biran 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cbbf6682aad11d3d9954df25555baa94be850624
-  data.tar.gz: 39016c642ec0bce21ca5394275271cd7409632cb
+SHA256:
+  metadata.gz: a67e7f787cbdfa09727e1214e5668cfc20ca239a6765c538b46884f70436cb10
+  data.tar.gz: c48aaf4d46a5a7a1130a14191113ed9db8ec9e8cbac2d71b6e1f74548fd5db32
 SHA512:
-  metadata.gz: 2379b8246e3690e8851d5204a5d85a2e6bbcdbc7c154e6222aec125232245586e59ac1818a8ac9ffcf576be8be46c0903dc5ab46d098749b97127cba2a29fd14
-  data.tar.gz: 670cebdc1b49959dc578e142d47b16ceb53f022bc7f08cf52b71a4853cdf1ac6c4acacc4fe6c9684550ffeee476eb01a1bf792c1bee2cb5fdfe19f13322fded8
+  metadata.gz: c878c531325e65bf3d0ec59b7d5b9b2f41921165d4390839c24c5aa78b94b654ab9af45934e0d3242a5031bc19ba7a9afc7e3be294acb14b141e69c438a01c8a
+  data.tar.gz: 185b07e2b09bd9fd2d0f666b814a9bb6ba8f5bd0c1e8943031d98cd8bb1fae588d12e59edcba4879df95c120e62a0f208153370621b54e2c0a11c07698ef5f2c

data/README.md

@@ -102,6 +102,7 @@ the list of things you can configure are:
 :bindings,
 :app_setup_blocks,
 :files_to_generate
+:vhost_public_dirname
 ```
 ## Options
 ### config_filename
@@ -226,9 +227,18 @@ defaults: &defaults
 ### app_env
 **Type: string  
 Default: Rails.env if rails or ‘development’ in non rails  
-Availble in: config file, initializer**
+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.
+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.
+```
+config = Biran::Configurinator.new
+```
+If you need to specify the environment on the instance directly, you can do the following to create a staging config object independent of the other app_env settings:
+```
+config = Biran::Configurinator.new(env: ‘staging)
+```
 
 ### bindings
 **Type: array  
@@ -276,7 +286,8 @@ Default:**
 **Available in: config file, initializer**
 
 This config option defines which files you want to be available to generate as part of the config:generate task. Each file listed will get its own task and will be run when `rake config:generate` is run.
-The default config will generate `config/vhost.conf` only. By default, all files will be generated in the `config` directory. You can override this in the options.
+The default config will generate `config/vhost.conf` only. By default, all files will be generated in the `config` directory. You can override this in the options by setting an `output_dir` and/or an `output_name` to define the location and the name to be added to the extension.  
+NOTE: If you use the `output_name` option, the template name is still pulled from the block name. In the example below, for the reports file, the template name would be `config/_reports.yml.erb` and the block will generate a file in `/srv/app/current/reports` named `user_report.yml`.  
 Basic exmple from `config/app_config.yml`:
 ```
 app:
@@ -290,5 +301,16 @@ app:
     reports:
       extension: ‘.yml’
       output_dir: ‘/srv/app/current/reports’
