hashery 1.5.0 → 2.0.0

data/.ruby

@@ -1,6 +1,6 @@
 ---
 source:
-- var
+- meta
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -14,10 +14,7 @@ copyrights:
 - holder: Rubyworks
   year: '2010'
   license: BSD-2-Clause
-replacements: []
-alternatives: []
 requirements:
-- name: blankslate
 - name: detroit
   groups:
   - build
@@ -31,33 +28,49 @@ requirements:
   - test
   development: true
 dependencies: []
+alternatives: []
 conflicts: []
 repositories:
 - uri: git://github.com/rubyworks/hashery.git
   scm: git
   name: upstream
 resources:
-  home: http://rubyworks.github.com/hashery
-  code: http://github.com/rubyworks/hashery
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-  docs: http://rubydocs.info/gems/hashery/frames
-  wiki: http://wiki.github.com/rubyworks/hashery
-  gems: http://rubygems.org/gems/hashery
+- uri: http://rubyworks.github.com/hashery
+  label: Website
+  type: home
+- uri: http://github.com/rubyworks/hashery
+  label: Source Code
+  type: code
+- uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+  type: mail
+- uri: http://rubydoc.info/github/rubyworks/hashery/master/frames
+  label: Documentation
+  type: docs
+- uri: http://wiki.github.com/rubyworks/hashery
+  label: User Guide
+  type: wiki
+- uri: http://rubygems.org/gems/hashery
+  type: gems
+categories: []
 extra: {}
 load_path:
 - lib
+- alt
 revision: 0
 created: '2010-04-21'
 summary: Facets-bread collection of Hash-like classes.
 title: Hashery
-version: 1.5.0
+version: 2.0.0
 name: hashery
-description: ! 'The Hashery is a collection of Hash-like classes, spun-off from the
-  original
+description: ! 'The Hashery is a tight collection of Hash-like classes. Included among
+  its many
+
+  offerings are the auto-sorting Dictionary class, the efficient LRUHash, the
 
-  Ruby Facets library. Included are the widely used OrderedHash, the related but
+  flexible OpenHash and the convenient KeyHash. Nearly every class is a subclass
 
-  more featured Dictionary class, a number of open classes, similiar to the
+  of the CRUDHash which defines a CRUD model on top of Ruby''s standard Hash
 
-  standard OpenStruct and a few variations on the standard Hash.'
-date: '2011-11-10'
+  making it a snap to subclass and augment to fit any specific use case.'
+date: '2012-06-18'

data/.yardopts

@@ -1,3 +1,4 @@
+--plugin tomdoc
 --output-dir doc
 --title Hashery
 --protected

data/Config.rb

@@ -0,0 +1,28 @@
+config 'rubytest' do
+  $:.unshift 'test'
+  $:.unshift 'lib'
+end
+
+profile 'coverage' do
+  config 'rubytest' do
+    $:.unshift 'test'
+    $:.unshift 'lib'
+
+    require 'simplecov'
+    SimpleCov.command_name 'RubyTest'
+    SimpleCov.start do
+      add_filter '/test/'
+      add_filter '/lib/hashery/ordered_hash.rb'
+      coverage_dir 'log/coverage'
+    end
+  end
+
+  config 'qed' do
+    require 'simplecov'
+    SimpleCov.command_name 'QED'
+    SimpleCov.start do
+      add_filter '/demo/'
+      coverage_dir 'log/coverage'
+    end
+  end
+end

data/HISTORY.rdoc

@@ -1,5 +1,42 @@
 = RELEASE HISTORY
 
+== 2.0.0 / 2012-05-11
+
+This is a big release for Hashery which both culls some of it's
+less fitting classes and modules while greatly improving the rest.
+The first and most immediate change is use of a proper namespace.
+All classes and modules are now appropriately kept in the `Hashery`
+namespace. To get the old behavior you can `include Hashery` as the
+toplevel. For the other changes and improvements dive into the 
+API documentation.
+
+Changes:
+
+* Use proper Hashery namespace.
+* Add CRUDHash, which also serves a good base class.
+* Improved OpenHash to be nearly 100% open.
+* Deprecate BasicStruct, as it would be better to improve OpenStruct.
+* Deprecate BasicCascade, though it never really came to be.
+* Deprecate BasicObject emulator, as it is no longer needed.
+* Deprecate Memoizer, not sure how that got in here anyway.
+* Deprecate Ostructable, which can be paired up with better OpenStruct.
+* Removed open_object.rb, which has long been deprecated.
+
+
+== 1.5.1 / 2012-05-09
+
+This release adds transformative #each method to OpenCascade, to
+ensure #each returns an OpenCascade. Also, BasicCascade has been
+added that is like OpenCascade by fully open by use of BasicObject
+as a base class.
+
+Changes:
+
+* Fix OpenCascade#each (porecreat).
+* Introduce BasicCascade class.
+* Renamed `Ini` class to `IniHash` class.
+
+
 == 1.5.0 / 2011-11-10
 
 In this release, CoreExt module has been addeed to encapsulate

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Hashery 
+
+Copyright (c) 2009 Rubyworks 
+
+MIT License
+
+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.
+
+Website: http://rubyworks.github.com/hashery
+License: http://www.spdx.org/licenses/MIT
+

data/NOTICE.txt

@@ -0,0 +1,46 @@
+All copyright holders have released their wares with a compatible
+license or have given permission for their work to be distributed
+under the same license as Hashery.
+
+BasicObject is based on Jim Weirich's BlankSlate class.
+
+    BlankSlate
+    Copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+    All rights reserved.
+
+Dictionary is based on OrderedHash by Jan Molic.
+
+    OrderHash 2.0 Copyright (c) 2005 Jan Molic.
+
+
+LRUHash is based on same by Robert Klemme
+
+    Copyright (c) 2010 Robert Klemme
+
+
+Memoizer is based on same by Erik Veenstra
+
+    Copyright (c) 2006 Erik Veenstra
+
+
+IniHash is based on Ini library by Jeena Paradies
+
+    Copyright (c) 2007 Jeena Paradies <info@jeenaparadies.net>
+
+
+LinkedList is based on same by Kirk Haines
+
+    Copyright (C) 2006 Kirk Haines <khaines@enigo.com>
+
+
+FuzzyHash is based on the same by Joshua Hull.
+
+    Copyright (c) 2009 Joshua Hull
+
+
+PathHash is based on SlashedHash by Daniel Parker
+
+    HashMagic by Daniel Parker <gems@behindlogic.com>
+    Copyright (c) 2006 BehindLogic
+    http://hash_magic.rubyforge.org
+

data/README.rdoc

