goldmine 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 482001cf15140a91a9974768449d712eb6624be6
-  data.tar.gz: 6cda985ad920d0551ef2a6ab8233b10417984385
+  metadata.gz: 2da17da9ef071e7861b17cce9d420675d9a33113
+  data.tar.gz: e5694ec828554a1e0330256e0cb203bbca7004fb
 SHA512:
-  metadata.gz: dd45fedbbdf42e6735a1ae88454f5e739ab88e6d357df51b1d6737219bf44aa558ebfb660632ac0f47ae7398f462b3a0ff46926384dccc9c445132d0a4cfa931
-  data.tar.gz: d0abda41d61c2f16f37087ecf357369e3d5bc4a81ab72af37d93e281eb5f2414f223058586306129534841b2ef4af4042e4e2a37005a06d7f0cb62b02bcfffde
+  metadata.gz: bb3e37ca75c3dda52415bc671f2e334db814b2755d639654c37b72a69a2c1f606cc9910407d524b5abbd043319de776fb35d284df8945bfabbc6153a42e5b7c3
+  data.tar.gz: 76cc1f317fbde8bdddf364ed3ea7b9734c2df8700dc80beecfb1457118f41aa31bc3ceddceb05814a77344260a56a49526e04d9e65763730a6e2e0469ec60579

data/Gemfile.lock

@@ -1,35 +1,72 @@
 PATH
   remote: .
   specs:
