embedson 1.0.4 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NThiNzZmNzBkMTA2Mzg0OGVmZWJhMGI0Yzc3MmVjYWFjN2JjYTA2ZQ==
-  data.tar.gz: !binary |-
-    ZDg1Njk0ODlmNGI3OTY0OTZjMmFiMDY0YzM3NjIxYTkyYTIxOGNlMA==
+SHA1:
+  metadata.gz: 50c8f25d72bfcd91fc902d3da04d1d251f02a9e5
+  data.tar.gz: 9053217978e0523ced6274438945882bc474b378
 SHA512:
-  metadata.gz: !binary |-
-    ZjBkMmQxN2JhMzBiOWZiOTQ3ZjI1OGJiZDFkMDBjN2Y2NzUwZDFmNjNkMWE4
-    NWUwZDExOTc1YzZhMWY0ODgzOTlmMDYwYTQyNGQ3Yjk5ODk3Yzg1OGVhMDIx
-    ZDdlMjkzYTRhZDcxNDEyNzJiZmQ2MzBlNGRmNDZkN2QzNWM1YzE=
-  data.tar.gz: !binary |-
-    Y2JmODUxMDljZTc4MDhkNWJiNDI2MmU1NTUyNjkyNzU3Nzc4NTE4Yzc2ODFm
-    MTU2NjBkZmExOGI4MmI1YjU5MjBhZDVlZWNmOTI3YmVlMTlkNzdiYzEwMzk0
-    Yzg4ODUxYzY0MWM4YzA4M2ZmZTkwYWZiNmZiMmY3NzM3MmY2ODE=
+  metadata.gz: 9069a37c1e5a4ae3de6c787af44e5684ffa6d869d1e908923841be3304c685b5a9ff2d77c7ff476fc92ed2d5b074accaedb1b9b4e2562bdca3d06c621170195d
+  data.tar.gz: 3bac214b304bb0155b655dc39795cf0f6882ff429b8efe2cedeac6a0be02d646021a71c3d46707a75802a33a24e7b928dee943e2b696b3db88a23143935cc985

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Embedson change log
+
+## 1.1.1 / Unreleased
+
+* [Added]
+
+* [Deprecated]
+
+* [Removed]
+
+* [Fixed]
+
+## 1.1.0 / 2015-03-17
+
+* [Added] support for inheritance in embedded classes
+
+* [Fixed] fix assignment to instance variable in hash_method
+
+## 1.0.4 / 2014-11-19
+
+* [Added] support for :hash_method option.
+
+## 1.0.3 / 2014-11-16
+
+* [Added] support for multiple embedded_in
+
+* [Fixed] sending embedded class to embedding object when saving

data/README.md

@@ -6,14 +6,14 @@
 
 # Embedson
 
-Adds functionality of `embeds_one` to ActiveRecord.
+Main goal is to implement Mongoids embedded document functionality in ActiveRecord.
+
+Hash representation of class defined by specified method (default `to_h`) is saved in json/hstore column.
 
-Adds functionality of `embedded_in` to any class:
+Adds functionality of `embeds_one` to ActiveRecord.
 
-- with defined `to_h` method which should return `Hash` 
-- initialized with Hash.
+Adds functionality of `embedded_in` to any class initialized with Hash.
 
-Result of `to_h` is saved json/hstore column.
 
 
 ## Installation
