joinable_array 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in joinable_array.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steven Noble
+
+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.

data/README.md

@@ -0,0 +1,47 @@
+# JoinableArray
+
+A small gem to make it easier to do relational joins with arrays in ruby without requiring database calls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'joinable_array'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install joinable_array
+
+## Usage
+
+joinable_array offers a JoinableArray class which can be used as
+
+```ruby
+things1 = JoinableArray(array1)
+things2 = JoinableArray(array2)
+
+outer_join = things1
+  .outer_join(things2) {|l,r| l.merge(r)}
+
+inner_join = things1
+  .joins_on {|x| [x[0], x[1]]}
+  .inner_join(things2.joins_on {|x| [x.a, x.b]}) {|l,r| l.merge(r)}
+ 
+left_join = things1
+  .joins_on {|x| [x[0], x[1]]}
+  .fills_with {|key| key[0 .. -1].concat([0,0,0])}
+  .left_join(things2.joins_on {|x| [x.a, x.b]}) {|l,r| l.merge(r)}
+ 
+right_join = things1
+  .joins_on {|x| [x[0], x[1]]}
+  .right_join(things2
+    .joins_on {|x| [x.a, x.b]}
+    .fills_with {|key|, Obj.new(*key)}
+  ) {|l,r| l.merge(r)}
+```
+
+The simplest join is `outer_join` which is a method on `JoinableArray` and requires another `JoinableArray` as its parameter and returns a 3rd `JoinableArray` which is the outer join of the original two `JoinableArray` instances. The elements of the returned `JoinableArray` is defined by the block passed to `outer_join`. The block accepts two parameters: the first is an element from the first `JoinableArray` and the second is from the other `JoinableArray`. The block returns the value of resulting `JoinableArray`

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.ruby_opts = ['-I.:lib:test']
+  t.libs << 'test'
+  t.test_files = ['./test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test
+

data/joinable_array.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'joinable_array/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "joinable_array"
+  spec.version       = JoinableArray::VERSION
+  spec.authors       = ["Steven Noble"]
+  spec.email         = ["steven.noble@gmail.com"]
+  spec.description   = %q{A way to do sql style joins with Array}
+  spec.summary       = %q{joinable arrays}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/joinable_array/version.rb

@@ -0,0 +1,3 @@
+module JoinableArray
+  VERSION = "0.0.1"
+end

data/lib/joinable_array.rb

@@ -0,0 +1,120 @@
+class RelationalMethods
+  def self.inner_join(left_a, right_a, left_key, right_key, &block)
+    left, right = left_and_right(left_a, right_a, left_key, right_key)
+    join(left, right, left_a, &block)
+  end
+
+  def self.left_join(left_a, right_a, left_key, right_key, fill, &block)
+    left, right = left_and_right(left_a, right_a, left_key, right_key)
+    right = fill_cube(right, left, &fill).sort_by {|x| x[:key]}
+    join(left, right, left_a, &block)
+  end
+
+  def self.right_join(left_a, right_a, left_key, right_key, fill, &block)
+    left, right = left_and_right(left_a, right_a, left_key, right_key)
+    left = fill_cube(left, right, &fill).sort_by {|x| x[:key]}
+    join(left, right, left_a, &block)
+  end
+
+  def self.outer_join(left_a, right_a, left_key, right_key, left_fill, right_fill, &block)
+    left, right = left_and_right(left_a, right_a, left_key, right_key)
+    left = fill_cube(left, right, &left_fill).sort_by {|x| x[:key]}
+    right = fill_cube(right, left, &right_fill).sort_by {|x| x[:key]}
+    join(left, right, left_a, &block)
+  end
+
+  def self.fill_cube(left, right, &block)
+    right_hash = right[idx = 0]
+    new_array = left.slice(0, 0)
+    previously_added = nil
+    left.each do |left_hash|
+      while right_hash && (right_hash[:key] <=> left_hash[:key]) < 0
+        if previously_added == nil || (right_hash[:key] <=> previously_added) > 0
+          previously_added = right_hash[:key] 
+          new_array << {:key => right_hash[:key], :object => block ? block.call(right_hash[:key]) : nil}
+        end
+        right_hash = right[idx += 1]
+      end
+      new_array << left_hash
+      while right_hash && right_hash[:key] == left_hash[:key]
+        right_hash = right[idx += 1]
+      end
+    end
+    while right_hash
+      if previously_added == nil || (right_hash[:key] <=> previously_added) > 0
+        previously_added = right_hash[:key]
+        new_array << {:key => right_hash[:key], :object => block ? block.call(right_hash[:key]) : nil}
+      end
+      right_hash = right[idx += 1]
+    end
+    new_array
+  end
+
+  def self.join(left, right, prototype_container)
+    anchor = 0
+    new_array = prototype_container.slice(0,0)
+    left.each do |left_hash|
+      right_hash = right[anchor]
+      while right_hash && (right_hash[:key] <=> left_hash[:key]) < 0
+        right_hash = right[anchor += 1]
+      end
+      idx = anchor
+      while right_hash && right_hash[:key] == left_hash[:key]
+        new_array << yield(left_hash[:object], right_hash[:object])
+        right_hash = right[idx += 1]
+      end
+    end
+    new_array
+  end
+
+  def self.left_and_right(left_a, right_a, left_key, right_key)
+    left = left_a.map {|x| {:key => left_key ? left_key.call(x) : 0, :object => x}}.sort_by {|x| x[:key]}
+    right = right_a.map {|x| {:key => right_key ? right_key.call(x) : 0, :object => x}}.sort_by {|x| x[:key]}
+    [left, right]
+  end
+end
+
+module Joinable
+  def inner_join(that, &block)
+    RelationalMethods.inner_join(self, that, join_key, that.join_key, &block)
+  end
+
+  def join_on(&block)
+    @join_key = block
+    self
+  end
+
+  def join_key
+    @join_key
+  end
+
+  def fills_with(&block)
+    @fill_row = block
+    self
+  end
+
+  def fill_row
+    @fill_row
+  end
+
+  def cross_join(that, &block)
+    RelationalMethods.inner_join(self, that, nil, nil, &block)
+  end
+
+  def left_join(that, &block)
+    RelationalMethods.left_join(self, that, join_key, that.join_key, that.fill_row, &block)
+  end
+
+  def right_join(that, &block)
+    RelationalMethods.right_join(self, that, join_key, that.join_key, fill_row, &block)
+  end
+
+  def outer_join(that, &block)
+    RelationalMethods.outer_join(self, that, join_key, that.join_key, fill_row, that.fill_row, &block)
+  end
+end
+
+class JoinableArray < Array
+  include Joinable
+end
+

data/test/joinable_array_test.rb

@@ -0,0 +1,83 @@
+require 'lib/joinable_array'
+require 'minitest/autorun'
+
+class JoinableArrayTest < MiniTest::Unit::TestCase
+  def typeA(a,b,c,d)
+    {:a => a, :b => b, :c => c, :d => d}
+  end
+
+  def typeB(a,b,e,f)
+    {:a => a, :b => b, :e => e, :f => f}
+  end
+
+  def setup
+    @a = JoinableArray.new([typeA(4,6,1,2), typeA(7,7,2,2), typeA(8,3,5,5), typeA(9,4,1,7)]) 
+    @b = JoinableArray.new([typeB(8,3,1,2), typeB(8,3,2,2), typeB(7,7,5,5), typeB(1,2,3,4)])
+  end
+
+  def test_simple_join
+    c = @a.
+      join_on {|x| [x[:a], x[:b]]}.
+      inner_join(@b.join_on {|x| [x[:a], x[:b]]}) {|l,r| l.merge(r)}.
+      sort_by {|x| [x[:a], x[:b], x[:c], x[:d], x[:e], x[:f]]}
+
+    assert_equal(3, c.length)
+    assert_equal(@a[1].merge(@b[2]), c[0])
+    assert_equal(@a[2].merge(@b[0]), c[1])
+    assert_equal(@a[2].merge(@b[1]), c[2])
+  end
+
+  def test_left_join
+    c = @a.
+      join_on {|x| [x[:a], x[:b]]}.
+      left_join(@b.
+        join_on {|x| [x[:a], x[:b]]}.
+        fills_with {|key| typeB(key[0], key[1], -1, -2)
+      }) {|l,r| l.merge(r)}.
+      sort_by {|x| [x[:a], x[:b], x[:c], x[:d], x[:e], x[:f]]}
+
+    assert_equal(5, c.length)
+    assert_equal(@a[0].merge({:e => -1, :f => -2}), c[0])
+    assert_equal(@a[1].merge(@b[2]), c[1])
+    assert_equal(@a[2].merge(@b[0]), c[2])
+    assert_equal(@a[2].merge(@b[1]), c[3])
+    assert_equal(@a[3].merge({:e => -1, :f => -2}), c[4])
+  end
+
+  def test_outer_join
+    c = @a.
+      join_on {|x| [x[:a], x[:b]]}.
+      fills_with {|key| typeA(key[0], key[1], -1, -2)}.
+      outer_join(@b.
+        join_on {|x| [x[:a], x[:b]]}.
+        fills_with {|key| typeB(key[0], key[1], -3, -4)}
+      ) {|l,r| l.merge(r)}.
+      sort_by {|x| [x[:a], x[:b], x[:c], x[:d], x[:e], x[:f]]}
+
+    assert_equal(6, c.length)
+    assert_equal(@b[3].merge({:c => -1, :d => -2}), c[0])
+    assert_equal(@a[0].merge({:e => -3, :f => -4}), c[1])
+    assert_equal(@a[1].merge(@b[2]), c[2])
+    assert_equal(@a[2].merge(@b[0]), c[3])
+    assert_equal(@a[2].merge(@b[1]), c[4])
+    assert_equal(@a[3].merge({:e => -3, :f => -4}), c[5])
+  end
+
+  def test_cross_join
+    c = @a.cross_join(@b) {|l,r| l.merge(r)}
+
+    assert_equal(16, c.length)
+    d = []
+    @a.each do |a|
+      @b.each do |b|
+        d << a.merge(b)
+      end
+    end
+
+    c.sort_by! {|x| [x[:a], x[:b], x[:c], x[:d], x[:e], x[:f]]}
+    d.sort_by! {|x| [x[:a], x[:b], x[:c], x[:d], x[:e], x[:f]]}
+
+    assert_equal(d, c)
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: joinable_array
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steven Noble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A way to do sql style joins with Array
+email:
+- steven.noble@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- joinable_array.gemspec
+- lib/joinable_array.rb
+- lib/joinable_array/version.rb
+- test/joinable_array_test.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: joinable arrays
+test_files:
+- test/joinable_array_test.rb