doodle 0.0.10 → 0.1.0

data/CREDITS

@@ -0,0 +1,22 @@
+Doodle grew out of my response to Ruby Quiz 49 - "Lisp
+Game":[http://www.rubyquiz.com/quiz49.html] and is in effect a ~very~
+late entry to the justly renowned Quiz 67 -
+"metakoans":[http://www.rubyquiz.com/quiz67.html]. I learnt a lot from
+the answers to that quiz, in particular Christian Neukirchen's and
+Florian Gross's solutions (though I took a different path). I've also
+been inspired by Ara Howard's traits and attributes libraries.
+
+== Similar and related libraries
+
+* traits[http://www.codeforpeople.com/lib/ruby/traits/]
+* attributes[http://www.codeforpeople.com/lib/ruby/attributes/]
+
+== Thanks
+
+*doodle* is developed using
+BDD[http://en.wikipedia.org/wiki/Behavior_driven_development] with
+RSpec[http://rspec.rubyforge.org/], autotest (part of the
+ZenTest[http://www.zenspider.com/ZSS/Products/ZenTest/] suite) and
+rcov[http://eigenclass.org/hiki.rb?rcov]. Thanks for the fantastic
+tools guys!
+

data/{ChangeLog → History.txt}

@@ -1,8 +1,27 @@
-= ChangeLog for doodle
+== 0.1.0 / 2008-04-26
+- doodle's first beta version - the API should remain stable from now on
+- created a Google group: http://groups.google.com/group/ruby-doodle
+- major change: changed Doodle from module to class so you now use
+    class Foo < Doodle
+  instead of 
+    class Foo < Doodle::Base
+- Doodle::Helper renamed Doodle::Core
+- added #parent method - returns outer object in initialization blocks
+  (see spec/doodle_context_spec for example usage)
+- fixed class and singleton attribute inheritance
+- rake spec now passes all specs with ruby 1.8.6, ruby 1.9.0 and JRuby 1.1.1
+- added more specs
+- added lib/doodle/utils.rb (used by examples)
+- removed (half-hearted) support for 1.8.5
+- removed redundant methods & excised some cruft
+- refactored project to use newgem
+
+== 0.0.11 / 2008-04-13
+- refactored attributes and conversions
 
 == 0.0.10 / 2008-04-13
-- fixed bug in class attribute initialization
-	
+- fixed bug with setting class and singleton attributes & added spec
+
 == 0.0.9 / 2008-04-12
 
 - new features:

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sean O'Halpin
+
+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/Manifest.txt

@@ -0,0 +1,61 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+CREDITS
+Rakefile
+config/hoe.rb
+config/requirements.rb
+examples/smtp_tls.rb
+examples/example-01.rdoc
+examples/profile-options.rb
+examples/doodle-errors.rb
+examples/event-location.rb
+examples/parent.rb
+examples/example-02.rb
+examples/example-02.rdoc
+examples/example-01.rb
+examples/mail.rb
+examples/yaml-example2.rb
+examples/yaml-example.rb
+examples/test-datatypes.rb
+examples/mail-datatypes.rb
+lib/doodle.rb
+lib/molic_orderedhash.rb
+lib/doodle/datatypes.rb
+lib/doodle/rfc822.rb
+lib/doodle/utils.rb
+lib/doodle/version.rb
+log/debug.log
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/arg_order_spec.rb
+spec/attributes_spec.rb
+spec/bugs_spec.rb
+spec/class_spec.rb
+spec/class_var_spec.rb
+spec/collector_spec.rb
+spec/conversion_spec.rb
+spec/defaults_spec.rb
+spec/doodle_context_spec.rb
+spec/doodle_spec.rb
+spec/extra_args_spec.rb
+spec/factory_spec.rb
+spec/flatten_first_level_spec.rb
+spec/init_spec.rb
+spec/new_doodle_spec.rb
+spec/required_spec.rb
+spec/serialization_spec.rb
+spec/singleton_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/superclass_spec.rb
+spec/validation_spec.rb
+spec/validation2_spec.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake

data/README.txt

@@ -0,0 +1,166 @@
+= doodle
+
+* http://doodle.rubyforge.org
+
+== DESCRIPTION:
+
+Doodle is a Ruby library for simplifying the definition of Ruby
+classes by making attributes and their properties more declarative.
+
+Doodle is eco-friendly: it does not globally modify Object, Class or
+Module, nor does it pollute instances with its own instance variables
+(i.e. it plays nice with yaml).
+
+Doodle has been tested with Ruby 1.8.6 and JRuby 1.1. It does not yet
+work with Ruby 1.9 or Rubinius.
+
+Please feel free to post bug reports, feature requests, and any
+comments or discussion topics to the doodle Google group: 
+http://groups.google.com/group/ruby-doodle
+
+== FEATURES:
+
+* initialization
+  * using positional arguments
+  * with named arguments
+  * by block
+* defaults
+* initial values
+* validation at attribute and class levels
+* conversions for attributes and classes
+* collectors to help in defining simple DSLs
+* works for classes, instances and singletons
+
+== SYNOPSIS:
+
+=== Example 1
+
+  require 'rubygems'
+  require 'date'
+  require 'doodle'
+
+  class DateRange < Doodle 
+    has :start_date do
+      default { Date.today }
+    end
+    has :end_date do
+      default { start_date }
+    end
+  end
+
+  dr = DateRange.new
+  dr.start_date                   # => #<Date: 4909159/2,0,2299161>
+  dr.end_date                     # => #<Date: 4909159/2,0,2299161>
+
+=== Example 2
+
+  require 'rubygems'
+  require 'date'
+  require 'doodle'
+  require 'doodle/utils' # for try
+
+  class DateRange < Doodle 
+    has :start_date, :kind => Date do
+      default { Date.today }
+      from String do |s|
+        Date.parse(s)
+      end
+      must "be >= 2000-01-01" do |d|
+        d >= Date.parse('2000-01-01')
+      end
+    end
+    has :end_date do
+      default { start_date }
+      from String do |s|
+        Date.parse(s)
+      end
+    end
+    must 'have end_date >= start_date' do
+      end_date >= start_date
+    end
+    from String do |s|
+      m = /(\d{4}-\d{2}-\d{2})\s*(?:to|-|\s)\s*(\d{4}-\d{2}-\d{2})/.match(s)
+      if m
+        self.new(*m.captures)
+      else
+        raise Exception, "Cannot parse date: '#{s}'"
+      end
+    end
+  end
+
+  dr = DateRange.new '2007-12-31', '2008-01-01'
+  dr.start_date                   # => #<Date: 4908931/2,0,2299161>
+  dr.end_date                     # => #<Date: 4908933/2,0,2299161>
+
+  dr = DateRange '2007-12-31', '2008-01-01'
+  dr.start_date                   # => #<Date: 4908931/2,0,2299161>
+  dr.end_date                     # => #<Date: 4908933/2,0,2299161>
+
+  dr = DateRange :start_date => '2007-12-31', :end_date => '2008-01-01'
+  dr.start_date                   # => #<Date: 4908931/2,0,2299161>
+  dr.end_date                     # => #<Date: 4908933/2,0,2299161>
+
+  dr = DateRange do
+    start_date '2007-12-31'
+    end_date '2008-01-01'
+  end
+  dr.start_date                   # => #<Date: 4908931/2,0,2299161>
+  dr.end_date                     # => #<Date: 4908933/2,0,2299161>
+
+
+  dr = DateRange.from '2007-01-01 to 2008-12-31'
+  dr.start_date                   # => #<Date: 4908203/2,0,2299161>
+  dr.end_date                     # => #<Date: 4909663/2,0,2299161>
+
+  dr = DateRange.from '2007-01-01 2007-12-31'
+  dr.start_date                   # => #<Date: 4908203/2,0,2299161>
+  dr.end_date                     # => #<Date: 4908931/2,0,2299161>
+
+  p try {
+    dr = DateRange.from 'Hello World'
+    dr.start_date                   # => 
+    dr.end_date                     # => 
+  }
+
+  p try {
+    dr = DateRange '2008-01-01', '2007-12-31' 
+    dr.start_date                   # => 
+    dr.end_date                     # => 
+  }
+  # >> #<Doodle::ConversionError: Cannot parse date: 'Hello World'>
+  # >> #<Doodle::ValidationError: DateRange must have end_date >= start_date>
+
+== INSTALL:
+
+* Linux/Mac OS X
+
+  $ sudo gem install doodle
+
+* Windows
+
+  C:\> gem install doodle
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Sean O'Halpin
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,77 @@
+require 'doodle/version'
+
+AUTHOR = "Sean O'Halpin"  # can also be an array of Authors
+EMAIL = "sean.ohalpin@gmail.com"
+DESCRIPTION = "Doodle is a gem for simplifying the definition of Ruby classes by
+making attributes and their properties more declarative. Doodle is
+eco-friendly: it does not globally modify Object, Class or Module."
+
+GEM_NAME = 'doodle' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'doodle' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Doodle::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'doodle documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["spec/**/*_spec.rb"]
+#  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+  
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/examples/doodle-errors.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'doodle'
+require 'doodle/utils'
+require 'pp'
+
+class Foo < Doodle
+  has :name, :kind => String
+end
+
+params = {
+  :name => 1,
+  :extra => 42
+}
+
+rv = try {
+  foo = Foo(params)
+}
+pp rv
+
+rv = try {
+  Doodle.raise_exception_on_error = false
+  foo = Foo(params)
+  foo.errors
+}
+pp rv

data/examples/event-location.rb

@@ -5,14 +5,14 @@ require 'doodle'
 require "yaml"
 require "pp"
 
-class Location < Doodle::Base
+class Location < Doodle
   has :name, :kind => String
   has :events, :init => [], :collect => :Event
 end
 
 class Event
   # or if you want to inherit from another class
-  include Doodle::Helper
+  include Doodle::Core
   include Doodle::Factory
 
   has :name, :kind => String
@@ -26,11 +26,7 @@ class Event
       Date.parse(s)
     end
   end
-  has :locations, :init => [], :collect => {:place => "Location"} do
-    from Array do |array|
-      array.map{|x| Location(x)}
-    end
-  end
+  has :locations, :collect => {:place => :Location}
 end  
 
 event = Event "Festival" do