caesars 0.3.2

data/CHANGES.txt

@@ -0,0 +1,25 @@
+CAESAR -- CHANGES
+
+
+#### 0.3.2 (2009-03-04) ###############################
+
+* FIX: 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
+          and makes it possible to use several DSLs in the same
+          namespace. 
+
+
+#### 0.3.1 (2009-03-04) ###############################
+
+* NEW: Accept instances without a name
+* CHANGE: Updated examples. 
+* NEW: More rdocs. 
+
+
+
+#### 0.3 (2009-03-04) ###############################
+
+Initial public release
+

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Delano Mandelbaum
+
+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,139 @@
+= Caesars - v0.3
+
+A simple class for rapid DSL prototyping in Ruby.
+
+NOTE: Currently runs only with Ruby 1.9+!
+
+== Installation
+
+One of:
+
+* gem install caesars
+* copy lib/caesars.rb into your lib directory. 
+
+Or for GitHub fans:
+
+* git clone git://github.com/delano/caesar.git
+* gem sources -a http://gems.github.com (you only have to do this once, ever...), then:
+  * gem install delano-caesar
+
+		
+== Usage
+         
+
+     # ------------------------------------------------------------------
+     #   EXAMPLE 1 -- Flavour
+     # 
+     
+     class Flavour < Caesars  # Subclass Caesars. 
+     end
+     
+     extend Flavour::DSL     # Bring the DSL into the current namespace. 
+                             # This module is created dynamically based
+                             # on the name of the subclass.
+                                  
+     flavour do              # Start drinking! I mean, start writing your
+       spicy true            # domain specific language! 
+       clamy true            # Use any attribute name you want.
+       salty true
+       vodka :very_true      # And any value you want. 
+     end
+     
+     p @flavour              # => #<Flavour:0x3f56b0 ...>
+     p @flavour.spicy        # => true
+     
+     
+     
+     # ------------------------------------------------------------------
+     # EXAMPLE 2 -- Staff
+     #
+     
+     # Tell Caesars which attributes have children using Caesars#bloody and 
+     # which have blocks that you want to execute later using Caesars#virgin.
+     class Staff < Caesars 
+       bloody :location
+       bloody :person
+       virgin :calculate
+     end
+     
+     extend Staff::DSL
+     
+     # The top level method is the lower case name of the class. For deeper
+     # names like Class::SecondLevel it will use the final name 
+     # (i.e. secondlevel). You can supply an optional modifier name which 
+     # 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)
+           rate "9.35/h"
+           calculate :salary do |gumption|
+             ("%.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
+           end
+         end
+       end
+     end
+     
+     p @staff_fte                    # => #<KitchenStaff: ...>
+     p @staff_fte.desc               # => Our hard-working, "full-time" staff
+     
+     # Deeper attributes are also available via instance methods
+     p @staff_fte.splashdown.delano  # => {:role=>:cook, :rate=>"$8.35/h", :satisfaction=>:low}
+     p @staff_fte.splashdown.sheila  # => {:role=>:manager, :catchphrase=>"This gravy tastes like food I ate in a Mexican prison."}
+     p @staff_fte.splashdown.steve   # => {:role=>[:manager, :cook], :anger=>:high, :catchphrase=>"Rah! [strokes goatee]"}
+     p @staff_fte.splashdown.delano.satisfaction   # => :low
+     
+     # You can also access them using hash syntax
+     p @staff_fte.splashdown[:steve][:role]  # => [:manager, :cook]
+     
+     # The "bloody" attributes keep track of all values that are used. These are available as arrays
+     # via "NAME_values" methods. The goes for the virgin ones. 
+     p @staff_fte.location_values    # => [:splashdown]
+     p @staff_fte.person_values.uniq # => [:steve, :sheila, :delano, :angela]
+     p @staff_fte.calculate_values   # => [:salary, :salary]
+     
+     # The "virgin" methods store their blocks as Procs and are not executed automatically. 
+     # 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
+
+
+
+== More Info
+
+* GitHub[http://github.com/delano/caesar]
+* Inspiration[http://www.youtube.com/watch?v=ycElb0tB9_U]
+* Recipe[http://twitter.com/solutious/status/1264327499]
+
+== Credits
+
+* Delano Mandelbaum (delano@solutious.com)
+
+== Thanks
+
+* Clams, Tomatoes, Vodka, and the rest of the crew. 
+
+== License
+
+See: LICENSE.txt

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'hanna/rdoctask'
+require 'fileutils'
+include FileUtils
+ 
+task :default => :package
+ 
+# SPECS ===============================================================
+ 
+# None-yet!
+
+# PACKAGE =============================================================
+
+name = "caesars"
+load "#{name}.gemspec"
+
+version = @spec.version
+
+Rake::GemPackageTask.new(@spec) do |p|
+  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :release => [ :rdoc, :package ]
+
+task :install => [ :rdoc, :package ] do
+	sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [ :clean ] do
+	sh %{sudo gem uninstall #{name}}
+end
+
+
+# Rubyforge Release / Publish Tasks ==================================
+
+desc 'Publish website to rubyforge'
+task 'publish:rdoc' => 'doc/index.html' do
+  sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
+end
+
+task 'publish:gem' => [:package] do |t|
+  sh <<-end
+    rubyforge add_release -o Any -a CHANGES.txt -f -n README.rdoc #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+    rubyforge add_file -o Any -a CHANGES.txt -f -n README.rdoc #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
+  end
+end
+
+
+Rake::RDocTask.new do |t|
+	t.rdoc_dir = 'doc'
+	t.title    = @spec.summary
+	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+	t.options << '--charset' << 'utf-8'
+	t.rdoc_files.include('LICENSE.txt')
+	t.rdoc_files.include('README.rdoc')
+	t.rdoc_files.include('CHANGES.txt')
+	t.rdoc_files.include('bin/*')
+	t.rdoc_files.include('lib/*.rb')
+end
+
+CLEAN.include [ 'pkg', '*.gem', '.config', 'doc' ]
+
+
+

data/bin/example

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+#
+# Caesars Example
+#
+# Usage: bin/example
+#
+
+$:.unshift(File.join(File.join(File.dirname(__FILE__), '..'), 'lib')) # Make sure our local lib is first in line
+
+require 'caesars'
+
+# ------------------------------------------------------------------
+#   EXAMPLE 1 -- Flavour
+# 
+
+class Flavour < Caesars  # Subclass Caesars. 
+end
+
+extend Flavour::DSL     # Bring the DSL into the current namespace. 
+                        # This module is created dynamically based
+                        # on the name of the subclass.
+                             
+flavour do              # Start drinking! I mean, start writing your
+  spicy true            # domain specific language! 
+  clamy true            # Use any attribute name you want.
+  salty true
+  vodka :very_true      # And any value you want. 
+end
+
+p @flavour              # => #<Flavour:0x3f56b0 ...>
+p @flavour.spicy        # => true
+
+
+
+# ------------------------------------------------------------------
+# EXAMPLE 2 -- Staff
+#
+
+# Tell Caesars which attributes have children using Caesars#bloody and 
+# which have blocks that you want to execute later using Caesars#virgin.
+class Staff < Caesars
+  bloody :location
+  bloody :person
+  virgin :calculate
+end
+
+extend Staff::DSL
+
+# The top level method is the lower case name of the class. For deeper
+# names like Class::SecondLevel it will use the final name 
+# (i.e. secondlevel). You can supply an optional modifier name which 
+# 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)
+      rate "9.35/h"
+      calculate :salary do |gumption|
+        ("%.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
+      end
+    end
+  end
+end
+
+p @staff_fte                    # => #<KitchenStaff: ...>
+p @staff_fte.desc               # => Our hard-working, "full-time" staff
+
+# Deeper attributes are also available via instance methods
+p @staff_fte.splashdown.delano  # => {:role=>:cook, :rate=>"$8.35/h", :satisfaction=>:low}
+p @staff_fte.splashdown.sheila  # => {:role=>:manager, :catchphrase=>"This gravy tastes like food I ate in a Mexican prison."}
+p @staff_fte.splashdown.steve   # => {:role=>[:manager, :cook], :anger=>:high, :catchphrase=>"Rah! [strokes goatee]"}
+p @staff_fte.splashdown.delano.satisfaction   # => :low
+
+# You can also access them using hash syntax
+p @staff_fte.splashdown[:steve][:role]  # => [:manager, :cook]
+
+# The "bloody" attributes keep track of all values that are used. These are available as arrays
+# via "NAME_values" methods. The goes for the virgin ones. 
+p @staff_fte.location_values    # => [:splashdown]
+p @staff_fte.person_values.uniq # => [:steve, :sheila, :delano, :angela]
+p @staff_fte.calculate_values   # => [:salary, :salary]
+
+# The "virgin" methods store their blocks as Procs and are not executed automatically. 
+# 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/bin/example.bat

@@ -0,0 +1,12 @@
+@echo off
+
+rem Check for funkiness when called from another batch script.
+rem We want FULL_PATH to contain the full path to the stella bin directory. 
+IF EXIST "%~dp0example.bat" (set FULL_PATH=%~dp0) ELSE (set FULL_PATH=%~dp$PATH:0)
+
+rem Check for JRuby, otherwise use Ruby.
+rem We want EXECUTABLE to contain either "jruby" or "ruby"
+IF EXIST "%JRUBY_HOME%" (set EXECUTABLE=jruby) ELSE (set EXECUTABLE=ruby)
+
+rem Call the Ruby script, passing it all the arguments.
+@%EXECUTABLE% %FULL_PATH%example %*

data/caesars.gemspec

@@ -0,0 +1,35 @@
+@spec = Gem::Specification.new do |s|
+  s.name = %q{caesars}
+  s.version = "0.3.2"
+  s.date = %q{2009-03-04}
+  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=
+
+  s.authors = ["Delano Mandelbaum"]
+  s.description = %q{A simple class for rapid DSL prototyping in Ruby.}
+  s.summary = %q{Caesars: A simple class for rapid DSL prototyping in Ruby.}
+  s.email = %q{delano@solutious.com}
+
+  # = MANIFEST =
+  # git ls-files
+  s.files = %w(
+  CHANGES.txt
+  LICENSE.txt
+  README.rdoc
+  Rakefile
+  bin/example
+  bin/example.bat
+  caesars.gemspec
+  lib/caesars.rb
+  )
+
+  #  s.add_dependency ''
+
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/delano/caesar}
+  s.extra_rdoc_files = %w[README.rdoc LICENSE.txt CHANGES.txt]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Caesars: A simple class for rapid DSL prototyping in Ruby.", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.1.1}
+  s.rubyforge_project = "caesars"
+end

data/lib/caesars.rb

@@ -0,0 +1,95 @@
+
+# Caesars -- A simple class for rapid DSL prototyping.
+#
+# Subclass Caesars, then tell it which attributes have children using
+# Caesars.bloody and which have blocks that you want to execute later
+# using Caesars.virgin. That's it! Just start drinking! I mean, start 
+# writing your domain specific language!
+#
+# See README.rdoc for a usage example.
+#
+class Caesars
+  VERSION = "0.3.2"
+  # A subclass of ::Hash that provides method names for hash parameters.
+  # It's like a lightweight OpenStruct. 
+  #     ch = Caesars::Hash[:tabasco => :lots!]
+  #     puts ch.tabasco  # => lots!
+  #
+  class Hash < ::Hash
+    def method_missing(meth)
+      (self.has_key?(meth)) ? self[meth] : nil
+    end
+  end
+    # An instance of Caesars::Hash which contains the data specified by your DSL
+  attr_accessor :caesars_properties
+  # Creates an instance of Caesars. 
+  # +name+ is . 
+  def initialize(name=nil)
+    @caesars_name = name if name
+    @caesars_properties = Caesars::Hash.new
+    @caesars_pointer = @caesars_properties
+  end
+  # This method handles all of the attributes that do not contain blocks. 
+  def method_missing(name, *args, &b)
+    return @caesars_properties[name] if @caesars_properties.has_key?(name) && args.empty? && b.nil?
+    if @caesars_pointer[name]
+      @caesars_pointer[name] = [@caesars_pointer[name]] unless @caesars_pointer[name].is_a?(Array)
+      @caesars_pointer[name] += args
+    elsif !args.empty?
+      @caesars_pointer[name] = args.size == 1 ? args.first : args
+    end
+  end
+  # see bin/example for usage.
+  def self.virgin(meth)
+    self.bloody(meth, false)
+  end
+  # see bin/example for usage.
+  def self.bloody(meth, execute=true)
+    define_method(meth) do |*names,&b|  # |*names,&b| syntax does not parse in Ruby 1.8
+      all = instance_variable_get("@" << meth.to_s) || []
+      
+      names.each do |name|
+        instance_variable_set("@" << meth.to_s, all << name)
+        
+        if execute
+          prev = @caesars_pointer
+          @caesars_pointer[name] ||= Caesars::Hash.new
+          @caesars_pointer = @caesars_pointer[name]
+          b.call if b
+          @caesars_pointer = prev
+        else
+          @caesars_pointer[name] = b
+        end
+        
+      end
+      nil
+    end
+    define_method("#{meth}_values") do ||
+      instance_variable_get("@" << meth.to_s) || []
+    end
+  end
+  # Executes automatically when Caesars is subclassed. This creates the
+  # YourClass::DSL module which contains a single method: method_missing. 
+  # This is used to catch the top level DSL method. That's why you can 
+  # used any method name you like. 
+  def self.inherited(modname)
+    meth = (modname.to_s.split(/::/))[-1].downcase  # Some::ClassName => classname
+    module_eval %Q{
+      module #{modname}::DSL
+        def #{meth}(*args, &b)
+          name = !args.empty? ? args.first.to_s : nil
+          varname = "@#{meth.to_s}"
+          varname << "_\#{name}" if name
+          i = instance_variable_set(varname, #{modname.to_s}.new(name))
+          i.instance_eval(&b) if b
+          i
+        end
+      end
+    }, __FILE__, __LINE__
+  end
+end
+
+
+
+
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: caesars
+version: !ruby/object:Gem::Version 
+  version: 0.3.2
+platform: ruby
+authors: 
+- Delano Mandelbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-04 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A simple class for rapid DSL prototyping in Ruby.
+email: delano@solutious.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+- CHANGES.txt
+files: 
+- CHANGES.txt
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/example
+- bin/example.bat
+- caesars.gemspec
+- lib/caesars.rb
+has_rdoc: true
+homepage: http://github.com/delano/caesar
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- "Caesars: A simple class for rapid DSL prototyping in Ruby."
+- --main
+- README.rdoc
+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: caesars
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 1
+summary: "Caesars: A simple class for rapid DSL prototyping in Ruby."
+test_files: []
+