rubypivot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2976ecf2bef2b1fcc45d0044cbf553ab7b07e0ee8ecd48aca334f13836399016
+  data.tar.gz: 92c6cf0c117a8dbbff68b55a72c760bae6bc62992b1ca7744e9bfe35ebc731eb
+SHA512:
+  metadata.gz: 9575159c5670c6831c9777e98bede1a93e19347f3b9ae6d3f9a848450d78029dc3810323857de554d98d0fa5a72edfd5930173fc049c73b8ee0b28a00b9c4e7c
+  data.tar.gz: a9a32709eec385451e3bd1398e412cc874e7020daf02ad25ca85ed4905606c15ee300e4884dc8a9be906b0da8188d6ec5bb498cd2c3d180b6e90ad22cd5fd4f7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/SetupMemo.md
+.DS_Store

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubypivot.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 utsumi
+
+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,32 @@
+# Rubypivot
+
+Rubypivot is a tool to make pivot table arrays for ruby.
+It transforming a dataset or array of hashes into a spreadsheet-style array.
+
+Suggestions and pull requests are welcome.
+
+## Installation
+
+```
+gem install rubypivot
+```
+Not yet ready, please clone the repository for the moment.
+## Usage
+
+```ruby
+require "rubypivot"
+pivot = Rubypivot::Pivot.new(source_data, :month, :name, :value, data_type: :integer)
+pivot.build.each do |line|
+  p line
+end
+```
+See sample scripts in examples folder.
+
+Supported data aggregation is only SUM for numeric values.
+
+Total calculation supported.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubypivot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/active_record_like.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+#
+# Active record example
+#
+APP_ROOT = File.dirname(__FILE__)
+$LOAD_PATH << "#{APP_ROOT}/../lib"
+require "rubypivot"
+
+MONTHS = {
+  1 => 'Jan',
+  2 => 'Feb',
+  3 => 'Mar',
+}
+NAMES = {
+  1 => 'Wendy',
+  2 => 'John',
+  3 => 'David',
+}
+
+class ActiveRecordLikeRecord
+  def initialize(data) @data = data; end
+  def method_missing(name, *_args) @data[name.to_sym]; end
+end
+
+class ActiveRecordLike
+  SOURCE_DATA = [
+    { month: 1, name: 1, value: 33},
+    { month: 2, name: 1, value: 45},
+    { month: 2, name: 1, value: 55},
+    { month: 1, name: 2, value: 123},
+    { month: 2, name: 2, value: 23},
+    { month: 1, name: 3, value: 3},
+  ]
+  def self.all
+    res = []
+    SOURCE_DATA.each do |data|
+      res << ActiveRecordLikeRecord.new(data)
+    end
+    res
+  end
+end
+
+records = ActiveRecordLike.all
+pivot = Rubypivot::Pivot.new(records, :month, :name, :value)
+pivot.options[:data_type] = :integer
+pivot.options[:column_lookup] = MONTHS
+pivot.options[:row_lookup] = NAMES
+pivot.build.each do |line|
+  p line
+end

data/examples/lookup.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+#
+# Lookup example : column/row header can lookup hash table
+#
+APP_ROOT = File.dirname(__FILE__)
+$LOAD_PATH << "#{APP_ROOT}/../lib"
+require "rubypivot"
+
+MONTHS = {
+  1 => 'Jan',
+  2 => 'Feb',
+  3 => 'Mar',
+}
+NAMES = {
+  1 => 'Wendy',
+  2 => 'John',
+  3 => 'David',
+}
+source_data = [
+  { month: 1, name: 1, value: 33},
+  { month: 2, name: 1, value: 45},
+  { month: 2, name: 1, value: 55},
+  { month: 1, name: 2, value: 123},
+  { month: 2, name: 2, value: 23},
+  { month: 1, name: 3, value: 3},
+]
+
+pivot = Rubypivot::Pivot.new(source_data, :month, :name, :value)
+pivot.options[:data_type] = :integer # or :float or :string or nil for raw data
+pivot.options[:column_lookup] = MONTHS
+pivot.options[:row_lookup] = NAMES
+pivot.options[:row_total] = 'Personal Total'
+# pivot.options[:header] = false
+# pivot.options[:row_header] = false
+pivot.build.each do |line|
+  p line
+end
+puts "------------"
+p pivot.total_row('Total')
+

