value_objects 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fcf100e50deeb0be95ee828543bebc1271b8ccfe
+  data.tar.gz: eb2293813317264b2fcbdfcae89feaa7a8f48298
+SHA512:
+  metadata.gz: 650a0c71dcba21c4ea3774471de37a7b3937319c73d80ae411a396e520dca12bcc2fd7c6570f22791bc6e42add3016f10a3c024b1441195712fc0e5fc4654734
+  data.tar.gz: ed81e88aa8436eb2d76ba35f87346ff55643573cf27726828e3729f1568f388cf072694db9c1267e16caa6055a473cb52d1b3caf7a5cd30e4b058a94e62a01a5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matthew Yeow
+
+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,230 @@
+# ValueObjects
+
+Serializable and validatable value objects for ActiveRecord
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'value_objects'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install value_objects
+
+## Usage
+
+### Create the value object class
+
+The value object class inherits from `ValueObjects::Base`, and attributes are defined with `attr_accessor`:
+
+```ruby
+class AddressValue < ValueObjects::Base
+  attr_accessor :street, :postcode, :city
+end
+
+address = AddressValue.new(street: '123 Big Street', postcode: '12345', city: 'Metropolis')
+address.street # => "123 Big Street"
+address.street = '321 Main St' # => "321 Main St"
+address.to_hash # => {:street=>"321 Main St", :postcode=>"12345", :city=>"Metropolis"}
+```
+
+### Add validations
+
+Validations can be added using the DSL from `ActiveModel::Validations`:
+
+```ruby
+class AddressValue < ValueObjects::Base
+  attr_accessor :street, :postcode, :city
+  validates :postcode, presence: true
+end
+
+address = AddressValue.new(street: '123 Big Street', city: 'Metropolis')
+address.valid? # => false
+address.errors.to_h # => {:postcode=>"can't be blank"}
+address.postcode = '12345' # => "12345"
+address.valid? # => true
+address.errors.to_h # => {}
+```
+
+### Serialization with ActiveRecord
+
+For columns of `json` type, the value object class can be used as the coder for the `serialize` method:
+
+```ruby
+class Customer < ActiveRecord::Base
+  serialize :home_address, AddressValue
+end
+
+customer = Customer.new
+customer.home_address = AddressValue.new(street: '123 Big Street', postcode: '12345', city: 'Metropolis')
+customer.save
+customer.reload
+customer.home_address # => #<AddressValue:0x00ba9876543210 @street="123 Big Street", @postcode="12345", @city="Metropolis">
+```
+
+For columns of `string` or `text` type, wrap the value object class in a `JsonCoder`:
+
+```ruby
+class Customer < ActiveRecord::Base
+  serialize :home_address, ValueObjects::ActiveRecord::JsonCoder.new(AddressValue)
+end
+```
+
+### Validation with ActiveRecord
+
+By default, validating the record does not automatically validate the value object.
+Use the `ValueObjects::ValidValidator` to make this automatic:
+
+```ruby
+class Customer < ActiveRecord::Base
+  serialize :home_address, AddressValue
+  validates :home_address, 'value_objects/valid': true
+  validates :home_address, presence: true # other validations are allowed too
+end
+
+customer = Customer.new
+customer.home_address = AddressValue.new(street: '123 Big Street', city: 'Metropolis')
+customer.valid? # => false
+customer.errors.to_h # => {:home_address=>"is invalid"}
+customer.home_address.errors.to_h # => {:postcode=>"can't be blank"}
+customer = Customer.new
+customer.valid? # => false
+customer.errors.to_h # => {:home_address=>"can't be blank"}
+```
+
+### With `ValueObjects::ActiveRecord`
+
+For easy set up of both serialization and validation, `include ValueObjects::ActiveRecord` and invoke `value_object`:
+
+```ruby
+class Customer < ActiveRecord::Base
+  include ValueObjects::ActiveRecord
+  value_object :home_address, AddressValue
+  validates :home_address, presence: true
+end
+```
+
+This basically works the same way but also defines the `<attribute>_attributes=` method which can be used to assign the value object using a hash:
+
+```ruby
+customer.home_address_attributes = { street: '321 Main St', postcode: '54321', city: 'Micropolis' }
+customer.home_address # => #<AddressValue:0x00ba9876503210 @street="321 Main St", @postcode="54321", @city="Micropolis">
+```
+
+This is functionally similar to what `accepts_nested_attributes_for` does for associations.
+
+Also, `value_object` will use the `JsonCoder` automatically if it detects that the column type is `string` or `text`.
+
+Additional options may be passed in to customize validation:
+
+```ruby
+class Customer < ActiveRecord::Base
+  include ValueObjects::ActiveRecord
+  value_object :home_address, AddressValue, allow_nil: true
+end
+```
+
+Or, to skip validation entirely:
+
+```ruby
+class Customer < ActiveRecord::Base
+  include ValueObjects::ActiveRecord
+  value_object :home_address, AddressValue, no_validation: true
+end
+```
+
+### Value object collections
+
+Serialization and validation of value object collections are also supported.
+
+First, create a nested `Collection` class that inherits from `ValueObjects::Base::Collection`:
+
+```ruby
+class AddressValue < ValueObjects::Base
+  attr_accessor :street, :postcode, :city
+  validates :postcode, presence: true
+
+  class Collection < Collection
+  end
+end
+```
+
+Then use the nested `Collection` class as the serialization coder:
+
+```ruby
+class Customer < ActiveRecord::Base
+  include ValueObjects::ActiveRecord
+  value_object :addresses, AddressValue::Collection
+  validates :addresses, presence: true
+end
+
+customer = Customer.new(addresses: [])
+customer.valid? # => false
+customer.errors.to_h # => {:addresses=>"can't be blank"}
+customer.addresses << AddressValue.new(street: '123 Big Street', postcode: '12345', city: 'Metropolis')
+customer.valid? # => true
+customer.addresses << AddressValue.new(street: '321 Main St', city: 'Micropolis')
+customer.valid? # => false
+customer.errors.to_h # => {:addresses=>"is invalid"}
+customer.addresses[1].errors.to_h # => {:postcode=>"can't be blank"}
+```
+
+The `<attribute>_attributes=` method also functions in much the same way:
+
+```ruby
+customer.addresses_attributes = { '0' => { city: 'Micropolis' }, '1' => { city: 'Metropolis' } }
+customer.addresses # => [#<AddressValue:0x00ba9876543210 @city="Micropolis">, #<AddressValue:0x00ba9876503210 @city="Metropolis">]
+```
+
+Except, items with '-1' keys are considered as dummy items and ignored:
+
+```ruby
+customer.addresses_attributes = { '0' => { city: 'Micropolis' }, '-1' => { city: 'Metropolis' } }
+customer.addresses # => [#<AddressValue:0x00ba9876543210 @city="Micropolis">]
+```
+
+This is useful when data is submitted via standard HTML forms encoded with the 'application/x-www-form-urlencoded' media type (which cannot represent empty collections). To work around this, a dummy item can be added to the collection with it's key set to '-1' and it will conveniently be ignored when assigned to the value object collection.
+
+### Integrate with Cocoon
+
+Put this into a Rails initializer (e.g. `config/initializers/value_objects.rb`):
+
+```ruby
+ValueObjects::ActionView.integrate_with :cocoon
+```
+
+This will add the `link_to_add_nested_value` & `link_to_remove_nested_value` view helpers.
+Use them in place of Cocoon's `link_to_add_association` & `link_to_remove_association` when working with nested value objects:
+
+```ruby
+# use the attribute name (:addresses) in place of the association name
+# and supply the value object class as the next argument
+link_to_add_nested_value 'Add Address', f, :addresses, AddressValue
+
+# the `f` form builder argument is not needed
+link_to_remove_nested_value 'Remove Address'
+```
+
+## Maintainers
+
+* Matthew Yeow (https://github.com/tbsmatt), Tinkerbox Studios (https://www.tinkerbox.com.sg/)
+
+## Contributing
+
+* Fork the repository.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so we don't break it in a future version unintentionally.
+* Commit, but do not mess with rakefile or version. (if you want to have your own version, that is fine but bump version in a commit by itself)
+* Submit a pull request. Bonus points for topic branches.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/value_objects/action_view/cocoon.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module ValueObjects
+
+  module ActionView
+
+    module Cocoon
+
+      def link_to_add_nested_value(name, f, attribute, value_class, html_options = {}, &block)
+        render_options = html_options.delete(:render_options) || {}
+        partial = html_options.delete(:partial)
+        wrap_object = html_options.delete(:wrap_object)
+        form_name = html_options.delete(:form_name) || 'f'
+        count = html_options.delete(:count).to_i
+        new_object = value_class.new
+        new_object = wrap_object.call(new_object) if wrap_object
+
+        html_options[:class] = [html_options[:class], 'add_fields'].compact.join(' ')
+        html_options[:'data-association'] = attribute
+        html_options[:'data-association-insertion-template'] = CGI.escapeHTML(render_association(attribute, f, new_object, form_name, render_options, partial)).html_safe
+        html_options[:'data-count'] = count if count > 0
+
+        name = capture(&block) if block_given?
+        dummy_input = tag(:input, type: 'hidden', name: "#{f.object_name}[#{attribute}_attributes][-1][_]")
+        content_tag(:a, name, html_options) + dummy_input
+      end
+
+      def link_to_remove_nested_value(name, html_options = {}, &block)
+        wrapper_class = html_options.delete(:wrapper_class)
+
+        html_options[:class] = [html_options[:class], 'remove_fields dynamic'].compact.join(' ')
+        html_options[:'data-wrapper-class'] = wrapper_class if wrapper_class
+
+        name = capture(&block) if block_given?
+        content_tag(:a, name, html_options)
+      end
+
+    end
+
+  end
+
+end
+
+ActionView::Base.send(:include, ValueObjects::ActionView::Cocoon)

data/lib/value_objects/action_view.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ValueObjects
+
+  module ActionView
+
+    def self.integrate_with(library)
+      require "value_objects/action_view/#{library}"
+    end
+
+  end
+
+end

data/lib/value_objects/active_record.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module ValueObjects
+
+  module ActiveRecord
+
+    def self.included(base)
+      base.extend self
+    end
+
+    def value_object(attribute, value_class, options = {})
+      type =
+        begin
+          column_for_attribute(attribute)&.type
+        rescue ::ActiveRecord::StatementInvalid
+          # This can happen if `column_for_attribute` is called but the database table does not exist
+          # as will be the case when migrations are run and the model class is loaded by initializers
+          # before the table is created.
+          # This is a workaround to prevent such migrations from failing.
+          nil
+        end
+      coder =
+        case type
+        when :string, :text
+          JsonCoder.new(value_class)
+        else
+          value_class
+        end
+      serialize(attribute, coder)
+      validates_with(::ValueObjects::ValidValidator, options.merge(attributes: [attribute])) unless options[:no_validation]
+      setter = :"#{attribute}="
+      define_method("#{attribute}_attributes=") do |attributes|
+        send(setter, value_class.new(attributes))
+      end
+    end
+
+    class JsonCoder
+
+      EMPTY_ARRAY = [].freeze
+
+      def initialize(value_class)
+        @value_class = value_class
+      end
+
+      def load(value)
+        @value_class.load(JSON.load(value) || EMPTY_ARRAY) if value
+      end
+
+      def dump(value)
+        value.to_json if value
+      end
+
+    end
+
+  end
+
+end

data/lib/value_objects/base.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+module ValueObjects
+
+  class Base
+
+    include ::ActiveModel::Model
+
+    def ==(other)
+      self.class == other.class && self.class.attrs.all? { |key| public_send(key) == other.public_send(key) }
+    end
+
+    def to_hash
+      self.class.attrs.each_with_object({}) { |key, hash| hash[key] = public_send(key) }
+    end
+
+    class << self
+
+      def load(value)
+        new(value) if value
+      end
+
+      def dump(value)
+        value.to_hash if value
+      end
+
+      def i18n_scope
+        :value_objects
+      end
+
+      attr_reader :attrs
+
+      private
+
+      def attr_accessor(*args)
+        (@attrs ||= []).concat(args)
+        super(*args)
+      end
+
+    end
+
+    class Collection
+
+      class << self
+
+        def inherited(subclass)
+          subclass.instance_variable_set(:@value_class, subclass.parent)
+        end
+
+        def new(attributes)
+          # Data encoded with the 'application/x-www-form-urlencoded' media type cannot represent empty collections.
+          # As a workaround, a dummy item can be added to the collection with it's key set to '-1'.
+          # This dummy item will be ignored when initializing the value collection.
+          attributes.map { |k, v| @value_class.new(v) if k != '-1' }.compact
+        end
+
+        def load(values)
+          (values.blank? ? [] : values.map { |value| @value_class.new(value) }) if values
+        end
+
+        def dump(values)
+          values.map(&:to_hash) if values
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/value_objects/valid_validator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ValueObjects
+
+  class ValidValidator < ActiveModel::EachValidator
+
+    def validate_each(record, attribute, value)
+      record.errors.add(attribute, :invalid) unless value && Array(value).count(&:invalid?) == 0
+    end
+
+  end
+
+end

data/lib/value_objects/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module ValueObjects
+  VERSION = '0.1.0'
+end

data/lib/value_objects.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'active_record'
+require 'value_objects/version'
+require 'value_objects/base'
+require 'value_objects/valid_validator'
+require 'value_objects/active_record'
+require 'value_objects/action_view'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: value_objects
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Yeow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- matthew.yeow@tinkerbox.com.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/value_objects.rb
+- lib/value_objects/action_view.rb
+- lib/value_objects/action_view/cocoon.rb
+- lib/value_objects/active_record.rb
+- lib/value_objects/base.rb
+- lib/value_objects/valid_validator.rb
+- lib/value_objects/version.rb
+homepage: https://github.com/tinkerbox/value_objects
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+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: Serializable and validatable value objects for ActiveRecord
+test_files: []