configreader 0.0.2 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f973d9c43db8e4a51ccd599d6f9e2f20681a9d7
+  data.tar.gz: 0e0fa11b219a3a3165eeafdfbd8e9d352a10e835
+SHA512:
+  metadata.gz: 816eb2a0e074436ed1a6524bc873b249bdc23764f75a0c924bb6435883eaf626515040398b27158a0f12954a3191e6e5df01ff1fc06f141b3b3ff68d4c4bb04d
+  data.tar.gz: c5701951d4feec6174884ebba5567fe6dfbde7300db1be5c16263b62c15e5401fa6bf3dc89c7aefac9fe31ba50dff82249408c84b78db061c23b74ef9c7a9929

data/.gemspec

@@ -12,13 +12,15 @@ Gem::Specification.new do |s|
                   providing a more concise API to access your configuration data, by accessing methods instead of Hash keys. It also
                   allows you to configure environment aware configuration objects, and by so inverting the logic of
                   environment specific configuration into the ConfigReader.}
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.require_path  = "lib"
   s.test_files = Dir.glob('spec/lib/*_spec.rb')
 
 
-  s.add_dependency 'rails'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  s.add_dependency 'rails', '> 3.0.0'
+  s.add_dependency 'hashie', '~> 3.0', '> 3.0.0'
+  s.add_development_dependency 'rake', '~> 0.9'
+  s.add_development_dependency 'rspec', '~> 2.11', '>= 2.11.0'
 end

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.0.4
+* Moved to Hashie - enables easy access to all underlying levels of hash
+* Deep Merge - defaults now deep merge in EnvConfigReader (You can now put any default attributes under defaults)
+
+
+ ## 0.0.2
+ * Added support for default environment
+
+
+ ## 0.0.1
+ * Initial Release

data/Gemfile

@@ -1,3 +1,3 @@
 source "http://rubygems.org"
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,79 +1,71 @@
 PATH
   remote: .
   specs:
-    configreader (0.0.2)
-      rails
+    configreader (0.0.4)
+      hashie (~> 3.0, > 3.0.0)
+      rails (> 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
+    actionmailer (4.1.9)
+      actionpack (= 4.1.9)
+      actionview (= 4.1.9)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.9)
+      actionview (= 4.1.9)
+      activesupport (= 4.1.9)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.9)
+      activesupport (= 4.1.9)
+      builder (~> 3.1)
       erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.4)
+    activemodel (4.1.9)
+      activesupport (= 4.1.9)
+      builder (~> 3.1)
+    activerecord (4.1.9)
+      activemodel (= 4.1.9)
+      activesupport (= 4.1.9)
+      arel (~> 5.0.0)
+    activesupport (4.1.9)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    json (1.7.5)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.7)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.2)
+    hashie (3.3.1)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.2)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
-      bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
+    rails (4.1.9)
+      actionmailer (= 4.1.9)
+      actionpack (= 4.1.9)
+      actionview (= 4.1.9)
+      activemodel (= 4.1.9)
+      activerecord (= 4.1.9)
+      activesupport (= 4.1.9)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.9)
+      sprockets-rails (~> 2.0)
+    railties (4.1.9)
+      actionpack (= 4.1.9)
+      activesupport (= 4.1.9)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
+      thor (>= 0.18.1, < 2.0)
     rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -82,21 +74,25 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
-    sprockets (2.1.3)
+    sprockets (2.12.3)
       hike (~> 1.2)
+      multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.12)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.35)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   configreader!
-  rake
-  rspec
+  rake (~> 0.9)
+  rspec (~> 2.11, >= 2.11.0)

data/README.md

@@ -1,4 +1,4 @@
-# ConfigReader 0.0.2  [![Build Status](https://secure.travis-ci.org/TheGiftsProject/configreader.png)](http://travis-ci.org/TheGiftsProject/configreader)
+# ConfigReader 0.0.4  [![Build Status](https://secure.travis-ci.org/TheGiftsProject/configreader.png)](http://travis-ci.org/TheGiftsProject/configreader)
 
  ConfigReader provides an easy way to load up your configuration YAML files into Ruby objects,
  providing a more concise API to access your configuration data, by accessing methods instead of Hash keys. It also
@@ -6,8 +6,6 @@
 
  You can use it to access your FACEBOOK / ANALYTICS configuration YAML's for instance.
 
