abyss 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in abyss.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'autotest'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jesse Trimble
+
+MIT License
+
+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,46 @@
+# Abyss
+
+Ruby DSL for defining arbitrarily-deep configuration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'abyss'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abyss
+
+## Usage
+
+    Abyss.configure do
+
+      # An arbitrarily-named configuration group
+      #
+      rush do
+
+        # Define arbitrary properties
+        #
+        year_founded '1968'
+        members ["Geddy", "Alex", "Neil"]
+
+      end
+
+    end
+
+    # Accessing...
+    Abyss.configuration.rush.year_founded #=> "1968"
+    Abyss.configuration.rush.members #=> ["Geddy", "Alex", "Neil"]
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/abyss.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/abyss/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jesse Trimble"]
+  gem.email         = ["jesseltrimble@gmail.com"]
+  gem.description   = %q{Manage arbitrarily-deep configurations through a friendly DSL.}
+  gem.summary       = %q{Manage arbitrarily-deep configurations through a friendly DSL.}
+  gem.homepage      = ""
+
+  gem.add_dependency "activesupport", '~> 3.2.0'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "abyss"
+  gem.require_paths = ["lib"]
+  gem.version       = Abyss::VERSION
+end

data/lib/abyss.rb

@@ -0,0 +1,20 @@
+require "abyss/version"
+require "abyss/errors"
+require "abyss/deep_store"
+require "abyss/store"
+
+module Abyss
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Public interface to Abyss Configuragion API
+  # See Store for examples.
+  #
+  def self.configure(&block)
+    self.configuration ||= Store.new
+    self.configuration.instance_eval &block
+  end
+
+end

data/lib/abyss/deep_store.rb

@@ -0,0 +1,82 @@
+require 'active_support/ordered_hash'
+
+module Abyss
+
+  # = DeepStore
+  # === Abstract Class
+  #
+  # An object meant for configuration that allows arbitrary configuration
+  # properties and arbitrarily deep configuration groups.
+  #
+  # Meant to be subclassed. The power of this class lies in the 'assign'
+  # method.
+  #
+  # Examples:
+  #
+  #     class MyConfig < DeepStore
+  #
+  #       def assign(property_name, values)
+  #         # values is an array of the arguments picked up by #method_missing
+  #         self.configurations[property_name] = manipulate(values)
+  #       end
+  #
+  #       private
+  #
+  #       def manipulate(values)
+  #         # something important...
+  #         values
+  #       end
+  #
+  #     end
+  #
+  #     my_config = MyConfig.new
+  #     my_config.my_config_group do # arbitrary configuration group
+  #       my_configuration_property "Hardy har!", "Grumblegrumblegrumble..." # configuration item, also arbitrary
+  #     end
+  #
+  #     my_config.my_config_group.my_configuration_property #=> [ "Hardy har!", "Grumblegrumblegrumble..." ]
+  #
+  class DeepStore
+
+    attr_accessor :configurations
+
+    def initialize #:nodoc:
+      @configurations = ActiveSupport::OrderedHash.new {}
+    end
+
+    # If a block is passed, add a configuration group named `method_name`
+    # (which is just a new instance of DeepStore) and evaluate the block
+    # against the new instance.
+    #
+    # If one or more arguments are supplied, calls `#assign(method_name, args)
+    #
+    # If no arguments are supplied, return the entity stored by `method_name`.
+    # Could be a DeepStore instance or some arbitrary configuration.
+    #
+    def method_missing(method_name, *args, &block)
+      raise ArgumentError.new("Can't supply both a method argument and a block.") if block_given? && args.size > 0
+
+      if block_given?
+        @configurations[method_name] ||= self.class.new
+        @configurations[method_name].instance_eval &block
+      end
+
+      return get(method_name) if args.length == 0
+
+      assign(method_name, args)
+    end
+
+    # Abstract method. Override this in a subclass to do processing on the
+    # config name / value to be stored.
+    #
+    def assign(name, values)
+      raise Errors::AbstractMethod.new("#assign")
+    end
+
+    def get(method_name) #:nodoc:
+      @configurations[method_name]
+    end
+
+  end
+
+end

data/lib/abyss/errors.rb

@@ -0,0 +1,19 @@
+module Abyss
+
+  module Errors
+
+    class AbstractMethod < RuntimeError
+      attr_accessor :name
+
+      def initialize(name)
+        self.name = name
+      end
+
+      def message
+        "Abstract method: must override #{name} in a base class."
+      end
+    end
+
+  end
+
+end

data/lib/abyss/store.rb

