key_value_ext 0.0.3

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+pkg
+nbproject
+TODO.txt
+*.gemspec
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2009 Jeff Patmon
+
+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.

data/README.rdoc

@@ -0,0 +1,40 @@
+= Key Value Extensions for Array
+
+A library of key-value operations
+
+== Resources
+
+Install
+
+* sudo gem install key_value_ext
+
+Use
+
+* require 'key_value_ext'
+
+	
+== Description
+
+A key-value array is one with the structure [[key1, val2], [key2, [value2, value3, ...]], ... ].
+
+This library provides the following functions
+
+* map_key_value
+* group_key_value
+
+for creating key-value arrays from arrays and hashes, and
+
+* keys
+* values
+* consolidate
+* expand
+* invert_key_value
+* to_hash
+
+for arrays that are key-value arrays
+
+== Usage
+
+Good for laying out complex nested views and forms when group_by is not enough.
+
+See the spec for examples.

data/Rakefile

@@ -0,0 +1,70 @@
+#require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+gem 'gem_version', '>= 0.0.1'
+require 'gem_version'
+#require 'rake/contrib/sshpublisher'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'key_value_ext'
+  s.version = GemVersion.next_version
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.8.7'
+  s.description = 'Array and hash extensions for key-value operations.'
+  s.summary = 'Good for laying out complex nested views and forms when group_by is not enough.'
+  
+  exclude_folders = '' # 'spec/rails/{doc,lib,log,nbproject,tmp,vendor,test}'
+  exclude_files = [] # FileList['**/*.log'] + FileList[exclude_folders+'/**/*'] + FileList[exclude_folders]
+  s.files = FileList['{lib,spec}/**/*'] + %w(init.rb LICENSE Rakefile README.rdoc .gitignore) - exclude_files
+  s.require_path = 'lib'
+  s.has_rdoc = true
+  s.test_files = Dir['spec/*_spec.rb']
+  
+  s.author = 'Jeff Patmon'
+  s.email = 'jpatmon@gmail.com'
+  s.homepage = 'http://github.com/jeffp/key_value_ext/tree/master'
+end
+ 
+require 'spec/version'
+require 'spec/rake/spectask'
+
+desc "Run specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/*_spec.rb']
+  t.libs << 'lib' << 'spec'
+  t.rcov = false
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  #t.rcov_dir = 'coverage'
+  #t.rcov_opts = ['--exclude', "kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+end
+
+desc "Generate documentation for the #{spec.name} gem."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = spec.name
+  #rdoc.template = '../rdoc_template.rb'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'lib/**/*.rb')
+end
+
+desc "Clean up gem build"
+task :clean do
+  FileUtil.rm_f Dir.glob('*.gem')
+end
+ 
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+  GemVersion.increment_version
+  GemVersion.commit_and_push
+end
+ 
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = RUBY_PLATFORM =~ /mswin/ ? false : true
+  p.need_zip = true
+end
+
+Dir['tasks/**/*.rake'].each {|rake| load rake}

data/init.rb

@@ -0,0 +1 @@
+require 'arspy'

data/lib/key_value_ext.rb

@@ -0,0 +1,75 @@
+class Object
+  def to_a
+    self.is_a?(Array) ? self : [self]
+  end
+end
+
+class Array
+  def map_key_value(key=nil, &block)
+    self.map{|elem| [(key.nil? ? elem : elem.__send__(key.to_sym)), (block_given? ? block.call(elem) : elem)] }
+  end
+  alias_method :mapkeyvalue, :map_key_value
+  def to_hash
+    acts_as_key_value!(:to_hash)
+    Hash[*self.consolidate.inject([]){|array, pair| array << pair.first << pair.last}]
+  end
+  def group_key_value(attribute, &block)
+    self.mapkeyvalue(attribute, &block).consolidate
+  end
+  alias_method :groupkeyvalue, :group_key_value
+  def consolidate
+    acts_as_key_value!(:consolidate)
+    keys, index = {}, -1
+    kv = self.dup
+    kv.delete_if do |pair|
+      index += 1
+      key_index = keys[pair.first]
+      if key_index
+        kv[key_index][1] = kv[key_index][1].to_a + pair.last.to_a
+      else
+        keys[pair.first] = index
+      end
+      key_index
+    end
+  end
+  def expand
+    acts_as_key_value!(:expand)
+    self.inject([]) do |result, pair|
+      result + pair.last.to_a.map{|val| [pair.first, val]}
+    end
+  end
+ 
+  def flip
+    acts_as_key_value!(:swap)
+    self.map{|pair| [pair.last, pair.first]}
+  end
+
+  def invert_key_value
+    acts_as_key_value!(:invert)
+    self.expand.flip.consolidate
+  end
+
+  def keys
+    acts_as_key_value!(:keys)
+    self.map{|pair| pair.first }
+  end
+  def values
+    acts_as_key_value!(:values)
+    self.map{|pair| pair.last }
+  end
+  private
+  def acts_as_key_value!(method)
+     raise "Cannot call '#{method}' on an non-key-value array" unless (self.empty? || self.first.is_a?(Array) && self.first.size == 2)
+  end
+end
+
+class Hash
+  def map_key_value(key=nil, &block)
+    self.map{|first, last| [(key.nil? ? first : last.__send__(key.to_sym)), (block_given? ? block.call(first, last) : last)]}
+  end
+  alias_method :mapkeyvalue, :map_key_value
+  def invert_key_value
+    self.to_a.invert_key_value
+  end
+end
+

data/spec/key_value_spec.rb

@@ -0,0 +1,137 @@
+require 'ostruct'
+require File.dirname(__FILE__) + '/../lib/key_value_ext'
+
+
+describe 'mapkeyvalue' do
+  describe 'with no param and no block' do
+    describe 'for an array' do
+      it "should may the elements to themselves maintaining order" do
+        [:a, :b, :c].mapkeyvalue.should == [[:a, :a], [:b, :b], [:c, :c]]
+      end
+    end
+    describe 'for a hash ' do
+      it "should group by the key and produce a 2-dim key-value array with no guaranteed order" do
+        {:a=>1, :b=>2, :c=>3}.mapkeyvalue.should =~ [[:a, 1], [:b, 2], [:c, 3]]
+      end
+    end
+  end
+  describe 'with no param but with a block' do
+    describe 'for an array' do
+      it "should group the block content by the array elements maintaining order" do
+        [:a, :b, :c].mapkeyvalue{|elem| elem.to_s }.should == [[:a, 'a'], [:b, 'b'], [:c, 'c']]
+      end
+    end
+    describe 'for a hash' do
+      it "should group the block content by the hash keys producing a key-value array with no guaranteed order" do
+        {:a=>1, :b=>2, :c=>3}.mapkeyvalue{|k, v| k.to_s + v.to_s }.should =~ [[:a, 'a1'], [:b, 'b2'], [:c, 'c3']]
+      end
+    end
+  end
+  describe 'with a param but with no block' do
+    describe 'for an array of objects' do
+      it "should group the array elements by the value/object returned by the method specified in the param" do
+        a, b, c = OpenStruct.new(:meth=>1), OpenStruct.new(:meth=>2), OpenStruct.new(:meth=>3)
+        [a, b, c].mapkeyvalue(:meth).should == [[1, a], [2, b], [3, c]]
+      end
+    end
+    describe 'for a hash' do
+      it "should group the values by the value/object returned by the method specified in the param" do
+        a, b, c = OpenStruct.new(:meth=>1), OpenStruct.new(:meth=>2), OpenStruct.new(:meth=>3)
+        {:a=>a, :b=>b, :c=>c}.mapkeyvalue(:meth).should =~ [[1,a], [2,b], [3,c]]
+      end
+    end
+  end
+end
+
+describe 'consolidate' do
+  describe 'for a non-key-value array' do
+    it "should raise exception" do
+      lambda { [1, 2, 3].consolidate }.should raise_exception(/consolidate/)
+    end
+  end
+  describe 'for a key-value array' do
+    it "should consolidate values into arrays grouped by the same key maintaining first-in-line order" do
+      [[:a, 1], [:b, 2], [:c, 3], [:a, 4]].consolidate.should == [[:a, [1,4]], [:b, 2], [:c, 3]]
+    end
+  end
+end
+
+describe 'to_hash' do
+  describe 'for a non-key-value array' do
+    it "should raise exception" do
+      lambda { [1,2,3].to_hash }.should raise_exception(/to_hash/)
+    end
+  end
+  describe 'for a key-value array' do
+    it "should return a hash of keys containing values array preserving values with arrays" do
+      [[:a, 1], [:b, [2,3]], [:c, nil]].to_hash.should == {:a=>1, :b=>[2,3], :c=>nil}
+    end
+    it "should consolidate duplicate keys" do
+      [[:a, 1], [:b, [2,3]], [:c, nil], [:a, 5]].to_hash.should == {:a=>[1,5], :b=>[2,3], :c=>nil}
+    end
+  end
+end
+
+describe 'keys' do
+  describe 'for a non-key-value array' do
+    it "should raise exception" do
+      lambda { [1,2,3].keys }.should raise_exception(/keys/)
+    end
+  end
+  describe 'for a key-value array' do
+    it "should return an array of the keys" do
+      [[:a, 1], [:b, 2], [:c, 3]].keys.should == [:a, :b, :c]
+    end
+  end
+end
+
+describe 'values' do
+  describe 'for a non-key-value array' do
+    it "should raise exception" do
+      lambda { [1,2,3].values }.should raise_exception(/values/)
+    end
+  end
+  describe 'for a key-value array' do
+    it "should return an array of the values" do
+      [[:a, 1], [:b, 2], [:c, 3]].values.should == [1,2,3]
+    end
+  end
+end
+
+describe 'expand' do
+  describe 'for a non-key-value array' do
+    it "should raise exception" do
+      lambda { [1,2,3].expand }.should raise_exception(/expand/)
+    end
+  end
+  describe 'for a key-value array' do
+    it "should break out arrays of values" do
+      [[:a, [1, 2]], [:b, 1], [:c, [4,5]]].expand.should == [[:a,1],[:a,2],[:b,1],[:c,4],[:c,5]]
+    end
+  end
+end
+
+describe 'invert_key_value' do
+  describe 'for a non-key-value array' do
+    it "should raise exception" do
+      lambda { [1,2,3].invert_key_value }.should raise_exception(/invert/)
+    end
+  end
+  describe 'for a key-value array' do
+    it "should return a key-value array with keys constructed from values referencing previous keys preserving order" do
+      [[:a, 1], [:b, 2], [:c, 3]].invert_key_value.should == [[1, :a], [2, :b], [3, :c]]
+    end
+    it "should invert for values with arrays" do
+      [[:a, [1,2]], [:b, 2], [:c, [3,2]]].invert_key_value.should == [[1, :a], [2, [:a,:b,:c]], [3, :c]]
+    end
+  end
+end
+
+describe 'Object.to_a' do
+  it 'should convert an object to an array unless it is an array' do
+    1.to_a.should == [1]
+    'str'.to_a.should == ['str']
+    [1,'str'].to_a.should == [1,'str']
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: key_value_ext
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Jeff Patmon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Array and hash extensions for key-value operations.
+email: jpatmon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/key_value_ext.rb
+- spec/key_value_spec.rb
+- spec/spec.opts
+- init.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+- .gitignore
+has_rdoc: true
+homepage: http://github.com/jeffp/key_value_ext/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Good for laying out complex nested views and forms when group_by is not enough.
+test_files: 
+- spec/key_value_spec.rb