configurator2 0.1.2

data/.rspec

@@ -0,0 +1,3 @@
+--backtrace
+--colour
+

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+  
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -0,0 +1,100 @@
+# Configurator
+## Add simple configuration to any Ruby class
+
+### Installation
+1. Add `gem 'configurator2'` to your Gemfile
+2. Run `bundle`
+3. Profit
+
+### Usage
+
+#### Mix into any Ruby class and add options
+```ruby
+class Application
+  extend Configurator
+  option :api_url, "https://www.myapp.com/api/v1"
+  options :format, :mode, :whatevs
+end
+```
+
+This will add `Application.config.api_url`, which will be overridable but default
+to `https://www.myapp.com/api/v1`. It also adds a number of options without
+defaults, namely `format`, `mode`, and `whatevs`.
+
+Every call to `option` or `options` adds getters and setters for these options,
+but you can also use the alternate syntax by ommitting the equals sign when setting
+an option.
+
+#### Configure your class
+Configurator supports three different interfaces and two setter methods:
+
+##### Block configuration with implicit configuration object
+```ruby
+Application.config do
+  api_url "https://www.some.other.app/api/v2"
+  format :json
+end
+```
+
+##### Block configuration with passed configuration object
+```ruby
+Application.config do |config|
+  config.api_url = "https://www.some.other.app/api/v2"
+  config.format = :json
+end
+```
+
+##### Direct configuration
+```ruby
+Application.config.api_url = "https://www.some.other.app/api/v2"
+Application.config.format = :json
+```
+
+OR omit the equals operators:
+
+```ruby
+Application.config.mode :production
+```
+
+#### Sub-configurations
+Adding a sub-configuration is simple, too, like so:
+
+```ruby
+class Application
+  extend Configurator
+  option :smtp_server do
+    options :host, :port, :password, :username
+  end
+end
+```
+
+Now, you can refer to an Application's smtp_server configuration like so:
+
+```ruby
+Application.config.smtp_server.host
+Application.config.smtp_server.port
+# etc
+```
+
+You can also configure a group of configuration options as a hash:
+
+```ruby
+Application.config.smtp_server = {
+  host: "smtp.host.com",
+  port: "3306",
+  username: "user",
+  password: "pass"
+}
+```
+
+#### Observe your users' configuration choices later
+
+Just refer to a class or module's configuration setting later, pretty simply:
+
+```ruby
+if Application.config.smtp_server.host
+  Mailer.send_email_with_options(Application.config.smtp_server)
+end
+```
+
+Or whatever.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "configurator2"
+    gemspec.summary = "A mixin to add a .config method and options with defaults to any library"
+    gemspec.description = %{}
+    gemspec.email = "flip@getplinq.com"
+    gemspec.homepage = "http://github.com/Plinq/configurator"
+    gemspec.authors = ["Flip Sasser"]
+  end
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/configurator2.gemspec

@@ -0,0 +1,45 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "configurator2"
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Flip Sasser"]
+  s.date = "2013-01-02"
+  s.description = ""
+  s.email = "flip@getplinq.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    "Guardfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "configurator2.gemspec",
+    "lib/configurator.rb",
+    "lib/configurator/configuration.rb",
+    "lib/configurator/option.rb",
+    "spec/lib/configurator_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/Plinq/configurator"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A mixin to add a .config method and options with defaults to any library"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/configurator/configuration.rb

@@ -0,0 +1,59 @@
+require 'configurator/option'
+
+module Configurator
+  class Configuration < Hash
+    include Option
+
+    def add_option(name, default, &block)
+      defaults[name.to_sym] = default || block
+    end
+
+    def config
+      self
+    end
+
+    def defaults
+      @defaults ||= {}
+    end
+
+    def initialize(options = {})
+      options.each do |key, value|
+        set(key, value)
+      end
+    end
+
+    def get(name)
+      name = name.to_sym
+      value = self.key?(name) ? self[name] : defaults[name]
+      if value.respond_to? :call
+        value = value.call
+      end
+      value
+    end
+
+    def set(name, value, &block)
+      name = name.to_sym
+      if block_given?
+        self[name] = block
+      elsif value.is_a?(Hash)
+        self[name] = defaults[name] || self.class.new
+        value.each do |key, value_two|
+          self[name].send("#{key}=", value_two)
+        end
+      else
+        self[name] = value
+      end
+    end
+
+    private
+    def method_missing(method, *args, &block)
+      method_name = method.to_s
+      setter = method_name.chomp!('=') || !args.empty? || block_given?
+      if setter
+        set(method_name, args.first, &block)
+      else
+        get(method)
+      end
+    end
+  end
+end

data/lib/configurator/option.rb

@@ -0,0 +1,16 @@
+module Configurator
+  module Option
+    def option(name, default = nil, &block)
+      config.add_option(name, block_given? ? Configuration.new : default)
+      if block_given?
+        config.get(name).instance_exec(config.get(name), &block)
+      end
+    end
+    private :option
+
+    def options(*names)
+      names.each {|name| option(name) }
+    end
+    private :options
+  end
+end

data/lib/configurator.rb

