cocoapods-spm 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61ad227d509165fab0c8f3e832aa06d05524fa7c2cbfd4d7cc8f393252fc60f
-  data.tar.gz: 66f6bf9e254c7a99edc55f304fcf34ea60867fbbb9f138a6473eb200b6fa9f32
+  metadata.gz: 815b5b5db4530e4fd685d421cd33fb1cde41b29abfa667aa0ba9d3c1b61f8ef0
+  data.tar.gz: 6befd92a1d7528b4da4a5f62a1f8676c8bfb8be0dd5cc65d8c134a7df01d5b01
 SHA512:
-  metadata.gz: e48c19f9a2ed81601a69cca75ceda44b9353bf76f996458dc3398dad8e7b0ed2fa6fff8ce03cad91122cdcf6f7603a5cc1070b9944dfab98a0d1ff5081f82740
-  data.tar.gz: d26d1674591412b761b92e51154142b5e76f7515464b0e462d5b26a06caeadd3162df96308d2ff34b1cb3d27c554eb33715d2248b7e66e2e58e1d56ceb4b1214
+  metadata.gz: abf5bf865306d931a1fbe53d230d17d80f62a1813a96b199c902c9f7da9dfc7ecbfff44eac5a3c7043ca73f856d66225c94f38d6ca5cf634f3b475d29f4a5476
+  data.tar.gz: 87e9e3935e947420740e3bdbd2d4c8ca0f36c8ad955a9ab15b2d7756c6bf58dc37aa7a3b9378df75b4db60b30c2e1e1a8b666b19d547cbe5216c907a0f89607a

data/lib/cocoapods-spm/command/clean.rb

@@ -0,0 +1,31 @@
+module Pod
+  class Command
+    class Spm < Command
+      class Clean < Spm
+        self.summary = "Clean caches"
+        def self.options
+          [
+            ["--all", "Clean all"],
+            ["--macros", "Clean macros"],
+            ["--packages", "Clean packages"],
+          ].concat(super)
+        end
+
+        def initialize(argv)
+          super
+          @clean_all = argv.flag?("all")
+          @clean_macros = argv.flag?("macros")
+          @clean_pkgs = argv.flag?("packages")
+        end
+
+        def run
+          to_clean = []
+          to_clean << spm_config.pkg_root_dir if @clean_pkgs
+          to_clean << spm_config.macro_root_dir if @clean_macros
+          to_clean << spm_config.root_dir if @clean_all
+          to_clean.each { |dir| dir.rmtree if dir.exist? }
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-spm/command/macro/deprecated.rb

@@ -0,0 +1,35 @@
+module Pod
+  class Command
+    class Spm < Command
+      def self.bind_command(cls)
+        Class.new(Spm) do
+          define_method(:cls) { cls }
+
+          self.summary = "[Deprecated] #{cls.summary}"
+
+          def self.options
+            cls.options
+          end
+
+          def initialize(argv)
+            name = self.class.name.demodulize.downcase
+            warn "[DEPRECATION] `pod spm #{name}` is deprecated. Please use `pod spm macro #{name}` instead.".yellow
+            @_binded = cls.new(argv)
+            super
+          end
+
+          def validate!
+            @_binded.validate!
+          end
+
+          def run
+            @_binded.run
+          end
+        end
+      end
+
+      Fetch = bind_command(Macro::Fetch)
+      Prebuild = bind_command(Macro::Prebuild)
+    end
+  end
+end

data/lib/cocoapods-spm/command/macro/fetch.rb

@@ -0,0 +1,33 @@
+require "cocoapods-spm/macro/fetcher"
+
+module Pod
+  class Command
+    class Spm < Command
+      class Macro < Spm
+        class Fetch < Macro
+          self.summary = "Fetch macros"
+          def self.options
+            [
+              ["--all", "Prebuild all macros"],
+              ["--macros=foo", "Macros to prebuild, separated by comma (,)"],
+            ].concat(super)
+          end
+
+          def initialize(argv)
+            super
+            update_cli_config(
+              all: argv.flag?("all"),
+              macros: argv.option("macros", "").split(",")
+            )
+          end
+
+          def run
+            spm_config.macros.each do |name|
+              SPM::MacroFetcher.new(name: name, can_cache: true).run
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-spm/command/macro/prebuild.rb

@@ -0,0 +1,37 @@
+require "cocoapods-spm/macro/prebuilder"
+
+module Pod
+  class Command
+    class Spm < Command
+      class Macro < Spm
+        class Prebuild < Macro
+          self.summary = "Prebuild macros"
+          def self.options
+            [
+              ["--all", "Prebuild all macros"],
+              ["--macros=foo", "Macros to prebuild, separated by comma (,)"],
+              ["--config=foo", "Config (debug/release) to prebuild macros"],
+            ].concat(super)
+          end
+
+          def initialize(argv)
+            super
+            update_cli_config(
+              all: argv.flag?("all"),
+              macros: argv.option("macros", "").split(","),
+              config: argv.option("config"),
+              dont_prebuild_macros: false,
+              dont_prebuild_macros_if_exist: false
+            )
+          end
+
+          def run
+            spm_config.macros.each do |name|
+              SPM::MacroPrebuilder.new(name: name).run
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-spm/command/macro.rb

@@ -0,0 +1,14 @@
+require "cocoapods-spm/command/macro/fetch"
+require "cocoapods-spm/command/macro/prebuild"
+require "cocoapods-spm/command/macro/deprecated"
+
+module Pod
+  class Command
+    class Spm < Command
+      class Macro < Spm
+        self.summary = "Working with macros"
+        self.abstract_command = true
+      end
+    end
+  end
+end

data/lib/cocoapods-spm/command/spm.rb

@@ -1,5 +1,5 @@
-require "cocoapods-spm/command/prebuild"
-require "cocoapods-spm/command/fetch"
+require "cocoapods-spm/command/macro"
+require "cocoapods-spm/command/clean"
 
 module Pod
   class Command

data/lib/cocoapods-spm/config/spm.rb

@@ -16,7 +16,7 @@ module Pod
       def initialize
         @dsl_config = {
           :dont_prebuild_macros => false,
-          :dont_prebuild_macros_if_exist => true
+          :dont_prebuild_macros_if_exist => true,
         }
         @cli_config = {}
       end
@@ -58,25 +58,33 @@ module Pod
       end
 
       def macro_root_dir
-        root_dir # To be updated: rootdir / "macros"
+        @macro_root_dir ||= prepare_dir(root_dir / "macros")
       end
 
       def macro_downloaded_root_dir
         macro_root_dir / ".downloaded"
       end
 
+      def macro_prebuilt_root_dir
+        macro_root_dir / ".prebuilt"
+      end
+
       def macro_downloaded_sandbox
         @macro_downloaded_sandbox ||= Sandbox.new(macro_downloaded_root_dir)
       end
 
       def pkg_umbrella_dir
-        @pkg_umbrella_dir ||= prepare_dir(root_dir / ".umbrella")
+        @pkg_umbrella_dir ||= prepare_dir(pkg_root_dir / ".umbrella")
       end
 
       def pkg_checkouts_dir
         pkg_umbrella_dir / ".build" / "checkouts"
       end
 
+      def pkg_artifacts_dir
+        pkg_umbrella_dir / ".build" / "artifacts"
+      end
+
       def pkg_metadata_dir
         @pkg_metadata_dir ||= prepare_dir(pkg_root_dir / "metadata")
       end

data/lib/cocoapods-spm/def/podfile.rb

@@ -1,10 +1,11 @@
 require "cocoapods-spm/config"
+require "cocoapods-spm/helpers/patch"
 
 module Pod
   class Podfile
+    include Mixin::PatchingBehavior
     attr_accessor :spm_resolver
 
-    alias origin_pod pod
     def config_cocoapods_spm(options)
       SPM::Config.instance.dsl_config = options
     end
@@ -13,11 +14,11 @@ module Pod
       @macro_pods ||= {}
     end
 
-    def pod(name = nil, *requirements)
+    patch_method :pod do |name = nil, *requirements|
       macro = requirements[0].delete(:macro) if requirements.first.is_a?(Hash)
       macro ||= {}
       unless macro.empty?
-        requirements[0][:path] = prepare_macro_pod_dir(name, macro)
+        requirements[0][:path] = prepare_macro_pod_dir(name, macro).to_s
         macro_pods[name] = macro
       end
       origin_pod(name, *requirements)
@@ -27,6 +28,10 @@ module Pod
       current_target_definition.store_spm_pkg(name, options)
     end
 
+    def spm_pkgs
+      spm_pkgs_by_aggregate_target.values.flatten.uniq(&:name)
+    end
+
     def spm_pkgs_for(target)
       spm_pkgs_by_aggregate_target[target.to_s]
     end
@@ -62,8 +67,7 @@ module Pod
         end
       HEREDOC
 
-      path = Pathname(".spm.pods/#{name}")
-      (path / ".prebuilt").mkpath
+      path = Pod::SPM::Config.instance.macro_root_dir / name
       (path / "Sources").mkpath
       (path / "#{name}.podspec").write(podspec_content)
       path

data/lib/cocoapods-spm/def/spm_dependency.rb

@@ -15,8 +15,10 @@ module Pod
       end
 
       def inspect
-        "#<#{self.class} name=#{name} product=#{product} pkg=#{pkg}>"
+        "#<#{self.class} #{name}/#{product} pkg=#{pkg}>"
       end
+
+      alias to_s inspect
     end
   end
 end

data/lib/cocoapods-spm/def/spm_package.rb

@@ -42,9 +42,11 @@ module Pod
       end
 
       def inspect
-        "#<#{self.class} name=#{name}>"
+        "#<#{self.class} #{name}>"
       end
 
+      alias to_s inspect
+
       def local?
         @relative_path != nil
       end

data/lib/cocoapods-spm/helpers/io.rb

@@ -0,0 +1,13 @@
+module Pod
+  module IOUtils
+    def self.symlink(src, dst)
+      # NOTE: File operations are case-insensitive (foo.json and Foo.json are identical)
+      return if File.identical?(src, dst)
+
+      src = Pathname.new(src) unless src.is_a?(Pathname)
+      dst = Pathname.new(dst) unless dst.is_a?(Pathname)
+      dst.delete if dst.exist?
+      File.symlink(src.absolute? ? src : src.realpath, dst)
+    end
+  end
+end

data/lib/cocoapods-spm/helpers/patch.rb

@@ -0,0 +1,14 @@
+module Mixin
+  module PatchingBehavior
+    def patch_method(method_name, &block)
+      raw_method_name = "origin_#{method_name}"
+      alias_method raw_method_name, method_name
+      define_method(method_name, &block)
+      private raw_method_name
+    end
+
+    def self.included(base)
+      base.extend(self)
+    end
+  end
+end

data/lib/cocoapods-spm/hooks/helpers/update_script.rb

