a9n 0.4.10 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1d8f2c513626e5bfb81877c7829ae35c6967379
-  data.tar.gz: b4b7178b605d1130d79cb7ea500931dbdab8d318
+  metadata.gz: c71a89a1074cdf639fc076b8270d1492bda0fb92
+  data.tar.gz: 982f8eb998d9bd89f2942bc6fa1ee77b6e0f16a3
 SHA512:
-  metadata.gz: 45d9e0ed919596f3a1f9a1ea1df92f1be3cb85fa2964f5ac525c486a444b0a3a91f364c178389e22d3c5b32e35a7a5ccfe3422bfc21da51225313eeca84c7866
-  data.tar.gz: 42732ec164bb8ab98aa70306e1b239937520e389b3c1afc5995905badd4a55ece4a51c727743ad68c4135a0f2dafca1d3b40c94d23f57f7366c1259018fda180
+  metadata.gz: 1122f4218143bfb287cf5d3203eebfa5a935bcd19d8cec8acbb4944d7af4f8eedf2578022f1f2d97f00bcb1f032ed7a27a45bb992b74e831a51cdcf07c533b9d
+  data.tar.gz: 2384c6aafc3e68c25acf4f8f0f51d59b61cd5094a3693e4412d98de7ce14bcd423587f81ccbaa274ad982fe9ce376b52b847cb9d826aeabb97d1d2c55ed24a10

data/.gitignore

@@ -12,3 +12,4 @@ rdoc
 spec/reports
 tmp
 .coveralls.yml
+spec/examples.txt

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.9
+  - 2.1.10
   - 2.2.5
   - 2.3.1
 addons:

data/Gemfile

@@ -1,6 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-gem 'rake'
-gem 'rspec'
-gem 'codeclimate-test-reporter', require: false

data/a9n.gemspec

