constructor 1.0.4 → 2.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+Gemfile.lock
+pkg
+doc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in constructor.gemspec
+gemspec

data/History.rdoc

@@ -1,3 +1,8 @@
+== 2.0 / 2010-12-27
+
+  * Now uses an included module with an initialize method instead of a class_eval-ed initialize to better handle inheritance and mixins, and to simplify the code.
+  * Removed Jeweler, replaced with Bundler
+  
 == 1.0.4 / 2009-12-01
 
   * Building is now done with Jeweler.

data/README.rdoc

@@ -50,7 +50,7 @@ to the Donkey constructor.
 
 (The MIT License)
 
-Copyright (c) 2007 Atomic Object
+Copyright (c) 2007-2010 Atomic Object
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,33 +1,27 @@
 require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+begin
+  require 'rake/rdoctask'
+  require 'spec/rake/spectask'
+rescue
+  puts "You need to: bundle install"
+end
 
 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
-
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'constructor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('History.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/constructor.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "constructor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "constructor"
+  s.version     = Constructor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Atomic Object"]
+  s.email       = ["github@atomicobject.com"]
+  s.homepage    = "http://atomicobject.github.com/constructor"
+  s.summary     = %q{Declarative named-argument object initialization.}
+  s.description = %q{Declarative means to define object properties by passing a hash to the constructor, which will set the corresponding ivars.}
+
+  s.rubyforge_project = "constructor"
+
+  s.files         = `git ls-files`.split("\n").reject {|f| f =~ /homepage/}
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency "rspec", ">= 1", "<= 1.3.1"
+  s.add_development_dependency "rake", ">= 0.8.7"
+end

data/lib/constructor.rb

@@ -1,127 +1,48 @@
-CONSTRUCTOR_VERSION = '1.0.4' #:nodoc:#
+require 'constructor/constructor'
 
-class Class #:nodoc:#
+class Class 
+  def _constructor_config #:nodoc:#
+    # Inherit an existing config from an ancestor if possible
+    @constructor_config ||= (@constructor_config ? @constructor_config : (superclass ? superclass._constructor_config.dup : nil)) || {}
+  end
+  
+  # Access the constructor keys for this class
+  def constructor_keys 
+    # Inherit keys from an ancestor if possible
+    @_ctor_keys ||= (@_ctor_keys ? @_ctor_keys : (superclass ? superclass.constructor_keys.dup : nil)) || []
+  end
+  
+  # Defines an initialize method for the class that expects a hash
+  # of named arguments
+  #
+  #
+  #   class Horse
+  #     construct :name, :breed, :weight
+  #   end
+  #   Horse.new :name => 'Ed', :breed => 'Mustang', :weight => 342
   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
+    if superclass.constructor_keys.any?
       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 "
+    # Look for embedded options in the listing:
+    opts = attrs.find { |a| a.kind_of?(Hash) and attrs.delete(a) }
+    do_accessors = opts.nil? ? false : opts[:accessors] == true
+    do_readers = opts.nil? ? false : opts[:readers] == true
+    _constructor_config[:require_args] = opts.nil? ? true : opts[:strict] != false
+    _constructor_config[:super_args] = opts.nil? ? nil : opts[:super]
+    if block_given?
+      _constructor_config[:constructor_block] = block
     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
+    attr_accessor(*attrs) if do_accessors
+    attr_reader(*attrs) if do_readers
+    
+    # Remember all constructor keys
+    @_ctor_keys = [attrs,superclass.constructor_keys].flatten
+    
+    # Build the new initialize method
+    include Constructor
   end
 end

data/lib/constructor/constructor.rb

@@ -0,0 +1,59 @@
+module Constructor #:nodoc:#
+  def initialize(args = nil)
+    config = self.class._constructor_config
+    super(*config[:super_args]) if config[:super_args] && defined?(super)
+    
+    keys = self.class.constructor_keys
+    if config[:require_args]
+      # First, make sure we've got args of some kind
+      unless args and args.keys and args.keys.size > 0 
+        raise ArgumentError.new(keys)
+      end
+      # Scan for missing keys in the argument hash
+      a_keys = args.keys
+      missing = []
+      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 ArgumentError.new(missing,a_keys)
+      end
+    end
+    
+    if args
+      keys.each do |key|
+        instance_variable_set "@#{key}", args[key]
+      end
+    end
+    
+    setup if respond_to?(:setup)
+    
+    if config[:constructor_block]
+      instance_eval(&config[:constructor_block])
+    end
+  end
+  
+  # Fancy validation exception, based on missing and extraneous keys.
+  class ArgumentError < 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
+end

data/lib/constructor/version.rb