@@ -50,7 +50,10 @@ Example with [Virtus](https://github.com/solnic/virtus):
 	
 	class Test < ActiveRecord::Base
 
-	  embeds_one :virt, class_name: Virt, column_name: :data, inverse_of: :parent
+	  embeds_one :virt, class_name: Virt,
+                        column_name: :data,
+                        inverse_of: :parent,
+                        hash_method: :to_h    # default option
 	end
 
 	class Virt

data/TODO.md

@@ -1,5 +1,4 @@
 ## ToDo list
 
 - support for inheritance of embedded class
-- support for dirty tracking
 - never enough tests

data/embedson.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["sufleR"]
   spec.email         = ["szymon.fracczak@netguru.co"]
   spec.summary       = %q{Embedded model for AR with postgresql}
-  spec.description   = %q{Save any class which respond to to_h in json column as embedded model.}
+  spec.description   = %q{Save hash representation of class in json column as embedded model.}
   spec.homepage      = "https://github.com/sufleR/embedson"
   spec.license       = "MIT"
 
@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 1.9.3"
 
   spec.add_dependency "activerecord", ">= 4"
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "pg", "~> 0.17"
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pg", "~> 0.18"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "with_model", "~> 1.2"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"

data/lib/embedson/model.rb

@@ -16,6 +16,7 @@ module Embedson
     #           :class_name - Name of class which will be ebedded.
     #           :column_name - Name of column where Hash representation will be stored.
     #           :inverse_of - Name of field where related class will store current object.
+    #           :hash_method - Method name which returns hash representation os saved object. Default :to_h
     #
     # Examples
     #

data/lib/embedson/model/embeds_builder.rb

@@ -26,7 +26,7 @@ module Embedson
           send("#{builder.field_name}_send_to_related", arg)
 
           instance_variable_set(builder.instance_var_name, arg)
-          val = arg.nil? ? arg : arg.send(builder.hash_method).stringify_keys
+          val = arg.nil? ? arg : arg.send(builder.hash_method).stringify_keys.merge('_type' => builder.klass.name)
           unless val == read_attribute(builder.column_name)
             write_attribute(builder.column_name, val)
           end
@@ -44,7 +44,8 @@ module Embedson
 
       def related_model(builder)
         klass.send :define_method, "#{builder.field_name}_related_model" do
-          builder.related_klass_name.constantize.new(read_attribute(builder.column_name))
+          attribute = read_attribute(builder.column_name)
+          attribute.fetch('_type', builder.related_klass_name).constantize.new(attribute)
         end
         klass.send :private, "#{builder.field_name}_related_model"
       end

data/lib/embedson/model/method_builder.rb

@@ -22,7 +22,7 @@ module Embedson
       end
 
       def hash_method
-        @hash_method || options.fetch(:hash_method, nil) || :to_h
+        @hash_method ||= options.fetch(:hash_method, nil) || :to_h
       end
 
       def column_name

data/lib/embedson/version.rb

@@ -1,3 +1,3 @@
 module Embedson
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/spec/embedson/model/embedded_builder_spec.rb

@@ -64,7 +64,9 @@ describe Embedson::Model::EmbeddedBuilder do
         it 'changes parents son_col to son.to_h' do
           expect{
             son.send(:parent_send_to_related, son)
-          }.to change { parent.son_col }.from('different' => 'true').to(son.to_h.stringify_keys)
+          }.to change { parent.son_col }
+           .from('different' => 'true')
+           .to(son.to_h.stringify_keys.merge('_type' => 'Parent'))
         end
 
       end
@@ -72,7 +74,7 @@ describe Embedson::Model::EmbeddedBuilder do
       context 'and to_h is equal parents embeded.to_h' do
         before do
           son
-          parent.send(:write_attribute, :son_col, { something: { to: 'write' } } )
+          parent.send(:write_attribute, :son_col, { something: { to: 'write' }, _type: 'Parent' } )
           parent.save!
         end
 
@@ -109,7 +111,9 @@ describe Embedson::Model::EmbeddedBuilder do
         it 'changes parents emb_col to son.to_h' do
           expect{
             son.send(:parenta_send_to_related, son)
-          }.to change { parent.emb_col }.from('different' => 'true').to(son.to_h.stringify_keys)
+          }.to change { parent.emb_col }
+           .from('different' => 'true')
+           .to(son.to_h.stringify_keys.merge('_type' => 'Parent'))
         end
 
       end
@@ -210,9 +214,9 @@ describe Embedson::Model::EmbeddedBuilder do
 
         it 'changes column values' do
           son.save
-          expect(parent.son_col).to eq('something' => different)
+          expect(parent.son_col).to eq('something' => different, '_type' => 'Parent')
           expect(parent.emb_col).to be_nil
-          expect(parent_two.son_col).to eq('something' => different)
+          expect(parent_two.son_col).to eq('something' => different, '_type' => 'ParentTwo')
         end
 
         context 'and son is changed' do
@@ -222,9 +226,9 @@ describe Embedson::Model::EmbeddedBuilder do
               son.change = 'new value'
               son.save
             }.to change { parent.reload.son_col }
-                  .from('something' => different)
-                  .to('something' => different, 'change' => 'new value')
-            expect(parent_two.son_col).to eq('something' => different, 'change' => 'new value')
+             .from('something' => different, '_type' => 'Parent')
+             .to('something' => different, 'change' => 'new value', '_type' => 'Parent')
+            expect(parent_two.son_col).to eq('something' => different, 'change' => 'new value', '_type' => 'ParentTwo')
           end
         end
       end
@@ -257,7 +261,7 @@ describe Embedson::Model::EmbeddedBuilder do
 
           it 'changes column values' do
             expect(son.save).to be_truthy
-            expect(parent.son_col).to eq('something' => different)
+            expect(parent.son_col).to eq('something' => different, '_type' => 'Parent')
             expect(parent.emb_col).to be_nil
           end
         end
@@ -331,9 +335,9 @@ describe Embedson::Model::EmbeddedBuilder do
         it 'changes column values' do
           expect(son.save!).to be_truthy
           parent.reload
-          expect(parent.son_col).to eq('something' => different)
+          expect(parent.son_col).to eq('something' => different, '_type' => 'Parent')
           expect(parent.emb_col).to be_nil
-          expect(parent_two.reload.son_col).to eq('something' => different)
+          expect(parent_two.reload.son_col).to eq('something' => different, '_type' => 'ParentTwo')
         end
 
         context 'and son is changed' do
@@ -343,9 +347,9 @@ describe Embedson::Model::EmbeddedBuilder do
               son.change = 'new value'
               son.save!
             }.to change { parent.reload.son_col }
-                  .from('something' => different)
-                  .to('something' => different, 'change' => 'new value')
-            expect(parent_two.son_col).to eq('something' => different, 'change' => 'new value')
+             .from('something' => different, '_type' => 'Parent')
+             .to('something' => different, 'change' => 'new value', '_type' => 'Parent')
+            expect(parent_two.son_col).to eq('something' => different, 'change' => 'new value', '_type' => 'ParentTwo')
           end
         end
       end
@@ -378,7 +382,7 @@ describe Embedson::Model::EmbeddedBuilder do
 
           it 'changes column values' do
             expect(son.save!).to be_truthy
-            expect(parent.son_col).to eq('something' => different)
+            expect(parent.son_col).to eq('something' => different, '_type' => 'Parent')
             expect(parent.emb_col).to be_nil
           end
         end
@@ -387,12 +391,22 @@ describe Embedson::Model::EmbeddedBuilder do
   end
 
   describe 'defined .destroy' do
+
+
+    context 'when there is no parent' do
+      let(:son) { Son.new }
+
+      it 'returns false' do
+        expect(son.destroy).to be_falsey
+      end
+    end
+
     context 'when there is parent' do
       let(:son) { Son.new(parent: parent, parent_two: parent_two) }
 
       context 'and destroy on all returns true' do
         it 'returns true' do
-          expect(son.destroy).to eq(true)
+          expect(son.destroy).to be_truthy
         end
       end
 

data/spec/embedson/model/embeds_builder_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Embedson::Model::EmbedsBuilder do
+
+  with_model :Parent do
+    table do |t|
+      t.json :son_col
+    end
+
+    model do
+      embeds_one :son, column_name: :son_col, class_name: FirstSon
+    end
+  end
+
+  class FirstSon < OpenStruct
+    extend Embedson::Model
+
+    embedded_in :parent, inverse_of: :son
+
+  end
+
+  class FirstSonsChild < FirstSon
+  end
+
+  describe 'defined #son method' do
+    context 'when child of embedded model is assigned as son' do
+      let(:parent) { Parent.new(son: son) }
+      let(:son) { FirstSonsChild.new(some: 'random') }
+
+      it 'returns SonsChild instance' do
+        expect(parent.son).to be_a FirstSonsChild
+        expect(parent.son).to eq son
+      end
+
+      context 'when aprent is persisted' do
+        before do
+          parent.save!
+        end
+
+        it 'returns SonsChild instance' do
+          expect(parent.reload.son).to be_a FirstSonsChild
+          expect(parent.son).to eq son
+        end
+      end
+    end
+  end
+end

data/spec/embedson/model_spec.rb

@@ -86,7 +86,7 @@ describe Embedson::Model do
               expect{
                 parent.embedded = embedded
                 parent.save!
-              }.to change { parent.reload.read_attribute(:embedded) }.from(nil).to(embedded.to_h.stringify_keys)
+              }.to change { parent.reload.read_attribute(:embedded) }.from(nil).to(embedded.to_h.stringify_keys.merge('_type' => 'Parent'))
             end
           end
         end
