config_file_manager 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b4fdc0a8ed8426e6d4ecd41d04ff9ad0aa8e817aca12189cc6cbe0878b81748
-  data.tar.gz: 903cfee08159f7a560fbc8305282d540799f06271363862898aaa4121545981c
+  metadata.gz: d77a5b859939e565703bc2dc5dce3dd9fe8d4cec4f33c7939585834d991a4e66
+  data.tar.gz: bd75f33acab4a3e6790bbf907d0409a0a24023f87f2a7f1f0236af26590525ca
 SHA512:
-  metadata.gz: 305ed92cf6e19d9b6b4d5ab1af990f5dde5236c53345e206797081ccb8eb43890def787aa3834fe325ecab0bdd31cfcbe522c88315e11c3abe406ce1654fff38
-  data.tar.gz: 1c5368b9ef06c10ce0476f1c3f09589869e134547bf7350aad2ef75bb12bd29a0ff0613287cb0a88ddca14f3d8f00773725d26758e658edb07d6b777d65997fc
+  metadata.gz: 3ad597c042ac18dcc1502113ad9ba87fb925c76a9ccb2e1e835bab8192a657d4a0ee2d1ce5ee46957db8c2115c0fc608a4a81ac5051ad1d06c7fed9296bb8ee7
+  data.tar.gz: 4bdcdb68a55c6f6166ef65b9ba6cfcb858288723894e219843616dbffd4c43f0da70b0bcc3735c5eff8f040430787f60e045e1223f6dda38af083e87e73d4060

data/.rubocop.yml

@@ -1,5 +1,5 @@
 inherit_gem:
-  rubocop-espago: rubocop.yml
+  rubocop-espago: sorbet.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.3

data/.ruby-version

@@ -0,0 +1 @@
+4.0.6

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## [Unreleased]
+## [0.1.4] - 2026-09-01
+
+- Add recursive example directories
+- Switch from YARD to RBS comments
+
+## [0.1.3] - 2023-11-30
+
+- Add json parsing
 
 ## [0.1.2] - 2023-08-29
 

data/README.md

@@ -38,8 +38,16 @@ You can use this gem to easily configure automatic symlinking of config files in
 ```rb
 # config/deploy.rb
 
-config_file_manager = ConfigFileManager.new(File.expand_path(__dir__))
-set :linked_files, config_file_manager.to_relative_paths(config_file_manager.files)
+# path to the repo root
+root_path = File.expand_path('..', __dir__)
+# path to the `config/` directory
+config_dir_path = File.expand_path(__dir__)
+
+config_file_manager = ConfigFileManager.new(config_dir_path)
+# get absolute paths to all config files and change them
+# to relative paths (relative to the repo root)
+linked_files = config_file_manager.files.map { _1.delete_prefix("#{root_path}/") }
+set :linked_files, linked_files
 ```
 
 That way you don't have to specify the config files by hand.
@@ -53,7 +61,7 @@ Create an initializer that will be executed first and creates a configured insta
 ```rb
 # config/initializers/0_config_file_manager.rb
 
-CONFIG_MANAGER = ConfigFileManager.new(File.expand_path('..', __dir__), env: Rails.env)
+CONFIG_MANAGER = ConfigFileManager.new(Rails.root.join('config'), env: Rails.env)
 ```
 
 And then you can you it to conveniently load config files.
@@ -181,7 +189,7 @@ loader.to_relative_path("/Users/Verseth/my_app/config/foo.yml")
 #=> "foo.yml"
 ```
 
-## to_absolute_path
+### to_absolute_path
 
 Converts an absolute path within the config directory to a relative path.
 
@@ -208,7 +216,7 @@ production:
     foo: prod value <%= 10 - 2 %>
 ```
 
-You cna load it like so.
+You can load it like so.
 
 ```rb
 loader = ConfigFileManager.new(File.expand_path('config', __dir__))

data/lib/config_file_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ConfigFileManager # rubocop:disable Style/StaticClass
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/lib/config_file_manager.rb

@@ -1,6 +1,8 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'json'
 require 'yaml'
 require 'erb'
 require 'pastel'
@@ -13,29 +15,30 @@ class ConfigFileManager
 
   # Absolute path to the main directory that contains all config files (and subdirectories).
   #
-  # @return [String]
+  #: String
   attr_reader :config_dir
 
   # Maximum depth of nested directories containing config files.
   #
-  # @return [Integer]
+  #: Integer
   attr_reader :max_dir_depth
 
   # Current environment name. Used to load the correct section of YAML files.
   #
-  # @return [String]
+  #: String
   attr_reader :env
 
   # Extension of the example/dummy version of a config file.
   # eg. `.example`, `.dummy`
   #
-  # @return [String]
+  #: String
   attr_reader :example_extension
 
-  # @param config_dir [String] Absolute path to the root config directory
-  # @param example_extension [String]
-  # @param max_dir_depth [Integer] Maximum depth of nested directories containing config files.
-  # @param env [String] Current environment name
+  # @param config_dir Absolute path to the root config directory
+  # @param max_dir_depth Maximum depth of nested directories containing config files.
+  # @param env Current environment name
+  #
+  #: (String config_dir, ?example_extension: String, ?max_dir_depth: Integer, ?env: String) -> void
   def initialize(config_dir, example_extension: '.example', max_dir_depth: 5, env: 'development')
     @config_dir = config_dir
     @example_extension = example_extension
@@ -48,8 +51,9 @@ class ConfigFileManager
   # Returns an array of absolute paths to the found files
   # with the specified extension stripped away.
   #
-  # @param example_extension [String] File extension of example files
-  # @return [Array<String>]
+  # @param example_extension File extension of example files
+  #
+  #: (?example_extension: String, ?result: Array[String], ?depth: Integer, ?dir_path: String) -> Array[String]
   def files(example_extension: @example_extension, result: [], depth: 0, dir_path: @config_dir)
     return result if depth > @max_dir_depth
 
@@ -61,9 +65,9 @@ class ConfigFileManager
         # this essentially performs a depth limited search (DFS with a depth limit)
         next files(
           example_extension: example_extension,
-          result: result,
-          depth: depth + 1,
-          dir_path: abs_path
+          result:            result,
+          depth:             depth + 1,
+          dir_path:          abs_path,
         )
       end
 
@@ -75,8 +79,9 @@ class ConfigFileManager
     result
   end
 
-  # @param example_extension [String]
-  # @return [Array<String>] Absolute paths to missing config files.
+  # Absolute paths to missing config files.
+  #
+  #: (?example_extension: String) -> Array[String]
   def missing_files(example_extension: @example_extension)
     files(example_extension: example_extension).reject do |file|
       ::File.exist?(file)
@@ -85,9 +90,7 @@ class ConfigFileManager
 
   # Create the missing config files based on their dummy/example versions.
   #
-  # @param example_extension [String]
-  # @param print [Boolean]
-  # @return [void]
+  #: (?example_extension: String, ?print: bool) -> void
   def create_missing_files(example_extension: @example_extension, print: false)
     puts COLORS.blue('== Copying missing config files ==') if print
     files(example_extension: example_extension).each do |file|
@@ -95,22 +98,44 @@ class ConfigFileManager
     end
   end
 
-  # Search for directories under the `config_dir` directory
-  # with the specified ending (eg. `.example`).
-  # Returns an array of absolute paths to the found files
-  # with the specified ending stripped away.
+  # Recursively search for directories under the `config_dir` directory
+  # with the specified extension (eg. `.example`).
+  # Returns an array of absolute paths to the found directories
+  # with the specified extension stripped away.
+  #
+  # @param example_extension ending of example directories
   #
-  # @param example_extension [String] ending of example directories
-  # @return [Array<String>]
-  def dirs(example_extension: @example_extension)
-    ::Dir.each_child(@config_dir)
-         .map { ::File.join(@config_dir, _1) }
-         .select { ::File.directory?(_1) && _1.end_with?(example_extension) }
-         .map { _1.delete_suffix(example_extension) }
+  #: (?example_extension: String, ?result: Array[String], ?depth: Integer, ?dir_path: String) -> Array[String]
+  def dirs(example_extension: @example_extension, result: [], depth: 0, root_dir_path: @config_dir)
+    return result if depth > @max_dir_depth
+
+    ::Dir.each_child(root_dir_path) do |path|
+      abs_path = ::File.join(root_dir_path, path)
+
+      next unless ::File.directory?(abs_path)
+
+      # if the entry is a directory with the example extension, add it to the result array
+      if path.end_with?(example_extension)
+        result << abs_path.delete_suffix(example_extension)
+        next
+      end
+
+      # if the entry is a directory without the example extension, scan it recursively
+      # this essentially performs a depth limited search (DFS with a depth limit)
+      next dirs(
+        example_extension: example_extension,
+        result:            result,
+        depth:             depth + 1,
+        root_dir_path:     abs_path,
+      )
+    end
+
+    result
   end
 
-  # @param example_extension [String]
-  # @return [Array<String>] Absolute paths to missing config directories.
+  # Absolute paths to missing config directories.
+  #
+  #: (?example_extension: String) -> Array[String]
   def missing_dirs(example_extension: @example_extension)
     dirs(example_extension: example_extension).reject do |file|
       ::Dir.exist?(file)
@@ -119,9 +144,7 @@ class ConfigFileManager
 
   # Create the missing config directories based on their dummy/example versions.
   #
-  # @param example_extension [String]
-  # @param print [Boolean]
-  # @return [void]
+  #: (?example_extension: String, ?print: bool) -> void
   def create_missing_dirs(example_extension: @example_extension, print: false)
     puts COLORS.blue('== Copying missing config directories ==') if print
     dirs(example_extension: example_extension).each do |dir|
@@ -132,8 +155,7 @@ class ConfigFileManager
   # Converts a collection of absolute paths to an array of
   # relative paths.
   #
-  # @param absolute_paths [Array<String>]
-  # @return [Array<String>]
+  #: (Array[String] absolute_paths) -> Array[String]
   def to_relative_paths(absolute_paths)
     absolute_paths.map do |path|
       to_relative_path(path)
@@ -142,8 +164,7 @@ class ConfigFileManager
 
   # Converts an absolute path to a relative path
   #
-  # @param absolute_path [String]
-  # @return [String]
+  #: (String absolute_path) -> String
   def to_relative_path(absolute_path)
     absolute_path.delete_prefix("#{@config_dir}/")
   end
@@ -151,8 +172,7 @@ class ConfigFileManager
   # Converts a collection of relative paths to an array of
   # absolute paths.
   #
-  # @param relative_paths [Array<String>]
-  # @return [Array<String>]
+  #: (Array[String] relative_paths) -> Array[String]
   def to_absolute_paths(relative_paths)
     relative_paths.map do |path|
       to_absolute_path(path)
@@ -161,16 +181,14 @@ class ConfigFileManager
 
   # Converts a relative path to an absolute path.
   #
-  # @param relative_path [String]
-  # @return [String]
+  #: (String relative_path) -> String
   def to_absolute_path(relative_path)
     "#{@config_dir}/#{relative_path}"
   end
 
-  # @param file_name [Array<String>]
-  # @param env [String, nil]
-  # @param symbolize [Boolean] Whether the keys should be converted to Ruby symbols
-  # @return [Hash, Array]
+  # @param symbolize Whether the keys should be converted to Ruby symbols
+  #
+  #: (*String file_name, ?env: String?, ?symbolize: bool) -> untyped
   def load_yaml(*file_name, env: @env, symbolize: true)
     env = env.to_sym if env && symbolize
     parsed = ruby_load_yaml(load_erb(*file_name), symbolize_names: symbolize)
@@ -179,43 +197,50 @@ class ConfigFileManager
     parsed[env]
   end
 
-  # @param file_name [Array<String>]
+  # @param symbolize Whether the keys should be converted to Ruby symbols
+  #
+  #: (*String file_name, ?env: String?, ?symbolize: bool) -> untyped
+  def load_json(*file_name, env: @env, symbolize: true)
+    env = env.to_sym if env && symbolize
+    parsed = ::JSON.parse(load_erb(*file_name), symbolize_names: symbolize)
+    return parsed unless env
+
+    parsed[env]
+  end
+
+  #: (*String file_name) -> void
   def delete_file(*file_name)
     ::File.delete(file_path(*file_name))
   end
 
-  # @param dir_name [Array<String>]
+  #: (*String dir_name) -> void
   def delete_dir(*dir_name)
     ::FileUtils.rm_r(file_path(*dir_name))
   end
 
-  # @param file_name [Array<String>]
-  # @return [String]
+  #: (*String file_name) -> String
   def load_erb(*file_name)
     ::ERB.new(load_file(*file_name)).result
   end
 
-  # @param file_name [Array<String>]
-  # @return [String]
   # @raise [SystemCallError]
+  #
+  #: (*String file_name) -> String
   def load_file(*file_name)
     ::File.read file_path(*file_name)
   end
 
-  # @param file_name [Array<String>]
-  # @return [Boolean]
+  #: (*String file_name) -> bool
   def file_exist?(*file_name)
     ::File.exist? file_path(*file_name)
   end
 
-  # @param dir_name [Array<String>]
-  # @return [Boolean]
+  #: (*String dir_name) -> bool
   def dir_exist?(*dir_name)
     ::Dir.exist? file_path(*dir_name)
   end
 
-  # @param file_name [Array<String>]
-  # @return [String]
+  #: (*String file_name) -> String
   def file_path(*file_name)
     *path, name = file_name
     ::File.join(@config_dir, *path, name)
@@ -224,19 +249,22 @@ class ConfigFileManager
   private
 
   if ::Psych::VERSION >= '4'
-    def ruby_load_yaml(content, **options) # rubocop:disable Style/DocumentationMethod
-      ::YAML.load(content, aliases: true, **options) # rubocop:disable Security/YAMLLoad
+    # Load YAML content using the Psych 4+ API.
+    #
+    #: (String content, **untyped options) -> untyped
+    def ruby_load_yaml(content, **options)
+      ::YAML.load(content, aliases: true, **options)
     end
   else
-    def ruby_load_yaml(content, **options) # rubocop:disable Style/DocumentationMethod
-      ::YAML.load(content, **options) # rubocop:disable Security/YAMLLoad
+    # Load YAML content using the pre Psych 4 API.
+    #
+    #: (String content, **untyped options) -> untyped
+    def ruby_load_yaml(content, **options)
+      ::YAML.load(content, **options)
     end
   end
 
-  # @param original_name [String]
-  # @param new_name [String]
-  # @param print [Boolean]
-  # @return [Boolean]
+  #: (String original_name, String new_name, ?print: bool) -> bool
   def create_missing_file(original_name, new_name, print: false)
     return false if ::File.exist?(new_name)
 
@@ -249,10 +277,7 @@ class ConfigFileManager
     true
   end
 
-  # @param original_name [String]
-  # @param new_name [String]
-  # @param print [Boolean]
-  # @return [Boolean]
+  #: (String original_name, String new_name, ?print: bool) -> bool
   def create_missing_dir(original_name, new_name, print: false)
     return false if ::Dir.exist?(new_name)
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: config_file_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Mateusz Drewniak
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -32,13 +31,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/config_file_manager.rb
 - lib/config_file_manager/version.rb
-- sig/config_loader.rbs
 homepage: https://github.com/Verseth/ruby-config-loader
 licenses:
 - MIT
@@ -46,7 +45,6 @@ metadata:
   homepage_uri: https://github.com/Verseth/ruby-config-loader
   source_code_uri: https://github.com/Verseth/ruby-config-loader
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -54,15 +52,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Gem that makes it easy to load config files.
 test_files: []

data/sig/config_loader.rbs

@@ -1,4 +0,0 @@
-module ConfigFileManager
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end