@@ -66,19 +66,22 @@ Well git in there!
 
 Hashery uses QED[http://rubyworks.github.com/qed] and
 Lemon[http://rubyworks.github.com/lemon] test frameworks.
-Both are used  in nearly the same fashion:
+The QED framework to create well tested high-level documentation.
+Run the QED specs via:
 
-  $ qed -Ilib qed/
+  $ qed -Ilib demo/
 
-And
+Lemon is used to create low-level unit tests. Run these via the 
+RubyTest univeral test harness.
+
+  $ rubytest -Ilib test/
 
-  $ lemon -Ilib test/
 
 === Patches
 
 Hashery's repository is hosted on GitHub[http://github.com/rubyworks/hashery].
-If you'd like to offer up a fix or feature change then fork the repo and 
-submit a pull request (preferably in a topic branch). I assume you have heard
+If you'd like to offer up a fix or feature, fork the repo and submit a pull
+request (preferably in a topic branch). I assume you have heard
 all the talk about proper {practices}[http://learn.github.com/p/intro.html],
 so I won't bug you with it yet again.
 
@@ -100,5 +103,5 @@ See COPYING.rdoc file for further details.
 
 Some libraries included in the Hashery have special copyrights
 attributing specific authors. Please see each library script for
-specifics.
+specifics and the NOITCE.txt file for an overview.
 

data/lib/hashery.rb

@@ -1,20 +1,20 @@
 require 'hashery/core_ext'
 
-require 'hashery/basic_struct'
+#require 'hashery/basic_struct'
 require 'hashery/casting_hash'
+require 'hashery/crud_hash'
 require 'hashery/dictionary'
 require 'hashery/fuzzy_hash'
+require 'hashery/ini_hash'
 require 'hashery/linked_list'
 require 'hashery/lru_hash'
 require 'hashery/key_hash'
-require 'hashery/memoizer'
 require 'hashery/open_cascade'
 require 'hashery/open_hash'
-#require 'hashery/open_object'
-require 'hashery/ordered_hash'
-require 'hashery/ostructable'
+#require 'hashery/ordered_hash'
+#require 'hashery/ostructable'
 require 'hashery/property_hash'
 require 'hashery/query_hash'
 require 'hashery/static_hash'
 
-#require 'hashery/ini'
+

data/lib/hashery.yml

@@ -1,6 +1,6 @@
 ---
 source:
-- var
+- meta
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -14,10 +14,7 @@ copyrights:
 - holder: Rubyworks
   year: '2010'
   license: BSD-2-Clause
-replacements: []
-alternatives: []
 requirements:
-- name: blankslate
 - name: detroit
   groups:
   - build
@@ -31,33 +28,49 @@ requirements:
   - test
   development: true
 dependencies: []
+alternatives: []
 conflicts: []
 repositories:
 - uri: git://github.com/rubyworks/hashery.git
   scm: git
   name: upstream
 resources:
-  home: http://rubyworks.github.com/hashery
-  code: http://github.com/rubyworks/hashery
-  mail: http://groups.google.com/group/rubyworks-mailinglist
-  docs: http://rubydocs.info/gems/hashery/frames
-  wiki: http://wiki.github.com/rubyworks/hashery
-  gems: http://rubygems.org/gems/hashery
+- uri: http://rubyworks.github.com/hashery
+  label: Website
+  type: home
+- uri: http://github.com/rubyworks/hashery
+  label: Source Code
+  type: code
+- uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+  type: mail
+- uri: http://rubydoc.info/github/rubyworks/hashery/master/frames
+  label: Documentation
+  type: docs
+- uri: http://wiki.github.com/rubyworks/hashery
+  label: User Guide
+  type: wiki
+- uri: http://rubygems.org/gems/hashery
+  type: gems
+categories: []
 extra: {}
 load_path:
 - lib
+- alt
 revision: 0
 created: '2010-04-21'
 summary: Facets-bread collection of Hash-like classes.
 title: Hashery
-version: 1.5.0
+version: 2.0.0
 name: hashery
-description: ! 'The Hashery is a collection of Hash-like classes, spun-off from the
-  original
+description: ! 'The Hashery is a tight collection of Hash-like classes. Included among
+  its many
+
+  offerings are the auto-sorting Dictionary class, the efficient LRUHash, the
 
-  Ruby Facets library. Included are the widely used OrderedHash, the related but
+  flexible OpenHash and the convenient KeyHash. Nearly every class is a subclass
 
-  more featured Dictionary class, a number of open classes, similiar to the
+  of the CRUDHash which defines a CRUD model on top of Ruby''s standard Hash
 
-  standard OpenStruct and a few variations on the standard Hash.'
-date: '2011-11-10'
+  making it a snap to subclass and augment to fit any specific use case.'
+date: '2012-06-18'

data/lib/hashery/association.rb

@@ -1,123 +1,183 @@
-# Copyright (c) 2005 Thomas Sawyer
+module Hashery
 
-# = Association
-#
-# General binary association allows one object to be
-# associated with another. It has a variety of uses,
-# link-lists, simple ordered maps and mixed collections,
-# among them.
-#
-# NOTE: This class is still fairly experimental. And it is not
-# loaded along with the other Hashery libraries when using
-# `require 'hashery'`.
-#
-# == Usage
-#
-# Associations can be used to draw simple relationships.
-#
-#   :Apple >> :Fruit
-#   :Apple >> :Red
-#
-#   :Apple.associations #=> [ :Fruit, :Red ]
-#
-# It can also be used for simple lists of ordered pairs.
-#
-#   c = [ :a >> 1, :b >> 2 ]
-#   c.each { |k,v| puts "#{k} associated with #{v} }
-#
-# produces
-#
-#   a associated with 1
-#   b associated with 2
-#
-# == Limitations
-#
-# The method :>> is used to construct the association.
-# It is a rarely used method so it is generally available.
-# But you can't use it for any of the following classes
-# becuase they use #>> for other things.
-#
-#   Bignum
-#   Fixnum
-#   Date
-#   IPAddr
-#   Process::Status
-#
-#--
-# TODO: Should associations be singleton?
-#
-# TODO: Is it really wise to keep a table of all associations?
-#++
-
-class Association
-  include Comparable
+  # TODO: Should associations be singleton?
+  #
+  # TODO: Is it really wise to keep a table of all associations?
 
-  class << self
-    # Store association references.
-    def reference
-      @reference ||= Hash.new{ |h,k,v| h[k]=[] }
+  # Association is a general binary association that allows one
+  # object to be associated with another. It has a variety of uses,
+  # such as linked-lists, simple ordered maps and mixed collections,
+  # among them.
+  #
+  # NOTE: This class is still fairly experimental. And it is not
+  # loaded along with the other Hashery libraries when using
+  # `require 'hashery'`. It must be required independently.
+  #
+  # Associations can be used to draw simple relationships.
+  #
+  #   :Apple >> :Fruit
+  #   :Apple >> :Red
+  #
+  #   :Apple.associations #=> [ :Fruit, :Red ]
+  #
+  # It can also be used for simple lists of ordered pairs.
+  #
+  #   c = [ :a >> 1, :b >> 2 ]
+  #   c.each { |k,v| puts "#{k} associated with #{v} }
+  #
+  # produces
+  #
+  #   a associated with 1
+  #   b associated with 2
+  #
+  # The method :>> is used to construct the association.
+  # It is a rarely used method so it is generally available.
+  # But you can't use it for any of the following classes
+  # becuase they use #>> for other things.
+  #
+  #   Bignum
+  #   Fixnum
+  #   Date
+  #   IPAddr
+  #   Process::Status
+  #
+  class Association
+    include Comparable
+
+    class << self
+      #
+      # Store association references.
+      #
+      # Returns `Hash` of all associaitons.
+      #
+      def reference
+        @reference ||= Hash.new{ |h,k,v| h[k]=[] }
+      end
+
+      #
+      # Shortcut for #new.
+      #
+      # index - The "index key" of the association.
+      # value - The "value" of the association.
+      #
+      # Returns `Association`.
+      #
+      def [](index, value)
+        new(index, value)
+      end
+
+      #def new(index, value)
+      #  lookup[[index, value]] ||= new(index, value)
+      #end
+
+      #def lookup
+      #  @lookup ||= {}
+      #end
     end
 
-    def [](index, value)
-      new(index, value)
+    #
+    # The "index key" of the association.
+    #
+    attr_accessor :index
+
+    #
+    # The "value" of the association.
+    #
+    attr_accessor :value
+
+    #
+    # Initialize new Association.
+    #
+    # index - The "index key" of the association.
+    # value - The "value" of the association.
+    #
+    def initialize(index, value=nil)
+      @index = index
+      @value = value
+
+      unless index.associations.include?(value)
+        index.associations << value
+      end
     end
 
-    #def new(index, value)
-    #  lookup[[index, value]] ||= new(index, value)
-    #end
-
-    #def lookup
-    #  @lookup ||= {}
-    #end
-  end
-
-  attr_accessor :index
-  attr_accessor :value
-
-  def initialize(index, value=nil)
-    @index = index
-    @value = value
-
-    unless index.associations.include?(value)
-      index.associations << value
+    #
+    # Compare the values of two associations.
+    #
+    # TODO: Comparions with non-associations?
+    #
+    # assoc - The other `Association`.
+    #
+    # Returns [Integer] `1`, `0`, or `-1`.
+    #
+    def <=>(assoc)
+      return -1 if self.value < assoc.value
+      return  1 if self.value > assoc.value
+      return  0 if self.value == assoc.value
     end
-  end
-
-  def <=>(assoc)
-    return -1 if self.value < assoc.value
-    return  1 if self.value > assoc.value
-    return  0 if self.value == assoc.value
-  end
 
-  def invert!
-    temp = @index
-    @index = @value
-    @value = temp
-  end
-
-  def to_s
-    return "#{index.to_s}#{value.to_s}"
-  end
-
-  def inspect
-    %{#{@index.inspect} >> #{@value.inspect}}
-  end
+    #
+    # Invert association, making the index the value and vice-versa.
+    #
+    # Returns [Array] with two-elements reversed.
+    #
+    def invert!
+      temp = @index
+      @index = @value
+      @value = temp
+    end
 
-  def to_ary
-    [ @index, @value ]
-  end
+    #
+    # Produce a string representation.
+    #
+    # Returns [String].
+    #
+    def to_s
+      return "#{index} >> #{value}"
+    end
 
-  # Object extensions.
-  #
-  module Kernel
+    #
+    # Produce a literal code string for creating an association.
+    #
+    # Returns [String].
+    #
+    def inspect
+      "#{index.inspect} >> #{value.inspect}"
+    end
 
-    # Define an association with +self+.
-    def >>(to)
-      Association.new(self, to)
+    #
+    # Convert to two-element associative array.
+    #
+    # Returns [Array] Two-element Array of index and value pair.
+    #
+    def to_ary
+      [index, value]
     end
 
-    def associations
-      Association.reference[self]
+    #
+    # Object extensions.
+    #
+    module Kernel
+
+      #
+      # Define an association for +self+.
+      #
+      # to - The value of the association.
+      #
+      # Returns [Association].
+      #
+      def >>(to)
+        Association.new(self, to)
+      end
+
+      #
+      # List of associations for this object.
+      #
+      # Returns an `Array` of `Associations`.
+      #
+      def associations
+        Association.reference[self]
+      end
+
     end
 
   end
@@ -125,10 +185,9 @@ class Association
 end
 
 class Object #:nodoc:
-  include Association::Kernel
+  include Hashery::Association::Kernel
 end
 
-
 #--
 # Setup the >> method in classes that use it already.
 #
@@ -160,3 +219,4 @@ end
 # end
 #++
 
+# Copyright (c) 2005 Rubyworks, Thomas Sawyer