backhead 0.1.0

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/Changelog.md

@@ -0,0 +1,4 @@
+## 2012-12-13 v0.1.0
+
+* specify engine configuration options
+* set configuration options via environment variables

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in backhead.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Charles Lowell
+
+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,36 @@
+# Backhead
+
+The "backhead" was where the the gauges and controls sat on the old steam engines. This
+gem removes the tedium of defining rails engine configuration options
+
+![An Engine Backhead](http://upload.wikimedia.org/wikipedia/commons/thumb/c/c5/4017_Backhead_20040426.jpg/640px-4017_Backhead_20040426.jpg)
+
+## Usage
+
+Include backhead into class. You can now define configuration options
+for your engine.
+
+    class MyEngine < Rails::Engine
+      include Backhead
+
+      configuration :my_engine do
+        option :fast
+        option :efficient
+      end
+
+      # standard engine stuff
+      initializer 'my_engine.setup' do |app|
+        MyEngine.enable_nitrus_mode() if app.config.my_engine.fast
+        MyEngine.decrease_fuel_consumption() if app.config.my_engine.efficient
+      end
+    end
+
+This will create two new configuration options that users can set in their environment files:
+`config.my_engine.fast` and `config.my_engine.efficient`.
+
+As a bonus, it will also allow users to set these configuration parameters via the environment
+variables `MY_ENGINE_FAST` and `MY_ENGINE_EFFICIENT` if they so choose. This gives more baked in
+flexibility to control the app and runtime rather than via source control.
+
+Configuration options that are explicitly set during initialization will take precedence over
+those specified by environment variables

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)

data/backhead.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backhead/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "backhead"
+  gem.version       = Backhead::VERSION
+  gem.authors       = ["Charles Lowell"]
+  gem.email         = ["cowboyd@thefrontside.net"]
+  gem.description   = %q{removes the tedium of defining rails engine configuration options}
+  gem.summary       = %q{specify which configuration options your engine supports. Optionally set them with environment variables}
+  gem.homepage      = "https://github.com/cowboyd/backhead"
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency 'rails', '>= 3'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-spies'
+end

data/lib/backhead.rb

@@ -0,0 +1,31 @@
+require "backhead/version"
+require 'active_support/concern'
+require 'rails/engine'
+
+module Backhead
+  extend ActiveSupport::Concern
+
+  included do
+    fail TypeError, "Backhead can only be included into subclasses of Rails::Railtie" unless self < Rails::Railtie
+  end
+
+  module ClassMethods
+    def configuration(name, &block)
+      options = @_current_configuration_options = Set.new
+      yield if block_given?
+      struct = Struct.new(*options.to_a).new
+      config.send("#{name}=", struct)
+      initializer "#{name}.setup" do |app|
+        options.each do |option|
+          if struct.send(option).nil?
+            struct.send("#{option}=", ENV["#{name}_#{option}".upcase])
+          end
+        end
+      end
+    end
+
+    def option(name)
+      @_current_configuration_options << name.to_sym
+    end
+  end
+end

data/lib/backhead/version.rb

@@ -0,0 +1,3 @@
+module Backhead
+  VERSION = "0.1.0"
+end

data/spec/backhead_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Backhead do
+  it 'cannot be included into a non-railtie' do
+    expect {Class.new.send(:include, Backhead)}.to raise_error(TypeError)
+  end
+  describe 'included into a rails engine and configured' do
+    before do
+      @engine = Class.new(Rails::Engine)
+      @initializers = []
+      @engine.stub(:initializer) {|name, options, &body| @initializers << body}
+      @engine.class_eval do
+        include Backhead
+        configuration :foo do
+          option :bar
+          option :baz_bang
+        end
+      end
+      @app = mock('Rails App', :config => @engine.config)
+      @initialize = proc do
+        @initializers.each do |i|
+          i.call(@app)
+        end
+      end
+    end
+
+    describe "setting a configuration parameter" do
+      before do
+        @engine.config.foo.bar = 'bif'
+      end
+      it "actually sets it." do
+        @engine.config.foo.bar.should eql 'bif'
+      end
+    end
+
+    describe "when an environment variable is set" do
+      before do
+        ENV['FOO_BAZ_BANG'] = 'booyeah'
+      end
+      after do
+        ENV.delete 'FOO_BAZ_BANG'
+      end
+
+      describe 'when initialized' do
+        before do
+          @initialize.call
+        end
+        it 'sets the configuration parameter from the environment' do
+          @engine.config.foo.baz_bang.should eql 'booyeah'
+        end
+      end
+
+      describe 'but when initialized when option is set explicitly from ruby code' do
+        before do
+          @engine.config.foo.baz_bang = 'blort'
+          @initialize.call
+        end
+        it 'uses the value set from ruby code' do
+          @engine.config.foo.baz_bang.should eql 'blort'
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec-spies'
+require 'backhead'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: backhead
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Charles Lowell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-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: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-spies
+  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: removes the tedium of defining rails engine configuration options
+email:
+- cowboyd@thefrontside.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Changelog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backhead.gemspec
+- lib/backhead.rb
+- lib/backhead/version.rb
+- spec/backhead_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cowboyd/backhead
+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: specify which configuration options your engine supports. Optionally set
+  them with environment variables
+test_files:
+- spec/backhead_spec.rb
+- spec/spec_helper.rb