store_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f5848ec2d1688ab965fe1c960c300ef7834270c433555cd51b09969a1b84ac2
+  data.tar.gz: 399e0250321b8ac5d470a0c52ae7ca9ca50a125b2a96e06c7eb2dd322a76baeb
+SHA512:
+  metadata.gz: 4638217fbbbb70dd9a649942dd7d3f28d0bc9b3c5a6e7fa3461e8d77b4f8c7575b566c4f525bd71bf6e05fc4e993a7dd08bc6fc49e9c52afed900d4f45bf2f83
+  data.tar.gz: bebdc47d1101a98e7c49bab39c18e973b3f88818860ab37deabb5f0c54beba04c5322167c680504b68c1551390022f5d853f8eb7395895a8c0073a9493c4f045

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 DmitryTsepelev
+
+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,181 @@
+# Disclaimer
+
+**This gem hasn't been released yet! I'm going to force push a lot, be careful**
+
+[![Gem Version](https://badge.fury.io/rb/store_model.svg)](https://rubygems.org/gems/store_model)
+[![Build Status](https://travis-ci.org/DmitryTsepelev/store_model.svg?branch=master)](https://travis-ci.org/DmitryTsepelev/store_model)
+[![Coverage Status](https://coveralls.io/repos/github/DmitryTsepelev/store_model/badge.svg?branch=master)](https://coveralls.io/github/DmitryTsepelev/store_model?branch=master)
+
+# StoreModel
+
+<a href="https://evilmartians.com/?utm_source=store_model">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+StoreModel allows to work with JSON-backed database columns in a similar way we work with ActiveRecord models. Supports Ruby >= 2.3 and Rails >= 5.2.
+
+For instance, imagine that you have a model `Product` with a `jsonb` column called `configuration`. Your usual workflow probably looks like:
+
+```ruby
+product = Product.find(params[:id])
+if product.configuration["model"] = "spaceship"
+  product.configuration["color"] = "red"
+end
+product.save
+```
+
+This approach works fine when you don't have a lot of keys with logic around them and just read the data. However, when you start working with that data more intensively (for instance, adding some validations around it) - you may find the code a bit verbose and error-prone. With this gem, the snipped above could be rewritten this way:
+
+```ruby
+product = Product.find(params[:id])
+if product.configuration.model = "spaceship"
+  product.configuration.color = "red"
+end
+product.save
+```
+
+> **Note**: if you want to work with JSON fields as an attributes, defined on the ActiveRecord model (not in the separate class) - consider using [store_attribute](https://github.com/palkan/store_attribute) or [jsonb_accessor](https://github.com/devmynd/jsonb_accessor).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'store_model'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install store_model
+```
+
+## How to register stored model
+
+Start with creating a class for representing the hash as an object:
+
+```ruby
+class Configuration
+  include StoreModel::Model
+
+  attribute :model, :string
+  attribute :color, :string
+end
+```
+
+Attributes shoould be defined using [Rails Attributes API](https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html). There is a number of types available out of the box, and you can always extend the type system with your own ones.
+
+Register the field in the ActiveRecord model class:
+
+```ruby
+class Product < ApplicationRecord
+  attribute :configuration, Configuration.to_type
+end
+```
+
+## Validations
+
+`StoreModel` supports all the validations shipped with `ActiveModel`. Start with defining validation for the store model:
+
+```ruby
+class Configuration
+  include StoreModel::Model
+
+  attribute :model, :string
+  attribute :color, :string
+
+  validates :color, presence: true
+end
+```
+
+Then, configure your ActiveRecord model to validates this field as a store model:
+
+```ruby
+class Product < ApplicationRecord
+  attribute :configuration, Configuration.to_type
+
+  validates :configuration, store_model: true
+end
+```
+
+When attribute is invalid, errors are not copied to the parent model by default:
+
+```ruby
+product = Product.new
+puts product.valid? # => false
+puts product.errors.messages # => { configuration: ["is invalid"] }
+puts product.configuration.errors.messages # => { color: ["can't be blank"] }
+```
+
+You can change this behavior to have these errors on the root level (instead of `["is invalid"]`):
+
+```ruby
+class Product < ApplicationRecord
+  attribute :configuration, Configuration.to_type
+
+  validates :configuration, store_model: { merge_errors: true }
+end
+```
+
+In this case errors look this way:
+
+```ruby
+product = Product.new
+puts product.valid? # => false
+puts product.errors.messages # => { color: ["can't be blank"] }
+```
+
+You can change the global behavior using `StoreModel.config`:
+
+```ruby
+StoreModel.config.merge_errors = true
+```
+
+You can also add your own custom strategies to handle errors. All you need to do is to provide a callable object to `StoreModel.config.merge_errors` or as value of `:merge_errors`. It should accept three arguments - _attribute_, _base_errors_ and _store_model_errors_:
+
+```ruby
+StoreModel.config.merge_errors = lambda do |attribute, base_errors, _store_model_errors| do
+  base_errors.add(attribute, "cthulhu fhtagn")
+end
+```
+
+If the logic is complex enough - it worth defining a separate class with a `#call` method:
+
+```ruby
+class FhtagnErrorStrategy
+  def call(attribute, base_errors, _store_model_errors)
+    base_errors.add(attribute, "cthulhu fhtagn")
+  end
+end
+```
+
+You can provide its instance or snake-cased name when configuring global `merge_errors`:
+
+```ruby
+StoreModel.config.merge_errors = :fhtagn_error_strategy
+
+class Product < ApplicationRecord
+  attribute :configuration, Configuration.to_type
+
+  validates :configuration, store_model: { merge_errors: :fhtagn_error_strategy }
+end
+```
+
+or when calling `validates` method on a class level:
+
+```ruby
+StoreModel.config.merge_errors = FhtagnErrorStrategy.new
+
+class Product < ApplicationRecord
+  attribute :configuration, Configuration.to_type
+
+  validates :configuration, store_model: { merge_errors: FhtagnErrorStrategy.new }
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/lib/active_model/validations/store_model_validator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "store_model/combine_errors_strategies"
+
+module ActiveModel
+  module Validations
+    class StoreModelValidator < ActiveModel::Validator
+      def validate(record)
+        options[:attributes].each do |attribute|
+          attribute_value = record.send(attribute)
+          combine_errors(record, attribute) unless attribute_value.validate
+        end
+      end
+
+      private
+
+      def combine_errors(record, attribute)
+        base_errors = record.errors
+        store_model_errors = record.send(attribute).errors
+
+        base_errors.delete(attribute)
+
+        strategy = StoreModel::CombileErrorsStrategies.configure(options)
+        strategy.call(attribute, base_errors, store_model_errors)
+      end
+    end
+  end
+end

data/lib/store_model.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "store_model/model"
+require "store_model/configuration"
+require "active_model/validations/store_model_validator"
+
+module StoreModel
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/store_model/combine_errors_strategies.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "store_model/combine_errors_strategies/mark_invalid_error_strategy"
+require "store_model/combine_errors_strategies/merge_error_strategy"
+
+module StoreModel
+  module CombileErrorsStrategies
+    module_function
+
+    # Finds a strategy based on options and global config
+    def configure(options)
+      configured_strategy = options[:merge_errors] || StoreModel.config.merge_errors
+
+      if configured_strategy.respond_to?(:call)
+        configured_strategy
+      elsif configured_strategy == true
+        StoreModel::CombileErrorsStrategies::MergeErrorStrategy.new
+      elsif configured_strategy.nil?
+        StoreModel::CombileErrorsStrategies::MarkInvalidErrorStrategy.new
+      else
+        const_get(configured_strategy.to_s.camelize).new
+      end
+    end
+  end
+end

data/lib/store_model/combine_errors_strategies/mark_invalid_error_strategy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module StoreModel
+  module CombileErrorsStrategies
+    class MarkInvalidErrorStrategy
+      def call(attribute, base_errors, _store_model_errors)
+        base_errors.add(attribute, I18n.translate("invalid", scope: "errors.messages"))
+      end
+    end
+  end
+end

data/lib/store_model/combine_errors_strategies/merge_error_strategy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module StoreModel
+  module CombileErrorsStrategies
+    class MergeErrorStrategy
+      def call(_attribute, base_errors, store_model_errors)
+        base_errors.copy!(store_model_errors)
+      end
+    end
+  end
+end

data/lib/store_model/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module StoreModel
+  # StoreModel configuration:
+  #
+  # - `merge_errors` - set up to `true` to merge errors or specify your
+  #                    own strategy
+  #
+  class Configuration
+    attr_accessor :merge_errors
+  end
+end

data/lib/store_model/json_model_type.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+module StoreModel
+  class JsonModelType < ActiveModel::Type::Value
+    def initialize(model_klass)
+      @model_klass = model_klass
+    end
+
+    def type
+      :json
+    end
+
+    # rubocop:disable Style/RescueModifier
+    def cast_value(value)
+      case value
+      when String
+        decoded = ActiveSupport::JSON.decode(value) rescue nil
+        @model_klass.new(decoded) unless decoded.nil?
+      when Hash
+        @model_klass.new(value)
+      when @model_klass
+        value
+      end
+    end
+    # rubocop:enable Style/RescueModifier
+
+    def serialize(value)
+      case value
+      when Hash, @model_klass
+        ActiveSupport::JSON.encode(value)
+      else
+        super
+      end
+    end
+
+    def changed_in_place?(raw_old_value, new_value)
+      cast_value(raw_old_value) != new_value
+    end
+  end
+end

data/lib/store_model/model.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "store_model/json_model_type"
+
+module StoreModel
+  module Model
+    def self.included(base)
+      base.include ActiveModel::Model
+      base.include ActiveModel::Attributes
+
+      base.extend(Module.new do
+        def to_type
+          JsonModelType.new(self)
+        end
+      end)
+    end
+
+    def as_json(options = {})
+      attributes.with_indifferent_access.as_json(options)
+    end
+
+    def ==(other)
+      return super unless other.is_a?(self.class)
+
+      attributes.all? { |name, value| value == other.send(name) }
+    end
+
+    # Allows to call :presence validation on the association itself
+    def blank?
+      attributes.values.all?(&:blank?)
+    end
+
+    def inspect
+      attribute_string = attributes.map { |name, value| "#{name}: #{value || 'nil'}" }.join(", ")
+      "#<#{self.class.name} #{attribute_string}>"
+    end
+  end
+end

data/lib/store_model/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StoreModel
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: store_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DmitryTsepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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: rspec-rails
+  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: rubocop
+  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: coveralls
+  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: Gem for working with JSON-backed attributes as ActiveRecord models
+email:
+- dmitry.a.tsepelev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_model/validations/store_model_validator.rb
+- lib/store_model.rb
+- lib/store_model/combine_errors_strategies.rb
+- lib/store_model/combine_errors_strategies/mark_invalid_error_strategy.rb
+- lib/store_model/combine_errors_strategies/merge_error_strategy.rb
+- lib/store_model/configuration.rb
+- lib/store_model/json_model_type.rb
+- lib/store_model/model.rb
+- lib/store_model/version.rb
+homepage: https://github.com/DmitryTsepelev/store_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: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Gem for working with JSON-backed attributes as ActiveRecord models
+test_files: []