granite-form 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb26aa530c266a54d01fe3723d4ee44a95bedbefb140a5358403ebcdf78ced5c
-  data.tar.gz: 1c63d7e31c87a934a6c858c24c396f0547e16268997dcd2c2e8dbeac16ba98d5
+  metadata.gz: df27378689a1bdcdc95593c32c65046ecaab452cc3303839979ace6f1a12ef0f
+  data.tar.gz: 41b0ee8c8b22f1cf992e7b46c91528b4596ad6b362930c5299b6fde58a9bd2b8
 SHA512:
-  metadata.gz: 2b28feea4881f8c4f6635f1e626345b4ea534306b8596deb8a61f2a38ce428950eb957bd9b1c936699fbe049a22e1c41d36dce4ebd695c769b3fee39c3ecf716
-  data.tar.gz: e0fdbd61872e007edaf0cf4ffed388b382f14e53e2637a04979eae1f4e2f1b67aa0bad71569b9ab4b2ce8cd2363820e380661f402edec70584c480962aa7c0e1
+  metadata.gz: aef5479a5c58afc85c8e68635fbd8382039c69b8235beaeda74d5caf320540c2fd8aac330f70f4c031abfd37d6a214c3acab0086c9c0a1d3843aedd7aab5a1db
+  data.tar.gz: 5fcc7f498c8685167096ec9d835c6cc80efec7915b17c32aa27f8e912776d2ef25e215ed24c076e7c8e4cb32790eba060d8a7aac827ff1c2cd8d93819b7ae7e2

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+.github/workflows/ci.yml @toptal/coresmiths-team
+.github/workflows/main.yml @toptal/coresmiths-team

data/CHANGELOG.md

@@ -1,73 +1,9 @@
 # master
 
-# Version 1.2.0
+## v0.1.1
 
-* Rails 6.1 and 7 support (#80). Thanks to @ojab and @rewritten
+- Fixed represented error message copying when represented model uses symbols for `message`. 
 
-# Version 1.1.7
+## v0.1.0
 
-* Add typecasting from `ActionController::Parameters` to `Hash` (#73)
-
-# Version 1.1.6
-
-* Fix Ruby 2.6 deprecations (#72)
-
-# Version 1.1.5
-
-* Rails 6 support (#70, #71)
-
-# Version 1.1.4
-
-## Changes
-
-* `came_from_default?` attribute method (#66)
-
-# Version 1.1.3
-
-## Changes
-
-* `came_from_user?` attribute method (#65)
-
-# Version 1.1.2
-
-## Changes
-
-* `ActiveData.base_concern` config option in addition to `ActiveData.base_class` (#64)
-
-# Version 1.1.1
-
-## Changes
-
-* `ActiveData.base_class` config option (#63)
-
-* ActiveModel 5.2 compatibility (#62)
-
-# Version 1.1.0
-
-## Incompatible changes
-
-* Represented attributes are not provided by default, to add them, `include ActiveData::Model::Representation` (#46)
-
-* `include ActiveData::Model::Associations::Validations` is not included by default anymore, to get `validate_ancestry!`, `valid_ancestry?` and `invalid_ancestry?` methods back you need to include this module manually
-
-## Changes
-
-* Introduce persistence adapters for associations (#24, #51)
-
-* `ActionController::Parameters` support (#43)
-
-* Nested attributes simple method overriding (#41)
-
-* Persistence for `references` associations (#28, #32)
-
-* Support `update_only` option on collection nested attributes (#30)
-
-* `embedder` accessor for embedded associations
-
-* Dynamic scopes for `references` associations (#27)
-
-## Bugfixes
-
-* Fixed multiple validations on represented attributes and associations (#44)
-
-* Proper boolean attributes defaults (#31, #33)
+- Forked from ActiveData, see https://github.com/pyromaniac/active_data/blob/v1.2.0/CHANGELOG.md for changes before this

data/README.md

@@ -3,7 +3,7 @@
 
 # Granite::Form
 
-Granite::Form is a ActiveModel-based front-end for your data. You might need to use it in the following cases:
+`Granite::Form` is an `ActiveModel`-based front-end for your data. It is useful in the following cases:
 
 * When you need a form objects pattern.
 
@@ -43,7 +43,7 @@ class ProfileController < ApplicationController
 end
 ```
 
-* When you need to work with data-storage in ActiveRecord style with
+* When you need to work with data storage à la `ActiveRecord`.
 
 ```ruby
 class Flight
@@ -75,7 +75,7 @@ class Flight
 end
 ```
 
-* When you need to implement embedded objects for ActiveRecord models
+* When you need to embed objects in `ActiveRecord` models.
 
 ```ruby
 class Answer
@@ -94,25 +94,25 @@ class Quiz < ActiveRecord::Base
   validates :answers, associated: true
 end
 
-q = Quiz.new
-q.answers.build(question_id: 42, content: 'blabla')
-q.save
+quiz = Quiz.new
+quiz.answers.build(question_id: 42, content: 'blabla')
+quiz.save
 ```
 
 ## Why?
 
-Granite::Form is an ActiveModel-based library that provides the following abilities:
+`Granite::Form` is an `ActiveModel-based library that provides the following functionalities:
 
   * Standard form objects building toolkit: attributes with typecasting, validations, etc.
   * High-level universal ORM/ODM library using any data source (DB, http, redis, text files).
-  * Embedding objects into your ActiveRecord entities. Quite useful with PG JSON capabilities.
+  * Embedding objects into ActiveRecord entities. Quite useful with PG JSON capabilities.
 
 Key features:
 
-  * Complete objects lifecycle support: saving, updating, destroying.
+  * Complete object lifecycle support: saving, updating, destroying.
   * Embedded and referenced associations.
-  * Backend-agnostic named scopes functionality.
-  * Callbacks, validations and dirty attributes inside.
+  * Backend-agnostic named scopes.
+  * Callbacks, validations and dirty attributes.
 
 ## Installation
 
@@ -130,11 +130,11 @@ Or install it yourself as:
 
 ## Usage
 
-Granite::Form has modular architecture, so it is required to include modules to obtain additional features. By default Granite::Form supports attributes definition and validations.
+`Granite::Form` has modular architecture, so it is required to include modules to obtain additional features. By default `Granite::Form` supports attributes definition and validations.
 
 ### Attributes
 
-Granite::Form provides several types of attributes and typecasts each attribute to its defined type upon initialization.
+`Granite::Form` provides several types of attributes and typecasts each attribute to its defined type upon initialization.
 
 ```ruby
 class Book
@@ -151,16 +151,16 @@ end
 attribute :full_name, String, default: 'John Talbot'
 ```
 
-By default, if type for attribute is not set, it is defined with `Object` type, so it would be a great idea to specify type for every attribute explicitly.
+If type for an attribute is not set, it defaults to `Object`. It is therefore recommended to specify the type for every attribute explicitly.
 
-Type is necessary for attribute typecasting. Here is the list of pre-defined basic typecasters:
+The type is necessary for attribute typecasting. Here is the list of pre-defined basic typecasters:
 
 ```irb
 [1] pry(main)> Granite::Form._typecasters.keys
 => ["Object", "String", "Array", "Hash", "Date", "DateTime", "Time", "ActiveSupport::TimeZone", "BigDecimal", "Float", "Integer", "Boolean", "Granite::Form::UUID"]
 ```
 
-In addition, you can provide any class type when defining the attribute, but in that case you will be able to only assign instances of that specific class or value nil:
+In addition, you can provide any class type when defining an attribute, but in that case you will be able to only assign instances of that specific class or `nil`:
 
 ```ruby
 attribute :template, MyCustomTemplateType
@@ -168,7 +168,7 @@ attribute :template, MyCustomTemplateType
 
 ##### Defaults
 
-It is possible to provide default values for attributes and they will act in the same way as AR or Mongoid default values:
+It is possible to provide default values for attributes and they will act in the same way as `ActiveRecord` or `Mongoid` default values:
 
 ```ruby
 attribute :check, Boolean, default: false # Simply false by default
@@ -179,7 +179,7 @@ attribute :today_wday, Integer, default: ->(instance) { instance.today.wday } #
 
 ##### Enums
 
-Enums restrict the scope of possible values for attribute. If assigned value is not included in provided list - then it turns to nil:
+Enums restrict the scope of possible values for an attribute. If the assigned value is not included in the provided list, the attribute value is set to `nil`:
 
 ```ruby
 attribute :direction, String, enum: %w[north south east west]
@@ -187,7 +187,7 @@ attribute :direction, String, enum: %w[north south east west]
 
 ##### Normalizers
 
-Normalizers are applied last, modifying typecast value. It is possible to provide a list of normalizers, they will be applied in the order. It is possible to pre-define normalizers to DRY code:
+Normalizers are applied last, modifying a typecast value. It is possible to provide a list of normalizers. They will be applied in the provided order. It is possible to pre-define normalizers to DRY code:
 
 ```ruby
 Granite::Form.normalizer(:trim) do |value, options, _attribute|
@@ -201,13 +201,13 @@ attribute :title, String, normalizers: [->(value) { value.strip }, trim: {length
 
 ```ruby
 attribute :name, String, readonly: true # Readonly forever
-attribute :name, String, readonly: ->{ true } # Conditionally readonly
+attribute :name, String, readonly: -> { true } # Conditionally readonly
 attribute :name, String, readonly: ->(instance) { instance.subject.present? } # Explicit instance
 ```
 
 #### Collection
 
-Collection is simply an array of equally-typed values:
+A collection is simply an array of equally-typed values:
 
 ```ruby
 class Panda
@@ -217,7 +217,7 @@ class Panda
 end
 ```
 
-Collection typecasts each value to specified type and also no matter what are you going to pass - it will be an array.
+A collection typecasts each value to the specified type. Also, it normalizes any given value to an array.
 
 ```irb
 [1] pry(main)> Panda.new
@@ -228,11 +228,11 @@ Collection typecasts each value to specified type and also no matter what are yo
 => #<Panda ids: [42, 33]>
 ```
 
-Default and enum modifiers are applied to every value, normalizer will be applied to the whole array.
+Default and enum modifiers are applied on each value, normalizers are applied on the array.
 
 #### Dictionary
 
-Dictionary field is a hash of specified type values with string keys:
+A dictionary field is a hash of specified type values with string keys:
 
 ```ruby
 class Foo
@@ -249,11 +249,11 @@ end
 => #<Foo ordering: {"name"=>"desc"}>
 ```
 
-Keys list might be restricted with `:keys` option, defaults and enums are applied to every value, normalizers are applied to the whole hash.
+The keys list might be restricted with the `:keys` option. Default and enum modifiers are applied on each value, normalizers are applied on the hash.
 
 #### Localized
 
-Localized is similar to how Globalize 3 attributes work.
+`localized` is similar to how `Globalize 3` attributes work.
 
 ```ruby
 localized :title, String
@@ -261,11 +261,11 @@ localized :title, String
 
 #### Represents
 
-Represents provides an easy way to expose model attributes through an interface.
-It will automatically set passed value to the represented object **before validation**.
-You can use any ActiveRecord, ActiveModel or Granite::Form object as a target of representation.
-A type of an attribute will be taken from it.
-If there is no type, it will be `Object` by default. You can set the type explicitly by passing the `type: TypeClass` option.
+`represents` provides an easy way to expose model attributes through an interface.
+It will automatically set the passed value to the represented object **before validation**.
+You can use any `ActiveRecord`, `ActiveModel` or `Granite::Form` object as a target of representation.
+The type of an attribute will be taken from it.
+If no type is defined, it will be `Object` by default. You can set the type explicitly by passing the `type: TypeClass` option.
 Represents will also add automatic validation of the target object.
 
 ```ruby
@@ -295,7 +295,7 @@ person.name
 
 ### Associations
 
-Granite::Form provides a set of associations. There are two types of them: referenced and embedded. The closest example of referenced association is AR `belongs_to` and as for embedded ones - Mongoid's embedded. Also these associations support `accepts_nested_attributes` call.
+`Granite::Form` provides a set of associations. There are two types: referenced and embedded. The closest example of referenced association is `AcitveRecord`'s `belongs_to`. For embedded ones - Mongoid's embedded. Also these associations support `accepts_nested_attributes` calls.
 
 #### EmbedsOne
 
@@ -312,11 +312,11 @@ embeds_one :profile do
 end
 ```
 
-Possible options:
+Оptions:
 
 * `:class_name` - association class name
-* `:validate` - true or false
-* `:default` - default value for association: attributes hash or instance of defined class
+* `:validate` - `true` or `false`
+* `:default` - default value for the association: an attributes hash or an instance of the defined class
 
 #### EmbedsMany
 
@@ -324,7 +324,7 @@ Possible options:
 embeds_many :tags
 ```
 
-Defines collection of embedded objects. Might be defined inline:
+Defines a collection of embedded objects. Might be defined inline:
 
 ```ruby
 embeds_many :tags do
@@ -332,9 +332,11 @@ embeds_many :tags do
 end
 ```
 
+Оptions:
+
 * `:class_name` - association class name
-* `:validate` - true or false
-* `:default` - default value for association: attributes hash collection or instances of defined class
+* `:validate` -  `true` or `false`
+* `:default` - default value for the association: an attributes hash or an instance of the defined class
 
 #### ReferencesOne
 
@@ -342,22 +344,22 @@ end
 references_one :user
 ```
 
-This will provide several methods to the object: `#user`, `#user=`, `#user_id` and `#user_id=`, just as would occur with an ActiveRecord association.
+Provides several methods to the object: `#user`, `#user=`, `#user_id` and `#user_id=`, similarly to an ActiveRecord association.
 
-Possible options:
+Оptions:
 
 * `:class_name` - association class name
-* `:primary_key` - associated object primary key (`:id` by default):
+* `:primary_key` - the associated object's primary key name (`:id` by default):
 
   ```ruby
   references_one :user, primary_key: :name
   ```
 
-  This will create the following methods: `#user`, `#user=`, `#user_name` and `#user_name=`
+  Creates the following methods: `#user`, `#user=`, `#user_name` and `#user_name=`.
 
 * `:reference_key` - redefines `#user_id` and `#user_id=` method names completely.
-* `:validate` - true or false
-* `:default` - default value for association: reference or object itself
+* `:validate` - `true` or `false`
+* `:default` - default value for the association: reference or the object itself
 
 #### ReferencesMany
 
@@ -365,18 +367,18 @@ Possible options:
 references_many :users
 ```
 
-This will provide several methods to the object: `#users`, `#users=`, `#user_ids` and `#user_ids=` just as an ActiveRecord relation does.
+Provides several methods to the object: `#users`, `#users=`, `#user_ids` and `#user_ids=`, similarly to an ActiveRecord association.
 
-Possible options:
+Options:
 
 * `:class_name` - association class name
-* `:primary_key` - associated object primary key (`:id` by default):
+* `:primary_key` - the associated object's primary key name (`:id` by default):
 
   ```ruby
   references_many :users, primary_key: :name
   ```
 
-  This will create the following methods: `#users`, `#users=`, `#user_names` and `#user_names=`
+  Creates the following methods: `#users`, `#users=`, `#user_names` and `#user_names=`.
 
 * `:reference_key` - redefines `#user_ids` and `#user_ids=` method names completely.
 * `:validate` - true or false
@@ -396,15 +398,15 @@ class Mongoid::Document
   end
 end
 ```
-Where
+where
 `ClassName` - name of model class or one of ancestors
 `data_source` - name of data source class
 `primary_key` - key to search data
 `scope_proc` - additional proc for filtering
 
-All required interface for adapters described in `Granite::Form::Model::Associations::PersistenceAdapters::Base`.
+All requirements for the adapter interfaces are described in `Granite::Form::Model::Associations::PersistenceAdapters::Base`.
 
-Adapter for ActiveRecord is `Granite::Form::Model::Associations::PersistenceAdapters::ActiveRecord`. So, all AR models will use `PersistenceAdapters::ActiveRecord` by default.
+The adapter for `ActiveRecord` is `Granite::Form::Model::Associations::PersistenceAdapters::ActiveRecord`. All `ActiveRecord` models use `PersistenceAdapters::ActiveRecord` by default.
 
 ### Primary
 

data/lib/granite/form/model/representation.rb

@@ -79,7 +79,7 @@ module Granite
             errors.where(from).each do |error|
               options = error.options
               # If we generate message for built-in validation, we don't want to later escape it in our monkey-patch
-              options = options.merge(message: error.message.html_safe) unless options.key?(:message)
+              options = options.merge(message: error.message.html_safe)
 
               errors.add(to, error.type, **options)
             end

data/lib/granite/form/version.rb

@@ -1,5 +1,5 @@
 module Granite
   module Form
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

data/spec/lib/granite/form/model/representation_spec.rb

@@ -126,13 +126,25 @@ describe Granite::Form::Model::Representation do
 
     specify do
       expect { post.validate }.to change { post.errors.messages }
-        .to(hash_including('author.user.email': ['is invalid'], name: ["can't be blank"]))
+        .to('author.user.email': ['is invalid'], name: ["can't be blank"])
     end
 
     if ActiveModel.version >= Gem::Version.new('6.1.0')
       specify do
         expect { post.validate }.to change { post.errors.details }
-          .to(hash_including('author.user.email': [{error: 'is invalid'}], name: [{error: :blank}]))
+          .to('author.user.email': [{error: 'is invalid'}], name: [{error: :blank}])
+      end
+    end
+
+    context 'when using symbol in error message of represented model' do
+      before do
+        Author.validates :name, inclusion: {in: ['Author'], message: :invalid_name, allow_blank: true}
+        post.author.name = 'Not Author'
+      end
+
+      specify do
+        expect { post.validate }.to change { post.errors.messages }
+          .to('author.user.email': ['is invalid'], name: ['must be Author'])
       end
     end
   end

data/spec/spec_helper.rb

@@ -8,8 +8,7 @@ require 'rack/test'
 require 'action_controller/metal/strong_parameters'
 require 'database_cleaner'
 
-require 'support/model_helpers'
-require 'support/muffle_helper'
+Dir[File.join(__dir__, 'support', '**', '*.rb')].sort.each { |f| require f }
 
 ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
 ActiveRecord::Base.logger = Logger.new('/dev/null')

data/spec/support/translations.rb

@@ -0,0 +1,6 @@
+I18n.backend.store_translations(:en, YAML.safe_load(<<-YAML))
+  activerecord:
+    errors:
+      messages:
+        invalid_name: "must be Author"
+YAML

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite-form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - pyromaniac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -200,6 +200,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/CODEOWNERS"
 - ".github/workflows/ci.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
@@ -331,6 +332,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/model_helpers.rb
 - spec/support/muffle_helper.rb
+- spec/support/translations.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -401,3 +403,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/model_helpers.rb
 - spec/support/muffle_helper.rb
+- spec/support/translations.rb