cocoapods-mapfile 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e843368c99922210970ea7de9ab8d2bcc895a158901d054a1cd076d29d73310
-  data.tar.gz: 8f7430064b4472cb4fd6c9fa42dfdd7a144d314c702ab7500a42b0ff302d9ab5
+  metadata.gz: 7638b72b3d9fe0246d6dd7a06aba65b29ad95ccc30fdf7567626141f90c58d43
+  data.tar.gz: 62b76aa9a97ada6c2e0e187092c2c8ad669e1d55bd07e6efe0f95f00cc0ba5a1
 SHA512:
-  metadata.gz: e1b0fbf54c2976dd6f7fcba6eca0d1d421a1df6360216e2049643d6ec1133592f19ce49786f58d0c100d71ce923492cf0135be75cbffbaae6e5a40f8b2a1c749
-  data.tar.gz: 9429682a00e5c633baf19f845f691b7fd64b6fa687af9afcb776b5beb86245338e5d1b2d910482809f66d91f660fb02e69c6ce1d3026922f1c6cf447e4345d0d
+  metadata.gz: 723055fb0d1a47079499121296b2c0236f007a96a6cc023f6518a1888a3cb0d87e09de92dc6a820193187e1b9e3e8cdfc5d7c4d6fa2820942768b4972ddde1a7
+  data.tar.gz: 05d078150dca66846048b6dc73b29e2c6dd8d8e182bf1504dd3a17b973cd5101c2429d8c63cbd0d4d886ef92d920116481415c56542f1ae4adeda7574b48691d

data/README.md

@@ -7,11 +7,13 @@ A CocoaPods plugin which can gen/read header map file.
 **hmap-gen** is able to scan the header files of the target referenced components in the specified Cocoapods project, and generates a header map file that public to all the components
 as well as generates a public and private header map file for each referenced component.
 
