extensional 1.3.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 1.3.1 / 2010-09-30
+
+* Initial public release
+

data/LEGAL

@@ -0,0 +1,5 @@
+LEGAL NOTICE INFORMATION
+------------------------
+
+All the files in this distribution are covered under either the MIT
+license (see the file LICENSE).

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Oregon Health & Sciences University Knight Cancer Institute
+
+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.md

@@ -0,0 +1,76 @@
+extensional: Class extent collector
+===================================
+
+**Git**:          [http://github.com/caruby/extensional](http://github.com/caruby/extensional)    
+**Author**:       OHSU Knight Cancer Institute    
+**Copyright**:    2010    
+**License**:      MIT License    
+**Latest Version**: 1.3.1    
+**Release Date**: September 30th 2010    
+
+Synopsis
+--------
+
+The extensional gem adds the ability of a Class to collect its instances.
+An extensional class is an Enumerable whose each method iterates over its instances.
+An optional callback block enables associative access to instances by key.
+
+Feature List
+------------
+
+1. Add instances to a Class extent.
+
+2. Associative access by a designated key.
+
+3. Custom unit definition.
+
+4. Measurement parser.
+
+Installing
+----------
+
+To install the extensional gem, use the following command:
+
+    $ gem install extensional
+
+(Add `sudo` if you're installing under a POSIX system as root)
+
+Alternatively, if you've checked the source out directly, you can call
+`rake install` from the root project directory.
+
+Usage
+-----
+
+An extensional class is an Enumerable whose <tt>each</tt> method iterates over its instances, e.g.:
+
+    class Person
+      make_extensional
+    end
+    Employee.new(20195) #=> Employee@2653
+    Employee.to_a #=> [Employee@2653]
+
+An optional callback block adds associative access to instances by key using the class <tt>for</tt>
+method, e.g.:
+
+    class Employee
+      make_extensional { |hash, emp| hash[emp.number] = emp }
+      ...
+    end
+    Employee.for(20196) #=> nil
+    Employee.new(20196) #=> Employee@2654
+    Employee.for(20196) #=> Employee@2654
+
+The Class.make_extensional RDoc includes additional examples.
+
+Changelog
+---------
+
+- **September.30.10**: 2010.1 release
+    - Initial public release
+
+Copyright
+---------
+
+extensional &copy; 2010 by [Oregon Health & Sciences University](mailto:loneyf@ohsu.edu).
+extensional is licensed under the MIT license. Please see the LICENSE and LEGAL
+files for more information.

data/lib/extensional.rb

@@ -0,0 +1,45 @@
+require 'forwardable'
+require 'set'
+require 'extensional/class'
+
+# An Extensional Class collects its instances.
+# See Class#make_extensional for the usage model.
+module Extensional
+  include Enumerable
+
+  # This Extensional implementation version.
+  VERSION = '1.3.1'
+
+  # Returns this Extensional class's Extent.
+  def extent
+    @extent
+  end
+
+  # Returns the instance with the given key arguments, or nil if no association is found.
+  #
+  # Raises NotImplementedError if the class extent does not implement associative access.
+  def for(*key)
+    unless @extent.associative? then
+      raise NotImplementedError.new("Associative access by key is not implemented for #{self}")
+    end
+    # extract the key argument from a key array with zero or one members;
+    # if key has more than one member, the key remains an array of all arguments
+    key = key.first if key.size == 1
+    @extent.find(key)
+  end
+
+  # Adds an instance of this class to the class extent.
+  def <<(instance)
+    @extent << instance
+  end
+
+  # Calls block an each instance in this class's extent.
+  def each(&block)
+    @extent.each(&block)
+  end
+
+  # Clears this class's extent.
+  def clear
+    @extent.clear
+  end
+end

data/lib/extensional/class.rb

@@ -0,0 +1,68 @@
+require 'extensional/extent'
+
+class Class
+  # Adds the ability of a Class to collect its instances. An extensional class is an Enumerable
+  # whose +each+ method iterates over its instances, e.g.:
+  #   class Person
+  #     make_extensional
+  #     def initialize(ssn)
+  #       @ssn = ssn
+  #       Person << self
+  #     end
+  #     def to_s
+  #       "#{self.class.name}{ssn=>#{@ssn}}"
+  #     end
+  #     ...
+  #   end
+  #   Person.new('555-55-5555')
+  #   Person.join(', ') #=> Person{ssn=>555-55-5555}
+  #
+  # The optional callback block adds associative access to instances by key using the class #for method.
+  # The callback block is called when an instance is added to the extent. The block arguments include the
+  # key=>instance association hash and the new instance, e.g.:
+  #   class Person
+  #     make_extensional { |hash, person| hash[person.ssn] = person }
+  #     ...
+  #   end
+  #   Person.for('555-55-5555') #=> nil
+  #   Person.new('555-55-5555')
+  #   Person.for('555-55-5555') #=> Person{ssn=>555-55-5555}
+  #
+  # The optional hash argument is the association hash. If the association hash is created with a block,
+  # then the instance is added to the hash on demand when the #for method is called in accordance with
+  # the standard Hash#new behavior, e.g.:
+  #   class Person
+  #     make_extensional(Hash.new { |hash, ssn| hash[snn] = new(ssn) })
+  #     ...
+  #   end
+  #   Person.for('555-55-5555') #=> Person{ssn=>555-55-5555}
+  #   Person.join(', ') #=> Person{ssn=>555-55-5555}
+  #   Person.new('666-66-6666') # added to the extent but not the association since there is no callback block
+  #   Person.map { |person| person.ssn }.sort #=> ["555-55-5555", "666-66-6666"]
+  #   Person.for('666-66-6666') #=> nil
+  #
+  # The hash factory block above only adds an instance to the extent association if it is accessed using the
+  # #for class method. If an instance can be created both on demand and independently of the #for method,
+  # then specify both a factory block and a callback block, e.g.:
+  #   class Person
+  #     make_extensional(Hash.new { |hash, ssn| new(ssn) }) {|hash, person| hash[person.snn] = person }
+  #     ...
+  #   end
+  #   Person.for('555-55-5555') #=> Person{ssn=>555-55-5555}
+  #   Person.new('666-66-6666') # added to both the extent and the association
+  #   Person.map { |person| person.ssn }.sort #=> ["555-55-5555", "666-66-6666"]
+  #   Person.for('666-66-6666') #=> Person{ssn=>666-66-6666}
+  #
+  # Note that hash assignment is not needed in the hash initializer method, since there is a callback block
+  # assigns the hash key to the new instance.
+  #
+  # This latter make_extensional alternative is the most flexible strategy, since it provides for both
+  # iterative and associative access.
+  #
+  # If neither a callback block nor a hash is given, then associative access is disabled as described
+  # in the Extensional#for method.
+  def make_extensional(hash=nil, &block) # :yields: hash, instance
+    @extent = Extent.new(hash, &block)
+    extend(Extensional)
+  end
+end

data/lib/extensional/extent.rb

@@ -0,0 +1,48 @@
+require 'forwardable'
+require 'set'
+
+# An Extent is a thin Array wrapper with optional associative access.
+class Extent
+  include Enumerable
+
+  # The key=>instance association hash.
+  attr_reader :association
+
+  # Creates a new Extent. The block is called when an instance is added to the extent.
+  def initialize(hash=nil, &block) # :yields: hash, instance
+    @extent = Set.new
+    @association = hash
+    @association ||= {} if block_given?
+    @callback = block
+  end
+
+  # Adds the given obj to this extent.
+  def <<(obj)
+    @callback.call(@association, obj) if @callback
+    @extent << obj
+  end
+
+  # Calls the given block an each instance in this extent.
+  def each(&block)
+    @extent.each(&block)
+  end
+
+  # Returns whether this Extent implements associative access by key.
+  def associative?
+    not @association.nil?
+  end
+
+  # Returns the instance for the given key.
+  #
+  # Raises NotImplementedError if this extent does not implement associative access.
+  def find(key)
+    raise NotImplementedError.new("Associative access by key is not implemented for this class extent") unless associative?
+    @association[key]
+  end
+
+  # Removes all instances from this Extent's extent and association.
+  def clear
+    @extent.clear
+    @association.clear if associative?
+  end
+end

data/test/lib/extensional_test.rb

@@ -0,0 +1,105 @@
+$:.unshift 'lib'
+
+require 'extensional'
+
+class Extended
+  make_extensional
+
+  def initialize
+    Extended << self
+  end
+end
+
+class Associative
+  make_extensional { |hash, obj| hash[obj.label] = obj }
+
+  attr_reader :label
+
+  def initialize(label)
+    @label = label
+    Associative << self
+  end
+end
+
+class CompoundKey
+  make_extensional { |hash, obj| hash[obj.key] = obj }
+
+  attr_reader :key
+
+  def initialize(x, y)
+    @key = [x, y]
+    CompoundKey << self
+  end
+end
+
+class CreateOnAccess
+  make_extensional(Hash.new { |hash, label| hash[label] = CreateOnAccess.new(label) })
+
+  def initialize(label)
+    @label = label
+  end
+end
+
+class AssociativeCreateOnAccess
+  make_extensional(Hash.new { |hash, label| AssociativeCreateOnAccess.new(label) }) { |hash, obj| hash[obj.label] = obj }
+
+  attr_reader :label
+
+  def initialize(label)
+    @label = label
+    AssociativeCreateOnAccess << self
+  end
+end
+
+class A
+  make_extensional
+  def initialize
+    self.class << self
+  end
+end
+
+class B < A
+  make_extensional
+end
+
+class C < A
+  make_extensional
+end
+
+class ExtensionalTest < Test::Unit::TestCase
+  def test_extent
+    assert_equal(Extended.new, Extended.to_a.first, "Instance not added to extension")
+  end
+
+  def test_associative
+    obj = Associative.new(:test)
+    assert_same(obj, Associative.for(:test), "Instance not accessible by label")
+  end
+
+  def test_compound_key
+    obj = CompoundKey.new(:x, :y)
+    assert_same(obj, CompoundKey.for(:x, :y), "Instance not accessible by compound key")
+  end
+
+  def test_hash_factory
+    obj = CreateOnAccess.for(:test)
+    assert_not_nil(obj, "Instance not created")
+  end
+
+  def test_associative_hash_factory
+    obj = AssociativeCreateOnAccess.for(:on_demand)
+    assert_not_nil(obj, "Instance not created")
+    assert_same(obj, AssociativeCreateOnAccess.for(:on_demand), "Instance created on demand not accessible by label")
+    obj = AssociativeCreateOnAccess.new(:by_new)
+    assert(AssociativeCreateOnAccess.extent.association.has_key?(:by_new), "Instance not accessible by label")
+  end
+
+  def test_isolation
+    a = A.new
+    b = B.new
+    c = C.new
+    assert_equal([a], A.to_a, "Superclass extension incorrect")
+    assert_equal([b], B.to_a, "Subclass extension incorrect")
+    assert_equal([c], C.to_a, "Subclass extension incorrect")
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: extensional
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 1
+  version: 1.3.1
+platform: ruby
+authors: 
+- OHSU
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "    The extensional gem adds the ability of a Class to collect its instances.\n    An extensional class is an Enumerable whose each method iterates over its instances.\n    An optional callback block enables associative access to instances by key.\n"
+email: caruby.org@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/extensional/class.rb
+- lib/extensional/extent.rb
+- lib/extensional.rb
+- test/lib/extensional_test.rb
+- History.txt
+- LEGAL
+- LICENSE
+- README.md
+has_rdoc: extensional
+homepage: http://github.com/caruby/extensional/
+licenses: []
+
+post_install_message: 
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: caruby
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Collects Class instances.
+test_files: []
+