@@ -0,0 +1,18 @@
+require 'configurator/option'
+
+module Configurator
+  autoload :Configuration, 'configurator/configuration'
+  include Option
+
+  def self.extended(base)
+    base.class_eval { remove_instance_variable(:@configuration) if defined? @configuration }
+  end
+
+  def config(&block)
+    @configuration ||= Configuration.new
+    if block_given?
+      @configuration.instance_exec(@configuration, &block)
+    end
+    @configuration
+  end
+end

data/spec/lib/configurator_spec.rb

@@ -0,0 +1,141 @@
+require 'configurator'
+
+describe Configurator do
+  it "extends objects without exploding" do
+    lambda {
+      class FooBar
+        extend Configurator
+      end
+    }.should_not raise_error
+  end
+
+  describe "mixed into a class" do
+    before do
+      class TestClass
+        extend Configurator
+      end
+    end
+
+    it "defines a `config` method" do
+      TestClass.should respond_to(:config)
+    end
+
+    describe "adds a `config` method that" do
+      it "accepts a block" do
+        lambda {
+          TestClass.config { inspect }
+        }.should_not raise_error
+      end
+
+      it "executes the block in the context of the configured class' new configuration instance" do
+        TestClass.config.should_receive(:puts).and_return(nil)
+        TestClass.config { puts "ohai" }
+      end
+    end
+
+    describe "adds an `option` method that" do
+      it "allows developers to declare class-level options" do
+        TestClass.send(:option, :do_something)
+        TestClass.config.defaults.key?(:do_something).should be_true
+      end
+
+      it "allows developers to declare defaults on options" do
+        TestClass.send(:option, :do_something, true)
+        TestClass.config.defaults[:do_something].should be_true
+      end
+
+      it "defines getter methods on the config class method" do
+        TestClass.send(:option, :do_something)
+        TestClass.config.do_something.should be_nil
+      end
+
+      it "defines setter methods on the class" do
+        TestClass.send(:option, :do_something)
+        lambda { TestClass.config.do_something = "ohai" }.should_not raise_error
+      end
+
+      describe "that adds a class-level accessor that" do
+        it "returns default values when a developer has not overriden it" do
+          TestClass.send(:option, :do_something, "now!")
+          TestClass.config.do_something.should == "now!"
+        end
+
+        it "returns overriden values when a developer has overriden them" do
+          TestClass.send(:option, :do_something, "now!")
+          TestClass.config do
+            do_something "later..."
+          end
+          TestClass.config.do_something.should == "later..."
+        end
+
+        it "uses a lambda to defer processing until it's called" do
+          TestClass.send(:option, :payment_method, lambda {
+            defined?(Paypal) ? :paypal : :plinq
+          })
+          TestClass.config.payment_method.should == :plinq
+        end
+
+        it "returns nil when a value is explicitly nil" do
+          TestClass.send(:option, :current_user_method, :current_user)
+          TestClass.config.current_user_method.should == :current_user
+          #TestClass.config.current_user_method = nil
+          TestClass.config do
+            current_user_method nil
+          end
+          TestClass.config.current_user_method.should be_nil
+        end
+        it "accepts a setter format" do
+          TestClass.send(:option, :do_something, "now!")
+          TestClass.config.do_something = "later..."
+          TestClass.config.do_something.should == "later..."
+        end
+      end
+    end
+
+    describe '#option with sub-options' do
+      before :each do
+        TestClass.send(:option, :advanced_options) do
+          option :bitrate, 1024
+          option :fps, 30
+        end
+      end
+
+      it "accepts a block that creates a sub-configuration" do
+        TestClass.config.advanced_options.bitrate.should == 1024
+        TestClass.config.advanced_options.fps.should == 30
+      end
+
+      it "accepts a hash that for a sub-configuration" do
+        TestClass.config.advanced_options = {
+          bitrate: 2000,
+          fps: 60
+        }
+        TestClass.config.advanced_options.bitrate.should == 2000
+        TestClass.config.advanced_options.fps.should == 60
+      end
+
+      it "doesn't overwrite a defaults hash if you set one value but not the other" do
+        TestClass.config.advanced_options = {bitrate: 2000}
+        TestClass.config.advanced_options.bitrate.should == 2000
+        TestClass.config.advanced_options.fps.should == 30
+      end
+
+      it "accepts even MORE options below the other ones, yo" do
+        TestClass.send(:option, :sub) do
+          option(:name, :face)
+          option(:sub) do
+            option(:name, :fiz)
+          end
+        end
+        TestClass.config.sub.name.should == :face
+        TestClass.config.sub.sub.name.should == :fiz
+      end
+    end
+
+    it "adds an `options` method that defines many options with default nil values" do
+      TestClass.should_receive(:option).once.with(:host)
+      TestClass.should_receive(:option).once.with(:api_key)
+      TestClass.send :options, :host, :api_key
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: configurator2
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Flip Sasser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email: flip@getplinq.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .rspec
+- Guardfile
+- README.md
+- Rakefile
+- VERSION
+- configurator2.gemspec
+- lib/configurator.rb
+- lib/configurator/configuration.rb
+- lib/configurator/option.rb
+- spec/lib/configurator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Plinq/configurator
+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: A mixin to add a .config method and options with defaults to any library
+test_files: []