groups_by 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f28904725eec72b0357363797953cb4a3b8445a
+  data.tar.gz: afadd8777ad851fff079af13724a013c212f5d6e
+SHA512:
+  metadata.gz: '0483d2eb03687589d708de912edaed59e85c8c7dea0d82b8d4aa4d50902e91991f6a6196d50e275be54d84f0dc28c28a2c85d0ee8518209b6ec39894c994689a'
+  data.tar.gz: 40f60d4bee8460a739584ef98f4650c0a4f36b2ada65cad3a29ca486b52f758b9016fe803b348493fd07e5190cb1f494770aa4a0553a8cb1cc61fde623e72f4c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at karol.zygmunt.blaszczyk@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'colorize'
+  gem 'faker'
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Karol Błaszczyk
+
+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,141 @@
+# GroupsBy
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'groups_by'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install groups_by
+
+## Usage
+
+There are several ways of using groups_by.
+
+### Base
+  The first way is to go through the `GroupsBy` class itself.
+
+  ```ruby
+      require 'groups_by'
+
+      # @param source [Array<Hash>]
+      # @option [Array<String,Symbol,Proc>] :group_by_rules
+      # @option [Proc] :summarizer
+      GroupsBy.new.groups_by(
+              source,
+              group_by_rules: grouping_rules,
+              summarizer: summarizer)
+  ```
+### CoreExt
+  The second way is to modify the Array class by including core extension.
+  ```ruby
+      require 'groups_by/core_ext/array'   # extends only Array
+
+      data = [
+        { value1: 10, value2: 100, name: 'Stanton',  company: 'Smith Inc', id: '-one-' },
+        { value1: 20, value2: 200, name: 'Stanton',  company: 'Fisher LLC', id: '-three-' },
+        { value1: 50, value2: 500, name: 'Darrel', company: 'Smith Inc', id: '-three-' }
+      ]
+
+      result = data.groups_by(:name, :company, ->(el) { el[:id][/\w+/]})
+      # => {"Stanton"=>{"Smith Inc"=>{"one"=>[{:value1=>10, :value2=>100, :name=>"Stanton", :company=>"Smith Inc", :id=>"-one-"}]}, "Fisher LLC"=>{"three"=>[{:value1=>20, :value2=>200, :name=>"Stanton", :company=>"Fisher LLC", :id=>"-three-"}]}}, "Darrel"=>{"Smith Inc"=>{"three"=>[{:value1=>50, :value2=>500, :name=>"Darrel", :company=>"Smith Inc", :id=>"-three-"}]}}}
+
+      GroupsBy.pritify result
+      # =>
+      #   Stanton
+  	#   	Smith Inc
+  	#   		one
+  	#   			value1    value2    name      company   id
+  	#   			10        100       Stanton   Smith Inc -one-
+  	#   	Fisher LLC
+  	#   		three
+  	#   			value1     value2     name       company    id
+  	#   			20         200        Stanton    Fisher LLC -three-
+  	#   Darrel
+  	#   	Smith Inc
+  	#   		three
+  	#   			value1    value2    name      company   id
+  	#   			50        500       Darrel    Smith Inc -three-      
+```
+
+### Summarizer
+  You can pass summarize logic into grouper to summarize desirable values
+  ```ruby
+      data = [
+        { value1: 10, value2: 100, name: 'Stanton',  company: 'Smith Inc', id: '-one-' },
+        { value1: 20, value2: 200, name: 'Stanton',  company: 'Fisher LLC', id: '-three-' },
+        { value1: 50, value2: 500, name: 'Darrel', company: 'Smith Inc', id: '-three-' }
+      ]
+
+      grouping_rules = [:name, :company, ->(el) { el[:id][/\w+/]}]
+
+      summarizer = lambda do |elements|
+        {
+          value1_sum: elements.map { |m| m[:value1].to_f }.reduce(&:+),
+          value2_sum: elements.map { |m| m[:value2].to_f }.reduce(&:+)
+        }
+      end
+
+      result = GroupsBy.new.groups_by(
+              data,
+              group_by_rules: grouping_rules,
+              summarizer: summarizer)      
+      # => {"Stanton"=>{"Smith Inc"=>{"one"=>{:values=>[{:value1=>10, :value2=>100, :name=>"Stanton", :company=>"Smith Inc", :id=>"-one-"}]}, :totals=>{:value1_sum=>10.0, :value2_sum=>100.0}}, "Fisher LLC"=>{"three"=>{:values=>[{:value1=>20, :value2=>200, :name=>"Stanton", :company=>"Fisher LLC", :id=>"-three-"}]}, :totals=>{:value1_sum=>20.0, :value2_sum=>200.0}}, :totals=>{:value1_sum=>30.0, :value2_sum=>300.0}}, "Darrel"=>{"Smith Inc"=>{"three"=>{:values=>[{:value1=>50, :value2=>500, :name=>"Darrel", :company=>"Smith Inc", :id=>"-three-"}]}, :totals=>{:value1_sum=>50.0, :value2_sum=>500.0}}, :totals=>{:value1_sum=>50.0, :value2_sum=>500.0}}, :totals=>{:value1_sum=>80.0, :value2_sum=>800.0}}
+
+      GroupsBy.pritify result
+      # =>
+      # Stanton
+    	# 	Smith Inc
+    	# 		one
+    	# 			value1    value2    name      company   id
+    	# 			10        100       Stanton   Smith Inc -one-
+    	# 		value1_sum value2_sum
+    	# 		10.0       100.0
+    	# 	Fisher LLC
+    	# 		three
+    	# 			value1     value2     name       company    id
+    	# 			20         200        Stanton    Fisher LLC -three-
+    	# 		value1_sum value2_sum
+    	# 		20.0       200.0
+    	# 	value1_sum value2_sum
+    	# 	30.0       300.0
+    	# Darrel
+    	# 	Smith Inc
+    	# 		three
+    	# 			value1    value2    name      company   id
+    	# 			50        500       Darrel    Smith Inc -three-
+    	# 		value1_sum value2_sum
+    	# 		50.0       500.0
+    	# 	value1_sum value2_sum
+    	# 	50.0       500.0
+    	# value1_sum value2_sum
+    	# 80.0       800.0     
+```  
+### Pritify
+  Display grouped array in prettified way
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/karol-blaszczyk/groups_by. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GroupsBy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/groups_by/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'groups_by/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'groups_by'
+  spec.version       = GroupsBy::VERSION
+  spec.authors       = ['Karol Błaszczyk']
+  spec.email         = ['karol.zygmunt.blaszczyk@gmail.com']
+
+  spec.summary       = 'groups_by'
+  spec.description   = '#group_by with multiple grouping rules.'
+  spec.homepage      = 'https://github.com/karol-blaszczyk/groups_by'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/groups_by.rb

@@ -0,0 +1,30 @@
+%w[
+  groups_by/version
+  colorize
+  groups_by/pritifier
+  groups_by/core_grouper
+  pry
+].each do |lib|
+  require lib
+end
+
+class GroupsBy
+  include CoreGrouper
+
+  class << self
+    include Pritifier
+  end
+
+  # GroupsBy.new.groups_by(
+  #   source: DATA,
+  #   group_by_rules: [:age_range, :age_range_state, :ad_group_state, :is_negative],
+  #   summarizer: nil
+  # )
+  attr_accessor :source_arr, :group_by_rules, :summarizer
+  def groups_by(source_arr, group_by_rules: [], summarizer: nil)
+    @source_arr = source_arr
+    @group_by_rules = group_by_rules
+    @summarizer = summarizer
+    group(source_arr, group_by_rules)
+  end
+end

data/lib/groups_by/core_ext/array.rb

@@ -0,0 +1,7 @@
+require 'groups_by'
+
+class Array
+  def groups_by(*grouping_rules)
+    GroupsBy.new.groups_by(self, group_by_rules: grouping_rules)
+  end
+end

data/lib/groups_by/core_grouper.rb

@@ -0,0 +1,47 @@
+module CoreGrouper
+  UNDEFINED_GROUP_NAME = '_unknown_group_'.freeze
+
+  class InvalidGrouping < StandardError; end
+
+  # @param source [Array<Hash>]
+  # @param group_by_rules [Array<String,Symbol,Proc>]
+  def group(source, group_by_rules)
+    groups = source.group_by { |el| group_proc(group_by_rules.first).call(el) || UNDEFINED_GROUP_NAME }
+    return groups.merge(groups) { |_group, elements| group_merger(elements, group_by_rules) } unless summarizer
+    # Summarizer present
+    groups.merge! totals_hash(groups.values.flatten)
+    groups.merge(groups.reject { |k, _v| k == :totals }) do |_group, elements|
+      group_merger(elements, group_by_rules)
+    end
+  end
+
+  private
+
+  def group_merger(elements, group_by_rules)
+    return group(elements, group_by_rules.drop(1)) unless group_by_rules.count == 1
+    return elements unless summarizer
+    # Summarizer present
+    { values: elements }.tap do |hsh|
+      # totals only if more than 1 element
+      hsh.merge!(totals_hash(elements)) if elements.count > 1
+    end
+  end
+
+  def totals_hash(elements)
+    { totals: summarizer.call(elements) }
+  end
+
+  # @param grouping_by [Proc,String,Symbol]
+  # @return [Proc]
+  def group_proc(grouping_by)
+    case grouping_by
+    when Symbol, String
+      # prevent grouping_by to be out of lambda scope
+      instance_exec { ->(el) { el[grouping_by] } }
+    when Proc
+      grouping_by
+    else
+      raise InvalidGrouping
+    end
+  end
+end

data/lib/groups_by/pritifier.rb

@@ -0,0 +1,48 @@
+module Pritifier
+  require 'colorize'
+  INDENT = "\t".freeze
+
+  # @param table [Hash, Array] initialy source_arr
+  # @param indent [Integer]
+  def pritify(table, indent = 0)
+    indent += 1
+    return pritty_table(table, indent, 'blue') if table.is_a?(Array)
+    table.each do |k, v|
+      # indent = 0 unless i == 0
+      if k == :values
+        pritty_table(v, indent, 'green')
+      elsif k == :totals
+        pritty_table([v], indent, 'blue')
+      else
+        print "\n" + INDENT * indent + k.to_s.underline.red
+        pritify(v, indent)
+      end
+    end
+  end
+
+  private
+
+  def metrics_table_headers(keys, cell_size)
+    keys.map { |key| key.to_s + ' ' * (cell_size - key.to_s.length) }
+  end
+
+  # Metrics table, or totals table, with values
+  def pritty_table(array, indent, color = 'green')
+    vmax = array.flat_map(&:values).map(&:to_s).map(&:length).max # find max value might be slow
+    kmax = array.first.keys.map(&:to_s).map(&:length).max
+    cell_size = (vmax > kmax ? vmax : kmax) + 1
+
+    # Print keys from first item in array
+    keys_to_print = metrics_table_headers(array.first.keys, cell_size)
+
+    left_indent = INDENT * indent # ' ' * cell_size * indent
+    print ("\n" + left_indent + keys_to_print.join('')).send(color)
+
+    array.each do |row|
+      values_to_print = row.values.map do |value|
+        (value.to_s + ' ' * (cell_size - value.to_s.length)).send(color)
+      end
+      print ("\n" + INDENT * indent + values_to_print.join('')).send("light_#{color}")
+    end
+  end
+end

data/lib/groups_by/version.rb

@@ -0,0 +1,3 @@
+class GroupsBy
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: groups_by
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Karol Błaszczyk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "#group_by with multiple grouping rules."
+email:
+- karol.zygmunt.blaszczyk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- groups_by.gemspec
+- lib/groups_by.rb
+- lib/groups_by/core_ext/array.rb
+- lib/groups_by/core_grouper.rb
+- lib/groups_by/pritifier.rb
+- lib/groups_by/version.rb
+homepage: https://github.com/karol-blaszczyk/groups_by
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: groups_by
+test_files: []