store_model 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e08694a9eb910d42bd5c9a1f6f2b23746494aad264315e8b7c1de863148fb72
-  data.tar.gz: e5fd75336b9c22c9b75a5de967e2019e54bef594ff7d526fa56dc0ccdac9237e
+  metadata.gz: ddf27da9ed2536f94b6363448b5198695e8c15113b94e4e160a10980a8709532
+  data.tar.gz: f508d45e6a30c2634a89fdbd8204643aa597f1c879958314bb0c83b4fe3fd27f
 SHA512:
-  metadata.gz: b229005093bd41076d547b093880954c060623ce2906b782e7e675ae5416b7f27b5876172d16d137d4be33a521449a196f30f170b946df174e4b0732ebad16a1
-  data.tar.gz: 5add920a20c6b2f56121fe360c70f878de2ea194f7a0e5347168a5d9e4f72a7eed660d4966b8b4b0476c57fe90e99425da9b219abc59f7b487a91b21679bbddf
+  metadata.gz: fccc4d5dee04b782758ada583a9a840b585805786869912a1d82e50a8df5dcfb682afc97b1dffe45961640a095395f1da4f3b27c0e94afeddc59de5a218c658e
+  data.tar.gz: ad0e9c6f11accc117b45a9647d525ad9a19acc47704d22261129e46ec648461b77585e3d4ff828ad3a00b46bf3b6968789af97a2ac8e1789d8c965c9da034c98

data/README.md

@@ -89,6 +89,7 @@ product.save
   * [Unknown attributes](./docs/unknown_attributes.md)
 3. [Array of stored models](./docs/array_of_stored_models.md)
 4. [Alternatives](./docs/alternatives.md)
+5. [Defining custom types](./docs/defining_custom_types.md)
 
 ## License
 

data/lib/active_model/validations/store_model_validator.rb

@@ -5,7 +5,15 @@ require "store_model/combine_errors_strategies"
 
 module ActiveModel
   module Validations
+    # +StoreModelValidator+ is a subclass of ActiveModel::EachValidator for
+    # checking StoreModel::Model attributes.
     class StoreModelValidator < ActiveModel::EachValidator
+      # Validates _json_ attribute using the configured strategy or
+      # invalidates _array_ attribute when at least one element is invalid.
+      #
+      # @param record [ApplicationRecord] object to validate
+      # @param attribute [String] name of the validated attribute
+      # @param value [Object] value of the validated attribute
       def validate_each(record, attribute, value)
         if value.nil?
           record.errors.add(attribute, :blank)

data/lib/store_model.rb

@@ -4,7 +4,7 @@ require "store_model/model"
 require "store_model/configuration"
 require "active_model/validations/store_model_validator"
 
-module StoreModel
+module StoreModel # :nodoc:
   class << self
     def config
       @config ||= Configuration.new

data/lib/store_model/combine_errors_strategies.rb

@@ -4,10 +4,15 @@ require "store_model/combine_errors_strategies/mark_invalid_error_strategy"
 require "store_model/combine_errors_strategies/merge_error_strategy"
 
 module StoreModel
+  # Module with built-in strategies for combining errors.
   module CombineErrorsStrategies
     module_function
 
-    # Finds a strategy based on options and global config
+    # Finds a strategy based on +options+ and global config.
+    #
+    # @param options [Hash]
+    #
+    # @return [Object] strategy
     def configure(options)
       configured_strategy = options[:merge_errors] || StoreModel.config.merge_errors
 

data/lib/store_model/combine_errors_strategies/mark_invalid_error_strategy.rb

@@ -2,7 +2,14 @@
 
 module StoreModel
   module CombineErrorsStrategies
+    # +MarkInvalidErrorStrategy+ marks attribute invalid in the parent record.
     class MarkInvalidErrorStrategy
+      # Invalidates +attribute+ in the parent record.
+      #
+      # @param attribute [String] name of the validated attribute
+      # @param base_errors [ActiveModel::Errors] errors object of the parent record
+      # @param _store_model_errors [ActiveModel::Errors] errors object of the
+      # StoreModel::Model attribute
       def call(attribute, base_errors, _store_model_errors)
         base_errors.add(attribute, :invalid)
       end

data/lib/store_model/combine_errors_strategies/merge_error_strategy.rb

@@ -2,7 +2,15 @@
 
 module StoreModel
   module CombineErrorsStrategies
+    # +MergeErrorStrategy+ copies errors from the StoreModel::Model to the parent
+    # record (for Rails < 6.1) or marks the attribute invalid (for Rails >= 6.1).
     class MergeErrorStrategy
