a9n 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ec9b298373c65a346ce067638ebd8ceead3212f184296861c9c1c63b8af08f
-  data.tar.gz: eadff429b6e3f4b6e81f9f7c203475afd7ccadb879b222b405ea1a19a3c27475
+  metadata.gz: 2d6b3183902e220ce9b3159af50976f1a13ad2e7eecd37b8ddc63cc461b2cbd3
+  data.tar.gz: cae9ed3830fe21623e856349703378526b38f653bcd9ca9393d102050ae5b798
 SHA512:
-  metadata.gz: e46ea38e14377bcd4b1ddd2740e8f7619a2b0d35b35ea2a017ce348044284127018e730e0c6474922b910bced72413ffc152df06f65ed158882e4e7973612691
-  data.tar.gz: 989588cc2260ab4d1c6023c8d83a4939cc71031e362273da9a6c6ee057df16b7756fa8d7b366b5f35e05ef396996b36d03e655dae09bcc2c19fab344e03f0474
+  metadata.gz: a436c129417fefef0e2fbdb728b83b18cf9e1ee9192303737fa9d00bde7bc2189f98228a58a0db44e6b6a233524d7e8a94d418de37f83c68c28634a4e459cbb8
+  data.tar.gz: af4055cef9c76f29d9146ed4c3471b6885491d5c193c641a24bc432ed69bf7578dda31b10a5fbb69ed75a9924a33d0d02cfe2365245f844bf5d64033e9b80261

data/.hound.yml

@@ -0,0 +1,4 @@
+fail_on_violations: true
+
+rubocop:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,43 @@
+Gemspec/RequiredRubyVersion:
+  Include:
+    - 2.4
+    - 2.5
+    - 2.6
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/LineLength:
+  Max: 140
+
+Security/YAMLLoad:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/MethodMissingSuper:
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TrivialAccessors:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+a9n

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.3

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.3
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 addons:
   code_climate:
     repo_token: 9aa2aa2432639c57772b6917ad9da468709e5536b75617575b02b35201a2eaf8

data/README.md

@@ -10,7 +10,7 @@
 [codeclimate]: https://codeclimate.com/github/knapo/a9n
 [coverage]: https://codeclimate.com/github/knapo/a9n
 
-A9n is a simple tool to keep ruby/rails apps configuration maintanable and verifiable. It supports Rails 3.x, 4.x and Ruby 2.0. 2.1, 2.2, 2.3. Ruby 1.8 and Rails 2.x are not supported since version 0.1.2. Ruby 1.9 is not supported since version 0.4.0.
+A9n is a simple tool to keep ruby/rails apps configuration maintanable and verifiable. It supports Rails 4+ and Ruby 2.4+.
 
 Why it's named a9n? It's a numeronym for application (where 9 stands for the number of letters between the first **a** and last **n**, similar to i18n or l10n).
 
@@ -34,7 +34,7 @@ keys `A9n::MissingConfigurationVariablesError` is thrown with the explanation wh
 Set application root and load configuration by adding to your `application.rb` or `environment.rb` right
 after budler requires:
 
-    A9n.root = File.expand_path('../..', __FILE__)
+    A9n.root = File.expand_path('..', __dir__)
     A9n.load
 
 This step is not required ,if you don't use `a9n` in the environment settings or initializers.
@@ -64,16 +64,16 @@ is accessible by:
 
 If you want to split configuration, you can use multiple files. All files from `config/a9n` are loaded by default, but you may pass custom paths as an argument to `A9n.load` e.g. `A9n.load('config/facebook.yml', 'config/mongoid.yml')`. In such cases config items are accessible through the scope consistent with the file name.
 
-E.g. if you have `config/a9n/mandrill.yml`:
+E.g. if you have `config/a9n/mail.yml`:
 
      defaults:
-       username: "joe"
-       api_key: "1234asdf"
+       email_from: 'knapo@knapo.net'
+       delivery_method: 'smtp'
 
 You can access it by:
 
