biran 0.1.14 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 724bb696cb3fefd277f0d8c892eab6a3bb247fe2cf8015fc721c9d79f5c3fc78
-  data.tar.gz: 00af99015b69fa0d49f5ebd4f67fa237729416a1ae9aacbf81bb0bd1aab54482
+  metadata.gz: d862a844d5e11a1453aad13df8c47fdca3392f8bc64fb82bd726f4eb034630db
+  data.tar.gz: 49a1b2185ca65594fa706ebd26c3cfec620db033a12b3763b9eb6944077c77c8
 SHA512:
-  metadata.gz: 4613fff5623383163a13cb4592c4b869efbdd0ac08b81494f0e6db4e80ef8356d44ff538dcd03b09df873bff1484010fbd093f045f436d4c19d9e6ec6e4806eb
-  data.tar.gz: 45744b7d551dbd3f3df0d841fc9fcf8de8cda94fdafae3c20a05545e3b708acde2cb9378fbf69dc39ad149dcc2369c174e53834947c7c55088cec4d9f6a75f17
+  metadata.gz: 46bbd0b7e003fe6e5bfd9036a0fb7a9b6c240ebf0b4b0a32d008b8c20a8a140f325cca9e5f8f4bc4706d21627cc646cf65cbf1f75bb3fc431ed8eeea4e738d82
+  data.tar.gz: 9209c6ca4a45d8939c0f7b8796a2079a35985afaed20750a6c9bc7d7548e1b4c10f387beb4fd92455f9af0c8413f96c643647582ab59aadf659307079124fc2d

data/README.md

@@ -40,7 +40,8 @@ Dir.glob('lib/tasks/*.rake').each {|r| import r}
 # Configuration
 
 You can set where your config files are, rails end and other stuff in a file like `config/initializers/biran.rb`