@@ -0,0 +1,34 @@
+module Abyss
+
+  # = Store
+  #
+  # Utility for Abyss configuration.
+  # Intended for use within a host app's initializer, eg:
+  # /config/initializers/foundation.rb
+  #
+  # Examples:
+  #
+  #     Abyss.configure do
+  #       title 'Abyss Demo'
+  #
+  #       backend do
+  #         support do
+  #           email 'info@factorylabs.com'
+  #           phone '303-555-1234'
+  #         end
+  #       end
+  #
+  #     end
+  #
+  class Store < DeepStore
+
+    # Overrides DeepStore#assign. Simply assigns the configuration name to the
+    # first value.
+    #
+    def assign(name, values)
+      self.configurations[name] = values.first
+    end
+
+  end
+
+end

data/lib/abyss/version.rb

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

data/spec/abyss/deep_store_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+module Abyss
+
+  describe ".configure" do
+
+    before { Abyss.configuration = nil }
+
+    it 'is shorthand for the Abyss Config API' do
+      expected_block = Proc.new { }
+      fake_config = mock()
+      Store.stub(:new).and_return(fake_config)
+      fake_config.should_receive(:instance_eval).with(&expected_block)
+
+      Abyss.configure &expected_block
+    end
+
+  end
+
+  describe DeepStore do
+
+    context "when dealing directly with an instance of DeepStore" do
+
+      subject { DeepStore.new }
+
+      describe "#initialize" do
+
+        it 'sets its #configurations to an empty OrderedHash' do
+          subject.configurations.should == ActiveSupport::OrderedHash.new
+        end
+
+      end
+
+      describe "#get" do
+
+        it "returns what is stored in its #configurations" do
+          subject.configurations = { thing: 'foo' }
+          subject.get(:thing).should == 'foo'
+        end
+
+      end
+
+      describe "#assign" do
+
+        it 'raises an error about subclassing' do
+          expect {
+            subject.some_nonexistent_method "foo"
+          }.to raise_error /must override #assign in a base class/i
+        end
+
+      end
+
+      describe "#method_missing behavior" do
+
+        context "when given a block and no args" do
+
+          let(:config_mock) { mock }
+          let(:empty_proc)  { proc {} }
+
+          before do
+            # force evaluation since we stub :new
+            subject
+          end
+
+          it "creates a new named configuration group" do
+            subject.some_undefined_method &empty_proc
+            subject.some_undefined_method.should be_instance_of subject.class
+          end
+
+          it "evaluates the block against a new configuration instance" do
+            DeepStore.stub(:new).and_return(config_mock)
+            config_mock.should_receive(:instance_eval).with &empty_proc
+            subject.some_undefined_method &empty_proc
+          end
+
+        end
+
+        context "with no arguments and no block" do
+
+          it "returns a configuration stored by the method name" do
+            subject.should_receive(:get).with(:some_undefined_method)
+            subject.some_undefined_method
+          end
+
+        end
+
+        context "with an argument" do
+
+          it "calls #assign on itself, passing the method name and args list" do
+            subject.should_receive(:assign).with(:some_undefined_method, ['foo'])
+            subject.some_undefined_method 'foo'
+          end
+
+        end
+
+        describe "invalid scenarios" do
+
+          context "with an argument and a block" do
+
+            it "raises an InvalidArguemnt error" do
+              expect {
+                subject.some_undefined_method("foo") {}
+              }.to raise_error ArgumentError, /can't supply both a method argument and a block/i
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/abyss/store_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Abyss
+
+  describe ".configure" do
+
+    before { Abyss.configuration = nil }
+
+    it 'is shorthand for the Abyss Store API' do
+      expected_block = Proc.new { }
+      fake_config = mock()
+      Store.stub(:new).and_return(fake_config)
+      fake_config.should_receive(:instance_eval).with(&expected_block)
+
+      Abyss.configure &expected_block
+    end
+
+  end
+
+  describe Store do
+
+    subject { Store.new }
+
+    it "is a subclass of DeepStore" do
+      subject.should be_a DeepStore
+    end
+
+    describe "#assign" do
+
+      it "assigns the method name to the first passed value in #configurations" do
+        subject.assign("thing", ["foo"])
+        subject.configurations["thing"].should == "foo"
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'abyss'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: abyss
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Trimble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70310377219460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310377219460
+description: Manage arbitrarily-deep configurations through a friendly DSL.
+email:
+- jesseltrimble@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- abyss.gemspec
+- lib/abyss.rb
+- lib/abyss/deep_store.rb
+- lib/abyss/errors.rb
+- lib/abyss/store.rb
+- lib/abyss/version.rb
+- spec/abyss/deep_store_spec.rb
+- spec/abyss/store_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.10
+signing_key: 
+specification_version: 3
+summary: Manage arbitrarily-deep configurations through a friendly DSL.
+test_files:
+- spec/abyss/deep_store_spec.rb
+- spec/abyss/store_spec.rb
+- spec/spec_helper.rb