@@ -0,0 +1,61 @@
+require "cocoapods-spm/hooks/base"
+
+module Pod
+  module SPM
+    module UpdateScript
+      module Mixin
+        def update_script(options = {})
+          script_name = options[:name]
+          content_by_target = options[:content_by_target]
+
+          aggregate_targets.each do |target|
+            lines, input_paths, output_paths = content_by_target.call(target)
+            next if input_paths.empty?
+
+            update_script_content(
+              path: target.send("#{script_name}_path"),
+              before: options[:insert_before],
+              insert: lines.join("\n")
+            )
+
+            # Update input/output files
+            user_build_configurations.each_key do |config|
+              append_contents = lambda do |method_name, contents|
+                target.send(method_name, config).open("a") do |f|
+                  contents.each { |p| f << "\n" << p }
+                end
+              end
+              append_contents.call("#{script_name}_input_files_path", input_paths)
+              append_contents.call("#{script_name}_output_files_path", output_paths)
+            end
+          end
+        end
+
+        private
+
+        def update_script_content(options = {})
+          match_content = options[:before]
+          insert_content = <<~SH
+            # --------------------------------------------------------
+            # Added by `cocoapods-spm`
+            # --------------------------------------------------------
+            #{options[:insert]}
+            # --------------------------------------------------------
+          SH
+          options[:path].open("r+") do |f|
+            content = f.read
+            offset = content.index(match_content) unless match_content.nil?
+            if offset.nil?
+              f << "\n" << insert_content
+            else
+              f.seek(offset)
+              after_content = f.read
+              f.seek(offset)
+              f << "\n" << insert_content << after_content
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-spm/hooks/post_integrate/5.update_settings.rb

@@ -1,5 +1,5 @@
 require "cocoapods-spm/hooks/base"
-require "cocoapods-spm/metadata"
+require "cocoapods-spm/macro/metadata"
 
 module Pod
   module SPM
@@ -7,22 +7,21 @@ module Pod
       class UpdateSettings < Hook
         def run
           update_macro_plugin_flags
-          update_modulemap_flags
-          update_swift_include_paths
-          update_linker_flags
+          update_packages_flags
         end
 
         private
 
         def macro_plugin_flag_by_config
+          path_prefix = "${PODS_ROOT}/../#{spm_config.macro_prebuilt_root_dir}"
           @macro_plugin_flag_by_config ||= begin
             hash = user_build_configurations.keys.to_h do |config|
               flags = macro_pods.keys.map do |name|
-                metadata = Metadata.for_pod(name)
+                metadata = MacroMetadata.for_pod(name)
                 impl_module_name = metadata.macro_impl_name
                 plugin_executable_path =
-                  "${PODS_ROOT}/../.spm.pods/#{name}/.prebuilt/#{config.to_s.downcase}/" \
-                  "#{impl_module_name}##{impl_module_name}"
+                  "#{path_prefix}/#{name}/" \
+                  "#{impl_module_name}-#{config.to_s.downcase}##{impl_module_name}"
                 "-load-plugin-executable \"#{plugin_executable_path}\""
               end.join(" ")
               [config, flags]
@@ -42,27 +41,20 @@ module Pod
           )
         end
 
-        def update_modulemap_flags
-          perform_settings_update(
-            update_targets: lambda do |target, _, _|
-              {
-                "OTHER_SWIFT_FLAGS" => modulemap_args_for_target(target, prefix: "-Xcc"),
-                "OTHER_CFLAGS" => modulemap_args_for_target(target)
-              }
-            end
-          )
-        end
-
-        def update_linker_flags
+        def update_packages_flags
           return if @spm_resolver.result.spm_pkgs.empty?
 
-          # For packages to work in the main target
           perform_settings_update(
             update_targets: lambda do |target, _, _|
               {
-                "OTHER_LDFLAGS" => linker_flags_for(target),
+                "SOURCE_PACKAGES_CHECKOUTS_DIR" => "${PODS_CONFIGURATION_BUILD_DIR}/../../../SourcePackages/checkouts",
                 "FRAMEWORK_SEARCH_PATHS" => "\"${PODS_CONFIGURATION_BUILD_DIR}/PackageFrameworks\"",
-                "LIBRARY_SEARCH_PATHS" => "\"${PODS_CONFIGURATION_BUILD_DIR}\""
+                "LIBRARY_SEARCH_PATHS" => "\"${PODS_CONFIGURATION_BUILD_DIR}\"",
+                "SWIFT_INCLUDE_PATHS" => "$(PODS_CONFIGURATION_BUILD_DIR)",
+                "OTHER_SWIFT_FLAGS" => modulemap_args_for_target(target, prefix: "-Xcc"),
+                "OTHER_CFLAGS" => modulemap_args_for_target(target),
+                "HEADER_SEARCH_PATHS" => header_search_paths_for(target),
+                "OTHER_LDFLAGS" => linker_flags_for(target),
               }
             end
           )
@@ -74,25 +66,22 @@ module Pod
           @spm_resolver.result.linker_flags_for(target)
         end
 
-        def update_swift_include_paths
-          return if @spm_resolver.result.spm_pkgs.empty? && spm_config.all_macros.empty?
-
-          perform_settings_update(
-            update_targets: lambda do |_, _, _|
-              { "SWIFT_INCLUDE_PATHS" => "$(PODS_CONFIGURATION_BUILD_DIR)" }
-            end
-          )
-        end
-
         def modulemap_args_for_target(target, prefix: nil)
           @spm_resolver
             .result
-            .spm_products_for(target)
-            .reject { |p| p.headers_path.nil? }
-            .map { |p| "-fmodule-map-file=\"${GENERATED_MODULEMAP_DIR}/#{p.name}.modulemap\"" }
+            .spm_targets_for(target)
+            .filter_map(&:clang_modulemap_arg)
             .map { |v| prefix.nil? ? v : "#{prefix} #{v}" }
             .join(" ")
         end
+
+        def header_search_paths_for(target)
+          @spm_resolver
+            .result
+            .spm_targets_for(target)
+            .filter_map(&:header_search_path_arg)
+            .join(" ")
+        end
       end
     end
   end

data/lib/cocoapods-spm/hooks/post_integrate/6.update_embed_frameworks_script.rb

@@ -1,52 +1,30 @@
 require "cocoapods-spm/hooks/base"
+require "cocoapods-spm/hooks/helpers/update_script"
 
 module Pod
   module SPM
     class Hook
       class UpdateEmbedFrameworksScript < Hook
-        def run
-          aggregate_targets.each do |target|
-            next if framework_paths_for(target).empty?
+        include UpdateScript::Mixin
 
-            update_embed_frameworks_script(target)
-            user_build_configurations.each_key do |config|
-              update_embed_frameworks_script_files_path(target, config)
+        def run
+          update_script(
+            name: :embed_frameworks_script,
+            content_by_target: lambda do |target|
+              input_paths = framework_paths_for(target)
+              output_paths = input_paths.map do |p|
+                "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/#{File.basename(p)}"
+              end
+              lines = input_paths.map { |p| "install_framework \"#{p}\"" }
+              [lines, input_paths, output_paths]
             end
-          end
+          )
         end
 
         private
 
         def framework_paths_for(target)
-          @spm_resolver.result.spm_products_for(target).select(&:dynamic?).map do |p|
-            "${BUILT_PRODUCTS_DIR}/PackageFrameworks/#{p.name}.framework"
-          end
-        end
-
-        def update_embed_frameworks_script(target)
-          lines = framework_paths_for(target).map { |p| "install_framework \"#{p}\"" }
-          target.embed_frameworks_script_path.open("a") do |f|
-            f << "\n" << <<~SH
-              # --------------------------------------------------------
-              # Added by `cocoapods-spm` to embed SPM package frameworks
-              # --------------------------------------------------------
-              #{lines.join("\n")}
-              # --------------------------------------------------------
-            SH
-          end
-        end
-
-        def update_embed_frameworks_script_files_path(target, config)
-          input_paths = framework_paths_for(target)
-          output_paths = input_paths.map do |p|
-            "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/#{File.basename(p)}"
-          end
-          target.embed_frameworks_script_input_files_path(config).open("a") do |f|
-            input_paths.each { |p| f << "\n" << p }
-          end
-          target.embed_frameworks_script_output_files_path(config).open("a") do |f|
-            output_paths.each { |p| f << "\n" << p }
-          end
+          @spm_resolver.result.spm_targets_for(target).select(&:dynamic?).map(&:built_framework_path).uniq
         end
       end
     end

data/lib/cocoapods-spm/hooks/post_integrate/7.update_copy_resources_script.rb

@@ -0,0 +1,33 @@
+require "cocoapods-spm/hooks/base"
+require "cocoapods-spm/hooks/helpers/update_script"
+
+module Pod
+  module SPM
+    class Hook
+      class UpdateCopyResourcesScript < Hook
+        include UpdateScript::Mixin
+
+        def run
+          update_script(
+            name: :copy_resources_script,
+            insert_before: Generator::CopyResourcesScript::RSYNC_CALL,
+            content_by_target: lambda do |target|
+              input_paths = resource_paths_for(target)
+              output_paths = input_paths.map do |p|
+                "${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/#{File.basename(p)}"
+              end
+              lines = input_paths.map { |p| "install_resource \"#{p}\"" }
+              [lines, input_paths, output_paths]
+            end
+          )
+        end
+
+        private
+
+        def resource_paths_for(target)
+          @spm_resolver.result.spm_targets_for(target).flat_map(&:resources).map(&:built_resource_path).uniq
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-spm/macro/metadata.rb

@@ -0,0 +1,11 @@
+require "cocoapods-spm/swift/package/description"
+
+module Pod
+  module SPM
+    class MacroMetadata < Swift::PackageDescription
+      def self.for_pod(name)
+        from_file(Config.instance.macro_root_dir / name / "metadata.json")
+      end
+    end
+  end
+end

data/lib/cocoapods-spm/macro/prebuilder.rb

@@ -1,4 +1,4 @@
-require "cocoapods-spm/metadata"
+require "cocoapods-spm/macro/metadata"
 
 module Pod
   module SPM
@@ -26,7 +26,7 @@ module Pod
       end
 
       def macro_prebuilt_dir
-        macro_dir / ".prebuilt"
+        spm_config.macro_prebuilt_root_dir / name
       end
 
       def metadata_path
@@ -39,7 +39,7 @@ module Pod
 
         raw = Dir.chdir(macro_downloaded_dir) { `swift package dump-package` }
         metadata_path.write(raw)
-        @metadata = Metadata.from_s(raw)
+        @metadata = MacroMetadata.from_s(raw)
       end
 
       def prebuild_macro_impl
@@ -47,7 +47,8 @@ module Pod
 
         config = spm_config.macro_config
         impl_module_name = @metadata.macro_impl_name
-        return if spm_config.dont_prebuild_macros_if_exist? && (macro_prebuilt_dir / config / impl_module_name).exist?
+        prebuilt_binary = macro_prebuilt_dir / "#{impl_module_name}-#{config}"
+        return if spm_config.dont_prebuild_macros_if_exist? && prebuilt_binary.exist?
 
         UI.section "Building macro implementation: #{impl_module_name} (#{config})...".green do
           Dir.chdir(macro_downloaded_dir) do
@@ -55,10 +56,10 @@ module Pod
           end
         end
 
-        (macro_prebuilt_dir / config).mkpath
+        prebuilt_binary.parent.mkpath
         FileUtils.copy_entry(
           macro_downloaded_dir / ".build" / config / impl_module_name,
-          macro_prebuilt_dir / config / impl_module_name
+          prebuilt_binary
         )
       end
     end

data/lib/cocoapods-spm/main.rb

@@ -1,5 +1,6 @@
+require "cocoapods-spm/helpers/io"
+require "cocoapods-spm/helpers/patch"
 require "cocoapods-spm/config"
-require "cocoapods-spm/metadata"
 require "cocoapods-spm/executables"
 require "cocoapods-spm/def/target_definition"
 require "cocoapods-spm/def/podfile"