active_record_to_hash 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 348e5277a6af88cfd52397ab8b50e5a945c3eb8a6db670fe5e18fd4e1e65027c
+  data.tar.gz: 7a49b75739ccf0270184181c630c00e661159ce214180e1f774c8c96bb797ef9
+SHA512:
+  metadata.gz: 06b65646b336a5082d5738fa9088dc74076fb94ac6de453718c3550f9f09c47c33267bf45b69e76ca14ee70e38099952cfe1419e9a62f826a3655ffc9e7abbe8
+  data.tar.gz: f420f96cb01629325d57acf1891883aabe03ced09bec07210f2cada6b49c07d4b9546ef63862c4cd830f75ea4f99df9e64d2ea1de93f64c550a88d0a44cf22de

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Masamoto Miyata
+
+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,237 @@
+# ActiveRecordToHash
+
+## Summary
+
+Add `to_hash` method to ActiveRecord of Rails. The `to_hash` method can also acquire related records with relations by Hash, by passing the options to the argument.You can filter the values to retrieve, and change the keys of Hash using options.
+
+ActiveRecordToHash will be useful when creating a Web API that returns a response with JSON.
+
+## Installation
+
+```
+gem 'active_record_to_hash', '~>0.1'
+```
+
+
+## Usage
+
+### Options
+
+| Key | Description | Type |
+|:--|:--|:--|
+| attrs_reader | Specify a method to get the hash of the value and column name. If you omitt it, `attributes` is used. | Symbol |
+| key | Change the key of the hash. | Symbol |
+| except | Remove from the hash. | Symbol Array |
+| only | Retrieve only the specified key. | Symbol Array |
+| with_[attribute_name] | The attribute name is passed to public_send. If the return value is ActiveRecord or ActiveRecord_Relation, call `to_hash`. The Hash specified for this value is passed to that `to_hash`. | Boolean Hash :exists |
+| scope | You can specify scope when acquiring related records. | Symbol Array Proc |
+
+
+### Examples
+
+Examples are shown assuming the following tables.
+
+```rb
+create_table :wide_areas do |t|
+ t.string :name
+ t.timestamps
+end
+
+create_table :areas   do |t|
+ t.string :name
+ t.references :wide_area, foreign_key:   true
+ t.timestamps
+end
+
+create_table :shops   do |t|
+ t.string :name
+ t.timestamps
+end
+
+create_table :shop_areas   do |t|
+ t.references :shop, foreign_key:   true
+ t.references :area, foreign_key:   true
+ t.timestamps
+end
+
+class   Shop < ApplicationRecord
+ has_many :shop_areas
+ has_many :areas, inverse_of:   :shops, through:   :shop_areas
+ 
+ def to_api_hash
+     {
+       id: id,
+       name: name
+    }
+ end
+end
+```
+
+```rb
+p shop.to_hash
+# {
+#   :id=>1,
+#   :name=>"Shop No1",
+#   :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00,
+#   :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00
+# }
+
+p shop.to_hash(attrs_reader: to_api_hash)
+# {
+#   :id=>1,
+#   :name=>"Shop No1",
+# }
+
+p shop.to_hash(attrs_reader: ->(shop){ {shop_id: shop.id} })
+# {
+#   :shop_id=>1,
+# }
+
+p shop.to_hash(only: :name)
+# {:name => "Shop No1"}
+
+p shop.to_hash(except: [:created_at, :updated_at])
+# {:id => 1, :name => "Shop No1"}
+
+p shop.to_hash(only: [:id], with_name: {key: :foobar})
+# {:id=>1, :foobar=>"Shop No1"}
+
+p shop.to_hash(only: [:id, :name], with_areas: true)
+# {
+#  :id=>1,
+#  :name=>"Shop No1",
+#  :areas=>[
+#   {:id=>1, :name=>"Area No1", :wide_area_id=>1, :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00, :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00},
+#   {:id=>2, :name=>"Area No2", :wide_area_id=>2, :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00, :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00},
+#   {:id=>3, :name=>"Area No3", :wide_area_id=>3, :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00, :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00}
+#  ]
+# }
+
+p shop.to_hash(only: [:id, :name], with_areas: false)
+# {
+#  :id=>1,
+#  :name=>"Shop No1"
+# }
+
+p shop.to_hash(only: [:id, :name], with_areas: {key: :area_list})
+# {
+#  :id=>1,
+#  :name=>"Shop No1",
+#  :area_list=>[
+#   {:id=>1, :name=>"Area No1", :wide_area_id=>1, :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00, :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00},
+#   {:id=>2, :name=>"Area No2", :wide_area_id=>2, :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00, :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00},
+#   {:id=>3, :name=>"Area No3", :wide_area_id=>3, :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00, :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00}
+#  ]
+# }
+
+p shop.to_hash(only: [:id, :name], with_areas: {scope: ->{ where(id: 1) }})
+# {
+#  :id=>1,
+#  :name=>"Shop No1",
+#  :areas=>[
+#   {:id=>1, :name=>"Area No1", :wide_area_id=>1, :created_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00, :updated_at=>Mon, 26 Mar 2018 07:53:26 UTC +00:00}
+#  ]
+# }
+
+p shop.to_hash(
+  only: [:id, :name],
+  with_areas: {
+    only: [:id, :name],
+    with_wide_area: {
+      only: [:id, :name]
+    }
+  }
+)
+# {
+#   :id=>1,
+#   :name=>"Shop No1",
+#   :areas=>[
+#     {:id=>1, :name=>"Area No1", :wide_area=>{:id=>1, :name=>"Wide Area No1"}},
+#     {:id=>2, :name=>"Area No2", :wide_area=>{:id=>2, :name=>"Wide Area No2"}},
+#     {:id=>3, :name=>"Area No3", :wide_area=>{:id=>3, :name=>"Wide Area No3"}}
+#   ]
+# }
+
+
+p shop.to_hash(
+  only: [:id, :name],
+  with_areas: {
+    alter: ->(areas){ areas.each_with_object({}) {|area, memo| memo[area[:id]] = area[:name] } }
+  }
+)
+# {
+#   :id=>1,
+#   :name=>"Shop No1",
+#   :areas=>{1=>"Area No1", 2=>"Area No2", 3=>"Area No3"}
+# }
+
+p shop.to_hash(only: [:id, :name], with_areas: :exists)
+# {:id=>1, :name=>"Shop No1", :areas=>true}
+# You can use this option only with ActiveRecord::Relation
+
+```
+
+### Configuration
+
+#### method_name
+
+You can change the method name from `:to_hash` to you want.
+
+```rb
+# config/application.rb
+module   YourApp
+ class   Application < Rails::Application
+   ...
+   config.active_record_to_hash.method_name = :to_your_hash
+ end
+end
+```
+
+#### aliases
+
+You can set an aliases for the method.
+
+```rb
+# config/application.rb
+module   YourApp
+ class   Application < Rails::Application
+   ...
+   config.active_record_to_hash.aliases = [:to_api_hash]
+ end
+end
+```
+
+This is useful for overriding and preparing hashed methods of various patterns. The same alias method is also called for the related record specified in `with_[attribute_name]` option.
+
+```rb
+# app/model/application_record.rb
+
+  def to_api_hash(options = {})
+    options = {
+      except: [:created_at, :updated_at, :sequence],
+      attrs_reader: :attributes_for_api
+    }.merge(options)
+    
+    super(options)
+  end
+  
+  # Time type value is converted to timestamp.
+  def attributes_for_api
+    hash = attributes.each_with_object({}.with_indifferent_access) do |(k, v), obj|
+      v = v.to_i if v.is_a? Time
+      obj[k] = v
+    end
+    hash
+  end
+```
+
+
+
+## Contributing
+
+* Run rspec test.
+* Check source code with the rubocop.
+
+
+## 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,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordToHash'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/active_record_to_hash.rb

