cocoapods-project-gen 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8224b3941957448267846730698368b63e05c21813a8785cef0077ffb5ea56b2
-  data.tar.gz: 525e97837422369163770a4e56fd3baadc67edeea2c5b156505e91c6325b78df
+  metadata.gz: ea8031db47261426a1e1ac999b16ffdcaff6e404fa9ebe8ea790f654720b04b9
+  data.tar.gz: b9de39c0d6fb2944bcb5be0bab8e175d14ba65a0d5eb865c491e4fd1fcd8bc5d
 SHA512:
-  metadata.gz: 2e62a1df71643dcc9f824c2a330e6d30d4c8854011e5d1b6b6bdcb696349d1766e288bde42d1e36730a0a988cf7bfd60e5d2c59cfbc7b0215bbce51536cde705
-  data.tar.gz: 9b0e65439b421036a9ef85bc2983edb34f16c3592cdbce370865387c57e47efc04e71b50dcbed185ceb873a651f17e8e4058baf2cf9599ccebbd8c9deea2e4cd
+  metadata.gz: b2576574c992dd78e94f3a69a3ed17419c4e09dcf2cfa314190c22b73c7a0227dc22a0b161e0943e62dd21f56e329e05f1e11883a183674e840543a8568124af
+  data.tar.gz: 23b165ff2623b80e727c0f9d630ebb3321b0d75b261ed7d36115bff4ff60b249e74097b53d61f421125f2c5191d75c8eb088de79f9b674ddca9edce7b3e919c2

data/README.md

@@ -25,55 +25,94 @@ Or install it yourself as:
 # gem install
 $ gem install cocoapods-project-gen
 ```
+
 ### Quickstart
 
+To begin gen an cocoapods project by opening an podpsec dir, and to your command line with:
+
+```shell
+xcframework gen 
+```
+
+or
+
+```shell
+xcframework gen --output-dir=<xcframework output dir>
+```
+
+```shell
+xcframework gen --output-dir=<xcframework output dir> **.podspec
+```
+
 To begin gen an cocoapods project start by create an `ProjectGenerator`:
 
 ```ruby
-require 'cocoapods-project-gen'
-podspecs = Pathname.glob(File.expand_path("./Resources/AFNetworking-master", __dir__) + '/*.podspec{.json,}')
-out_put = File.expand_path("./Resources/output", __dir__)
-gen = ProjectGen::ProjectGenerator.new_from_local(podspecs, [])
-gen.generate!(out_put) do |platforms, pod_targets, validated|
-    p platforms, pod_targets, validated
-end
+podspecs = [**.podspec]
+ProjectGen::Command.run(['gen', "--output-dir=#{File.expand_path('./Resources/output', __dir__)}", *podspecs])
 ```
 
-or use this way:
+or to build for xcframework use this way:
 
 ```ruby
 require 'cocoapods-project-gen'
 
 product_type = :dynamic_framework
 use_module = true
-include_podspecs = []
+external_podspecs = []
 swift_version = '4.2'
 configuration = :release
+output_dir = <output dir>
 generator = ProjectGen::ProjectGenerator.new(include_podspecs.first, @sources, @platforms)
 generator.local = false
 generator.no_clean       = false
 generator.allow_warnings = true
-generator.no_subspecs    = true
-generator.only_subspec   = false
+generator.only_subspec   = %w[AFNetworking/UIKit AFNetworking/Reachability]
 generator.use_frameworks = product_type == :dynamic_framework
 generator.use_static_frameworks = product_type == :framework
 generator.use_modular_headers = use_module
-generator.skip_import_validation = true
-generator.external_podspecs = include_podspecs.drop(1)
+generator.external_podspecs = external_podspecs.drop(1)
 generator.swift_version = swift_version
 generator.configuration = configuration
