has_configuration 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebff0280281752c0b1556b9a3b78ff373ef3d5f9
-  data.tar.gz: af60528f4c04a911de41688962cf09e286e1a1d3
+  metadata.gz: 40f44c4cea757f02eefd7f88c4ebe57191f7fd66
+  data.tar.gz: 8f43c0b7f09647f1b64a81bb087bb137340973ac
 SHA512:
-  metadata.gz: 0da42542ceb0db1259ae25374f8a81742d53983d31e7facebdda9496636bf1273dddf40a1aedb6a84b925719cc46591e69ffd15bb8de939f83295f20a390ce46
-  data.tar.gz: a73480c049c8520064fe58df406255e0f0070e85ef33975f65da5fd36ade95ddad7e4a60ebd0066fc8804d0a560bdca3d79810c0f9091e409aef221ede610902
+  metadata.gz: 702a7f3bb8b1c8f8f369a66a07d1f2ae9979282fd8aa501a8885dfa58a377dd8169bc726e96151a953feb69a37b91d196edcd68adfa7ff09bc23122c9ad192b6
+  data.tar.gz: 7e565b1b17efaa841c5fa15fa9f2377807df8b1b67a1c6ca1dadf94333fcbf73684234d56af5b3fe34fff860dd431c5005b72c9c9e68996ea69a964b1682cc5d

data/lib/has_configuration.rb

@@ -1,13 +1,11 @@
 require 'has_configuration/configuration'
 
 module HasConfiguration #:nodoc:
-
   def self.included(base)
     base.extend(ClassMethods)
   end
 
-  module ClassMethods
-
+  module ClassMethods #:nodoc:
     # Load configuration settings from a yaml file and adds a class and an instance
     # method +configuration+ to the object.
     #
@@ -22,9 +20,10 @@ module HasConfiguration #:nodoc:
     # ==== Integration Examples
     #
     #   has_configuration
-    #   # => loads setting without environment processing from the file #{self.class.name.downcase}.yml
+    #   # => loads setting without environment processing from the
+    #   #    file #{self.class.name.downcase}.yml
     #
-    #   has_configuration :file => Rails.root.join('config', 'example.yml'), :env => 'staging'
+    #   has_configuration file: Rails.root.join('config', 'example.yml'), env: 'staging'
     #   # => loads settings for staging environment from RAILS_ROOT/config/example.yml file
     #
     # ==== YAML File Example
@@ -50,21 +49,24 @@ module HasConfiguration #:nodoc:
     # If the example above was loaded into a class +Foo+ in +production+ environment:
     #
     #   Foo.configuration       # => <HasConfiguration::Configuration:0x00...>
-    #   foo.new.configuration   # => <HasConfiguration::Configuration:0x00...>
+    #   Foo.new.configuration   # => <HasConfiguration::Configuration:0x00...>
     #
     #   # convenient getter methods
     #   Foo.configuration.some.nested             # => "value"
     #
     #   # to_h returns a HashWithIndifferentAccess
-    #   Foo.configuration.to_h                    # => { :user => "root", :password => "prod-secret"
+    #   Foo.configuration.to_h                    # => { :user => "root",
+    #                                             #      :password => "prod-secret",
     #                                             #      :some => { :nested => "value" } }
     #   Foo.configuration.to_h[:some][:nested]    # => "value"
     #   Foo.configuration.to_h[:some]['nested']   # => "value"
     #
     #   # force a special key type (when merging with other hashes)
-    #   Foo.configuration.to_h(:symbolized)       # => { :user => "root", :password => "prod-secret"
+    #   Foo.configuration.to_h(:symbolized)       # => { :user => "root",
+    #                                             #      :password => "prod-secret",
     #                                             #      :some => { :nested => "value" } }
-    #   Foo.configuration.to_h(:stringify)        # => { 'user' => "root", 'password' => "prod-secret"
+    #   Foo.configuration.to_h(:stringify)        # => { 'user' => "root",
+    #                                             #      'password' => "prod-secret",
     #                                             #      'some' => { 'nested' => "value" } }
     #
     def has_configuration(options = {})
@@ -72,26 +74,21 @@ module HasConfiguration #:nodoc:
       include Getter
     end
 
-    module Getter #:nodoc:all
-
+    # Adds getters for the configuration
+    module Getter
       def self.included(base)
         base.extend(ClassMethods)
       end
 
-      module ClassMethods
-        def configuration
-          @configuration
-        end
+      module ClassMethods #:nodoc:
+        attr_reader :configuration
       end
 
       def configuration
         self.class.configuration
       end
-
     end
-
   end
-
 end
 
 class Object #:nodoc:

data/lib/has_configuration/configuration.rb

@@ -2,9 +2,8 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'ostruct'
 require 'yaml'
 
-module HasConfiguration #:nodoc:all
-  class Configuration
-
+module HasConfiguration #:nodoc:
+  class Configuration #:nodoc:
     def initialize(klass, options = {})
       @class_name = klass.name
       @options    = options
@@ -51,7 +50,8 @@ module HasConfiguration #:nodoc:all
         filename = "#{@class_name.downcase}.yml"
         defined?(Rails) ? Rails.root.join('config', filename).to_s : filename
       else
-        raise ArgumentError, "Unable to resolve filename, please add :file parameter to has_configuration"
+        fail ArgumentError,
+             'Unable to resolve filename, please add :file parameter to has_configuration'
       end
     end
 
@@ -71,7 +71,9 @@ module HasConfiguration #:nodoc:all
     end
 
     def deep_symbolized_hash
-      @deep_symbolized_hash ||= deep_transform_keys(@hash) { |key| key.to_sym rescue key }
+      @deep_symbolized_hash ||= deep_transform_keys(@hash) do |key|
+        key.respond_to?(:to_sym) ? key.to_sym : key
+      end
     end
 
     def deep_stringified_hash
@@ -86,6 +88,5 @@ module HasConfiguration #:nodoc:all
       end if hash
       result
     end
-
   end
 end

data/lib/version.rb

@@ -1,8 +1,8 @@
 module HasConfiguration #:nodoc:
   module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 2
-    BUILD = 4
+    MAJOR = 1
+    MINOR = 0
+    BUILD = 0
 
     STRING = [MAJOR, MINOR, BUILD].join('.')
   end

data/spec/lib/has_configuration/configuration_spec.rb

@@ -11,35 +11,35 @@ RSpec.describe HasConfiguration::Configuration do
     ).to receive(:raw_file).and_return(File.read(fixture))
   end
 
-  describe ".new" do
+  describe '.new' do
     let(:fixture) { 'spec/fixtures/class.yml' }
 
-    context "when no filename provided" do
-      let(:file) { "/RAILS_ROOT/config/class.yml" }
+    context 'when no filename provided' do
+      let(:file) { '/RAILS_ROOT/config/class.yml' }
 
-      it "loads default file" do
+      it 'loads default file' do
         expect_any_instance_of(Configuration).to receive(:raw_file).with(file)
         HasConfiguration::Configuration.new(klass)
       end
     end
 
-    context "when filename provided" do
-      let(:file) { "foo/bar.yml" }
+    context 'when filename provided' do
+      let(:file) { 'foo/bar.yml' }
 
-      it "loads provided file" do
+      it 'loads provided file' do
         expect_any_instance_of(Configuration).to receive(:raw_file).with(file)
-        HasConfiguration::Configuration.new(klass, :file => file)
+        HasConfiguration::Configuration.new(klass, file: file)
       end
     end
   end
 
-  context "when initialized" do
+  context 'when initialized' do
     let(:environment) { nil }
 
-    context "environment" do
+    context 'environment' do
       let(:fixture) { 'spec/fixtures/class.yml' }
 
-      context "without env option" do
+      context 'without env option' do
         subject(:hash) { HasConfiguration::Configuration.new(klass).to_h }
 
         it 'return the expected hash' do
@@ -47,19 +47,18 @@ RSpec.describe HasConfiguration::Configuration do
         end
       end
 
-      context "with env option" do
+      context 'with env option' do
         let(:environment) { 'production' }
 
-        subject(:hash) { HasConfiguration::Configuration.new(klass, :env => environment).to_h }
+        subject(:hash) { HasConfiguration::Configuration.new(klass, env: environment).to_h }
 
         it 'return the expected hash' do
           expect(hash).to eq('env' => environment)
         end
       end
-
     end
 
-    context "yaml defaults" do
+    context 'yaml defaults' do
       let(:fixture) { 'spec/fixtures/with_defaults.yml' }
 
       subject(:hash) { HasConfiguration::Configuration.new(klass).to_h }
