hash_pivot 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 580ffb47923a02141676ab7cc6174e410e993aa49d53e3a7c02f994926433638
-  data.tar.gz: 8280b0020a220ed46df11bcb8a557f13ef6c8c0be99e319d3ee6716751120dc8
+  metadata.gz: 871d8c1d4c6a26913eb825057ee2823b54e9919c5a8faceadc008064fd239243
+  data.tar.gz: 4a5c03ee17d1ab10a11873f5b56419de12fadeaa6a34695e8eb1d3fd48f0d93e
 SHA512:
-  metadata.gz: 94a17744698e9b22fe9c084983d6c2c8a10c123c160f2389d583791884edf08045fbf3c6d624c65e8c7facf4b34e375ef4faa75c6d6123bb6f0fb4ac708c05a7
-  data.tar.gz: aa168215bbc6fcd46e3bfc93b5cb74e360bed7e511084d359bb9de624210359fea0f142cda76c65b93805ec3b2a1f258fecea2592957769e09ca33f83548cebc
+  metadata.gz: b4c7fcd39a18b07f16c8b7facaeb42fdb76969d42879a0c663789458f007692233c9cdb4d4cb6d685d17877b8688e2f17f431c263c8578e1aad67f9b18d56f57
+  data.tar.gz: 9fa1e4cb4becd504a2832dcdf5d221709340a23e39ea9c35d917f797949b1768833675fc8e8874b848bce572f0fd84377d4699de6fdd7829e3153413c216421f

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-06-25
+## [0.3.1] - 2022-06-28
+
+- Refactoring code
+- Add document url
+
+## [0.3.0] - 2022-06-26
+
+- Replace Column with label if Hash is given for pivot_kinds.
+- Update README for label replacing.
+
+## [0.2.0] - 2022-06-26
+
+- Add usage examples in README.
+- Fix CHANGELOG.md url.
+
+## [0.1.0] - 2022-06-26
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hash_pivot (0.1.0)
+    hash_pivot (0.3.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,9 +2,7 @@
 
 # HashPivot
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hash_pivot`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Pivot Array of Hash or Array of Struct or ActiveRecord::Relation.
 
 ## Installation
 
@@ -18,7 +16,165 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+### Pivot Array of Hash
+
+#### Prepare data
+
+Prepare Array of Hash.
+
+id | role | team | age
+-- | -- | -- | --
+1 | guest | rabbit | 1
+2 | guest | mouse | 2
+3 | guest | rabbit | 3
+4 | admin | mouse | 4
+
+```ruby
+ data = [
+  { id: 1, role: 'guest', team: 'rabbit', age: 1 },
+  { id: 2, role: 'guest', team: 'mouse', age: 2 },
+  { id: 3, role: 'guest', team: 'rabbit', age: 3 },
+  { id: 4, role: 'admin', team: 'mouse', age: 4 }
+]
+```
+
+#### Basic usage
+
+Grouping by `:role` and pivot in `:team`. Pivot column is `rabbit or mouse` .
+
+```ruby
+HashPivot.pivot(data, :role, :team, %w[rabbit mouse])
+
+# [{ :role => "guest",
+#    "rabbit" => [{ :id => 1, :role => "guest", :team => "rabbit", :age => 1 }, { :id => 3, :role => "guest", :team => "rabbit", :age => 3 }],
+#    "mouse" => [{ :id => 2, :role => "guest", :team => "mouse", :age => 2 }] },
+#  { :role => "admin", "rabbit" => [], "mouse" => [{ :id => 4, :role => "admin", :team => "mouse", :age => 4 }] }]
+```
+
+role | rabbit | mouse
+-- | -- | --
+guest | {1	guest	rabbit	1} {3	guest	rabbit	3} | {2	guest	mouse	2}
+admin |   | {4	admin	mouse	4}
+
+Grouping by `:role` and pivot in `:team`.
+
+Pivot column is nil. This means that pivot column is automatically configured.
+
+```ruby
+HashPivot.pivot(data, :role, :team, nil)
+
+# [{ :role => "guest",
+#    "rabbit" => [{ :id => 1, :role => "guest", :team => "rabbit", :age => 1 }, { :id => 3, :role => "guest", :team => "rabbit", :age => 3 }],
+#    "mouse" => [{ :id => 2, :role => "guest", :team => "mouse", :age => 2 }] },
+#  { :role => "admin", "mouse" => [{ :id => 4, :role => "admin", :team => "mouse", :age => 4 }] }]
+```
+
+#### Pivot with summarize.
+
+Pivot data is summarized by block.
+
+Age is summarized by block.
+
+```ruby
+HashPivot.pivot(data, :role, :team, %w[rabbit mouse]) { |array| array.sum { |h| h[:age] } }
+
+# [{ :role => "guest", "rabbit" => 4, "mouse" => 2 }, { :role => "admin", "rabbit" => 0, "mouse" => 4 }]
+```
+
+role | rabbit | mouse
+-- | -- | --
+guest | 4 | 2
+admin | 0 | 4
+
+#### Pivot with summarize and replacing label.
+
+If you give Hash for pivot kinds like this, pivot data is summarized by block and replace with labels.
+
+```ruby
+pivot_kinds = { 'rabbit' => 'RABBIT AGE',
+                'mouse' => 'MOUSE AGE' }
+```
+
+```ruby
+HashPivot.pivot(data, :role, :team, pivot_kinds) { |array| array.sum { |h| h[:age] } }
+
+# [{ :role => "guest", "RABBIT AGE" => 4, "MOUSE AGE" => 2 }, { :role => "admin", "RABBIT AGE" => 0, "MOUSE AGE" => 4 }]
+```
+
+role | RABBIT AGE | MOUSE AGE
+-- | -- | --
+guest | 4 | 2
+admin | 0 | 4
+
+### Pivot Array of Struct
+
+#### Prepare data
+
+Prepare Array of Struct.
+
+```ruby
+HashPivotUserStruct = Struct.new(:id, :role, :team, :age, keyword_init: true)
+data = [
+  HashPivotUserStruct.new(id: 1, role: 'guest', team: 'rabbit', age: 1),
+  HashPivotUserStruct.new(id: 2, role: 'guest', team: 'mouse', age: 2),
+  HashPivotUserStruct.new({ id: 3, role: 'guest', team: 'rabbit', age: 3 }),
+  HashPivotUserStruct.new({ id: 4, role: 'admin', team: 'mouse', age: 4 })
+]
+```
+
+#### Basic usage
+
+Grouping by `:role` and pivot in `:team`. Pivot column is `rabbit or mouse` .
+
+```ruby
+HashPivot.pivot(data, :role, :team, %w[rabbit mouse], repository: HashPivot::Repository::StructRepository)
+
+# [{ :role => "guest",
+#    "rabbit" => [{ :id => 1, :role => "guest", :team => "rabbit", :age => 1 }, { :id => 3, :role => "guest", :team => "rabbit", :age => 3 }],
+#    "mouse" => [{ :id => 2, :role => "guest", :team => "mouse", :age => 2 }] },
+#  { :role => "admin", "rabbit" => [], "mouse" => [{ :id => 4, :role => "admin", :team => "mouse", :age => 4 }] }]
+```
+
+
+### Pivot Array of ActiveRecord::Relation
+
+#### Prepare data
+
+Prepare Array of ActiveRecord::Relation.
+
+```ruby
+class MigrateSqlDatabase < ActiveRecord::Migration[6.1]
+  def self.up
+    create_table(:hash_pivot_users) do |t|
+      t.string :role
+      t.string :team
+      t.integer :age
+    end
+  end
+end
+```
+
+```ruby
+HashPivotUser.destroy_all
+HashPivotUser.create(:hash_pivot_user, id: 1, role: 'guest', team: 'rabbit', age: 1)
+HashPivotUser.create(:hash_pivot_user, id: 2, role: 'guest', team: 'mouse', age: 2)
+HashPivotUser.create(:hash_pivot_user, id: 3, role: 'guest', team: 'rabbit', age: 3)
+HashPivotUser.create(:hash_pivot_user, id: 4, role: 'admin', team: 'mouse', age: 4)
+```
+
+#### Basic usage
+
+Grouping by `:role` and pivot in `:team`. Pivot column is `rabbit or mouse` .
+
+```ruby
+HashPivot.pivot(data, :role, :team, %w[rabbit mouse], repository: HashPivot::Repository::ActiveRecordRepository)
+
+# [{ :role => "guest",
+#    "rabbit" => [{ :id => 1, :role => "guest", :team => "rabbit", :age => 1 }, { :id => 3, :role => "guest", :team => "rabbit", :age => 3 }],
+#    "mouse" => [{ :id => 2, :role => "guest", :team => "mouse", :age => 2 }] },
+#  { :role => "admin", "rabbit" => [], "mouse" => [{ :id => 4, :role => "admin", :team => "mouse", :age => 4 }] }]
+```
+
 
 ## Development
 

data/hash_pivot.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}CHANGELOG.md"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/hash_pivot'
 
   # 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.

data/lib/hash_pivot/table.rb

@@ -6,34 +6,51 @@ require_relative './repository/struct_repository'
 
 module HashPivot
   class Table
+    # rubocop:disable Layout/LineLength
+
     # @param [Array<Hash>] data
+    # @param [Class<HashPivot::Repository::HashRepository,HashPivot::Repository::StructRepository,HashPivot::Repository::ActiveRecordRepository>] repository
     def initialize(data, repository: HashPivot::Repository::HashRepository)
       @data = data
       @repository = repository
     end
 
+    # rubocop:enable Layout/LineLength
+
     # @param [Array, Object] group
     # @param [Object] pivot_in
-    # @param [Array] pivot_kinds
+    # @param [Hash,nil] pivot_kinds
+    # @param [Proc] block
+    # @return [Array<Hash>]
     def pivot(group, pivot_in, pivot_kinds, &block)
       group = [group] unless group.is_a?(Array)
       @repository.hash_by_group(@data, group, pivot_in).each_with_object([]) do |(key, array), memo|
-        hash = pivot_with_sum(pivot_kinds, array, pivot_in, &block)
+        hash = transpose_with(pivot_kinds, array, pivot_in, &block)
 
         memo << key.merge(hash)
       end
     end
 
-    def pivot_with_sum(pivot_kinds, array, pivot_in, &block)
-      pivot_kinds ||= array.map { |h| h[pivot_in] }.uniq.compact
-      pivot_kinds.each_with_object({}) do |pivot_kind, memo|
+    private
+
+    # @param [Hash,nil] pivot_kinds
+    # @param [Array] array
+    # @param [Object] pivot_in
+    # @param [Proc] block
+    # @return [Hash]
+    def transpose_with(pivot_kinds, array, pivot_in, &block)
+      pivot_kinds ||= calculated_pivot_kinds_from(array, pivot_in)
+      pivot_kinds.each_with_object({}) do |(pivot_kind, pivot_label), memo|
         pivoted_data = array.select { |h| h[pivot_in] == pivot_kind }
-        memo[pivot_kind] = if block
-                             yield(pivoted_data)
-                           else
-                             pivoted_data
-                           end
+        memo[pivot_label] = block ? yield(pivoted_data) : pivoted_data
       end
     end
+
+    # @param [Array] array
+    # @param [Object] pivot_in
+    # @return [Hash]
+    def calculated_pivot_kinds_from(array, pivot_in)
+      array.map { |h| h[pivot_in] }.uniq.compact.each_with_object({}) { |kind, memo| memo[kind] = kind }
+    end
   end
 end

data/lib/hash_pivot/version.rb

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

data/lib/hash_pivot.rb

@@ -4,12 +4,28 @@ require_relative 'hash_pivot/version'
 require_relative 'hash_pivot/table'
 require 'hash_pivot/error/not_implemented_error'
 module HashPivot
+  # rubocop:disable Layout/LineLength
+
   # @param [Array<Hash>] data
   # @param [Array] group
   # @param [Object] pivot_in
-  # @param [Array] pivot_kinds
+  # @param [Array,Hash,nil] pivot_header
   # @return [Hash]
-  def self.pivot(data, group, pivot_in, pivot_kinds, repository: HashPivot::Repository::HashRepository, &block)
+  # @param [Class<HashPivot::Repository::HashRepository,HashPivot::Repository::StructRepository,HashPivot::Repository::ActiveRecordRepository>] repository
+  # @param [Proc] block
+  def self.pivot(data, group, pivot_in, pivot_header, repository: HashPivot::Repository::HashRepository, &block)
+    pivot_kinds = if pivot_header.is_a?(Array)
+                    transform_to_hash(pivot_header)
+                  else
+                    pivot_header
+                  end
     Table.new(data, repository: repository).pivot(group, pivot_in, pivot_kinds, &block)
   end
+
+  # rubocop:enable Layout/LineLength
+
+  def self.transform_to_hash(array)
+    array.each_with_object({}) { |kind, memo| memo[kind] = kind }
+  end
+  private_class_method :transform_to_hash
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_pivot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - junara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-26 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -182,7 +182,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/junara/hash_pivot
   source_code_uri: https://github.com/junara/hash_pivot
-  changelog_uri: https://github.com/junara/hash_pivotCHANGELOG.md
+  changelog_uri: https://github.com/junara/hash_pivot/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/hash_pivot
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []