yaml-vfs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7520f51e2e72b65619517d88bfcca217e8b7a22b8cff8f1aa54fb78fc44be93e
-  data.tar.gz: 7175cd3d9718aa7d38a67785cf056d9f61bd205b1ddbf08089479b1ba07a0e3d
+  metadata.gz: bb77a02e5dff7b58ddbb164d61e7b1ffd1ffdd0ec0ddf816aaf6189462de0105
+  data.tar.gz: aea8cbd0ffb9eed48a942edc211fcbbc6378b1047aa72ff63e389dd31d513702
 SHA512:
-  metadata.gz: 5b17d619dbbe74947b0040ac4afacbf27b207e785a9cacbcda365cf83ff0b243080955d2a51ac45dc295b296820389d4a8dd78ef195bb6b93d93c70a9c0a8341
-  data.tar.gz: 1ec49fd3ee822039e2fb3ad489cd9afd7cf9a0986f1ef161c3ec0c7f522c25a66626f057522728f65e60103f0adde0aa83844aac9021609c0b80daad03e61b48
+  metadata.gz: b6962cb728e59c07c08c00276a80a489b1707b3239c2d037d743159e04f907bbea961504944fb9b60b268b70e589e0bbcdf890d701eb5fa1aad5747d1339a03e
+  data.tar.gz: ad4386f7f3fb7d9c3643bb525de459b93a0c99b848226c34de64c15c1266ff40fb479d1f8e97408d8ae4813a804ea3044d5bb2ad5e2f1b9573106d988a65f706

data/README.md

@@ -55,6 +55,28 @@ $ vfs yamlwriter --framework-path=<path> --real-headers-dir=<path> --real-module
 - `--real-modules-dir=<path>`: real modules path
 - `--output-path=<path>`: vfs yaml file output path
 
+### Quickstart
+
+To begin gen an yaml VFS file start by create an `FileCollector`:
+
+```ruby
+require 'yaml_vfs'
+modules = ['./module.modulemap', './module.private.modulemap']
+headers_path = ['./A.h', './B.h']
+vfs = VFS::FileCollector.new('./A.framework', modules, headers_path)
+vfs.write_mapping('./vfs_yaml_output_path')
+```
+
+or set use path:
+
+```ruby
+require 'yaml_vfs'
+modules = ['./module.modulemap', './module.private.modulemap']
+headers_path = ['./A.h', './B.h']
+vfs = VFS::FileCollector.new_from_real_headers_dir('./A.framework', './module_path', './headers')
+vfs.write_mapping('./vfs_yaml_output_path')
+```
+
 ## Command Line Tool
 
 Installing the 'yaml-vfs' gem will also install two command-line tool `vfs` which you can use to generate VFS YAML file.

data/lib/yaml-vfs/command/yaml_vfs_writer.rb

@@ -51,7 +51,7 @@ module VFS
       def run
         require 'yaml_vfs'
 
-        VFS::FileCollector.new_from_real_headers_dir(@framework_path, @real_header_dir, @real_modules_dir).write_mapping(@output_path)
+        VFS::FileCollector.new_from_real_headers_dir(@framework_path, @real_modules_dir, @real_header_dir).write_mapping(@output_path)
       end
     end
   end

data/lib/yaml-vfs/file_collector.rb

@@ -8,23 +8,24 @@ module VFS
   class FileCollector
     HEADER_FILES_EXTENSIONS = %w[.h .hh .hpp .ipp .tpp .hxx .def .inl .inc].freeze
 
-    attr_reader :framework_path, :real_modules_dir, :real_headers
+    attr_reader :framework_path, :real_modules, :real_headers
 
-    def self.new_from_real_headers_dir(framework_path, real_header_dir, real_modules_dir)
+    def self.new_from_real_headers_dir(framework_path, real_modules_dir, real_header_dir)
       raise ArgumentError, 'real_header_dir must set and exist' if real_header_dir.nil? || !real_header_dir.exist?
 
-      files = Pathname.glob(real_header_dir.join('**').join('*')).select do |file|
+      files = Pathname.glob(Pathname(real_header_dir).join('**').join('*')).select do |file|
         HEADER_FILES_EXTENSIONS.include?(file.extname)
       end
-      new(framework_path, real_modules_dir, files)
+      real_modules = Pathname(real_modules_dir).glob('module*.modulemap')
+      new(framework_path, real_modules, files)
     end
 
-    def initialize(framework_path, real_modules_dir, real_headers)
+    def initialize(framework_path, real_modules, real_headers)
       @seen = Set.new
       @vfs_writer = YAMLVFSWriter.new
       @real_headers = real_headers
-      @framework_path = framework_path
-      @real_modules_dir = real_modules_dir
+      @framework_path = Pathname(framework_path)
+      @real_modules = real_modules
     end
 
     def write_mapping(name)
@@ -33,9 +34,10 @@ module VFS
 
       add_write_file
       @vfs_writer.case_sensitive = false
-      path = name.expand_path
+      path = Pathname(name).expand_path
       path = path.join('all-product-headers.yaml') if path.directory?
       stream = @vfs_writer.write
+      path.dirname.mkpath
       File.open(path, 'w') { |f| f.write(stream) }
     end
 
@@ -49,8 +51,8 @@ module VFS
           @vfs_writer.add_file_mapping(path, file)
         end
       }
-      wirte_f.call('Headers', @real_headers) unless @real_headers.empty?
-      wirte_f.call('Modules', real_modules_dir.glob('*.modulemap')) unless @real_modules_dir.nil?
+      wirte_f.call('Headers', real_headers) unless real_headers.empty?
+      wirte_f.call('Modules', real_modules) unless real_modules.empty?
     end
   end
 end

data/lib/yaml-vfs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VFS
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-vfs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cat1237
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,8 +100,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description: header_reader lets your read Xcode header map file. header-writer lets
-  your analyze the project pod dependencies and gen header map file for all pods.
+description: '`vfs yamlwriter` lets you create clang opt "-ivfsoverlay" ymal file,
+  map virtual path to real path.'
 email:
 - wangson1237@outlook.com
 executables:
@@ -141,5 +141,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Read or write header map file.
+summary: A gem which can gen VFS YAML file.
 test_files: []