blindgaenger-configurable 0.1 → 0.2

data/README.textile

@@ -5,9 +5,11 @@ Little helper to configure ruby instances in a DSLish way.
 
 h2. Usage
 
-See the @examples/triangle.rb@ for the example described here.
+See @examples/*.rb@ for all examples described here.
 
-Include it in your class and define some configuration attributes:
+h3. Basic usage (Triangle example)
+
+Include @Configurable@ in your class and define some configuration attributes:
 
 <pre><code>
   require 'rubygems'
@@ -51,7 +53,7 @@ Use the configured instances.
 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
+h3. Initalize with the configured key (Website example)
 
 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.
@@ -81,7 +83,7 @@ the specified key. It's up to you, what you do with it.
 </code></pre>
 
 
-h3. Reader, writer or accessor
+h3. Config attributes, readers, writers and accessors (Person example)
 
 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 
@@ -91,43 +93,45 @@ accessible from the outside world.
   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
+    config_attribute :health     # can't be given or stolen
+    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
+    health   'good'
     birthday '1898-02-10'
     nickname 'Bert'
-    friends 'Hanns Eisler', 'Karl Valentin'
+    friends  ['Hanns Eisler', 'Karl Valentin']
   end
   
   brecht = Person['Bertolt Brecht']
   
+  # attribute
+  brecht.health                    #=> NoMethodError
+  brecht.health = 'bad'            #=> NoMethodError
+  
   # reader
-  brecht.birthday #=> 1898-02-10
-  begin  
-    brecht.birthday = '2008-12-24'
-  rescue NoMethodError => ex
-  end
+  brecht.birthday                  #=> 1898-02-10
+  brecht.birthday = '2008-12-24'   #=> NoMethodError
   
   # writer
-  brecht.nickname = 'Herr K.'
-  begin
-    brecht.nickname
-  rescue NoMethodError => ex
-  end
+  brecht.nickname = 'Herr K.'      #=> 'Herr K.'
+  brecht.nickname                  #=> NoMethodError
   
   # accessor
-  brecht.friends #=> ["Hanns Eisler", "Karl Valentin"]
-  brecht.friends << 'Carola Neher'
-  brecht.friends #=> ["Hanns Eisler", "Karl Valentin", "Carola Neher"]  
+  brecht.friends                   #=> ["Hanns Eisler", "Karl Valentin"]
+  brecht.friends << 'Carola Neher' #=> ["Hanns Eisler", "Karl Valentin", "Carola Neher"]  
+  brecht.friends                   #=> ["Hanns Eisler", "Karl Valentin", "Carola Neher"]  
 </code></pre>
 
-You see, all behave the exact same way!
+You see, all behave the exact same way as your attr_* helpers! Except for the new
+config_attribute, which defines the instance variable, but does not share it to
+the outside world.
 
 
-h3. Use in configuration files
+h3. Use in configuration files (Computer example)
 
 Please see @examples/computers.rb@ for the working example.
 
@@ -193,6 +197,39 @@ Back in your ruby file, load the config and use it as usual.
   raumstation.type #=> :server
 </code></pre>
 
+
+h3. Configs with code blocks (Tower example)
+
+By providing a block you can define what your @config_*@ method should do. This
+way you can implement for example validations or stacks. Something like this:
+
+<pre><code>
+class Tower
+  include Configurable
+
+  attr_reader :stack
+
+  config_attribute :brick do |color|
+    raise "argh, #{color}!!!" if color == 'purple'
+    @stack ||= []
+    @stack << color
+  end
+end
+</code></pre>
+
+Now the @brick@ method can be called multiple times. And for the @purple@ color
+you'll get an angry error.
+
+<pre><code>
+brick = Tower.configure 'nice' do
+  brick 'red'
+  brick 'green'
+  brick 'green'
+  brick 'blue'
+end
+brick.stack #=> ["red", "green", "green", "blue"]
+</code></pre>
+
 That's it!
 
 

data/lib/configurable.rb

@@ -1,3 +1,6 @@
+require 'rubygems'
+require 'facets' 
+
 module Configurable
 
   def self.included(base)
@@ -25,9 +28,11 @@ module Configurable
                 super # should raise the error
               end
             else
-              value = *args
-              value = block.call(*args) if block_given?
-              instance_variable_set("@#{name}", value)
+              if block_given?
+                instance_exec(*args, &block)
+              else
+                instance_variable_set("@#{name}", *args)
+              end
             end
           end
 
@@ -51,6 +56,9 @@ module Configurable
       config_attr(true, false, *names, &block)
     end
 
+    def base.config_attribute(*names, &block)
+      config_attr(false, false, *names, &block)
+    end
 
     def base.configure(key, *args, &block)
       # arity isn't reliable, so just try it

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blindgaenger-configurable
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - blindgaenger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-18 00:00:00 -08:00
+date: 2009-01-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

data/examples/brecht.rb

@@ -1,40 +0,0 @@
-$:.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

@@ -1,16 +0,0 @@
-
-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

@@ -1,46 +0,0 @@
-$:.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">