serialize_has_many 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTRhYzllMTI1ODQ4NWY0MjcyOTBiNDFhZjMyMmNjMWU0ZTA3YTUwMQ==
+    NWI0NzAyYmIyM2IxMDdmODU3YzFhY2I2NGVkM2NiNzg0ZTIxNjE2NQ==
   data.tar.gz: !binary |-
-    MTlmYzU2ZjkzM2Q0Y2FlYThiMjA0NjM2YWU1MTllNjA3YTk5NTlmOA==
+    NTllMTVmMjU1ZGZiYzVjOTI5YzkzZGRhNjMzMTZmZDMzZDgyOWVmYg==
 SHA512:
   metadata.gz: !binary |-
-    ZmM4ODRlYzEzZTAzNWU0NjU4OWQzNmE4MTZkNzRkNDExM2Q1ZDhmMzQ0ZjU5
-    ZGFlYzYzMDNiNTVjNjQ2YTJiZjRkNzQ4MzYwM2EyZDNhNjMxZmQ2ZjhjYmNh
-    NWRlMmVlMjVjYjdmMjgwNjAzMTU1MzUwMzIwNTYyOTIwNzkwZGY=
+    YmMwYjg2N2ViMWFmY2Q0YWUwYTU5NmZmMmU5NDdjYzcwYTNkMGM5MWEyNDRi
+    MGMxNzY4YWM3ZmU0YjVjMjNhNzYyZjU3NjZlZDVlZWM5Mzc2NmQ5OWQ3OGE3
+    MmY4NGVlMzBhOTgxZjBhNDQ1NzI0YjgxN2JlODk4NGQ3YjUyZGI=
   data.tar.gz: !binary |-
-    ZGE5ZTExNjc5ZTM0MGFlMmIyNWYwNmFkZTUwMzNmNTA3YzYyNTVhYzNiMzM5
-    NWI3NzVmNGFhN2I0MjRlZTViYWZjMzQ5MmRhZGZmZTg2YjliMjhjZGZiYjNj
-    OGI4ZTE3YTRlYmY3MjU3MTA4ZjgyMGQ0NmYyMGVhODI1NGNmZmI=
+    OGVhNjAxOTJmZmY4NjBkNzRhMDJhNmRkMGY4Y2ExODRhMGY0MWEwODg4ZjVj
+    MTI1MDViNjUyNDEwYTM2YjNjMDY2MzVhNzY5MWM2OTVmM2IwMDZjZWYxOWJm
+    OWMyMjIzNzM4MjhhNmZmOGJjODVhN2UxMzkzYzQ0NTg3ZTI2NDk=

data/README.md

@@ -1,6 +1,6 @@
 # SerializeHasMany
 
-[![Build Status](https://travis-ci.org/rdsubhas/serialize_has_many.svg?branch=master)](https://travis-ci.org/rdsubhas/serialize_has_many)
+[![Build Status](https://travis-ci.org/rdsubhas/serialize_has_many.svg?branch=master)](https://travis-ci.org/rdsubhas/serialize_has_many) [![Code Climate](https://codeclimate.com/github/rdsubhas/serialize_has_many/badges/gpa.svg)](https://codeclimate.com/github/rdsubhas/serialize_has_many) [![Coverage Status](https://img.shields.io/coveralls/rdsubhas/serialize_has_many.svg)](https://coveralls.io/r/rdsubhas/serialize_has_many)
 
 Serializes `has_many` relationships into a single column while still doing attributes, validations, callbacks, nested forms and fields_for. Easy NoSQL with ActiveRecord!
 
@@ -24,8 +24,10 @@ Or install it yourself as:
 
 Assume you have a Parent has-many Child relation. To use `serialize_has_many`:
 
-* Child should respond to `attributes` and `new(attributes)`
-* Parent should have a `text` column attribute to store the serialized data
+* Child should respond to `attributes` and `new(attributes)`. To be clear:
+  * `child.attributes` should give a hash
+  * `Child.new(attributes)` should take that hash
+* Parent should have an attribute to store the serialized data, preferably `text` datatype
 * Add `serialize_has_many` in the Parent
 
 ### Example
@@ -33,6 +35,7 @@ Assume you have a Parent has-many Child relation. To use `serialize_has_many`:
 (For a real scenario, check `example/app/models/`)
 
 ```ruby
+# Make Child to use ActiveModel::Model instead of ActiveRecord
 class Child
   include ActiveModel::Model
   attr_accessor :name, :age, ...
@@ -43,15 +46,29 @@ class Child
   end
 end
 
+# Convert Parent to use serialize_has_many instead of has_many
 class Parent < ActiveRecord::Base
   include SerializeHasMany::Concern
-  serialize_has_many <name-of-column>, Child,
-    using: <JSON|YAML>,
-    validate: <true|false>,
-    reject_if: <proc to reject empty children when submitting from nested forms>
+  serialize_has_many "<name of column>",
+    Child, # Child class
+    using: JSON, # JSON, YAML, or any other ActiveRecord serializer
+    validate: false, # Set true to validate children when validating the parent
+    reject_if: Proc.new { ... } # Proc to reject empty children when submitting from nested forms
 end
 ```
 
+### Works With
+
+* Tested on Rails 4.0 and above, Ruby 1.9.3+
+* For the Child model, you can use any class that you want, as long as `attributes` provides a hash, and `new(attributes)` takes that hash. Some options are:
+  * [ActiveModel](https://github.com/rails/rails/tree/master/activemodel)
+  * [Virtus](https://github.com/solnic/virtus)
+  * [ActiveAttr](https://github.com/cgriego/active_attr)
+
+### Advanced Scenarios
+
+This gem supports nested relationships in the Child class. You can do it yourself with a simple array attribute, or you can use Virtus which allows you to have explicit nested object types. Just remember that `attributes` should provide a hash (and only a hash, no nested objects), and `new(attributes)` should take the same hash.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/serialize_has_many/fork )

data/lib/serialize_has_many/serializer.rb

@@ -14,18 +14,14 @@ module SerializeHasMany
     end
 
     def dump(items)
-      @using.dump to_attributes(items)
-      case items
-        when nil then nil
-        when Array then @using.dump(to_attributes(items))
-        else raise('not an array or nil')
-      end
+      attributes = to_attributes(items)
+      attributes ? @using.dump(attributes) : nil
     end
 
     def from_attributes(items)
       case items
         when nil then []
-        when Array then items.map{ |item| from_item(item) }
+        when Array then items.map{ |item| from_hash(item) }
         else raise('not an array or nil')
       end
     end
@@ -33,12 +29,12 @@ module SerializeHasMany
     def to_attributes(items)
       case items
         when nil then nil
-        when Array then items.map{ |item| to_item(item) }
+        when Array then items.map{ |item| to_hash(item) }
         else raise('not an array or nil')
       end
     end
 
-    def from_item(item)
+    def from_hash(item)
       case item
         when nil then nil
         when Hash then @child_class.new(item)
@@ -47,7 +43,7 @@ module SerializeHasMany
       end
     end
 
-    def to_item(item)
+    def to_hash(item)
       case item
         when nil then nil
         when Hash then item

data/lib/serialize_has_many/version.rb

@@ -1,3 +1,3 @@
 module SerializeHasMany
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serialize_has_many
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Subhas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
 description: Serializes `has_many` relationships into a single column while still
   doing attributes, validations, callbacks, nested forms and fields_for. Easy NoSQL
   with ActiveRecord!