goldmine 2.1.0 → 3.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goldmine
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2016-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Extract a wealth of information from Arrays and Hashes
+description: 
 email:
 - natehop@gmail.com
 executables: []
@@ -77,15 +77,14 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- goldmine.gemspec
 - lib/goldmine.rb
-- lib/goldmine/array_miner.rb
-- lib/goldmine/cache.rb
-- lib/goldmine/hash_miner.rb
-- lib/goldmine/hash_rollup.rb
-- lib/goldmine/rollup_context.rb
+- lib/goldmine/miner.rb
+- lib/goldmine/pivot.rb
+- lib/goldmine/pivot_result.rb
+- lib/goldmine/rollup.rb
+- lib/goldmine/rollup_clean_room.rb
+- lib/goldmine/rollup_result.rb
 - lib/goldmine/version.rb
-- license.md
 - test/test_goldmine.rb
 homepage: https://github.com/hopsoft/goldmine
 licenses:
@@ -107,10 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Extract a wealth of information from Arrays and Hashes
+summary: Extract a wealth of information from Arrays
 test_files:
 - test/test_goldmine.rb
-has_rdoc: 

data/goldmine.gemspec

@@ -1,20 +0,0 @@
-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"
-  gem.add_development_dependency "sinatra"
-end

data/lib/goldmine/array_miner.rb

@@ -1,67 +0,0 @@
-require "delegate"
-
-module Goldmine
-  class ArrayMiner < SimpleDelegator
-    def initialize(array=[])
-      super array.to_a
-    end
-
-    # Pivots the Array into a Hash of mined data.
-    # Think of it as creating a pivot table or perhaps an OLAP cube.
-    #
-    # @example Simple pivot
-    #   list = [1,2,3,4,5,6,7,8,9]
-    #   data = list.pivot { |i| i < 5 }
-    #
-    #   # resulting data
-    #   # {
-    #   #   true  => [1, 2, 3, 4],
-    #   #   false => [5, 6, 7, 8, 9]
-    #   # }
-    #
-    # @example Named pivot
-    #   list = [1,2,3,4,5,6,7,8,9]
-    #   data = list.pivot("less than 5") { |i| i < 5 }
-    #
-    #   # resulting data
-    #   # {
-    #   #   { "less than 5" => true } => [1, 2, 3, 4],
-    #   #   { "less than 5" => false } => [5, 6, 7, 8, 9]
-    #   # }
-    #
-    # @example Chained pivot
-    #   list = [1,2,3,4,5,6,7,8,9]
-    #   data = list.pivot { |i| i < 5 }.pivot { |i| i % 2 == 0 }
-    #
-    #   # resulting data
-    #   {
-    #     [true, false]  => [1, 3],
-    #     [true, true]   => [2, 4],
-    #     [false, false] => [5, 7, 9],
-    #     [false, true]  => [6, 8]
-    #   }
-    #
-    # @param [String] name The named of the pivot.
-    # @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|
-        value = yield(item)
-
-        if value.is_a?(Array)
-          if value.empty?
-            memo.assign_mined(name, nil, item)
-          else
-            value.each { |v| memo.assign_mined(name, v, item) }
-          end
-        else
-          memo.assign_mined(name, value, item)
-        end
-
-        memo.goldmine = true
-        memo
-      end
-    end
-
-  end
-end

data/lib/goldmine/cache.rb

@@ -1,28 +0,0 @@
-module Goldmine
-  class Cache
-
-    def initialize
-      @hash = {}
-    end
-
-    def [](*keys)
-      @hash[make_key(*keys)]
-    end
-
-    def []=(*keys, value)
-      @hash[make_key(*keys)] = value
-    end
-
-    def fetch(*keys)
-      @hash[make_key(*keys)] ||= yield
-    end
-
-    private
-
-    def make_key(*keys)
-      keys.map do |key|
-        key.is_a?(String) ? key.to_sym : key.object_id
-      end
-    end
-  end
-end

data/lib/goldmine/hash_miner.rb

@@ -1,81 +0,0 @@
-require "delegate"
-
-module Goldmine
-  class HashMiner < SimpleDelegator
-    def initialize(hash={})
-      @rollup_cache = Cache.new
-      super @hash = hash.to_h
-    end
-
-    attr_accessor :goldmine
-
-    # Further pivots the Hash into mined data.
-    # This method is what enables the pivot method chaining.
-    #
-    # @example Chained pivot
-    #   list = [1,2,3,4,5,6,7,8,9]
-    #   data = list.pivot { |i| i < 5 }.pivot { |i| i % 2 == 0 }
-    #
-    #   # resulting data
-    #   {
-    #     [true, false]  => [1, 3],
-    #     [true, true]   => [2, 4],
-    #     [false, false] => [5, 7, 9],
-    #     [false, true]  => [6, 8]
-    #   }
-    #
-    # @note This method should not be called directly. Call Array#pivot instead.
-    #
-    # @param name [String] The named of the pivot.
-    # @yield [Object] Yields once for each item in the Array.
-    # @return [Hash] The pivoted Hash of data.
-    def pivot(name=nil, &block)
-      return self unless goldmine
-
-      reduce(HashMiner.new) do |memo, item|
-        key = item.first
-        value = Goldmine.miner(item.last)
-        value.pivot(name, &block).each do |k, v|
-          if key.is_a? Hash
-            k = { block.to_s => k } unless k.is_a?(Hash)
-            new_key = key.merge(k)
-          else
-            new_key = [key, k].flatten
-          end
-          memo[new_key] = v
-        end
-        memo.goldmine = true
-        memo
-      end
-    end
-
-    # Returns a HashRollup with summarized data.
-    #
-    # @yield [Object] Yields once for each pivoted grouping of values.
-    # @return [Hash] The rollup Hash of data.
-    def rollup(name, &block)
-      HashRollup.new(@hash, @rollup_cache).rollup(name, &block)
-    end
-
-    # Assigns a key/value pair to the Hash.
-    # @param name [String] The name of a pivot (can be null).
-    # @param key [Object] The key to use.
-    # @param value [Object] The value to assign
-    # @return [Object] The result of the assignment.
-    def assign_mined(name, key, value)
-      goldmine_key = goldmine_key(name, key)
-      self[goldmine_key] ||= []
-      self[goldmine_key] << value
-    end
-
-    # Creates a key for a pivot-name/key combo.
-    # @param name [String] The name of a pivot (can be null).
-    # @param key [Object] The key to use.
-    # @return [Object] The constructed key.
-    def goldmine_key(name, key)
-      goldmine_key = { name => key } if name
-      goldmine_key ||= key
-    end
-
-  end
-end

data/lib/goldmine/hash_rollup.rb

@@ -1,83 +0,0 @@
-require "delegate"
-require "csv"
-
-module Goldmine
-  class HashRollup < SimpleDelegator
-    attr_reader :names
-
-    def initialize(pivoted, cache=Cache.new)
-      @names = []
-      @cache = cache
-      @context = RollupContext.new(@cache)
-      @pivoted = pivoted
-      super @rolled = {}
-    end
-
-    def rollup(name, &block)
-      names << name
-      pivoted.each do |key, value|
-        @cache.fetch(name, value) do
-          rolled[key] ||= {}
-          rolled[key][name] = @context.instance_exec(value, &block)
-        end
-      end
-      self
-    end
-
-    def to_tabular
-      [].tap do |rows|
-        rows << tabular_header
-        rows.concat tabular_rows
-      end
-    end
-
-    def to_csv_table
-      rows = to_rows.map { |row| CSV::Row.new(row.keys, row.values) }
-      CSV::Table.new rows
-    end
-
-    def to_rows
-      header = tabular_header
-      tabular_rows.map do |tabular_row|
-        {}.tap do |row|
-          header.each_with_index do |header_name, index|
-            row[header_name] = tabular_row[index]
-          end
-        end
-      end
-    end
-
-    private
-
-    attr_reader :pivoted, :rolled
-
-    def tabular_header
-      return [] if empty?
-      to_tabular_header keys.first, values.first
-    end
-
-    def tabular_rows
-      map do |pair|
-        to_tabular_row pair.first, pair.last
-      end
-    end
-
-    def to_tabular_row(key, value)
-      row = key.values.dup if key.is_a?(Hash)
-      row ||= as_array(key).dup
-      row.concat value.values
-    end
-
-    def to_tabular_header(key, value)
-      header = key.keys.map(&:to_s) if key.is_a?(Hash)
-      header ||= (1..as_array(key).size).map { |i| "column#{i}" }
-      header.concat value.keys.map(&:to_s)
-    end
-
-    def as_array(value)
-      return value if value.is_a?(Array)
-      [value]
-    end
-
-  end
-end

data/lib/goldmine/rollup_context.rb

@@ -1,23 +0,0 @@
-module Goldmine
-  class RollupContext
-    def initialize(cache)
-      @cache = cache
-      @computations = {}
-    end
-
-    def computed(name)
-      @computations[name.to_sym] ||= Computation.new(name, @cache)
-    end
-
-    class Computation
-      def initialize(name, cache)
-        @name = name
-        @cache = cache
-      end
-
-      def for(list)
-        @cache[@name, list]
-      end
-    end
-  end
-end

data/license.md

@@ -1,8 +0,0 @@
-# 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.
-