biran 0.1.13.1 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec150cd74d08598ecb7d3bfb1324bf57c15e20806c0143b042b257569f430bf6
-  data.tar.gz: 7863cf3face519ede43bb1ca24f569112ad83fe8e686c467141c81a13a0b981d
+  metadata.gz: 1175961da6d05c7c7b23697b7522f2eebfbcee12fdf62cee19cee89dc1cd9ff0
+  data.tar.gz: e1b32e766224708ef485e81cf535ab0011e78dd97382f655fb358174ffd6e7f2
 SHA512:
-  metadata.gz: 5464720ba0f9989e9941b77ca1fd54a17388eedd3d044e180689ce58fb7a1da87252e0ccfa09fab514410077ffe18b0a7fbbb52a56a35fce0ebc8ed6b5fb4964
-  data.tar.gz: 1edb42ac1ebc49f45d6c60e312a4bd089495fdc11c2c96be0f1f2328f4a8d6bbdb5d14b11dbfe16fae34b8c1ab086b6ee48c82bfe4d0c3d0e8a0400e73a4b907
+  metadata.gz: 6ba45896793d88333fcc70fd22e5886293c46beb8e7eca1ae7ab250ccab510af4014e7dbe42a67453a7f009de0e1b01826f9d152b1a628bbce958eb961785fec
+  data.tar.gz: 6b3676949fec3f902e8cbb5fd3fd8cae359cd3b88bf3026b71a1c97a300b4ff2d101c1de44c615089aab7383d6c21afbce30d290fdf9011d4ab1603154428bea

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

@@ -5,9 +5,24 @@ defaults: &defaults
     files_to_generate:
       my_config:
         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
+  my_first_value: 11
+  nested_values:
+    <<: *nested_defaults
+    my_third_value: 13
 
 development:
   <<: *defaults
+  my_first_value: 11
+  nested_values:
+    <<: *nested_defaults
+    my_third_value: 13

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
 
@@ -78,7 +79,6 @@ module Biran
 
     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
@@ -87,7 +87,7 @@ module Biran
     def process_config_file(config_file)
       config_file_contents = File.read(config_file)
       config_file_contents = ERB.new(config_file_contents).result
-      config_file_contents = YAML.safe_load(config_file_contents, [], [], true)
+      config_file_contents = yaml_load(config_file_contents)
       config_file_contents[env].deep_symbolize_keys!
     rescue Errno::ENOENT
       raise "Missing config file: #{config_file}"
@@ -113,6 +113,12 @@ module Biran
       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.exists? 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: ''}
@@ -122,6 +128,11 @@ module Biran
       end
     end
 
+    def yaml_load data_content
+      # Ruby 3.1 with Psych 4 allows yaml-aliases only in direct manner
+      YAML.safe_load(data_content, aliases: true)
+    end
+
     def filtered_config
       @filtered_config ||= config.except(*configuration.app_setup_blocks)
     end

data/lib/biran/configurinator.rb.test_changes