-    goldmine (1.0.0)
+    goldmine (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    coveralls (0.8.1)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    debug_inspector (0.0.2)
     docile (1.1.5)
-    mime-types (2.4.3)
-    multi_json (1.10.1)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    interception (0.5)
+    json (1.8.2)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    netrc (0.10.3)
     os (0.9.6)
-    pry-test (0.5.4)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    pry-rescue (1.4.2)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    pry-test (0.6.4)
       os
-    rake (10.1.0)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    simplecov (0.9.1)
+      pry
+      pry-byebug
+      pry-rescue
+      pry-stack_explorer
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    simplecov (0.10.0)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.2)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.5.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,8 +1,9 @@
-[![Lines of Code](http://img.shields.io/badge/lines_of_code-73-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-89-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
 [![Code Status](http://img.shields.io/codeclimate/github/hopsoft/goldmine.svg?style=flat)](https://codeclimate.com/github/hopsoft/goldmine)
 [![Dependency Status](http://img.shields.io/gemnasium/hopsoft/goldmine.svg?style=flat)](https://gemnasium.com/hopsoft/goldmine)
 [![Build Status](http://img.shields.io/travis/hopsoft/goldmine.svg?style=flat)](https://travis-ci.org/hopsoft/goldmine)
 [![Coverage Status](https://img.shields.io/coveralls/hopsoft/goldmine.svg?style=flat)](https://coveralls.io/r/hopsoft/goldmine?branch=master)
+[![Downloads](http://img.shields.io/gem/dt/goldmine.svg?style=flat)](http://rubygems.org/gems/goldmine)
 
 # Goldmine
 
@@ -141,3 +142,22 @@ end
 }
 ```
 
+# Returning pivots in tabular format
+
+This feature is useful when you need to do things like export to CSV or build user interfaces.
+
+```ruby
+# using the stacked pivot example above
+mined.to_a
+# result:
+[
+  ["Name has an 'e'", ">= 21 years old"],
+  [false, true, 2],
+  [true, true, 2],
+  [true, false, 1]
+]
+```
+
+The first entry is the header row.
+Subsequent entries are data rows.
+The last value in each data row indicates the number of matches.

data/goldmine.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path("../lib/goldmine/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "goldmine"
+  gem.license     = "MIT"
+  gem.version     = Goldmine::VERSION
+  gem.authors     = ["Nathan Hopkins"]
+  gem.email       = ["natehop@gmail.com"]
+  gem.homepage    = "https://github.com/hopsoft/goldmine"
+  gem.summary     = "Extract a wealth of information from Arrays and Hashes"
+  gem.description = "Extract a wealth of information from Arrays and Hashes"
+
+  gem.files       = Dir["lib/**/*.rb", "bin/*", "[A-Z]*"]
+  gem.test_files  = Dir["test/**/*.rb"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "pry-test"
+  gem.add_development_dependency "coveralls"
+end

data/lib/goldmine/array_miner.rb

@@ -2,9 +2,10 @@ require "delegate"
 
 module Goldmine
   class ArrayMiner < SimpleDelegator
+    attr_reader :source_data
 
     def initialize(array=[])
-      super array
+      super @source_data = array
     end
 
     # Pivots the Array into a Hash of mined data.
@@ -46,7 +47,7 @@ module Goldmine
     # @yield [Object] Yields once for each item in the Array
     # @return [Hash] The pivoted Hash of data.
     def pivot(name=nil, &block)
-      reduce(HashMiner.new) do |memo, item|
+      reduce(HashMiner.new(source_data: source_data)) do |memo, item|
         value = yield(item)
 
         if value.is_a?(Array)

data/lib/goldmine/hash_miner.rb

@@ -2,8 +2,10 @@ require "delegate"
 
 module Goldmine
   class HashMiner < SimpleDelegator
+    attr_reader :source_data
 
-    def initialize(hash={})
+    def initialize(hash={}, source_data: nil)
+      @source_data = source_data || hash
       super hash
     end
 
@@ -32,7 +34,7 @@ module Goldmine
     def pivot(name=nil, &block)
       return self unless goldmine
 
-      reduce(HashMiner.new) do |memo, item|
+      reduce(HashMiner.new(source_data: source_data)) do |memo, item|
         key = item.first
         value = Goldmine.miner(item.last)
         value.pivot(name, &block).each do |k, v|
@@ -69,5 +71,24 @@ module Goldmine
       goldmine_key ||= key
     end
 
+    # Returns the pivot keys.
+    # @return [Array]
+    def pivoted_keys
+      first.first.keys
+    end
+
+    # Returns pivoted data as a tabular Array that can be used to build CSVs or user interfaces.
+    # @return [Array] Tabular pivot data
+    def to_a
+      rows = map do |pair|
+        [].tap do |row|
+          row.concat pair.first.values
+          row << pair.last.size
+        end
+      end
+      rows.insert 0, pivoted_keys
+      rows
+    end
+
   end
 end

data/lib/goldmine/version.rb

@@ -1,3 +1,3 @@
 module Goldmine
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/license.md

@@ -0,0 +1,8 @@
+# The MIT License (MIT)
+
+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/test/test_goldmine.rb

@@ -43,6 +43,52 @@ class TestGoldmine < PryTest::Test
     assert data == expected
   end
 
+  test "pivoted_keys" do
+    list = [1,2,3,4,5,6,7,8,9]
+    list = Goldmine::ArrayMiner.new(list)
+    data = list.pivot("less than 5") { |i| i < 5 }
+    expected = ["less than 5"]
+    assert data.pivoted_keys == expected
+  end
+
+  test "to_a tabular data" do
+    list = [
+      { :name => "Sally",   :age => 21 },
+      { :name => "John",    :age => 28 },
+      { :name => "Stephen", :age => 37 },
+      { :name => "Emily",   :age => 32 },
+      { :name => "Joe",     :age => 18 }
+    ]
+    list = Goldmine::ArrayMiner.new(list)
+    mined = list.pivot("Name has an 'e'") do |record|
+      !!record[:name].match(/e/i)
+    end
+    mined = mined.pivot(">= 21 years old") do |record|
+      record[:age] >= 21
+    end
+
+    expected = [["Name has an 'e'", ">= 21 years old"], [false, true, 2], [true, true, 2], [true, false, 1]]
+    assert mined.to_a == expected
+  end
+
+  test "source_data" do
+    list = [
+      { :name => "Sally",   :age => 21 },
+      { :name => "John",    :age => 28 },
+      { :name => "Stephen", :age => 37 },
+      { :name => "Emily",   :age => 32 },
+      { :name => "Joe",     :age => 18 }
+    ]
+    list = Goldmine::ArrayMiner.new(list)
+    mined = list.pivot("Name has an 'e'") do |record|
+      !!record[:name].match(/e/i)
+    end
+    mined = mined.pivot(">= 21 years old") do |record|
+      record[:age] >= 21
+    end
+    assert mined.source_data == list
+  end
+
   test "pivot of list values" do
     list = [
       { :name => "one",   :list => [1] },
@@ -155,6 +201,7 @@ class TestGoldmine < PryTest::Test
     }
 
     assert data == expected
+    assert data.source_data == list
   end
 
   test "named chained pivots" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goldmine
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Extract a wealth of information from Arrays & Hashes
+description: Extract a wealth of information from Arrays and Hashes
 email:
 - natehop@gmail.com
 executables: []
@@ -63,10 +63,12 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- goldmine.gemspec
 - lib/goldmine.rb
 - lib/goldmine/array_miner.rb
 - lib/goldmine/hash_miner.rb
 - lib/goldmine/version.rb
+- license.md
 - test/test_goldmine.rb
 homepage: https://github.com/hopsoft/goldmine
 licenses:
@@ -88,9 +90,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Extract a wealth of information from Arrays & Hashes
+summary: Extract a wealth of information from Arrays and Hashes
 test_files:
 - test/test_goldmine.rb
+has_rdoc: