biran 0.1.11 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5889906b3c4456f766a2c5204bb4441e3add107cba9db0b1189ba12adb9a55ef
-  data.tar.gz: 41799ef23de8827c738b3e9cb0f584782fbab60759e2f742f32327e686fc09f9
+  metadata.gz: 724bb696cb3fefd277f0d8c892eab6a3bb247fe2cf8015fc721c9d79f5c3fc78
+  data.tar.gz: 00af99015b69fa0d49f5ebd4f67fa237729416a1ae9aacbf81bb0bd1aab54482
 SHA512:
-  metadata.gz: 7e06d5684a5c05f46fab522863f68f352f27b4eb176e26feaf5dc7fc31a696498103cb92f861fed51454fc269d04049ae2fabc986043bd9e7d4277852c429885
-  data.tar.gz: 02ae8db4a54fb74ccdbb17d1464a56ab6ec5180f5c8c0fd1d34ea6cc5e06aa9a461374d574b84d0185c4c922f965ab5496bbe1ea3fd238ac7699da3c4aae1b8e
+  metadata.gz: 4613fff5623383163a13cb4592c4b869efbdd0ac08b81494f0e6db4e80ef8356d44ff538dcd03b09df873bff1484010fbd093f045f436d4c19d9e6ec6e4806eb
+  data.tar.gz: 45744b7d551dbd3f3df0d841fc9fcf8de8cda94fdafae3c20a05545e3b708acde2cb9378fbf69dc39ad149dcc2369c174e53834947c7c55088cec4d9f6a75f17

data/README.md

@@ -302,7 +302,39 @@ app:
       extension: ‘.yml’
       output_dir: ‘/srv/app/current/reports’
       output_name: ‘user_report’
+```  
+
+In a more advanced example, you can generate multiple files from the same template by setting the `config_index_list` option. If you set this as a list of indexes, then a file will be generated for each index. The index number 
+will get passed to the template as an instance variable (`@config_index`) and can be used to look up a specific version of values from the config file. The file that is generated will respect the normal naming, including using the `output_name` option, however, it will append the 
+index number to the end of the file name. If the name was going to be special_file, and you add an index list of `[1,2]`, two files will get generated named `special_file-1` and `special_file-2`.  
+Advanced example from `config/app:.yml`:
+```
+app:
+  files_to_generate:
+    reports:
+      extension: '.yml'
+      config_index_list:
+        - one
+        - two
+reports:
+  default: &reports_default_values
+    some_value: 'some_value'
+    other_value: 'other_value'
+  one:
+    <<: *reports_default_values
+  two:
+    <<: *reports_default_values
+    some_value: 'my_value'
+```  
+Then in your template file you can use the index to get the proper config for each generated file. This allows you to reuse the same template to generate multiple files, each with different content. This is useful for generating service config files, like for sidekiq workers.
+The config above would generate two files: `config/reports-one.yml` and `config/reports-two.yml`, using the content from each index block as specified in the following simple template example.
 ```