- Note: Only the first level YAML keys can be accessed as methods.
-
 ## Usage
 
 Note: The examples are for a Rails 3 app.

data/lib/configreader.rb

@@ -1,6 +1,7 @@
 require 'active_support/dependencies'
 require 'configreader/config'
 require 'yaml'
+require 'hashie'
 require 'pathname'
 
 module ConfigReader
@@ -41,5 +42,6 @@ module ConfigReader
 end
 
 require 'configreader/engine'
+require 'configreader/mixins/file_loading'
 require 'configreader/flat_configreader'
 require 'configreader/env_configreader'

data/lib/configreader/env_configreader.rb

@@ -2,14 +2,23 @@ require File.expand_path('../flat_configreader', __FILE__)
 
 module ConfigReader
 
-  class EnvConfigReader < FlatConfigReader
+  class EnvConfigReader < Hashie::Mash
+
+    DEFAULT_KEY = 'defaults'
+
+    include ConfigReader::FileLoading
+    include Hashie::Extensions::DeepMerge
 
     class EnvironmentNotFoundInYaml < StandardError ; end
 
-    def initialize(file_name)
-      super(file_name)
-      @data = @data[Rails.env] || @data['defaults']
-      raise EnvironmentNotFoundInYaml.new if @data.nil?
+    def initialize(config)
+      config_data = load_config(config)
+      env_data = config_data[Rails.env] || {}
+      default_data = config_data[DEFAULT_KEY] || {}
+
+      super(default_data)
+      self.deep_merge!(env_data)
+      raise EnvironmentNotFoundInYaml.new(Rails.env) if self.empty?
     end
 
   end

data/lib/configreader/flat_configreader.rb

@@ -1,37 +1,11 @@
 module ConfigReader
 
-  class FlatConfigReader
+  class FlatConfigReader < Hashie::Mash
 
-    def initialize(config)
-      @data = config.is_a?(String) ? read_file(config) : config
-
-      remove_id_method
-    end
-
-    def method_missing(name)
-      @data[name.to_s]
-    end
-
-    #def local_constant_names
-    #  nil
-    #end
-
-    protected
+    include ConfigReader::FileLoading
 
-    def relative_path
-      "#{Rails.root}/config"
-    end
-
-    def full_path(file_name)
-      File.join(relative_path, file_name)
-    end
-
-    def read_file(file_name)
-      YAML.load_file(full_path(file_name))
-    end
-
-    def remove_id_method
-      instance_eval "undef id" if methods.any? { |method| method == "id" }
+    def initialize(config)
+      super(load_config(config))
     end
 
   end

data/lib/configreader/mixins/file_loading.rb

@@ -0,0 +1,23 @@
+module ConfigReader
+  module FileLoading
+
+    def load_config(config)
+      config.is_a?(String) ? read_file(config) : config
+    end
+
+    private
+
+    def config_path
+      File.join(Rails.root, "config")
+    end
+
+    def full_path(file_name)
+      File.join(config_path, file_name)
+    end
+
+    def read_file(file_name)
+      YAML.load_file(full_path(file_name))
+    end
+
+  end
+end

data/lib/configreader/version.rb

@@ -1,3 +1,3 @@
 module ConfigReader
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/spec/config/fake_env.yml

@@ -10,6 +10,6 @@ test:
   certid:   certid
 
 production:
-  id:     wrong
-  devid:  wrong
+  id:     productionID
+  devid:  productionDevId
   only_production: 3

data/spec/lib/env_configreader_spec.rb

@@ -1,37 +1,35 @@
 require 'spec_helper'
-require File.expand_path('../../../lib/configreader/env_configreader', __FILE__)
 
 describe ConfigReader::EnvConfigReader do
 
   before do
-    ConfigReader::EnvConfigReader.any_instance.stub(:relative_path => "#{ConfigReader::Engine.root}/spec/config")
+    ConfigReader::EnvConfigReader.any_instance.stub(:config_path => "#{ConfigReader::Engine.root}/spec/config")
   end
 
   subject { ConfigReader::EnvConfigReader.new("fake_env.yml") }
 
   it "should let you access data under the right env" do
-    subject.devid.should == "devid"
-    subject.appid.should == "appid"
+    subject.devid.should eq "devid"
+    subject.appid.should eq "appid"
   end
 