-    - `<header.h>` : -I<hmap file path>
-    - `header.h` : iquote <hmap file path>
+    - <header.h> : -I<hmap file path>
+    - "header.h" : -iquote <hmap file path>
 
 For framework, use [yaml-vfs](https://github.com/Cat1237/yaml-vfs) create VFS file to map framework Headers and Modules dir and pass VFS file to `-ivfsoverlay` parameter.
 
+    - vfs : -ivfsoverlay <all-product-headers.yaml>
+
 A hmap file includes four types of headers:
 
     - header.h
@@ -19,12 +21,6 @@ A hmap file includes four types of headers:
     - <project_name/header.h> **based on podspec**
     - <podspec source header/**/header.h> **based on podspec**
 
-At the same time, **hmap-reader** can read the header, bucktes, string_table information saved in the header map file.
-
-- ✅ It can read hmap file.
-
-- ✅ It can generate header map file.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -64,39 +60,73 @@ $ pod hmap-gen --project-directory=/project/dir/ --nosave-origin-header-search-p
 # cleanup the hmap file
 $ pod hmap-gen --clean-hmap
 
+# no keep xcconfig file [HEADER_SEARCH_PATHS] and [USER_HEADER_SEARCH_PATHS] value
+$ pod hmap-gen --fno-save-origin
+
+# ⚠️no keep xcconfig file [HEADER_SEARCH_PATHS] and [USER_HEADER_SEARCH_PATHS] value, except for the values ​​set by[--allow-targets]
+$ pod hmap-gen --fno-save-origin --allow-targets=Realm, YYKit
+
+# not use automatically generated hmap file from Xcode， use [hmap-gen]
+$ pod hmap-gen --fno-use-origin-headermap
+
 # read the hmap file from /hmap/dir/file
 $ pod hmap-reader --hmap-path=/hmap/dir/file
 ```
 
-At same time, you can put this line in your podfile:
-
 ```rb
 plugin 'cocoapods-mapfile'
 ```
 This was equl:
 ```rb
-pod hmap-gen --project-directory=/project/dir/ 
+$ pod hmap-gen --project-directory=/project/dir/ 
 ```
+or, you can set some value:
 
-Every time you execute pod install or pod update, `cocoapods-mapfile` will automatically generate a `header map file` for you and modify `HEAD_SEARCH_PATHS`.
+```rb
+plugin('cocoapods-mapfile', allow_targets: ['Realm', 'YYKit'], save_origin: false, use_origin_headermap: false)
+```
+This was equl:
+```rb
+$ pod hmap-gen --fno-save-origin --fno-use-origin-headermap --allow-targets=Realm, YYKit
+```
 
-### Option && Flags
+Every time you execute pod install or pod update, `cocoapods-mapfile` will automatically generate a `header map file` for you and modify:
+- `OTHER_CPLUSPLUSFLAGS`
+- `OTHER_CFLAGS`
+- `USE_HEADERMAP`
+- `USER_HEADER_SEARCH_PATHS`
+- `HEAD_SEARCH_PATHS`
 
-`hmap-gen/hmap-writer`:
+## Command Line Tool
 
-- `--project-directory=/project/dir/`: The path to the root of the project directory.
-- `--nosave-origin-header-search-paths`: This option will not save xcconfig origin [HEADER_SEARCH_PATHS] and put `hmap file path` first.
-- `--clean-hmap`: This option will clean up all `hmap-gen/hmap-writer` setup for hmap.
+Installing the `cocoapods-mapfile` gem will also install two command-line tool `hmapfile reader` and `hmapfile writer` which you can use to generate header map file and read hmap file.
 
-`hmap-reader`:
+For more information consult 
+- `hmapfile --help`,
+- `hmapfile reader --help`
+- `hmapfile writer --help`
 
-- `--hmap-path=/hmap/dir/file`: The path of the hmap file.
+### Usage
 
-## Command Line Tool
+```shell
+# Read or write header map file.
+$ hmapfile COMMAND
+```
+#### Commands
+`hmapfile reader`:
+- `--hmap-path=/hmap/dir/file`: Read this path of the hmap file.
+
+`hmapfile writer`:
+ - `--json-path=/project/dir/json`: The path to the hmap json data.
+- `--output-path=/project/dir/hmap file`: The path json data to the hmap file.
 
-Installing the 'cocoapods-mapfile' gem will also install two command-line tool `hmap_reader` and `hmap-writer` which you can use to generate header map file and read hmap file.
+example：
 
-For more information consult `hmap_reader --help` or `hmap_writer --help`.
+```shell
+hmapfile writer --json-path=../cat.json --output-path=../cat.hmap
+
+hmapfile reader --hmap-path=../cat.hmap
+```
 
 ## Contributing
 

data/bin/{hmap_writer → hmapfile}

@@ -6,6 +6,6 @@ if $PROGRAM_NAME == __FILE__
   require 'bundler/setup'
 end
 
-require 'cocoapods-hmap/command/hmap_gen'
+require 'hmap'
 
-Pod::Command::HMapGen.run(ARGV)
+HMap::Command.run(ARGV)

data/lib/cocoapods_plugin.rb

@@ -1,13 +1,27 @@
 # frozen_string_literal: true
 
-require 'cocoapods-hmap/command/hmap_gen'
-require 'cocoapods-hmap/command/hmap_reader'
+require 'hmap/command/hmap_gen'
 
 module Pod
   # hook
   module CocoaPodsHMapHook
-    HooksManager.register('cocoapods-mapfile', :post_install) do
-      Command::HMapGen.run(["--project-directory=#{Config.instance.installation_root}"])
+    @HooksManager = HooksManager
+    @HooksManager.register('cocoapods-mapfile', :post_install) do |_, options|
+      args = ["--project-directory=#{Config.instance.installation_root}"]
+      allow_targets = options['allow_targets']
+      unless allow_targets.nil?
+        if allow_targets.is_a?(Array)
+          args << "--allow-targets=#{allow_targets.join(', ')}" unless allow_targets.empty?
+        else
+          print 'waring:'.yellow, \
+                'plugin cocoapods-mapfile args allow_targets must be a array, like ## allow_targets: [target1, targte2] ##'
+        end
+      end
+      save_origin = options['save_oripodgin'].nil? ? true : options['save_origin']
+      use_origin_headermap = options['use_origin_headermap'].nil? ? true : options['use_origin_headermap']
+      args << '--fno-save-origin' unless save_origin
+      args << '--fno-use-origin-headermap' unless use_origin_headermap
+      Command::HMapGen.run(args)
     end
   end
 end

data/lib/{cocoapods-hmap → hmap}/command/hmap_gen.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'cocoapods_hmap'
-require 'cocoapods'
+require 'hmap'
 
 module Pod
   class Command
@@ -17,9 +16,11 @@ module Pod
       def initialize(argv)
         super
         project_directory = argv.option('project-directory')
-        @save_origin_header_search_paths = !argv.flag?('nosave-origin-header-search-paths', false)
+        targets = argv.option('allow-targets') || ''
+        @allow_targets = targets.split(%r{,\s*})
+        @no_use_build_in_headermap = !argv.flag?('fno-use-origin-headermap', false)
+        @save_origin_build_setting = !argv.flag?('fno-save-origin', false)
         @clean_hmap = argv.flag?('clean-hmap', false)
-
         return if project_directory.nil?
 
         @project_directory = Pathname.new(project_directory).expand_path
@@ -34,16 +35,23 @@ module Pod
       # help
       def self.options
         [
-          ['--project-directory=/project/dir/', 'The path to the root of the project
-            directory'],
-          ['--nosave-origin-header-search-paths', 'This option will not save xcconfig origin [HEADER_SEARCH_PATHS] and put hmap file first'],
+          ['--project-directory=/project/dir/', 'The path to the root of the project directory'],
+          ['--allow-targets=target, target1, target2', 'If we set --fno-use-origin-headermap and ' \
+            '--fno-save-origin, we can use this option to decide which targets to use hmap file while keeping the initial settings'],
+          ['--fno-save-origin',
+           'This option will not save xcconfig origin [HEADER_SEARCH_PATHS] and put hmap file first'],
+          ['--fno-use-origin-headermap',
+           'This option will use  Xcode built-in options Use Header Maps and not use this code gen hmap file'],
           ['--clean-hmap', 'This option will clean up all hmap-gen setup for hmap.']
         ].concat(super)
       end
 
       def run
         UI.section "\n[hmap-gen] start.............." do
-          HMap::MapFileWriter.new(@save_origin_header_search_paths, @clean_hmap)
+          HMap::MapFileWriter.new(@save_origin_build_setting,
+                                  @clean_hmap,
+                                  @allow_targets,
+                                  use_build_in_headermap: @no_use_build_in_headermap)
         end
         UI.puts('[hmap-gen] finish..............')
       end

data/lib/{cocoapods-hmap → hmap}/command/hmap_reader.rb

@@ -1,18 +1,22 @@
 # frozen_string_literal: false
 
-require 'cocoapods_hmap'
-require 'cocoapods'
+require 'hmap'
 
-module Pod
+module HMap
   class Command
     # hmap file reader cmd
-    class HMapReader < Command
+    class Reader < Command
       self.summary = 'Read mapfile and puts result.'
 
       self.description = <<-DESC
       Read mapfile and puts result, header, buckets, string_table.
       DESC
 
+      self.arguments = [
+        # framework_p, r_header, r_m
+        CLAide::Argument.new('--hmap-path', true)
+      ]
+
       def initialize(argv)
         super
         mapfile_path = argv.option('hmap-path')
@@ -21,7 +25,7 @@ module Pod
 
       def validate!
         super
-        banner! if help?
+        # banner! if help?
         raise '[ERROR]: --hmap-path no set'.red unless File.exist?(@mapfile_path)
       end
 
@@ -32,10 +36,9 @@ module Pod
       end
 
       def run
-        UI.section "\n[hmap-reader] start..............\n".yellow do
-          HMap::MapFileReader.new(@mapfile_path)
-        end
-        UI.puts("\n[hmap-reader] finish..............\n".yellow)
+        puts "\n[hmap-reader] start..............\n".yellow
+        HMap::MapFileReader.new(@mapfile_path)
+        puts "\n[hmap-reader] finish..............\n".yellow
       end
     end
   end

data/lib/hmap/command/hmap_writer.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module HMap
+  class Command
+    # hmap file gen cmd
+    class Writer < Command
+      # summary
+      self.summary = 'Analyzes the input json and gen each dependencie mapfile.'
+
+      self.description = <<-DESC
+      Analyzes the input json and gen each dependencie mapfile.
+      DESC
+
+      self.arguments = [
+        # framework_p, r_header, r_m
+        CLAide::Argument.new('--json-path', true),
+        CLAide::Argument.new('--output-path', false)
+      ]
+
+      def initialize(argv)
+        super
+        json_path = argv.option('json-path')
+        @json_path = json_path unless json_path.nil?
+        output_path = argv.option('output-path')
+        @output_path = output_path.nil? ? Pathname('.') : Pathname(output_path)
+      end
+
+      def validate!
+        super
+        help! 'error: no input json files which to use with the `--json-path` option.' if @json_path.nil?
+        help! "error: Input json file #{@json_path}: no such file" unless File.exist?(@json_path)
+      end
+
+      # help
+      def self.options
+        [
+          ['--json-path=/project/dir/json', 'The path to the hmap json data.'],
+          ['--output-path=/project/dir/hmap file', 'The path json data to the hmap file.']
+        ].concat(super)
+      end
+
+      def run
+        puts "\n[hmap-gen-from-json] start..............".yellow
+        json_file = File.read(@json_path)
+        json = JSON.parse(json_file)
+        path = @output_path
+        path = path.join("#{File.basename(@json_path, '.*')}.hmap") if path.directory?
+        HMapSaver.new_from_buckets(json).write_to(path)
+        puts '[hmap-gen-from-json] finish..............'.yellow
+      end
+    end
+  end
+end

data/lib/hmap/command.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# The primary namespace for VFS.
+module HMap
+  require 'colored2'
+  require 'claide'
+  # The primary Command for VFS.
+  class Command < CLAide::Command
+    require 'hmap/command/hmap_writer'
+    require 'hmap/command/hmap_reader'
+
+    self.abstract_command = false
+    self.command = 'hmapfile'
+    self.version = VERSION
+    self.description = 'Read or write header map file.'
+    self.plugin_prefixes = %w[claide writer reader]
+
+    def initialize(argv)
+      super
+      return if ansi_output?
+
+      Colored2.disable!
+      String.send(:define_method, :colorize) { |string, _| string }
+    end
+  end
+end

data/lib/{cocoapods-hmap → hmap}/framework/framework_vfs.rb

@@ -1,5 +1,8 @@
+require 'yaml_vfs'
+
 module HMap
   module Target
+    # Each fremaework vfs informations
     class FrameworkEntry
       attr_reader :configuration, :platform, :app_build_dir, :project_temp_dir
       attr_accessor :headers_real_paths, :modules_real_paths
@@ -40,16 +43,15 @@ module HMap
         has_private_module = module_path.glob('module*.modulemap').length > 1
         e_headers = ->(path, *names) { names.inject(Pathname(path)) { |e, n| e.join(n) } }
         @headers_real_paths += headers
-        @headers_real_paths << e_headers.call(app_build_dir, 'Headers',
-                                                   "#{framework_name}-Swift.h")
+        @headers_real_paths << e_headers.call(app_build_dir, 'Headers', "#{framework_name}-Swift.h")
         @modules_real_paths << e_headers.call(project_temp_dir, 'module.modulemap')
-        if has_private_module
-          @modules_real_paths << e_headers.call(entry.project_temp_dir,
-                                                     'module.private.modulemap')
-        end
+        return unless has_private_module
+
+        @modules_real_paths << e_headers.call(entry.project_temp_dir, 'module.private.modulemap')
       end
     end
 
+    # A collection of Each FrameworkEntrys
     class FrameworkVFS
       attr_reader :entrys
 
@@ -75,17 +77,14 @@ module HMap
         vfs_path.select { |k, _| k.include?(key) }
       end
 
-      def write(path = nil)
+      def write(path)
         vfs_path.each do |key, values|
           es = values.map do |value|
-            headers_real_paths = value.headers_real_paths
-            modules_real_paths = value.modules_real_paths
-            VFS::FileCollectorEntry.new(Pathname(value.app_build_dir), modules_real_paths, headers_real_paths)
+            VFS::FileCollectorEntry.new(Pathname(value.app_build_dir), value.modules_real_paths,
+                                        value.headers_real_paths)
           end
           fc = VFS::FileCollector.new(es)
-          pa = Helper::Pods.vfs_files_dir.join(key)
-          pa = File.join(path, key) unless path.nil?
-          pa = Pathname(pa)
+          pa = path.join(key)
           pa.mkpath unless pa.exist?
           fc.write_mapping(pa)
         end

data/lib/hmap/helper/build_setting_constants.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module HMap
+  # A collection of build settings key.
+  module BuildSettingConstants
+    OTHER_CFLAGS = 'OTHER_CFLAGS'
+    OTHER_CPLUSPLUSFLAGS = 'OTHER_CPLUSPLUSFLAGS'
+    HEAD_SEARCH_PATHS = 'HEADER_SEARCH_PATHS'
+    USER_HEADER_SEARCH_PATHS = 'USER_HEADER_SEARCH_PATHS'
+    USE_HEADERMAP = 'USE_HEADERMAP'
+    INGERITED = '$(inherited)'
+  end
+end

data/lib/hmap/helper/hmap_helper.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module HMap
+  # HMap file information
+  class HMapHeaderEntry
+    attr_reader :type, :headers
+
+    def initialize(type)
+      @type = type
+      @headers = []
+    end
+
+    def add_header(header)
+      headers << header
+    end
+
+    def file_name(name)
+      name = 'hmap' if name.nil?
+      [name, '-', type, '.hmap'].join
+    end
+
+    def build_setting_key
+      case type
+      when :i_headers, :iextra_headers
+        yield('-I', :HEADER_SEARCH_PATHS) if block_given?
+      when :iquote_headers, :extra_headers
+        yield('-iquote', :USER_HEADER_SEARCH_PATHS) if block_given?
+      else
+        raise Informative, "Error: header type not expect#{type}"
+      end
+    end
+
+    def build_setting(path, name)
+      full_path = File.join(path, file_name(name))
+      build_setting_key do |key|
+        [key, "\"#{full_path}\""]
+      end
+    end
+
+    def build_setting_xcconfig(path, name)
+      full_path = File.join(path, file_name(name))
+      build_setting_key do |_, xc|
+        [xc, "\"#{full_path}\""]
+      end
+    end
+  end
+
+  # A collection of Each HMapHeaderEntry
+  class HMapHeaders
+    def initialize
+      @public_headers = HMapHeaderEntry.new(:i_headers)
+      @public_headers_e = HMapHeaderEntry.new(:iextra_headers)
+      @private_headers = HMapHeaderEntry.new(:iquote_headers)
+      @private_headers_e = HMapHeaderEntry.new(:extra_headers)
+      @unqi_headers = Set.new
+    end
+
+    def headers
+      public_headers + private_headers
+    end
+
+    def public_headers
+      [@public_headers, @public_headers_e]
+    end
+
+    def private_headers
+      [@private_headers, @private_headers_e]
+    end
+
+    def private_setting_for_reference(path, name)
+      headers_build_settings_for_reference(private_headers, path, name)
+    end
+
+    def public_setting_for_reference(path, name)
+      headers_build_settings_for_reference(public_headers, path, name)
+    end
+
+    def private_setting_for_options(path, name)
+      headers_build_settings_for_options(private_headers, path, name, ' ').join(' ')
+    end
+
+    def public_setting_for_options(path, name)
+      headers_build_settings_for_options(public_headers, path, name).join(' ')
+    end
+
+    def headers_build_settings_for_reference(headers, path, name)
+      headers.each_with_object({}) do |header, setting|
+        se = header.build_setting_xcconfig(path, name)
+        setting.merge!(Hash[*se]) { |_, oldval, newval| [oldval, newval].join(' ') }
+      end
+    end
+
+    def headers_build_settings_for_options(headers, path, name, key = '')
+      headers.each_with_object([]) do |header, setting|
+        setting << header.build_setting(path, name).join(key)
+      end
+    end
+
+    def add_headers(type, headers, module_name, headers_sandbox)
+      headers.each do |header|
+        next unless @unqi_headers.add?(header)
+
+        header_name = header.basename.to_s
+        header_dir = "#{header.dirname}/"
+        header_module_path = "#{module_name}/#{header_name}"
+        header_module_name = "#{module_name}/"
+        header_relative_path = header.relative_path_from(headers_sandbox).to_s
+        header_last_dir_name = "#{header.dirname.basename}/#{header_name}"
+        case type
+        when :private_header_files, :public_header_files
+          @public_headers.add_header([header_name, header_module_name, header_name]) if type == :public_header_files
+          @public_headers_e.add_header([header_module_path, header_dir, header_name])
+          @private_headers.add_header([header_name, header_module_name, header_name])
+          unless header_relative_path == header_module_path || header_relative_path == header_name
+            @private_headers_e.add_header([header_relative_path, header_dir, header_name])
+          end
+          unless header_last_dir_name == header_module_path
+            @private_headers_e.add_header([header_last_dir_name, header_dir, header_name])
+          end
+        when :source_files
+          @private_headers_e.add_header([header_name, header_dir, header_name])
+          @private_headers_e.add_header([header_last_dir_name, header_dir, header_name])
+          @private_headers_e.add_header([header_relative_path, header_dir, header_name])
+        end
+      end
+    end
+  end
+
+  # Gen hmap file and vfs file
+  class HMapHelper
+    attr_reader :i_headers, :iquote_headers, :directory, :framework_entrys, :headers
+
+    def initialize(directory)
+      puts "Current hmap files dir: #{directory}"
+      @directory = Pathname(directory)
+      @framework_entrys = []
+      @headers = HMapHeaders.new
+    end
+
+    def write_hmapfile(name = nil)
+      return if directory.nil?
+
+      @headers.headers.each do |entry|
+        path = directory.join(entry.file_name(name))
+        hmap_write_headers_to_path(path, entry.headers)
+      end
+    end
+
+    def write_vfsfiles(name = '')
+      return if framework_entrys.empty?
+
+      vfs_directory = directory.join(name).join('vfs')
+      puts "Current vfs files dir: #{vfs_directory}"
+      Target::FrameworkVFS.new(framework_entrys).write(vfs_directory)
+      puts 'vfs files write finish.'
+    end
+
+    def write_hmap_vfs_to_paths(hmap_name = nil, vfs_name = '')
+      write_vfsfiles(vfs_name)
+      write_hmapfile(hmap_name)
+    end
+
+    def add_framework_entry(configurations, platforms,
+                            name, framework_name, module_path, headers)
+      entry = Target::FrameworkEntry.new_entrys_from_configurations_platforms(configurations, platforms, name,
+                                                                              framework_name, module_path, headers)
+      @framework_entrys += entry
+    end
+
+    def header_mappings(headers, headers_sandbox, module_name, type)
+      @headers.add_headers(type, headers, module_name, headers_sandbox)
+    end
+
+    def xcconfig_header_setting(is_framework, path = nil, name = nil)
+      i_s = @headers.public_setting_for_options(path, name)
+      setting_values = [[BuildSettingConstants::INGERITED, i_s].join(' ')]
+      setting_values << xcconfig_vfs_setting(path) if is_framework
+      setting_values << @headers.private_setting_for_options(path, name)
+      setting_values.each_with_object({}) do |value, setting|
+        setting.merge!({
+                         BuildSettingConstants::OTHER_CFLAGS => value,
+                         BuildSettingConstants::OTHER_CPLUSPLUSFLAGS => value
+                       }) { |_, oldval, newval| [oldval, newval].join(' ') }
+      end
+    end
+
+    private
+
+    def xcconfig_vfs_setting(path)
+      path = directory if path.nil?
+      "-ivfsoverlay \"#{path}/vfs/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)/all-product-headers.yaml\""
+    end
+
+    def i_headers_name(name)
+      directory.join("#{name}.hmap")
+    end
+
+    def iquote_headers_name
+      directory.join("#{name}-iquote.hmap")
+    end
+
+    def hmap_write_headers_to_path(path, headers)
+      return if headers.empty?
+
+      print "\t - Save hmap file to path: "
+      puts path.to_s.yellow
+      HMapSaver.new_from_buckets(headers).write_to(path)
+    end
+  end
+end