Html rendering

.gitignore

@@ -15,3 +15,16 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+# RVM
+.ruby-gemset
+.ruby-version
+
+# JetBrains
+.idea/
+
+# Xcode
+xcuserdata/
+
+# Pods
+Pods/

CHANGELOG.md

@@ -7,6 +7,9 @@
 * Update matching for `Settings.bundle` file in project.  
   [Jim Hildensperger](https://github.com/jhildensperger)
 
+* Add HTML acknowledgements file.
+  [Dmitry Lobanov](https://github.com/lolgear)
+
 ##### Bug Fixes
 
 * None.  

cocoapods_acknowledgements.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '>= 4.0.2', '< 5'
 
   spec.add_dependency "redcarpet", "~> 3.3"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

lib/cocoapods_acknowledgements.rb

@@ -1,14 +1,21 @@
 module CocoaPodsAcknowledgements
   require 'cocoapods_acknowledgements/plist_generator'
+  require 'cocoapods_acknowledgements/html_generator'
   require 'cocoapods_acknowledgements/settings_plist_generator'
-
-  def self.save_metadata(metadata, plist_path, project, sandbox, user_target_uuid)
-    if defined? Xcodeproj::Plist.write_to_path
-      Xcodeproj::Plist.write_to_path(metadata, plist_path)
-    else
-      Xcodeproj.write_plist(metadata, plist_path)
+  require 'cocoapods_acknowledgements/writers'
+  def self.write_metadata(metadata, file_path)
+    extname = Pathname.new(file_path).extname
+    case extname
+      when '.plist'
+        PlistWriter.write(metadata, file_path)
+      when '.html'
+        HTMLWriter.write(metadata, file_path)
+      when '.md'
+        MarkdownWriter.write(metadata, file_path)
     end
+  end
 
+  def self.add_metadata_to_project(plist_path, project, sandbox, user_target_uuid)
     # Find a root folder in the users Xcode Project called Pods, or make one
     cocoapods_group = project.main_group["Pods"]
     unless cocoapods_group
@@ -17,7 +24,7 @@ def self.save_metadata(metadata, plist_path, project, sandbox, user_target_uuid)
 
     # Add the example plist to the found CocoaPods group
     plist_pathname = Pathname.new(File.expand_path(plist_path))
-    file_ref = cocoapods_group.files.find { |file| file.real_path == plist_pathname }
+    file_ref = cocoapods_group.files.find {|file| file.real_path == plist_pathname}
     unless file_ref
       file_ref = cocoapods_group.new_file(plist_path)
     end
@@ -29,11 +36,15 @@ def self.save_metadata(metadata, plist_path, project, sandbox, user_target_uuid)
     end
 
     project.save
+  end
 
+  def self.save_metadata(metadata, plist_path, project, sandbox, user_target_uuid)
+    write_metadata(metadata, plist_path)
+    add_metadata_to_project(plist_path, project, sandbox, user_target_uuid)
   end
 
   def self.settings_bundle_in_project(project)
-    file = project.files.find { |f| f.path =~ /Settings\.bundle$/ }
+    file = project.files.find {|f| f.path =~ /Settings\.bundle$/}
     file.real_path.to_path unless file.nil?
   end
 
@@ -63,12 +74,21 @@ def self.settings_bundle_in_project(project)
         umbrella_target.user_target_uuids.each do |user_target_uuid|
 
           # Generate a plist representing all of the podspecs
-          metadata = PlistGenerator.generate(umbrella_target, sandbox, excluded_pods)
-
-          next unless metadata
+          plist_metadata = PlistGenerator.generate(umbrella_target, sandbox, excluded_pods)
+          html_metadata = HTMLGenerator.generate(umbrella_target, sandbox, excluded_pods)
+          next unless plist_metadata
 
+          # save plist file.
           plist_path = sandbox.root + "#{umbrella_target.cocoapods_target_label}-metadata.plist"
-          save_metadata(metadata, plist_path, project, sandbox, user_target_uuid)
+          save_metadata(plist_metadata, plist_path, project, sandbox, user_target_uuid)
+
+          # save html file.
+          html_path = sandbox.root + "#{umbrella_target.cocoapods_target_label}-metadata.html"
+          save_metadata(html_metadata, html_path, project, sandbox, user_target_uuid)
+
+          # save markdown file.
+          markdown_path = sandbox.root + "#{umbrella_target.cocoapods_target_label}-metadata.md"
+          save_metadata(html_metadata, markdown_path, project, sandbox, user_target_uuid)
 
           if should_include_settings
             # Generate a plist in Settings format

lib/cocoapods_acknowledgements/auxiliaries.rb

@@ -0,0 +1,37 @@
+module CocoaPodsAcknowledgements
+  module Auxiliaries
+    def file_accessor(spec, platform, sandbox)
+      pod_root = sandbox.pod_dir(spec.name)
+      if pod_root.exist?
+        path_list = Pod::Sandbox::PathList.new(pod_root)
+        Pod::Sandbox::FileAccessor.new(path_list, spec.consumer(platform))
+      end
+    end
+
+    # Returns the text of the license for the given spec.
+    #
+    # @param  [Specification] spec
+    #         the specification for which license is needed.
+    #
+    # @return [String] The text of the license.
+    # @return [Nil] If not license text could be found.
+    #
+    def license_text(spec, file_accessor)
+      return nil unless spec.license
+      text = spec.license[:text]
+      unless text
+        if file_accessor
+          if license_file = file_accessor.license
+            if license_file.exist?
+              text = IO.read(license_file)
+            else
+              Pod::UI.warn "Unable to read the license file `#{license_file }` " \
+                  "for the spec `#{spec}`"
+            end
+          end
+        end
+      end
+      text
+    end
+  end
+end

lib/cocoapods_acknowledgements/generator.rb

@@ -0,0 +1,38 @@
+require 'cocoapods_acknowledgements/auxiliaries'
+module CocoaPodsAcknowledgements
+  class Generator
+    class << self
+      include Auxiliaries
+
+      def generate_specs(target_description, sandbox, excluded, root_specs)
+        []
+      end
+
+      def generate(target_description, sandbox, excluded)
+        root_specs = target_description.specs.map(&:root).uniq.reject {|spec| excluded.include?(spec.name)}
+        return nil if root_specs.empty?
+        generate_specs(target_description, sandbox, excluded, root_specs)
+      end
+    end
+  end
+end
+
+module CocoaPodsAcknowledgements
+  class Generator
+    class SpecObject
+      attr_accessor :name, :version, :authors, :socialMedialURL, :summary,
+                    :description, :licenseType, :licenseText, :homepage
+      def initialize(options)
+        @name = options["name"]
+        @version = options["version"]
+        @authors = options["authors"]
+        @socialMediaURL = options["socialMediaURL"]
+        @summary = options["summary"]
+        @description = options["description"]
+        @licenseType = options["licenseType"]
+        @licenseText = options["licenseText"]
+        @homepage = options["homepage"]
+      end
+    end
+  end
+end

lib/cocoapods_acknowledgements/html_generator.rb

@@ -0,0 +1,27 @@
+require 'cocoapods_acknowledgements/markdown_parser'
+require 'cocoapods_acknowledgements/generator'
+
+module CocoaPodsAcknowledgements
+  class HTMLGenerator < PlistGenerator
+    class << self
+      def generate_specs(target_description, sandbox, excluded, root_specs)
+        metadata = super
+        specs = metadata["specs"]
+        metadata["specs"] = specs.map do |spec|
+          Generator::SpecObject.new(spec)
+        end
+        metadata["header"] = header
+        metadata["footer"] = footer
+        metadata
+      end
+
+      def header
+        'Acknowledgements'
+      end
+
+      def footer
+        'Generated by CocoaPods - https://cocoapods.org'
+      end
+    end
+  end
+end

lib/cocoapods_acknowledgements/markdown_parser.rb

@@ -0,0 +1,16 @@
+require 'redcarpet'
+
+module CocoaPodsAcknowledgements
+  class MarkdownParser
+    class << self
+      def markdown_parser
+        @markdown_parser ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+      end
+
+      def parse_markdown(text)
+        return nil unless text
+        markdown_parser.render(text)
+      end
+    end
+  end
+end

lib/cocoapods_acknowledgements/plist_generator.rb

@@ -1,87 +1,34 @@
-require 'redcarpet'
+require 'cocoapods_acknowledgements/markdown_parser'
+require 'cocoapods_acknowledgements/generator'
 
 module CocoaPodsAcknowledgements
-  class PlistGenerator
+  class PlistGenerator < Generator
     class << self
-
-      def markdown_parser
-        @markdown_parser ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML)
-      end
-
-      def generate(target_description, sandbox, excluded)
-        root_specs = target_description.specs.map(&:root).uniq.reject { |spec| excluded.include?(spec.name) }
-
-        return nil if root_specs.empty?
-
+      def generate_specs(target_description, sandbox, excluded, root_specs)
         specs_metadata = []
-        root_specs.each do |spec|
+        specs = root_specs.map do |spec|
           pod_root = sandbox.pod_dir(spec.name)
           platform = Pod::Platform.new(target_description.platform_name)
           file_accessor = file_accessor(spec, platform, sandbox)
           license_text = license_text(spec, file_accessor)
 
-          spec_metadata = {
+          metadata = {
             "name" => spec.name,
             "version" => spec.version,
             "authors" => spec.authors,
             "socialMediaURL" => spec.social_media_url,
             "summary" => spec.summary,
-            "description" => parse_markdown(spec.description),
+            "description" => MarkdownParser.parse_markdown(spec.description),
             "licenseType" => spec.license[:type],
             "licenseText" => license_text,
             "homepage" => spec.homepage,
           }
-          specs_metadata << spec_metadata
         end
-
+        specs_metadata += specs
         metadata = {}
         metadata["specs"] = specs_metadata
         metadata
       end
-
-      #-----------------------------------------------------------------------#
-
-      def file_accessor(spec, platform, sandbox)
-        pod_root = sandbox.pod_dir(spec.name)
-        if pod_root.exist?
-          path_list = Pod::Sandbox::PathList.new(pod_root)
-          Pod::Sandbox::FileAccessor.new(path_list, spec.consumer(platform))
-        end
-      end
-
-      # Returns the text of the license for the given spec.
-      #
-      # @param  [Specification] spec
-      #         the specification for which license is needed.
-      #
-      # @return [String] The text of the license.
-      # @return [Nil] If not license text could be found.
-      #
-      def license_text(spec, file_accessor)
-        return nil unless spec.license
-        text = spec.license[:text]
-        unless text
-          if file_accessor
-            if license_file = file_accessor.license
-              if license_file.exist?
-                text = IO.read(license_file)
-              else
-                Pod::UI.warn "Unable to read the license file `#{license_file }` " \
-                  "for the spec `#{spec}`"
-              end
-            end
-          end
-        end
-        text
-      end
-
-      def parse_markdown(text)
-        return nil unless text
-        markdown_parser.render(text)
-      end
-
-      #-----------------------------------------------------------------------#
-
     end
   end
 end

lib/cocoapods_acknowledgements/settings_plist_generator.rb

@@ -1,14 +1,10 @@
-require 'cocoapods_acknowledgements/plist_generator'
+require 'cocoapods_acknowledgements/markdown_parser'
+require 'cocoapods_acknowledgements/generator'
 
 module CocoaPodsAcknowledgements
-  class SettingsPlistGenerator < PlistGenerator
+  class SettingsPlistGenerator < Generator
     class << self
-
-      def generate(target_description, sandbox, excluded)
-        root_specs = target_description.specs.map(&:root).uniq.reject { |spec| excluded.include?(spec.name) }
-
-        return nil if root_specs.empty?
-
+      def generate_specs(target_description, sandbox, excluded, root_specs)
         specs_metadata = [header]
 
         root_specs.each do |spec|