@@ -0,0 +1,17 @@
+module ActiveRecordToHash
+  class Railtie < ::Rails::Railtie
+    config.active_record_to_hash = ActiveSupport::OrderedOptions.new
+    config.active_record_to_hash.method_name = :to_hash
+    config.active_record_to_hash.aliases = []
+
+    config.after_initialize do |_app|
+      require 'active_record_to_hash/version'
+      require 'active_record_to_hash/utilities'
+      require 'active_record_to_hash/active_record'
+      ::ActiveRecord::Base.send(:include, ::ActiveRecordToHash::ActiveRecord)
+      ::Rails.application.config.active_record_to_hash.aliases.each do |alias_name|
+        ::ActiveRecord::Base.send(:alias_method, alias_name, ::Rails.application.config.active_record_to_hash.method_name)
+      end
+    end
+  end
+end

data/lib/active_record_to_hash/active_record.rb

@@ -0,0 +1,31 @@
+module ActiveRecordToHash
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    included do
+      define_method ::Rails.application.config.active_record_to_hash.method_name do |options = {}|
+        if options[:pluck]
+          result = public_send(options[:pluck])
+        else
+          attrs_reader = options[:attrs_reader] || :attributes
+          attrs = attrs_reader.is_a?(Proc) ? attrs_reader.call(self) : public_send(attrs_reader)
+          result = attrs.each_with_object({}) do |(k, v), memo|
+            key = k.to_sym
+            next if ActiveRecordToHash.to_a(options[:except]).include?(key)
+            next if options[:only] && !ActiveRecordToHash.to_a(options[:only]).include?(key)
+
+            memo[key] = v
+          end
+          result = ActiveRecordToHash.handle_alter(result, options)
+        end
+
+        ActiveRecordToHash.handle_with_options(options) do |hash_key, attr_name, child_options|
+          child = ActiveRecordToHash.retrieve_child_attribute(self, attr_name, child_options, __callee__)
+          result[hash_key] = ActiveRecordToHash.handle_alter(child, child_options)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/active_record_to_hash/utilities.rb

@@ -0,0 +1,74 @@
+module ActiveRecordToHash
+  module_function
+
+  def call_scope(relation, scope)
+    if scope.is_a? Proc
+      ret = relation.instance_exec(&scope)
+      return ret || relation
+    end
+
+    relation.public_send(scope)
+  end
+
+  def to_a(value)
+    return value if value.is_a? Array
+    return [] if value.nil?
+
+    [value]
+  end
+
+  def retrieve_child_attribute(record, attr_name, options, callee) # rubocop:disable Metrics/AbcSize
+    return options[:value] if options[:value]
+
+    args = options[:args] || []
+    value = record.public_send(attr_name, *args)
+    if options[:exists]
+      raise 'You can use `exists` option only with ActiveRecord::Relation' unless value.is_a? ::ActiveRecord::Relation
+
+      return value.exists?
+    end
+
+    ActiveRecordToHash.to_a(options[:scope]).each do |scope|
+      value = ActiveRecordToHash.call_scope(value, scope)
+    end
+    return value.public_send(callee, options.except(:alter)) if value.is_a? ::ActiveRecord::Base
+
+    if value.is_a?(Array) || value.is_a?(::ActiveRecord::Relation)
+      return value.map do |obj|
+        next obj.public_send(callee, options.except(:alter)) if obj.is_a? ::ActiveRecord::Base
+
+        obj
+      end
+    end
+
+    value
+  end
+
+  def handle_alter(result, options)
+    return result if options[:alter].nil?
+
+    res = options[:alter].call(result)
+    return result if res.nil?
+
+    res
+  end
+
+  def handle_with_options(options)
+    options.each_key do |key|
+      next unless key.to_s.start_with?('with_')
+      next if options[key] == false
+
+      attr_name = key[5..-1].to_sym # 5 is 'with_'.length
+      hash_key = !options[key].is_a?(Hash) || options[key][:key].nil? ? attr_name : options[key][:key]
+      child_options = ActiveRecordToHash.normalize_child_options(options[key])
+      yield(hash_key, attr_name, child_options)
+    end
+  end
+
+  def normalize_child_options(options)
+    return {} if options == true
+    return { exists: true } if options == :exists
+
+    options
+  end
+end

data/lib/active_record_to_hash/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordToHash
+  VERSION = '0.5.1'.freeze
+end

data/lib/tasks/active_record_to_hash_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_record_to_hash do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: active_record_to_hash
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Masamoto Miyata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Add a `to_hash` method that can acquire the relations to the active record.
+email:
+- miyata@sincere-co.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_record_to_hash.rb
+- lib/active_record_to_hash/active_record.rb
+- lib/active_record_to_hash/utilities.rb
+- lib/active_record_to_hash/version.rb
+- lib/tasks/active_record_to_hash_tasks.rake
+homepage: https://github.com/gomo/active_record_to_hash
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Add the `to_hash` function to active record.
+test_files: []