+      # Merges errors on +attribute+ from the child model with parent errors.
+      #
+      # @param _attribute [String] name of the validated attribute
+      # @param base_errors [ActiveModel::Errors] errors object of the parent record
+      # @param store_model_errors [ActiveModel::Errors] errors object of the StoreModel::Model
+      # attribute
       def call(_attribute, base_errors, store_model_errors)
         if Rails::VERSION::MAJOR < 6 || Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR.zero?
           base_errors.copy!(store_model_errors)

data/lib/store_model/configuration.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
 module StoreModel
-  # StoreModel configuration:
-  #
-  # - `merge_errors` - set up to `true` to merge errors or specify your
-  #                    own strategy
-  #
+  # StoreModel configuration.
   class Configuration
+    # Controls usage of MergeErrorStrategy
+    # @return [Boolean]
     attr_accessor :merge_errors
   end
 end

data/lib/store_model/enum.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
 module StoreModel
+  # Allows defining Rails-like enums
   module Enum
+    # Defines new enum
+    #
+    # @param name [String] name of the enum to define
+    # @param values [Object]
+    # @param kwargs [Object]
     def enum(name, values = nil, **kwargs)
       values ||= kwargs[:in] || kwargs
 

data/lib/store_model/model.rb

@@ -6,8 +6,9 @@ require "store_model/type_builders"
 require "store_model/nested_attributes"
 
 module StoreModel
+  # When included into class configures it to handle JSON column
   module Model
-    def self.included(base)
+    def self.included(base) # :nodoc:
       base.include ActiveModel::Model
       base.include ActiveModel::Attributes
       base.include StoreModel::NestedAttributes
@@ -16,21 +17,37 @@ module StoreModel
       base.extend StoreModel::TypeBuilders
     end
 
+    # Returns a hash representing the model. Some configuration can be
+    # passed through +options+.
+    #
+    # @param options [Hash]
+    #
+    # @return [Hash]
     def as_json(options = {})
       attributes.with_indifferent_access.as_json(options)
     end
 
+    # Compares two StoreModel::Model instances
+    #
+    # @param other [StoreModel::Model]
+    #
+    # @return [Boolean]
     def ==(other)
       return super unless other.is_a?(self.class)
 
-      attributes.all? { |name, value| value == other.send(name) }
+      attributes.all? { |name, value| value == other.attributes[name] }
     end
 
-    # Allows to call :presence validation on the association itself
+    # Allows to call :presence validation on the association itself.
+    #
+    # @return [Boolean]
     def blank?
       attributes.values.all?(&:blank?)
     end
 
+    # String representation of the object.
+    #
+    # @return [String]
     def inspect
       attribute_string = attributes.map { |name, value| "#{name}: #{value || 'nil'}" }.join(", ")
       "#<#{self.class.name} #{attribute_string}>"
@@ -38,17 +55,31 @@ module StoreModel
 
     delegate :attribute_types, to: :class
 
+    # Returns the type of the attribute with the given name
+    #
+    # @param attr_name [String] name of the attribute
+    #
+    # @return [ActiveModel::Type::Value]
     def type_for_attribute(attr_name)
       attr_name = attr_name.to_s
       attribute_types[attr_name]
     end
 
+    # Checks if the attribute with a given name is defined
+    #
+    # @param attr_name [String] name of the attribute
+    #
+    # @return [Boolean]
     # rubocop:disable Naming/PredicateName
     def has_attribute?(attr_name)
       attribute_types.key?(attr_name.to_s)
     end
     # rubocop:enable Naming/PredicateName
 
+    # Contains a hash of attributes which are not defined but exist in the
+    # underlying JSON data
+    #
+    # @return [Hash]
     def unknown_attributes
       @unknown_attributes ||= {}
     end

data/lib/store_model/nested_attributes.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 module StoreModel
+  # Contains methods for working with nested StoreModel::Model attributes.
   module NestedAttributes
-    def self.included(base)
+    def self.included(base) # :nodoc:
       base.extend ClassMethods
     end
 
-    module ClassMethods
+    module ClassMethods # :nodoc:
+      # Enables handling of nested StoreModel::Model attributes
+      #
+      # @param associations [Array] list of associations to define attributes
       def accepts_nested_attributes_for(*associations)
         associations.each do |association|
           case attribute_types[association.to_s]

data/lib/store_model/type_builders.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
 module StoreModel
+  # Contains methods for converting StoreModel::Model to ActiveModel::Type::Value.
   module TypeBuilders
+    # Converts StoreModel::Model to Types::JsonType
+    # @return [Types::JsonType]
     def to_type
       Types::JsonType.new(self)
     end
 
+    # Converts StoreModel::Model to Types::ArrayType
+    # @return [Types::ArrayType]
     def to_array_type
       Types::ArrayType.new(self)
     end

data/lib/store_model/types.rb

@@ -5,6 +5,7 @@ require "store_model/types/array_type"
 require "store_model/types/enum_type"
 
 module StoreModel
+  # Contains all custom types.
   module Types
     class CastError < StandardError; end
   end

data/lib/store_model/types/array_type.rb

@@ -4,15 +4,30 @@ require "active_model"
 
 module StoreModel
   module Types
+    # Implements ActiveModel::Type::Value type for handling an array of
+    # StoreModel::Model
     class ArrayType < ActiveModel::Type::Value
+      # Initializes type for model class
+      #
+      # @param model_klass [StoreModel::Model] model class to handle
+      #
+      # @return [StoreModel::Types::ArrayType]
       def initialize(model_klass)
         @model_klass = model_klass
       end
 
+      # Returns type
+      #
+      # @return [Symbol]
       def type
         :array
       end
 
+      # Casts +value+ from DB or user to StoreModel::Model instance
+      #
+      # @param value [Object] a value to cast
+      #
+      # @return StoreModel::Model
       def cast_value(value)
         case value
         when String then decode_and_initialize(value)
@@ -24,6 +39,12 @@ module StoreModel
         end
       end
 
+      # Casts a value from the ruby type to a type that the database knows how
+      # to understand.
+      #
+      # @param value [Object] value to serialize
+      #
+      # @return [String] serialized value
       def serialize(value)
         case value
         when Array
@@ -33,6 +54,12 @@ module StoreModel
         end
       end
 
+      # Determines whether the mutable value has been modified since it was read
+      #
+      # @param raw_old_value [Object] old value
+      # @param new_value [Object] new value
+      #
+      # @return [Boolean]
       def changed_in_place?(raw_old_value, new_value)
         cast_value(raw_old_value) != new_value
       end

data/lib/store_model/types/enum_type.rb

@@ -4,15 +4,29 @@ require "active_model"
 
 module StoreModel
   module Types
+    # Implements ActiveModel::Type::Value type for handling Rails-like enums
     class EnumType < ActiveModel::Type::Value
+      # Initializes type for mapping
+      #
+      # @param mapping [Hash] mapping for enum values
+      #
+      # @return [StoreModel::Types::EnumType]
       def initialize(mapping)
         @mapping = mapping
       end
 
+      # Returns type
+      #
+      # @return [Symbol]
       def type
         :integer
       end
 
+      # Casts +value+ from DB or user to StoreModel::Model instance
+      #
+      # @param value [Object] a value to cast
+      #
+      # @return StoreModel::Model
       def cast_value(value)
         return if value.blank?
 

data/lib/store_model/types/json_type.rb

@@ -4,15 +4,29 @@ require "active_model"
 
 module StoreModel
   module Types
+    # Implements ActiveModel::Type::Value type for handling an instance of StoreModel::Model
     class JsonType < ActiveModel::Type::Value
+      # Initializes type for model class
+      #
+      # @param model_klass [StoreModel::Model] model class to handle
+      #
+      # @return [StoreModel::Types::JsonType]
       def initialize(model_klass)
         @model_klass = model_klass
       end
 
+      # Returns type
+      #
+      # @return [Symbol]
       def type
         :json
       end
 
+      # Casts +value+ from DB or user to StoreModel::Model instance
+      #
+      # @param value [Object] a value to cast
+      #
+      # @return StoreModel::Model
       def cast_value(value)
         case value
         when String then decode_and_initialize(value)
@@ -24,6 +38,12 @@ module StoreModel
         handle_unknown_attribute(value, e)
       end
 
+      # Casts a value from the ruby type to a type that the database knows how
+      # to understand.
+      #
+      # @param value [Object] value to serialize
+      #
+      # @return [String] serialized value
       def serialize(value)
         case value
         when Hash, @model_klass
@@ -33,6 +53,12 @@ module StoreModel
         end
       end
 
+      # Determines whether the mutable value has been modified since it was read
+      #
+      # @param raw_old_value [Object] old value
+      # @param new_value [Object] new value
+      #
+      # @return [Boolean]
       def changed_in_place?(raw_old_value, new_value)
         cast_value(raw_old_value) != new_value
       end

data/lib/store_model/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module StoreModel
-  VERSION = "0.5.1"
+module StoreModel # :nodoc:
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_model
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails