configreader 0.0.1

data/.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/configreader/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "configreader"
+  s.version     = ConfigReader::VERSION
+  s.authors     = ["Itay Adler"]
+  s.email       = ["itayadler@gmail.com"]
+  s.homepage    = "https://github.com/TheGiftsProject/configreader"
+  s.summary     = %q{ConfigReader - An easy way to manage your configuration files}
+  s.description = %q{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.}
+
+  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'
+end

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--order random

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@config_reader

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    configreader (0.0.1)
+      rails
+
+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)
+      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)
+    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)
+      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)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 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)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  configreader!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,86 @@
+# ConfigReader 0.0.1  [![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
+ allows you to configure environment aware configuration objects, keeping your code DRY.
+
+ Note: Only the first level YAML keys can be accessed as methods.
+
+## Usage
+
+Note: The examples are for a Rails 3 app.
+
+* Add our gem to your Gemfile:
+
+`gem 'configreader'`
+
+* The most simple way to use ConfigReader is to change your existing config initializer files to use it
+like so:
+
+Let's say you have a YAML config like  `config/initializers/example.rb`
+```yaml
+ development:
+    some_config: 123
+ production:
+    some_config: 456
+ test:
+    some_config: 678
+ staging:
+    some_config: 154
+```
+
+In your config initializer, initialize an EnvConfigReader like so:
+```ruby
+   EXAMPLE = ConfigReader::EnvConfigReader.new("example.yml")
+```
+
+Then you could access EXAMPLE config from anywhere in your Rails app:
+```ruby
+   EXAMPLE.some_config
+```
+
+Since we are using an EnvConfigReader object, the some_config we asked for is loaded up from the current RAILS_ENVIRONMENT.
+By default, ConfigReader will assume your config folder is your Rails.root/config, and will build the full path using it.
+
+There's also a FlatConfigReader, which is the more basic version. it's useful for flat config files like so:
+```yaml
+   key1: 1
+   key2: 2
+```
+
+```ruby
+   FLAT = ConfigReader::FlatConfigReader.new("flat.yml")
+   FLAT.key1
+```
+
+## Automatically creating configuration objects
+
+A more advanced feature ConfigReader offers, is automatically loading all your configuration files during the initialization
+of your Rails app.
+
+It's turned off by default, so to turn it on, we'll need to create an initializer for ConfigReader:
+
+`config/initializers/configreader.rb`
+```ruby
+   ConfigReader.initialize do
+      config.auto_create_config_objects = true
+   end
+```
+
+You're almost done, you'll need to move your YAML configuration files to the default configreader directory:
+`#{Rails.root}/config/configreader`
+
+The YAML files in the root configreader folder will be created with a FlatConfigReader, and the ones in the
+`#{Rails.root}/config/configreader/env` will be created with an EnvConfigReader.
+The configuration objects will be set as consts on Object, so you'll be able to access them from anywhere
+in your Rails app, just like we already did in the initializers.
+
+`auto_create_class` - You can also override the default auto_create behavior to set the consts instead on Object, to something else
+like ConfigReader, so then you'll be able to access them using that object: `ConfigReader::EXAMPLE`
+
+`auto_create_config_folder` - The default value to the config_folder is `#{Rails.root}/config/configreader`. Use this config
+item to override it another path.
+
+## Requirements
+
+Ruby 1.8.7+, Rails 3.0+.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/configreader/config.rb

@@ -0,0 +1,16 @@
+module ConfigReader
+  class Config
+
+    attr_accessor :auto_create_config_folder, :auto_create_config_objects, :auto_create_class
+
+    def self.default
+      new.instance_eval {
+        @auto_create_config_folder = "#{ConfigReader.app_root}/config/configreader"
+        @auto_create_config_objects = false
+        @auto_create_class = Object
+
+        self
+      }
+    end
+  end
+end

data/lib/configreader/engine.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module ConfigReader
+
+  class Engine < Rails::Engine
+
+    initializer "engine.auto_create_configreader", :before => :load_config_initializers do |app|
+      ConfigReader.app_root = app.root
+    end
+  end
+end

data/lib/configreader/env_configreader.rb

@@ -0,0 +1,17 @@
+require_relative './flat_configreader'
+
+module ConfigReader
+
+  class EnvConfigReader < FlatConfigReader
+
+    class EnvironmentNotFoundInYaml < StandardError ; end
+
+    def initialize(file_name)
+      super(file_name)
+      @data = @data[Rails.env]
+      raise EnvironmentNotFoundInYaml.new if @data.nil?
+    end
+
+  end
+end
+

