group_by_summary 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d88a626a72ccd137f934c59f4b2fd1c84d4474fe
+  data.tar.gz: 22f244aebe0881404f48f0e3e215f8ed09d248f3
+SHA512:
+  metadata.gz: 0f3464d2d35df6b79c3c27ae2abb7ca9dc1cf9aeee90ac4827ecd168672262874825cdeeda54e4679d0d3314c93e232930d0c8f52000ab6268b5a7c8a3da46ff
+  data.tar.gz: 7ec45c60d9504cdc208930e8303f2af199f72bcac1244152269ba0881b00fadb3374271445b42a1fe9065e9524f1b16c251cc4e8a0bd36584264bf4d3b2b79fa

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 jimjames99
+
+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,107 @@
+# GroupBySummary
+![Travis badge](https://travis-ci.org/jimjames99/group_by_summary.svg?branch=master)
+
+You run a chain of stores that carry different kinds of fruit. Which stores carry which fruit?
+The query for store name, fruit, and quantity in stock returns many rows for each store:
+
+```StoreInventory.group(:name, :fruit).pluck(:name, :fruit, 'sum(quantity)')```
+
+```
+[
+['Eastside', 'banana', 44],
+['Eastside', 'apple', 22],
+['Westside', 'banana', 33],
+['Westside', 'orange', 44],
+['Northside', 'tomato', 55],
+with many rows for each store
+]
+```
+
+You want to consolidate those rows into pretty summary table with only one row per store like this (output by [TerminalTable](https://github.com/tj/terminal-table)):
+
+```
+|           | apple | banana | orange | tomato |
+|-----------|------:|-------:|-------:|-------:|
+| Eastside  |    22 |     44 |        |        |
+| Westside  |       |     33 |     44 |        |
+| Northside |       |        |        |     55 |
+```
+
+Or you want to tab-separate the row values so you can paste it into an Excel spreadsheet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'group_by_summary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install group_by_summary
+
+## Usage
+
+Create a summary object by passing an array of arrays. The output of this arel is perfect:
+```StoreInventory.group(:name, :fruit).pluck(:name, :fruit, 'sum(quantity)')```
+Each array containing 2 or 3 elements:
+* entity name
+* attribute for column heading
+* value to be displayed in the cell (optional)
+
+```
+require 'group_by_summary'
+raw_rows = 
+  [
+    ['Eastside', 'banana', 44],
+    ['Eastside', 'apple', 22],
+    ['Westside', 'banana', 33],
+    ['Westside', 'orange', 44],
+    ['Northside', 'tomato', 55]
+  ]
+summary = GroupBySummary.new(raw_rows)
+```
+
+Column headings for the table are extracted from the second element in the array 
+```
+summary.heading
+=> [nil, 'apple', 'banana', 'orange', 'tomato']
+```
+ If you want to give a column heading for the entity column (first col), give it a name:
+```
+summary.heading('Store')
+=> ['Store', 'apple', 'banana', 'orange', 'tomato']
+```
+Install the [TerminalTable gem](https://github.com/tj/terminal-table) to display a nice table:
+```
+require 'terminal-table'
+table = Terminal::Table.new(rows: summary.rows)
+table.headings = summary.heading
+puts table
+=>
++-----------+-------+--------+--------+--------+
+|           | apple | banana | orange | tomato |
++-----------+-------+--------+--------+--------+
+| Eastside  | 22    | 44     |        |        |
+| Westside  |       | 33     | 44     |        |
+| Northside |       |        |        | 55     |
++-----------+-------+--------+--------+--------+
+```
+Or output to console with tab separators so you can paste into an Excel spreadsheet. If values are not present an x is printed. 
+```
+puts summary.to_s(:tab)
+=>
+	apple	banana	orange	tomato
+Eastside	x	x
+Westside		x	x
+Northside				x
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'group_by_summary'
+
+# 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

data/bin/setup

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

data/group_by_summary.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'group_by_summary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'group_by_summary'
+  spec.version       = GroupBySummary::VERSION
+  spec.authors       = ['jimjames99']
+  spec.email         = ['jim@jimjames.org']
+
+  spec.summary       = %q{Takes array produced from StoreInventory.group(:name, :fruit).pluck(:name, :fruit, 'sum(quantity)') and produces an array of arrays suitable for display in a table.}
+  spec.homepage      = 'https://github.com/jimjames99/group_by_summary'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '>= 1.7.6', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5'
+end

data/lib/array_named_access.rb

@@ -0,0 +1,11 @@
+module ArrayNamedAccess
+
+  def second
+    self[1]
+  end
+
+  def third
+    self[2]
+  end
+
+end

data/lib/group_by_summary.rb

@@ -0,0 +1,70 @@
+require 'group_by_summary/version'
+require 'array_named_access'
+
+class GroupBySummary
+
+  attr_reader :list_of_items
+
+  # Imagine you run a chain of stores that sell different kinds of fruit.
+  # Query for store name and kind of fruit in stock:
+  # StoreInventory.group(:name, :fruit).pluck(:name, :fruit, 'sum(quantity)')
+  # [
+  #   ['Eastside', 'banana', 44],
+  #   ['Eastside', 'apple', 22],
+  #   ['Westside', 'banana', 33],
+  #   ['Westside', 'orange', 44],
+  #   ['Northside', 'tomato', 55],
+  # ]
+  #
+  # Order matters here: entity, attributes, value (optional)
+  # Also must be ordered by entity.
+  #
+  def initialize(arr=[])
+    @list_of_items = Array.new(arr).extend(ArrayNamedAccess)
+    @list_of_items.each { |a| a.extend(ArrayNamedAccess) }
+  end
+
+  # ['apple', 'banana', 'orange', 'tomato']
+  def column_names
+    @column_names ||= @list_of_items.collect(&:second).uniq.sort
+  end
+
+  # ['Store', 'apple', 'banana', 'orange', 'tomato']
+  def heading(entity_name=nil)
+    [entity_name] + column_names
+  end
+
+  def heading_with_tabs(entity_name=nil)
+    heading(entity_name).join("\t")
+  end
+
+  def rows
+    rows = []
+    @list_of_items.group_by(&:first).each do |store|
+      store.extend(ArrayNamedAccess)
+      store_row = [nil] * heading.size
+      # Add the entity name to the start of the row.
+      store_row[0] = store.first
+      # Fill in values for each column (remember entity name is already first position).
+      store.second.each do |tuple|
+        store_row[@column_names.index(tuple.second) + 1] = (tuple.third || 'x')
+      end
+      rows << store_row
+    end
+    rows
+  end
+
+  # Ruby's join is recursive and we want to keep the top level arrays.
+  def rows_with_tabs
+    rows.collect { |i| i.join("\t") }
+  end
+
+  def to_s(opt=nil)
+    if opt == :tab
+      [heading_with_tabs] + rows_with_tabs
+    else
+      [heading] + rows
+    end
+  end
+
+end

data/lib/group_by_summary/version.rb

@@ -0,0 +1,3 @@
+class GroupBySummary
+  VERSION = '0.2.1'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: group_by_summary
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- jimjames99
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email:
+- jim@jimjames.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- group_by_summary.gemspec
+- lib/array_named_access.rb
+- lib/group_by_summary.rb
+- lib/group_by_summary/version.rb
+homepage: https://github.com/jimjames99/group_by_summary
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Takes array produced from StoreInventory.group(:name, :fruit).pluck(:name,
+  :fruit, 'sum(quantity)') and produces an array of arrays suitable for display in
+  a table.
+test_files: []