rsyc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 288017edc2b1dfedb6ef4c081f722f25ba3555e5
+  data.tar.gz: 27870a746683d9371f35fa80a840bd81eccd4fc3
+SHA512:
+  metadata.gz: d3d62916b805c874c2363eb7c6afb13aee6918425fb6387821811e688931f834831aa7c554167c785ea0df74754d87b758b048b2db807161a5868fcde0ffc36f
+  data.tar.gz: 6c4241931571015dd9d8bd26001e8fd82b96cfca614ff7b7aa34cd1547afdada57131fa01e49c09458720ccf3d950b096b18308ca6ae4f20442e58e51e09b61d

data/.gitignore

@@ -0,0 +1,2 @@
+doc/
+.yardoc/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    rsyc (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    mime-types (2.2)
+    multi_json (1.9.2)
+    rake (10.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.18.1)
+    tins (1.0.1)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  coveralls
+  rake
+  rspec
+  rsyc!
+  yard

data/README.md

@@ -0,0 +1,60 @@
+# Rsyc [![Build Status](https://travis-ci.org/bsm/rsyc.png?branch=master)](https://travis-ci.org/bsm/rsyc) [![Coverage Status](https://coveralls.io/repos/bsm/rsyc/badge.png?branch=master)](https://coveralls.io/r/bsm/rsyc?branch=master)
+
+Simplest-possible Rails application configuration accessor.
+
+## Usage
+
+Include it in your Gemfile:
+
+```ruby
+gem "rsyc"
+```
+
+Create a config/app.yml with your configuration:
+
+```yaml
+development:
+  redis: "http://localhost:6379"
+  nested:
+    user: me
+    pass: secret
+
+production:
+  redis: "http://remote.service:27841"
+  nested:
+    user: real
+    pass: s3cret
+```
+
+Use in in your Rails app:
+
+```ruby
+Rails.application.config.app.redis       # => "http://localhost:6379"
+Rails.application.config.app[:redis]     # => "http://localhost:6379"
+Rails.application.config.app.nested.pass # => "secret"
+```
+
+## Licence
+
+```
+Copyright (c) 2014 Black Square Media
+
+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/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+YARD::Rake::YardocTask.new
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+namespace :spec do
+  task coveralls: [:spec, 'coveralls:push']
+end
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/rsyc.rb

@@ -0,0 +1,61 @@
+require 'ostruct'
+require 'yaml'
+require 'erb'
+require 'pathname'
+
+module Rsyc
+
+  def self.new(*args)
+    Config.new(*args)
+  end
+
+  class Options < ::Hash
+
+    def initialize(hash)
+      super().update(hash)
+
+      keys.each do |key|
+        value = delete(key)
+        self[key.to_s] = case value when Hash then Options.new(value) else value end
+      end
+    end
+
+    def [](key)
+      super key.to_s
+    end
+
+    def fetch(key)
+      super key.to_s
+    end
+
+    def method_missing(name, *)
+      key?(name.to_s) ? fetch(name) : super
+    end
+
+    def respond_to_missing?(*)
+      key?(name.to_s) || super
+    end
+
+  end
+
+  class Config < Options
+
+    # @param [String] path configuration file path
+    # @param [String] env environment name
+    def initialize(path, env)
+      path = Pathname.new(path.to_s).expand_path
+      raise ArgumentError, "Unable to find a configuration in #{path}" unless path.exist?
+
+      conf = YAML.load(ERB.new(path.read).result)
+      raise ArgumentError, "Invalid configuration in #{path}" unless conf.is_a?(Hash)
+
+      conf = conf[env.to_s]
+      raise ArgumentError, "No configuration for '#{env}' found in #{path}" unless conf.is_a?(Hash)
+
+      super(conf)
+    end
+
+  end
+end
+
+require 'rsyc/railtie.rb' if defined?(Rails)

data/lib/rsyc/railtie.rb

@@ -0,0 +1,10 @@
+require "rails"
+require "rsyc"
+
+module Rsyc
+  class Railtie < Rails::Railtie
+    initializer "rsyc.init" do
+      Rails.application.config.app = Rsyc.new Rails.root.join('config', 'app.yml'), Rails.env
+    end
+  end
+end

data/rsyc.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 1.9.1'
+  s.required_rubygems_version = ">= 1.8.0"
+
+  s.name        = File.basename(__FILE__, '.gemspec')
+  s.summary     = "Rsyc"
+  s.description = "A simple YAML configuration builder and accessor"
+  s.version     = "0.1.0"
+
+  s.authors     = ["Black Square Media"]
+  s.email       = "info@blacksquaremedia.com"
+  s.homepage    = "https://github.com/bsm/rsyc"
+  s.licenses    = ["MIT"]
+
+  s.require_path = 'lib'
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "coveralls"
+end

data/spec/fixtures/app.yml

@@ -0,0 +1,8 @@
+test:
+  simple: "value"
+  nested:
+    scope: "name"
+    url: "http://test.host.com/path?a=1"
+
+other:
+  special: "value"

data/spec/lib/rsyc_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Rsyc::Config do
+
+  subject { described_class.new FIXTURE_PATH.join("app.yml"), "test" }
+
+  it 'should load configuration' do
+    subject.should be_a(Rsyc::Options)
+  end
+
+  it 'should fail when file is missing' do
+    -> {
+      described_class.new FIXTURE_PATH.join("missing.yml"), "test"
+    }.should raise_error(ArgumentError)
+  end
+
+  it 'should fail when config is missing' do
+    -> {
+      described_class.new FIXTURE_PATH.join("blank.yml"), "test"
+    }.should raise_error(ArgumentError)
+  end
+
+  it 'should fail when env is missing' do
+    -> {
+      described_class.new FIXTURE_PATH.join("app.yml"), "missing"
+    }.should raise_error(ArgumentError)
+  end
+
+  it 'should have accessors' do
+    subject.simple.should == "value"
+    subject[:simple].should == "value"
+    subject["simple"].should == "value"
+
+    -> { subject.missing }.should raise_error(NoMethodError)
+    subject[:missing].should be_nil
+    subject["missing"].should be_nil
+
+    subject.nested.should == {"scope"=>"name", "url"=>"http://test.host.com/path?a=1"}
+    subject.nested.url.should == "http://test.host.com/path?a=1"
+    subject.nested[:url].should == "http://test.host.com/path?a=1"
+    subject.nested["url"].should == "http://test.host.com/path?a=1"
+
+    -> { subject.nested.missing }.should raise_error(NoMethodError)
+    subject.nested[:missing].should be_nil
+    subject.nested["missing"].should be_nil
+  end
+
+end
+
+describe Rsyc::Options do
+
+  subject { described_class.new some: "value", nested: { "status" => :ok } }
+
+  it { should be_a(Hash) }
+  it { should == {"some"=>"value", "nested"=>{"status"=>:ok}} }
+
+  its(:some)    { should == "value" }
+  its(["some"]) { should == "value" }
+  its([:some])  { should == "value" }
+  its(:nested)  { should be_instance_of(described_class) }
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'rsyc'
+
+FIXTURE_PATH = Pathname.new File.expand_path("../fixtures", __FILE__)

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rsyc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Black Square Media
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: coveralls
+  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: A simple YAML configuration builder and accessor
+email: info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rsyc.rb
+- lib/rsyc/railtie.rb
+- rsyc.gemspec
+- spec/fixtures/app.yml
+- spec/fixtures/wrong.yml
+- spec/lib/rsyc_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/rsyc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rsyc
+test_files: []
+has_rdoc: