composite 0.3.0

data/README

@@ -0,0 +1,44 @@
+== Composite version 0.3.0
+
+=== Overview
+Mixin module to create classes where the 'whole'
+object is seen as being composed of 'parts'.
+Allowing access to some object both as composed
+as well as in parts. The typical use case is a subclass
+of String that is used to deal with a string that
+has a certain format and supports accessor methods
+to its parts, for example an URI/IRI, a BCP 47 language tag,
+a name or address in a certain format, and so on.
+
+=== Usage
+  class myComposite < BaseClass
+    def initialize (n)
+      super(n)
+    end
+    part :part1, :part2, ...
+    def compose
+      # calculate a value for the BaseClass object
+      # from @part1, @part2,...
+    end
+    def decompose
+      # calculate @part1, @part2,...
+      # from the value of BaseClass
+    end
+  end
+
+The above provides methods part1, part1=, part2, part2=,...
+for access to parts.
+
+=== Performance
+decompose is called on each access (both read and write)
+to any of the parts, because it's impossible to predict
+when the BaseClass object changes (all methods of the
+BaseClass would need to be patched). If decompose takes
+time, it may be possible to speed things up by saving a
+copy of the BaseClass object, or its hash, internally
+and do a comparison to see if anything has changed.
+
+=== Copyright
+Copyright (c) 2007 Martin J. Du"rst (duerst@it.aoyama.ac.jp)
+Licensed under the same terms as Ruby. Absolutely no warranty.
+(see http://www.ruby-lang.org/en/LICENSE.txt)

data/lib/composite.rb

@@ -0,0 +1,41 @@
+# :include: ../README
+
+module Composite
+  def self.included(base) #:nodoc:
+    super
+    base.extend(ClassMethods)
+  end
+  
+  # Assumes composite is up to date, and decomposes into parts.
+  # Virtual method, needs to be overwritten where module is included.
+  def decompose;  raise NotImplementedError;  end
+  # Assumes parts are up to date, and composes from parts.
+  # Virtual method, needs to be overwritten where module is included.
+  def compose;  raise NotImplementedError;  end
+
+  # Internal module to extend class that includes this module.
+  # This trick of getting around the fact that module methods
+  # aren't inherited when a module is included is from:
+  # http://wiki.rubyonrails.org/rails/pages/SimpleAccessControlExample
+  module ClassMethods
+    # Metaprogramming keyword to define 'part' instance variables
+    # that automatically call compose/decompose on access.
+    def part (*parts, &block)
+      parts.each do |aPart|
+        set_method = (aPart.to_s+'=').to_sym
+        get_method = aPart.to_sym
+        instance = ('@'+aPart.to_s).to_sym
+        send :define_method, get_method do ||
+          decompose
+          instance_variable_get instance
+        end
+        send :define_method, set_method do |a|
+          decompose
+          #call.block
+          instance_variable_set instance, a
+          compose
+        end
+      end
+    end
+  end
+end

data/test/test_composite.rb

@@ -0,0 +1,41 @@
+# some unit tests for the Composite module
+# assumes that names are "Given_Name Family_Name",
+# which is hopelessly non-internationalized, sorry!
+#
+# Copyright 2007 Martin J. Du"rst (duerst@it.aoyama.ac.jp);
+# available under the same licence as Ruby itself
+# (see http://www.ruby-lang.org/en/LICENSE.txt)
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'Composite'
+
+class Name < String
+  include Composite
+  def initialize (name)
+    super(name)
+  end
+  part :given, :family
+  def compose
+    replace(@given+' '+@family)
+  end
+  def decompose
+    @given, @family = self.split(' ')
+  end
+end
+
+require 'test/unit'
+class TestComposite < Test::Unit::TestCase
+  def test_simple
+    n = Name.new('John Smith')
+    assert_equal('John', n.given)
+    assert_equal('Smith', n.family)
+    n.given = 'Jane'
+    assert_equal('Jane Smith', n)
+    n.family = 'Miller'
+    assert_equal('Jane Miller', n)
+    n.given = 'Bill'
+    assert_equal('Bill Miller', n)
+    n.given += '-Willy'
+    assert_equal('Bill-Willy Miller', n)
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: composite
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+date: 2007-03-22 00:00:00 +09:00
+summary: metaprogramming module to (de)compose a base class into/from parts
+require_paths: 
+- lib
+email: duerst@it.aoyama.ac.jp
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: composite
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Martin J. Du"rst
+files: 
+- lib/composite.rb
+- test/test_composite.rb
+- README
+test_files: 
+- test/test_composite.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+