+<% index = "{@config_index}" -%>
+defaults:
+  :some_value: <%= @app_config[:reports][index.to_sym][:some_value] %>
+  :other_value: <%= @app_config[:reports][index.to_sym][:other_value] %>
+```  
+
 ### vhost_public_dirname
 **Type: string  
 Default: 'public'  

data/config/_my_config.yml.erb

@@ -0,0 +1,2 @@
+my_config:
+  key: value

data/config/app_config.yml

@@ -0,0 +1,26 @@
+defaults: &defaults
+  app:
+    base_path: <%= Dir.pwd %>
+    use_capistrano: false
+    files_to_generate:
+      my_config:
+        extension: '.yml'
+  my_first_value: 1
+  my_second_value: 2
+  nested_values: &nested_defaults
+    my_third_value: 3
+    my_fourth_value: 4
+
+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/lib/biran/configurinator.rb

@@ -30,12 +30,17 @@ module Biran
         .tap { |files_list| files_list.each(&sanitize_config_files(files_list)) }
     end
 
-    def create(name:, extension:, output_dir: nil, output_name: nil)
+    def create(name:, extension:, output_dir: nil, output_name: nil, config_index_list: [])
       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!
+      return generated_file.save! unless config_index_list.any?
+      config_index_list.each do |config_index|
+        generated_file.output_name = "#{output_name}-#{config_index}"
+        generated_file.template_config_index = config_index
+        generated_file.save!
+      end
     end
 
     private
@@ -82,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}"
@@ -109,7 +114,7 @@ module Biran
     end
 
     def sanitize_config_files files_list
-      lambda do |file, _|
+      lambda do |(file, _)|
         files_list[file] ||=  {extension: ''}
         ext = files_list[file].fetch(:extension, '').strip
         ext.prepend('.') unless ext.start_with?('.') || ext.empty?
@@ -117,6 +122,12 @@ module Biran
       end
     end
 
+    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
+
     def filtered_config
       @filtered_config ||= config.except(*configuration.app_setup_blocks)
     end

data/lib/biran/erb_config.rb

@@ -1,34 +1,56 @@
 module Biran
   class ERBConfig
-    attr_reader :output_dir, :source_dir, :name, :extension, :config, :output_name
-    attr_accessor :bindings
+    attr_reader :output_dir, :source_dir, :name, :extension, :config, :template_contents
+    attr_accessor :bindings, :output_name, :template_config_index
+
+    DEFAULT_TEMPLATE_CONFIG_INDEX = 1
 
     def initialize(config, name, extension, source, output_dir, output_name)
-      @name       = name
-      @extension  = extension
-      @config     = config
-      @source_dir = source
-      @output_dir = output_dir
-      @output_name = output_name
+      before_process_erb do
+        @name       = name
+        @extension  = extension
+        @config     = config
+        @source_dir = source
+        @output_dir = output_dir
+        @output_name = output_name
+      end
     end
 
     def save!
       File.open(File.join(output_dir, "#{output_name}#{extension}"), 'w') do |f|
-        f.print process_erb.result(build_erb_env.call)
+        f.print template_contents.result(build_erb_env.call)
       end
     end
 
     private
 
+    def before_process_erb
+      yield
+      raise ArgumentError unless process_erb_ready?
+      @template_contents = process_erb
+    rescue ArgumentError
+      e_message = "Settings required to determine template name for #{name} are not configured"
+      raise Biran::ConfigSyntaxError, e_message
+    end
+
+    def process_erb_ready?
+      @name &&
+      @extension &&
+      @source_dir
+    end
+
     def process_erb
       config_erb_file = File.join(source_dir, "_#{name}#{extension}.erb")
       ERB.new(File.read(config_erb_file), nil, '-')
+    rescue Errno::ENOENT
+      raise Biran::ConfigSyntaxError, "Missing template file for #{name}: #{config_erb_file}"
     end
 
     def build_erb_env
       proc do
         @environment = config[:env]
         @app_config  = config
+        @config_index =  template_config_index || DEFAULT_TEMPLATE_CONFIG_INDEX
 
         @bindings.each(&assign_instance_vars) unless @bindings.nil?
 

data/lib/biran/exceptions.rb

@@ -0,0 +1,16 @@
+module Biran
+  class ConfigSyntaxError < ::StandardError
+    def initialize(msg=nil)
+      @msg = msg || 'Missing required argument or bad formatting in config file'
+      set_backtrace []
+    end
+
+    def to_s
+      @msg
+    end
+
+    def p_warning
+      "Warning: #{@msg}"
+    end
+  end
+end

data/lib/biran/version.rb

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

data/lib/biran.rb

@@ -5,6 +5,7 @@ require 'biran/config_defaults'
 require 'biran/config'
 require 'biran/erb_config'
 require 'biran/configurinator'
+require 'biran/exceptions'
 require 'biran/railtie' if defined?(Rails)
 
 module Biran

data/lib/tasks/biran_tasks.rake

@@ -1,18 +1,39 @@
 namespace :config do
   config = Biran::Configurinator.new
 
-  desc 'Generate new config files'
-  task :generate do
+  desc 'Legacy - Generate all new config files'
+  task :generate_legacy do
     Rake::Task['config:generate_with_deps'].enhance config.file_tasks
     Rake::Task['config:generate_with_deps'].invoke
   end
 
   task :generate_with_deps
 
+  desc 'Generate all new config files'
+  task :generate do
+    error_count = 0
+    config.file_tasks.each do |task|
+      Rake::Task["config:#{task}"].invoke
+    rescue Biran::ConfigSyntaxError => e
+      error_count += 1
+      puts e.p_warning
+      next
+    end
+
+    abort 'Errors in creating config files' unless error_count == 0
+  end
+
   config.files_to_generate.each do |file_name, options|
     desc %(Generate the #{file_name}#{options.fetch(:extension, '')} config file)
     task file_name do
       config.create name: file_name, **options
+    rescue ArgumentError => e
+      e_message = "Missing required argument or bad formatting in config file for #{file_name}"
+      e.set_backtrace([])
+      raise Biran::ConfigSyntaxError, e_message
+    rescue Biran::ConfigSyntaxError => e
+      e.set_backtrace([])
+      raise Biran::ConfigSyntaxError, e.message
     end
   end
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: biran
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.14
 platform: ruby
 authors:
 - javierg
 - brlanier
 - seancookr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-04 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -44,6 +44,9 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.7
@@ -51,6 +54,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.7
@@ -58,58 +64,58 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: tapout
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec-ontap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 description: Biran is the guy that will help you generate config files for your rail
   app.
 email:
@@ -121,12 +127,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- config/_my_config.yml.erb
+- config/app_config.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
@@ -134,8 +143,9 @@ files:
 homepage: https://github.com/amco/biran
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Helper for generating config generate tasks.
 test_files: []