hash_pivot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 580ffb47923a02141676ab7cc6174e410e993aa49d53e3a7c02f994926433638
-  data.tar.gz: 8280b0020a220ed46df11bcb8a557f13ef6c8c0be99e319d3ee6716751120dc8
+  metadata.gz: 984228026a6a9d085ce9ba14f6ffa03c022019bd54a4dc87cff276a2294af305
+  data.tar.gz: ee52cc9ec944dcec33998ced00ee793c618c278975fe6409987f64991f8dc177
 SHA512:
-  metadata.gz: 94a17744698e9b22fe9c084983d6c2c8a10c123c160f2389d583791884edf08045fbf3c6d624c65e8c7facf4b34e375ef4faa75c6d6123bb6f0fb4ac708c05a7
-  data.tar.gz: aa168215bbc6fcd46e3bfc93b5cb74e360bed7e511084d359bb9de624210359fea0f142cda76c65b93805ec3b2a1f258fecea2592957769e09ca33f83548cebc
+  metadata.gz: 8d5b2cfb8a93e2c36bb0236718bc755d28040783b0c21d0929dfdc61cc6e0d61b793dc2a60656d0074f3d48924a2629f4b787614e31e66b086b3db28449a0bda
+  data.tar.gz: 16acd796cb344c3b8deffdba51f6779572bc53c8cbfb9a835d6b923f83e262b04f111fe8598758a13afd485a087f08e63ea2ac60a8f2e2557056d0d938393b91

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-06-25
+## [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.2.0)
 
 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,129 @@ 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.
+
+```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 }] }]
+```
+
+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 }]
+```
+
+
+### 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,7 @@ 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"
 
   # 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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_pivot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - junara
@@ -182,7 +182,7 @@ 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
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []