embedded_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02293fdb185c52cf9e47900b15c6671242a71cc1
+  data.tar.gz: 7196be5ee607c4a4424411569d274c3ffb424dab
+SHA512:
+  metadata.gz: 046380f5d754a6a53c953dd29805f0cc3910ad3168a2025a945a04a33f1e855849a3bd8d621e48201b121606c603ee8496333f9fc99180c41241cae823c6ba68
+  data.tar.gz: 9bed4cb001562418f5802374b1f162a2a72bd06c1fcc5d8e2698173b4068c483ef8801f4290ea47f05003658b81661d430351703902695548e710677dbd1cc08

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nikolai Vasilenko
+
+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,101 @@
+# EmbeddedModel
+
+A simple extension for ActiveRecord allowing to embed plain-models and store them as JSON. It's well-suited in case the use of full-featured models with underlying tables is redundant.
+
+Works with ActiveRecord ~> 4.2. Support of the 5th version has not been implemented yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'embedded_model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install embedded_model
+
+## Usage
+
+### Embeddable models
+
+Any class allowing to populate their attributes by passing hash into constructor will suit.
+
+```ruby
+class Person
+  attr_accessor :name
+
+  def initialize(attrs = {})
+    @name = attrs.with_indifferent_access['name']
+  end
+end
+```
+
+I recommend using [Virtus](https://github.com/solnic/virtus).
+
+```ruby
+class Person
+  include Virtus.model
+
+  attribute :name, String
+end
+```
+
+### Embedding into container model
+
+Add columns to be used as storage for embedded objects. If your database supports JSON (e.g. PostgreSQL), use type `json`, otherwise use `text`.
+
+Use `embeds_one` method for embedding single objects and `embeds_many` for collections.
+
+```ruby
+class Department < ActiveRecord::Base
+  embeds_one :boss
+  embeds_many :employees
+end
+```
+
+By default, names of the embeddable models are inferred from the column names. Should your classes have other names, it is necessary to specify them explicitly.
+
+```ruby
+class Party < ActiveRecord::Base
+  embeds_one :tank, class_name: 'Player'
+  embeds_many :dps, class_name: 'Player'
+end
+```
+
+### Example
+
+As soon as everything gets done, it simply works.
+
+```ruby
+department_params = {
+  boss: { name: 'Todd' },
+  employees: [{ name: 'Andy' }, { name: 'Jim' }]
+}
+
+department = Department.new(department_params)
+
+# Do something with your model objects
+department.boss.command('Work!')  # => Todd commands 'Work!'
+department.employees.each(&:work) # => Andy works hard Jim works hard
+
+department.save
+department.reload
+
+# Do something else
+department.boss.command('Good job!') # => Todd commands 'Good job!'
+department.employees.each(&:go_home) # => Andy goes home Jim goes home
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vasilenko/embedded_model.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/embedded_model.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'embedded_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'embedded_model'
+  spec.version       = EmbeddedModel::VERSION
+  spec.authors       = ['Nikolai Vasilenko']
+  spec.email         = ['colormailbox@gmail.com']
+
+  spec.summary       = 'Embeds your PORO models into ActiveRecord ones and stores them as JSON'
+  spec.homepage      = 'https://github.com/vasilenko/embedded_model'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.0'
+end

data/lib/embedded_model/active_record_extension.rb

@@ -0,0 +1,15 @@
+module EmbeddedModel
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def embeds_one(column, options = {})
+        EmbeddedModel::Embedder.new(self, column, options).embed_object
+      end
+
+      def embeds_many(column, options = {})
+        EmbeddedModel::Embedder.new(self, column, options).embed_collection
+      end
+    end
+  end
+end

data/lib/embedded_model/embedder.rb

@@ -0,0 +1,39 @@
+module EmbeddedModel
+  class Embedder
+    def initialize(container, column, options = {})
+      @container = container
+      @column = column
+      @class_name = options[:class_name]
+    end
+
+    def embed_object
+      embed object_builder
+    end
+
+    def embed_collection
+      embed collection_builder, default: []
+    end
+
+    private
+
+    def embed(builder, options = {})
+      @container.attribute(@column, EmbeddedModel::Type.new(&builder), options)
+    end
+
+    def model
+      @model ||=
+        begin
+          return @class_name if @class_name.is_a?(Class)
+          (@class_name || @column).to_s.classify.constantize
+        end
+    end
+
+    def object_builder
+      ->(attrs) { attrs.is_a?(model) ? attrs : model.new(attrs) }
+    end
+
+    def collection_builder
+      ->(arr) { arr.map(&object_builder) }
+    end
+  end
+end

data/lib/embedded_model/type.rb

@@ -0,0 +1,27 @@
+require 'active_record/connection_adapters/postgresql/oid/json'
+
+module EmbeddedModel
+  class Type < ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json
+    def initialize(&builder)
+      @builder = builder
+    end
+
+    def type_cast_from_database(value)
+      type_cast(super)
+    end
+
+    def type_cast_from_user(value)
+      type_cast(value)
+    end
+
+    def type_cast_for_database(value)
+      super(value.as_json)
+    end
+
+    private
+
+    def cast_value(value)
+      @builder.call(value)
+    end
+  end
+end

data/lib/embedded_model/version.rb

@@ -0,0 +1,3 @@
+module EmbeddedModel
+  VERSION = '0.1.0'
+end

data/lib/embedded_model.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+require 'embedded_model/version'
+require 'embedded_model/type'
+require 'embedded_model/embedder'
+require 'embedded_model/active_record_extension'
+
+ActiveRecord::Base.include(EmbeddedModel::ActiveRecordExtension)

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: embedded_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikolai Vasilenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- colormailbox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- embedded_model.gemspec
+- lib/embedded_model.rb
+- lib/embedded_model/active_record_extension.rb
+- lib/embedded_model/embedder.rb
+- lib/embedded_model/type.rb
+- lib/embedded_model/version.rb
+homepage: https://github.com/vasilenko/embedded_model
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Embeds your PORO models into ActiveRecord ones and stores them as JSON
+test_files: []