embedson 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b52da8a4596e89eaa71d2a1f109988c9157cc51
+  data.tar.gz: adf12afbc8c12ca1c1b751def0865010217fa421
+SHA512:
+  metadata.gz: 9463f20a91ef4449246cda718aa4e1a2671d1b7fe6a37d2f92836392e6f76b3caa84b0042482b5e400c653caa7deb6969c3335b3016b17f7e5339946283a5a1b
+  data.tar.gz: e0346bfea5cd34fc28bd695b96ab5160421a65f3c42cf7e8aac19fd0fcdf42e81fe8fb78aeb68cdd4333ae28990b60dc1de2d3c551ae9d68f737cccfe3a39349

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in embedson.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 sufleR
+
+MIT License
+
+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,83 @@
+# Embedson
+
+Adds functionality of `embedded_one` and `embedded_in`. 
+
+Embeded class is saved in json column.
+
+Embedded class have to provide `to_h` method which should return data to store in database.
+
+####TODO
+
+1. More tests
+2. Code refactoring to clean up `embedded_in` and `embeds_one` from define methods
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'embedson'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install embedson
+
+## Usage
+
+Example with [Virtus](https://github.com/solnic/virtus):
+
+```RUBY
+	
+	#create_tests.rb - migration	
+	class CreateTests < ActiveRecord::Migration
+	  def change
+	    create_table :tests do |t|
+		  t.json :data
+		end
+	  end
+	end
+	
+	class Test < ActiveRecord::Base
+	  extend Embedson::Model
+ 
+	  embeds_one :virt, column_name: :data, inverse_of: :parent
+	end
+
+	class Virt
+	  include Virtus.model
+	  extend Embedson::Model
+ 
+	  attribute :name, String
+	  attribute :address, Hash
+	
+	  embedded_in :parent, class_name: Test
+	end
+	
+	virt = Virt.new(name: 'Sample', address: { street: 'Kind', number: '33' })
+	virt.attributes # => {:name=>"Sample", :address=>{:street=>"Kind", :number=>"33"}}
+	
+	test = Test.create!
+	test.attributes # => {"id"=>1, "data"=>nil
+	
+	test.virt = virt
+	test.save
+	test.attributes # => {"id"=>1, "data"=>{"name"=>"Sample", "address"=>{"street"=>"Kind", "number"=>"33"}
+	
+	test.reload.virt.attributes # =>  {:name=>"Sample", :address=>{:street=>"Kind", :number=>"33"}, :children=>[]}
+	test.virt == virt # => true
+	test.virt.parent == test # => true
+	
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/embedson/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/embedson.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'embedson/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "embedson"
+  spec.version       = Embedson::VERSION
+  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.homepage      = "https://github.com/sufleR/embedson"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "with_model"
+
+end

data/lib/embedson/model.rb

@@ -0,0 +1,79 @@
+module Embedson::Model
+
+  def embeds_one(name, options = {})
+    column_name = options.fetch(:column_name, nil) || name
+    klass_name = (options.fetch(:class_name, nil) || name).to_s.classify
+    inverse_get = options.fetch(:inverse_of, nil) || self.name.downcase
+    inverse_set = "#{inverse_get}="
+
+    define_method("#{name}=") do |arg|
+      raise TypeError, "wrong argument type #{arg.class.name} (expected #{klass_name})" unless arg.nil? || arg.is_a?(klass_name.constantize)
+
+      if arg.respond_to?(inverse_set) && arg.public_send(inverse_get) != self
+        arg.public_send(inverse_set, self)
+      end
+
+      instance_variable_set("@#{name}", arg)
+      write_attribute(column_name, arg.nil? ? arg : arg.to_h)
+    end
+
+    define_method(name) do
+      return if read_attribute(column_name).nil?
+
+      if instance_variable_get("@#{name}").nil?
+        model = klass_name.constantize.new(read_attribute(column_name))
+        instance_variable_set("@#{name}", model)
+        model.public_send(inverse_set, self) if model.respond_to?(inverse_set)
+      end
+      instance_variable_get("@#{name}")
+    end
+  end
+
+  def embedded_in(name, options = {})
+    klass_name = (options.fetch(:class_name, nil) || name).to_s.classify
+    inverse_get = options.fetch(:inverse_of, nil) || self.name.demodulize.tableize.singularize
+    inverse_set = "#{inverse_get}="
+
+
+    define_method(name) do
+      instance_variable_get("@#{name}")
+    end
+
+    define_method("#{name}=") do |arg|
+      raise TypeError, "wrong argument type #{arg.class.name} (expected #{klass_name})" unless arg.nil? || arg.is_a?(klass_name.constantize)
+
+      instance_variable_set("@#{name}", arg)
+      parent = public_send(name)
+
+      if parent.respond_to?(inverse_set) && parent.public_send(inverse_get) != self
+        parent.public_send(inverse_set, self)
+      end
+    end
+
+    define_method('destroy') do
+      parent = public_send(name)
+      return false unless parent.present?
+      parent.public_send(inverse_set, nil)
+      parent.save!
+    end
+
+    define_method('save') do
+      parent = public_send(name)
+      return false unless parent.present?
+      parent.save
+    end
+
+    define_method('save!') do
+      parent = public_send(name)
+      raise "No parent model defined!" unless parent.present?
+      parent.save!
+    end
+
+    define_method('embedson_model_changed!') do
+      parent = public_send(name)
+      raise "No parent model defined!" unless parent.present?
+      parent.public_send(inverse_set, self)
+      true
+    end
+  end
+end

data/lib/embedson/version.rb

@@ -0,0 +1,3 @@
+module Embedson
+  VERSION = "0.0.2"
+end

data/lib/embedson.rb

@@ -0,0 +1,2 @@
+require "embedson/version"
+require "embedson/model"

data/spec/embedson/model_spec.rb

@@ -0,0 +1,248 @@
+require 'spec_helper'
+
+describe Embedson::Model do
+
+  describe '#emdbeds_one' do
+    context 'when only relation name is specified' do
+
+      with_model :Parent do
+        table do |t|
+          t.json :embedded
+        end
+
+        model do
+          extend Embedson::Model
+
+          embeds_one :embedded
+        end
+      end
+
+      class Embedded < OpenStruct
+
+        def to_h
+          { defined: 'in', embedded: true }
+        end
+      end
+
+      let(:parent) { Parent.new() }
+      let(:embedded) { Embedded.new() }
+
+      it 'adds "embeds_one" method' do
+        expect(Parent).to respond_to(:embeds_one)
+      end
+
+      it 'adds "embedded" method' do
+        expect(Parent.new()).to respond_to(:embedded)
+      end
+
+      it 'adds "embedded=" method' do
+        expect(Parent.new()).to respond_to("embedded=")
+      end
+
+      describe 'defined .embedded= method' do
+        it 'assigns value of embedded class' do
+          expect {
+            parent.embedded = embedded
+          }.to change{ parent.embedded }.from(nil).to(embedded)
+        end
+
+        context 'when assigning nil' do
+          let(:parent) { Parent.new(embedded: embedded) }
+
+          it 'removes assignmnent' do
+            parent
+            expect {
+              parent.embedded = nil
+            }.to change { parent.embedded }.from(embedded).to(nil)
+          end
+        end
+
+        context 'when assigning wrong class' do
+          it 'raises TypeError' do
+            expect{
+              parent.embedded = 'something'
+            }.to raise_error(TypeError)
+          end
+        end
+
+        context 'when Parent is persisted' do
+          before do
+            parent.save!
+          end
+
+          it 'marks parent as changed' do
+            expect {
+              parent.embedded = embedded
+            }.to change{ parent.changed? }.from(false).to(true)
+          end
+
+          context 'and saved after change' do
+            it 'saves Embedded class to json column' do
+              expect{
+                parent.embedded = embedded
+                parent.save!
+              }.to change { parent.reload.read_attribute(:embedded) }.from(nil).to(embedded.to_h.stringify_keys)
+            end
+          end
+        end
+      end
+
+      describe 'defined embedded method' do
+        context 'when value column is null' do
+          it 'returns nil' do
+            expect(parent.embedded).to be nil
+          end
+        end
+
+        it 'returns embedded class' do
+          parent.embedded = embedded
+          expect(parent.embedded).to be_a Embedded
+        end
+
+        context 'when there is defined value in column' do
+          before do
+            parent.embedded = embedded
+            parent.save!
+          end
+
+          it 'returns embedded class initialized with value from column' do
+            expect(parent.reload.embedded).to eq embedded
+          end
+        end
+      end
+    end
+
+    context 'when options include column_name' do
+
+      with_model :Parent do
+        table do |t|
+          t.json :data
+        end
+
+        model do
+          extend Embedson::Model
+
+          embeds_one :embedded, column_name: :data
+        end
+      end
+
+      class Embedded < OpenStruct
+
+        def to_h
+          { defined: 'in', embedded: true }
+        end
+      end
+
+      let(:parent) { Parent.new() }
+      let(:embedded) { Embedded.new() }
+
+      it 'adds "embeds_one" method' do
+        expect(Parent).to respond_to(:embeds_one)
+      end
+
+      it 'adds "embedded" method' do
+        expect(Parent.new()).to respond_to(:embedded)
+      end
+
+      it 'adds "embedded=" method' do
+        expect(Parent.new()).to respond_to("embedded=")
+      end
+
+      it 'saves embedded class to data column' do
+        expect {
+          parent.embedded = embedded
+          parent.save!
+        }.to change{ parent.read_attribute(:data) }.from(nil).to(embedded.to_h.stringify_keys)
+      end
+    end
+
+    context 'when options include inverse_of' do
+
+      with_model :Parent do
+        table do |t|
+          t.json :embedded
+        end
+
+        model do
+          extend Embedson::Model
+
+          embeds_one :embedded, inverse_of: :parent_m
+        end
+      end
+
+      class Embedded < OpenStruct
+        extend Embedson::Model
+
+        embedded_in :parent_m, class_name: 'Parent'
+
+        def to_h
+          { defined: 'in', embedded: true }
+        end
+      end
+
+      let(:parent) { Parent.new() }
+      let(:embedded) { Embedded.new() }
+
+      it 'adds "embeds_one" method' do
+        expect(Parent).to respond_to(:embeds_one)
+      end
+
+      it 'adds "embedded" method' do
+        expect(Parent.new()).to respond_to(:embedded)
+      end
+
+      it 'adds "embedded=" method' do
+        expect(Parent.new()).to respond_to("embedded=")
+      end
+
+      it 'assigns self to parent_m in embedded class' do
+        parent.embedded = embedded
+        expect(parent.embedded.parent_m).to eq parent
+      end
+    end
+
+    context 'when options include class_name' do
+
+      with_model :Parent do
+        table do |t|
+          t.json :embedded
+        end
+
+        model do
+          extend Embedson::Model
+
+          embeds_one :emb, class_name: 'Embedded', column_name: :embedded
+        end
+      end
+
+      class Embedded < OpenStruct
+        extend Embedson::Model
+
+        embedded_in :parent
+
+        def to_h
+          { defined: 'in', embedded: true }
+        end
+      end
+
+      let(:parent) { Parent.new(embedded: { some: 'thing' }) }
+      let(:embedded) { Embedded.new() }
+
+      it 'adds "embeds_one" method' do
+        expect(Parent).to respond_to(:embeds_one)
+      end
+
+      it 'adds "emb" method' do
+        expect(Parent.new()).to respond_to(:emb)
+      end
+
+      it 'adds "emb=" method' do
+        expect(Parent.new()).to respond_to("emb=")
+      end
+
+      it 'assigns self to parent_m in embedded class' do
+        expect(parent.emb.some).to eq 'thing'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,68 @@
+require 'embedson'
+require 'with_model'
+require 'pry'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.extend WithModel
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  ActiveRecord::Base.establish_connection(
+    "postgres://embedson:embedson@localhost/embedson"
+  )
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: embedson
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- sufleR
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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: pg
+  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
+  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: with_model
+  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: Save any class which respond to to_h in json column as embedded model.
+email:
+- szymon.fracczak@netguru.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embedson.gemspec
+- lib/embedson.rb
+- lib/embedson/model.rb
+- lib/embedson/version.rb
+- spec/embedson/model_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sufleR/embedson
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Embedded model for AR with postgresql
+test_files:
+- spec/embedson/model_spec.rb
+- spec/spec_helper.rb