-     A9n.mandrill.username # => `joe`
-     A9n.mandrill.api_key # => `1234asdf`
+     A9n.mail.email_from # => `knapo@knapo.net`
+     A9n.mail.delivery_method # => `smtp`
 
 ## Mapping ENV variables
 

data/Rakefile

@@ -1,4 +1,3 @@
-#!/usr/bin/env rake
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
@@ -8,4 +7,4 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = ['--profile', '--color']
 end
 
-task default: :spec
+task default: :spec

data/a9n.gemspec

@@ -1,24 +1,25 @@
-require File.expand_path('../lib/a9n/version', __FILE__)
+require File.expand_path('lib/a9n/version', __dir__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Krzysztof Knapik"]
-  gem.email         = ["knapo@knapo.net"]
-  gem.description   = %q{a9n - ruby/rails apps configuration manager}
-  gem.summary       = %q{a9n is a tool to keep ruby/rails apps extra configuration easily maintainable and verifiable}
-  gem.homepage      = "https://github.com/knapo/a9n"
+  gem.authors       = ['Krzysztof Knapik']
+  gem.email         = ['knapo@knapo.net']
+  gem.description   = 'a9n - ruby/rails apps configuration manager'
+  gem.summary       = 'a9n is a tool to keep ruby/rails apps extra configuration easily maintainable and verifiable'
+  gem.homepage      = 'https://github.com/knapo/a9n'
   gem.license       = 'MIT'
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^exe/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "a9n"
-  gem.require_paths = ["lib"]
+  gem.name          = 'a9n'
+  gem.require_paths = ['lib']
   gem.version       = A9n::VERSION
 
-  gem.required_ruby_version = ">= 2.3"
+  gem.required_ruby_version = '>= 2.4'
 
+  gem.add_development_dependency 'codeclimate-test-reporter'
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'codeclimate-test-reporter'
-  gem.add_development_dependency 'pry'
 end

data/lib/a9n.rb

@@ -1,25 +1,25 @@
-require "forwardable"
-require "pathname"
-require "ostruct"
-require "yaml"
-require "erb"
-require "a9n/version"
-require "a9n/exceptions"
-require "a9n/struct"
-require "a9n/scope"
-require "a9n/ext/string_inquirer"
-require "a9n/ext/hash"
-require "a9n/loader"
+require 'forwardable'
+require 'pathname'
+require 'ostruct'
+require 'yaml'
+require 'erb'
+require 'a9n/version'
+require 'a9n/exceptions'
+require 'a9n/struct'
+require 'a9n/scope'
+require 'a9n/ext/string_inquirer'
+require 'a9n/ext/hash'
+require 'a9n/loader'
 
 module A9n
   extend SingleForwardable
 
-  EXTENSION_LIST = "{yml,yml.erb,yml.example,yml.erb.example}"
-  STRICT_MODE = "strict"
+  EXTENSION_LIST = '{yml,yml.erb,yml.example,yml.erb.example}'.freeze
+  STRICT_MODE = 'strict'.freeze
 
   class << self
     def env
-      @env ||= ::A9n::StringInquirer.new(app_env || env_var("RAILS_ENV") || env_var("RACK_ENV") || env_var("APP_ENV"))
+      @env ||= ::A9n::StringInquirer.new(app_env || env_var('RAILS_ENV') || env_var('RACK_ENV') || env_var('APP_ENV'))
     end
 
     def env=(value)
@@ -27,7 +27,7 @@ module A9n
     end
 
     def app_env
-      app.env if app && app.respond_to?(:env)
+      app&.env
     end
 
     def app
@@ -43,7 +43,7 @@ module A9n
     end
 
     def app_root
-      app.root if app && app.respond_to?(:root)
+      app&.root
     end
 
     def root=(path)
@@ -55,7 +55,8 @@ module A9n
     end
 
     def env_var(name, strict: false)
-      fail A9n::MissingEnvVariableError.new(name) if strict && !ENV.key?(name)
+      raise A9n::MissingEnvVariableError, name if strict && !ENV.key?(name)
+
       if ENV[name].is_a?(::String)
         ENV[name].dup.force_encoding(Encoding::UTF_8)
       else
@@ -66,7 +67,7 @@ module A9n
     def default_files
       files  = Dir[root.join("config/{#{A9n::Scope::ROOT_NAMES.join(',')}}.#{EXTENSION_LIST}").to_s]
       files += Dir[root.join("config/a9n/*.#{EXTENSION_LIST}")]
-      files.map{ |f| f.sub(/.example$/,'') }.uniq
+      files.map { |f| f.sub(/.example$/, '') }.uniq
     end
 
     def load(*files)
@@ -109,23 +110,28 @@ module A9n
         storage[scope.name] = data
         define_root_geters(scope.name)
       end
-      return data
+
+      data
     end
 
     def absolute_paths_for(files)
-      files.map { |file| Pathname.new(file).absolute? ? file : self.root.join('config', file).to_s }
+      files.map { |file| Pathname.new(file).absolute? ? file : root.join('config', file).to_s }
     end
 
     def require_local_extension
-      return if app.nil? || root.nil?
-      local_extension_file = File.join(root, "config/a9n.rb")
+      return if root.nil?
+
+      local_extension_file = File.join(root, 'config/a9n.rb')
+
       return unless File.exist?(local_extension_file)
+
       require local_extension_file
     end
 
     def define_root_geters(*names)
       names.each do |name|
         next if respond_to?(name)
+
         define_singleton_method(name) { storage.fetch(name) }
       end
     end

data/lib/a9n/capistrano.rb

@@ -1,5 +1,5 @@
 if defined?(Capistrano::Configuration.instance)
   require 'a9n/capistrano/ver2x.rb'
 else
-  load File.expand_path('../capistrano/tasks.cap', __FILE__)
+  load File.expand_path('capistrano/tasks.cap', __dir__)
 end

data/lib/a9n/capistrano/tasks.cap

@@ -1,12 +1,12 @@
 namespace :a9n do
-  desc "Copy stage configuration to the base file."
+  desc 'Copy stage configuration to the base file.'
   task :copy_stage_config do
     on roles(:app) do
       within fetch(:release_path) do
-        execute :cp, "config/configuration.yml.#{fetch(:stage)}", "config/configuration.yml"
+        execute :cp, 'config/configuration.yml.#{fetch(:stage)}', 'config/configuration.yml'
       end
     end
   end
 end
 
-after "deploy:updating", "a9n:copy_stage_config"
+after 'deploy:updating', 'a9n:copy_stage_config'

data/lib/a9n/capistrano/ver2x.rb

@@ -1,8 +1,8 @@
 Capistrano::Configuration.instance.load do
-  after "deploy:update_code", "a9n:copy_stage_config"
+  after 'deploy:update_code', 'a9n:copy_stage_config'
 
   namespace :a9n do
-    desc "Copy stage configuration to base file."
+    desc 'Copy stage configuration to base file.'
     task :copy_stage_config, roles: :app do
       run "cp #{fetch(:release_path)}/config/configuration.yml.#{fetch(:stage)} #{fetch(:release_path)}/config/configuration.yml"
     end

data/lib/a9n/ext/hash.rb

@@ -3,14 +3,16 @@ module A9n
     class << self
       def deep_prepare(hash, scope)
         hash.inject({}) do |result, (key, value)|
-          result[(key.to_sym rescue key)] = get_value(key, value, scope)
+          key_name = key.respond_to?(:to_sym) ? key.to_sym : key
+          result[key_name] = get_value(key, value, scope)
           result
         end
       end
 
       def merge(*items)
         return nil if items.compact.empty?
-        items.compact.inject({}){|sum, item| sum.merge!(item)}
+
+        items.compact.inject({}) { |sum, item| sum.merge!(item) }
       end
 
       private

data/lib/a9n/ext/string_inquirer.rb

@@ -4,11 +4,11 @@ module A9n
     private
 
     def respond_to_missing?(method_name, include_private = false)
-      (method_name[-1] == "?") || super
+      (method_name[-1] == '?') || super
     end
 
     def method_missing(method_name, *arguments)
-      if method_name[-1] == "?"
+      if method_name[-1] == '?'
         self == method_name[0..-2]
       else
         super

data/lib/a9n/loader.rb

@@ -1,8 +1,8 @@
 module A9n
   class Loader
-    attr_reader :scope, :env, :local_file, :example_file
+    attr_reader :scope, :env, :local_file, :example_file, :struct
 
-    COMMON_SCOPE = "defaults"
+    COMMON_SCOPE = 'defaults'.freeze
 
     def initialize(file_path, scope, env)
       @scope = scope
@@ -12,20 +12,15 @@ module A9n
     end
 
     def get
-      @struct ||= load
+      struct || load
     end
 
     def load
       local_config    = self.class.load_yml(local_file, scope, env)
       example_config  = self.class.load_yml(example_file, scope, env)
 
-      if local_config.nil? && example_config.nil?
-        fail A9n::MissingConfigurationDataError.new("Configuration data for *#{env}* env was not found in neither *#{example_file}* nor *#{local_file}*")
-      end
-
-      if !local_config.nil? && !example_config.nil?
-        verify!(local_config, example_config)
-      end
+      ensure_data_presence!(local_config, example_config)
+      ensure_keys_presence!(local_config, example_config)
 
       @struct = A9n::Struct.new(local_config || example_config)
     end
@@ -33,6 +28,7 @@ module A9n
     class << self
       def load_yml(file_path, scope, env)
         return nil unless File.exist?(file_path)
+
         yml = YAML.load(ERB.new(File.read(file_path)).result)
 
         common_scope = prepare_yml_scope(yml, scope, COMMON_SCOPE)
@@ -42,21 +38,30 @@ module A9n
       end
 
       def prepare_yml_scope(yml, scope, env)
-        if yml[env].is_a?(::Hash)
-          A9n::Hash.deep_prepare(yml[env], scope)
-        else
-          nil
-        end
+        return nil unless yml[env].is_a?(::Hash)
+
+        A9n::Hash.deep_prepare(yml[env], scope)
       end
     end
 
     private
 
-    def verify!(local, example)
+    def ensure_data_presence!(local, example)
+      return unless local.nil?
+      return unless example.nil?
+
+      raise A9n::MissingConfigurationDataError, "Configuration data for *#{env}* env was not found in neither *#{example}* nor *#{local}*"
+    end
+
+    def ensure_keys_presence!(local, example)
+      return if local.nil?
+      return if example.nil?
+
       missing_keys = example.keys - local.keys
-      if missing_keys.any?
-        fail A9n::MissingConfigurationVariablesError.new("Following variables are missing in #{local_file} file: #{missing_keys.join(',')}")
-      end
+
+      return if missing_keys.empty?
+
+      raise A9n::MissingConfigurationVariablesError, "Following variables are missing in #{local_file} file: #{missing_keys.join(',')}"
     end
   end
 end

data/lib/a9n/scope.rb

@@ -1,6 +1,6 @@
 module A9n
   class Scope
-    ROOT_NAMES = [:configuration, :a9n]
+    ROOT_NAMES = [:configuration, :a9n].freeze
 
     attr_reader :name
 
@@ -17,8 +17,7 @@ module A9n
     end
 
     def self.form_file_path(path)
-      name = File.basename(path.to_s).split('.').first.to_sym
-      self.new(name)
+      new(File.basename(path.to_s).split('.').first.to_sym)
     end
   end
 end