settable 1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/Readme.md

@@ -0,0 +1,74 @@
+About
+===
+
+Simple library to make configuration files dead simple. It uses "set, enable, disable" just like capistrano and sinatra. It also has some rails helpers to change settings based off environments.
+
+To create the configuration wrapper, its as simple as:
+
+    class Configuration
+      include Settable
+
+      def initialize(&block)
+        instance_eval(&block) if block_given?
+      end
+    end
+
+to use this in your initializer, script, etc. just open it up and use set/enable/etc    
+
+    # using it without the rails helpers
+    config = Configuration.new do
+      set :environment, 'development'
+      enable :debug
+      
+      set :api_token do
+        return 'PRODTOKEN' if environment == 'production'
+        'DEVTOKEN'
+      end
+
+      set :api_endpoint, "http://example.com/api/#{api_token}"
+    end
+    
+    puts config.debug?
+    puts config.api_endpoint
+    
+or if you wanted to use it with rails    
+    
+    class Configuration
+      include Settable
+      include Settable::Rails
+
+      def initialize(&block)
+        instance_eval(&block) if block_given?
+      end
+    end
+      
+and use the environment helpers
+
+    config = Configuration.new do
+      # add some custom environments from our app
+      define_environments :blah, :qa
+
+      set :something, in_blah?
+      set :debug, in_environments?(:development, :test)
+  
+      if in_production?
+        enable :tracking, :caching
+      else
+        disable :tracking, :caching
+      end
+  
+      set :api_token do
+        in_production { return 'PRODTOKEN' }
+        in_development{ return 'DEVTOKEN' }
+        'OTHERTOKEN'
+      end
+  
+      set :api_endpoint do
+        in_environments(:development, :test){ return "http://sandbox.example.com/api/#{api_token}" }
+        "http://example.com/api/#{api_token}"
+      end
+    end
+    
+    puts config.debug?
+    puts config.caching?
+    puts config.api_endpoint

data/examples/example.rb

@@ -0,0 +1,36 @@
+$:.push File.expand_path("../../lib", __FILE__)
+require 'settable'
+
+class Configuration
+  include Settable
+  
+  def initialize(&block)
+    instance_eval(&block) if block_given?
+  end
+end
+
+config = Configuration.new do
+  set :environment, 'development'
+  
+  set :api_token do
+    return 'PRODTOKEN' if environment == 'production'
+    'DEVTOKEN'
+  end
+  
+  set :api_endpoint, "http://example.com/api/#{api_token}"
+  set :environment, 'production'
+end
+
+# external stuffs
+config.set :something, 1
+config.enable :debug
+
+puts config.inspect
+
+puts '-' * 80
+
+puts config.environment
+puts config.api_token
+puts config.api_endpoint
+puts config.something
+puts config.debug?

data/examples/rails.rb

@@ -0,0 +1,51 @@
+$:.push File.expand_path("../../lib", __FILE__)
+require 'settable'
+
+# stub out our rails
+module Rails
+  def self.env; :blah end
+end
+
+class Configuration
+  include Settable
+  include Settable::Rails
+    
+  def initialize(&block)
+    instance_eval(&block) if block_given?
+  end
+end
+
+@config = Configuration.new do
+  define_environments :blah, :qa
+  
+  set :something, in_blah?
+  set :debug, in_environments?(:development, :test)
+  
+  if in_production?
+    enable :tracking, :caching
+  else
+    disable :tracking, :caching
+  end
+  
+  set :api_token do
+    in_production { return 'PRODTOKEN' }
+    in_development{ return 'DEVTOKEN' }
+    'OTHERTOKEN'
+  end
+  
+  set :api_endpoint do
+    in_environments(:development, :test){ return "http://sandbox.example.com/api/#{api_token}" }
+    "http://example.com/api/#{api_token}"
+  end
+end
+
+# external stuffs
+puts @config.inspect
+
+puts '-' * 80
+
+puts @config.tracking?
+puts @config.caching?
+puts @config.api_token
+puts @config.api_endpoint
+puts @config.debug?

data/lib/settable.rb

@@ -0,0 +1,64 @@
+module Settable
+  VERSION = "1.0"
+  
+  module Rails
+    DEFAULT_ENVIRONMENTS = [:development, :production, :test]
+    
+    # allow us to add custom environment helpers
+    def define_environments(*envs)
+      envs.each do |env|
+        define_metaclass_method(:"in_#{env}"){ |&block| in_environment(env.to_sym, &block) }
+        define_metaclass_method(:"in_#{env}?"){ in_environment?(env.to_sym) }      
+      end
+    end
+    alias_method :define_environment, :define_environments
+    
+    # create our default environments
+    DEFAULT_ENVIRONMENTS.each do |env|
+      define_method(:"in_#{env}"){ |&block| in_environment(env.to_sym, &block) }
+      define_method(:"in_#{env}?"){ in_environment?(env.to_sym) }      
+    end
+    
+    # helper method that will call the block if the Rails.env matches the given environments
+    def in_environments(*envs, &block)
+      block.call if envs.include?(::Rails.env.to_sym)
+    end
+    alias_method :in_environment, :in_environments
+    
+    # tests if we're in the given environment(s)
+    def in_environments?(*envs)
+      envs.include?(::Rails.env.to_sym)
+    end
+    alias_method :in_environment?, :in_environments?
+  end
+  
+  def define_metaclass_method(method, &block)
+    (class << self; self; end).send :define_method, method, &block
+  end
+  
+  # list 
+  def __settables__
+    @__settables__ ||= []
+  end
+  
+  # modified from sinatra
+  def set(key, value=nil, &block)
+    raise ArgumentError, "You must specify either a block or value" if block_given? && !value.nil?
+    value = block if block_given?
+    if value.is_a?(Proc)
+      __settables__ << key
+      define_metaclass_method key, &value
+      define_metaclass_method(:"#{key}?"){ !!__send__(key) }
+    else
+      set key, Proc.new{value}
+    end
+  end
+
+  def enable(*keys)
+    keys.each{ |key| set key, true }
+  end
+  
+  def disable(*keys)
+    keys.each{ |key| set key, false }
+  end
+end

data/settable.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "settable"
+
+Gem::Specification.new do |s|
+  s.name        = "settable"
+  s.version     = Settable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rob Hurring"]
+  s.email       = ["robhurring@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Small include to make config files better}
+  s.description = %q{Small include to make config files better}
+
+  s.rubyforge_project = "settable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: settable
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.0"
+platform: ruby
+authors: 
+- Rob Hurring
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-09 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Small include to make config files better
+email: 
+- robhurring@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.md
+- examples/example.rb
+- examples/rails.rb
+- lib/settable.rb
+- settable.gemspec
+has_rdoc: true
+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: settable
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Small include to make config files better
+test_files: []
+