@@ -0,0 +1,3 @@
+module Constructor
+  VERSION = "2.0.0"
+end

data/{specs → spec}/constructor_spec.rb

@@ -191,12 +191,12 @@ describe 'stict mode usage' do
     # Omit foo
     lambda {
       TestingStrictArgsDefault.new :bar => 'ok,yeah'
-    }.should raise_error(ConstructorArgumentError, /foo/)
+    }.should raise_error(Constructor::ArgumentError, /foo/)
     
     # Omit bar
     lambda {
       TestingStrictArgsDefault.new :foo => 'ok,yeah'
-    }.should raise_error(ConstructorArgumentError, /bar/)
+    }.should raise_error(Constructor::ArgumentError, /bar/)
   end
 
   it 'defaults to strict argument enforcement' do
@@ -208,16 +208,16 @@ describe 'stict mode usage' do
   end
 
   it 'does not allow empty constructor arguments when strict option is true' do
-    lambda {TestingStrictArgs.new {}}.should raise_error(ConstructorArgumentError,/foo,bar/)
-    lambda {TestingStrictArgs.new}.should raise_error(ConstructorArgumentError,/foo,bar/)
-    lambda {TestingStrictArgs.new nil}.should raise_error(ConstructorArgumentError,/foo,bar/)
+    lambda {TestingStrictArgs.new {}}.should raise_error(Constructor::ArgumentError,/foo,bar/)
+    lambda {TestingStrictArgs.new}.should raise_error(Constructor::ArgumentError,/foo,bar/)
+    lambda {TestingStrictArgs.new nil}.should raise_error(Constructor::ArgumentError,/foo,bar/)
   end
 
   it 'does not allow extraneous arguments when strict option is true' do
     [ /thing/, /other/ ].each do |rejected_arg|
       lambda {
         TestingStrictArgs.new(:foo => 1, :bar => 2, :other => 3, :thing => 4)
-      }.should raise_error(ConstructorArgumentError, rejected_arg)
+      }.should raise_error(Constructor::ArgumentError, rejected_arg)
     end
   end
 
@@ -229,16 +229,16 @@ describe 'stict mode usage' do
     t2.bar.should eql(2)
 
     # See that strictness still applies
-    lambda {TestingStrictArgs2.new :no => 'good'}.should raise_error(ConstructorArgumentError)
+    lambda {TestingStrictArgs2.new :no => 'good'}.should raise_error(Constructor::ArgumentError)
   end
 end
 
-describe 'catching ConstructorArgumentError' do
+describe 'catching Constructor::ArgumentError' do
   it 'allows for generic rescuing of constructor argument errors' do
     begin
       TestingStrictArgs.new :broken => 'yoobetcha'
     rescue => bad_news
-      bad_news.should be_kind_of(ConstructorArgumentError)
+      bad_news.should be_kind_of(Constructor::ArgumentError)
     end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: constructor
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  hash: 15
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Atomic Object
@@ -9,63 +15,103 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 -05:00
+date: 2010-12-30 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        version: "1"
+    - - <=
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  name: rake
+  prerelease: false
+  version_requirements: *id002
 description: Declarative means to define object properties by passing a hash to the constructor, which will set the corresponding ivars.
-email: github@atomicobject.com
+email: 
+- github@atomicobject.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- Gemfile
 - History.rdoc
 - README.rdoc
 - Rakefile
-- homepage/Notes.txt
-- homepage/Rakefile
-- homepage/index.erb
-- homepage/index.html
-- homepage/page_header.graffle
-- homepage/page_header.html
-- homepage/page_header.png
-- homepage/sample_code.png
-- homepage/sample_code.rb
+- constructor.gemspec
 - lib/constructor.rb
+- lib/constructor/constructor.rb
+- lib/constructor/version.rb
 - lib/constructor_struct.rb
-- specs/constructor_spec.rb
-- specs/constructor_struct_spec.rb
+- spec/constructor_spec.rb
+- spec/constructor_struct_spec.rb
 has_rdoc: true
 homepage: http://atomicobject.github.com/constructor
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: constructor
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Declarative named-argument object initialization.
 test_files: 
-- specs/constructor_spec.rb
-- specs/constructor_struct_spec.rb
+- spec/constructor_spec.rb
+- spec/constructor_struct_spec.rb

data/homepage/Notes.txt

@@ -1,27 +0,0 @@
-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/homepage/Rakefile

@@ -1,15 +0,0 @@
-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/homepage/index.erb

@@ -1,27 +0,0 @@
-<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/homepage/index.html

@@ -1,36 +0,0 @@
-<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/homepage/page_header.html

@@ -1,9 +0,0 @@
-<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/homepage/sample_code.rb

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