@@ -69,7 +68,7 @@ RSpec.describe HasConfiguration::Configuration do
       end
     end
 
-    context "with erb" do
+    context 'with erb' do
       let(:fixture) { 'spec/fixtures/with_erb.yml' }
 
       subject(:hash) { HasConfiguration::Configuration.new(klass).to_h }
@@ -78,39 +77,37 @@ RSpec.describe HasConfiguration::Configuration do
         expect(hash).to eq('erb' => Rails.env)
       end
     end
-
   end
 
-  describe "#to_h" do
+  describe '#to_h' do
     let(:fixture) { 'spec/fixtures/with_nested_attributes.yml' }
 
-    context "#to_h" do
+    context '#to_h' do
       subject { HasConfiguration::Configuration.new(klass).to_h }
       it { should be_a(HashWithIndifferentAccess) }
     end
 
-    context "#to_h(:stringify)" do
+    context '#to_h(:stringify)' do
       subject { HasConfiguration::Configuration.new(klass).to_h(:stringify) }
       it { should eq('env' => 'test', 'nested' => { 'foo' => 'bar', 'baz' => true }) }
     end
 
-    context "#to_h(:symbolized)" do
+    context '#to_h(:symbolized)' do
       subject { HasConfiguration::Configuration.new(klass).to_h(:symbolized) }
-      it { should eq(:env => 'test', :nested => { :foo => 'bar', :baz => true }) }
+      it { should eq(env: 'test', nested: { foo: 'bar', baz: true }) }
     end
-
   end
 
-  describe "struct methods" do
+  describe 'struct methods' do
     let(:configuration) { HasConfiguration::Configuration.new(klass) }
     let(:fixture) { 'spec/fixtures/with_nested_attributes.yml' }
 
-    it "is structified" do
-      expect(configuration.to_h[:env]           ).to eql('test')
-      expect(configuration.env                  ).to eql('test')
+    it 'is structified' do
+      expect(configuration.to_h[:env]).to eql('test')
+      expect(configuration.env).to eql('test')
 
-      expect(configuration.to_h[:nested]['foo'] ).to eql('bar')
-      expect(configuration.nested.foo           ).to eql('bar')
+      expect(configuration.to_h[:nested]['foo']).to eql('bar')
+      expect(configuration.nested.foo).to eql('bar')
     end
   end
 end

data/spec/lib/has_configuration_spec.rb

@@ -1,15 +1,13 @@
 RSpec.describe HasConfiguration do
-
-  context "when declared" do
-
+  context 'when declared' do
     before(:all) do
       Dummy = Class.new do
         require 'has_configuration'
-        has_configuration :file => 'spec/fixtures/class.yml'
+        has_configuration file: 'spec/fixtures/class.yml'
       end
     end
 
-    context "the class" do
+    context 'the class' do
       subject(:dummy) { Dummy }
 
       it { should respond_to(:configuration) }
@@ -19,7 +17,7 @@ RSpec.describe HasConfiguration do
       end
     end
 
-    context "an instance" do
+    context 'an instance' do
       subject(:dummy) { Dummy.new }
 
       it { should respond_to(:configuration) }
@@ -28,7 +26,5 @@ RSpec.describe HasConfiguration do
         expect(dummy.configuration).to be
       end
     end
-
   end
-
 end

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
-if RUBY_VERSION >= "1.9"
-  require 'coveralls'
-  Coveralls.wear!
-end
+require 'coveralls'
+Coveralls.wear!
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -56,7 +54,7 @@ RSpec.configure do |config|
     # For more details, see:
     #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
     expectations.syntax = :expect
-   end
+  end
 
   # These two settings work together to allow you to limit a spec run
   # to individual examples or groups you care about by tagging them with

data/spec/support/rails_mock.rb

@@ -1,5 +1,10 @@
 # Mocks Rails Environment
 Rails = Class.new do
-  def self.root; Pathname.new("/RAILS_ROOT"); end
-  def self.env ; 'test'                     ; end
+  def self.root
+    Pathname.new('/RAILS_ROOT')
+  end
+
+  def self.env
+    'test'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_configuration
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Martin Spickermann
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Loads configuration setting from a yml file and adds a configuation method
-  to class and instances
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Loads configuration setting from a yml file and adds a configuation method
+      to class and instances
 email:
 - spickermann@gmail.com
 executables: []