hashery 2.1.0 → 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8459bb831f3ff14d0b44ff30648c5c6e569de75d
+  data.tar.gz: 55fae7249dd499b25808e4a4e523f2c01057d55e
+SHA512:
+  metadata.gz: 9b2fdfded7c965ef34498e94fd0a47bb2aad42255857c754d985bdcc5ebc4e8d440bf5b0faa9f9edd72918eb53bdfa319e5e22ab4f616ec15c20833e284a7775
+  data.tar.gz: c175b2f9590ae9c1e608c556132c3f574d12ac842548823786d8003f7a7d55b83a6845f5c74abc18bd3d620f51a04b595f1687af080952e3405ace2c7e42c73f

data/.index

@@ -0,0 +1,73 @@
+---
+revision: 2013
+type: ruby
+sources:
+- Index.yml
+- Gemfile
+authors:
+- name: Trans
+  email: transfire@gmail.com
+- name: Kirk Haines
+- name: Robert Klemme
+- name: Jan Molic
+- name: George Moschovitis
+- name: Jeena Paradies
+- name: Erik Veenstra
+organizations:
+- name: RubyWorks (http://rubyworks.github.com/)
+requirements:
+- groups:
+  - development
+  - test
+  version: '>= 0'
+  name: qed
+- groups:
+  - development
+  - test
+  version: '>= 0'
+  name: lemon
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/hashery
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/hashery
+  label: Source Code
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+- type: docs
+  uri: http://rubydoc.info/github/rubyworks/hashery/master/frames
+  label: Documentation
+- type: wiki
+  uri: http://wiki.github.com/rubyworks/hashery
+  label: User Guide
+- type: gems
+  uri: http://rubygems.org/gems/hashery
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/hashery.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2010'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+  - alt
+name: hashery
+title: Hashery
+version: 2.1.1
+summary: Facets-bread collection of Hash-like classes.
+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 flexible OpenHash and the convenient KeyHash. Nearly every class is a subclass
+  of the CRUDHash which defines a CRUD model on top of Ruby's standard Hash making
+  it a snap to subclass and augment to fit any specific use case.
+created: '2010-04-21'
+date: '2013-08-21'

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,9 +1,22 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 2.1.0 / 2012-11-24
+## 2.1.1 / 2013-08-21
+
+This minor release clarifies the licensing. The entire library is now
+distributed under the BSD-2-Clause license, also known as the FreeBSD
+license. In addition this release provides a bug fix for flattening
+arrays that contain an OpenCascade object.
+
+Changes:
+
+* Clarify licensing.
+* Fix #flatten on Arrays that contain an OpenCascade.
+
+
+## 2.1.0 / 2012-11-24 (Golden Retriever)
 
 The major change of the 2.1 release is to switch over to `Hash#fetch`
-as the fundamental CRUD read method inplace of the previous `#read` core
+as the fundamental CRUD read method in-place of the previous `#read` core
 extension (an alias of `#[]`). This is a pretty fundamental change which
 required modification of a number of classes. So please do extra-diligence
 and file an issue if you experience any problems.
@@ -23,7 +36,7 @@ Changes:
 * Change OpenCascade to auto-create the subclass when inherited.
 
 
-== 2.0.1 / 2012-07-06
+## 2.0.1 / 2012-07-06
 
 This minor release fixes an issue with OpenCascade (#13).
 The key_proc procedure wasn't being passed along to sub-cascades. 
@@ -33,7 +46,7 @@ Changes:
 * OpenCascade passes along key_proc to children.
 
 
-== 2.0.0 / 2012-05-11
+## 2.0.0 / 2012-05-11 (Crud Space)
 
 This is a big release for Hashery which both culls some of it's
 less fitting classes and modules while greatly improving the rest.
@@ -56,7 +69,7 @@ Changes:
 * Removed open_object.rb, which has long been deprecated.
 
 
-== 1.5.1 / 2012-05-09
+## 1.5.1 / 2012-05-09
 
 This release adds transformative #each method to OpenCascade, to
 ensure #each returns an OpenCascade. Also, BasicCascade has been
@@ -70,7 +83,7 @@ Changes:
 * Renamed `Ini` class to `IniHash` class.
 
 
-== 1.5.0 / 2011-11-10
+## 1.5.0 / 2011-11-10 (Devil's Core)
 
 In this release, CoreExt module has been added to encapsulate
 methods that extend Ruby's core Hash class (there are only a few).
@@ -88,7 +101,7 @@ Changes:
 * Switch license to BSD-2-Clause license.
 
 
-== 1.4.0 / 2011-01-19
+## 1.4.0 / 2011-01-19 (Back To Basics)
 
 This release includes a copy of Ruby Facets' BasicObject class, which
 fixes the loading bug of the previous version. This release also renames
@@ -101,7 +114,7 @@ Changes:
 * Fix basicobject.rb loading issue.
 
 
-== 1.3.0 / 2010-10-01
+## 1.3.0 / 2010-10-01 (Private Property)
 
 This release fixes a minor bug in CastingHash and adds a new
 PropertyHash class.
@@ -117,7 +130,7 @@ Changes:
   * Fixed CastingHash#new where #to_proc is called against NilClass
 
 
-== 1.2.0 / 2010-06-04
+## 1.2.0 / 2010-06-04 (Fuzzy Wuzzy)
 
 This release makes two significant changes to the Hashery.
 First, we have a new shiny library called FuzzyHash by
@@ -138,7 +151,7 @@ Changes:
   * OpenCascade subclasses OpenHash and handles Array cascading.
 
 
-== 1.1.0 / 2010-04-28
+## 1.1.0 / 2010-04-28 (Ugly Ducklings)
 
 A follow-up release of Hashery that adds two new libraries:
 Association and SparseArray. Both of these may seem like odd
@@ -157,7 +170,7 @@ Changes:
   * Added sparsearray.rb
 
 
-== 1.0.0 / 2010-04-21
+## 1.0.0 / 2010-04-21 (Hatching Hashery)
 
 This is the first release of the Facets Hashery.
 Most of included classes come directly from Ruby

data/LICENSE.txt

@@ -1,26 +1,23 @@
-Hashery 
+BSD-2-Clause License
 
-Copyright (c) 2009 Rubyworks 
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-MIT License
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
 
-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:
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
 
-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
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 

data/NOTICE.txt

@@ -2,12 +2,6 @@ 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.
@@ -44,3 +38,9 @@ PathHash is based on SlashedHash by Daniel Parker
     Copyright (c) 2006 BehindLogic
     http://hash_magic.rubyforge.org
 
+BasicObject is based on Jim Weirich's BlankSlate class.
+
+    BlankSlate
+    Copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+    All rights reserved.
+

data/{README.rdoc → README.md}

@@ -1,15 +1,17 @@
-= Hashery
+# Hashery
 
-{Homepage}[http://rubyworks.github.com/hashery] |
-{Development}[http://github.com/rubyworks/hashery] |
-{Report Issue}[http://github.com/rubyworks/hashery/issues] |
-{Mailing List}[http://googlegroups.com/group.rubyworks-mailinglist] |
-{IRC}[irc://irc.freenode.net/rubyworks]
+[Homepage](http://rubyworks.github.com/hashery) ·
+[Development](http://github.com/rubyworks/hashery) ·
+[Report Issue](http://github.com/rubyworks/hashery/issues] ·
+[Mailing List](http://googlegroups.com/group.rubyworks-mailinglist] ·
+[IRC](irc://irc.freenode.net/rubyworks)
 
-{<img src="http://travis-ci.org/rubyworks/hashery.png" />}[http://travis-ci.org/rubyworks/hashery]
+[![Gem Version](https://badge.fury.io/rb/hashery.png)](http://badge.fury.io/rb/hashery)
+[![Build Status](https://secure.travis-ci.org/rubyworks/hashery.png)](http://travis-ci.org/rubyworks/hashery) &nbsp; &nbsp;
+[![Flattr Me](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)
 
 
-== DESCRIPTION
+## Description
 
 Among Ruby Facets most common additions were an assortment
 of Hash-like classes. To better support this collection
@@ -23,14 +25,14 @@ some variations of the standard Hash class and a few
 other yummy morsels.
 
 
-== HOW TO USE
+## Usage
 
-For usage information, see the individual library files included
-in this collection and read the demo documents which give
+For instruction on usage, please see the individual library files
+included in this collection and read the demo documents which give
 examples of almost all features.
 
 
-== CORE EXTENSIONS
+## Core Extensions
 
 Hashery adds four core extensions of Ruby's Hash class: `#retrieve`,
 `#rekey`, `#rekey!` and `Hash.create`. The first is simply an alias
@@ -40,17 +42,17 @@ a new hash with another hash upon initialization. All of these are
 sorely missing for Ruby itself, which is why they are provided here.
 
 
-== HOW TO INSTALL
+## Installation
 
 To install with RubyGems simply open a console and type:
 
   $ sudo gem install hashery
 
 Tarball packages are available for manual site installations
-via {Ruby Setup}[http://proutils.github.com/setup].
+via [Ruby Setup](http://proutils.github.com/setup).
 
 
-== AUTHORS
+## Authors
 
 Developers who have contributed code to the project include:
 
@@ -63,15 +65,15 @@ Developers who have contributed code to the project include:
 * Erik Veenstra
 
 
-== CONTRIBUTE
+## Contributing
 
 Don't be a lump on a log. See an issue? Have a suggestion? Want to help?
 Well git in there!
 
-=== Testing
+### Testing
 
-Hashery uses QED[http://rubyworks.github.com/qed] and
-Lemon[http://rubyworks.github.com/lemon] test frameworks.
+Hashery uses [QED](http://rubyworks.github.com/qed) and
+[Lemon](http://rubyworks.github.com/lemon) test frameworks.
 The QED framework to create well tested high-level documentation.
 Run the QED specs via:
 
@@ -83,34 +85,29 @@ RubyTest universal test harness.
   $ rubytest -Ilib test/
 
 
-=== Patches
+### Patches
 
-Hashery's repository is hosted on GitHub[http://github.com/rubyworks/hashery].
+Hashery's repository is hosted on [GitHub](http://github.com/rubyworks/hashery).
 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],
+all the talk about proper [practices](http://learn.github.com/p/intro.html),
 so I won't bug you with it yet again.
 
-=== Donations
+### Donations
 
 Yes, we FOSS programmers need to eat too! ;-) No seriously, any help you can
 offer goes a long way toward continued development of Rubyworks projects,
 including Hashery. See the upper right-hand corner on the
-Rubyworks[http://rubyworks.github.com] homepage. Thanks.
+[Rubyworks](http://rubyworks.github.com) homepage. Thanks.
 
 
-== RELEASE NOTES
-
-Please see the HISTORY file.
-
-
-== COPYRIGHTS
+## Copyrights
 
 Copyright (c) 2010 Rubyworks
 
-Licensed under the *BSD-2-clause* license.
+Licensed under the *BSD-2-Clause* license.
 
-See COPYING.rdoc file for further details.
+See COPYING.md file for further details.
 
 Some libraries included in the Hashery have special copyrights
 attributing specific authors. Please see each library script for

data/demo/00_introduction.rdoc

@@ -0,0 +1,6 @@
+= Hashery
+
+For the following demos the `hashery` script has
+been preloaded and the Hashery namespace has been
+included into the demo context for convenience.
+

data/demo/01_open_hash.rdoc

@@ -0,0 +1,63 @@
+= OpenHash
+
+An OpenHash is a Hash that provides +open+ access to its entries via method
+calls. Writers (methods ending in =-marks) assign entries. Methods without
+special puncuation will retrieve entries. 
+
+  o = OpenHash.new
+  o.a = 1
+  o.b = 2
+  o.a.assert == 1
+  o.b.assert == 2
+
+Writers always use a Symbol for keys in the underlying Hash.
+
+  o.to_h.assert == { :a=>1, :b=>2 }
+
+All the usual Hash methods are still available in an OpenHash.
+
+  c = o.map{ |k,v| [k,v] }
+  c.assert.include?([:a,1])
+  c.assert.include?([:b,2])
+
+And they are protected from being overridden by writers.
+
+  o.map = 3
+  o.map.refute == 3
+
+Even so, the underlying Hash object does contain the entry even 
+when it cannot be accessed via a reader method.
+
+  o.to_h.assert == { :a=>1, :b=>2, :map=>3 }
+
+We can see if a method is open or not via the `#open?` method.
+
+  o.open?(:a).assert == true
+  o.open?(:map).assert == false
+
+For some usecases it may be necessary to give up access to one or
+more Hash methods in favor of access to the hash entries. This can
+be done using the `#open!` method.
+
+  o.open!(:map, :merge)
+  o.map.assert == 3
+  o.merge = 4
+  o.merge.assert == 4
+
+Becuase of nature of a writer, a certain set of Hash methods are always
+protected, in particluar all methods buffered by underscore (e.g. `__id__`).
+So these cannot be opened.
+
+  expect ArgumentError do
+    o.open!(:__id__)
+  end
+
+Even though writers alwasy use Symbols as keys, because an OpenHash
+is a true Hash object, any object can be used as a key internally.
+
+  o = OpenHash.new
+  o[nil] = "Nothing"
+  o.to_h.assert == { nil=>"Nothing" }
+
+It simply cannot be accessible via a reader method.
+