embeds_many 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df5b6c590bea371b92b51fcc0d997179a9a31f79
-  data.tar.gz: 822d11065876bd3721db8ff8d5ea42161eab83da
+  metadata.gz: ba71f51a1cc397e9552e7df72bd48f850f6b94f1
+  data.tar.gz: d2a3a9e1d58f919d9151203c1a742f2cb30046be
 SHA512:
-  metadata.gz: edb630f9cec39da2062f0fe599074357d0427a071f8e489cf0a07ecadad47d52cf84f4f35d606f5a365a62f5f27efbb502dc833d1e3fee017169b76c8204529d
-  data.tar.gz: f026f9f1796fa051ddd02f2d42afec6f8b37a9e47568b7de09fab2910b0b51f230e744c92d78602b3701fd09c9ee0f3faa99ccc2ae0bf995c18be9167c15aa02
+  metadata.gz: 6f28e15a662b00e961dd31a3fc2cd3dafc0e02d4542c7f70244d6338dac273122e518de8a15098f1e63ba2f1230fc15c6d0a3baa91f5df8434310c2c3c04babb
+  data.tar.gz: d348e086153200946b6e644ca9c047c1f2784f7770ecf9a0361b3ce68061638ef4416351b09ed145b07dd66d7e3f9ef0d7712b7ceeb0b054ffaff9711d3cba1b

data/README.markdown

@@ -7,6 +7,12 @@ EmbedsMany allows programmers to work with embedded records the same way as acti
 
 **NOTE**: EmbedsMany only works with Rails/ActiveRecord `4.0.4` or above. To use EmbedsMany, you must use PostgreSQL.
 
+## Limitations and assumptions
+
+- Embedded keys and values can only be simply text strings due to the restriction of [hstore](http://www.postgresql.org/docs/9.2/static/hstore.html).
+- Embedded records should be of limited number, or they may cause performance problems.
+- The `id` of embedded records may duplicate when race condition happens.
+
 ## Usage
 
 ### Installation
@@ -40,13 +46,22 @@ add_column :users, :tags, :hstore, array: true, default: []
 
 ### Setup Model
 
+A simple usage is as follows:
+
 ```ruby
 class User < ActiveRecord::Base
-  # many embedded tags
+  # embedded tags
   embeds_many :tags
+end
+```
 
-  # validation tags
-  embedded :tags do
+If you need validations on embedded records, you can provide an optional block:
+
+```ruby
+class User < ActiveRecord::Base
+  # embedded tags
+  embeds_many :tags do
+    # add accessors
     embedded_fields :name, :color
 
     validates :name, uniqueness: true, presence: true
@@ -63,7 +78,9 @@ class User < ActiveRecord::Base
 end
 ```
 
-### Work with embedded tags
+**Note**: There's no need to define a class for the embedded records, it's taken over automatically by `embeds_many`.
+
+### Work with embedded records
 
 ```ruby
 # create new tag

data/lib/embeds_many/base.rb

@@ -1,7 +1,7 @@
 module EmbedsMany
   module Base
-    def embeds_many(field)
-      child_klass = instance_variable_set "@#{field}_klass", EmbedsMany::Child.clone
+    def embeds_many(field, &block)
+      child_klass =  Class.new(EmbedsMany::Child)
       child_klass.instance_variable_set "@field_name", field
 
       # rewrite association
@@ -9,12 +9,8 @@ module EmbedsMany
         instance_variable_get("@#{field}_collection") ||
           instance_variable_set("@#{field}_collection", ChildrenCollection.new(self, field, child_klass))
       end
-    end
 
-    # define validations and helper instance methods
-    def embedded(field, &block)
-      child_klass = instance_variable_get "@#{field}_klass"
-      child_klass.class_eval(&block)
+      child_klass.class_eval(&block) if block
     end
   end
 end

data/lib/embeds_many/child.rb

@@ -30,10 +30,10 @@ module EmbedsMany
 
     # validation requires model name
     def self.model_name
-      ActiveModel::Name.new(self, nil, @field_name.to_s.classify)
+      ActiveModel::Name.new(self, nil, self.name || @field_name.to_s.classify)
     end
 
-    def initialize(attrs)
+    def initialize(attrs={})
       @attributes = ActiveSupport::HashWithIndifferentAccess.new
 
       attrs.each do |name, value|

data/lib/embeds_many/child_collection.rb

@@ -1,10 +1,10 @@
 module EmbedsMany
   class ChildrenCollection
-    def new(attrs)
+    def new(attrs={})
       @child_klass.new(attrs.merge(parent: @obj))
     end
 
-    def create(attrs)
+    def create(attrs={})
       record = @child_klass.new(attrs.merge(parent: @obj))
 
       record.save

data/lib/embeds_many/version.rb

@@ -1,3 +1,3 @@
 module EmbedsMany
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/embeds_many/user_spec.rb

@@ -18,6 +18,10 @@ describe User do
         user.reload.tags.any? {|t| t.name == 'bug'}.should be_true
       end
 
+      it "should to initialize an tag with no parameters" do
+        user.tags.new.should_not be_nil
+      end
+
       it "should be unable to create tags with duplicate name" do
         user.tags.new(name: 'bug', color: 'red').save.should be_true
 
@@ -27,6 +31,13 @@ describe User do
         tag.errors[:name].should_not be_empty
       end
 
+      it "should be unable to create tags without name" do
+        tag = user.tags.new(color: 'red')
+
+        tag.save.should be_false
+        tag.errors[:name].should_not be_empty
+      end
+
       it "should be unable to create tags without color" do
         tag = user.tags.new(name: 'bug')
 
@@ -35,6 +46,7 @@ describe User do
       end
     end
 
+
     it "should be able to update record" do
       tag = user.tags.create(name: 'bug', color: 'red')
 

data/spec/schema.rb

@@ -10,10 +10,9 @@ end
 
 class User < ActiveRecord::Base
   # many embedded tags
-  embeds_many :tags
-
-  # validation tags
-  embedded :tags do
+  # the block is optional
+  embeds_many :tags do
+    # add accessors
     embedded_fields :name, :color
 
     validates :name, uniqueness: true, presence: true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embeds_many
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - liufengyun