config_accessor 0.0.2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+gemspec
+
+group :development do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alexey Mikhaylov
+
+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.rdoc

@@ -0,0 +1,34 @@
+== Synopsys
+Class-level configuration DSL
+
+== Installation
+  gem install config_accessor
+
+== Examples
+  require 'config_accessor'
+
+  class Remote
+    configurable!
+
+    config_accessor :host, :default => "localhost"
+    config_accessor :port, :default => "80", :transform => :to_i
+    config_accessor :proxy_host, :proxy_port
+  end
+
+  class Local < Remote
+    config_accessor :l_port
+  end
+
+  Remote.host        # => "localhost"
+  Remote.port        # => 80
+  Remote.proxy_host  # => nil
+
+  r = Remote.new
+
+  r.port = "81"
+  r.port             # => 81
+  Remote.port        # => 80
+  Remote.port = 82
+  r.port             # => 81
+
+  Local.port         # => 80

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config_accessor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "config_accessor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "config_accessor"
+  s.version     = ConfigAccessor::VERSION
+  s.authors     = ["Alexei Mikhailov"]
+  s.email       = ["amikhailov83@gmail.com"]
+  s.homepage    = "https://github.com/take-five/config_accessor"
+  s.summary     = %q{Class-level configurations}
+
+  s.rubyforge_project = "config_accessor"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/config_accessor/class_methods.rb

@@ -0,0 +1,95 @@
+module ConfigAccessor
+  module ClassMethods
+    # config_accessor(symbol...) => nil
+    #
+    # Declare a named config attribute for this class
+    # Allowed options:
+    # * :transform - Symbol, Proc or Method that must be applied to configuration value before set
+    # * :default - Default value for this config section
+    # * :alias - alias name for configuration section
+    def config_accessor(*names)
+      # extract options
+      options = names.last.is_a?(Hash) ? names.pop : {}
+
+      # convert strings to symbols
+      names.map!(&:to_sym)
+
+      raise ArgumentError, 'config accessors names expected' unless names.length > 0
+
+      raise ArgumentError, ':alias option should be set '\
+                         'if and only if one argument supplied' if options.has_key?(:alias) &&
+          names.length != 1
+
+      names.each do |name|
+        define_config_accessor(name, options)
+      end
+
+      nil
+    end
+    alias config_accessors config_accessor
+
+    # Defines an instance and a singleton method with (optionally) alias.
+    # The method parameter can be a <tt>Proc</tt>, a <tt>Method</tt> or an <tt>UnboundMethod</tt> object.
+    def define_config_method(symbol, method, ali=nil)
+      define_method(symbol, method)
+      define_singleton_method(symbol, method)
+      define_config_accessor_aliases(symbol, ali.to_sym) if ali
+    end
+
+    # Clone class-level configuration for each instance
+    def new(*args, &block) #:nodoc:
+      instance = super(*args, &block)
+
+      # clone class-level variables
+      defined_config_accessors.each do |name, val|
+        instance.write_config_value(name, ConfigAccessor.try_duplicate(val))
+      end
+
+      instance
+    end
+
+    private
+    # create universal config accessor
+    def define_config_accessor(name, options) #:nodoc:
+      transform = if t = options.delete(:transform)
+                    raise TypeError, 'transformer must be Symbol, Method or Proc' unless t.respond_to?(:to_proc)
+                    t.to_proc
+                  end
+
+      # create accessor
+      accessor = proc do |*args, &block|
+        if args.empty? && !block # reader
+          read_config_value(name)
+        else # writer
+          raise ArgumentError, 'Too many arguments (%s for 1)' % args.length if args.length > 1
+
+          val = args.first || block
+          # apply :transform
+          val = transform.call(val) if transform.is_a?(Proc)
+
+          # set
+          write_config_value(name, val)
+        end
+      end
+
+      # set default value
+      accessor.call(options.delete(:default)) if options.has_key?(:default)
+
+      # add method
+      define_config_method(name, accessor, options.delete(:alias))
+
+      # return nil
+      nil
+    end
+
+    # create alias for both singleton and instance methods
+    def define_config_accessor_aliases(accessor_name, alias_name) #:nodoc:
+      class_eval <<-CODE
+      class << self
+        alias #{alias_name} #{accessor_name}
+      end
+      alias #{alias_name} #{accessor_name}
+      CODE
+    end
+  end
+end

