granite-form 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebac9979a786e2a3638b1dd7b21648320c779770c10f7fe63707b38a58c0164c
-  data.tar.gz: 604dcf0abda92863e1503b0d977a53ca1de7a39823bfc8a4aabab8d9c6a27045
+  metadata.gz: 908865a58fa79739294c85bb506d878596a28782c02a9a2825ca1fb7fd128972
+  data.tar.gz: ff9b6cbed34774e3dedb0b33c28b75694b1575051adb989248ca5695254e9586
 SHA512:
-  metadata.gz: cfc2c624834fe5d0ad4fadb903e6b9a38eed17778cea3c0cf9430437fb095436429c1a0941fd418e143805b064c1a74c0c959fb57493d96fb9602cdca625f36d
-  data.tar.gz: 4937e3d02a378edf48daa770799206b3ecdb91ee71ed1025169e6e3bf4a25bc157c01aea9db54dcb70645728eeb0055ca42be7db23258f0b7f2744d8f7415dd9
+  metadata.gz: 92d055b121d30a9644521227782908a0b84ef0847c16ce60fafec47cb17c5c2988e8a071e199ed5506dd0783bba335b6a399a519c095867658e310680dd96f10
+  data.tar.gz: 4b4cf5f23530ad12408f498df6eed11e53438dd0a6f110ae04c10568934f041dbb64b946ee42352b7bfec83119a5827b652c8fddd62e745fa0f2835448674ce6

data/.github/CODEOWNERS

@@ -1,2 +1 @@
-.github/workflows/ci.yml @toptal/coresmiths-team
-.github/workflows/main.yml @toptal/coresmiths-team
+* @toptal/portals-experience-be

data/.github/workflows/{ci.yml → ruby.yml}

@@ -1,21 +1,39 @@
-name: CI
-on: [push, pull_request]
+name: Ruby
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
 jobs:
   rspec:
     strategy:
       fail-fast: false
       matrix:
         include:
-          - { ruby: '2.3', rails: '4.2' }
           - { ruby: '2.4', rails: '5.0' }
           - { ruby: '2.5', rails: '5.1' }
           - { ruby: '2.6', rails: '5.2' }
           - { ruby: '2.7', rails: '6.0' }
           - { ruby: '3.0', rails: '6.1' }
-          - { ruby: '3.0', rails: '7.0' }
+          - { ruby: '3.1', rails: '7.0' }
     runs-on: ubuntu-latest
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails.${{ matrix.rails }}.gemfile
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: granite
+          POSTGRES_PASSWORD: granite
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps tcp port 5432 on service container to the host
+          - 5432:5432
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.2.10
+  TargetRubyVersion: 2.4.0
 
 Lint/AmbiguousBlockAssociation:
   Enabled: false

data/.rubocop_todo.yml

@@ -8,7 +8,7 @@
 
 # Offense count: 19
 Metrics/AbcSize:
-  Max: 55
+  Max: 59
 
 # Offense count: 2
 # Configuration parameters: CountComments.
@@ -17,7 +17,7 @@ Metrics/ClassLength:
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 15
 
 # Offense count: 904
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
@@ -41,7 +41,7 @@ Metrics/BlockLength:
 
 # Offense count: 4
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 18
 
 # Offense count: 75
 Style/Documentation:

data/Appraisals

@@ -1,8 +1,7 @@
-%w[4.2 5.0 5.1 5.2 6.0 6.1 7.0].each do |version|
+%w[5.0 5.1 5.2 6.0 6.1 7.0].each do |version|
   appraise "rails.#{version}" do
     gem 'activesupport', "~> #{version}.0"
     gem 'activemodel', "~> #{version}.0"
     gem 'activerecord', "~> #{version}.0"
-    gem 'sqlite3', '~> 1.3.6' if version < '6.0'
   end
 end

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # master
 
 ## Next
+## v0.4.0
+
+* [BREAKING] Drop support for taking `model` as first argument in default/readonly/enum/normalize. This means that `default: -> (model) { model.other_field}` is no longer supported and should be replaced with `default: -> { other_field }`.
+* Add support for evaluating `Symbol` for readonly/enum/normalize. If symbol is passed in one of those options, method with that name will be called when evaluating the value.
+* [BREAKING] Remove `localized` attribute type.
+* [BREAKING] Change the behavior of `default` and `normalize` for `collection` & `dictionary`. Instead of acting per element they will now act on the attribute as a whole.
+  * E.g. `collection :numbers, default: [1, 2, 3]` will not set the default for the whole collection of `numbers` rather than each element in `numbers`. 
+
+## v0.3.0
+
+- [BREAKING] Stop automatically saving `references_one`/`references_many` when applying changes.
+- [BREAKING] Removed Lifecycle module. `embeds_many`/`embeds_one` objects can no longer be created/saved/updated/destroyed.
+- [BREAKING] Due to changes above `accepts_nested_attributes_for` for `embeds_many`/`embeds_one` associations no longer marks objects for destruction but simply removes them, making changes instantly.
+- Drop support for ruby 2.3 and rails 4.2
+
 ## v0.2.0
 
 - Replace typecasters with proper type definitions.

data/README.md

@@ -172,9 +172,10 @@ It is possible to provide default values for attributes and they will act in the
 
 ```ruby
 attribute :check, Boolean, default: false # Simply false by default
-attribute :today, Date, default: ->{ Time.zone.now.to_date } # Dynamic default value
-attribute :today_wday, Integer, default: ->{ today.wday } # Default is evaluated in instance context
-attribute :today_wday, Integer, default: ->(instance) { instance.today.wday } # The same as previous, but instance provided explicitly
+attribute :wday, Integer, default: ->{ today.wday } # Default evaluated in instance context
+def calculate_today
+  Time.zone.now.today
+end
 ```
 
 ##### Enums
@@ -201,8 +202,8 @@ 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: ->(instance) { instance.subject.present? } # Explicit instance
+attribute :name, String, readonly: :name_changed? # Conditional with calling method
+attribute :name, String, readonly: -> { subject.present? } # Conditional with lambda
 ```
 
 #### Collection
@@ -251,14 +252,6 @@ end
 
 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.
-
-```ruby
-localized :title, String
-```
-
 #### Represents
 
 `represents` provides an easy way to expose model attributes through an interface.
@@ -384,8 +377,6 @@ Options:
 * `:validate` - true or false
 * `:default` - default value for association: reference collection or objects themselves
 
-#### Interacting with ActiveRecord
-
 ### Persistence Adapters
 
 Adapter definition syntax:

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: '3.7'
+services:
+  postgresql:
+    image: 'postgres:12.4'
+    environment:
+      POSTGRES_USER: granite
+      POSTGRES_PASSWORD: granite
+    volumes:
+      - granite_dbdata:/var/lib/postgresql/data
+    ports:
+      - '5432:5432'
+
+volumes:
+  granite_dbdata:

data/gemfiles/rails.5.0.gemfile

@@ -5,7 +5,6 @@ source "https://rubygems.org"
 gem "activesupport", "~> 5.0.0"
 gem "activemodel", "~> 5.0.0"
 gem "activerecord", "~> 5.0.0"
-gem "sqlite3", "~> 1.3.6"
 
 group :test do
   gem "guard"

data/gemfiles/rails.5.1.gemfile

@@ -5,7 +5,6 @@ source "https://rubygems.org"
 gem "activesupport", "~> 5.1.0"
 gem "activemodel", "~> 5.1.0"
 gem "activerecord", "~> 5.1.0"
-gem "sqlite3", "~> 1.3.6"
 
 group :test do
   gem "guard"

data/gemfiles/rails.5.2.gemfile

@@ -5,7 +5,6 @@ source "https://rubygems.org"
 gem "activesupport", "~> 5.2.0"
 gem "activemodel", "~> 5.2.0"
 gem "activerecord", "~> 5.2.0"
-gem "sqlite3", "~> 1.3.6"
 
 group :test do
   gem "guard"

data/granite-form.gemspec

@@ -1,32 +1,32 @@
 require File.expand_path('../lib/granite/form/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['pyromaniac']
-  gem.email         = ['kinwizard@gmail.com']
-  gem.description   = 'Making object from any hash or hash array'
-  gem.summary       = 'Working with hashes in AR style'
-  gem.homepage      = ''
+  gem.authors = ['Toptal Engineering']
+  gem.description = 'Making object from any hash or hash array'
+  gem.summary = 'Working with hashes in AR style'
+  gem.homepage = 'https://github.com/toptal/granite-form'
 
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = 'granite-form'
+  gem.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = 'granite-form'
   gem.require_paths = ['lib']
-  gem.version       = Granite::Form::VERSION
+  gem.required_ruby_version = '>= 2.4.0'
+  gem.version = Granite::Form::VERSION
 
-  gem.add_development_dependency 'actionpack', '>= 4.0'
-  gem.add_development_dependency 'activerecord', '>= 4.0'
+  gem.add_development_dependency 'actionpack', '>= 5.0'
+  gem.add_development_dependency 'activerecord', '>= 5.0'
   gem.add_development_dependency 'appraisal'
   gem.add_development_dependency 'bump'
   gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'pg'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.7.0'
   gem.add_development_dependency 'rspec-its'
   gem.add_development_dependency 'rubocop', '0.52.1'
-  gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'uuidtools'
 
-  gem.add_runtime_dependency 'activemodel', '>= 4.0'
-  gem.add_runtime_dependency 'activesupport', '>= 4.0'
+  gem.add_runtime_dependency 'activemodel', '>= 5.0'
+  gem.add_runtime_dependency 'activesupport', '>= 5.0'
   gem.add_runtime_dependency 'tzinfo'
 end

data/lib/granite/form/active_record/associations.rb

@@ -45,7 +45,7 @@ module Granite
               before_save callback_name
               class_eval <<-METHOD, __FILE__, __LINE__ + 1
               def #{callback_name}
-                association(:#{reflection.name}).apply_changes!
+                association(:#{reflection.name}).sync
               end
               METHOD
             end

data/lib/granite/form/base.rb

@@ -1,6 +1,5 @@
 require 'granite/form/model'
 require 'granite/form/model/primary'
-require 'granite/form/model/lifecycle'
 require 'granite/form/model/associations'
 
 module Granite
@@ -8,7 +7,7 @@ module Granite
     class Base
       include Granite::Form::Model
       include Granite::Form::Model::Primary
-      include Granite::Form::Model::Lifecycle
+      include Granite::Form::Model::Persistence
       include Granite::Form::Model::Associations
     end
   end

data/lib/granite/form/errors.rb

@@ -17,21 +17,6 @@ module Granite
       end
     end
 
-    class UnsavableObject < Error
-    end
-
-    class UndestroyableObject < Error
-    end
-
-    class ObjectNotSaved < Error
-    end
-
-    class ObjectNotDestroyed < Error
-    end
-
-    class AssociationChangesNotApplied < Error
-    end
-
     class AssociationTypeMismatch < Error
       def initialize(expected, got)
         super "Expected `#{expected}` (##{expected.object_id}), but got `#{got}` (##{got.object_id})"

data/lib/granite/form/model/associations/base.rb

@@ -41,10 +41,6 @@ module Granite
             target
           end
 
-          def apply_changes!
-            apply_changes or raise Granite::Form::AssociationChangesNotApplied
-          end
-
           def callback(name, object)
             evaluator = reflection.options[name]
             return true unless evaluator

data/lib/granite/form/model/associations/collection/embedded.rb

@@ -4,7 +4,8 @@ module Granite
       module Associations
         module Collection
           class Embedded < Proxy
-            delegate :build, :create, :create!, to: :@association
+            delegate :build, to: :@association
+            delegate :delete, to: :target
             alias_method :new, :build
           end
         end

data/lib/granite/form/model/associations/collection/proxy.rb

@@ -6,7 +6,7 @@ module Granite
           class Proxy
             include Enumerable
 
-            delegate :target, :save, :save!, :loaded?, :reload, :clear, :concat, to: :@association
+            delegate :target, :loaded?, :reload, :clear, :concat, to: :@association
             delegate :each, :size, :length, :first, :last, :empty?, :many?, :==, :dup, to: :target
             alias_method :<<, :concat
             alias_method :push, :concat

data/lib/granite/form/model/associations/embeds_any.rb

@@ -12,6 +12,13 @@ module Granite
           def embed_object(object)
             object.instance_variable_set(:@embedder, owner)
           end
+
+          def model_data(model)
+            return unless model
+
+            model.association_names.each { |assoc_name| model.association(assoc_name).sync }
+            model.attributes
+          end
         end
       end
     end

data/lib/granite/form/model/associations/embeds_many.rb

@@ -7,27 +7,6 @@ module Granite
             push_object(build_object(attributes))
           end
 
