kung_figure 0.0.1

data/README.rdoc

@@ -0,0 +1,88 @@
+= Simple Rest
+
+ * http://github.com/niquola/kung_figure
+
+== DESCRIPTION
+
+Simple RUBY configuration DSL
+
+== INSTALL:
+
+  sudo gem install kung_figure
+
+or for rails in config/environment.rb 
+
+  config.gem 'kung_figure'
+
+then
+
+  sudo rake gems:install
+
+== USAGE  
+
+Example:
+   
+  module MyModule
+    include KungFigure
+    class Config < KungFigure::Base
+      define_prop :prop1,'default1'
+      define_prop :prop2, 2
+
+      class NestedConfig < KungFigure::Base
+        define_prop :prop3,'prop3'
+
+        class NestedNestedConfig < KungFigure::Base
+          define_prop :prop4,'prop4'
+        end
+      end
+    end
+  end
+
+This will add method configure,config,load_config into MyModule:
+  
+  MyModule.configure do
+    prop1 'new value'
+    nested_config do
+       prop3 'new value'
+    end
+  end
+
+and accessors for configs:
+
+  MyModule.config.prop1
+  MyModule.config.nested_config.prop1
+
+You can also include KungFigure into nested in module classes and declare Config class (subclassing KungFigure::Base)
+to get similar result:
+
+
+  module MyModule
+    include KungFigure
+    class Config < KungFigure::Base
+      define_prop :prop1,'default1'
+    end
+    #somewhere in another file
+    class WorkHorse
+      include KungFigure
+      class Config < KungFigure::Base
+        define_prop :my_config,'default'
+      end
+
+      def meth
+         config.my_config
+      end
+    end
+  end
+
+Then your can access configuration with:
+
+  MyModule::WorkHorse.config or MyModule.config.work_horse
+  
+Or inside instances of WorkHorse as config method.
+   
+
+== CHANGE LOG
+
+== MORE
+
+For more info see tests and source code :)  

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the pg_gnostic plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the pg_gnostic plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'kung_figure'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+PKG_FILES = FileList[ '[a-zA-Z]*', 'generators/**/*', 'lib/**/*', 'rails/**/*', 'tasks/**/*', 'test/**/*' ]
+
+spec = Gem::Specification.new do |s|
+  s.name = "kung_figure"
+  s.version = "0.0.1"
+  s.author = "niquola"
+  s.email = "niquola@gmail.com"
+  s.homepage = "http://github.com/niquola/kung_figure"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Ruby configuration DSL base"
+  s.files = PKG_FILES.to_a 
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/kung_figure.rb

@@ -0,0 +1,79 @@
+module KungFigure
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def config
+    self.class.config
+  end
+
+  module ClassMethods
+    def set_root_config_class(klazz)
+      @root_config_class = klazz
+    end
+
+    def root_config_class
+      self.const_get(@root_config_class || :Config)
+    end
+
+    def config
+      @config ||= root_config_class.new
+    end
+
+    def configure(&block)
+      config.instance_eval &block
+    end
+
+    def load_config(path)
+      load path
+    end
+  end
+
+  class Base
+    class << self
+      def define_prop(name,default)
+        define_method(name) do |*args|
+          @props ||= {}
+          if args.length > 0
+            @props[name] = args[0]
+          else
+            @props[name] || default
+          end
+        end
+      end
+    end
+
+    def camelize(str)
+      str.split('_').map{|l| l.capitalize}.join('')
+    end
+    
+    def get_from_enclosing_module(klazz_name)
+      config_klazz_path=self.class.name.to_s.split('::')[0..-2]
+      config_klazz_path<< klazz_name
+      config_klazz_path.inject(Object){|parent,nxt|
+         break unless parent.const_defined?(nxt.to_sym) 
+         parent.const_get(nxt.to_sym)
+      }
+    end
+
+    def method_missing(key,&block)
+      @props ||= {}
+      klazz_name = camelize(key.to_s).to_sym
+      child_cfg_clazz = self.class.const_get(klazz_name) if self.class.const_defined?(klazz_name)
+      child_cfg_clazz ||= get_from_enclosing_module(klazz_name)
+
+      raise "No such configuration #{key}" unless child_cfg_clazz
+
+      unless @props.key?(key)
+        @props[key] = if child_cfg_clazz.ancestors.include?(KungFigure::Base)
+                        child_cfg_clazz.new
+                      elsif child_cfg_clazz.respond_to?(:config)
+                        child_cfg_clazz.config
+                      end
+      end
+      @props[key].instance_eval(&block) if block_given?
+      return @props[key]
+    end
+  end
+end

data/test/kung_figure_test.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+module MyModule
+  include KungFigure
+  class Config < KungFigure::Base
+    define_prop :prop1,'default1'
+    define_prop :prop2, 2
+
+    class NestedConfig < KungFigure::Base
+      define_prop :prop3,'prop3'
+
+      class NestedNestedConfig < KungFigure::Base
+        define_prop :prop4,'prop4'
+      end
+    end
+  end
+end
+
+
+module MyModule
+  class WorkHorse
+    include KungFigure
+    class Config < KungFigure::Base
+      define_prop :my_config,'default'
+    end
+  end
+end
+
+class TestKungFigure < Test::Unit::TestCase
+  def test_configuration
+    assert_equal('default1',MyModule.config.prop1)
+    assert_equal(2,MyModule.config.prop2)
+    assert_equal('prop3',MyModule.config.nested_config.prop3)
+    assert_equal('prop4',MyModule.config.nested_config.nested_nested_config.prop4)
+
+    MyModule.config.nested_config.nested_nested_config.prop4 'new value'
+    assert_equal('new value',MyModule.config.nested_config.nested_nested_config.prop4)
+
+    MyModule.configure do
+      nested_config do
+        prop3 'value3'
+      end
+    end
+
+    assert_equal('value3',MyModule.config.nested_config.prop3)
+  end
+
+  def test_nested_config_declaration
+    assert_equal('default',MyModule.config.work_horse.my_config)
+    assert_equal('default',MyModule::WorkHorse.config.my_config)
+    MyModule.configure do
+      work_horse do
+        my_config 'new value'
+      end
+    end
+    assert_equal('new value',MyModule.config.work_horse.my_config)
+    assert_equal('new value',MyModule::WorkHorse.config.my_config)
+    assert_equal(MyModule::WorkHorse.config,MyModule::WorkHorse.new.config)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+def path(path)
+  File.join(File.dirname(__FILE__),path)
+end
+
+$:.unshift(path('../lib'))
+require "kung_figure"
+require "test/unit"
+
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: kung_figure
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- niquola
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: niquola@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/kung_figure.rb
+- test/kung_figure_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/niquola/kung_figure
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby configuration DSL base
+test_files: []
+