biran 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5889906b3c4456f766a2c5204bb4441e3add107cba9db0b1189ba12adb9a55ef
-  data.tar.gz: 41799ef23de8827c738b3e9cb0f584782fbab60759e2f742f32327e686fc09f9
+  metadata.gz: 4d14217aa3698d0cf75e5ca704c0601debc6c49768668251af03fa552130666f
+  data.tar.gz: b99edeb48b785ba764c9cb9ab67a2fb403f3216b20b8c95d315592249a6fd417
 SHA512:
-  metadata.gz: 7e06d5684a5c05f46fab522863f68f352f27b4eb176e26feaf5dc7fc31a696498103cb92f861fed51454fc269d04049ae2fabc986043bd9e7d4277852c429885
-  data.tar.gz: 02ae8db4a54fb74ccdbb17d1464a56ab6ec5180f5c8c0fd1d34ea6cc5e06aa9a461374d574b84d0185c4c922f965ab5496bbe1ea3fd238ac7699da3c4aae1b8e
+  metadata.gz: 9d660b2a71857448b2cc1508ba8ee250b850a27f5a14c54b47f0c3fc4d9e200d3ddd6546efd134def3c895e3a010a12389a5cb4a004f539ab13983b75386eb5c
+  data.tar.gz: 6abba1cd95045a1fb5923edb0d7b360728109d1a3e46ea3736fba9153e8a76234806983803a9cd722ab28669f5bbedd0874d49a55b5940ed4bdf5696172623b7

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/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/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

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

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biran
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - javierg
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-04 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -127,6 +127,7 @@ files:
 - 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