blindgaenger-configurable 0.1

data/README.textile

@@ -0,0 +1,203 @@
+h1. Configurable
+
+Little helper to configure ruby instances in a DSLish way.
+
+
+h2. Usage
+
+See the @examples/triangle.rb@ for the example described here.
+
+Include it in your class and define some configuration attributes:
+
+<pre><code>
+  require 'rubygems'
+  require 'configurable'
+
+  class Triangle
+    include Configurable
+
+    config_accessor :shape
+    config_accessor :color
+  end
+</code></pre>
+
+Configure some instances. Each config needs a @key@ to be accessible beside all 
+the other configs. Let's name it after some important mathematics.
+
+<pre><code>
+  Triangle.configure 'euklid' do
+    shape 'isosceles'
+    color 'red'
+  end
+
+  Triangle.configure 'pythagoras' do
+    shape 'equilateral'
+    color 'blue'
+  end
+</code></pre>
+
+Use the configured instances.
+
+<pre><code>
+  Triangle.configs #=>  {"euclid"=>#<Triangle:0x...>, "pythagoras"=>#<Triangle:0x...>}
+
+  Triangle.each {|name, triangle|
+    puts "#{name} => #{triangle.inspect}"
+  }
+
+  Triangle['pythagoras'].shape #=> equilateral
+</code></pre>
+
+Of course, feel free to have a look at the "source code":http://github.com/blindgaenger/configurable on Github. ;)  
+
+ 
+h3. Initalize with the configured key
+
+In some cases the key you use in the @configure@ method should be available in 
+the model as well. Of course, you could specify it again, but that's not necessary.
+
+Just define (or maybe you already have) a contructor which is able to receive
+the specified key. It's up to you, what you do with it.
+
+<pre><code>
+  class Website
+    include Configurable
+    
+    config_accessor :name
+    config_accessor :url
+
+    def initialize(key)
+      @name = key
+    end
+  end
+
+  Website.configure 'StackOverflow' do
+    url 'http://stackoverflow.com/'
+  end
+
+  so = Website['StackOverflow']
+  so.name  #=> StackOverflow
+  so.url   #=> http://stackoverflow.com/
+</code></pre>
+
+
+h3. Reader, writer or accessor
+
+The basic @attr_*@ methods are available as @config_*@. They create the getter 
+and setter methods as usual. So you can still define which attributes should be 
+accessible from the outside world.
+
+<pre><code>
+  class Person
+    include Configurable
+
+    config_reader   :birthday   # can't change it
+    config_writer   :nickname   # don't even know how they call you
+    config_accessor :friends    # may come and go
+  end
+  
+  Person.configure 'Bertolt Brecht' do
+    birthday '1898-02-10'
+    nickname 'Bert'
+    friends 'Hanns Eisler', 'Karl Valentin'
+  end
+  
+  brecht = Person['Bertolt Brecht']
+  
+  # reader
+  brecht.birthday #=> 1898-02-10
+  begin  
+    brecht.birthday = '2008-12-24'
+  rescue NoMethodError => ex
+  end
+  
+  # writer
+  brecht.nickname = 'Herr K.'
+  begin
+    brecht.nickname
+  rescue NoMethodError => ex
+  end
+  
+  # accessor
+  brecht.friends #=> ["Hanns Eisler", "Karl Valentin"]
+  brecht.friends << 'Carola Neher'
+  brecht.friends #=> ["Hanns Eisler", "Karl Valentin", "Carola Neher"]  
+</code></pre>
+
+You see, all behave the exact same way!
+
+
+h3. Use in configuration files
+
+Please see @examples/computers.rb@ for the working example.
+
+Ok, at first define the model. Please note, that @type@ is the second parameter
+of the constructor.
+
+<pre><code>
+  class Computer
+    include Configurable
+
+    config_accessor :host    
+    config_accessor :type
+    config_accessor :ip  
+    
+    def initialize(host, type)
+      @host = host
+      @type = type
+    end
+  end
+</code></pre>
+
+Now define some DSLish config helpers. Each injects a different @type@ as 
+arguments to the @configure@ methods. Use as much arguments as you like. But it's 
+important, that the @key@ (in this case the @name@) is still the first argument.
+
+<pre><code>
+  def server(name, &block)
+    Computer.configure(name, :server, &block)
+  end
+
+  def notebook(name, &block)
+    Computer.configure(name, :notebook, &block)
+  end
+</code></pre>
+
+Create a config file and use the DSL. Although the helpers simply wrap the 
+@configure@ method it looks much nicer!
+
+<pre><code>
+  server 'raumstation' do
+    ip '192.168.0.201'
+  end
+
+  server 'wohnserver' do
+    ip '192.168.0.202'
+  end
+
+  notebook 'gartenstuhl' do
+    ip '192.168.0.203'
+  end
+</code></pre>
+
+Back in your ruby file, load the config and use it as usual.
+
+<pre><code>
+  config_file = 'computers.config'
+  load config_file
+
+  ips = Computer.map {|name, computer| computer.ip }
+  #=> ["192.168.0.201", "192.168.0.200", "192.168.0.202", "192.168.0.203"]
+
+  raumstation = Computer['raumstation']
+  raumstation.type #=> :server
+</code></pre>
+
+That's it!
+
+
+h2. Contact
+
+You can contact me via mail at blindgaenger at gmail dot com, or leave me a 
+message on my "Github profile":http://github.com/blindgaenger.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'spec/rake/spectask'
+
+desc "Run Specs with Rspec"
+Spec::Rake::SpecTask.new :spec do |t|
+  t.spec_opts = %w(--format specdoc --color)
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = "--format pretty --no-source"
+end

data/examples/brecht.rb

@@ -0,0 +1,40 @@
+$:.unshift File.join(File::dirname(__FILE__), '..', 'lib')
+require 'configurable'
+
+class Person
+  include Configurable
+
+  config_reader   :birthday   # can't change it
+  config_writer   :nickname   # don't even know how they call you
+  config_accessor :friends    # may come and go
+end
+
+Person.configure 'Bertolt Brecht' do
+  birthday '1898-02-10'
+  nickname 'Bert'
+  friends 'Hanns Eisler', 'Karl Valentin'
+end
+
+brecht = Person['Bertolt Brecht']
+
+# reader
+brecht.birthday   #=> 1898-02-10
+begin  
+  brecht.birthday = '2008-12-24'
+rescue NoMethodError => ex
+  #=> undefined method `birthday=' for #<Person:0xb7c30d04>
+end
+
+# writer
+brecht.nickname = 'Herr K.'
+begin
+  brecht.nickname
+rescue NoMethodError => ex
+  #=> super: no superclass method `nickname'
+end
+
+# accessor
+brecht.friends    #=> ["Hanns Eisler", "Karl Valentin"]
+brecht.friends << 'Carola Neher'
+brecht.friends    #=> ["Hanns Eisler", "Karl Valentin", "Carola Neher"]
+

data/examples/computers.config

@@ -0,0 +1,16 @@
+
+desktop 'apfelsaft' do
+  ip '192.168.0.200'
+end
+
+server 'raumstation' do
+  ip '192.168.0.201'
+end
+
+server 'wohnserver' do
+  ip '192.168.0.202'
+end
+
+notebook 'gartenstuhl' do
+  ip '192.168.0.203'
+end

data/examples/computers.rb

@@ -0,0 +1,46 @@
+$:.unshift File.join(File::dirname(__FILE__), '..', 'lib')
+require 'configurable'
+
+class Computer
+  include Configurable
+
+  attr_accessor :type
+  config_accessor :hostname
+  config_accessor :ip  
+  
+  def initialize(host, type)
+    @hostname = host
+    @type = type
+  end
+end
+
+
+# define some DSLish config helpers
+
+def server(name, &block)
+  Computer.configure(name, :server, &block)
+end
+
+def desktop(name, &block)
+  Computer.configure(name, :desktop, &block)
+end
+
+def notebook(name, &block)
+  Computer.configure(name, :notebook, &block)
+end
+
+
+# load the config (here from 'computers.config')
+config_file = $0.gsub /#{File.extname($0)}$/, '.config'
+load config_file
+
+
+# now use them
+
+ips = Computer.map {|name, computer| computer.ip }
+#=> ["192.168.0.201", "192.168.0.200", "192.168.0.202", "192.168.0.203"]
+
+Computer['raumstation'] #=> <Computer:0xb7c6e4c4 @type=:server, @hostname="raumstation", @ip="192.168.0.201">
+Computer['apfelsaft']   #=> <Computer:0xb7c6e62c @type=:desktop, @hostname="apfelsaft", @ip="192.168.0.200">
+Computer['wohnserver']  #=> <Computer:0xb7c6e370 @type=:server, @hostname="wohnserver", @ip="192.168.0.202">
+Computer['gartenstuhl'] #=> <Computer:0xb7c6e21c @type=:notebook, @hostname="gartenstuhl", @ip="192.168.0.203">

data/examples/triangle.rb

@@ -0,0 +1,32 @@
+$:.unshift File.join(File::dirname(__FILE__), '..', 'lib')
+require 'configurable'
+
+class Triangle
+  include Configurable
+
+  config_accessor :shape
+
+  config_accessor :sides do |*args|
+    args.join('->')
+  end
+
+  config_accessor :angles do |alpha, beta, gamma, *others|
+    raise 'more than 3 angles defined' unless others.empty?
+    raise 'sum of all angels is not 180' if alpha + beta + gamma != 180
+    [alpha, beta, gamma]
+  end
+end
+
+Triangle.configure('euclid') do
+  shape 'isosceles'
+  sides 'a', 'b', 'c'
+  angles 90, 60, 30
+end
+
+p Triangle.configs
+#=> {"euclid"=>#<Triangle:0xb7d01e90 @sides="a->b->c", @shape="isosceles", @angles=[90, 60, 30]>}
+
+triangle = Triangle['euclid']
+p triangle.sides
+#=> "a->b->c"
+

data/examples/website.rb

@@ -0,0 +1,22 @@
+$:.unshift File.join(File::dirname(__FILE__), '..', 'lib')
+require 'configurable'
+
+class Website
+  include Configurable
+  
+  config_accessor :name
+  config_accessor :url
+
+  def initialize(key)
+    @name = key
+  end
+end
+
+Website.configure 'StackOverflow' do
+  url 'http://stackoverflow.com/'
+end
+
+so = Website['StackOverflow']
+so.name  #=> StackOverflow
+so.url   #=> http://stackoverflow.com/
+

data/lib/configurable.rb

@@ -0,0 +1,70 @@
+module Configurable
+
+  def self.included(base)
+
+    class << base
+      attr_reader :configs
+      include Enumerable
+      def method_missing(name, *args, &block)
+        @configs ||= {}
+        @configs.send(name, *args, &block)
+      end
+    end
+
+  private
+    # based on http://eigenclass.org/hiki.rb?ruby+plugins
+    def base.config_attr(reader, writer, *names, &block)
+      class_eval do
+        names.each do |name|
+
+          define_method(name) do |*args|
+            if args.empty?
+              if reader
+                instance_variable_get("@#{name}")
+              else
+                super # should raise the error
+              end
+            else
+              value = *args
+              value = block.call(*args) if block_given?
+              instance_variable_set("@#{name}", value)
+            end
+          end
+
+          if writer
+            attr_writer name.to_sym
+          end
+
+        end
+      end
+    end
+
+    def base.config_accessor(*names, &block)
+      config_attr(true, true, *names, &block)
+    end
+
+    def base.config_writer(*names, &block)
+      config_attr(false, true, *names, &block)
+    end
+
+    def base.config_reader(*names, &block)
+      config_attr(true, false, *names, &block)
+    end
+
+
+    def base.configure(key, *args, &block)
+      # arity isn't reliable, so just try it
+      begin
+        instance = self.new(key, *args)
+      rescue ArgumentError
+        instance = self.new(*args)
+      end
+      instance.instance_eval &block
+      self[key] = instance
+      instance
+    end
+
+  end # self.included
+
+end
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: blindgaenger-configurable
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- blindgaenger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.15
+    version: 
+description: 
+email: blindgaenger@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.textile
+- lib/configurable.rb
+- examples/brecht.rb
+- examples/computers.config
+- examples/computers.rb
+- examples/triangle.rb
+- examples/website.rb
+has_rdoc: "false"
+homepage: http://github.com/blindgaenger/configurable
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Little helper to configure ruby instances in a DSLish way.
+test_files: []
+