-  it "should not let you access data under other enviroments" do
+  it "should not let you access data under other environments" do
     subject.only_production.should be_nil
-    subject.devid.should_not == "wrong"
+    subject.devid.should_not eq "productionDevId"
   end
 
   it "should enable you to read the id attribute" do
-    subject.id.should == "testID"
+    subject.id.should eq "testID"
   end
 
   context 'when an environment does not exist in the configuration' do
 
     it 'should fallback to default settings if defaults exist' do
       Rails.stub(:env) { 'unknown' }
-      config = ConfigReader::EnvConfigReader.new 'fake_env.yml'
 
-      config.id.should == 'defaultID'
-      config.appid.should == 'defaultAppID'
-      config.certid.should == 'defaultCertID'
+      subject.id.should eq 'defaultID'
+      subject.appid.should eq 'defaultAppID'
+      subject.certid.should eq 'defaultCertID'
     end
 
     it 'should raise an EnvironmentNotFoundInYaml when loading if defaults do not exist' do
@@ -42,4 +40,12 @@ describe ConfigReader::EnvConfigReader do
 
   end
 
+  context 'when an environment only exists partially' do
+    before { Rails.stub(:env) { 'production' } }
+    it 'should deep merge the defaults' do
+      subject.devid.should eq 'productionDevId'
+      subject.certid.should eq 'defaultCertID'
+    end
+  end
+
 end

data/spec/lib/flat_configreader_spec.rb

@@ -3,19 +3,28 @@ require 'spec_helper'
 describe ConfigReader::FlatConfigReader do
 
   before do
-    ConfigReader::FlatConfigReader.any_instance.stub(:relative_path => "#{ConfigReader::Engine.root}/spec/config")
+    ConfigReader::FlatConfigReader.any_instance.stub(:config_path => "#{ConfigReader::Engine.root}/spec/config")
   end
 
   subject { ConfigReader::FlatConfigReader.new("fake_simple.yml") }
+  let(:string_value) {"my name"}
 
   it "should enable you to read attributes from the yml" do
     subject.boolean_value.should be_true
     subject.integer_value.should == 3
-    subject.string_value.should == "my name"
+    subject.string_value.should == string_value
     subject.quoted_string_value.should == "qtd my name"
     subject.complex_value.should == {'a' => 1, 'b' => 2}
   end
 
+  it 'should act like a string hash' do
+    subject['string_value'].should eq string_value
+  end
+
+  it 'should act like a symbol hash' do
+    subject[:string_value].should eq string_value
+  end
+
   it "should enable you to read the id attribute" do
     subject.id.should == "file"
   end
@@ -30,5 +39,17 @@ describe ConfigReader::FlatConfigReader do
     }.to raise_error(Errno::ENOENT)
   end
 
+  describe :to_h do
+    let(:expected_hash) { YAML.load_file("spec/config/fake_simple.yml") }
+
+    it "should return a hash" do
+      subject.to_h.should be_a Hash
+    end
+
+    it "should return the correct data" do
+      subject.to_h.should eq expected_hash
+    end
+
+  end
 
 end

metadata

@@ -1,82 +1,99 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: configreader
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Itay Adler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 description: |-
   ConfigReader provides an easy way to load up your configuration YAML files into Ruby objects,
                     providing a more concise API to access your configuration data, by accessing methods instead of Hash keys. It also
                     allows you to configure environment aware configuration objects, and by so inverting the logic of
                     environment specific configuration into the ConfigReader.
-email: 
+email:
 - itayadler@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gemspec
 - .gitignore
 - .rspec
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -86,6 +103,7 @@ files:
 - lib/configreader/engine.rb
 - lib/configreader/env_configreader.rb
 - lib/configreader/flat_configreader.rb
+- lib/configreader/mixins/file_loading.rb
 - lib/configreader/version.rb
 - spec/config/auto_create/env/fake_env.yml
 - spec/config/auto_create/fake_simple.yml
@@ -98,39 +116,30 @@ files:
 - spec/lib/flat_configreader_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/TheGiftsProject/configreader
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.4.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ConfigReader - An easy way to manage your configuration files
-test_files: 
-- spec/lib/flat_configreader_spec.rb
-- spec/lib/env_configreader_spec.rb
+test_files:
 - spec/lib/config_spec.rb
+- spec/lib/env_configreader_spec.rb
+- spec/lib/flat_configreader_spec.rb