data/lib/config_accessor/instance_methods.rb

@@ -0,0 +1,33 @@
+module ConfigAccessor
+  # Both instance and class-level methods
+  module InstanceMethods
+    def configure(&block)
+      raise ArgumentError, 'Block expected' unless block_given?
+
+      self.instance_eval(&block)
+
+      self
+    end
+
+    # Writes names configuration value
+    def write_config_value(name, value)
+      (@_config_accessors ||= {})[name.to_sym] = value
+    end
+
+    # Reads configuration value (supports inheritance)
+    def read_config_value(name)
+      parent_config_accessors.merge(@_config_accessors || {})[name.to_sym]
+    end
+
+    protected
+    # inheritable config accessors array
+    def defined_config_accessors #:nodoc:
+      @_config_accessors ||= {}
+    end
+
+    def parent_config_accessors #:nodoc:
+      superklass = (self.is_a?(Class) ? self : self.class).superclass
+      superklass.respond_to?(:defined_config_accessors) ? superklass.defined_config_accessors : {}
+    end
+  end
+end

data/lib/config_accessor/version.rb

@@ -0,0 +1,3 @@
+module ConfigAccessor
+  VERSION = "0.0.2"
+end

data/lib/config_accessor.rb

@@ -0,0 +1,22 @@
+require "config_accessor/version"
+require "config_accessor/class_methods"
+require "config_accessor/instance_methods"
+
+module ConfigAccessor
+  def configurable
+    extend(ClassMethods)
+    
+    extend(InstanceMethods)
+    include(InstanceMethods)
+  end
+  alias configurable! configurable
+
+  def try_duplicate(obj) #:nodoc:
+    duplicable = [NilClass, TrueClass, FalseClass, Numeric, Symbol, Class, Module].none? { |klass| obj.is_a?(klass) }
+
+    duplicable ? obj.dup : obj
+  end
+  module_function :try_duplicate
+end
+
+Object.extend(ConfigAccessor)

data/spec/config_accessor_spec.rb

@@ -0,0 +1,106 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe ConfigAccessor do
+  it "should be configurable" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :a
+    }
+    c.should respond_to(:a)
+    c.new.should respond_to(:a)
+
+    c.new.should_not respond_to(:config_accessor)
+  end
+
+  it "should be configurable in subclasses" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :a
+    }
+    d = Class.new(c) {}
+
+    d.should respond_to(:a)
+    d.new.should respond_to(:a)
+  end
+
+  it "should be able to set configuration values" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :port
+      port 80
+    }
+    d = Class.new(c) {}
+    instance = c.new
+
+    c.port.should eq(80)
+    instance.port.should eq(80)
+    d.port.should eq(80)
+
+    instance.port 81
+    d.port.should eq(80)
+  end
+
+  it "should not mutate class configuration through instance" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :port, :ary
+      port 80
+      ary []
+    }
+    instance = c.new
+
+    instance.port 81
+    instance.ary << 1
+
+    instance.port.should eq(81)
+    instance.ary.should eq([1])
+
+    c.port.should eq(80)
+    c.ary.should eq([])
+
+    c.port 82
+    instance.port.should eq(81)
+  end
+
+  it "should be able to set default values" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :port, :default => 80
+    }
+    c.port.should eq(80)
+  end
+
+  it "should be able to define aliases" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :port, :alias => :inferred_port, :default => 80
+    }
+    c.inferred_port.should eq(80)
+  end
+
+  it "should accept blocks as values" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :transformer
+      transformer { 22 }
+    }
+    c.transformer.should be_a_kind_of(Proc)
+  end
+
+  it "should transform values" do
+    c = Class.new {
+      configurable!
+
+      config_accessor :port, :transform => :to_i
+    }
+    c.port "80"
+    c.port.should eq(80)
+  end
+end

data/spec/test_helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require "config_accessor"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: config_accessor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Alexei Mikhailov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-10 00:00:00 +06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: 
+email: 
+- amikhailov83@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- config_accessor.gemspec
+- lib/config_accessor.rb
+- lib/config_accessor/class_methods.rb
+- lib/config_accessor/instance_methods.rb
+- lib/config_accessor/version.rb
+- spec/config_accessor_spec.rb
+- spec/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/take-five/config_accessor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: config_accessor
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Class-level configurations
+test_files: []
+