eymiha_util 0.1.0 → 0.1.1

data/lib/forward_referencing.rb

@@ -0,0 +1,138 @@
+# Forward referencing is one of those painful problems in programming - if
+# you try to use something before it's defined, trouble ensues. Using the
+# ForwardReferencing module and the ForwardReference class can let you
+# gracefully recover from problems caused by forward references in data and
+# processing.
+
+require 'eymiha'
+
+# The ForwardReferencing module can be mixed into a class to allow it to
+# capture and resolve ForwardReferences.
+module ForwardReferencing
+
+  # An array containing the set of unresolved forward references.
+  attr_reader :forward_references
+
+  # To be called from the initializer of the includer, this sets up the forward
+  # reference capture and resolution mechanisms.
+  def start_forward_referencing
+    @forward_references = []
+    @had_forward_reference_resolution = false
+    @forward_reference_resolver = nil
+  end
+
+  # To be called when a section of code that could contain a forward reference
+  # is entered. The method returns a newly created ForwardReference with the
+  # given dependency that can be jumped to during resolution.
+  def create_forward_reference dependency=nil
+    forward_reference = ForwardReference.new dependency
+    @forward_references << forward_reference
+    forward_reference
+  end
+
+  # To be called when a section of code that could contain a forward reference
+  # has successfully been reached. It is used to remove the ForwardReference
+  # that was created at the start of the section, and asserts that a
+  # resolution was made.
+  def remove_forward_reference forward_reference=nil
+    @forward_references.delete forward_reference if
+      (forward_reference.kind_of? ForwardReference)
+    @had_forward_reference_resolution = true
+  end
+
+  # To be called to try to resolve any unresolved ForwardReferences by jumping
+  # to each in turn and retrying the code that caused it. This method repeats
+  # until nothing more is resolved. At that point unresolved forward reference
+  # may still exist, to be possibly resolved by another call to this method
+  # downstream.
+  def resolve_forward_references
+    forward_references = @forward_references
+    @forward_references = []
+    @had_forward_reference_resolution = false
+    if forward_references.size > 0
+      @forward_reference_resolver ||= callcc {|cont| cont} while
+        (@forward_reference_resolver == nil)
+      forward_reference = forward_references.shift
+      forward_reference.continuation.call if forward_reference != nil
+    end
+    @forward_reference_resolver = nil
+    resolve_forward_references if @had_forward_reference_resolution
+  end
+
+  # To be called at the end of a section of code that could contain a forward
+  # reference, it will continue during normal processing and jump back to the
+  # resolve_forward_references method during resolution.
+  def continue_forward_reference_resolution
+    @forward_reference_resolver.call if @forward_reference_resolver
+  end
+
+  # Returns a hash of dependencies to arrays of the ForwardReferences that
+  # have them as dependencies.
+  def forward_reference_dependencies
+    dependencies = {}
+    @forward_references.each { |forward_reference|
+      dependency = forward_reference.dependency
+      forward_references = dependencies[dependency]
+      dependencies[dependency] = [] if forward_references == nil
+      dependencies[dependency] << forward_reference
+    }
+    dependencies
+  end
+  
+  # Returns a string indicating the current state of ForwardReferencing.
+  def forward_references_to_s
+    "#{self_name}  #{forward_references_remaining} unresolved"
+  end
+
+  # Returns the number of unresolved forward references.
+  def forward_references_remaining
+    @forward_references.size
+  end
+
+end
+
+
+# A ForwardReferencer is simply a class-wrapper for the ForwardReferencing
+# module. method have been shortened there is reduced potential for conflict
+# from inheritence than from inclusion or extension.
+class ForwardReferencer
+
+  understands ForwardReferencing
+
+  alias initialize   start_forward_referencing
+  alias create       create_forward_reference
+  alias remove       remove_forward_reference
+  alias resolve      resolve_forward_references
+  alias continue     continue_forward_reference_resolution
+  alias dependencies forward_reference_dependencies
+  alias to_s         forward_references_to_s
+  alias remaining    forward_references_remaining
+  
+end
+
+
+# A ForwardReference holds a continuation and a dependency, the where and
+# the why of forward referencing.
+class ForwardReference
+
+  # Holds the place to jump back to for attempting to resolve a forward
+  # reference.
+  attr_reader :continuation
+  
+  # Holds an arbitrary object that indicates why the forward reference
+  # occurred.
+  attr_accessor :dependency
+
+  # Returns a new instance with a valid continuation and the given dependency.
+  def initialize(dependency)
+    @continuation = nil
+    @continuation = callcc{|cont| cont} while (@continuation == nil)
+    @dependency = dependency
+  end
+
+  # Returns a string indicating the current state of the ForwardReference.
+  def to_s
+    "#{self_name}  dependency #{dependency}  #{continuation}"
+  end
+
+end

data/test/tc_forward_referencing.rb

@@ -0,0 +1,126 @@
+require 'test/unit'
+
+require 'forward_referencing'
+
+class LineLink
+
+  attr_accessor :data, :link
+
+  def initialize(chain,data,link)
+    @data,@link = data,link
+  end
+
+  def to_s
+    "#{data} #{link}"
+  end
+
+end
+
+
+class LineChain < ForwardReferencer
+  
+  attr_accessor :chain
+
+  def load(text)
+    @chain = {}
+    pattern = /(\w*) (\w*)/
+    text.each do |line|
+      matches = pattern.match line 
+      line_link = LineLink.new self, matches[1], matches[2]
+      @chain[line_link.data] = line_link
+      forward_reference = create line_link.data
+      if ((link = @chain[line_link.link]) != nil) ||
+         (line_link.link == 'end')
+        line_link.link = link
+        remove forward_reference
+      end
+      continue
+    end
+  end
+
+end
+
+
+class TC_Histogram < Test::Unit::TestCase
+
+  def test_forward_referencing
+    
+    text = <<TEXT_END
+eight nine
+five six
+four five
+nine end
+one two
+seven eight
+six seven
+start zero
+three four
+two three
+zero one
+TEXT_END
+    
+    line_chain = LineChain.new
+    line_chain.load(text)
+    dependencies = line_chain.dependencies
+    assert(dependencies["start"] != nil)
+    assert(dependencies["one"] != nil)
+    assert(dependencies["five"] != nil)
+    assert(dependencies["eight"] != nil)
+    assert(line_chain.remaining == 4)
+    assert(line_chain.chain['start'].to_s ==
+           'start zero')
+    assert(line_chain.chain['zero'].to_s ==
+           'zero one two')
+    assert(line_chain.chain['one'].to_s ==
+           'one two')
+    assert(line_chain.chain['two'].to_s ==
+           'two three four five six')
+    assert(line_chain.chain['three'].to_s ==
+           'three four five six')
+    assert(line_chain.chain['four'].to_s ==
+           'four five six')
+    assert(line_chain.chain['five'].to_s ==
+           'five six')
+    assert(line_chain.chain['six'].to_s ==
+           'six seven eight nine')
+    assert(line_chain.chain['seven'].to_s ==
+           'seven eight nine')
+    assert(line_chain.chain['eight'].to_s ==
+           'eight nine')
+    assert(line_chain.chain['nine'].to_s ==
+           'nine ')
+    assert(line_chain.chain.size == 11)
+    assert(line_chain.to_s == "LineChain  4 unresolved")
+
+    line_chain.resolve
+    assert(line_chain.remaining == 0)
+    assert(line_chain.chain['start'].to_s ==
+           'start zero one two three four five six seven eight nine ')
+    assert(line_chain.chain['zero'].to_s ==
+           'zero one two three four five six seven eight nine ')
+    assert(line_chain.chain['one'].to_s ==
+           'one two three four five six seven eight nine ')
+    assert(line_chain.chain['two'].to_s ==
+           'two three four five six seven eight nine ')
+    assert(line_chain.chain['three'].to_s ==
+           'three four five six seven eight nine ')
+    assert(line_chain.chain['four'].to_s ==
+           'four five six seven eight nine ')
+    assert(line_chain.chain['five'].to_s ==
+           'five six seven eight nine ')
+    assert(line_chain.chain['six'].to_s ==
+           'six seven eight nine ')
+    assert(line_chain.chain['seven'].to_s ==
+           'seven eight nine ')
+    assert(line_chain.chain['eight'].to_s ==
+           'eight nine ')
+    assert(line_chain.chain['nine'].to_s ==
+           'nine ')
+    assert(line_chain.chain.size == 11)
+    assert(line_chain.to_s == "LineChain  0 unresolved")
+    
+  end
+  
+end
+
+

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.2
 specification_version: 1
 name: eymiha_util
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-05-10 00:00:00 -04:00
+  version: 0.1.1
+date: 2007-05-16 00:00:00 -04:00
 summary: Eymiha general utility classes and methods
 require_paths: 
 - lib
