yaml-vfs 0.0.1

checksums.yaml

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Cat1237
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# yaml-vfs
+
+[![License MIT](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://raw.githubusercontent.com/wangson1237/SYCSSColor/master/LICENSE) 
+
+A gem which can gen VFS YAML file.
+
+`vfs yamlwriter` lets you create clang opt "-ivfsoverlay" ymal file,  map virtual path to real path.
+
+- ✅ It can gen VFS YAML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaml-vfs'
+```
+
+And then execute:
+
+```shell
+# bundle install
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+# gem install
+$ gem install yaml-vfs
+```
+
+## Usage
+
+The command should be executed when your want VFS YAML file.
+
+```shell
+# write the VFS YAML file to --output-path=<path>
+$ vfs yamlwriter --framework-path=<path> --real-headers-dir=<path> --real-modules-dir=<path> --output-path=<path>
+
+# write the VFS YAML file to .
+$ vfs yamlwriter --framework-path=<path> --real-headers-dir=<path> --real-modules-dir=<path>
+```
+
+### Option && Flags
+
+`Usage:`
+
+- `vfs yamlwriter --framework-path --real-headers-dir --real-modules-dir [--output-path]`
+
+`Options:`
+
+- `--framework-path=<path>`: framework path
+- `--real-headers-dir=<path>`: real header path
+- `--real-modules-dir=<path>`: real modules path
+- `--output-path=<path>`: vfs yaml file 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.
+
+For more information consult `vfs --help` or `vfs yamlwriter --help`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [yaml-vfs](https://github.com/Cat1237/yaml-vfs). This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the yaml-vfs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cocoapods-hmap/blob/master/CODE_OF_CONDUCT.md).

data/bin/vfs

@@ -0,0 +1,12 @@
+#!/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 'yaml_vfs'
+VFS::Command.run(ARGV)
+
+

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module VFS
+  class Command
+    # vfs yaml file gen cmd
+    class YAMLWriter < Command
+      # summary
+      self.summary = 'Virtual the framework and modules dir, and map to real path'
+
+      self.description = <<-DESC
+        Gen VFS Yaml file. To map framework virtual path to real path.
+      DESC
+
+      self.arguments = [
+        # framework_p, r_header, r_m
+        CLAide::Argument.new('--framework-path', true),
+        CLAide::Argument.new('--real-headers-dir', true),
+        CLAide::Argument.new('--real-modules-dir', true),
+        CLAide::Argument.new('--output-path', false)
+      ]
+
+      def initialize(argv)
+        super
+        framework_path = argv.option('framework-path')
+        @framework_path = Pathname(framework_path) unless framework_path.nil?
+        real_headers_dir = argv.option('real-headers-dir')
+        @real_header_dir = Pathname(real_headers_dir) unless real_headers_dir.nil?
+        real_modules_dir = argv.option('real-modules-dir')
+        @real_modules_dir = Pathname(real_modules_dir) unless real_modules_dir.nil?
+        output_path = argv.option('output-path')
+        @output_path = output_path.nil? ? Pathname('.') : Pathname(output_path)
+      end
+
+      def validate!
+        super
+        help! 'must set framework_path' if @framework_path.nil?
+        help! 'must set real_headers_dir' if @real_header_dir.nil?
+        help! 'must set real_modules_dir' if @real_modules_dir.nil?
+      end
+
+      # help
+      def self.options
+        [
+          ['--framework-path=<path>', 'framework path'],
+          ['--real-headers-dir=<path>', 'real header path'],
+          ['--real-modules-dir=<path>', 'real modules path'],
+          ['--output-path=<path>', 'vfs yaml file output path']
+        ].concat(super)
+      end
+
+      def run
+        require 'yaml_vfs'
+
+        VFS::FileCollector.new_from_real_headers_dir(@framework_path, @real_header_dir, @real_modules_dir).write_mapping(@output_path)
+      end
+    end
+  end
+end

data/lib/yaml-vfs/command.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# The primary namespace for VFS.
+module VFS
+  require 'colored2'
+  require 'claide'
+  # The primary Command for VFS.
+  class Command < CLAide::Command
+    require 'yaml-vfs/command/yaml_vfs_writer'
+
+    self.abstract_command = false
+    self.command = 'vfs'
+    self.version = VERSION
+    self.description = 'VFS lets you create clang "-ivfsoverlay" ymal file,  map virtual path to real path.'
+    self.plugin_prefixes = %w[claide yaml_vfs_writer]
+
+    def initialize(argv)
+      super
+      return if ansi_output?
+
+      Colored2.disable!
+      String.send(:define_method, :colorize) { |string, _| string }
+    end
+  end
+end

data/lib/yaml-vfs/file_collector.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'yaml-vfs/yaml_vfs'
+
+module VFS
+  # vfs gen
+  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
+
+    def self.new_from_real_headers_dir(framework_path, real_header_dir, real_modules_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|
+        HEADER_FILES_EXTENSIONS.include?(file.extname)
+      end
+      new(framework_path, real_modules_dir, files)
+    end
+
+    def initialize(framework_path, real_modules_dir, real_headers)
+      @seen = Set.new
+      @vfs_writer = YAMLVFSWriter.new
+      @real_headers = real_headers
+      @framework_path = framework_path
+      @real_modules_dir = real_modules_dir
+    end
+
+    def write_mapping(name)
+      raise ArgumentError, 'framework_path must set' if @framework_path.nil?
+      raise ArgumentError, 'real_headers or real_header_dir one of them must set' if @real_headers.empty?
+
+      add_write_file
+      @vfs_writer.case_sensitive = false
+      path = name.expand_path
+      path = path.join('all-product-headers.yaml') if path.directory?
+      stream = @vfs_writer.write
+      File.open(path, 'w') { |f| f.write(stream) }
+    end
+
+    private
+
+    def add_write_file
+      wirte_f = lambda { |dir, files|
+        paths = @framework_path.join(dir)
+        files.each do |file|
+          path = paths.join(file.basename)
+          @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?
+    end
+  end
+end

data/lib/yaml-vfs/utils.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: false
+
+module VFS
+  # A collection of utility functions used throughout vfs.
+  module Utils
+    def self.traversal_component?(component)
+      component.each_filename.include?('.') || component.each_filename.include?('..')
+    end
+  end
+end
+
+String.class_eval do
+  def indent(count, char = ' ')
+    gsub(/([^\n]*)(\n|$)/) do
+      last_iteration = ($1 == '' && $2 == '')
+      line = ''
+      line << (char * count) unless last_iteration
+      line << $1
+      line << $2
+      line
+    end
+  end
+end

data/lib/yaml-vfs/version.rb

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

data/lib/yaml-vfs/yaml_vfs.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'json'
+
+module VFS
+  # A general purpose pseudo-structure.
+  # @abstract
+  class YAMLVFSEntry
+    attr_reader :v_path, :r_path
+
+    def directory?
+      @directory
+    end
+
+    def initialize(v_path, r_path, directory: false)
+      @v_path = v_path
+      @r_path = r_path
+      @directory = directory
+    end
+  end
+
+  # YAMLVFSWriter class.
+  # @see https://llvm.org/doxygen/classllvm_1_1vfs_1_1YAMLVFSWriter.html
+  # @abstract
+  class YAMLVFSWriter
+    attr_reader :mappings, :overlay_relative, :overlay_dir, :dir_stack
+    attr_accessor :case_sensitive, :use_external_names
+
+    def overlay_dir=(overlay_dir)
+      @overlay_relative = true
+      @overlay_dir = overlay_dir
+    end
+
+    def initialize
+      @mappings = []
+    end
+
+    def add_entry(virtual_path, real_path, is_directory)
+      raise ArgumentError, 'virtual path not absolute' unless virtual_path.absolute?
+      raise ArgumentError, 'real path not absolute' unless real_path.absolute?
+      raise ArgumentError, 'path traversal is not supported' if Utils.traversal_component?(virtual_path)
+
+      mappings << YAMLVFSEntry.new(virtual_path, real_path, directory: is_directory)
+    end
+
+    def add_file_mapping(virtual_path, real_path)
+      add_entry(virtual_path, real_path, false)
+    end
+
+    def add_directory_mapping(virtual_path, real_path)
+      add_entry(virtual_path, real_path, true)
+    end
+
+    def write
+      @mappings.sort_by! { |p| p.v_path.to_s }
+      JSONWriter.new.write(@mappings, @use_external_names, @case_sensitive, @overlay_relative, @overlay_dir)
+    end
+  end
+
+  # JSONWriter class.
+  # @see https://llvm.org/doxygen/VirtualFileSystem_8cpp_source.html
+  # @abstract
+  class JSONWriter
+    attr_reader :dir_stack
+
+    def write(entries, use_external_names, case_sensitive, overlay_relative, overlay_dir)
+      use_overlay_relative = write_yaml_header(use_external_names, case_sensitive, overlay_relative, overlay_dir)
+      unless entries.empty?
+        current_dir_empty = write_root_entry(entries, use_overlay_relative, overlay_dir)
+        entries.drop(1).reduce(current_dir_empty) do |empty, entry|
+          dir = entry.directory? ? entry.v_path : entry.v_path.dirname
+          start_directory_or_return(dir, empty, use_overlay_relative, overlay_dir, entry)
+        end
+      end
+      write_yaml_footer(entries)
+    end
+
+    def initialize
+      @dir_stack = []
+    end
+
+    private
+
+    def dir_indent
+      @dir_stack.length * 4
+    end
+
+    def file_indent
+      (@dir_stack.length + 1) * 4
+    end
+
+    def contained_in?(parent, path)
+      path.ascend { |p| break true if parent == p } || false
+    end
+
+    def contained_part(parent, path)
+      raise ArgumentError if parent.nil?
+      raise ArgumentError unless contained_in?(parent, path)
+
+      path.relative_path_from(parent)
+    end
+
+    def start_directory(path)
+      name = @dir_stack.empty? ? path : contained_part(@dir_stack.last, path)
+      @dir_stack << path
+      indent = dir_indent
+      @stream += "{\n".indent(indent)
+      @stream += "'type': 'directory',\n".indent(indent + 2)
+      @stream += "'name': \"#{name}\",\n".indent(indent + 2)
+      @stream += "'contents': [\n".indent(indent + 2)
+    end
+
+    def end_directory
+      indent = dir_indent
+      @stream += "]\n".indent(indent + 2)
+      @stream += '}'.indent(indent)
+      @dir_stack.pop
+    end
+
+    def write_entry(v_path, r_path)
+      indent = file_indent
+      @stream += "{\n".indent(indent)
+      @stream += "'type': 'file',\n".indent(indent + 2)
+      @stream += "'name': \"#{v_path}\",\n".indent(indent + 2)
+      @stream += "'external-contents': \"#{r_path}\"\n".indent(indent + 2)
+      @stream += '}'.indent(file_indent)
+    end
+
+    def overlay_dir_sub_rpath(use, overlay_dir, rpath)
+      if use
+        raise ArgumentError, 'Overlay dir must be contained in RPath' unless rpath.fnmatch?("#{overlay_dir}*")
+
+        rpath = rpath.relative_path_from(overlay_dir).expand_path
+      end
+      rpath
+    end
+
+    def write_yaml_header(use_external_names, case_sensitive, overlay_relative, _overlay_dir)
+      @stream = "{\n  'version': 0,\n"
+      @stream += "  'case-sensitive': '#{case_sensitive}',\n" unless case_sensitive.nil?
+      @stream += "  'use-external-names': '#{use_external_names}',\n" unless use_external_names.nil?
+      use_overlay_relative = !overlay_relative.nil?
+      @stream += "  'overlay_relative': '#{overlay_relative}',\n" if use_overlay_relative
+      @stream += "  'roots': [\n"
+      use_overlay_relative
+    end
+
+    def write_yaml_footer(entries)
+      unless entries.empty?
+        until @dir_stack.empty?
+          @stream += "\n"
+          end_directory
+        end
+        @stream += "\n"
+      end
+      @stream += "  ]\n}\n"
+      @stream
+    end
+
+    def write_root_entry(entries, use_overlay_relative, overlay_dir)
+      return true if entries.empty?
+
+      f_entry = entries.first
+      start_directory(f_entry.directory? ? f_entry.v_path : f_entry.v_path.dirname)
+      current_dir_empty = f_entry.directory?
+      use_overlay_relative_and_write_entry(use_overlay_relative, overlay_dir, current_dir_empty, f_entry)
+    end
+
+    def until_end_directory(dir)
+      dir_popped_from_stack = false
+      until @dir_stack.empty? || contained_in?(@dir_stack.last, dir)
+        @stream += "\n"
+        end_directory
+        dir_popped_from_stack = true
+      end
+      dir_popped_from_stack
+    end
+
+    def use_overlay_relative_and_write_entry(use_overlay_relative, overlay_dir, current_dir_empty, entry)
+      rpath = overlay_dir_sub_rpath(use_overlay_relative, overlay_dir, entry.r_path)
+      unless entry.directory?
+        write_entry(entry.v_path.basename, rpath)
+        current_dir_empty = false
+      end
+      current_dir_empty
+    end
+
+    def start_directory_or_return(dir, current_dir_empty, use_overlay_relative, overlay_dir, entry)
+      if dir == @dir_stack.last
+        @stream += ",\n" unless current_dir_empty
+      else
+        @stream += ",\n" if until_end_directory(dir) || !current_dir_empty
+        start_directory(dir)
+        current_dir_empty = true
+      end
+      use_overlay_relative_and_write_entry(use_overlay_relative, overlay_dir, current_dir_empty, entry)
+    end
+  end
+end

data/lib/yaml_vfs.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# The primary namespace for yaml-vfs.
+module VFS
+  require 'pathname'
+  require 'claide'
+
+  class PlainInformative < StandardError
+    include CLAide::InformativeError
+  end
+
+  # Informative
+  class Informative < PlainInformative
+    def message
+      super !~ /\[!\]/ ? "[!] #{super}\n".red : super
+    end
+  end
+
+  require_relative 'yaml-vfs/version'
+  require_relative 'yaml-vfs/utils'
+
+
+  autoload :FileCollector, 'yaml-vfs/file_collector'
+  autoload :Command, 'yaml-vfs/command'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: yaml-vfs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cat1237
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: claide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- wangson1237@outlook.com
+executables:
+- vfs
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/vfs
+- lib/yaml-vfs/command.rb
+- lib/yaml-vfs/command/yaml_vfs_writer.rb
+- lib/yaml-vfs/file_collector.rb
+- lib/yaml-vfs/utils.rb
+- lib/yaml-vfs/version.rb
+- lib/yaml-vfs/yaml_vfs.rb
+- lib/yaml_vfs.rb
+homepage: https://github.com/Cat1237/yaml-vfs
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Read or write header map file.
+test_files: []