cocoapods-acknowledgements-addons 0.2.0 → 0.3.0

data/example/Makefile

@@ -1,8 +1,8 @@
-default: install
+default:
+	make install-dependencies
 	open App.xcworkspace
 
-install:
+install-dependencies:
 	git submodule update --init --recursive
 	carthage bootstrap --platform ios --no-build
-	bundle install
 	bundle exec pod install

data/example/Podfile

@@ -1,15 +1,20 @@
 platform :ios, "12.0"
+use_frameworks!
+inhibit_all_warnings!
 
 target :App do
-  use_frameworks!
   pod "Alamofire", git: "https://github.com/Alamofire/Alamofire.git", tag: "4.8.2"
-  pod "CPDAcknowledgements", inhibit_warnings: true
+  pod "CPDAcknowledgements"
+end
+
+target :AppTests do
 end
 
 # Generates a plist of dependencies installed via CocoaPods
-plugin "cocoapods-acknowledgements"
+plugin "cocoapods-acknowledgements", settings_bundle: true
 
 # Adds additional acknowledgements to the generated plist
 plugin "cocoapods-acknowledgements-addons",
   add: ["Acknowledgements", "Carthage/Checkouts", "Dependencies"],
-  exclude: ["QuickTableViewController"]
+  with_spm: true,
+  exclude: ["Quick*"]

data/example/Podfile.lock

@@ -7,7 +7,7 @@ DEPENDENCIES:
   - CPDAcknowledgements
 
 SPEC REPOS:
-  https://github.com/cocoapods/specs.git:
+  https://github.com/CocoaPods/Specs.git:
     - CPDAcknowledgements
 
 EXTERNAL SOURCES:
@@ -24,6 +24,6 @@ SPEC CHECKSUMS:
   Alamofire: ae5c501addb7afdbb13687d7f2f722c78734c2d3
   CPDAcknowledgements: 6e15e71849ba4ad5e8a17a0bb9d20938ad23bac8
 
-PODFILE CHECKSUM: f95597022bf609d22d7eb87aee64383751ce2c4c
+PODFILE CHECKSUM: 510b2adb00afb6eb355a2f628b554a1370e84972
 
-COCOAPODS: 1.6.1
+COCOAPODS: 1.8.4

data/example/README.md

@@ -5,7 +5,7 @@
 ```rb
 plugin "cocoapods-acknowledgements-addons",
   add: ["Acknowledgements", "Carthage/Checkouts", "Dependencies"],
-  exclude: ["QuickTableViewController"]
+  exclude: ["Quick*"]
 ```
 
 The plugin finds additional acknowledgements from the following directories:

data/lib/cocoapods_acknowledgements/addons.rb

@@ -1,8 +1,9 @@
 require "cocoapods"
 require "cocoapods_acknowledgements"
 require "cocoapods_acknowledgements/addons/podspec_accumulator"
-require "cocoapods_acknowledgements/addons/plist_modifier"
-require "cocoapods_acknowledgements/addons/settings_plist_modifier"
+require "cocoapods_acknowledgements/addons/swift_package_accumulator"
+require "cocoapods_acknowledgements/addons/modifiers/pods_plist_modifier"
+require "cocoapods_acknowledgements/addons/modifiers/metadata_plist_modifier"
 
 module CocoaPodsAcknowledgements
   module AddOns
@@ -10,21 +11,31 @@ module CocoaPodsAcknowledgements
     Pod::HooksManager.register("cocoapods-acknowledgements-addons", :post_install) do |context, user_options|
       paths = [*user_options[:add]]
       excluded_names = [*user_options[:exclude]]
+      includes_spm = user_options[:with_spm] || false
 
       acknowledgements = paths.reduce([]) do |results, path|
         accumulator = PodspecAccumulator.new(Pathname(path).expand_path)