@@ -1,9 +1,8 @@
-# encoding: utf-8
 require File.expand_path('../lib/a9n/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Krzysztof Knapik"]
-  gem.email         = ["k@knapik.cc"]
+  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"
@@ -16,4 +15,8 @@ Gem::Specification.new do |gem|
   gem.version       = A9n::VERSION
 
   gem.required_ruby_version = ">= 2.0"
+
+  gem.add_development_dependency 'rake', '~> 11.3'
+  gem.add_development_dependency 'rspec', '~> 3.5'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
 end

data/lib/a9n.rb

@@ -1,25 +1,21 @@
+require "ostruct"
+require "yaml"
+require "erb"
 require "a9n/version"
+require "a9n/exceptions"
 require "a9n/struct"
 require "a9n/scope"
 require "a9n/ext/hash"
 require "a9n/loader"
-require "yaml"
-require "erb"
 
 module A9n
   extend SingleForwardable
 
-  class ConfigurationNotLoadedError < StandardError; end
-  class MissingConfigurationDataError < StandardError; end
-  class MissingConfigurationVariablesError < StandardError; end
-  class NoSuchConfigurationVariableError < StandardError; end
-  class MissingEnvVariableError < StandardError; end
-
   EXTENSION_LIST = "{yml,yml.erb,yml.example,yml.erb.example}"
 
   class << self
     def env
-      @env ||= app_env || get_env_var("RAILS_ENV") || get_env_var("RACK_ENV") || get_env_var("APP_ENV")
+      @env ||= app_env || env_var("RAILS_ENV") || env_var("RACK_ENV") || env_var("APP_ENV")
     end
 
     def app_env
@@ -27,7 +23,7 @@ module A9n
     end
 
     def app
-      @app ||= get_rails
+      @app ||= rails_app
     end
 
     def app=(app_instance)
@@ -46,24 +42,24 @@ module A9n
       @root = path.to_s.empty? ? nil : Pathname.new(path.to_s)
     end
 
-    def get_rails
+    def rails_app
       defined?(Rails) ? Rails : nil
     end
 
-    def get_env_var(name, strict = false)
-      raise MissingEnvVariableError.new(name) if strict && !ENV.key?(name)
+    def env_var(name, strict: false)
+      fail A9n::MissingEnvVariableError.new(name) if strict && !ENV.key?(name)
       ENV[name]
     end
 
     def default_files
-      files  = Dir[root.join("config/#{A9n::Scope::MAIN_NAME}.#{EXTENSION_LIST}").to_s]
+      files  = Dir[root.join("config/#{A9n::Scope::ROOT_NAME}.#{EXTENSION_LIST}").to_s]
       files += Dir[root.join("config/a9n/*.#{EXTENSION_LIST}")]
       files.map{ |f| f.sub(/.example$/,'') }.uniq
     end
 
     def load(*files)
       require_local_extension
-      files = files.empty? ? default_files : get_absolute_paths_for(files)
+      files = files.empty? ? default_files : absolute_paths_for(files)
       files.map { |file| load_file(file) }
     end
 
@@ -85,26 +81,33 @@ module A9n
     end
 
     def setup_scope(scope, data)
-      if scope.main?
+      if scope.root?
         storage.merge(data)
-        def_delegator :storage, :fetch
-        def_delegators :storage, *data.keys
+        safe_def_delegator :storage, :fetch
+        safe_def_delegator :storage, *data.keys
       else
         storage[scope.name] = data
-        def_delegator :storage, scope.name
+        safe_def_delegator :storage, scope.name
       end
       return data
     end
 
-    def get_absolute_paths_for(files)
+    def absolute_paths_for(files)
       files.map { |file| Pathname.new(file).absolute? ? file : self.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 unless File.exists?(local_extension_file)
+      return unless File.exist?(local_extension_file)
       require local_extension_file
     end
+
+    def safe_def_delegator(target, *names)
+      names.each do |name|
+        next if respond_to?(name)
+        def_delegator :storage, name
+      end
+    end
   end
 end

data/lib/a9n/exceptions.rb

@@ -0,0 +1,7 @@
+module A9n
+  class ConfigurationNotLoadedError < StandardError; end
+  class MissingConfigurationDataError < StandardError; end
+  class MissingConfigurationVariablesError < StandardError; end
+  class NoSuchConfigurationVariableError < StandardError; end
+  class MissingEnvVariableError < StandardError; end
+end

data/lib/a9n/ext/hash.rb

@@ -19,7 +19,7 @@ module A9n
         if value.is_a?(::Hash)
           deep_prepare(value, scope)
         elsif value.is_a?(Symbol) && value == :env
-          A9n.get_env_var(scope.env_key_name(key), true)
+          A9n.env_var(scope.env_key_name(key), strict: true)
         else
           value
         end

data/lib/a9n/loader.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 module A9n
   class Loader
     attr_reader :scope, :env, :local_file, :example_file
@@ -22,7 +20,7 @@ module A9n
       example_config  = self.class.load_yml(example_file, scope, env)
 
       if local_config.nil? && example_config.nil?
-        raise A9n::MissingConfigurationDataError.new("Configuration data for *#{env}* env was not found in neither *#{example_file}* nor *#{local_file}*")
+        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?
@@ -34,7 +32,7 @@ module A9n
 
     class << self
       def load_yml(file_path, scope, env)
-        return nil unless File.exists?(file_path)
+        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)
@@ -57,7 +55,7 @@ module A9n
     def verify!(local, example)
       missing_keys = example.keys - local.keys
       if missing_keys.any?
-        raise A9n::MissingConfigurationVariablesError.new("Following variables are missing in #{local_file} file: #{missing_keys.join(",")}")
+        fail A9n::MissingConfigurationVariablesError.new("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
-    MAIN_NAME = :configuration
+    ROOT_NAME = :configuration
 
     attr_reader :name
 
@@ -8,12 +8,12 @@ module A9n
       @name = name.to_sym
     end
 
-    def main?
-      name == MAIN_NAME
+    def root?
+      name == ROOT_NAME
     end
 
     def env_key_name(key)
-      (main? ? key : "#{name}_#{key}").upcase
+      (root? ? key : "#{name}_#{key}").upcase
     end
 
     def self.form_file_path(path)

data/lib/a9n/struct.rb

@@ -20,7 +20,7 @@ module A9n
       if data.key?(name)
         fetch(name)
       else
-        raise NoSuchConfigurationVariableError.new(name)
+        fail NoSuchConfigurationVariableError.new(name)
       end
     end
 

data/lib/a9n/version.rb

@@ -1,3 +1,3 @@
 module A9n
-  VERSION = "0.4.10"
+  VERSION = "0.4.12"
 end

data/spec/spec_helper.rb

@@ -9,18 +9,85 @@ require "bundler/setup"
 require "a9n"
 
 RSpec.configure do |config|
-  config.disable_monkey_patching!
-
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
-  config.order = "random"
-  config.tty = true
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = 'doc'
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end
 
 def clean_singleton(klass)
@@ -30,3 +97,4 @@ def clean_singleton(klass)
     end
   end
 end
+

data/spec/unit/a9n_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe A9n do
     context "app_env is set" do
       before do
         expect(subject).to receive(:app).and_return(double(env: "dwarf_env")).exactly(3).times
-        expect(subject).to receive(:get_env_var).never
+        expect(subject).to receive(:env_var).never
       end
 
       it do
@@ -22,9 +22,9 @@ RSpec.describe A9n do
     context "when APP_ENV is set" do
       before do
         expect(subject).to receive(:app_env).and_return(nil)
-        expect(subject).to receive(:get_env_var).with("RAILS_ENV").and_return(nil)
-        expect(subject).to receive(:get_env_var).with("RACK_ENV").and_return(nil)
-        expect(subject).to receive(:get_env_var).with("APP_ENV").and_return("dwarf_env")
+        expect(subject).to receive(:env_var).with("RAILS_ENV").and_return(nil)
+        expect(subject).to receive(:env_var).with("RACK_ENV").and_return(nil)
+        expect(subject).to receive(:env_var).with("APP_ENV").and_return("dwarf_env")
       end
 
       it do
@@ -36,7 +36,7 @@ RSpec.describe A9n do
   describe ".app" do
     context "when rails not found" do
       before do
-        expect(subject).to receive(:get_rails).and_return(nil)
+        expect(subject).to receive(:rails_app).and_return(nil)
       end
 
       it do
@@ -48,7 +48,7 @@ RSpec.describe A9n do
       let(:app) { double(env: "test", root: "/apps/a9n") }
 
       before do
-        expect(subject).to receive(:get_rails).and_return(app)
+        expect(subject).to receive(:rails_app).and_return(app)
       end
 
       it do
@@ -121,7 +121,7 @@ RSpec.describe A9n do
     end
   end
 
-  describe ".get_rails" do
+  describe ".rails_app" do
     context "when defined" do
       before do
         Object.const_set(:Rails, Module.new)
@@ -132,28 +132,28 @@ RSpec.describe A9n do
       end
 
       it do
-        expect(subject.get_rails).to be_kind_of(Module)
+        expect(subject.rails_app).to be_kind_of(Module)
       end
     end
 
     context "when not defined" do
       it do
-        expect(subject.get_rails).to be_nil
+        expect(subject.rails_app).to be_nil
       end
     end
   end
 
-  describe ".get_env_var" do
+  describe ".env_var" do
     before do
       ENV["DWARF"] = "little dwarf"
     end
 
     it do
-      expect(subject.get_env_var("DWARF")).to eq("little dwarf")
+      expect(subject.env_var("DWARF")).to eq("little dwarf")
     end
 
     it do
-      expect(subject.get_env_var("IS_DWARF")).to be_nil
+      expect(subject.env_var("IS_DWARF")).to be_nil
     end
   end
 
@@ -189,7 +189,7 @@ RSpec.describe A9n do
 
       before do
         expect(subject).to receive(:default_files).and_return(files.keys)
-        expect(subject).to receive(:get_absolute_paths_for).never
+        expect(subject).to receive(:absolute_paths_for).never
       end
 
       it do
@@ -211,7 +211,7 @@ RSpec.describe A9n do
 
       before do
         expect(subject).to receive(:default_files).never
-        expect(subject).to receive(:get_absolute_paths_for).with(given_files).and_call_original
+        expect(subject).to receive(:absolute_paths_for).with(given_files).and_call_original
       end
 
       it do

data/spec/unit/scope_spec.rb

@@ -9,12 +9,12 @@ RSpec.describe A9n::Scope do
   describe "#main?" do
     context "when name is configuration" do
       let(:name) { "configuration" }
-      it { expect(subject).to be_main }
+      it { expect(subject).to be_root }
     end
 
     context "when name is other than configuration" do
       let(:name) { "mandrill" }
-      it { expect(subject).not_to be_main }
+      it { expect(subject).not_to be_root }
     end
   end
 

metadata

@@ -1,18 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: a9n
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.4.12
 platform: ruby
 authors:
 - Krzysztof Knapik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
-dependencies: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: a9n - ruby/rails apps configuration manager
 email:
-- k@knapik.cc
+- knapo@knapo.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -31,6 +73,7 @@ files:
 - lib/a9n/capistrano.rb
 - lib/a9n/capistrano/tasks.cap
 - lib/a9n/capistrano/ver2x.rb
+- lib/a9n/exceptions.rb
 - lib/a9n/ext/hash.rb
 - lib/a9n/loader.rb
 - lib/a9n/scope.rb