flgen 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bf48956c855b1e0bef4cb503f0d587991d16ba1ff4f36c1aa3990ba7a343263
-  data.tar.gz: ce22e515604e2790ce7ecba9d04eedfc16212ebfa5d7e20cf43a4ba233abf16c
+  metadata.gz: 5660041e78d446e6127ef86bb45e93468f000750b2917df3e0b34de33ab4cfd0
+  data.tar.gz: f78fa09b2bac383f4f38270ad31ed7d67c98ea06e7709d2fd2aacd7a6b6d322d
 SHA512:
-  metadata.gz: 14eb5efde8db89f0c3bab5c380d482dd22d61172a2ad93e3654cd5edf46983dda17b4c0e164f42a1bb40dff785af9a9e21ef73c012d873d35f056be085949e3e
-  data.tar.gz: bd522a28b24a175bc4f440af52fb548f6e01dddaa81b12e7ef3fa82f0d11b21956f7ade28a9bf3684e84e55b084b98868383c6f710d187bb27fd5e3b16de2337
+  metadata.gz: d3b76b55b57b5e52a316a9eed0c7051e6c1333536b9ead179f3b0616920a1bb1524af76f6d2a6e921553083cdb4d04e53f5f28742083312dbd0cadc88514ab45
+  data.tar.gz: 13a7d45bd399cc0bb57d52084599de7912f894844092d6054289b4c8a555ff7cb4ea07c6979206ee16548409afdb5ff3ae94a452426a79778abdb9cc1bda650a

data/README.md

@@ -24,23 +24,23 @@ $ 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.
 * `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)`
+* `file?(path, from: :current)`
     * Return `treu` if the given file exists.
-* `directory?(path, from: :current, base: nil)`
+* `directory?(path, from: :current)`
     * Return `true` if the given directory exists.
 * `env?(name)`
     * Return `true` if the givne environment variable is defined.
@@ -54,6 +54,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(**seach_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 +69,12 @@ 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
+    * Seach the given file or directory from the directory path specified by the `from` argument.
 * `:current`
     * Search the given file or directory from the directory where the current filelist is.
 * `:root`
@@ -78,9 +84,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:
 
-The `base` argument is to specify the serach direcotry for the given file or directory.
+* `source_file`
+    * `:current`
+* `file_list`
+    * `:root`
+* `library_file`
+    * `:current`
+* `include_directory`
+    * `:current`
+* `library_directory`
+    * `:current`
+
+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_seach_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,21 +6,30 @@ module FLGen
       @context = context
       @path = path
       @root_directories = extract_root
+      @default_search_path = {}
     end
 
-    def file_list(path, from: :root, base: nil, raise_error: true)
+    def default_search_path(**seach_paths)
+      @default_search_path.update(seach_paths)
+    end
+
+    def reset_default_search_path(*target_types)
+      target_types.each { |type| @default_search_path.delete(type) }
+    end
+
+    def file_list(path, from: nil, raise_error: true)
       location = caller_location
-      load_file_list(path, from, base, location, raise_error)
+      load_file_list(path, from, location, raise_error)
     end
 
-    def source_file(path, from: :current, base: nil, raise_error: true)
+    def source_file(path, from: nil, raise_error: true)
       location = caller_location
-      add_file_entry(path, from, base, location, raise_error, :add_source_file)
+      add_file_entry(path, from, location, raise_error, :source_file)
     end
 
-    def library_file(path, from: :current, base: nil, raise_error: true)
+    def library_file(path, from: nil, raise_error: true)
       location = caller_location
-      add_file_entry(path, from, base, location, raise_error, :add_library_file)
+      add_file_entry(path, from, location, raise_error, :library_file)
     end
 
     def define_macro(macro, value = nil)
@@ -33,24 +42,24 @@ module FLGen
 
     alias_method :macro_defined?, :macro?
 
-    def include_directory(path, from: :current, base: nil, raise_error: true)
+    def include_directory(path, from: nil, raise_error: true)
       location = caller_location
-      add_directory_entry(path, from, base, location, raise_error, :add_include_directory)
+      add_directory_entry(path, from, location, raise_error, :include_directory)
     end
 
-    def library_directory(path, from: :current, base: nil, raise_error: true)
+    def library_directory(path, from: nil, raise_error: true)
       location = caller_location
-      add_directory_entry(path, from, base, location, raise_error, :add_library_directory)
+      add_directory_entry(path, from, location, raise_error, :library_directory)
     end
 
-    def file?(path, from: :current, base: nil)
+    def file?(path, from: :current)
       location = caller_location
-      !lookup_root(path, from, base, location, :file?).nil?
+      !extract_file_path(path, from, location, :file).nil?
     end
 
-    def directory?(path, from: :current, base: nil)
+    def directory?(path, from: :current)
       location = caller_location
-      !lookup_root(path, from, base, location, :directory?).nil?
+      !extract_directory_path(path, from, location, :directory).nil?
     end
 
     def env?(name)
@@ -91,14 +100,14 @@ module FLGen
       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 load_file_list(path, from, location, raise_error)
+      unless (list_path = extract_file_path(path, from, location, :file_list))
         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(list_path)
       file_list_already_loaded?(list_path) && return
 
       @context.loaded_file_lists << list_path
@@ -110,49 +119,61 @@ 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_file_entry(path, from, location, raise_error, type)
+      unless (file_path = extract_file_path(path, from, location, type))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
-      @context.__send__(method, root, path)
+      method = "add_#{type}".to_sym
+      @context.__send__(method, file_path)
     end
 
-    def add_directory_entry(path, from, base, location, raise_error, method)
-      unless (root = lookup_root(path, from, base, location, :directory?))
+    def add_directory_entry(path, from, location, raise_error, type)
+      unless (directory_path = extract_directory_path(path, from, location, type))
         raise_no_entry_error(path, location, raise_error)
         return
       end
 
-      directory_path = concat_path(root, path)
+      method = "add_#{type}".to_sym
       @context.__send__(method, directory_path)
     end
 
-    # rubocop:enable Metrics/ParameterLists
-
     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_file_path(path, from, location, type)
+      extract_path(path, from, location, type, :file?)
+    end
+
+    def extract_directory_path(path, from, location, type)
+      extract_path(path, from, location, type, :directory?)
     end
 
-    def search_root(path, from, base, location)
+    def extract_path(path, from, location, type, checker)
+      search_root(path, from, location, type)
+        .map { |root| File.expand_path(path, root) }
+        .find { |abs_path| File.__send__(checker, abs_path) && abs_path }
+    end
+
+    DEFAULT_SEARCH_PATH = {
+      file_list: :root, source_file: :current, library_file: :current, file: :current,
+      include_directory: :current, library_directory: :current, directory: :current
+    }.freeze
+
+    def search_root(path, from, location, type)
+      search_path = from || @default_search_path[type] || DEFAULT_SEARCH_PATH[type]
       if absolute_path?(path)
         ['']
-      elsif !base.nil?
-        [base]
-      elsif from == :current
+      elsif search_path == :current
         [current_directory(location)]
-      elsif from == :local_root
+      elsif search_path == :local_root
         [@root_directories.last]
-      else
+      elsif search_path == :root
         @root_directories
+      else
+        [search_path]
       end
     end
 
@@ -168,10 +189,6 @@ module FLGen
       File.dirname(path)
     end
 
-    def concat_path(root, path)
-      File.expand_path(path, root)
-    end
-
     def raise_no_entry_error(path, location, raise_error)
       return unless raise_error
 

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.18.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flgen
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: Filelist generator