-          def create(attributes = {})
-            build(attributes).tap(&:save)
-          end
-
-          def create!(attributes = {})
-            build(attributes).tap(&:save!)
-          end
-
-          def destroyed
-            @destroyed ||= []
-          end
-
-          def apply_changes
-            result = target.map do |object|
-              object.destroyed? || object.marked_for_destruction? ? object.destroy : object.save
-            end.all?
-            @destroyed = target.select(&:destroyed?)
-            target.delete_if(&:destroyed?)
-            result
-          end
-
           def target=(objects)
             objects.each { |object| setup_performers! object }
             loaded!
@@ -63,13 +42,14 @@ module Granite
             @target = []
           end
 
+          def sync
+            write_source(target.map { |model| model_data(model) })
+          end
+
           def clear
-            begin
-              transaction { target.all?(&:destroy!) }
-            rescue Granite::Form::ObjectNotDestroyed
-              nil
-            end
-            reload.empty?
+            target
+            @target = []
+            true
           end
 
           def reader(force_reload = false)
@@ -80,7 +60,7 @@ module Granite
           def replace(objects)
             transaction do
               clear
-              append(objects) or raise Granite::Form::AssociationChangesNotApplied
+              append(objects)
             end
           end
 
@@ -101,8 +81,7 @@ module Granite
               raise AssociationTypeMismatch.new(reflection.klass, object.class) unless object && object.is_a?(reflection.klass)
               push_object object
             end
-            result = owner.persisted? ? apply_changes : true
-            result && target
+            target
           end
 
           def push_object(object)
@@ -115,34 +94,6 @@ module Granite
             embed_object(object)
             callback(:before_add, object)
 
-            association = self
-
-            object.define_create do
-              source = association.send(:read_source)
-              index = association.target
-                .select { |one| one.persisted? || one.equal?(self) }
-                .index { |one| one.equal?(self) }
-
-              source.insert(index, attributes)
-              association.send(:write_source, source)
-            end
-
-            object.define_update do
-              source = association.send(:read_source)
-              index = association.target.select(&:persisted?).index { |one| one.equal?(self) }
-
-              source[index] = attributes
-              association.send(:write_source, source)
-            end
-
-            object.define_destroy do
-              source = association.send(:read_source)
-              index = association.target.select(&:persisted?).index { |one| one.equal?(self) }
-
-              source.delete_at(index) if index
-              association.send(:write_source, source)
-            end
-
             callback(:after_add, object)
           end
         end

data/lib/granite/form/model/associations/embeds_one.rb

@@ -3,33 +3,10 @@ module Granite
     module Model
       module Associations
         class EmbedsOne < EmbedsAny
-          attr_reader :destroyed
-
           def build(attributes = {})
             self.target = build_object(attributes)
           end
 
-          def create(attributes = {})
-            build(attributes).tap(&:save)
-          end
-
-          def create!(attributes = {})
-            build(attributes).tap(&:save!)
-          end
-
-          def apply_changes
-            if target
-              if target.destroyed? || target.marked_for_destruction?
-                @destroyed = target
-                clear
-              else
-                target.save
-              end
-            else
-              true
-            end
-          end
-
           def target=(object)
             if object
               callback(:before_add, object)
@@ -63,9 +40,14 @@ module Granite
             object
           end
 
+          def sync
+            write_source(model_data(target))
+          end
+
           def clear
-            target.try(:destroy)
-            reload.nil?
+            target
+            @target = nil
+            true
           end
 
           def reader(force_reload = false)
@@ -79,7 +61,6 @@ module Granite
               transaction do
                 clear
                 self.target = object
-                apply_changes! if owner.persisted?
               end
             else
               clear
@@ -94,16 +75,6 @@ module Granite
 
           def setup_performers!(object)
             embed_object(object)
-            association = self
-
-            object.define_save do
-              association.send(:write_source, attributes)
-            end
-
-            object.define_destroy do
-              association.send(:write_source, nil)
-              true
-            end
           end
         end
       end

data/lib/granite/form/model/associations/nested_attributes.rb

@@ -74,11 +74,12 @@ module Granite
               primary_attribute_name = primary_name_for(association.reflection.klass)
               if existing_record
                 primary_attribute = existing_record.attribute(primary_attribute_name)
-                primary_attribute_value = primary_attribute.type_definition.ensure_type(attributes[primary_attribute_name]) if primary_attribute
+                primary_attribute_value = primary_attribute.type_definition.prepare(attributes[primary_attribute_name]) if primary_attribute
               end
 
               if existing_record && (!primary_attribute || options[:update_only] || existing_record.primary_attribute == primary_attribute_value)
-                assign_to_or_mark_for_destruction(existing_record, attributes, options[:allow_destroy]) unless call_reject_if(object, association_name, attributes)
+                assign_to(existing_record, attributes) unless call_reject_if(object, association_name, attributes)
+                association.clear if destroy_flag?(attributes) && options[:allow_destroy]
               elsif attributes[primary_attribute_name].present?
                 raise Granite::Form::ObjectNotFound.new(object, association_name, attributes[primary_attribute_name])
               elsif !reject_new_object?(object, association_name, attributes, options)
@@ -123,11 +124,12 @@ module Granite
                 else
                   existing_record = association.target.detect do |record|
                     primary_attribute_value = record.attribute(primary_attribute_name)
-                      .type_definition.ensure_type(attributes[primary_attribute_name])
+                      .type_definition.prepare(attributes[primary_attribute_name])
                     record.primary_attribute == primary_attribute_value
                   end
                   if existing_record
-                    assign_to_or_mark_for_destruction(existing_record, attributes, options[:allow_destroy]) unless call_reject_if(object, association_name, attributes)
+                    assign_to(existing_record, attributes) unless call_reject_if(object, association_name, attributes)
+                    association.target.delete(existing_record) if destroy_flag?(attributes) && options[:allow_destroy]
                   elsif association.reflection.embedded?
                     unless reject_new_object?(object, association_name, attributes, options)
                       association.reflection.klass.with_sanitize(false) do
@@ -156,9 +158,8 @@ module Granite
               raise Granite::Form::TooManyObjects.new(limit, attributes_collection.size)
             end
 
-            def self.assign_to_or_mark_for_destruction(object, attributes, allow_destroy)
+            def self.assign_to(object, attributes)
               object.assign_attributes(attributes.except(*unassignable_keys(object)))
-              object.mark_for_destruction if destroy_flag?(attributes) && allow_destroy
             end
 
             def self.destroy_flag?(hash)
@@ -170,7 +171,6 @@ module Granite
             end
 
             def self.call_reject_if(object, association_name, attributes)
-              return false if destroy_flag?(attributes)
               case callback = object.nested_attributes_options[association_name][:reject_if]
               when Symbol
                 method(callback).arity.zero? ? send(callback) : send(callback, attributes)

data/lib/granite/form/model/associations/persistence_adapters/active_record.rb

@@ -26,10 +26,6 @@ module Granite
               data_source.new(attributes)
             end
 
-            def persist(object, raise_error: false)
-              raise_error ? object.save! : object.save
-            end
-
             def scope(owner, source)
               scope = data_source.unscoped
 

data/lib/granite/form/model/associations/persistence_adapters/base.rb

@@ -16,10 +16,6 @@ module Granite
               raise NotImplementedError, 'Should be implemented in inhereted adapter. Build new instance of data object by attributes'
             end
 
-            def persist(_object, *)
-              raise NotImplementedError, 'Should be implemented in inhereted adapter. Build new instance of data object by attributes'
-            end
-
             def scope(_owner, _source)
               raise NotImplementedError, 'Should be implemented in inhereted adapter. Better to be Enumerable'
             end

data/lib/granite/form/model/associations/references_many.rb

@@ -3,38 +3,6 @@ module Granite
     module Model
       module Associations
         class ReferencesMany < ReferencesAny
-          def build(attributes = {})
-            append([build_object(attributes)]).last
-          end
-
-          def create(attributes = {})
-            object = build(attributes)
-            persist_object(object)
-            object
-          end
-
-          def create!(attributes = {})
-            object = build(attributes)
-            persist_object(object, raise_error: true)
-            object
-          end
-
-          def apply_changes
-            target.all? do |object|
-              if object
-                if object.marked_for_destruction? && reflection.autosave?
-                  object.destroy
-                elsif object.new_record? || (reflection.autosave? && object.changed?)
-                  persist_object(object)
-                else
-                  true
-                end
-              else
-                true
-              end
-            end
-          end
-
           def target=(object)
             loaded!
             @target = object.to_a