@@ -0,0 +1,155 @@
+require 'biran/hash_refinement'
+
+module Biran
+  class Configurinator
+    include ConfigDefaults
+    using HashRefinement
+
+    DEFAULT_ENV = 'development'
+
+    attr_reader :config, :db_config, :env
+
+    class << self
+      attr_accessor :config
+
+      def configure
+        self.config ||= Config.instance
+        yield config
+      end
+    end
+
+    def initialize(env: nil)
+      @env = env || app_env
+      @config = build_app_config
+    end
+
+    def file_tasks
+      files_to_generate.keys
+    end
+
+    def files_to_generate
+      @files_to_generate ||= config.fetch(:app, {})
+        .fetch(:files_to_generate, configuration.files_to_generate)
+        .tap { |files_list| files_list.each(&sanitize_config_files(files_list)) }
+    end
+
+    def create(name:, extension:, output_dir: nil, output_name: nil)
+      output_dir ||= config_dir
+      output_name ||= name
+      generated_file = ERBConfig.new(filtered_config, name, extension, config_dir, output_dir, output_name)
+      generated_file.bindings = bindings
+      generated_file.save!
+    end
+
+    private
+
+    def build_app_config
+      raise 'Environment not set to build the application config' unless @env
+      app_config = {
+        app_root_dir: app_root,
+        app_shared_dir: app_shared_dir,
+        app_base_dir: app_base,
+        env: env,
+        local_config_file: local_config_file,
+        secrets_file_path: secrets_file,
+        vhost: config_vhost_dirs
+      }
+
+      app_config.deep_merge! app_config_defaults
+      app_config[:secrets].deep_merge! get_secret_contents(app_config)
+      app_config[:db_config] = build_db_config
+
+      app_config.deep_merge! local_config_file_contents
+
+      puts "app config final is #{app_config.inspect}"
+      app_config
+    end
+
+    def build_db_config
+      default_db_config = base_db_config
+      return default_db_config unless File.exist? db_config_override_file
+      default_db_config.deep_merge! process_config_file(db_config_override_file)
+    end
+
+    def base_db_config
+      return @base_db_config if @base_db_config
+      return @base_db_config = {} unless File.exists? 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
+    end
+
+    def process_config_file(config_file)
+      config_file_contents = File.read(config_file)
+      config_file_contents = ERB.new(config_file_contents).result
+      config_file_contents = YAML.safe_load(config_file_contents, [], [], true)
+      #puts "Config file contents after yaml load before env grab #{config_file_contents.inspect}"
+      config_file_contents_for_test = config_file_contents['test']
+      config_file_contents_for_env = config_file_contents[env]
+      puts "Config file contents for test:"
+      puts config_file_contents_for_test.to_yaml
+      puts
+      puts "Config file contents for #{env}:"
+      puts config_file_contents_for_env.to_yaml
+      puts
+      config_file_diff = config_file_contents_for_test.deep_diff(config_file_contents_for_env)
+      puts "diff hash is:"
+      puts config_file_diff.to_yaml
+      puts
+      config_file_diff_r = config_file_contents_for_env.deep_diff(config_file_contents_for_test)
+      puts "diff hash reversed is:"
+      puts config_file_diff_r.to_yaml
+      puts
+
+      config_file_contents_for_env.deep_symbolize_keys!
+    rescue Errno::ENOENT
+      raise "Missing config file: #{config_file}"
+    end
+
+    def config_vhost_dirs
+      {
+        public_dir: File.join(app_root, vhost_public_dirname),
+        shared_dir: app_shared_dir.to_s,
+        log_dir: File.join(app_root, 'log'),
+        pids_dir: File.join(app_root, 'tmp', 'pids')
+      }
+    end
+
+    def local_config_file_contents
+      return @local_config_contents if @local_config_contents
+      return @local_config_conents = {} unless File.exists? local_config_file
+      @local_config_contents = process_config_file(local_config_file)
+    end
+
+    def get_secret_contents(app_config)
+      secrets_file_contents = {}
+      if File.exist? app_config[:secrets_file_path]
+        secrets_file_contents = process_config_file app_config[:secrets_file_path]
+      end
+      secrets_file_contents
+    end
+
+    def sanitize_config_files files_list
+      lambda do |file, _|
+        files_list[file] ||=  {extension: ''}
+        ext = files_list[file].fetch(:extension, '').strip
+        ext.prepend('.') unless ext.start_with?('.') || ext.empty?
+        files_list[file][:extension] = ext
+      end
+    end
+
+    def filtered_config
+      @filtered_config ||= config.except(*configuration.app_setup_blocks)
+    end
+
+    def use_capistrano?
+      app_config_defaults[:app][:use_capistrano]
+    end
+  end
+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/hash_refinement.rb

@@ -0,0 +1,19 @@
+module HashRefinement
+
+  refine Hash do
+    def deep_diff(b)
+      a = self
+      (a.keys | b.keys).inject({}) do |diff, k|
+        if a[k] != b[k]
+          if a[k].respond_to?(:deep_diff) && b[k].respond_to?(:deep_diff)
+            diff[k] = a[k].deep_diff(b[k])
+          else
+            #diff[k] = b[k] || a[k]
+            diff[k] = b.keys.exclude?(k) ? a[k] : b[k]
+          end
+        end
+        diff
+      end
+    end
+  end
+end

data/lib/biran/version.rb

@@ -1,3 +1,3 @@
 module Biran
-  VERSION = '0.1.13.1'
+  VERSION = '0.1.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biran
 version: !ruby/object:Gem::Version
-  version: 0.1.13.1
+  version: 0.1.15
 platform: ruby
 authors:
 - javierg
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -88,34 +88,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: tapout
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  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'
 description: Biran is the guy that will help you generate config files for your rail
   app.
 email:
@@ -129,19 +101,23 @@ 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
 - lib/biran/configurinator.rb
+- lib/biran/configurinator.rb.test_changes
 - lib/biran/erb_config.rb
 - lib/biran/exceptions.rb
+- lib/biran/hash_refinement.rb
 - lib/biran/railtie.rb
 - lib/biran/version.rb
 - lib/tasks/biran_tasks.rake
 homepage: https://github.com/amco/biran
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -150,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="