has_configuration 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95d950812e279b6c249386d5daa7f8bf1ea8b610
+  data.tar.gz: 73a4c8ae615450b07d3d04f1ce19489b272f0870
+SHA512:
+  metadata.gz: 77e674cf3d7418efde319a083aa03ba30b3f729d0e984979caad995f0e0807b45a2136427173f3d01f8921e19c3dc1848d565106230d4b68d0c4ea652c2b505c
+  data.tar.gz: 502ffce5cf4bd8d5b2a5c7d72b87565a7201b441e2db704057ad8bee97d0938b41f0c8b6eb9a5638a77bd98b56dc801b0a1a553acea098542a0ac39383dc586b

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Martin Spickermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/has_configuration/configuration.rb

@@ -0,0 +1,90 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'ostruct'
+
+module HasConfiguration #:nodoc:all
+  class Configuration
+
+    def initialize(klass, options = {})
+      @class_name = klass.name
+      @options    = options
+
+      load_file
+      init_hash
+    end
+
+    def to_h(type = nil)
+      case type
+      when :symbolized  then  deep_symbolized_hash
+      when :stringify   then  deep_stringified_hash
+      else                    @hash
+      end
+    end
+
+  private
+
+    def method_missing(sym, *args, &block)
+      configuration.send(sym, *args, &block)
+    end
+
+    def load_file
+      @raw = YAML.load(ERB.new(raw_file(filename)).result)
+    end
+
+    def init_hash
+      @hash = (@raw || {}).with_indifferent_access
+      @hash = @hash[environment]        if environment
+    end
+
+    def raw_file(filename)
+      File.read(filename)
+    end
+
+    def configuration
+      @configuration ||= deep_structify(@hash)
+    end
+
+    def filename
+      if @options[:file]
+        @options[:file]
+      elsif @class_name
+        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"
+      end
+    end
+
+    def environment
+      case
+      when @options.keys.include?(:env)   then @options[:env]
+      when defined?(Rails)                then Rails.env.to_s
+      end
+    end
+
+    def deep_structify(hash)
+      result = {}
+      hash.each do |key, value|
+        result[key] = value.is_a?(Hash) ? deep_structify(value) : value
+      end if hash
+      OpenStruct.new(result)
+    end
+
+    def deep_symbolized_hash
+      @deep_symbolized_hash ||= deep_transform_keys(@hash) { |key| key.to_sym rescue key }
+    end
+
+    def deep_stringified_hash
+      @deep_stringified_hash ||= deep_transform_keys(@hash) { |key| key.to_s }
+    end
+
+    # from Rails 4.0 (/active_support/core_ext/hash/keys.rb)
+    def deep_transform_keys(hash, &block)
+      result = {}
+      hash.each do |key, value|
+        result[yield(key)] = value.is_a?(Hash) ? deep_transform_keys(value, &block) : value
+      end if hash
+      result
+    end
+
+  end
+end

data/lib/has_configuration.rb

@@ -0,0 +1,99 @@
+require 'has_configuration/configuration'
+
+module HasConfiguration #:nodoc:
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    # Load configuration settings from a yaml file and adds a class and an instance
+    # method +configuration+ to the object.
+    #
+    # ==== options
+    #
+    # [+file+]  The yml file to load:
+    #           Defaults to <tt>config/classname.yml</tt> if Rails is defined,
+    #           <tt>classname.yml</tt> otherwise.
+    # [+env+]   The environment to load from the file.
+    #           Defaults to +Rails.env+ if Rails is defined, no default if not.
+    #
+    # ==== Integration Examples
+    #
+    #   has_configuration
+    #   # => loads setting without environment processing from the file #{self.class.name.downcase}.yml
+    #
+    #   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
+    #
+    # The yaml file may contain defaults. Nesting is not limited. ERB in the yaml
+    # file is evaluated.
+    #
+    #   defaults: &defaults
+    #     user: root
+    #     some:
+    #       nested: value
+    #
+    #   development:
+    #     <<: *defaults
+    #     password: secret
+    #
+    #   production:
+    #     <<: *defaults
+    #     password: <%= ENV[:secret] &>
+    #
+    # ==== Configuration Retrieval
+    #
+    # If the example above was loaded into a class +Foo+ in +production+ environment:
+    #
+    #   Foo.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"
+    #                                             #      :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"
+    #                                             #      :some => { :nested => "value" } }
+    #   Foo.configuration.to_h(:stringify)        # => { 'user' => "root", 'password' => "prod-secret"
+    #                                             #      'some' => { 'nested' => "value" } }
+    #
+    def has_configuration(options = {})
+      @configuration = Configuration.new(self, options)
+      include Getter
+    end
+
+    module Getter #:nodoc:all
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def configuration
+          @configuration
+        end
+      end
+
+      def configuration
+        self.class.configuration
+      end
+
+    end
+
+  end
+
+end
+
+class Object #:nodoc:
+  include HasConfiguration
+end

data/lib/version.rb

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

data/spec/fixtures/class.yml