data/lib/configreader/flat_configreader.rb

@@ -0,0 +1,38 @@
+module ConfigReader
+
+  class FlatConfigReader
+
+    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
+
+    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" }
+    end
+
+  end
+end

data/lib/configreader/version.rb

@@ -0,0 +1,3 @@
+module ConfigReader
+  VERSION = "0.0.1"
+end

data/lib/configreader.rb

@@ -0,0 +1,45 @@
+require 'active_support/dependencies'
+require 'configreader/config'
+require 'yaml'
+require 'pathname'
+
+module ConfigReader
+
+  mattr_accessor :app_root
+  mattr_accessor :initialized
+
+  def self.initialize(&block)
+    return if ConfigReader.initialized
+    ConfigReader.module_eval &block
+    build_config_files
+    ConfigReader.initialized = true
+  end
+
+  def self.config
+    @config ||= ConfigReader::Config.default
+  end
+
+  def self.build_config_files
+    return unless config.auto_create_config_objects
+
+    build_files(config.auto_create_config_folder, FlatConfigReader)
+    build_files("#{config.auto_create_config_folder}/env", EnvConfigReader)
+  end
+
+  def self.build_files(folder, klass)
+    Dir["#{folder}/*.yml"].each do |file|
+      path = Pathname.new(file)
+      next if path.directory? or !path.exist?
+
+      config.auto_create_class.class_eval do
+        const_set(path.basename('.*').to_s.upcase, klass.new(YAML.load_file(file)))
+      end
+    end
+
+  end
+
+end
+
+require 'configreader/engine'
+require 'configreader/flat_configreader'
+require 'configreader/env_configreader'

data/spec/config/auto_create/env/fake_env.yml

@@ -0,0 +1,10 @@
+test:
+  id:       testID
+  devid:    devid
+  appid:    appid
+  certid:   certid
+
+production:
+  id:     wrong
+  devid:  wrong
+  only_production: 3

data/spec/config/auto_create/fake_simple.yml

@@ -0,0 +1,8 @@
+boolean_value: true
+integer_value: 3
+string_value: my name
+quoted_string_value: "qtd my name"
+complex_value:
+  a: 1
+  b: 2
+id: "file"

data/spec/config/fake_env.yml

@@ -0,0 +1,10 @@
+test:
+  id:       testID
+  devid:    devid
+  appid:    appid
+  certid:   certid
+
+production:
+  id:     wrong
+  devid:  wrong
+  only_production: 3

data/spec/config/fake_invalid.yml

@@ -0,0 +1,5 @@
+invalid_environment:
+  some_key: some_key
+
+production:
+  id: blah

data/spec/config/fake_simple.yml

@@ -0,0 +1,8 @@
+boolean_value: true
+integer_value: 3
+string_value: my name
+quoted_string_value: "qtd my name"
+complex_value:
+  a: 1
+  b: 2
+id: "file"

data/spec/config/fake_site.yml

@@ -0,0 +1,15 @@
+test:
+  ebay:
+    id: 1234
+    host: ebay_test
+  stubhub:
+    id: 3456
+    host: stubhub_test
+
+development:
+  ebay:
+    id: 1235
+    host: ebay_development
+  stubhub:
+    id: 3457
+    host: stubhub_development

data/spec/lib/config_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe ConfigReader::Config do
+
+  after :each do
+    Object.send(:remove_const, :FAKE_SIMPLE) if Object.const_defined? :FAKE_SIMPLE
+    Object.send(:remove_const, :FAKE_ENV) if Object.const_defined? :FAKE_ENV
+    ConfigReader.initialized = false
+  end
+
+  describe :initialize do
+    it "should update config attributes" do
+        ConfigReader.initialize do
+          config.auto_create_config_objects = true
+          config.auto_create_class = ConfigReader
+          config.auto_create_config_folder = "moshe"
+        end
+        ConfigReader.config.auto_create_config_objects.should == true
+        ConfigReader.config.auto_create_class.should == ConfigReader
+        ConfigReader.config.auto_create_config_folder.should == "moshe"
+    end
+
+    it "should not be able to run initialize more than once" do
+      ConfigReader.initialize do
+        config.auto_create_config_objects = true
+      end
+      ConfigReader.config.auto_create_config_objects.should == true
+      ConfigReader.initialize do
+        config.auto_create_config_objects = false
+      end
+      ConfigReader.config.auto_create_config_objects.should == true
+    end
+  end
+
+  describe :build_config_files do
+    before :all do
+      ConfigReader.config.auto_create_config_folder = "#{ConfigReader::Engine.root}/spec/config/auto_create"
+      ConfigReader.config.auto_create_class = Object
+    end
+
+    it "should auto-build flat config file" do
+      ConfigReader.config.auto_create_config_objects = true
+      ConfigReader.build_config_files
+      FAKE_SIMPLE.class.should == ConfigReader::FlatConfigReader
+    end
+
+    it "should auto-build env config file" do
+      ConfigReader.config.auto_create_config_objects = true
+      ConfigReader.build_config_files
+      FAKE_ENV.class.should == ConfigReader::EnvConfigReader
+    end
+
+    it "should not auto-build when auto_create_config_objects is false" do
+      ConfigReader.config.auto_create_config_objects = false
+      ConfigReader.build_config_files
+      expect { FAKE_SIMPLE }.to raise_error(NameError)
+    end
+
+  end
+end

data/spec/lib/env_configreader_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require_relative '../../lib/configreader/env_configreader'
+
+describe ConfigReader::EnvConfigReader do
+
+  before do
+    ConfigReader::EnvConfigReader.any_instance.stub(:relative_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"
+  end
+
+  it "should not let you access data under other enviroments" do
+    subject.only_production.should be_nil
+    subject.devid.should_not == "wrong"
+  end
+
+  it "should enable you to read the id attribute" do
+    subject.id.should == "testID"
+  end
+
+  context "configuration file with out test env" do
+    it "should raise an EnvironmentNotFoundInYaml when loading" do
+      expect {
+        ConfigReader::EnvConfigReader.new("fake_invalid.yml")
+      }.to raise_error(ConfigReader::EnvConfigReader::EnvironmentNotFoundInYaml)
+    end
+  end
+
+
+
+end

data/spec/lib/flat_configreader_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe ConfigReader::FlatConfigReader do
+
+  before do
+    ConfigReader::FlatConfigReader.any_instance.stub(:relative_path => "#{ConfigReader::Engine.root}/spec/config")
+  end
+
+  subject { ConfigReader::FlatConfigReader.new("fake_simple.yml") }
+
+  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.quoted_string_value.should == "qtd my name"
+    subject.complex_value.should == {'a' => 1, 'b' => 2}
+  end
+
+  it "should enable you to read the id attribute" do
+    subject.id.should == "file"
+  end
+
+  it "should return nil for attributes that don't exist" do
+    subject.blah_attribute.should be_nil
+  end
+
+  it "should raise File not found for wrong name of yml" do
+    expect {
+      ConfigReader::FlatConfigReader.new("non_existing.yml")
+    }.to raise_error(Errno::ENOENT)
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'configreader'
+
+#Monkey patching rails env to be test
+Rails.env = "test"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: configreader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Itay Adler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "ConfigReader provides an easy way to load up your configuration YAML
+  files into Ruby objects,\n                  providing a more concise API to access
+  your configuration data, by accessing methods instead of Hash keys. It also\n                  allows
+  you to configure environment aware configuration objects, and by so inverting the
+  logic of\n                  environment specific configuration into the ConfigReader."
+email:
+- itayadler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemspec
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/configreader.rb
+- lib/configreader/config.rb
+- lib/configreader/engine.rb
+- lib/configreader/env_configreader.rb
+- lib/configreader/flat_configreader.rb
+- lib/configreader/version.rb
+- spec/config/auto_create/env/fake_env.yml
+- spec/config/auto_create/fake_simple.yml
+- spec/config/fake_env.yml
+- spec/config/fake_invalid.yml
+- spec/config/fake_simple.yml
+- spec/config/fake_site.yml
+- spec/lib/config_spec.rb
+- spec/lib/env_configreader_spec.rb
+- spec/lib/flat_configreader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/TheGiftsProject/configreader
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ConfigReader - An easy way to manage your configuration files
+test_files:
+- spec/lib/config_spec.rb
+- spec/lib/env_configreader_spec.rb
+- spec/lib/flat_configreader_spec.rb