-You can also set options in `config/app_config.yml` in the `app` block. This list will be loaded last and override anything set in the initializer.
+You can also set options in `config/app_config.yml` in the `app` block. This list will be loaded last and override anything set in the initializer. All string
+input is sanitized to remove special characters that don't play well with file system paths. Any special haracters found are replaced with a '-'.
 
 Config file example:
 ```
@@ -92,6 +93,7 @@ the list of things you can configure are:
 :local_config_filename,
 :db_config_file_name,
 :secrets_filename,
+:extra_config_suffix,
 :config_dirname,
 :base_path,
 :shared_dir,
@@ -145,6 +147,16 @@ Available in: config file, initializer**
 
 Generally no need to change, but here in case you want to. Default is `secrets.yml`
 
+### extra_config_suffix
+**Type: string  
+Default: extras  
+Available in: environment variable, config_file, initializer**
+
+Sets the suffix to be applied to an extra config file you may want to load. The suffix is appended to the value of the config_filename. The default value will be `app_config_extras.yml`.
+This file gets loaded just before the local config file and can be used to provide additional configuration based stored in a second file. There are times when you may want to organize the
+configuration based on sub grouping that the yaml just doesn't allow easily.  
+Use cases might include grouping config based on a location, type of host, or even for testing purposes.
+
 ### config_dirname
 **Type: string  
 Default: config  

data/Rakefile

@@ -22,10 +22,10 @@ begin
   task("spec").clear
 
   RSpec::Core::RakeTask.new(:spec) do |t|
-    t.rspec_opts = "--format RSpec::TapY | tapout runtime"
+    t.rspec_opts = "--format documentation"
   end
 
-  task :default => :spec
+  task default: :spec
 rescue LoadError
   raise 'No rspec available'
 end

data/config/app_config.yml

@@ -7,9 +7,11 @@ defaults: &defaults
         extension: '.yml'
   my_first_value: 1
   my_second_value: 2
+  my_fifth_value: 5
   nested_values: &nested_defaults
     my_third_value: 3
     my_fourth_value: 4
+    my_sixth_value: 6
 
 test:
   <<: *defaults

data/config/app_config_test.yml

@@ -0,0 +1,10 @@
+defaults: &defaults
+  my_fifth_value: 55
+  nested_values:
+    my_sixth_value: 66
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults

data/lib/biran/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'singleton'
 
 module Biran
@@ -6,14 +7,15 @@ module Biran
 
     attr_writer :config_filename, :local_config_filename, :db_config_filename,
                 :secrets_filename, :config_dirname, :use_capistrano, :db_config,
-                :secrets, :base_path, :app_env, :base_dir, :bindings, :app_setup_blocks
+                :secrets, :base_path, :app_env, :base_dir, :bindings, :app_setup_blocks,
+                :extra_config_suffix
 
     attr_accessor :shared_dir
 
     def app_env
       return @app_env if @app_env
       @app_env = Rails.env if defined? Rails
-      @app_env ||= 'development'.freeze
+      @app_env ||= 'development'
     end
 
     def base_dir
@@ -21,27 +23,27 @@ module Biran
     end
 
     def config_filename
-      @config_filename ||= 'app_config.yml'.freeze
+      @config_filename ||= 'app_config.yml'
     end
 
     def local_config_filename
-      @local_config_filename ||= 'local_config.yml'.freeze
+      @local_config_filename ||= 'local_config.yml'
     end
 
     def db_config_filename
-      @db_config_filename ||= 'db_config.yml'.freeze
+      @db_config_filename ||= 'db_config.yml'
     end
 
     def secrets_filename
-      @secrets_filename ||= 'secrets.yml'.freeze
+      @secrets_filename ||= 'secrets.yml'
     end
 
     def config_dirname
-      @config_dirname ||= 'config'.freeze
+      @config_dirname ||= 'config'
     end
 
     def vhost_public_dirname
-      @vhost_public_dirname ||= 'public'.freeze
+      @vhost_public_dirname ||= 'public'
     end
 
     def use_capistrano
@@ -63,13 +65,17 @@ module Biran
     end
 
     def app_setup_blocks
-      @app_setup_blocks ||= %i[app].freeze
+      @app_setup_blocks ||= %i[app]
     end
 
     def bindings
       @bindings ||= %i[db_config]
     end
 
+    def extra_config_suffix
+      @extra_config_suffix ||= 'extras'
+    end
+
     def base_path
       return @base_path if @base_path
       @base_path = Rails.root if defined? Rails

data/lib/biran/config_defaults.rb

@@ -20,7 +20,8 @@ module Biran
     end
 
     def app_env
-      ENV['BIRAN_APP_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || configuration.app_env
+      app_env = ENV['BIRAN_APP_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || configuration.app_env
+      sanitize_input(app_env)
     end
 
     def app_base
@@ -41,37 +42,62 @@ module Biran
       app_config_defaults[:app][:bindings]
     end
 
+    def config_dirname
+      sanitize_input(configuration.config_dirname)
+    end
+
     def config_dir
-      File.join configuration.base_path, configuration.config_dirname
+      File.join(configuration.base_path, config_dirname)
     end
 
     def local_config_file
       ENV['BIRAN_LOCAL_CONFIG_FILE'] ||
-        File.join(app_shared_dir, configuration.config_dirname, local_config_filename)
+        File.join(app_shared_dir, config_dirname, local_config_filename)
     end
 
     def local_config_filename
-      ENV['BIRAN_LOCAL_CONFIG_FILENAME'] || app_config_defaults[:app][:local_config_filename] || configuration.local_config_filename
+      filename= ENV['BIRAN_LOCAL_CONFIG_FILENAME'] || app_config_defaults[:app][:local_config_filename] || configuration.local_config_filename
+      sanitize_input( filename )
+    end
+
+    def extra_config_suffix
+      suffix = ENV['BIRAN_EXTRA_CONFIG_SUFFIX'] || app_config_defaults[:app][:extra_config_suffix] || configuration.extra_config_suffix
+      sanitize_input( suffix )
+    end
+
+    def extra_config_file
+      File.join(config_dirname, app_config_filename.gsub(/\.yml$/, "_#{extra_config_suffix}.yml"))
+    end
+
+    def app_config_filename
+      sanitize_input(configuration.config_filename)
+    end
+
+    def app_config_file
+      File.join(config_dirname, app_config_filename)
     end
 
     def vhost_public_dirname
-      ENV['BIRAN_VHOST_PUBLIC_DIRNAME'] || app_config_defaults[:app][:vhost_public_dirname]
+      pub_dir_name = ENV['BIRAN_VHOST_PUBLIC_DIRNAME'] || app_config_defaults[:app][:vhost_public_dirname]
+      sanitize_input(pub_dir_name)
     end
 
     def db_config_override_file
-      File.join(app_shared_dir, configuration.config_dirname, db_config_filename)
+      File.join(app_shared_dir, config_dirname, db_config_filename)
     end
 
     def db_config_filename
-       app_config_defaults[:app][:db_config_filename] || configuration.db_config_filename
+       filename = app_config_defaults[:app][:db_config_filename] || configuration.db_config_filename
+       sanitize_input(filename)
     end
 
     def secrets_file
-      File.join(configuration.base_path, configuration.config_dirname, secrets_filename)
+      File.join(configuration.base_path, config_dirname, secrets_filename)
     end
 
     def secrets_filename
-      app_config_defaults[:app][:secrets_filename] || configuration.secrets_filename
+      filename = app_config_defaults[:app][:secrets_filename] || configuration.secrets_filename
+      sanitize_input(filename)
     end
 
     def default_db_config_file
@@ -81,5 +107,10 @@ module Biran
     def use_capistrano?
       # Implement in consumer class
     end
+
+    def sanitize_input string
+      # Borrowed from ActiveStorage
+      string.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "�").strip.tr("\u{202E}%$|:;/\t\r\n\\", "-")
+    end
   end
 end

data/lib/biran/configurinator.rb

@@ -61,6 +61,7 @@ module Biran
       app_config[:secrets].deep_merge! get_secrets_content(app_config[:secrets_file_path])
       app_config[:db_config].deep_merge! build_db_config
 
+      app_config.deep_merge! extra_config_file_contents
       app_config.deep_merge! local_config_file_contents
     end
 
@@ -72,13 +73,12 @@ module Biran
 
     def base_db_config
       return @base_db_config if @base_db_config
-      return @base_db_config = {} unless File.exists? default_db_config_file
+      return @base_db_config = {} unless File.exist? default_db_config_file
       @base_db_config ||= process_config_file(default_db_config_file)
     end
 
     def app_config_defaults
       return @app_config_defaults if @app_config_defaults
-      app_config_file = File.join(configuration.config_dirname, configuration.config_filename)
       app_defaults = app_defaults_init.dup
       config_properties = process_config_file(app_config_file)
       @app_config_defaults = app_defaults.deep_merge! config_properties
@@ -104,15 +104,21 @@ module Biran
 
     def local_config_file_contents
       return @local_config_contents if @local_config_contents
-      return @local_config_conents = {} unless File.exists? local_config_file
+      return @local_config_conents = {} unless File.exist? local_config_file
       @local_config_contents = process_config_file(local_config_file)
     end
 
     def get_secrets_content(secrets_file)
-      return {} unless File.exists? secrets_file
+      return {} unless File.exist? secrets_file
       process_config_file secrets_file
     end
 
+    def extra_config_file_contents
+      return @extra_config_contents if @extra_config_contents
+      return @extra_config_contents = {} unless File.exist? extra_config_file
+      @extra_config_contents = process_config_file(extra_config_file)
+    end
+
     def sanitize_config_files files_list
       lambda do |(file, _)|
         files_list[file] ||=  {extension: ''}
@@ -124,7 +130,6 @@ module Biran
 
     def yaml_load data_content
       # Ruby 3.1 with Psych 4 allows yaml-aliases only in direct manner
-      return YAML.safe_load(data_content, [], [], true) if defined?(Psych::VERSION) && Gem::Version.new(Psych::VERSION) < Gem::Version.new('4.0')
       YAML.safe_load(data_content, aliases: true)
     end
 

data/lib/biran/erb_config.rb

@@ -41,7 +41,7 @@ module Biran
 
     def process_erb
       config_erb_file = File.join(source_dir, "_#{name}#{extension}.erb")
-      ERB.new(File.read(config_erb_file), nil, '-')
+      ERB.new(File.read(config_erb_file), trim_mode: '-')
     rescue Errno::ENOENT
       raise Biran::ConfigSyntaxError, "Missing template file for #{name}: #{config_erb_file}"
     end

data/lib/biran/version.rb

@@ -1,3 +1,3 @@
 module Biran
-  VERSION = '0.1.14'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biran
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.2.0
 platform: ruby
 authors:
 - javierg
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-01 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -89,33 +89,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: tapout
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rspec-ontap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.15'
 description: Biran is the guy that will help you generate config files for your rail
   app.
 email:
@@ -129,6 +115,7 @@ files:
 - Rakefile
 - config/_my_config.yml.erb
 - config/app_config.yml
+- config/app_config_test.yml
 - lib/biran.rb
 - lib/biran/config.rb
 - lib/biran/config_defaults.rb
@@ -153,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="