@@ -32,9 +32,65 @@ files:
 - gem_package.rb
 - rakefile.rb
 - lib/envelope.rb
+- lib/forward_referencing.rb
 - lib/histogram.rb
 - test/tc_envelope.rb
+- test/tc_forward_referencing.rb
 - test/tc_histogram.rb
+- html/classes
+- html/classes/BaseEnvelope.html
+- html/classes/BaseEnvelope.src
+- html/classes/BaseEnvelope.src/M000001.html
+- html/classes/BaseEnvelope.src/M000002.html
+- html/classes/BaseEnvelope.src/M000003.html
+- html/classes/Envelope.html
+- html/classes/Envelope.src
+- html/classes/Envelope.src/M000013.html
+- html/classes/Envelope.src/M000014.html
+- html/classes/Envelope.src/M000015.html
+- html/classes/Envelope.src/M000016.html
+- html/classes/Envelope.src/M000017.html
+- html/classes/Envelope.src/M000018.html
+- html/classes/Envelope.src/M000020.html
+- html/classes/EnvelopeException.html
+- html/classes/ForwardReference.html
+- html/classes/ForwardReference.src
+- html/classes/ForwardReference.src/M000021.html
+- html/classes/ForwardReference.src/M000022.html
+- html/classes/ForwardReferencer.html
+- html/classes/ForwardReferencing.html
+- html/classes/ForwardReferencing.src
+- html/classes/ForwardReferencing.src/M000023.html
+- html/classes/ForwardReferencing.src/M000024.html
+- html/classes/ForwardReferencing.src/M000025.html
+- html/classes/ForwardReferencing.src/M000026.html
+- html/classes/ForwardReferencing.src/M000027.html
+- html/classes/ForwardReferencing.src/M000028.html
+- html/classes/ForwardReferencing.src/M000029.html
+- html/classes/ForwardReferencing.src/M000030.html
+- html/classes/Histogram.html
+- html/classes/Histogram.src
+- html/classes/Histogram.src/M000004.html
+- html/classes/Histogram.src/M000005.html
+- html/classes/Histogram.src/M000006.html
+- html/classes/Histogram.src/M000007.html
+- html/classes/Histogram.src/M000008.html
+- html/classes/Histogram.src/M000009.html
+- html/classes/Histogram.src/M000010.html
+- html/classes/Histogram.src/M000011.html
+- html/classes/Histogram.src/M000012.html
+- html/classes/HistogramException.html
+- html/created.rid
+- html/files
+- html/files/lib
+- html/files/lib/envelope_rb.html
+- html/files/lib/forward_referencing_rb.html
+- html/files/lib/histogram_rb.html
+- html/fr_class_index.html
+- html/fr_file_index.html
+- html/fr_method_index.html
+- html/index.html
+- html/rdoc-style.css
 test_files: []
 
 rdoc_options: 
@@ -47,5 +103,13 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eymiha
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: