biran 0.1.8 → 0.1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2899df8d26f43dff4f0b02faa88e392cb6bbae9cc09d45d069941ec01c578dc
-  data.tar.gz: ab08ca47f5e366256e732b928cb0987036409d051bc45e1612eae066aeae3136
+  metadata.gz: ec150cd74d08598ecb7d3bfb1324bf57c15e20806c0143b042b257569f430bf6
+  data.tar.gz: 7863cf3face519ede43bb1ca24f569112ad83fe8e686c467141c81a13a0b981d
 SHA512:
-  metadata.gz: eba5400620ab12da84098d634f078e568ba5b33b97cd2cff7a44d3566322dff32b512259880145fc8559fa6fd97bb11a4cf9ecce6a9c96ddd4d3914402236b25
-  data.tar.gz: 281d530de1ee0f93a11fcc5030c66950715eff2f8cad295b5e08eb2c027e0438e4652b82928e7d35187a35ecf3f093590196593abb82b089e239365bc6173a04
+  metadata.gz: 5464720ba0f9989e9941b77ca1fd54a17388eedd3d044e180689ce58fb7a1da87252e0ccfa09fab514410077ffe18b0a7fbbb52a56a35fce0ebc8ed6b5fb4964
+  data.tar.gz: 1edb42ac1ebc49f45d6c60e312a4bd089495fdc11c2c96be0f1f2328f4a8d6bbdb5d14b11dbfe16fae34b8c1ab086b6ee48c82bfe4d0c3d0e8a0400e73a4b907

data/README.md

@@ -231,7 +231,7 @@ Availble in: environment, initializer, instance**
 
 Generally not needed to specify unless you are not using rails or do not want to use `Rails.env` for lookups in config blocks.  
 You can set the app_env during instance creation by passing an environment string.  
-The following example will use the default or any of the built in environment vairables(BIRAN_APP_ENV, RACK_ENV, RAILS_ENV) or fall back to default.
+The following example will use the value of one of the built in environment variable found, checked in the following order: BIRAN_APP_ENV, RAILS_ENV, RACK_ENV. If one of the environment variables is not found, the default value will be used.
 ```
 config = Biran::Configurinator.new
 ```
@@ -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,13 @@
+defaults: &defaults
+  app:
+    base_path: <%= Dir.pwd %>
+    use_capistrano: false
+    files_to_generate:
+      my_config:
+        extension: '.yml'
+
+test:
+  <<: *defaults
+
+development:
+  <<: *defaults

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/config_defaults.rb

@@ -11,16 +11,16 @@ module Biran
           shared_dir: configuration.shared_dir,
           base_dir: configuration.base_dir,
           use_capistrano: configuration.use_capistrano,
-          db_config: configuration.db_config,
-          secrets: configuration.secrets,
           bindings: configuration.bindings,
           vhost_public_dirname: configuration.vhost_public_dirname
-        }
+        },
+        db_config: configuration.db_config,
+        secrets: configuration.secrets,
       }
     end
 
     def app_env
-      ENV['BIRAN_APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || configuration.app_env
+      ENV['BIRAN_APP_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || configuration.app_env
     end
 
     def app_base
@@ -47,7 +47,11 @@ module Biran
 
     def local_config_file
       ENV['BIRAN_LOCAL_CONFIG_FILE'] ||
-        File.join(app_shared_dir, configuration.config_dirname, configuration.local_config_filename)
+        File.join(app_shared_dir, configuration.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
     end
 
     def vhost_public_dirname
@@ -55,15 +59,23 @@ module Biran
     end
 
     def db_config_override_file
-      File.join(app_shared_dir, configuration.config_dirname, configuration.db_config_filename)
+      File.join(app_shared_dir, configuration.config_dirname, db_config_filename)
+    end
+
+    def db_config_filename
+       app_config_defaults[:app][:db_config_filename] || configuration.db_config_filename
     end
 
     def secrets_file
-      File.join(configuration.base_path, configuration.config_dirname, configuration.secrets_filename)
+      File.join(configuration.base_path, configuration.config_dirname, secrets_filename)
+    end
+
+    def secrets_filename
+      app_config_defaults[:app][:secrets_filename] || configuration.secrets_filename
     end
 
     def default_db_config_file
-      File.join(config_dir, configuration.db_config_filename)
+      File.join(config_dir, db_config_filename)
     end
 
     def use_capistrano?

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
@@ -53,8 +58,8 @@ module Biran
       }
 
       app_config.deep_merge! app_config_defaults
-      app_config[:secrets] = get_secret_contents(app_config)
-      app_config[:db_config] = build_db_config
+      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! local_config_file_contents
     end
@@ -103,16 +108,13 @@ module Biran
       @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
+    def get_secrets_content(secrets_file)
+      return {} unless File.exists? secrets_file
+      process_config_file secrets_file
     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?

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.8'
+  VERSION = '0.1.13.1'
 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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: biran
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.13.1
 platform: ruby
 authors:
 - javierg
 - brlanier
 - seancookr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2021-03-18 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,14 @@ 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.debug
 - lib/biran/erb_config.rb
+- lib/biran/exceptions.rb
 - lib/biran/railtie.rb
 - lib/biran/version.rb
 - lib/tasks/biran_tasks.rake
@@ -134,7 +142,7 @@ homepage: https://github.com/amco/biran
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +157,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: []

data/lib/biran/configurinator.rb.debug

@@ -1,145 +0,0 @@
-module Biran
-  class Configurinator
-    include ConfigDefaults
-
-    DEFAULT_ENV = 'development'
-
-    attr_reader :config, :db_config
-
-    class << self
-      attr_accessor :config
-
-      def configure
-        self.config ||= Config.instance
-        yield config
-      end
-
-      def env= env
-        @env = env
-      end
-    end
-
-    def env
-      return @env if @env
-      @env = app_env
-    end
-
-    def initialize
-      @config = build_app_config
-    end
-
-    def file_tasks
-      files_to_generate.keys
-    end
-
-    def debug_stuff
-      puts "app env2 is: #{app_env}"
-      puts "instance @env is #{@env}"
-      puts "env from method is #{env}"
-      puts "rack env is #{ENV['RACK_ENV']}"
-    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_dir ||= config_dir
-      #debug_stuff
-      generated_file = ERBConfig.new(filtered_config, name, extension, config_dir, output_dir)
-      generated_file.bindings = bindings
-      generated_file.save!
-    end
-
-    private
-
-    def build_app_config
-      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] = get_secret_contents(app_config)
-      app_config[:db_config] = build_db_config
-
-      app_config.deep_merge! local_config_file_contents
-    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)
-      config_file_contents[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