+      output_name: ‘user_report’
+```
+### vhost_public_dirname
+**Type: string  
+Default: 'public'  
+Available in: config file, initializer**
+
+Used to change the value of the public web directorname for use in the vhost config. Defined in the app block
+```
+app:
+  vhost_public_dirname: 'web'
 ```
 

data/lib/biran/config.rb

@@ -13,7 +13,7 @@ module Biran
     def app_env
       return @app_env if @app_env
       @app_env = Rails.env if defined? Rails
-      @app_env ||= 'development'
+      @app_env ||= 'development'.freeze
     end
 
     def base_dir
@@ -40,6 +40,10 @@ module Biran
       @config_dirname ||= 'config'.freeze
     end
 
+    def vhost_public_dirname
+      @vhost_public_dirname ||= 'public'.freeze
+    end
+
     def use_capistrano
       @use_capistrano ||= false
     end

data/lib/biran/config_defaults.rb

@@ -13,11 +13,16 @@ module Biran
           use_capistrano: configuration.use_capistrano,
           db_config: configuration.db_config,
           secrets: configuration.secrets,
-          bindings: configuration.bindings
+          bindings: configuration.bindings,
+          vhost_public_dirname: configuration.vhost_public_dirname
         }
       }
     end
 
+    def app_env
+      ENV['BIRAN_APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || configuration.app_env
+    end
+
     def app_base
       @app_base ||= ENV['BIRAN_APP_BASE_PATH'] || app_config_defaults[:app][:base_path] || app_config_defaults[:app][:root_path]
     end
@@ -45,6 +50,10 @@ module Biran
         File.join(app_shared_dir, configuration.config_dirname, configuration.local_config_filename)
     end
 
+    def vhost_public_dirname
+      ENV['BIRAN_VHOST_PUBLIC_DIRNAME'] || app_config_defaults[:app][:vhost_public_dirname]
+    end
+
     def db_config_override_file
       File.join(app_shared_dir, configuration.config_dirname, configuration.db_config_filename)
     end

data/lib/biran/configurinator.rb

@@ -4,7 +4,7 @@ module Biran
 
     DEFAULT_ENV = 'development'
 
-    attr_reader :config, :db_config
+    attr_reader :config, :db_config, :env
 
     class << self
       attr_accessor :config
@@ -13,19 +13,10 @@ module Biran
         self.config ||= Config.instance
         yield config
       end
-
-      def env= env
-        @env = env
-      end
-
-      def env
-        return @end if @env
-        return Rails.env if defined? Rails
-        DEFAULT_ENV
-      end
     end
 
-    def initialize
+    def initialize(env: nil)
+      @env = env || app_env
       @config = build_app_config
     end
 
@@ -39,9 +30,10 @@ module Biran
         .tap { |files_list| files_list.each(&sanitize_config_files(files_list)) }
     end
 
-    def create(name:, extension:, output_dir: nil)
+    def create(name:, extension:, output_dir: nil, output_name: nil)
       output_dir ||= config_dir
-      generated_file = ERBConfig.new(filtered_config, name, extension, config_dir, output_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
@@ -49,10 +41,12 @@ module Biran
     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
@@ -89,15 +83,15 @@ module Biran
       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[Configurinator.env].deep_symbolize_keys!
+      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, 'public'),
-        shared_dir: app_shared_dir,
+        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')
       }

data/lib/biran/configurinator.rb.debug

@@ -0,0 +1,145 @@
+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

data/lib/biran/erb_config.rb

@@ -1,18 +1,19 @@
 module Biran
   class ERBConfig
-    attr_reader :output_dir, :source_dir, :name, :extension, :config
+    attr_reader :output_dir, :source_dir, :name, :extension, :config, :output_name
     attr_accessor :bindings
 
-    def initialize(config, name, extension, source, output)
+    def initialize(config, name, extension, source, output_dir, output_name)
       @name       = name
       @extension  = extension
       @config     = config
       @source_dir = source
-      @output_dir = output
+      @output_dir = output_dir
+      @output_name = output_name
     end
 
     def save!
-      File.open(File.join(output_dir, "#{name}#{extension}"), 'w') do |f|
+      File.open(File.join(output_dir, "#{output_name}#{extension}"), 'w') do |f|
         f.print process_erb.result(build_erb_env.call)
       end
     end
@@ -26,7 +27,7 @@ module Biran
 
     def build_erb_env
       proc do
-        @environment = Configurinator.env
+        @environment = config[:env]
         @app_config  = config
 
         @bindings.each(&assign_instance_vars) unless @bindings.nil?

data/lib/biran/version.rb

@@ -1,3 +1,3 @@
 module Biran
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biran
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - javierg
@@ -10,50 +10,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2019-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.7
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.7
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +125,7 @@ files:
 - 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/railtie.rb
 - lib/biran/version.rb
@@ -148,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Helper for generating config generate tasks.