data/examples/simple.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+#
+# Simple example
+#
+APP_ROOT = File.dirname(__FILE__)
+$LOAD_PATH << "#{APP_ROOT}/../lib"
+require "rubypivot"
+
+source_data = [
+  { month: 'Jan', name: 'Wendy', value: 33},
+  { month: 'Feb', name: 'Wendy', value: 45},
+  { month: 'Feb', name: 'Wendy', value: 55},
+  { month: 'Jan', name: 'John', value: 123},
+  { month: 'Feb', name: 'John', value: 23},
+  { month: 'Jan', name: 'David', value: 3},
+]
+
+pivot = Rubypivot::Pivot.new(source_data, :month, :name, :value, data_type: :integer)
+pivot.column_titles = ['Jan', 'Feb', 'Mar']
+# pivot.options[:header] = true
+# pivot.options[:row_header] = false
+# pivot.column_titles.sort!
+# p pivot.column_titles
+# p pivot.row_titles
+pivot.build.each do |line|
+  p line
+end
+puts "------------"
+p pivot.total_row('Total')
+
+#["", "Jan", "Feb", "Mar"]
+#["David", 3, nil, nil]
+#["John", 123, 23, nil]
+#["Wendy", 33, 100, nil]

data/lib/rubypivot.rb

@@ -0,0 +1,9 @@
+# require "rubypivot/version"
+require "rubypivot/pivot"
+require "rubypivot/pivot_row"
+
+module Rubypivot
+  VERSION = "0.0.1" # Pre-release
+
+  class PivotError < StandardError; end
+end

data/lib/rubypivot/pivot.rb

@@ -0,0 +1,149 @@
+module Rubypivot
+
+  class Pivot
+    DEFAULT_OPTIONS = {
+      data_type: :integer, # :integer, :float or :string
+      column_sort: true,
+      row_sort: true,
+      header: true,
+      row_header: true,
+      # column_lookup: HashName
+      # row_lookup: HashName
+      # :row_total: 'Title for total column'
+    }.freeze
+
+    attr_accessor :options
+    def initialize(source_data, column_name, row_name, value_name, options = {})
+      @options = DEFAULT_OPTIONS.dup
+      @options.merge! options if options
+      raise PivotError, "Source Data must be an array of [hash|dataset]." if !source_data.is_a?(Array)
+      raise PivotError, "Column name must be specified." if column_name.nil?
+      raise PivotError, "Row name must be specified." if row_name.nil?
+      raise PivotError, "Value name must be specified." if value_name.nil?
+      # TODO: error checks for options
+      @column_name = column_name.to_sym
+      @row_name = row_name.to_sym
+      @value_name = value_name.to_sym
+      @source_data = source_data
+      #
+      @rows_parsed = nil # holds hash of DataRow instances
+      @column_titles = nil # array of column titles
+      @row_titles = nil # array of row titles
+    end
+
+    # Column title can be predefined by caller
+    def column_titles= (new_array)
+      raise PivotError, "Column title must be an array" unless new_array.is_a?(Array)
+      @column_titles = new_array
+    end
+    # Scan source data and buide titles array
+    def column_titles
+      @column_titles ||= make_column_list
+    end
+    # Row title can be predefined by caller
+    def row_titles= (new_array)
+      raise PivotError, "Row title must be an array" unless new_array.is_a?(Array)
+      @row_titles = new_array
+    end
+    # Scan source data and buide titles array
+    def row_titles
+      @row_titles || make_row_list
+    end
+
+    def make_column_list
+      @column_titles = [] unless @column_titles
+      @source_data.each do |each_line|
+        title = Pivot.get_title(@column_name, each_line)
+        @column_titles << title unless @column_titles.include?(title)
+      end
+      @column_titles.sort! if @options[:column_sort]
+      @column_titles
+    end
+  
+    def make_row_list
+      @row_titles = [] unless @row_titles
+      @source_data.each do |each_line|
+        title = Pivot.get_title(@row_name, each_line)
+        @row_titles << title unless @row_titles.include?(title)
+      end
+      @row_titles.sort! if @options[:row_sort]
+      @row_titles
+    end
+
+    def parse_data
+      make_column_list unless @column_titles
+      make_row_list unless @row_titles
+      @rows_parsed = PivotRows.new(@options)
+      @source_data.each do |each_line|
+        column_title = Pivot.get_title(@column_name, each_line)
+        row_title = Pivot.get_title(@row_name, each_line)
+        value = Pivot.get_value(@value_name, each_line)
+        row = @rows_parsed.get_row(row_title) # create a new row if not exists
+        row.add(column_title, value)
+      end
+      self
+    end
+
+    def column_header
+      res = []
+      res << '' if @options[:row_header]
+      if @options[:column_lookup]
+        @column_titles.each do |column|
+          res << @options[:column_lookup][column]
+        end
+      else
+        res += @column_titles
+      end
+      res << @options[:row_total] if @options[:row_total]
+      res
+    end
+
+    # return an pivot array
+    def build
+      parse_data unless @rows_parsed
+      res = []
+      res << column_header if @options[:header]
+      @row_titles.each do |row_title|
+        row = @rows_parsed.get_row(row_title)
+        data_array = []
+        data_array << @rows_parsed.header(row_title) if @options[:row_header]
+        data_array += row.to_a(column_titles)
+        data_array << row.total(column_titles) if @options[:row_total]
+        res << data_array
+      end
+      res
+    end
+
+    def total_row(title = nil)
+      parse_data unless @rows_parsed
+      # title: message at title row, third(3) param is grand total true/false
+      res = []
+      res << title if @options[:row_header]
+      res += @rows_parsed.total(@column_titles, @options[:row_total])
+    end
+  
+    def self.build(data, column_name, row_name, data_name, options = {})
+      obj = self.new(data, column_name, row_name, data_name, options)
+      obj.build
+    end
+    # get column title or row title
+    def self.get_title(name, line)
+      if line.is_a?(Hash)
+        res = line[name]
+      else
+        res = line.send(name)
+      end
+      res = 'Empty' if res.nil?
+      res
+    end
+
+    def self.get_value(name, line)
+      if line.is_a?(Hash)
+        line[name]
+      else
+        line.send(name)
+      end
+    end
+    
+  end
+end

data/lib/rubypivot/pivot_column.rb

@@ -0,0 +1,5 @@
+# Not used at this moment
+module Rubypivot
+  class PivotColumn
+  end
+end

data/lib/rubypivot/pivot_row.rb

@@ -0,0 +1,81 @@
+module Rubypivot
+  class PivotRows
+    attr_reader :rows, :data_type
+    def initialize(options = {})
+      @options = options
+      @data_type = options[:data_type]
+      @lookup = options[:row_lookup]
+      @rows = {}
+    end
+
+    def get_row(row_title)
+      @rows[row_title] ||= PivotRow.new(row_title, @data_type)
+    end
+    alias :add_row :get_row
+
+    def header(row_title)
+      @lookup ? @lookup[row_title] : row_title
+    end
+
+    def total(column_titles = [], show_grand_total = false)
+      return ['Total', 'row', 'can', 'not', 'create', "type :#{@data_type}"] unless [:integer, :float].include?(@data_type)
+      grand_total = @data_type == :float ? 0.0 : 0
+      data_array = []
+      column_titles.each do |column_title|
+          total = @data_type == :float ? 0.0 : 0
+          @rows.each do |row_title, row|
+            v = row.get(column_title)
+            total += v if v
+          end
+          grand_total += total if show_grand_total
+          data_array << total
+      end
+      data_array << grand_total if show_grand_total
+      data_array
+    end
+  end
+
+  class PivotRow
+    attr_reader :title
+    def initialize(title, data_type = nil)
+      @title = title # Title of the row : String
+      @data_type = data_type
+      @data = {}
+    end
+
+    def add(column_title, value)
+      return unless value
+      case @data_type
+      when :integer
+        @data[column_title] = 0 unless @data[column_title]
+        @data[column_title] += value.to_i
+      when :float
+        @data[column_title] = 0.0 unless @data[column_title]
+        @data[column_title] += value.to_f
+      when :string
+        @data[column_title] = value.to_s
+      else # raw data
+        @data[column_title] = value
+      end
+    end
+
+    def get(column_title)
+      return nil if column_title.nil?
+      @data[column_title]
+    end
+
+    def to_a(column_titles)
+      column_titles.map{|column_title| @data[column_title] }
+    end
+
+    def total(column_titles)
+      return unless [:integer, :float].include?(@data_type)
+      total = @data_type == :float ? 0.0 : 0
+      column_titles.each do |column_title|
+        total += @data[column_title] if @data[column_title]
+      end
+      total
+    end
+
+  end
+end

data/lib/rubypivot/version.rb

@@ -0,0 +1,3 @@
+module Rubypivot
+  VERSION = "0.0.1" # Pre-release
+end

data/rubypivot.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/rubypivot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubypivot"
+  spec.version       = Rubypivot::VERSION
+  spec.authors       = ["hiro utsumi"]
+  spec.email         = ["gambaldia@gmail.com"]
+
+  spec.summary       = "A tool to make pivot table arrays for ruby"
+  spec.description   = "Transforming a dataset or array of hashes into a spreadsheet-style array"
+  spec.homepage      = "https://github.com/gambldia/rubypivot"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = ""
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rubypivot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hiro utsumi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-28 00:00:00.000000000 Z
+dependencies: []
+description: Transforming a dataset or array of hashes into a spreadsheet-style array
+email:
+- gambaldia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SetupMemo.md
+- bin/console
+- bin/setup
+- examples/active_record_like.rb
+- examples/lookup.rb
+- examples/simple.rb
+- lib/rubypivot.rb
+- lib/rubypivot/pivot.rb
+- lib/rubypivot/pivot_column.rb
+- lib/rubypivot/pivot_row.rb
+- lib/rubypivot/version.rb
+- rubypivot.gemspec
+homepage: https://github.com/gambldia/rubypivot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gambldia/rubypivot
+  source_code_uri: https://github.com/gambldia/rubypivot
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A tool to make pivot table arrays for ruby
+test_files: []