lite-form 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71ac196f9262cabced3c3e7bc7e588e7bce698a4abbd7aa5a956787335993179
-  data.tar.gz: 33a648e006ccd5af8431f0a5d079db55cf10aad688eedb4fe16f65fdba380c34
+  metadata.gz: 586b7faedfe8c9173df9f3ed5a3190e182df29464beef8aaa50d416bbd0ddfea
+  data.tar.gz: f04200d3a486afc90c0971c0d6b8ef493d6a6015eaa7c0b795fbf3c9b3abbeb3
 SHA512:
-  metadata.gz: d1bd7cf4427423d2d3f6958e3c39d02de7ccdca6b06918c671e3ef3102e9deedc77dad59cef12f5897040e36a6848d2af0d06eee27783128eef08a4c3c323a51
-  data.tar.gz: 629f2dc0ae0728b002434fb890caa5d9d3f5589800938e9358e114319a358559fe73dac299481ebbbf663b38a64f25d509e83a3751a0098fab87081f3c0fa4ef
+  metadata.gz: 0b6c37f2dcfd4ff626f610b673b8597f09f1a389d0ce6f1e16097e926160baf34e160d8d90e49cf7a54c37ff95e8a6d6e56a833f82fcb817a13dbae44253f257
+  data.tar.gz: ae9667fed2747f42a888d625f8333177d554001a7c30b7e014523df0aa29d205158d707cf4d388e36dea12e4e61e9eea1ee0637deadbffd32fb4af0626dc7964

data/.rubocop.yml

@@ -1,12 +1,16 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
+  NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
-LineLength:
-  Max: 100
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     - 'spec/**/**/*'
@@ -14,6 +18,14 @@ Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
+Layout/LineLength:
+  Max: 100
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'
@@ -24,6 +36,8 @@ RSpec/ExampleLength:
   Enabled: false
 RSpec/MultipleExpectations:
   Enabled: false
+Style/ArgumentsForwarding:
+  Enabled: false
 Style/Documentation:
   Enabled: false
 Style/ExpandPathArguments:

data/.travis.yml

@@ -4,6 +4,7 @@ cache: bundler
 rvm:
 - 2.5
 - 2.6
+- 2.7
 - ruby-head
 matrix:
   fast_finish: true

data/CHANGELOG.md

@@ -6,6 +6,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2021-07-19
+### Added
+- Added Ruby 3.0 support
+
+## [1.0.5] - 2020-05-20
+### Added
+- Added ruby 2.7 support
+- Added save args
+- Added more callback support
+### Removed
+- Removed archive and destroy propagation
+
+## [1.0.4] - 2019-12-21
+### Removed
+- Removed generator empty directory check
+
+## [1.0.3] - 2019-09-16
+### Removed
+- Removed lite-form generator
+- Removed spec from rails generator
+
 ## [1.0.2] - 2019-09-16
 ### Changed
 - Changed create propagation to check errors instead of persistence

data/Gemfile.lock

@@ -1,115 +1,130 @@
 PATH
   remote: .
   specs:
-    lite-form (1.0.2)
+    lite-form (1.1.0)
       activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.0)
-      actionview (= 6.0.0)
-      activesupport (= 6.0.0)
-      rack (~> 2.0)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.0)
-      activesupport (= 6.0.0)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    builder (3.2.3)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
     colorize (0.8.1)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    database_cleaner (1.7.0)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    fasterer (0.6.0)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    fasterer (0.9.0)
       colorize (~> 0.7)
-      ruby_parser (>= 3.13.0)
+      ruby_parser (>= 3.14.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.6.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    loofah (2.2.3)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.4)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.17.0)
-    parser (2.6.4.1)
-      ast (~> 2.4.0)
-    rack (2.0.7)
+    method_source (1.0.0)
+    mini_portile2 (2.5.3)
+    minitest (5.14.4)
+    nokogiri (1.11.7)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (6.0.0)
-      actionpack (= 6.0.0)
-      activesupport (= 6.0.0)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 0.13)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.1)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.35.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.1)
-    ruby_parser (3.13.1)
-      sexp_processor (~> 4.9)
-    sexp_processor (4.12.1)
-    sqlite3 (1.4.1)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.1.10)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.16.0)
+      sexp_processor (~> 4.15, >= 4.15.1)
+    sexp_processor (4.15.3)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -125,8 +140,9 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-performance
+  rubocop-rake
   rubocop-rspec
   sqlite3
 
 BUNDLED WITH
-   2.0.1
+   2.2.24

data/README.md

@@ -30,18 +30,21 @@ Or install it yourself as:
 
 ## Setup
 
-`rails g lite:form:install` will generate the following file:
-`../app/forms/application_form.rb`
+### Generators
 
-```ruby
-class ApplicationForm < Lite::Form::Base
-end
+Use `rails g form NAME` will generate the following files:
+
+```erb
+app/forms/[name]_form.rb
 ```
 
-Use `rails g form NAME` will generate the following file:
-`../app/forms/[name]_form.rb`
+If a `ApplicationForm` file in the `app/forms` directory is available, the
+generator will create file that inherit from `ApplicationForm` if not it will
+fallback to `Lite::Form::Base`.
+
+### Forms
 
-You will then need to fill this class with the methods and actions you want to perform:
+You will need to fill this class with the methods and actions you want to perform:
 
 ```ruby
 class UserForm < ApplicationForm
@@ -56,9 +59,9 @@ class UserForm < ApplicationForm
   # Setup your form validations like you would on model objects
   validates :name, presence: true
 
-  # Access 4 predefined callbacks to trigger before, after, and
+  # Access 6 predefined callbacks to trigger before, after, and
   # around your actions. Available callbacks are `initialize`
-  # `create`, `save`, and `update`
+  # `commit`, `create`, `rollback`, `save`, and `update`.
   before_create :prepend_signature!
   after_update :append_signature!
 
@@ -71,17 +74,26 @@ class UserForm < ApplicationForm
     # Propagation methods help you perform an action on an object.
     # If successful is returns the result else it adds the object
     # errors to the form object. Available propagation methods are:
-    # `create_and_return!(object, params)`, `update_and_return!(object, params)`,
-    # `save_and_return!(object)`, and `destroy_and_return!(object)`
+    # `create_and_return!(object, params)`,
+    # `update_and_return!(object, params)`,
+    # `save_and_return!(object)`
     create_and_return!(User, attributes)
   end
 
   def update_action
-    ActiveRecord::Base.transaction do
-      user = User.find(attributes[:id])
-      update_and_return!(user, attributes.slice(:id))
-      update_and_return!(user.settings, tour: false)
+    run_callbacks(:commit) do
+      ActiveRecord::Base.transaction do
+        user = User.find(attributes[:id])
+        update_and_return!(user, attributes.slice(:id))
+
+        # The `save_and_return!` supports on/off validation
+        user.settings.web_notification = true
+        save_and_return!(user.settings, validate: false)
+      end
     end
+  rescue StandardError => e
+    # This will run the `rollback` callback and re-raise the error.
+    raise_transaction_rollback(e)
   end
 
   def prepend_signature!
@@ -98,7 +110,6 @@ end
 ## Usage
 
 To access the form you need to pass the object to the form class and thats it.
-You can even decorate a collection of objects by passing the collection to `decorate`.
 
 ```ruby
 form = UserForm.new(params)
@@ -136,7 +147,9 @@ include ActiveModel::Serialization
 
 # Default callbacks that are defined
 define_model_callbacks :initialize
+define_model_callbacks :commit
 define_model_callbacks :create
+define_model_callbacks :rollback
 define_model_callbacks :save
 define_model_callbacks :update
 ```

data/lib/generators/rails/USAGE

@@ -6,4 +6,3 @@ Example:
 
     This will create:
         - app/forms/[name]_form.rb
-        - spec/forms/[name]_form_spec.rb

data/lib/generators/rails/form_generator.rb

@@ -10,16 +10,9 @@ module Rails
 
     def copy_files
       path = File.join('app', 'forms', class_path, "#{file_name}_form.rb")
-      empty_directory('app/forms')
       template('form.rb.tt', path)
     end
 
-    def copy_specs
-      path = File.join('spec', 'forms', class_path, "#{file_name}_form_spec.rb")
-      empty_directory('spec/forms')
-      template('spec.rb.tt', path)
-    end
-
     private
 
     def file_name

data/lib/generators/rails/templates/form.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %>Form < ApplicationForm
+class <%= class_name %>Form < <%= ApplicationForm.to_s rescue 'Lite::Form::Base' %>
 end
 <% end -%>

data/lib/lite/form.rb

@@ -11,5 +11,4 @@ end
   require "lite/form/#{name}"
 end
 
-require 'generators/lite/form/install_generator'
 require 'generators/rails/form_generator'

data/lib/lite/form/base.rb

@@ -17,10 +17,18 @@ module Lite
       include Lite::Form::Helpers::Propagation
 
       define_model_callbacks :initialize
+      define_model_callbacks :commit
       define_model_callbacks :create
+      define_model_callbacks :rollback
       define_model_callbacks :save
       define_model_callbacks :update
 
+      attr_reader :result
+
+      def initialize(params = {})
+        run_callbacks(:initialize) { super(params) }
+      end
+
       class << self
 
         def model_name
@@ -33,12 +41,6 @@ module Lite
 
       end
 
-      attr_reader :result
-
-      def initialize(params = {})
-        run_callbacks(:initialize) { super(params) }
-      end
-
     end
   end
 end

data/lib/lite/form/helpers/errors.rb

@@ -50,6 +50,11 @@ module Lite
           errors.empty?
         end
 
+        def raise_transaction_rollback(exception)
+          run_callbacks(:rollback)
+          raise exception
+        end
+
       end
     end
   end

data/lib/lite/form/helpers/propagation.rb

@@ -7,19 +7,17 @@ module Lite
 
         private
 
-        %i[archive destroy save].each do |action|
-          define_method("#{action}_and_return!") do |klass|
-            merge_errors!(klass) unless klass.send(action)
-            klass
-          end
-        end
-
         def create_and_return!(klass, params)
           klass = klass.create(params)
           merge_errors!(klass) unless klass.errors.empty?
           klass
         end
 
+        def save_and_return!(klass, *args)
+          merge_errors!(klass) unless klass.save(*args)
+          klass
+        end
+
         def update_and_return!(klass, params)
           merge_errors!(klass) unless klass.update(params)
           klass

data/lib/lite/form/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Form
 
-    VERSION ||= '1.0.2'
+    VERSION = '1.1.0'
 
   end
 end

data/lite-form.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
     )
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-form
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Juan Gomez
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - j.gomez@drexed.com
 executables: []
@@ -200,12 +214,9 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
-- lib/generators/lite/form/install_generator.rb
-- lib/generators/lite/form/templates/install.rb
 - lib/generators/rails/USAGE
 - lib/generators/rails/form_generator.rb
 - lib/generators/rails/templates/form.rb.tt
-- lib/generators/rails/templates/spec.rb.tt
 - lib/lite/form.rb
 - lib/lite/form/base.rb
 - lib/lite/form/exceptions.rb
@@ -219,7 +230,7 @@ homepage: http://drexed.github.io/lite-form
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -234,8 +245,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.24
+signing_key:
 specification_version: 4
 summary: Ruby Form based framework (aka form objects)
 test_files: []

data/lib/generators/lite/form/install_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-
-module Lite
-  module Form
-    class InstallGenerator < Rails::Generators::Base
-
-      source_root File.expand_path('../templates', __FILE__)
-
-      def copy_application_query_file
-        copy_file('install.rb', 'app/forms/application_form.rb')
-      end
-
-    end
-  end
-end

data/lib/generators/lite/form/templates/install.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class ApplicationForm < Lite::Form::Base
-end

data/lib/generators/rails/templates/spec.rb.tt

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe <%= class_name %>Form, type: :form do
-  pending "add some examples to (or delete) #{__FILE__}"
-end