ceedling 0.0.1

data/new_project_template/vendor/ceedling/vendor/constructor/History.rdoc

@@ -0,0 +1,19 @@
+== 1.0.4 / 2009-12-01
+
+  * Building is now done with Jeweler.
+
+== 1.0.3 / 2009-11-30
+
+  * Quick release to include ConstructorStruct. 
+
+== 1.0.2 / 2008-05-07
+
+  * An error is raised when constructor keys are passed in that already exist in the super class
+
+== 1.0.1 / 2007-12-21
+
+* You can now pass a block to your constructor call; it gets executed after all the ivars get assigned.  (This lets you write some initializer code if you need to.)
+
+== 1.0.0 / 2007-11-18
+
+* Released!

data/new_project_template/vendor/ceedling/vendor/constructor/README.rdoc

@@ -0,0 +1,72 @@
+== Constructor
+
+* http://atomicobject.github.com/constructor
+
+== DESCRIPTION:
+  
+Declarative means to define object properties by passing a hash 
+to the constructor, which will set the corresponding ivars.
+
+== SYNOPSIS:
+
+  require 'constructor'
+
+  class Horse
+    constructor :name, :breed, :weight
+  end
+  Horse.new :name => 'Ed', :breed => 'Mustang', :weight => 342
+
+By default the ivars do not get accessors defined.
+But you can get them auto-made if you want:
+
+  class Horse
+    constructor :name, :breed, :weight, :accessors => true
+  end
+  ...
+  puts my_horse.weight
+ 
+Arguments specified are required by default.  You can disable 
+strict argument checking with :strict option.  This means that 
+the constructor will not raise an error if you pass more or 
+fewer arguments than declared.
+
+  class Donkey
+    constructor :age, :odor, :strict => false
+  end
+
+... this allows you to pass either an age or odor key (or neither)
+to the Donkey constructor.
+
+
+== REQUIREMENTS:
+
+* rubygems
+
+== INSTALL:
+
+* sudo gem install constructor
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Atomic Object
+
+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/new_project_template/vendor/ceedling/vendor/constructor/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+
+desc 'Default: run specs'
+task :default => :spec
+
+require 'spec/rake/spectask'
+desc 'Run constructor specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['specs/*_spec.rb']
+  t.spec_opts << '-c -f s'
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    $: << "lib"
+    require 'constructor.rb'
+    gemspec.name = 'constructor'
+    gemspec.version = CONSTRUCTOR_VERSION
+    gemspec.summary = 'Declarative named-argument object initialization.'
+    gemspec.description = 'Declarative means to define object properties by passing a hash to the constructor, which will set the corresponding ivars.'
+    gemspec.homepage = 'http://atomicobject.github.com/constructor'
+    gemspec.authors = 'Atomic Object'
+    gemspec.email = 'github@atomicobject.com'
+    gemspec.test_files = FileList['specs/*_spec.rb']
+  end
+
+  Jeweler::GemcutterTasks.new
+
+rescue LoadError
+  puts "(jeweler not installed)"
+end
+

data/new_project_template/vendor/ceedling/vendor/constructor/homepage/Notes.txt

@@ -0,0 +1,27 @@
+Wed Nov 21 21:49:27 EST 2007
+crosby
+
+1. Edit page_header.graffle
+2. Export as HTML imagemap
+3. Open ../sample_code/synopsis.rb
+4. Screen shot, save as sample_code.png
+5. rake (rewrites index.html)
+6. cd ..
+7. rake publish_docs
+
+page_header.graffle
+  Export-as-HTML-Imagemap
+  Use png
+  Use 125% scale
+  Remember to use the style inspector to assign actions to things that should be links.
+
+rake index
+  Rewrites index.html using index.erb and page_header.html (and some values in the Rakefile)
+
+The code sample screenshot:
+  Taken with Snapz Pro X (this is important, as Snapz is providing the
+  dropshadow and about 28 extra pixels widthwise)
+
+  Should be 650 px wide to line up with the page header.
+
+  Transparency: be conscious of WHAT'S IN THE BACKGROUND

data/new_project_template/vendor/ceedling/vendor/constructor/homepage/Rakefile

@@ -0,0 +1,15 @@
+desc "Rewrite index.html using index.erb and publisher_homepage.html"
+task :index do
+  require 'erb'
+  @title = "Constructor - atomicobject.rb"
+  @plugin_install = "$ script/plugin install svn://rubyforge.org/var/svn/atomicobjectrb/tags/constructor"
+  @header_html = File.read("page_header.html")
+  html = ERB.new(File.read("index.erb")).result(binding)
+  fname = "index.html"
+  File.open(fname,"w") do |f|
+    f.print html
+  end
+  puts "Wrote #{fname}"
+end
+
+task :default => :index

data/new_project_template/vendor/ceedling/vendor/constructor/homepage/index.erb

@@ -0,0 +1,27 @@
+<html>
+  <head>
+    <title><%= @title %></title>
+  </head>
+  <style>
+  #rails_plugin_installation {
+    padding: 5px;
+    margin-bottom: 10px;
+    font: bold 10pt "Courier New", courier, serif
+  }
+  </style>
+
+  <body>
+
+    <div align="center">
+
+      <%= @header_html  %>
+
+      <div id="rails_plugin_installation"><%= @plugin_install %></div>
+
+      <a href="rdoc/index.html"><img border=0 src="sample_code.png"></a>
+    </div>
+
+
+
+  </body>
+</html>

data/new_project_template/vendor/ceedling/vendor/constructor/homepage/index.html

@@ -0,0 +1,36 @@
+<html>
+  <head>
+    <title>Constructor - atomicobject.rb</title>
+  </head>
+  <style>
+  #rails_plugin_installation {
+    padding: 5px;
+    margin-bottom: 10px;
+    font: bold 10pt "Courier New", courier, serif
+  }
+  </style>
+
+  <body>
+
+    <div align="center">
+
+      <map name="GraffleExport">
+	<area shape=rect coords="486,91,635,108" href="http://atomicobjectrb.rubyforge.org/">
+	<area shape=rect coords="485,120,635,187" href="rdoc/index.html">
+	<area shape=rect coords="310,120,463,187" href="http://rubyforge.org/frs/?group_id=4897&release_id=16546">
+	<area shape=rect coords="14,91,168,108" href="http://atomicobject.com">
+	<area shape=rect coords="572,16,627,71" href="http://atomicobjectrb.rubyforge.org/">
+	<area shape=rect coords="21,13,83,75" href="http://atomicobject.com">
+</map>
+<img border=0 src="page_header.png" usemap="#GraffleExport">
+
+
+      <div id="rails_plugin_installation">$ script/plugin install svn://rubyforge.org/var/svn/atomicobjectrb/tags/constructor</div>
+
+      <a href="rdoc/index.html"><img border=0 src="sample_code.png"></a>
+    </div>
+
+
+
+  </body>
+</html>

data/new_project_template/vendor/ceedling/vendor/constructor/homepage/page_header.html

@@ -0,0 +1,9 @@
+<map name="GraffleExport">
+	<area shape=rect coords="486,91,635,108" href="http://atomicobjectrb.rubyforge.org/">
+	<area shape=rect coords="485,120,635,187" href="rdoc/index.html">
+	<area shape=rect coords="310,120,463,187" href="http://rubyforge.org/frs/?group_id=4897&release_id=16546">
+	<area shape=rect coords="14,91,168,108" href="http://atomicobject.com">
+	<area shape=rect coords="572,16,627,71" href="http://atomicobjectrb.rubyforge.org/">
+	<area shape=rect coords="21,13,83,75" href="http://atomicobject.com">
+</map>
+<img border=0 src="page_header.png" usemap="#GraffleExport">

data/new_project_template/vendor/ceedling/vendor/constructor/homepage/sample_code.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'constructor'
+
+class Horse
+  constructor :name, :breed, :weight, :accessors => true
+end
+
+ed = Horse.new(:name => 'Ed', :breed => 'Mustang', :weight => 342)
+puts ed.name
+puts ed.breed
+puts ed.weight
+

data/new_project_template/vendor/ceedling/vendor/constructor/lib/constructor.rb

@@ -0,0 +1,127 @@
+CONSTRUCTOR_VERSION = '1.0.4' #:nodoc:#
+
+class Class #:nodoc:#
+  def constructor(*attrs, &block)
+    call_block = ''
+    if block_given?
+      @constructor_block = block
+      call_block = 'self.instance_eval(&self.class.constructor_block)'
+    end
+    # Look for embedded options in the listing:
+    opts = attrs.find { |a| a.kind_of?(Hash) and attrs.delete(a) } 
+    do_acc = opts.nil? ? false : opts[:accessors] == true
+    do_reader = opts.nil? ? false : opts[:readers] == true
+    require_args = opts.nil? ? true : opts[:strict] != false
+    super_args = opts.nil? ? nil : opts[:super]
+
+    # Incorporate superclass's constructor keys, if our superclass
+    if superclass.constructor_keys
+      similar_keys = superclass.constructor_keys & attrs
+      raise "Base class already has keys #{similar_keys.inspect}" unless similar_keys.empty?
+      attrs = [attrs,superclass.constructor_keys].flatten
+    end
+    # Generate ivar assigner code lines
+    assigns = ''
+    attrs.each do |k|
+      assigns += "@#{k.to_s} = args[:#{k.to_s}]\n"
+    end 
+
+    # If accessors option is on, declare accessors for the attributes:
+    if do_acc
+      add_accessors = "attr_accessor " + attrs.reject {|x| superclass.constructor_keys.include?(x.to_sym)}.map {|x| ":#{x.to_s}"}.join(',')
+      #add_accessors = "attr_accessor " + attrs.map {|x| ":#{x.to_s}"}.join(',')
+      self.class_eval add_accessors
+    end
+
+    # If readers option is on, declare readers for the attributes:
+    if do_reader
+      self.class_eval "attr_reader " + attrs.reject {|x| superclass.constructor_keys.include?(x.to_sym)}.map {|x| ":#{x.to_s}"}.join(',')
+    end
+    
+    # If user supplied super-constructor hints:
+    super_call = ''
+    if super_args
+      list = super_args.map do |a|
+        case a
+        when String
+          %|"#{a}"|
+        when Symbol
+          %|:#{a}|
+        end
+      end
+      super_call  = %|super(#{list.join(',')})|
+    end
+
+    # If strict is on, define the constructor argument validator method,
+    # and setup the initializer to invoke the validator method.
+    # Otherwise, insert lax code into the initializer.
+    validation_code = "return if args.nil?"
+    if require_args
+      self.class_eval do 
+        def _validate_constructor_args(args)
+          # First, make sure we've got args of some kind
+          unless args and args.keys and args.keys.size > 0 
+            raise ConstructorArgumentError.new(self.class.constructor_keys)
+          end
+          # Scan for missing keys in the argument hash
+          a_keys = args.keys
+          missing = []
+          self.class.constructor_keys.each do |ck|
+            unless a_keys.member?(ck)
+              missing << ck
+            end
+            a_keys.delete(ck) # Delete inbound keys as we address them
+          end
+          if missing.size > 0 || a_keys.size > 0
+            raise ConstructorArgumentError.new(missing,a_keys)
+          end
+        end
+      end
+      # Setup the code to insert into the initializer:
+      validation_code = "_validate_constructor_args args "
+    end
+
+    # Generate the initializer code
+    self.class_eval %{
+      def initialize(args=nil)
+        #{super_call}
+        #{validation_code}
+        #{assigns}
+        setup if respond_to?(:setup)
+        #{call_block}
+      end
+    }
+
+    # Remember our constructor keys
+    @_ctor_keys = attrs
+  end
+
+  # Access the constructor keys for this class
+  def constructor_keys; @_ctor_keys ||=[]; end
+
+  def constructor_block #:nodoc:#
+    @constructor_block
+  end
+
+end
+
+# Fancy validation exception, based on missing and extraneous keys.
+class ConstructorArgumentError < RuntimeError #:nodoc:#
+  def initialize(missing,rejected=[])
+    err_msg = ''
+    if missing.size > 0
+      err_msg = "Missing constructor args [#{missing.join(',')}]"
+    end
+    if rejected.size > 0
+      # Some inbound keys were not addressed earlier; this means they're unwanted
+      if err_msg
+        err_msg << "; " # Appending to earlier message about missing items
+      else
+        err_msg = ''
+      end
+      # Enumerate the rejected key names
+      err_msg << "Rejected constructor args [#{rejected.join(',')}]"
+    end
+    super err_msg
+  end
+end

data/new_project_template/vendor/ceedling/vendor/constructor/lib/constructor_struct.rb

@@ -0,0 +1,33 @@
+class ConstructorStruct
+  def self.new(*accessors, &block)
+    defaults = {:accessors => true, :strict => false}
+    
+    accessor_names = accessors.dup
+    if accessors.last.is_a? Hash
+      accessor_names.pop
+      user_opts = accessors.last
+      user_opts.delete(:accessors)
+      defaults.each do |k,v|
+        user_opts[k] ||= v
+      end
+    else
+      accessors << defaults
+    end
+    
+    Class.new do
+      constructor *accessors
+
+      class_eval(&block) if block
+
+      comparator_code = accessor_names.map { |fname| "self.#{fname} == o.#{fname}" }.join(" && ")
+      eval %|
+        def ==(o)
+          (self.class == o.class) && #{comparator_code}
+        end
+        def eql?(o)
+          (self.class == o.class) && #{comparator_code}
+        end
+      |
+    end
+  end
+end