easy_configs 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjkwNWNiMGNkZGZiOTFhMTU1NmRlMjQ0MWRhZDk0ZGViYzY0YWZlNg==
+  data.tar.gz: !binary |-
+    MjViNmY1MzBmMWM4ZDRiOWQ5MzQ4MmI2MDRhMjZkNDMwMjMwM2EwMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTk3ZDllZWY2YmY2NzcyMzAxN2I1ZWU2Mjk5MzBjYjIyNmRhNDVmMGJjYzdi
+    NjNhMGNkODUxNTg4Nzc3NDE3M2QxMGM4NDg3YjRlOWJmOGUwMjAzMjcyOTcx
+    NTYxZjkzMzYwODZiYmQyOTU1ZDZiNjUwNGIxMmRkODE3MWI4Yjk=
+  data.tar.gz: !binary |-
+    NGVlMzE2OGY5M2Y0OTQ2Y2MyY2QzYTU5OTlkNDRmZmVkMjc0YmE3Yzk1MDg5
+    YjdjZjQzZjlmOTZkNTM0YTgwYzgxNWM1MGFkZjIxMGZlMWIyNDQ1M2IzNDZl
+    ZjhmNzJkOTEyMDlmNjYyMWFiYjEzNjhjZGY2NGM5YTI4NTRjODM=

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    easy_configs (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  easy_configs!
+  rake

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Andrea Pavoni - http://andreapavoni.com
+
+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/README.md

@@ -0,0 +1,82 @@
+# EasyConfig
+
+A simple gem to store custom app settings the easiest way. It can be used in any
+Ruby *or* Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```gem 'easy_configs'```
+
+then execute:
+
+```$ bundle install```
+
+or install it yourself as:
+
+```$ gem install easy_configs```
+
+## Usage
+
+EasyConfig loads a YAML file (with eventual ERB tags, so you can use ```ENV``` variables).
+For example, given a YAML file with a bunch of keys:
+
+```
+foo:
+  bar: 1
+  env: <%= ENV['USER'] %>
+  baz:
+    nested: 2
+```
+
+Here's how to use it:
+
+```
+# Load yaml file
+MyConfig = EasyConfig.load_yaml 'path_to_yaml.yml'
+
+# Retrieve keys
+MyConfig.bar # => 1
+MyConfig.env # => YOUR_USERNAME
+
+# Retuns a nested object (EasyConfig::DeepStruct is a modified version of Ruby's OpenStruct)
+MyConfig.baz # => <#EasyConfig::DeepStruct>
+
+# Access a nested key
+MyConfig.baz.nested # => 2
+
+# Returns an Hash
+MyConfig.to_h # => {foo: {bar: 1, env: ..., baz: {nested: 2} }}
+
+```
+
+## Rails support
+
+EasyConfig has built-in support for Rails. It provides a generator to create an initializer and a sample config:
+
+* run the generator
+
+  ```rails generate easy_config:install```
+* edit the sample configuration in ```config/easy_config.yml```
+
+You might want to modify ```config/initializers/easy_config.rb``` to choose another name for the object that should store the settings.
+(default name is ```EConfig```), or add additional logic. No problem, this is just a *decent default* for the lazy.
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Testing
+
+* clone this repo
+* run `bundle install`
+* run `rake spec`
+
+
+## License
+Copyright (c) 2013 Andrea Pavoni http://andreapavoni.com

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = Dir["spec/**/*_spec.rb"]
+  t.verbose = false
+end
+
+task :default => :spec

data/easy_config.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "easy_config/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "easy_configs"
+  s.description     = "Store Ruby or Rails app settings in the easiest way."
+  s.summary = "Store custom Ruby or Rails app settings in the easiest way."
+  s.version     = EasyConfig::VERSION
+
+  s.authors     = ["Andrea Pavoni"]
+  s.email       = ["andrea.pavoni@gmail.com"]
+  s.homepage    = "http://github.com/apeacox/easy_config"
+
+  s.require_paths = ["lib"]
+  s.files = `git ls-files`.split($\)
+  s.test_files = Dir["spec/**/*"]
+
+end

data/lib/easy_config.rb

@@ -0,0 +1,15 @@
+require 'yaml'
+require 'erb'
+require 'easy_config/deep_struct'
+require 'easy_config/version'
+
+module EasyConfig
+
+  def self.load_yaml(path, key = nil)
+    result = YAML.load(ERB.new(File.read(path)).result)
+    result = result[key.to_s] unless key.nil?
+
+    DeepStruct.new result
+  end
+
+end

data/lib/easy_config/deep_struct.rb

@@ -0,0 +1,26 @@
+require 'ostruct'
+
+module EasyConfig
+
+  class DeepStruct < OpenStruct
+    def initialize(hash=nil)
+      @table = {}
+      @hash_table = {}
+
+      if hash
+        hash.each do |k,v|
+          @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+          @hash_table[k.to_sym] = v
+
+          new_ostruct_member(k)
+        end
+      end
+    end
+
+    def to_h
+      @hash_table
+    end
+
+  end
+
+end

data/lib/easy_config/version.rb

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

data/lib/generators/easy_config/install/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/base'
+
+module EasyConfig
+  class InstallGenerator < ::Rails::Generators::Base #:nodoc:
+
+    desc 'Generates EasyConfig files.'
+
+    def self.source_root
+      @_easy_config_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+
+    def self.banner
+      "rails generate easy_config:install"
+    end
+
+    def copy_files
+      template 'easy_config.rb', 'config/initializers/easy_config.rb'
+      template 'easy_config.yml', 'config/easy_config.yml'
+    end
+
+  end
+
+end

data/lib/generators/easy_config/install/templates/easy_config.rb

@@ -0,0 +1,5 @@
+require 'easy_config'
+
+path = File.join(Rails.root, "/config/easy_config.yml")
+
+EConfig = EasyConfig.load_yaml path, Rails.env

data/lib/generators/easy_config/install/templates/easy_config.yml

@@ -0,0 +1,16 @@
+# Set your configs here.
+
+development:
+  foo: 'example_dev'
+    bar:
+      baz: 1
+
+test:
+  foo: 'example_test'
+    bar:
+      baz: 1
+
+production:
+  foo: 'example_prod'
+    bar:
+      baz: 1

data/spec/easy_config_spec.rb

@@ -0,0 +1,42 @@
+require_relative 'helper'
+
+describe EasyConfig do
+
+  describe ".load" do
+
+    describe "it loads a basic YAML" do
+      let(:path) { File.expand_path './spec/fixtures/basic.yml' }
+      let(:obj) { EasyConfig.load_yaml path }
+
+      it "returns a EasyConfig::DeepStruct object" do
+        obj.must_be_instance_of EasyConfig::DeepStruct
+      end
+    end
+
+    describe "it loads a namespace inside YAML" do
+      let(:path) { File.expand_path './spec/fixtures/namespaced.yml' }
+
+      it "loads only the given namespace" do
+        obj1 = EasyConfig.load_yaml path, 'namespace1'
+        obj2 = EasyConfig.load_yaml path, 'namespace2'
+
+        obj1.test.foo.must_equal 1
+        obj2.test.foo.must_equal 3
+      end
+
+    end
+
+    describe "it loads ERB tags" do
+      let(:path) { File.expand_path './spec/fixtures/erbiefed.yml' }
+
+      it "loads only the given namespace" do
+        obj = EasyConfig.load_yaml path
+
+        obj.test.foo.must_equal 'this is from ERB'
+      end
+
+    end
+
+  end
+
+end

data/spec/fixtures/basic.yml

@@ -0,0 +1,4 @@
+test:
+  foo: 1
+  bar:
+    baz: 2

data/spec/fixtures/erbiefed.yml

@@ -0,0 +1,4 @@
+test:
+  foo: <%= 'this is from ERB' %>
+  bar:
+    baz: 2

data/spec/fixtures/namespaced.yml

@@ -0,0 +1,11 @@
+namespace1:
+  test:
+    foo: 1
+    bar:
+      baz: 2
+
+namespace2:
+  test:
+    foo: 3
+    bar:
+      baz: 4

data/spec/helper.rb

@@ -0,0 +1,5 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'easy_config'
+require 'minitest/spec'
+require 'minitest/autorun'

data/spec/lib/deep_struct_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../helper'
+
+describe EasyConfig::DeepStruct do
+  let(:hash) { {a: 1, b: {c: 3}} }
+  let(:deep_struct) { EasyConfig::DeepStruct.new hash }
+
+  describe ".new" do
+    it "returns a DeepStruct object" do
+      deep_struct.must_be_instance_of EasyConfig::DeepStruct
+    end
+  end
+
+  it "inherits from OpenStruct" do
+    deep_struct.class.ancestors.must_include OpenStruct
+  end
+
+  it "exposes method names to access keys" do
+    deep_struct.a.must_equal 1
+  end
+
+  it "can wrap another DeepStruct" do
+    deep_struct.b.must_be_instance_of EasyConfig::DeepStruct
+    deep_struct.b.c.must_equal 3
+  end
+
+  describe "#to_h" do
+    it "returns the original Hash" do
+      deep_struct.to_h.must_equal  hash
+    end
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: easy_configs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrea Pavoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies: []
+description: Store Ruby or Rails app settings in the easiest way.
+email:
+- andrea.pavoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- easy_config.gemspec
+- lib/easy_config.rb
+- lib/easy_config/deep_struct.rb
+- lib/easy_config/version.rb
+- lib/generators/easy_config/install/install_generator.rb
+- lib/generators/easy_config/install/templates/easy_config.rb
+- lib/generators/easy_config/install/templates/easy_config.yml
+- spec/easy_config_spec.rb
+- spec/fixtures/basic.yml
+- spec/fixtures/erbiefed.yml
+- spec/fixtures/namespaced.yml
+- spec/helper.rb
+- spec/lib/deep_struct_spec.rb
+homepage: http://github.com/apeacox/easy_config
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Store custom Ruby or Rails app settings in the easiest way.
+test_files:
+- spec/easy_config_spec.rb
+- spec/fixtures/basic.yml
+- spec/fixtures/erbiefed.yml
+- spec/fixtures/namespaced.yml
+- spec/helper.rb
+- spec/lib/deep_struct_spec.rb