flgen 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bf48956c855b1e0bef4cb503f0d587991d16ba1ff4f36c1aa3990ba7a343263
-  data.tar.gz: ce22e515604e2790ce7ecba9d04eedfc16212ebfa5d7e20cf43a4ba233abf16c
+  metadata.gz: 93ba3a15351e9da39f2dfbbd23c54790140fe7134be768352aa2430533008194
+  data.tar.gz: 0e4cc12fae241384ec559682d965b68a63362ca0c934013c1312ac93eaec28cb
 SHA512:
-  metadata.gz: 14eb5efde8db89f0c3bab5c380d482dd22d61172a2ad93e3654cd5edf46983dda17b4c0e164f42a1bb40dff785af9a9e21ef73c012d873d35f056be085949e3e
-  data.tar.gz: bd522a28b24a175bc4f440af52fb548f6e01dddaa81b12e7ef3fa82f0d11b21956f7ade28a9bf3684e84e55b084b98868383c6f710d187bb27fd5e3b16de2337
+  metadata.gz: 01ffbee882b46664e9e77a63977abe0e5c1de2a7c75271a1ce6b0284ce7a0517d1785d8e14d95c524959aedfbc8482f6dba3174001311034fd88d863cb013cd3
+  data.tar.gz: 398adf788fa50f20d2cdda686b3364b8978a05884e554aecc19ae6c5beb908049a49e6de852b5d7ba41552e0c29310a9826c63c2e49fef2cd65899515133747f

data/README.md

@@ -24,24 +24,29 @@ $ gem install flgen
 
 FLGen prives APIs listed below to describe your filelists.
 
-* `source_file(path, from: :current, base: nil)`
+* `source_file(path, from: nil)`
     * Add the given source file to the current filelist.
-* `file_list(path, from: :root, base: nil)`
+* `file_list(path, from: nil)`
     * Load the given filelist.
-* `library_file(path, from: :current, base: nil)`
+* `library_file(path, from: nil)`
     * Add the given file to the list of library files.
-* `include_directory(path, from: :current, base: nil)`
+* `include_directory(path, from: nil)`
     * Add the given directory to the list of include direcotries.
-* `library_directory(path, from: :current, base: nil)`
+* `library_directory(path, from: nil)`
     * Add the given directory to the list of library directories.
+* `find_files(patterns, from: nil)`
+    * Return an array of filenames matching the given patterns strings.
+    * See [here](https://docs.ruby-lang.org/en/3.2/Dir.html#method-c-glob) for the format of a pattern string.
+* `find_file(patterns, from: nil)`
+    * Return the first filename matching the given pattern strings.
+* `file?(path, from: :current)`
+    * Return `true` if the given file exists.
+* `directory?(path, from: :current)`
+    * Return `true` if the given directory exists.
 * `define_macro(name, value = nil)`
     * Define a text macro.
 * `macro?(name)`/`macro_defined?(name)`
     * Return `true` if the given macro is defined.
-* `file?(path, from: :current, base: nil)`
-    * Return `treu` if the given file exists.
-* `directory?(path, from: :current, base: nil)`
-    * Return `true` if the given directory exists.
 * `env?(name)`
     * Return `true` if the givne environment variable is defined.
 * `env(name)`
@@ -54,6 +59,10 @@ FLGen prives APIs listed below to describe your filelists.
     * If `tool` is specified the given argument is added only when `tool` is matched with the targe tool.
 * `target_tool?(tool)`
     * Return `true` if the given tool is matched with the targe tool.
+* `default_search_path(**search_paths)`
+    * Change the default behavior when the `from` argument is not specified.
+* `reset_default_search_path(*target_types)`
+    * Reset the default behavior when the `from` argument is not specified.
 
 FLGen's filelist is designed as an inernal DSL with Ruby. Therefore you can use Ruby's syntax. For example:
 
@@ -65,10 +74,14 @@ else
 end
 ```
 
-### About `from`/`base` arguments
+### About the `from` argument
 
 The `from` argument is to specify how to search the given file or directory. You can specify one of three below.
 
+* a directory path
+    * Search the given file or directory from the directory path specified by the `from` argument.
+* `:cwd`
+    * Search the given file or directory from the current working directory.
 * `:current`
     * Search the given file or directory from the directory where the current filelist is.
 * `:root`
@@ -78,9 +91,31 @@ The `from` argument is to specify how to search the given file or directory. You
 * `:local_root`
     * Search the given file or directory from the repository root directory where the current filelist belongs to.
 
-The `from` argument is ignored if the given path is an absolute path or the `base` argument is specified.
+Default behaviors when the `from` argument is not spcified are listed below:
+
+
+| API name          | Default `from` argument |
+|:------------------|:------------------------|
+| source_file       | :current                |
+| file_list         | :root                   |
+| library_file      | :current                |
+| include_directory | :current                |
+| library_directory | :current                |
+| find_files        | :current                |
+| find_file         | :current                |
 
-The `base` argument is to specify the serach direcotry for the given file or directory.
+You can change the above default behaviors by using the `default_search_path` API.
+In addition, you can reset the default behaviors by using the `reset_default_search_path` API.
+
+```ruby
+default_search_path source_file: :root, file_list: :current
+source_file 'foo.sv'    # FLGen will search the 'foo.sv' file from the root directories.
+file_list 'bar.list.rb' # FLGen will eaarch the 'bar.list.rb' file from the directory where this file list is.
+
+reset_default_search_path :source_file, :file_list
+source_file 'baz.sv'    # FLGen will search the 'baz.sv' file from the directory where this file list is.
+file_list 'qux.list.rb' # FLGen will eaarch the 'qux.list.rb' file from  the root directories.
+```
 
 #### Example
 

data/lib/flgen/context.rb

@@ -12,18 +12,18 @@ module FLGen
       @source_files ||= []
     end
 
-    def add_source_file(root, path)
+    def add_source_file(path)
       return if runtime?
 
-      file = SourceFile.new(root, path)
+      file = SourceFile.new(path)
       add_source_file?(file) &&
         (source_files << file.remove_ext(@options[:rm_ext]))
     end
 
-    def add_library_file(root, path)
+    def add_library_file(path)
       return if runtime?
 
-      file = SourceFile.new(root, path)
+      file = SourceFile.new(path)
       add_library_file?(file) &&
         add_compile_argument(Arguments::LibraryFile.new(file))
     end

data/lib/flgen/file_list.rb

@@ -6,53 +6,54 @@ module FLGen
       @context = context
       @path = path
       @root_directories = extract_root
+      @default_search_path = init_default_search_path
     end
 
-    def file_list(path, from: :root, base: nil, raise_error: true)
-      location = caller_location
-      load_file_list(path, from, base, location, raise_error)
+    def default_search_path(**search_paths)
+      @default_search_path.update(search_paths)
     end
 
-    def source_file(path, from: :current, base: nil, raise_error: true)
-      location = caller_location
-      add_file_entry(path, from, base, location, raise_error, :add_source_file)
+    def reset_default_search_path(*target_types)
+      target_types.each { |type| @default_search_path.delete(type) }
     end
 
-    def library_file(path, from: :current, base: nil, raise_error: true)
-      location = caller_location
-      add_file_entry(path, from, base, location, raise_error, :add_library_file)
+    def file_list(path, from: nil, raise_error: true)
+      load_file_list(path, from, raise_error, caller_location)
     end
 
-    def define_macro(macro, value = nil)
-      @context.define_macro(macro, value)
+    def source_file(path, from: nil, raise_error: true)
+      add_entry(path, from, raise_error, __callee__, caller_location)
     end
 
-    def macro?(macro)
-      @context.macros.include?(macro.to_sym)
-    end
+    define_method(:library_file, instance_method(:source_file))
+    define_method(:include_directory, instance_method(:source_file))
+    define_method(:library_directory, instance_method(:source_file))
 
-    alias_method :macro_defined?, :macro?
+    def find_files(patterns, from: nil, &block)
+      glob_files(patterns, from, __callee__, caller_location)
+        .then { |e| block ? e.each(&block) : e.to_a }
+    end
 
-    def include_directory(path, from: :current, base: nil, raise_error: true)
-      location = caller_location
-      add_directory_entry(path, from, base, location, raise_error, :add_include_directory)
+    def find_file(patterns, from: nil)
+      glob_files(patterns, from, __callee__, caller_location).first
     end
 
-    def library_directory(path, from: :current, base: nil, raise_error: true)
-      location = caller_location
-      add_directory_entry(path, from, base, location, raise_error, :add_library_directory)
+    def file?(path, from: :current)
+      !extract_path(path, from, __callee__, caller_location).nil?
     end
 
-    def file?(path, from: :current, base: nil)
-      location = caller_location
-      !lookup_root(path, from, base, location, :file?).nil?
+    define_method(:directory?, instance_method(:file?))
+
+    def define_macro(macro, value = nil)
+      @context.define_macro(macro, value)
     end
 
-    def directory?(path, from: :current, base: nil)
-      location = caller_location
-      !lookup_root(path, from, base, location, :directory?).nil?
+    def macro?(macro)
+      @context.macros.include?(macro.to_sym)
     end
 
+    alias_method :macro_defined?, :macro?
+
     def env?(name)
       ENV.key?(name.to_s)
     end
@@ -80,25 +81,25 @@ module FLGen
       return nil if @path.empty?
 
       Pathname
-        .new(@path)
-        .dirname
-        .descend
-        .select(&method(:repository_root?))
-        .map(&:to_s)
+        .new(@path).dirname.descend.select(&method(:repository_root?)).map(&:to_s)
     end
 
     def repository_root?(path)
       File.exist?(path.join('.git').to_s)
     end
 
-    def load_file_list(path, from, base, location, raise_error)
-      unless (root = lookup_root(path, from, base, location, :file?))
+    def init_default_search_path
+      Hash.new { |_, key| key == :file_list ? :root : :current }
+    end
+
+    def load_file_list(path, from, raise_error, location)
+      unless (extracted_path = extract_path(path, from, :file_list, location))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
       # Need to File.realpath to resolve symblic link
-      list_path = File.realpath(concat_path(root, path))
+      list_path = File.realpath(extracted_path)
       file_list_already_loaded?(list_path) && return
 
       @context.loaded_file_lists << list_path
@@ -110,49 +111,52 @@ module FLGen
       @context.loaded_file_lists.include?(path)
     end
 
-    # rubocop:disable Metrics/ParameterLists
-
-    def add_file_entry(path, from, base, location, raise_error, method)
-      unless (root = lookup_root(path, from, base, location, :file?))
+    def add_entry(path, from, raise_error, method_name, location)
+      unless (extracted_path = extract_path(path, from, method_name, location))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
-      @context.__send__(method, root, path)
+      @context.__send__("add_#{method_name}".to_sym, extracted_path)
     end
 
-    def add_directory_entry(path, from, base, location, raise_error, method)
-      unless (root = lookup_root(path, from, base, location, :directory?))
-        raise_no_entry_error(path, location, raise_error)
-        return
-      end
+    def raise_no_entry_error(path, location, raise_error)
+      return unless raise_error
 
-      directory_path = concat_path(root, path)
-      @context.__send__(method, directory_path)
+      raise NoEntryError.new(path, location)
     end
 
-    # rubocop:enable Metrics/ParameterLists
+    def glob_files(patterns, from, method_name, location)
+      search_root('', from, method_name, location)
+        .lazy.flat_map { |base| do_glob_files(patterns, base) }
+    end
+
+    def do_glob_files(patterns, base)
+      Dir.glob(Array(patterns), base: base)
+        .map { |path| File.join(base, path) }
+        .select(&File.method(:file?))
+    end
 
     def caller_location
       caller_locations(2, 1).first
     end
 
-    def lookup_root(path, from, base, location, checker)
-      search_root(path, from, base, location)
-        .find { |root| File.__send__(checker, concat_path(root, path)) }
+    def extract_path(path, from, method_name, location)
+      search_root(path, from, method_name, location)
+        .map { |root| File.expand_path(path, root) }
+        .find { |abs_path| exist_path?(abs_path, method_name) }
     end
 
-    def search_root(path, from, base, location)
+    FROM_KEYWORDS = [:cwd, :current, :local_root, :root].freeze
+
+    def search_root(path, from, method_name, location)
+      search_path = from || @default_search_path[method_name]
       if absolute_path?(path)
         ['']
-      elsif !base.nil?
-        [base]
-      elsif from == :current
-        [current_directory(location)]
-      elsif from == :local_root
-        [@root_directories.last]
+      elsif FROM_KEYWORDS.include?(search_path)
+        search_root_specified_by_keyword(search_path, location)
       else
-        @root_directories
+        [search_path]
       end
     end
 
@@ -160,6 +164,15 @@ module FLGen
       Pathname.new(path).absolute?
     end
 
+    def search_root_specified_by_keyword(from_keyword, location)
+      case from_keyword
+      when :cwd then [Dir.pwd]
+      when :current then [current_directory(location)]
+      when :local_root then [@root_directories.last]
+      else @root_directories
+      end
+    end
+
     def current_directory(location)
       # From Ruby 3.1 Thread::Backtrace::Location#absolute_path returns nil
       # for code string evaluated by eval methods
@@ -168,14 +181,15 @@ module FLGen
       File.dirname(path)
     end
 
-    def concat_path(root, path)
-      File.expand_path(path, root)
-    end
+    METHODS_TARGETING_DIRECTORY =
+      [:include_directory, :library_directory, :directory?].freeze
 
-    def raise_no_entry_error(path, location, raise_error)
-      return unless raise_error
-
-      raise NoEntryError.new(path, location)
+    def exist_path?(path, method_name)
+      if METHODS_TARGETING_DIRECTORY.include?(method_name)
+        File.directory?(path)
+      else
+        File.file?(path)
+      end
     end
   end
 end

data/lib/flgen/source_file.rb

@@ -2,8 +2,8 @@
 
 module FLGen
   class SourceFile
-    def initialize(root, path, checksum = nil)
-      @path = File.join(root, path)
+    def initialize(path, checksum = nil)
+      @path = path
       @checksum = checksum
     end
 
@@ -27,8 +27,8 @@ module FLGen
     def remove_ext(ext_list)
       return self unless match_ext?(ext_list)
 
-      path = Pathname.new(@path).sub_ext('').to_s
-      self.class.new('', path, checksum)
+      path_no_ext = Pathname.new(path).sub_ext('').to_s
+      self.class.new(path_no_ext, checksum)
     end
 
     def checksum

data/lib/flgen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FLGen
-  VERSION = '0.17.0'
+  VERSION = '0.19.0'
 end

metadata

@@ -1,113 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: flgen
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.12.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.40.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.40.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
+date: 2023-09-15 00:00:00.000000000 Z
+dependencies: []
 description: Filelist generator
 email:
 - ishitani@pezy.co.jp
@@ -162,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Filelist generator