hashslice 1.0.4

data/CHANGES

@@ -0,0 +1,9 @@
+= 1.0.4 - 22-May-2008
+* Library now managed by Daniel Berger with the kind permission of
+  the original author, Michael Granger.
+* Added gemspec, README, MANIFEST, and CHANGES files.
+* Added a Rakefile with tasks for testing and installation.
+* Replaced the test suite with one based on Test::Unit.
+
+= 1.0.3 - 9-Jun-2004
+* Last release by Michael Granger

data/MANIFEST

@@ -0,0 +1,7 @@
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* hashslice.gemspec
+* lib/hashslice.rb
+* test/test_hashslice.rb

data/README

@@ -0,0 +1,46 @@
+= Description
+   Slicing for Ruby hashes.
+
+= Installation
+   rake test (optional)
+   rake install
+
+= Synopsis
+   require 'hashslice'
+
+   hash = {'a' => 1, 'b' => 2, 'c' => 3}
+
+   # Slice reference
+   hash['a', 'b'] # -> [1, 2]
+   hash['a']      # -> 1
+
+   # Slice assignment
+   hash['a', 'b'] = 7, 8
+
+   hash # -> {'a' => 7, 'b' => 8, 'c' => 3}
+
+= Overview
+   This library modifies the Hash#[] and Hash#[]= methods so that they can
+   handle list reference or assignment.
+
+== Hash#[*keys]
+   If more than one key is provided then an array is returned. Single
+   keys work as before, i.e. they return a single value.
+
+== Hash#[*keys]=(*values)
+   The values on the right are assigned to the keys on left on a one for one
+   If there are more values than keys, the extra values are dropped.
+
+= Copyright
+   Copyright (c) 2001-2008, The FaerieMUD Consortium and Daniel J. Berger.
+   All rights reserved.
+
+= License
+   This module is free software. You may use, modify, and/or redistribute this
+   software under the terms of the Perl Artistic License.
+
+   See http://language.perl.com/misc/Artistic.html
+
+= Authors
+   Michael Granger (original author)
+   Daniel Berger (current maintainer)

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+desc "Install the pure hashslice library (non-gem)"
+task :install do
+   cp 'lib/hashslice.rb', Config::CONFIG['sitelibdir']
+end
+
+
+desc "Run the tests"
+Rake::TestTask.new('test') do |t|
+   t.warning = true
+   t.libs << 'lib'
+   t.test_files = FileList['test/*.rb']
+end

data/lib/hashslice.rb

@@ -0,0 +1,50 @@
+class Hash
+   alias :href :[]
+   alias :hset :[]=
+   
+   # The version of this library
+   VERSION_HASHSLICE = '1.0.4'
+
+   # Retrieve a hash slice. If a single key is provided, returns a single
+   # value. If multiple keys are provided, an array of values is returned.
+   # 
+   # Examples:
+   #
+   #     hash = {'a', 1, 'b', 2, 'c', 3}
+   #     hash['a']       -> 1
+   #     hash['a', 'c']  -> [1, 3]
+   #
+   def [](*args)
+      if args.length == 1
+         href(args[0])
+      else
+         args.map{ |k| href(k) }
+      end 
+   end
+
+   # Hash slice assignment. You can assign a list of values to a list of keys
+   # in a single operation on a one for one basis.
+   #
+   # If the number of keys exceeds the number of values, the remaining keys
+   # are assigned a value of nil.
+   #
+   # If the number of values exceeds the number of keys, the extra values are
+   # dropped.
+   #
+   # Examples:
+   #
+   #     hash['a'] = 1, 2          -> {a => [1, 2]}
+   #     hash['a', 'b'] = 3, 4     -> {a => 3, b => 4}
+   #     hash['a', 'b'] = 5        -> {a => 5, b => nil}
+   #     hash['a', 'b'] = 3, 4, 5  -> {a => 3, b => 4}
+   #
+   def []=(*args)
+      if args.length <= 2
+         hset(*args)
+      else
+         values = args.pop # Last arg is the value. The rest are keys.
+         values = [values] unless values.is_a?(Array)
+         args.each_index{ |i| hset(args[i], values[i]) }
+      end 
+   end
+end

data/test/test_hashslice.rb

@@ -0,0 +1,79 @@
+#######################################################################
+# test_hashslice.rb
+#
+# Test suite for the hashslice library. You should run these tests
+# via the 'rake test' task.
+#######################################################################
+require 'hashslice'
+require 'test/unit'
+
+class TC_Hashslice < Test::Unit::TestCase
+   def setup
+      @hash = {'a', 1, 'b', 2}
+   end
+   
+   def test_get_slice_instance_method_basic
+      assert_respond_to(@hash, :[])
+      assert_nothing_raised{ @hash['a'] }
+      assert_nothing_raised{ @hash['a', 'b'] }
+      assert_kind_of(Integer, @hash['a'])
+      assert_kind_of(Array, @hash['a', 'b'])
+   end
+
+   def test_get_slice_instance_method
+      assert_equal(1, @hash['a'])
+      assert_equal([1, 2], @hash['a', 'b'])
+      assert_equal([1, 2, nil], @hash['a', 'b', 'c'])
+      assert_nil(@hash['bogus'])
+   end
+
+   def test_get_slice_duplicate_keys
+      assert_equal([1, 1], @hash['a', 'a'])
+      assert_equal([1, 2, 1, 2], @hash['a', 'b', 'a', 'b'])
+   end
+
+   def test_set_slice_instance_method_basic
+      assert_respond_to(@hash, :[]=)
+      assert_nothing_raised{ @hash['a'] = 3 }
+      assert_nothing_raised{ @hash['a', 'b'] = 3 }
+      assert_nothing_raised{ @hash['a', 'b'] = 3, 4 }
+      assert_kind_of(Fixnum, @hash['a'] = 3)
+      assert_kind_of(Fixnum, @hash['a', 'b'] = 3)
+      assert_kind_of(Fixnum, @hash['a', 'b'] = 3, 4)
+   end
+
+   # hash[key] = value
+   def test_set_slice_instance_method_single_key_and_value
+      assert_nothing_raised{ @hash['a'] = 3 }
+      assert_nothing_raised{ @hash['b'] = [1, 2] }
+      assert_equal({'a' => 3, 'b' => [1, 2]}, @hash)
+   end
+
+   # hash[key1, key2] = value
+   def test_set_slice_instance_method_multiple_keys_single_value
+      assert_nothing_raised{ @hash['a', 'b'] = 3 }
+      assert_equal({'a' => 3, 'b' => nil}, @hash)
+   end
+
+   # hash[key1, key2] = value1, value2
+   def test_set_slice_instance_method_multiple_keys_multiple_values
+      assert_nothing_raised{ @hash['a', 'b'] = 3, 4 }
+      assert_equal({'a' => 3, 'b' => 4}, @hash)
+   end
+
+   # hash[key] = value1, value2
+   def test_set_slice_instance_method_single_key_multiple_values
+      assert_nothing_raised{ @hash['a'] = 3, 4 }
+      assert_equal({'a' => [3, 4], 'b' => 2}, @hash)
+   end
+
+   # hash[key1, key2] = value1, value2, value3
+   def test_set_slice_instance_method_multiple_keys_odd_values
+      assert_nothing_raised{ @hash['a', 'b'] = 3, 4, 5 }
+      assert_equal({'a' => 3, 'b' => 4}, @hash)
+   end
+
+   def teardown
+      @hash = nil
+   end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: hashslice
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-23 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
+files: 
+- lib/hashslice.rb
+- CHANGES
+- MANIFEST
+- README
+- Rakefile
+- test/test_hashslice.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: shards
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: An easy way to implement the facade pattern in your class
+test_files: 
+- test/test_hashslice.rb