cocoapods-acknowledgements 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab57b2637b279669a7dd0b4db49d6998da1ed244
+  data.tar.gz: e982c6d053c1cc0b24c73bf96fde9b49054377d6
+SHA512:
+  metadata.gz: 25e5b279dcb470db443765d10eb684ad2b65f5952dbc410ee82eaafb7eee06f6641ce64d4050d10f7a2c59181f3d8c69c51c46515ed104bb78c2cf0daedf61b0
+  data.tar.gz: e3c1fdead333ccd712641ca6f0209f7c89ab2bc4be92afa75a03d77f4e9c31d563a0f9e8a49ea8e07aeee06ae973e3933dbc7c9b5b87ac74d207544e33a11742

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: objective-c
+env:
+  # This is what 10.8.x comes with and we want to support that.
+  - RVM_RUBY_VERSION=system NOEXEC_DISABLE=1 RUBY_VERSION_SPECIFIC='sudo ln -s /usr/bin/llvm-gcc-4.2 /usr/bin/gcc-4.2' SSL_CERT_FILE=/usr/local/share/cacert.pem GIT_AUTHOR_NAME=CocoaPods GIT_AUTHOR_EMAIL=cocoapods@example.com PYTHONPATH=/usr/local/lib/python2.7/site-packages
+  - RVM_RUBY_VERSION=2.0.0-p247 NOEXEC_DISABLE=1 RUBY_VERSION_SPECIFIC='sudo gem install bundler --no-ri --no-rdoc' GIT_AUTHOR_NAME=CocoaPods GIT_AUTHOR_EMAIL=cocoapods@example.com PYTHONPATH=/usr/local/lib/python2.7/site-packages
+before_install:
+  - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
+  - source ~/.rvm/scripts/rvm && rvm use $RVM_RUBY_VERSION
+install: eval $RUBY_VERSION_SPECIFIC && rake bootstrap[use_bundle_dir]
+script: bundle exec rake spec:ci

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# CocoaPods::Metadata Changelog
+
+## Master
+
+##### Enhancements
+
+* Support Settings bundle style plists.  
+  [Marcelo Fabri](https://github.com/marcelofabri)
+
+* Support full Podspec metadata style.  
+  [Fabio Pelosin](https://github.com/fabiopelosin)
+  [Orta Therox](https://github.com/orta)

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'cocoapods'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'mocha', '~> 0.11.4'
+  gem 'rake'
+  gem 'prettybacon', :git => 'https://github.com/irrationalfab/PrettyBacon.git', :branch => 'master'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Fabio Pelosin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# CocoaPods Acknowledgements
+
+A CocoaPods plugin that generates a plist which includes the installation metadata. It supports generating two styles of dependency information. 
+
+* **Settings.bundle compatible plist** - This format is supported by a [large amount of pods](https://cocoapods.org/?q=acknow) and works with Apple's Settings.app.
+
+* **Full Podspec metadata plist** - This format provides more information to the app allowing for deeper introspection, currently only [CPDAcknowledgements](https://github.com/cocoapods/CPDAcknowledgements) works with this format.
+
+### Installation
+
+Install via `gem install cocoapods-acknowledgements` you need to be using at least CocoaPods `0.36` and add `plugin 'cocoapods-acknowledgements'` to your `Podfile`. See below for examples:
+
+### Example usage
+
+For showing your own UI inside your application:
+
+``` ruby
+plugin 'cocoapods-acknowledgements'
+```
+
+For embedding a `Settings.bundle` compatible plist
+
+``` ruby
+plugin 'cocoapods-acknowledgements', :settings_bundle => true
+```
+
+With a Settings.bundle compatible plist, offering the chance to run post-processing on the plist ( to add non-CocoaPods dependencies for example )
+
+``` ruby
+plugin 'cocoapods-acknowledgements', :settings_bundle => true , :settings_post_process => Proc.new { |settings_plist_path, umbrella_target| 
+  puts settings_plist_path 
+  puts umbrella_target.cocoapods_target_label
+}
+```
+
+The plugin will search through the first two levels of your project to find a `Settings.bundle` file, and add the file to the bundle. If this is not enough for you, we'd love a PR. 

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+def specs(dir)
+  FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+end
+
+task :bootstrap, :use_bundle_dir? do |t, args|
+  if args[:use_bundle_dir?]
+    sh "bundle install --path ./travis_bundle_dir"
+  else
+    sh "bundle install"
+  end
+end
+
+namespace :spec do
+  desc "Runs all the specs"
+  task :ci do
+    sh "bundle exec bacon #{specs('**')}"
+  end
+end
+
+task :default => "spec:ci"

data/cocoapods_acknowledgements.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods_acknowledgements/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cocoapods-acknowledgements"
+  spec.version       = CocoaPodsAcknowledgements::VERSION
+  spec.authors       = ["Fabio Pelosin", "Orta Therox", "Marcelo Fabri"]
+  spec.summary       = %q{CocoaPods plugin that generates an acknowledgements plist to make it easy to create tools to use in apps.}
+  spec.homepage      = "https://github.com/CocoaPods/cocoapods-acknowledgements"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redcarpet", "~> 3.3"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/cocoapods_acknowledgements.rb

@@ -0,0 +1,98 @@
+module CocoaPodsAcknowledgements
+  require 'cocoapods_acknowledgements/plist_generator'
+  require 'cocoapods_acknowledgements/settings_plist_generator'
+
+  def self.save_metadata(metadata, plist_path, project, sandbox, user_target_uuid)
+    Xcodeproj.write_plist(metadata, plist_path)
+
+    # Find a root folder in the users Xcode Project called Pods, or make one
+    cocoapods_group = project.main_group["Pods"]
+    unless cocoapods_group
+      cocoapods_group = project.main_group.new_group("Pods", sandbox.root)
+    end
+
+    # Add the example plist to the found CocoaPods group
+    file_ref = cocoapods_group.files.find { |file| file.real_path == plist_path }
+    unless file_ref
+      file_ref = cocoapods_group.new_file(plist_path)
+    end
+
+    # Ensure that the plist is added to target
+    target = project.objects_by_uuid[user_target_uuid]
+    unless target.resources_build_phase.files_references.include?(file_ref)
+      target.add_resources([file_ref])
+    end
+
+    project.save
+
+  end
+  
+  # TODO: Code golf this
+  def self.settings_bundle_in_project
+    Dir.glob("**/*Settings.bundle").first
+  end
+  
+  Pod::HooksManager.register('cocoapods-acknowledgements', :post_install) do |context, user_options|
+    require 'cocoapods'
+    
+    # Until CocoaPods provides a HashWithIndifferentAccess, normalize the hash keys here.
+    # See https://github.com/CocoaPods/CocoaPods/issues/3354
+    
+    user_options.inject({}) do |normalized_hash, (key, value)|
+      normalized_hash[key.to_s] = value
+      normalized_hash
+    end
+    
+    Pod::UI.section 'Adding Acknowledgements' do
+
+      should_include_settings = user_options["settings_bundle"] != nil
+
+      sandbox = context.sandbox if defined? context.sandbox
+      sandbox ||= Pod::Sandbox.new(context.sandbox_root)
+
+      context.umbrella_targets.each do |umbrella_target|
+        project = Xcodeproj::Project.open(umbrella_target.user_project_path)
+        
+        umbrella_target.user_target_uuids.each do |user_target_uuid|
+          
+          # Generate a plist representing all of the podspecs
+          metadata = PlistGenerator.generate(umbrella_target, sandbox)
+          
+          next unless metadata
+          
+          plist_path = sandbox.root + "#{umbrella_target.cocoapods_target_label}-metadata.plist"
+          save_metadata(metadata, plist_path, project, sandbox, user_target_uuid)
+          
+          if should_include_settings
+            # Generate a plist in Settings format
+            settings_metadata = SettingsPlistGenerator.generate(umbrella_target, sandbox)
+
+            # We need to look for a Settings.bundle
+            # and add this to the root of the bundle
+            
+            settings_bundle = settings_bundle_in_project
+            if settings_bundle == nil
+              Pod::UI.warn "Could not find a Settings.bundle to add the Pod Settings Plist to."
+            else
+              settings_plist_path = settings_bundle + "/#{umbrella_target.cocoapods_target_label}-settings-metadata.plist"
+              FileUtils.cp(plist_path, settings_plist_path)
+              Pod::UI.info "Added Pod info to Settings.bundle for target #{umbrella_target.cocoapods_target_label}"
+              
+              # Support a callback for the key :settings_post_process
+              if user_options["settings_post_process"]
+                user_options["settings_post_process"].call(settings_plist_path, umbrella_target)
+              end
+              
+            end
+          end
+
+        end
+        
+      end
+      
+    end
+    
+  end
+end
+
+

data/lib/cocoapods_acknowledgements/plist_generator.rb

@@ -0,0 +1,87 @@
+require 'redcarpet'
+
+module CocoaPodsAcknowledgements
+  class PlistGenerator
+    class << self
+
+      def markdown_parser
+        @markdown_parser ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+      end
+
+      def generate(target_description, sandbox)
+        root_specs = target_description.specs.map(&:root).uniq
+
+        return nil if root_specs.empty?
+
+        specs_metadata = []
+        root_specs.each 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 = {
+            "name" => spec.name,
+            "version" => spec.version,
+            "authors" => spec.authors,
+            "socialMediaURL" => spec.social_media_url,
+            "summary" => spec.summary,
+            "description" => parse_markdown(spec.description),
+            "licenseType" => spec.license[:type],
+            "licenseText" => license_text,
+          }
+          specs_metadata << spec_metadata
+        end
+
+        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
+                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
+

data/lib/cocoapods_acknowledgements/settings_plist_generator.rb

@@ -0,0 +1,54 @@
+require 'cocoapods_acknowledgements/plist_generator'
+
+module CocoaPodsAcknowledgements
+  class SettingsPlistGenerator < PlistGenerator
+    class << self
+
+      def generate(target_description, sandbox)
+        root_specs = target_description.specs.map(&:root).uniq
+
+        return nil if root_specs.empty?
+
+        specs_metadata = [header]
+
+        root_specs.each 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 = {
+            "Title" => spec.name,
+            "Type" => "PSGroupSpecifier",
+            "FooterText" => license_text
+          }
+          specs_metadata << spec_metadata
+        end
+
+        specs_metadata << footer
+        metadata = {
+          "PreferenceSpecifiers" => specs_metadata,
+          "Title" => "Acknowledgements",
+          "StringsTable" => "Acknowledgements"
+        }
+      end
+
+      def header
+        header = {
+          "FooterText" => "This application makes use of the following third party libraries:",
+          "Title" => "Acknowledgements",
+          "Type" => "PSGroupSpecifier"
+        }
+      end
+			
+      def footer
+        footer = {
+          "FooterText" => "Generated by CocoaPods - http://cocoapods.org",
+          "Title" => nil,
+          "Type" => "PSGroupSpecifier"
+        }
+      end
+    end
+  end
+end
+

data/lib/cocoapods_acknowledgements/version.rb

@@ -0,0 +1,3 @@
+module CocoaPodsAcknowledgements
+  VERSION = "1.0.0"
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,2 @@
+require 'cocoapods_acknowledgements'
+

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'cocoapods'
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-acknowledgements
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fabio Pelosin
+- Orta Therox
+- Marcelo Fabri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cocoapods_acknowledgements.gemspec
+- lib/cocoapods_acknowledgements.rb
+- lib/cocoapods_acknowledgements/plist_generator.rb
+- lib/cocoapods_acknowledgements/settings_plist_generator.rb
+- lib/cocoapods_acknowledgements/version.rb
+- lib/cocoapods_plugin.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CocoaPods/cocoapods-acknowledgements
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: CocoaPods plugin that generates an acknowledgements plist to make it easy
+  to create tools to use in apps.
+test_files:
+- spec/spec_helper.rb
+has_rdoc: