active_serialize 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69241d017dd21a5caab76128a03a095e2aaad60d
-  data.tar.gz: d1743e957dbf71127ea025cd2b12e0d24baf2589
+  metadata.gz: 100d3814b35d079e9ddd05300ea69aeb01d13ddd
+  data.tar.gz: 8432a699262798dc61effbe9f5994fe63d9f8829
 SHA512:
-  metadata.gz: 27d0d6b81498985305fa5914d88e2b058c29e3072a9b12b450005847c972cd21e42c72c39b87811dde4bf9cb716baff79378a49f7a84135666f4887007061fd1
-  data.tar.gz: b83476170f7834133a34d624ce23f880f9e5b6134c08f45227432248f5d8267e0a8a092e32dc0924a69630d5fbfdfbd0437bc05844442b64de289d635a9cad92
+  metadata.gz: 0bc27fb205558158804e0e264518342aed2183858abf3515c74cf67c0e5e6bb073fbb27bdd6c44ee19ee4143c5d89f75402a15d3475b6cccf44a56918b092e30
+  data.tar.gz: d76c8deca5278e237bd88f3b1abfe91c5a9956ba226c9673d976ba4fe5b7cc24a9d4ab8727c057c927ee673dd609160c06ab77f1e03e0a90d7f73936a0c245de

data/README.md

@@ -1,6 +1,6 @@
 # ActiveSerialize
 
-Provide a very simple way to transform ActiveRecord data into Hash output.
+Provide a very simple way to transform ActiveRecord data into Hash.
 
 ## Installation
 
@@ -18,60 +18,101 @@ Or install it yourself as:
 
     $ gem install active_serialize
 
-## Usage
+## Basic Usage
 
-Suppose the table `users`:
+There is a table `users`:
 ```ruby
-t.string :name,            null: false
-t.string :password_digest, null: false
+t.string :name
 t.string :email
 ```
 
-Model:
+And a table `books`:
+
 ```ruby
-class User
-  # YES, all you have to do is write this line
-  active_serialize rmv: %i[ password_digest ]
-end
+t.bigint :user_id
+t.string :name
 ```
 
-Console:
+Declaration in model:
+```ruby
+class User < ActiveRecord::Base
+  active_serialize
+  has_many :books
+  
+  def love
+    'Ruby'
+  end
+end
+
+class Book < ActiveRecord::Base
+  active_serialize rmv: :user_id
+  belongs_to :user
+end
 ```
-  $ User.all.to_h # on records (active relation)
- => [
-        { "id" => 1, "name" => "zhandao", "email" => "xxxx" },
-        { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx" }
-    ]
-  $ User.last.to_h # on a record
- => { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx" }
+
+Then:
+```ruby
+User.last.to_h
+# => { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx" }
+
+User.where(id: [1, 2]).to_ha # means "to hash array"
+# => [
+#        { "id" => 1, "name" => "zhandao", "email" => "xxxx" },
+#        { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx" }
+#    ]
 ```
 
-Explain:
-
-1. Basic principle: the supporter know all the fields name through `column_names` (a db mapping func),
-    so you just have to declare which fields do not need to output by passing 'rvm' param.
-2. You can also `add` something to the output JSON, but make sure that the field name you add needs to correspond to the model instance methods.  
-    The following example will generate `{ ..., "addtion_field" => "value' }`
-    ```ruby
-    class User
-      active_serialize add: :addition_field
-      
-      def addition_field
-        'value'
-      end
-    end
-    ```
+The basic usage just looks like `attributes` method.
+
+## How is it work?
+
+ActiveRecord class method `column_names` (which is called by this gem) shows that the filed names by loading database schema.
 
 ## Advanced Usage
 
-TODO
+### Except (remove) keys
+
+1. remove by default: `active_serialize rmv: [:email]` (you can also use `active_serialize_rmv`)
+2. remove when calling `to_h`: `to_h(rmv: [:email])`
+
+`=> { "id" => 2, "name" => "ikkiuchi" }`
 
+### Add keys
+
+1. add it by default: `active_serialize add: [:love]` (you can also use `active_serialize_add`)
+2. add when calling `to_h`: `to_h(add: [:love])`
+
+`=> { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx", "love" => "Ruby" }`
+
+* Values of addition keys will be the result of calling `public_send`
+
+### Add recursive attributes
+
+* recursive? —— calls `to_h` recursively (/ nested)
+
+See below:
 ```ruby
-active_serialize_add :sub_categories_info, when: :get_nested_list
-active_serialize_add :base_category_info, name: :base_category, when: -> { base_category.present? }
-active_serialize_map a: :b
+User.first.books.to_ha
+# => [{ "name" => "Rails Guide" }]
+
+# declaration in User
+active_serialize_add :books, recursive: true
+# `active_serialize recursive: :books` is OK, but notice `active_serialize` should only be called once.
+
+# then ...
+User.first.to_h
+# => { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx", "books" => [{ "name" => "Rails Guide" }] }
 ```
 
+### Transform key names
+
+Choose one of the following ways:
+
+1. `active_serialize_map love: :looove`
+2. `active_serialize_add :love, named: :looove`
+
+`=> { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx", "looove" => "Ruby" }`
+
 ## 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.

data/lib/active_serialize/class_methods.rb

@@ -19,13 +19,13 @@ module ActiveSerialize
       _active_serialize[recursive ? :recursive : :add].concat attrs.map(&:to_sym)
     end
 
-    def active_serialize_map settings = { }
+    def active_serialize_map **settings
       _active_serialize[:map].merge! settings
     end
 
     def active_serialize_keys(rmv: [ ], add: [ ])
       _active_serialize[:final] ||= column_names.map(&:to_sym) - _active_serialize[:rmv] + _active_serialize[:add]
-      _active_serialize[:final] - rmv + add
+      _active_serialize[:final] - Array(rmv) + Array(add)
     end
   end
 end

data/lib/active_serialize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveSerialize
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/lib/active_serialize.rb

@@ -15,9 +15,9 @@ module ActiveSerialize
       include  ToH
       delegate :active_serialize_keys, :_active_serialize, to: self
 
-      active_serialize_rmv *rmv
-      active_serialize_add *add
-      active_serialize_add *recursive, recursive: true
+      active_serialize_rmv *Array(rmv)
+      active_serialize_add *Array(add)
+      active_serialize_add *Array(recursive), recursive: true
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_serialize
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - zhandao