-        results + accumulator.acknowledgements
+        (results + accumulator.acknowledgements).uniq { |a| a.spec.name }
+      end
+
+      if includes_spm
+        spm_acknowledgements = context.umbrella_targets.reduce([]) do |results, target|
+          accumulator = SwiftPackageAccumulator.new(target.user_project.path)
+          (results + accumulator.acknowledgements).uniq { |a| a.spec.name }
+        end
+        acknowledgements += spm_acknowledgements
+        Pod::UI.info %(Found #{spm_acknowledgements.count} Swift Package(s)).green
       end
 
       sandbox = context.sandbox if defined? context.sandbox
       sandbox ||= Pod::Sandbox.new(context.sandbox_root)
 
       context.umbrella_targets.each do |target|
-        plist_modifier = PlistModifier.new(target, sandbox)
-        plist_modifier.add(acknowledgements.map(&:plist_metadata), excluded_names)
+        metadata_plist_modifier = MetadataPlistModifier.new(target, sandbox)
+        metadata_plist_modifier.add(acknowledgements.map(&:metadata_plist_item), excluded_names)
 
-        settings_plist_modifier = SettingsPlistModifier.new(target)
-        settings_plist_modifier.add(acknowledgements.map(&:settings_plist_metadata), excluded_names)
+        pods_plist_modifier = PodsPlistModifier.new(target, sandbox)
+        pods_plist_modifier.add(acknowledgements.map(&:settings_plist_item), excluded_names)
       end
     end
 

data/lib/cocoapods_acknowledgements/addons/acknowledgement.rb

@@ -3,6 +3,7 @@ require "cocoapods-core"
 module CocoaPodsAcknowledgements
   module AddOns
     class Acknowledgement
+      attr_reader :spec
 
       # @param path [String] the path string to a pod spec.
       #
@@ -34,10 +35,10 @@ module CocoaPodsAcknowledgements
         text
       end
 
-      # @return [Hash] the acknowledgement info for the plist.
+      # @return [Hash] the acknowledgement info for the Pods metadata plist.
       # @return [Nil] if the license text is missing.
       #
-      def plist_metadata
+      def metadata_plist_item
         return nil unless @spec and @license_text
         {
           name: @spec.name,
@@ -54,7 +55,7 @@ module CocoaPodsAcknowledgements
       # @return [Hash] the acknowledgement info for the Settings.bundle plist.
       # @return [Nil] if the license text is missing.
       #
-      def settings_plist_metadata
+      def settings_plist_item
         return nil unless @spec and @license_text
         {
           Title: @spec.name,

data/lib/cocoapods_acknowledgements/addons/{plist_modifier.rb → modifiers/metadata_plist_modifier.rb}

@@ -4,8 +4,10 @@ require "cocoapods_acknowledgements/addons/acknowledgement"
 
 module CocoaPodsAcknowledgements
   module AddOns
-    class PlistModifier
+    class MetadataPlistModifier
 
+      # A modifier to update Pods/Pods-#{app_name}-metadata.plist.
+      #
       # @param target [Pod::Installer::PostInstallHooksContext::UmbrellaTargetDescription] the xcodeproj target.
       # @param sandbox [Pod::Sandbox] the CocoaPods sandbox
       #
@@ -13,6 +15,13 @@ module CocoaPodsAcknowledgements
         @plist_path = sandbox.root + "#{target.cocoapods_target_label}-metadata.plist"
       end
 
+      # @return [CFPropertyList::List] the acknowledgement plist at Pods/Pods-#{app_name}-metadata.plist.
+      #
+      def plist
+        return nil unless @plist_path&.readable?
+        CFPropertyList::List.new(file: @plist_path)
+      end
+
       # Adds acknowledgements to the plist except the excluded ones.
       #
       # @param plist_metadata [Array<Hash>] the array of acknowledgement plist metadata.
@@ -27,19 +36,30 @@ module CocoaPodsAcknowledgements
         plist = CFPropertyList::List.new(file: @plist_path)
         entries = plist.value.value["specs"].value
         existing_titles = entries.map { |spec| spec.value["name"].value }
-        excluded_names += existing_titles
+        excluded_names.uniq!
 
-        additions = plist_metadata.map { |metadata|
-          next if metadata.nil? or excluded_names.include? metadata[:name]
+        additions = plist_metadata.map do |metadata|
+          next if metadata.nil? or existing_titles.include? metadata[:name]
           Pod::UI.info "Adding #{metadata[:name]} to #{@plist_path.basename}"
           CFPropertyList.guess(metadata)
-        }.reject(&:nil?)
+        end.reject(&:nil?)
 
         acknowledgements = entries + additions
-        acknowledgements.sort! { |a, b| a.value["name"].value <=> b.value["name"].value }
+        acknowledgements
+          .sort! { |a, b| a.value["name"].value <=> b.value["name"].value }
+          .reject! do |entry|
+            matches = excluded_names.any? do |excluded_name|
+              pattern = %r(^#{Regexp.escape(excluded_name).gsub("\*", ".*?")})
+              entry.value["name"].value =~ pattern
+            end
+            Pod::UI.info %(Removing #{entry.value["name"].value} from #{@plist_path.basename}) if matches
+            matches
+          end
 
         plist.value.value["specs"].value = acknowledgements
         plist.save(@plist_path, CFPropertyList::List::FORMAT_XML)
+
+        Pod::UI.puts "Saving #{@plist_path}".green
       end
 
     end

data/lib/cocoapods_acknowledgements/addons/modifiers/pods_plist_modifier.rb

@@ -0,0 +1,133 @@
+require "cfpropertylist"
+require "cocoapods"
+require "cocoapods_acknowledgements/addons/acknowledgement"
+
+module CocoaPodsAcknowledgements
+  module AddOns
+    class PodsPlistModifier
+
+      # A modifier to update:
+      #
+      # - Pods/Target Support Files/Pods-#{app_name}/Pods-#{app_name}-acknowledgements.{plist|markdown}
+      # - settings_bundle/#{app_name}-settings-metadata.plist"
+      #
+      # @param target [Pod::Installer::PostInstallHooksContext::UmbrellaTargetDescription] the xcodeproj target.
+      # @param sandbox [Pod::Sandbox] the CocoaPods sandbox
+      #
+      def initialize(target, sandbox)
+        @markdown_path = sandbox.target_support_files_root + target.cocoapods_target_label + "#{target.cocoapods_target_label}-acknowledgements.markdown"
+        @plist_path = sandbox.target_support_files_root + target.cocoapods_target_label + "#{target.cocoapods_target_label}-acknowledgements.plist"
+
+        project = Xcodeproj::Project.open(target.user_project_path)
+        file = project.files.find { |f| f.path =~ /Settings\.bundle$/ }
+        settings_bundle = file&.real_path
+        @settings_plist = settings_bundle + "#{target.cocoapods_target_label}-settings-metadata.plist" if settings_bundle&.exist?
+      end
+
+      # @return [String] the acknowledgement texts at Pods/Target Support Files/Pods-#{app_name}/Pods-#{app_name}-acknowledgements.markdown.
+      #
+      def markdown
+        return nil unless @markdown_path&.readable?
+        File.read @markdown_path
+      end
+
+      # @return [CFPropertyList::List] the acknowledgement plist at Pods/Target Support Files/Pods-#{app_name}/Pods-#{app_name}-acknowledgements.plist.
+      #
+      def plist
+        return nil unless @plist_path&.readable?
+        CFPropertyList::List.new(file: @plist_path)
+      end
+
+      # @return [CFPropertyList::List] the acknowledgement plist in the app Settings.bundle.
+      #
+      def settings_plist
+        return nil unless @settings_plist&.readable?
+        CFPropertyList::List.new(file: @settings_plist)
+      end
+
+      # Adds acknowledgements to the CocoaPods generated plist and markdown files except the excluded ones.
+      #
+      # @param plist_metadata [Array<Hash>] the array of acknowledgement plist metadata.
+      # @param excluded_names [Array<String>] the array of names to ignore.
+      #
+      def add(plist_metadata, excluded_names)
+        plist_metadata = [*plist_metadata]
+        excluded_names = [*excluded_names]
+
+        return if plist_metadata.empty?
+        plist = plist_with_additional_metadata(plist_metadata, excluded_names)
+
+        [@plist_path, @settings_plist].each do |path|
+          next unless path&.writable?
+          Pod::UI.puts "Saving #{path}".green
+          plist.save(path, CFPropertyList::List::FORMAT_XML)
+        end
+
+        File.write @markdown_path, markdown_text_with(plist)
+      end
+
+      private
+
+      def plist_with_additional_metadata(plist_metadata, excluded_names)
+        return nil unless @plist_path&.readable?
+
+        plist = CFPropertyList::List.new(file: @plist_path)
+        entries = plist.value.value["PreferenceSpecifiers"].value
+
+        header = entries.first
+        footer = entries.last
+        attributes = [header.value["Title"].value, footer.value["Title"].value]
+
+        existing_titles = entries
+          .map { |spec| spec.value["Title"].value }
+          .reject { |title| attributes.include? title }
+        excluded_names.uniq!
+
+        additions = plist_metadata.map do |metadata|
+          next if metadata.nil? or existing_titles.include? metadata[:Title]
+          Pod::UI.info "Adding #{metadata[:Title]} to #{@plist_path.basename}"
+          CFPropertyList.guess(metadata)
+        end.reject(&:nil?)
+
+        acknowledgements = entries[1...-1] + additions
+        acknowledgements
+          .sort! { |a, b| a.value["Title"].value <=> b.value["Title"].value }
+          .reject! do |entry|
+            matches = excluded_names.any? do |excluded_name|
+              pattern = %r(^#{Regexp.escape(excluded_name).gsub("\*", ".*?")})
+              entry.value["Title"].value =~ pattern
+            end
+            Pod::UI.info %(Removing #{entry.value["Title"].value} from #{@plist_path.basename}) if matches
+            matches
+          end
+
+        footer.value["FooterText"].value.gsub!("http:", "https:")
+
+        plist.value.value["PreferenceSpecifiers"].value = [header] + acknowledgements + [footer]
+        plist
+      end
+
+      def markdown_text_with(plist)
+        entries = plist.value.value["PreferenceSpecifiers"].value
+        header = entries.first
+        footer = entries.last
+        acknowledgements = entries[1...-1].map do |entry|
+          <<~ACKNOWLEDGEMENT.strip
+            ## #{entry.value["Title"].value}
+
+            #{entry.value["FooterText"].value}
+          ACKNOWLEDGEMENT
+        end
+
+        texts = <<~MARKDOWN
+          # #{header.value["Title"].value}
+          #{header.value["FooterText"].value}
+
+          #{acknowledgements.join("\n\n\n")}
+
+          #{footer.value["FooterText"].value}
+        MARKDOWN
+      end
+    end
+  end
+end

data/lib/cocoapods_acknowledgements/addons/swift_package_accumulator.rb

@@ -0,0 +1,28 @@
+require "cocoapods-core"
+require "cocoapods_acknowledgements/addons/acknowledgement"
+
+module CocoaPodsAcknowledgements
+  module AddOns
+    class SwiftPackageAccumulator
+
+      # @param xcodeproj_path [Pathname] the directory to look for podspecs.
+      #
+      def initialize(xcodeproj_path = nil)
+        if xcodeproj_path.nil?
+          @files = []
+        else
+          build_dir = %x{xcodebuild -project "#{xcodeproj_path}" -showBuildSettings | grep -m 1 BUILD_DIR | grep -oEi "\/.*"}.strip
+          source_packages_dir = Pathname(build_dir) + "../../SourcePackages/checkouts"
+          @files = Dir[source_packages_dir + "*/*.podspec"] # skip nested git submodules
+        end
+      end
+
+      # @return [Array<Acknowledgement>] the array of Acknowledgement objects.
+      #
+      def acknowledgements
+        @files.map { |file| Acknowledgement.new(file) }
+      end
+
+    end
+  end
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module CocoaPodsAcknowledgements
   module AddOns
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-acknowledgements-addons
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - bcylin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -72,6 +72,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/run_tests.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".travis.yml"
@@ -87,9 +88,11 @@ files:
 - example/App.xcodeproj/project.pbxproj
 - example/App.xcodeproj/project.xcworkspace/contents.xcworkspacedata
 - example/App.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
+- example/App.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
 - example/App.xcodeproj/xcshareddata/xcschemes/App.xcscheme
 - example/App.xcworkspace/contents.xcworkspacedata
 - example/App.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
+- example/App.xcworkspace/xcshareddata/swiftpm/Package.resolved
 - example/App/App-Bridging-Header.h
 - example/App/AppDelegate.swift
 - example/App/Assets.xcassets/AppIcon.appiconset/Contents.json
@@ -113,9 +116,10 @@ files:
 - example/README.md
 - lib/cocoapods_acknowledgements/addons.rb
 - lib/cocoapods_acknowledgements/addons/acknowledgement.rb
-- lib/cocoapods_acknowledgements/addons/plist_modifier.rb
+- lib/cocoapods_acknowledgements/addons/modifiers/metadata_plist_modifier.rb
+- lib/cocoapods_acknowledgements/addons/modifiers/pods_plist_modifier.rb
 - lib/cocoapods_acknowledgements/addons/podspec_accumulator.rb
-- lib/cocoapods_acknowledgements/addons/settings_plist_modifier.rb
+- lib/cocoapods_acknowledgements/addons/swift_package_accumulator.rb
 - lib/cocoapods_plugin.rb
 - lib/version.rb
 homepage: https://github.com/bcylin/cocoapods-acknowledgements-addons
@@ -137,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A CocoaPods plugin that adds additional acknowledgements to the plist generated

data/lib/cocoapods_acknowledgements/addons/settings_plist_modifier.rb

@@ -1,58 +0,0 @@
-require "cfpropertylist"
-require "cocoapods"
-require "cocoapods_acknowledgements/addons/acknowledgement"
-
-module CocoaPodsAcknowledgements
-  module AddOns
-    class SettingsPlistModifier
-
-      # @param target [Pod::Installer::PostInstallHooksContext::UmbrellaTargetDescription] the xcodeproj target.
-      #
-      def initialize(target)
-        project = Xcodeproj::Project.open(target.user_project_path)
-        file = project.files.find { |f| f.path =~ /Settings\.bundle$/ }
-        settings_bundle = file&.real_path
-
-        return unless settings_bundle&.exist?
-        @plist_path = settings_bundle + "#{target.cocoapods_target_label}-settings-metadata.plist"
-      end
-
-      # Adds acknowledgements to the plist except the excluded ones.
-      #
-      # @param plist_metadata [Array<Hash>] the array of acknowledgement plist metadata.
-      # @param excluded_names [Array<String>] the array of names to ignore.
-      #
-      def add(plist_metadata, excluded_names)
-        plist_metadata = [*plist_metadata]
-        excluded_names = [*excluded_names]
-
-        return if plist_metadata.empty? or not @plist_path&.writable?
-
-        plist = CFPropertyList::List.new(file: @plist_path)
-        entries = plist.value.value["PreferenceSpecifiers"].value
-
-        header = entries.first
-        footer = entries.last
-        attributes = [header.value["Title"].value, footer.value["Title"].value]
-
-        existing_titles = entries
-          .map { |spec| spec.value["Title"].value }
-          .reject { |title| attributes.include? title }
-        excluded_names += existing_titles
-
-        additions = plist_metadata.map { |metadata|
-          next if metadata.nil? or excluded_names.include? metadata[:Title]
-          Pod::UI.info "Adding #{metadata[:Title]} to #{@plist_path.basename}"
-          CFPropertyList.guess(metadata)
-        }.reject(&:nil?)
-
-        acknowledgements = entries[1...-1] + additions
-        acknowledgements.sort! { |a, b| a.value["Title"].value <=> b.value["Title"].value }
-
-        plist.value.value["PreferenceSpecifiers"].value = [header] + acknowledgements + [footer]
-        plist.save(@plist_path, CFPropertyList::List::FORMAT_XML)
-      end
-
-    end
-  end
-end