@@ -155,7 +155,7 @@ describe Embedson::Model do
         expect {
           parent.embeddedb = embedded
           parent.save!
-        }.to change{ parent.read_attribute(:data) }.from(nil).to(embedded.to_h.stringify_keys)
+        }.to change{ parent.read_attribute(:data) }.from(nil).to(embedded.to_h.stringify_keys.merge('_type' => 'Parent'))
       end
     end
 
@@ -336,76 +336,12 @@ describe Embedson::Model do
               expect{
                 embedded.parent = parent
                 parent.save!
-              }.to change { parent.reload.read_attribute(:embedded) }.from(nil).to(embedded.to_h.stringify_keys)
+              }.to change { parent.reload.read_attribute(:embedded) }.from(nil).to(embedded.to_h.stringify_keys.merge('_type' => 'Parent'))
             end
           end
         end
       end
 
-      describe 'defined .save! method' do
-
-        context 'when there is parent' do
-          let(:embedded) { Embeddede.new(parent: parent) }
-
-          it 'calls .save on parent' do
-            expect(parent).to receive(:save!)
-            embedded.save!
-          end
-
-          it 'saves to_h result in parent column' do
-            parent.save!
-            expect {
-              embedded.save!
-            }.to change { parent.reload.read_attribute(:embedded) }.from(nil).to({ "defined" => "in", "embedded" => true })
-          end
-
-          context 'and embedded is changed' do
-            it 'saves changes in parent' do
-              embedded.save!
-              expect {
-                embedded.change = 'new value'
-                embedded.save!
-              }.to change { parent.reload.read_attribute(:embedded) }
-                    .from({ "defined" => "in", "embedded" => true })
-                    .to({"defined"=>"in", "embedded"=>true, "change"=>"new value"})
-            end
-          end
-        end
-
-        context 'when there is no parent' do
-          it 'raises argument error' do
-            expect { embedded.save! }.to raise_error(Embedson::NoParentError)
-          end
-        end
-      end
-
-      describe 'defined .destroy method' do
-
-        context 'when there is parent' do
-          let(:embedded) { Embeddede.new(parent: parent) }
-
-          it 'calls .save! on parent' do
-            expect(parent).to receive(:save!)
-            embedded.destroy
-          end
-
-          it 'saves nil in parent column' do
-            embedded.save!
-            expect {
-              embedded.destroy
-            }.to change { parent.reload.read_attribute(:embedded) }.from({ "defined" => "in", "embedded" => true }).to(nil)
-          end
-        end
-
-        context 'when there is no parent' do
-          let(:embedded) { Embeddede.new }
-
-          it 'returns false' do
-            expect(embedded.destroy).to eq(false)
-          end
-        end
-      end
-
       describe 'defined .embedson_model_changed! method' do
 
         context 'when there is parent' do
@@ -419,7 +355,9 @@ describe Embedson::Model do
             embedded.change = 'registered'
             expect {
               embedded.embedson_model_changed!
-            }.to change { parent.read_attribute(:embedded) }.from({ "defined" => "in", "embedded" => true }).to({ "defined" => "in", "embedded" => true, 'change' => 'registered' })
+            }.to change { parent.read_attribute(:embedded) }
+             .from({ "defined" => "in", "embedded" => true, '_type' => 'Parent' })
+             .to({ "defined" => "in", "embedded" => true, 'change' => 'registered', '_type' => 'Parent' })
           end
         end
 

metadata

@@ -1,136 +1,137 @@
 --- !ruby/object:Gem::Specification
 name: embedson
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - sufleR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: with_model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: Save any class which respond to to_h in json column as embedded model.
+description: Save hash representation of class in json column as embedded model.
 email:
 - szymon.fracczak@netguru.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -146,6 +147,7 @@ files:
 - lib/embedson/version.rb
 - spec/embedson/exceptions_spec.rb
 - spec/embedson/model/embedded_builder_spec.rb
+- spec/embedson/model/embeds_builder_spec.rb
 - spec/embedson/model/method_builder_spec.rb
 - spec/embedson/model_spec.rb
 - spec/spec_helper.rb
@@ -159,23 +161,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Embedded model for AR with postgresql
 test_files:
 - spec/embedson/exceptions_spec.rb
 - spec/embedson/model/embedded_builder_spec.rb
+- spec/embedson/model/embeds_builder_spec.rb
 - spec/embedson/model/method_builder_spec.rb
 - spec/embedson/model_spec.rb
 - spec/spec_helper.rb