serialize_has_many 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzAzZTE0ODM2OTIxNmY4ZWM2ZjUxYWZhNDQ5Nzk4NDVmZTEyNjhmNw==
+  data.tar.gz: !binary |-
+    MjlhZDVhY2JmY2I0NmViNmU4NDEzYTFiMmVhNDNkMzc5NzVmNjFhZA==
+SHA512:
+  metadata.gz: !binary |-
+    YTcxMDhjMzljYmJmNTI3ZDljMWE3MTM5ZDNmMDVmYjViZWNmNzBmNTVlZDNi
+    MmZiOTA1OGEwZWYyM2QzYTNiZDc1ZWQyMzRjYTA5MzgyMDEwYWY5NDMyNjVi
+    MWFhNTNmNjA0ZDI5MzE1YTU0Y2M2M2Q2MzFmNmFhNDE2MGMxYjY=
+  data.tar.gz: !binary |-
+    OWEyNzE4MzdkYWU3OTk5ZWY5YTdmZTNlMTQwNzAwOWFkMTRlNTUwODQzZmJk
+    NjE1NmViYmJiYzgwYjg0ZjRmNzhlMTlhZTU5NTNkOTU1ZGY4NGFmYmI5YTAx
+    OTU1ZGI0YTBjOTNlZDA5ZDQ5MTdhODlkMTM2NDY5M2MyYzU4MmM=

data/README.md

@@ -0,0 +1,59 @@
+# SerializeHasMany
+
+Serializes `has_many` relationships into a single column while still doing attributes, validations, callbacks, nested forms and fields_for. Easy NoSQL with ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serialize_has_many'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serialize_has_many
+
+## Usage
+
+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
+* Add `serialize_has_many` in the Parent
+
+### Example
+
+(For a real scenario, check `example/app/models/`)
+
+```ruby
+class Child
+  include ActiveModel::Model
+  attr_accessor :name, :age, ...
+  validates ...
+
+  def attributes
+    { name: name, age: age, ... }
+  end
+end
+
+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>
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/serialize_has_many/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/lib/serialize_has_many/concern.rb

@@ -0,0 +1,29 @@
+require "active_support/concern"
+require "active_support/core_ext/module/aliasing"
+
+module SerializeHasMany
+  module Concern
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def serialize_has_many(attr_name, child_class, options=nil)
+        reject_if = options[:reject_if]
+        using = options[:using] || raise(':using is required')
+        serializer = Serializer.new(child_class, using)
+
+        serialize attr_name, serializer
+        validates_with Validators::TypeValidator, attr_name: attr_name, child_class: child_class
+
+        define_method "#{attr_name}_attributes=" do |items|
+          values = items.kind_of?(Hash) ? items.values : items
+          values = values.reject { |v| reject_if.call(v) } if reject_if
+          write_attribute attr_name, serializer.from_attributes(values)
+        end
+
+        if options[:validate] == true
+          validates_with Validators::NestedValidator, attr_name: attr_name, child_class: child_class
+        end
+      end
+    end
+  end
+end

data/lib/serialize_has_many/serializer.rb

@@ -0,0 +1,53 @@
+module SerializeHasMany
+  class Serializer
+    def initialize(child_class, using)
+      raise "#{child_class} does not respond to attributes" unless child_class.method_defined?(:attributes)
+      raise "#{using} does not implement load" unless using.respond_to?(:load)
+      raise "#{using} does not implement dump" unless using.respond_to?(:dump)
+
+      @child_class = child_class
+      @using = using
+    end
+
+    def load(string)
+      from_attributes @using.load(string)
+    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
+    end
+
+    def from_attributes(items)
+      case items
+        when nil then []
+        when Array then items.map{ |item| from_item(item) }
+        else raise('not an array or nil')
+      end
+    end
+
+    def to_attributes(items)
+      case items
+        when nil then nil
+        when Array then items.map{ |item| to_item(item) }
+        else raise('not an array or nil')
+      end
+    end
+
+    def from_item(item)
+      case item
+        when nil then nil
+        when @child_class then item
+        else @child_class.new(item)
+      end
+    end
+
+    def to_item(item)
+      item ? item.attributes : nil
+    end
+  end
+end

data/lib/serialize_has_many/validators/nested_validator.rb

@@ -0,0 +1,41 @@
+require 'active_model/validator'
+
+module SerializeHasMany
+  module Validators
+    class NestedValidator < ActiveModel::Validator
+      def attr_name
+        options[:attr_name]
+      end
+
+      def child_class
+        options[:child_class]
+      end
+
+      def attributes
+        [ attr_name ]
+      end
+
+      def validate(record)
+        items = record.send attr_name
+
+        if items.nil?
+          nil
+        elsif items.kind_of?(Array)
+          validate_each(record, items)
+        else
+          record.errors.add "#{attr_name}", "is not an array"
+        end
+      end
+
+      def validate_each(record, items)
+        items.each do |item|
+          if !item.nil? && !item.valid?
+            item.errors.each do |error, message|
+              record.errors.add "#{attr_name}.#{error}", message
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/serialize_has_many/validators/type_validator.rb

@@ -0,0 +1,39 @@
+require 'active_model/validator'
+
+module SerializeHasMany
+  module Validators
+    class TypeValidator < ActiveModel::Validator
+      def attr_name
+        options[:attr_name]
+      end
+
+      def child_class
+        options[:child_class]
+      end
+
+      def attributes
+        [ attr_name ]
+      end
+
+      def validate(record)
+        items = record.send attr_name
+
+        if items.nil?
+          nil
+        elsif items.kind_of?(Array)
+          validate_each(record, items)
+        else
+          record.errors.add "#{attr_name}", "is not an array"
+        end
+      end
+
+      def validate_each(record, items)
+        items.each do |item|
+          unless item.nil? || item.kind_of?(child_class)
+            record.errors.add "#{attr_name}", "item is not of type #{child_class}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/serialize_has_many/validators.rb

@@ -0,0 +1,6 @@
+module SerializeHasMany
+  module Validators
+    autoload :TypeValidator, 'serialize_has_many/validators/type_validator'
+    autoload :NestedValidator, 'serialize_has_many/validators/nested_validator'
+  end
+end

data/lib/serialize_has_many/version.rb

@@ -0,0 +1,3 @@
+module SerializeHasMany
+  VERSION = "0.0.1"
+end

data/lib/serialize_has_many.rb

@@ -0,0 +1,7 @@
+require "serialize_has_many/version"
+
+module SerializeHasMany
+  autoload :Concern,    'serialize_has_many/concern'
+  autoload :Serializer, 'serialize_has_many/serializer'
+  autoload :Validators, 'serialize_has_many/validators'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: serialize_has_many
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Subhas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Serialize has_many relationships into a single column
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/serialize_has_many.rb
+- lib/serialize_has_many/concern.rb
+- lib/serialize_has_many/serializer.rb
+- lib/serialize_has_many/validators.rb
+- lib/serialize_has_many/validators/nested_validator.rb
+- lib/serialize_has_many/validators/type_validator.rb
+- lib/serialize_has_many/version.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Serialize has_many relationships into a single column
+test_files: []