cross_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0bcc53f43aac877f900cb638581320071b6c96a2920517c9952270a919874833
+  data.tar.gz: 406e52dcf8f08c8c5925b3488e04556c95170c6e5403474f12c6eb9e5bcf9c6b
+SHA512:
+  metadata.gz: bd223cafe127ffebb432669ee586df26e0cf0c759e2ec5243c29707759612a022dcf27b12b5a9c8ed5df56d70d51ae35445d069227ed8a838a83520fd6b67325
+  data.tar.gz: df08520e8cf9e8eef3cb92e48ef9f9d02f0afab0e93c190d17d6f69125434990935bcae96d13ab6acda776e387b5762b1983fcd8d915eb3d6e77c02088b13efc

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  
+Style/YodaCondition:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-06-18 13:29:48 +0900 using RuboCop version 0.71.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 58
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 45
+
+# Offense count: 3
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cross_table.gemspec
+gemspec
+
+gem 'rubocop', require: false

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    cross_table (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  cross_table!
+  rake (~> 10.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 masa.kunikata
+
+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,166 @@
+# CrossTable
+
+Cross tabulation (Pivot table) utility
+to convert table data to a pivot table form.
+  
+<div>
+
+<div style="float:left;">
+
+   *Source (List table)*
+
+  |os     |lang |price|
+  |:---   |:--- |--:|
+  |win    |ruby |123|
+  |linux  |ruby |12|
+  |mac    |php  |270|
+  |win    |java |560|
+  |win    |php  |750|
+  |linux  |java |950|
+  |win    |java |1200|
+  |win    |php  |500|
+  |mac    |php  |10|
+  |mac    |java |566|
+  |win    |ruby |210|
+
+</div>
+
+<div style="float:left;">
+  
+  &nbsp;&gt;&gt;&gt;&nbsp;
+ 
+</div>
+
+<div style="float:left;">
+
+  *Destination (Pivot table)*
+
+  |     |ruby |java |php  |
+  |:--  |  --:|  --:|  --:|
+  |win  | 333 |1760 |1250 |
+  |linux| 12  |950  |0    |
+  |mac  | 0   |566  |280  |
+
+</div>
+
+</div>
+
+<br style="clear: both;"/>
+
+[The test code to get the sample table above.](test/cross_table_readme_sample_test.rb)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cross_table'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cross_table
+
+## Usage
+
+### Records Count
+
+```ruby
+require 'cross_table'
+
+cross_tbl = CrossTable.counts_from(
+  recs: [],         # Source List Table(Enumerable)
+  group_rules: [],  # Grouping Rules (Array of Hash)
+  y_keys: [],       # Y-axis Keys (Array)
+  x_keys: []        # X-axis Keys (Array)
+  ret_type: nil     # Type of returned Pivot table. (nil|:xy_titles|:data_only)
+)
+
+```
+
+[Sample test code of CrossTable.counts_from](test/cross_table_counts_test.rb)
+
+[Sample data and group_rule setting](test/test_sample.rb)
+
+
+### Fields Summary
+
+```ruby
+require 'cross_table'
+
+cross_tbl = CrossTable.sums_from(
+  recs: [],         # Source List Table(Enumerable of Hash)
+  field: :fld_name  # Target field name to be summarised
+  group_rules: [],  # Grouping Rules (Array of Hash)
+  y_keys: [],       # Y-axis Keys (Array)
+  x_keys: []        # X-axis Keys (Array)
+  ret_type: nil     # Type of returned Pivot table. (nil|:xy_titles|:data_only)
+)
+
+```
+
+[Sample test code of CrossTable.sums_from](test/cross_table_sums_test.rb)
+
+[Sample data and group_rule setting](test/test_sample.rb)
+
+### Fields Average
+
+```ruby
+require 'cross_table'
+
+cross_tbl = CrossTable.avgs_from(
+  recs: [],         # Source List Table(Enumerable of Hash)
+  field: :fld_name  # Target field name to be summarised
+  group_rules: [],  # Grouping Rules (Array of Hash)
+  y_keys: [],       # Y-axis Keys (Array)
+  x_keys: []        # X-axis Keys (Array)
+  ret_type: nil     # Type of returned Pivot table. (nil|:xy_titles|:data_only)
+)
+
+```
+
+[Sample test code of CrossTable.avgs_from](test/cross_table_avgs_test.rb)
+
+[Sample data and group_rule setting](test/test_sample.rb)
+
+### Arbitrary property of grouped records
+
+```ruby
+require 'cross_table'
+
+cross_tbl = CrossTable.from(
+  recs: [],         # Source List Table(Enumerable of Hash)
+  group_rules: [],  # Grouping Rules (Array of Hash)
+  y_keys: [],       # Y-axis Keys (Array)
+  x_keys: []        # X-axis Keys (Array)
+  ret_type: nil     # Type of returned Pivot table. (nil|:xy_titles|:data_only)
+  &aggr_proc        # Proc/block to get a value from the arg "group_recs"
+)
+
+```
+
+[Sample test code of CrossTable.from to get a Minumum value.](test/cross_table_from_test.rb)
+
+[Sample data and group_rule setting](test/test_sample.rb)
+
+### Multiple Keys Grouping
+
+[Sample test code of using multilpe keys.](test/cross_table_multiple_keys_test.rb)
+
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/masa-kunikata/cross_table.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+RuboCop::RakeTask.new(:lint)
+
+desc 'Run test_unit based test'
+Rake::TestTask.new do |t|
+  # To run test for only one file (or file path pattern)
+  #  $ bundle exec rake test TEST=test/test_specified_path.rb
+  t.libs << 'test'
+  t.test_files = Dir['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/cross_table.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cross_table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cross_table'
+  spec.version       = CrossTable::VERSION
+  spec.authors       = ['masa.kunikata']
+  spec.email         = ['masa.kunikata@gmail.com']
+
+  spec.summary       = 'cross tabulation "pivot table" utility'
+  spec.homepage      = 'https://github.com/masa-kunikata/cross_table'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/cross_table/grouping.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CrossTable
+  # group process
+  module Grouping
+    module_function
+
+    def group(recs, group_rules, &aggr_proc)
+      all_titles  = product_all(group_rules.map(&:keys))
+      all_procs   = product_all(group_rules.map(&:values))
+
+      auto_dig_hash = Hash.new { |h, k| h[k] = h.class.new(&h.default_proc) }
+      all_titles.zip(all_procs).each do |dig_keys, filter_procs|
+        group_recs = filter_procs.reduce(recs) do |memo, proc|
+          memo.select(&proc)
+        end
+        value = aggr_proc[group_recs]
+
+        last_key = dig_keys.pop
+        auto_dig_hash.dig(*dig_keys).store(last_key, value)
+      end
+      auto_dig_hash
+    end
+
+    def counts(recs, group_rules)
+      group(recs, group_rules, &:count)
+    end
+
+    def sums(recs, field, group_rules)
+      group(recs, group_rules) do |group_recs|
+        group_recs.map { |r| r[field] }.sum
+      end
+    end
+
+    def avgs(recs, field, group_rules)
+      group(recs, group_rules) do |group_recs|
+        sum = group_recs.map { |r| r[field] }.sum
+        count = group_recs.count
+        sum.to_f / count.to_f
+      end
+    end
+
+    class << self
+      private
+
+      def product_all(list)
+        list.first.product(*list[1..-1])
+      end
+    end
+  end
+end

data/lib/cross_table/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CrossTable
+  VERSION = '0.1.0'
+end

data/lib/cross_table.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'cross_table/version'
+require 'cross_table/grouping'
+
+# cross tabulation (pivot table) utility
+module CrossTable
+  module_function
+
+  def from(recs:, group_rules:, y_keys:, x_keys:, ret_type: nil, &aggr_proc)
+    of(Grouping.group(recs, group_rules, &aggr_proc),
+       y_keys: y_keys, x_keys: x_keys,
+       ret_type: ret_type)
+  end
+
+  def counts_from(recs:, group_rules:, y_keys:, x_keys:, ret_type: nil)
+    of(Grouping.counts(recs, group_rules),
+       y_keys: y_keys, x_keys: x_keys,
+       ret_type: ret_type)
+  end
+
+  def sums_from(recs:, field:, group_rules:, y_keys:, x_keys:, ret_type: nil)
+    of(Grouping.sums(recs, field, group_rules),
+       y_keys: y_keys, x_keys: x_keys,
+       ret_type: ret_type)
+  end
+
+  def avgs_from(recs:, field:, group_rules:, y_keys:, x_keys:, ret_type: nil)
+    of(Grouping.avgs(recs, field, group_rules),
+       y_keys: y_keys, x_keys: x_keys,
+       ret_type: ret_type)
+  end
+
+  def of(grouped_hash, y_keys:, x_keys:, ret_type: nil)
+    vals = y_keys.map do |y_dig_keys|
+      x_keys.map do |x_dig_keys|
+        grouped_hash.dig(*y_dig_keys).dig(*x_dig_keys)
+      end
+    end
+
+    case ret_type
+    when :data_only
+      return vals
+
+    when :xy_titles
+      return ([nil] + y_keys).zip([x_keys] + vals).map do |row_title, value_row|
+        [row_title] + value_row
+      end
+    end
+
+    y_keys.map.zip(
+      vals.map do |row|
+        x_keys.zip(row).to_h
+      end
+    ).to_h
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: cross_table
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- masa.kunikata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- masa.kunikata@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- cross_table.gemspec
+- lib/cross_table.rb
+- lib/cross_table/grouping.rb
+- lib/cross_table/version.rb
+homepage: https://github.com/masa-kunikata/cross_table
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: cross tabulation "pivot table" utility
+test_files: []