-generator.skip_tests = true
-begin
-    generator.generate!(spec_root) do |platform, pod_targets, validated|
-        raise 'Could not generator App.xcodeproj' unless validated
-
-    end
-rescue StandardError => e
-    raise Pod::Informative, "The `#{@include_podspecs.join(' ')}` specification does not validate." \
-                    "\n\n#{e.message}"
-end
+# xcframework gen
+xc_gen = ProjectGen::XcframeworkGen.new(generator)
+xc_gen.generate_xcframework(output_dir, build_library_for_distribution: true)
+```
+
+other options:
+
+```ruby
+['--no-build', 'Is or is not to build xcframework'],
+['--build-library-for-distribution', ' Enables BUILD_LIBRARY_FOR_DISTRIBUTION'],
+['--use-latest', 'When multiple dependencies with different sources, use latest.'],
+['--local', 'podpsecs is local or not'],
+['--output-dir=/project/dir/', 'Gen output dir'],
+['--allow-warnings', 'Gen even if warnings are present'],
+['--subspecs=NAME/NAME', 'Gen only the given subspecs'],
+['--no-clean', 'Gen leaves the build directory intact for inspection'],
+['--use-libraries', 'Gen uses static libraries to install the spec'],
+['--use-modular-headers', 'Gen uses modular headers during installation'],
+['--use-static-frameworks', 'Gen uses static frameworks during installation'],
+["--sources=#{Pod::TrunkSource::TRUNK_REPO_URL}", 'The sources from which to pull dependent pods ' \
+"(defaults to #{Pod::TrunkSource::TRUNK_REPO_URL}). Multiple sources must be comma-delimited"],
+['--platforms=ios,macos', 'Gen against specific platforms (defaults to all platforms supported by the ' \
+'podspec). Multiple platforms must be comma-delimited'],
+['--swift-version=VERSION', 'The `SWIFT_VERSION` that should be used to gen the spec. ' \
+'This takes precedence over the Swift versions specified by the spec or a `.swift-version` file'],
+['--include-podspecs=**/*.podspec', 'Additional ancillary podspecs which are used for gening via :path'],
+['--external-podspecs=**/*.podspec', 'Additional ancillary podspecs which are used for gening '\
+'via :podspec. If there are --include-podspecs, then these are removed from them'],
+['--configuration=CONFIGURATION', 'Build using the given configuration (defaults to Release)']
 ```
 
+## Command Line Tool
+
+Installing the `cocoapods-project-gen` gem will also install one command-line tool `xcframework gen`  which you can use to generate xcframework from podspec.
+
+For more information consult
+
+- `xcframework --help`
+- `xcframework gen --help`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [cocoapods-project-gen](https://github.com/Cat1237/cocoapods-project-gen). This project is intended to be a safe, welcoming space for collaboration.

data/bin/xcframework

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+if $PROGRAM_NAME == __FILE__
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', __dir__)
+  require 'bundler/setup'
+end
+
+require 'cocoapods-project-gen'
+
+ProjectGen::Command.run(ARGV)

data/lib/cocoapods-project-gen/command/command.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# The primary namespace for Gen.
+module ProjectGen
+  require 'colored2'
+  require 'claide'
+  # The primary Command for Gen.
+  class Command < CLAide::Command
+    require 'cocoapods-project-gen/command/gen'
+
+    self.abstract_command = false
+    self.command = 'xcframework'
+    self.version = VERSION
+    self.description = 'Creates Pods project and gen xcframework.'
+    self.plugin_prefixes = %w[claide gen]
+
+    def initialize(argv)
+      super
+      return if ansi_output?
+
+      Colored2.disable!
+      String.send(:define_method, :colorize) { |string, _| string }
+    end
+  end
+end

data/lib/cocoapods-project-gen/command/gen.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module ProjectGen
+  class Command
+    # hmap file gen cmd
+    class Gen < Command
+      # summary
+      self.summary = 'Creates Pods project and gen xcframework.'
+
+      self.description = <<-DESC
+        Creates the target for the Pods libraries in the Pods project and the relative support files and gen xcframework.
+      DESC
+
+      self.arguments = [
+        CLAide::Argument.new('PODSPEC_PATHS', false, true)
+      ]
+
+      def initialize(argv)
+        super
+        @build    = argv.flag?('build', true)
+        @local = argv.flag?('local')
+        @build_library_for_distribution = argv.flag?('build-library-for-distribution')
+        @use_latest = argv.flag?('use-latest', true)
+        output_dir = argv.option('output-dir', Pathname.pwd)
+        @output_dir = Pathname.new(output_dir).expand_path.join('project_gen/App')
+        @allow_warnings      = argv.flag?('allow-warnings', true)
+        @clean               = argv.flag?('clean', false)
+        @only_subspecs       = argv.option('subspecs', '').split(',')
+        @use_frameworks      = !argv.flag?('use-libraries')
+        @use_modular_headers = argv.flag?('use-modular-headers', true)
+        @use_static_frameworks = argv.flag?('use-static-frameworks')
+        @source_urls         = argv.option('sources', Pod::TrunkSource::TRUNK_REPO_URL).split(',')
+        @platforms           = argv.option('platforms', '').split(',')
+        @swift_version       = argv.option('swift-version', nil)
+        @include_podspecs    = argv.option('include-podspecs', '').split(',').map { |path| Pathname.new(path).expand_path }
+        @external_podspecs   = argv.option('external-podspecs', '').split(',').map { |path| Pathname.new(path).expand_path }
+        @podspecs_paths      = argv.arguments!
+        @configuration       = argv.option('configuration', nil)
+      end
+
+      def validate!
+        super
+      end
+
+      # help
+      def self.options
+        [
+          ['--no-build', 'Is or is not to build xcframework'],
+          ['--build-library-for-distribution', ' Enables BUILD_LIBRARY_FOR_DISTRIBUTION'],
+          ['--use-latest', 'When multiple dependencies with different sources, use latest.'],
+          ['--local', 'podpsecs is local or not'],
+          ['--output-dir=/project/dir/', 'Gen output dir'],
+          ['--allow-warnings', 'Gen even if warnings are present'],
+          ['--subspecs=NAME/NAME', 'Gen only the given subspecs'],
+          ['--no-clean', 'Gen leaves the build directory intact for inspection'],
+          ['--use-libraries', 'Gen uses static libraries to install the spec'],
+          ['--use-modular-headers', 'Gen uses modular headers during installation'],
+          ['--use-static-frameworks', 'Gen uses static frameworks during installation'],
+          ["--sources=#{Pod::TrunkSource::TRUNK_REPO_URL}", 'The sources from which to pull dependent pods ' \
+            "(defaults to #{Pod::TrunkSource::TRUNK_REPO_URL}). Multiple sources must be comma-delimited"],
+          ['--platforms=ios,macos', 'Gen against specific platforms (defaults to all platforms supported by the ' \
+            'podspec). Multiple platforms must be comma-delimited'],
+          ['--swift-version=VERSION', 'The `SWIFT_VERSION` that should be used to gen the spec. ' \
+           'This takes precedence over the Swift versions specified by the spec or a `.swift-version` file'],
+          ['--include-podspecs=**/*.podspec', 'Additional ancillary podspecs which are used for gening via :path'],
+          ['--external-podspecs=**/*.podspec', 'Additional ancillary podspecs which are used for gening '\
+            'via :podspec. If there are --include-podspecs, then these are removed from them'],
+          ['--configuration=CONFIGURATION', 'Build using the given configuration (defaults to Release)']
+        ].concat(super)
+      end
+
+      def run
+        generator = ProjectGenerator.new(@source_urls, @platforms)
+        generator.local          = @local
+        generator.no_clean       = !@clean
+        generator.use_latest = @use_latest
+        generator.allow_warnings = @allow_warnings
+        generator.only_subspecs   = @only_subspecs
+        generator.use_frameworks = @use_frameworks
+        generator.use_modular_headers = @use_modular_headers
+        generator.use_static_frameworks = @use_static_frameworks
+        generator.swift_version = @swift_version
+        generator.include_podspecs = @include_podspecs
+        generator.external_podspecs = @external_podspecs
+        if @local
+          generator.include_podspecs += podspecs_to_gen
+          generator.include_podspecs.uniq!
+        else
+          generator.external_podspecs += podspecs_to_gen
+          generator.external_podspecs.uniq!
+        end
+        if generator.include_podspecs.empty? && generator.external_podspecs.empty?
+          raise Informative, 'Unable to find podspecs in the working. Is local or not local?'
+        end
+
+        generator.configuration = @configuration
+        xc_gen = ProjectGen::XcframeworkGen.new(generator)
+        xc_gen.generate_xcframework(@output_dir, build: @build, build_library_for_distribution: @build_library_for_distribution)
+      end
+
+      private
+
+      # !@group Private helpers
+
+      # @return [Pathname] The path of the podspec found in the current
+      #         working directory.
+      #
+      # @raise  If no podspec is found.
+      # @raise  If multiple podspecs are found.
+      #
+      def podspecs_to_gen
+        if @podspecs_paths.empty?
+          Pathname.glob(Pathname.pwd.join('*.podspec{.json,}'))
+        else
+          Array(@podspecs_paths).map { |path| Pathname.new(path).expand_path }
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-project-gen/gem_version.rb

@@ -1,3 +1,3 @@
 module ProjectGen
-  VERSION = "0.1.0"
+  VERSION = "0.2.3"
 end

data/lib/cocoapods-project-gen/gen/build/headers_store.rb

@@ -0,0 +1,104 @@
+require 'fileutils'
+require 'cocoapods/sandbox'
+
+module ProjectGen
+  # Provides support for managing a header directory. It also keeps track of
+  # the header search paths.
+  #
+  class HeadersStore
+    SEARCH_PATHS_KEY = Struct.new(:platform_name, :target_name, :use_modular_headers)
+
+    # @return [Pathname] the absolute path of this header directory.
+    #
+    def root(source: false)
+      root = if source
+               sandbox.sources_root
+             else
+               sandbox.headers_root
+             end
+
+      root + @relative_path
+    end
+
+    # @return [Sandbox] the sandbox where this header directory is stored.
+    #
+    attr_reader :sandbox
+
+    # @param  [Sandbox] @see #sandbox
+    #
+    # @param  [String] relative_path
+    #         the relative path to the sandbox root and hence to the Pods
+    #         project.
+    #
+    # @param  [Symbol] visibility_scope
+    #         the header visibility scope to use in this store. Can be `:private` or `:public`.
+    #
+    def initialize(sandbox, relative_path, visibility_scope)
+      @sandbox       = sandbox
+      @relative_path = relative_path
+      @search_paths  = []
+      @search_paths_cache = {}
+      @visibility_scope = visibility_scope
+    end
+
+    #-----------------------------------------------------------------------#
+
+    # @!group Adding headers
+
+    # Adds headers to the directory.
+    #
+    # @param  [Pathname] namespace
+    #         the path where the header file should be stored relative to the
+    #         headers directory.
+    #
+    # @param  [Array<Pathname>] relative_header_paths
+    #         the path of the header file relative to the Pods project
+    #         (`PODS_ROOT` variable of the xcconfigs).
+    #
+    # @note   This method does _not_ add the files to the search paths.
+    #
+    # @return [Array<Pathname>]
+    #
+    def add_files(namespace, relative_header_paths, ln: false, source: false)
+      root(source: source).join(namespace).mkpath unless relative_header_paths.empty?
+      relative_header_paths.map do |relative_header_path|
+        add_file(namespace, relative_header_path, ln: ln, mkdir: false, source: source)
+      end
+    end
+
+    # Adds a header to the directory.
+    #
+    # @param  [Pathname] namespace
+    #         the path where the header file should be stored relative to the
+    #         headers directory.
+    #
+    # @param  [Pathname] relative_header_path
+    #         the path of the header file relative to the Pods project
+    #         (`PODS_ROOT` variable of the xcconfigs).
+    #
+    # @note   This method does _not_ add the file to the search paths.
+    #
+    # @return [Pathname]
+    #
+    def add_file(namespace, relative_header_path, ln: false, mkdir: true, source: false)
+      namespaced_path = root(source: source) + namespace
+      namespaced_path.mkpath if mkdir
+
+      absolute_source = (sandbox.root + relative_header_path)
+      source = absolute_source.relative_path_from(namespaced_path)
+      full_namespaced_path = namespaced_path.join(relative_header_path.basename)
+      return full_namespaced_path if full_namespaced_path.exist?
+
+      if ln
+        if Gem.win_platform?
+          FileUtils.ln(absolute_source, namespaced_path, force: true)
+        else
+          FileUtils.ln_sf(source, namespaced_path)
+        end
+      else
+        FileUtils.cp_r(absolute_source, namespaced_path)
+      end
+      full_namespaced_path
+    end
+  end
+end

data/lib/cocoapods-project-gen/gen/build/xcode_build.rb

@@ -0,0 +1,47 @@
+require 'cocoapods/executable'
+
+module ProjectGen
+  module XcodeBuild
+
+    def self.archive?(args, project_path, scheme, archive_path)
+      command = %w[archive -showBuildTimingSummary]
+      command += args
+      command += %W[-project #{project_path} -scheme #{scheme} -archivePath #{archive_path}]
+      command += %w[SKIP_INSTALL=NO]
+      results = Results.new
+      output = begin
+        Pod::Executable.execute_command('xcodebuild', command, true)
+      rescue StandardError => e
+        message = 'Returned an unsuccessful exit code.'
+        results.error('xcodebuild', message)
+        e.message
+      end
+      results.translate_xcodebuild_output_to_messages(output)
+      return false unless results.result_type == :error
+
+      results.print_results
+      true
+    end
+
+    def self.create_xcframework?(args, output_path)
+      command = %w[-create-xcframework]
+      command += args
+      command += %W[-output #{output_path}]
+
+      results = Results.new
+      output = begin
+        Pod::Executable.execute_command('xcodebuild', command, true)
+      rescue StandardError => e
+        message = 'Returned an unsuccessful exit code.'
+        results.error('xcodebuild', message)
+        e.message
+      end
+
+      results.translate_xcodebuild_output_to_messages(output)
+      return false unless results.result_type == :error
+
+      results.print_results
+      true
+    end
+  end
+end

data/lib/cocoapods-project-gen/gen/constants.rb

@@ -0,0 +1,71 @@
+module ProjectGen
+  # This modules groups all the constants known to .
+  #
+  module Constants
+    PRODUCT_DIR = 'Products'.freeze
+
+    # The default version of Swift to use when linting pods
+    #
+    DEFAULT_SWIFT_VERSION = '4.0'.freeze
+
+    # The valid platforms for linting
+    #
+    VALID_PLATFORMS = Pod::Platform.all.freeze
+
+    COPY_LIBRARY_SWIFT_HEADERS = 'Copy-Library-Swift-Headers'.freeze
+
+    # Whether the platform with the specified name is valid
+    #
+    # @param  [Platform] platform
+    #         The platform to check
+    #
+    # @return [Boolean] True if the platform is valid
+    #
+    def self.valid_platform?(platform)
+      VALID_PLATFORMS.any? { |p| p.name == platform.name }
+    end
+
+    def self.sdks(platform_name)
+      case platform_name
+      when :osx, :macos
+        %i[macosx]
+      when :ios
+        %i[iphonesimulator iphoneos]
+      when :watchos
+        %i[watchsimulator watchos]
+      when :tvos
+        %i[appletvsimulator appletvos]
+      end
+    end
+
+    # @return [Hash] The extensions or the various product UTIs.
+    #
+    PRODUCT_UTI_EXTENSIONS = {
+      framework: 'framework',
+      dynamic_framework: 'dynamic_framework',
+      dynamic_library: 'dylib',
+      static_library: 'a',
+      bundle: 'bundle'
+    }.freeze
+
+    SDK_ARCHS = {
+      iphonesimulator: %w[x86_64 arm64 i386],
+      iphoneos: %w[arm64],
+      watchos: %w[armv7k arm64_32],
+      watchsimulator: %w[x86_64 arm64],
+      appletvos: %w[x86_64 arm64],
+      appletvsimulator: %w[x86_64 arm64],
+      macosx: %w[x86_64 arm64]
+    }.freeze
+
+    SDK_DESTINATION = {
+      iphonesimulator: 'iOS Simulator',
+      iphoneos: 'iOS',
+      watchos: 'watchOS',
+      watchsimulator: 'watchOS Simulator',
+      appletvos: 'tvOS',
+      appletvsimulator: 'tvOS Simulator',
+      macosx: 'macOS'
+    }.freeze
+  end
+end

data/lib/cocoapods-project-gen/gen/pod/pod_copy_cleaner.rb

@@ -0,0 +1,50 @@
+module ProjectGen
+  class PodDirCopyCleaner
+    def initialize(podspecs)
+      @podspecs = podspecs
+    end
+
+    # Copies the `source` directory to `destination`, cleaning the directory
+    # of any files unused by `spec`.
+    #
+    # @return [Void]
+    #
+    def copy_and_clean(root, sandbox)
+      @podspecs.each do |spec|
+        destination = root + spec.name
+        source = sandbox.pod_dir(spec.name)
+        specs_by_platform = group_subspecs_by_platform(spec)
+        destination.parent.mkpath
+        FileUtils.rm_rf(destination)
+        copy(source, destination, specs_by_platform)
+      end
+    end
+
+    def group_subspecs_by_platform(spec)
+      specs_by_platform = {}
+      [spec, *spec.recursive_subspecs].each do |ss|
+        ss.available_platforms.each do |platform|
+          specs_by_platform[platform] ||= []
+          specs_by_platform[platform] << ss
+        end
+      end
+      specs_by_platform
+    end
+
+    def copy(source, destination, specs_by_platform)
+      path_list = Pod::Sandbox::PathList.new(source)
+      file_accessors = specs_by_platform.flat_map do |platform, specs|
+        specs.flat_map do |spec|
+          Pod::Sandbox::FileAccessor.new(path_list, spec.consumer(platform))
+        end
+      end
+      used_files = Pod::Sandbox::FileAccessor.all_files(file_accessors)
+      used_files.each do |path|
+        path = Pathname(path)
+        n_path = destination.join(path.relative_path_from(source))
+        n_path.dirname.mkpath
+        FileUtils.cp_r(path, n_path.dirname)
+      end
+    end
+  end
+end