@@ -0,0 +1,5 @@
+development:
+  env: development
+
+production:
+  env: production

data/spec/fixtures/with_defaults.yml

@@ -0,0 +1,6 @@
+defaults: &defaults
+  default: default
+
+development:
+  <<: *defaults
+  development: development

data/spec/fixtures/with_erb.yml

@@ -0,0 +1,2 @@
+development:
+  erb: <%= Rails.env %>

data/spec/fixtures/with_nested_attributes.yml

@@ -0,0 +1,5 @@
+development:
+  development: development
+  nested:
+    foo: bar
+    baz: true

data/spec/has_configuration/configuration_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe HasConfiguration::Configuration do
+
+  let(:klass) { Class }
+
+  describe ".new" do
+
+    before { mock_file('spec/fixtures/class.yml') }
+
+    context "when no filename provided" do
+
+      let(:file) { "/RAILS_ROOT/config/class.yml" }
+
+      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" }
+
+      it "loads provided file" do
+        expect_any_instance_of(Configuration).to receive(:raw_file).with(file)
+        HasConfiguration::Configuration.new(klass, :file => file)
+      end
+
+    end
+
+  end
+
+  context "when initialized" do
+
+    context "environment" do
+
+      before { mock_file('spec/fixtures/class.yml') }
+
+      context "without env option" do
+
+        subject { HasConfiguration::Configuration.new(klass) }
+        its(:to_h) { should eq('env' => 'development') }
+
+      end
+
+      context "with env option" do
+
+        let(:environment) { 'production' }
+        subject { HasConfiguration::Configuration.new(klass, :env => environment) }
+        its(:to_h) { should eq('env' => environment) }
+
+      end
+
+    end
+
+    context "yaml defaults" do
+
+      before { mock_file('spec/fixtures/with_defaults.yml') }
+
+      subject { HasConfiguration::Configuration.new(klass) }
+      its(:to_h) { should eq('default' => 'default', 'development' => 'development') }
+
+    end
+
+    context "with erb" do
+
+      before { mock_file('spec/fixtures/with_erb.yml') }
+
+      subject { HasConfiguration::Configuration.new(klass) }
+      its(:to_h) { should eq('erb' => Rails.env) }
+
+    end
+
+  end
+
+  describe "#to_h" do
+
+    before { mock_file('spec/fixtures/with_nested_attributes.yml') }
+
+    context "#to_h" do
+      subject { HasConfiguration::Configuration.new(klass).to_h }
+      it { should be_a(HashWithIndifferentAccess) }
+    end
+
+    context "#to_h(:stringify)" do
+      subject { HasConfiguration::Configuration.new(klass).to_h(:stringify) }
+      it { should eq('development' => 'development', 'nested' => { 'foo' => 'bar', 'baz' => true }) }
+    end
+
+    context "#to_h(:symbolized)" do
+      subject { HasConfiguration::Configuration.new(klass).to_h(:symbolized) }
+      it { should eq(:development => 'development', :nested => { :foo => 'bar', :baz => true }) }
+    end
+
+  end
+
+  describe "struct methods" do
+
+    before { mock_file('spec/fixtures/with_nested_attributes.yml') }
+
+    let(:configuration) { HasConfiguration::Configuration.new(klass) }
+
+    it "is structified" do
+      expect(configuration.to_h[:development]   ).to eql('development')
+      expect(configuration.development          ).to eql('development')
+
+      expect(configuration.to_h[:nested]['foo'] ).to eql('bar')
+      expect(configuration.nested.foo           ).to eql('bar')
+    end
+
+  end
+
+end

data/spec/has_configuration_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe HasConfiguration do
+
+  context "when declared" do
+
+    before(:all) do
+      Dummy = Class.new do
+        has_configuration :file => 'spec/fixtures/class.yml'
+      end
+    end
+
+    context "the class" do
+      subject { Dummy }
+      it { should respond_to(:configuration) }
+      its(:configuration) { should be }
+    end
+
+    context "an instance" do
+      subject { Dummy.new }
+      it { should respond_to(:configuration) }
+      its(:configuration) { should be }
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+require 'has_configuration'
+require 'has_configuration/configuration'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def mock_file(filename)
+  Configuration.any_instance.stub(:raw_file).and_return(File.read(filename))
+end
+
+# Mocks Rails Environment
+Rails = Class.new do
+
+  def self.root
+    Pathname.new("/RAILS_ROOT")
+  end
+
+  def self.env
+    'development'
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: has_configuration
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Martin Spickermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Loads configuration setting from a yml file and adds a configuation method
+  to class and instances
+email:
+- spickermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/has_configuration/configuration.rb
+- lib/has_configuration.rb
+- lib/version.rb
+- spec/fixtures/class.yml
+- spec/fixtures/with_defaults.yml
+- spec/fixtures/with_erb.yml
+- spec/fixtures/with_nested_attributes.yml
+- spec/has_configuration/configuration_spec.rb
+- spec/has_configuration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spickermann/has_configuration
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- - lib
+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: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Simple configuration handling
+test_files: []
+has_rdoc: