delano-caesars 0.5.2 → 0.5.4

data/CHANGES.txt

@@ -1,9 +1,21 @@
 CAESAR -- CHANGES
 
 
+#### 0.5.4 (2009-04-11) ###############################
+
+* FIXED: find_deferred would abort early because the safety limit
+to prevent endless loops wasn't being reset between calls. 
+
+
+#### 0.5.3 (2009-04-10) ###############################
+
+* ADDED: Better error handling when reading DSL config files
+* ADDED: forced_hash method 
+
+
 #### 0.5.2 (2009-03-31) ###############################
 
-* NEW: Caesars.debug?, Caesars.enable_debug, Caesars.disable_debug
+* ADDED: Caesars.debug?, Caesars.enable_debug, Caesars.disable_debug
 * CHANGED: find_deferred now supports nested Arrays. See rdocs. 
 * BUG: Found bug related to string/symbol ambiguity when using find.
 It's not fixed yet so for now be mindful of which attributes are 
@@ -14,31 +26,31 @@ and method accessors are not affected.
 
 #### 0.5.1 (2009-03-11) ###############################
 
-* FIX: Method-syntax was broken for attributes of top level method
-* FIX: Caesars::Hash#refresh was setting @options to nil
+* FIXED: Method-syntax was broken for attributes of top level method
+* FIXED: Caesars::Hash#refresh was setting @options to nil
 * UPDATED: docs and bin/example to reflect Caesars::Hash changes. 
-* FIX: instance_variables in Ruby 1.9.1 returns Symbols 
+* FIXED: instance_variables in Ruby 1.9.1 returns Symbols 
 
 
 #### 0.5.0 (2009-03-11) ###############################
 
-* FIX: find_deferred now gracefully handles nil errors
-* NEW: empty? method in Caesars::Config
-* NEW: post processing hook in Caesars::Config#refresh
-* NEW: Caesars::Hash#to_hash now recursively casts children to ::Hash.
-* FIX: Added Array support to Caesars::Hash
-* NEW: Setters for Caesars attributes
-* NEW: Caesars::Config supports multiple config files
-* NEW: Top level methods used more than once now merges values
+* FIXED: find_deferred now gracefully handles nil errors
+* ADDED: empty? method in Caesars::Config
+* ADDED: post processing hook in Caesars::Config#refresh
+* ADDED: Caesars::Hash#to_hash now recursively casts children to ::Hash.
+* FIXED: Added Array support to Caesars::Hash
+* ADDED: Setters for Caesars attributes
+* ADDED: Caesars::Config supports multiple config files
+* ADDED: Top level methods used more than once now merges values
 rather than overwrites. 
-* NEW: Caesars::Config supports reloading config files on the fly
+* ADDED: Caesars::Config supports reloading config files on the fly
 
 
 #### 0.4.2 (2009-03-05) ###############################
 
-* FIX: missing bin/party.conf in gem release
-* FIX: Now works with Ruby 1.8+
-* NEW: Cleaner rdocs. 
+* FIXED: missing bin/party.conf in gem release
+* FIXED: Now works with Ruby 1.8+
+* ADDED: Cleaner rdocs. 
 * TODO: Fix support for top level methods with names:
 food :extra do; end; # => food_extra
 
@@ -47,18 +59,18 @@ food :extra do; end; # => food_extra
 
 * CHANGE: Removed bloody method. We now parse blocks immediately.
 * CHANGE: Renamed virgin method to chill.
-* NEW: Caesars::Config class for loading DSLs as config files. 
+* ADDED: Caesars::Config class for loading DSLs as config files. 
 See Example 3. 
-* NEW: Added find_deferred method to automatically jump up the
+* ADDED: Added find_deferred method to automatically jump up the
 heirarchy when looking for a specific attribute. 
-* NEW: Added to_hash and [] methods to Caesars to make it 
+* ADDED: Added to_hash and [] methods to Caesars to make it 
 more hashlike. 
-* FIX: "chilled" attributes weren't available by method name
+* FIXED: "chilled" attributes weren't available by method name
 
 
 #### 0.3.2 (2009-03-04) ###############################
 
-* FIX: Added file and line info for eval code (better debugging).
+* FIXED: Added file and line info for eval code (better debugging).
 * CHANGE: The top level DSL method names are now determined by
 by the class name. Some::ClassName becomes classname. 
 This is less confusing than allowing it to be anything
@@ -68,9 +80,9 @@ namespace.
 
 #### 0.3.1 (2009-03-04) ###############################
 
-* NEW: Accept instances without a name
+* ADDED: Accept instances without a name
 * CHANGE: Updated examples. 
-* NEW: More rdocs. 
+* ADDED: More rdocs. 
 
 
 

data/README.rdoc

@@ -56,17 +56,21 @@ Or for GitHub fans:
      # will be included in the instance variable (@staff_fte).
      staff :fte do
        desc 'Our hard-working, "full-time" staff'
+
        location :splashdown do
          town :tsawwassen
+
          person :steve, :sheila do
            role :manager
          end
+
          person :steve do
            role :cook
            anger :high
            hours 25
            catchphrase "Rah! [strokes goatee]"
          end
+
          person :sheila do
            catchphrase "This gravy tastes like food I ate in a Mexican prison."
            hours rand(20)
@@ -75,6 +79,7 @@ Or for GitHub fans:
              ("%.2f" % [gumption * self.splashdown.sheila.rate.to_f]).to_f
            end
          end
+
          person :delano do
            role :cook
            rate "8.35/h"
@@ -82,9 +87,9 @@ Or for GitHub fans:
            satisfaction :low
            calculate :salary do 
              self.splashdown.delano.rate.to_f * self.splashdown.delano.hours
-     
            end
          end
+
        end
      end
      
@@ -104,7 +109,6 @@ Or for GitHub fans:
      # You can call them manually and send arguments like you normally would. 
      p @staff_fte.splashdown.delano.salary.call             # => 475.95
      p @staff_fte.splashdown.sheila.salary.call(rand(100))  # => 549.77
-     p @staff_fte.splashdown.keys
 
 
 == EXAMPLE 3 -- External Config file

data/bin/example

@@ -53,17 +53,21 @@ extend Staff::DSL
 # will be included in the instance variable (@staff_fte).
 staff :fte do
   desc 'Our hard-working, "full-time" staff'
+
   location :splashdown do
     town :tsawwassen
+
     person :steve, :sheila do
       role :manager
     end
+
     person :steve do
       role :cook
       anger :high
       hours 25
       catchphrase "Rah! [strokes goatee]"
     end
+
     person :sheila do
       catchphrase "This gravy tastes like food I ate in a Mexican prison."
       hours rand(20)
@@ -72,16 +76,17 @@ staff :fte do
         ("%.2f" % [gumption * self.splashdown.sheila.rate.to_f]).to_f
       end
     end
+
     person :delano do
       role :cook
       rate "8.35/h"
       hours 57
       satisfaction :low
       calculate :salary do 
-        self.splashdown.delano.rate.to_f * self.splashdown.delano.hours
-        
+        self.splashdown.delano.rate.to_f * self.splashdown.delano.hours        
       end
     end
+
   end
 end
 
@@ -101,7 +106,6 @@ p @staff_fte.splashdown[:steve][:role]  # => [:manager, :cook]
 # You can call them manually and send arguments like you normally would. 
 p @staff_fte.splashdown.delano.salary.call             # => 475.95
 p @staff_fte.splashdown.sheila.salary.call(rand(100))  # => 549.77
-p @staff_fte.splashdown.keys
 
 
 # ------------------------------------------------------------------

data/caesars.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = %q{caesars}
-  s.version = "0.5.2"
-  s.date = %q{2009-03-31}
+  s.version = "0.5.4"
+  s.date = %q{2009-04-11}
   s.specification_version = 1 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 

data/lib/caesars.rb

@@ -7,9 +7,9 @@
 # See bin/example
 #
 class Caesars
-  VERSION = "0.5.2"
+  VERSION = "0.5.4"
   @@debug = false
-  
+
   def Caesars.enable_debug; @@debug = true; end
   def Caesars.disable_debug; @@debug = false; end
   def Caesars.debug?; @@debug; end
@@ -108,30 +108,35 @@ class Caesars
   # should be returned.
   # 
   #      find_deferred(:environment, :role:, [:disks, '/file/path'])
-  #
-  # [:environment][:role][:disks]['/file/path']
-  # [:environment][:disks]['/file/path']
-  # [:disks]['/file/path']
+  # 
+  # Search order:
+  # * [:environment][:role][:disks]['/file/path']
+  # * [:environment][:disks]['/file/path']
+  # * [:disks]['/file/path']
   #
   # Other nested Arrays are treated special too. We look at the criteria from
   # right to left and remove the first nested element we find.
   #
   #      find_deferred([:region, :zone], :environment, :role, :ami)
   #
-  # [:region][:zone][:environment][:role][:ami]
-  # [:region][:environment][:role][:ami]
-  # [:environment][:role][:ami]
-  # [:environment][:ami]
-  # [:ami]
+  # Search order:
+  # * [:region][:zone][:environment][:role][:ami]
+  # * [:region][:environment][:role][:ami]
+  # * [:environment][:role][:ami]
+  # * [:environment][:ami]
+  # * [:ami]
+  #
+  # NOTE: There is a maximum depth of 10. 
   #
   # Returns the attribute if found or nil.
   #
   def find_deferred(*criteria)
+    
     # The last element is assumed to be the attribute we're looking for. 
     # The purpose of this function is to bubble up the hierarchy of a
     # hash to find it.
     att = criteria.pop  
-
+    
     # Account for everything being sent as an Array
     # i.e. find([1, 2, :attribute])
     # We don't use flatten b/c we don't want to disturb nested Arrays
@@ -139,12 +144,11 @@ class Caesars
       criteria = att
       att = criteria.pop
     end
-
+    
     found = nil
     sacrifice = nil
-
+    
     while !criteria.empty?
-      p [criteria, att].flatten if Caesars.debug?
       found = find(criteria, att)
       break if found
 
@@ -166,9 +170,8 @@ class Caesars
 
       # We need to make a sacrifice
       sacrifice = criteria.pop if sacrifice.nil?
-
-      break if (@limit ||= 0) > 5  # A failsafe
-      @limit += 1
+      break if (limit ||= 0) > 10  # A failsafe
+      limit += 1
       sacrifice = nil
     end
 
@@ -225,7 +228,12 @@ class Caesars
         #(@caesars_pointer[:"#{meth}_values"] ||= []) << name
         @caesars_pointer[name] ||= Caesars::Hash.new
         @caesars_pointer = @caesars_pointer[name]
-        b.call if b
+        begin
+          b.call if b
+        rescue ArgumentError, SyntaxError => ex
+          STDERR.puts "CAESARS: error in #{meth} (#{args.join(', ')})" 
+          raise ex
+        end
         @caesars_pointer = prev
       end
         
@@ -253,7 +261,7 @@ class Caesars
   #        end
   #      end
   #
-  #      @config.food.order.call(3)     # => 5
+  #      @config.food.count.call(3)     # => 5
   #
   def self.chill(caesars_meth)
     module_eval %Q{
@@ -261,7 +269,7 @@ class Caesars
         # caesars.toplevel.unnamed_chilled_attribute
         return @caesars_properties[:'#{caesars_meth}'] if @caesars_properties.has_key?(:'#{caesars_meth}') && caesars_names.empty? && b.nil?
         
-        # Use the name of the bloody method if no name is supplied. 
+        # Use the name of the chilled method if no name is supplied. 
         caesars_names << :'#{caesars_meth}' if caesars_names.empty?
         
         caesars_names.each do |name|
@@ -275,6 +283,46 @@ class Caesars
   end
   
   
+  
+  # Force the specified keyword to always be treated as a hash. 
+  # Example:
+  #
+  #     startup do
+  #       disks do
+  #         create "/path/2"         # Available as hash: [action][disks][create][/path/2] == {}
+  #         create "/path/4" do      # Available as hash: [action][disks][create][/path/4] == {size => 14}
+  #           size 14
+  #         end
+  #       end
+  #     end
+  #
+  def self.forced_hash(caesars_meth, &b)
+    module_eval %Q{
+      def #{caesars_meth}(*caesars_names,&b)
+        if @caesars_properties.has_key?(:'#{caesars_meth}') && caesars_names.empty? && b.nil?
+          return @caesars_properties[:'#{caesars_meth}'] 
+        end
+        
+        return nil if caesars_names.empty? && b.nil?
+        return method_missing(:'#{caesars_meth}', *caesars_names, &b) if caesars_names.empty?
+
+        caesars_name = caesars_names.shift
+
+        prev = @caesars_pointer
+        @caesars_pointer[:'#{caesars_meth}'] ||= Caesars::Hash.new
+        hash = Caesars::Hash.new
+        @caesars_pointer = hash
+        b.call if b
+        @caesars_pointer = prev
+        @caesars_pointer[:'#{caesars_meth}'][caesars_name] = hash 
+        @caesars_pointer = prev
+      end
+    }
+    nil
+    
+
+  end
+  
   # Executes automatically when Caesars is subclassed. This creates the
   # YourClass::DSL module which contains a single method named after YourClass 
   # that is used to catch the top level DSL method. 
@@ -312,6 +360,7 @@ class Caesars
         
       end
     }, __FILE__, __LINE__
+    
   end
   
 end
@@ -350,7 +399,7 @@ class Caesars::Config
     refresh
   end
   
-  def init
+  def caesars_init
     # Remove instance variables used to populate DSL data
     instance_variables.each do |varname|
       next if varname == :'@options' || varname == :'@paths'  # Ruby 1.9.1
@@ -373,7 +422,7 @@ class Caesars::Config
   end
   
   def refresh
-    init 
+    caesars_init
     
     @paths.each do |path|
       puts "Loading config from #{path}" if @verbose 
@@ -390,9 +439,10 @@ class Caesars::Config
         
         postprocess
         
-      rescue SyntaxError => ex
+      rescue ArgumentError, SyntaxError => ex
         puts "Syntax error in #{path}."
         puts ex.message
+        puts ex.backtrace if Caesars.debug?
         exit 1
       end
     end
@@ -429,5 +479,3 @@ end
 
 
 
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: delano-caesars
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-31 00:00:00 -07:00
+date: 2009-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: []