act_form 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f096ba9408679e014443f6ebc3ac2f2083b1f081ac923c97a485d9ea1c67784
-  data.tar.gz: cee283b7050b2d532d10ce998102c42aad399739f3841e025cf41a4cc92afdc7
+  metadata.gz: e4bbaec93fbf90269c9af4f2667fd6fa8a13c8c840046d3e87341433a7e6daca
+  data.tar.gz: 1b6069a04c93b612237f02b0ecb079d76ac283f4d909a14560575febeaf52a11
 SHA512:
-  metadata.gz: 755641d26b589a199cb05e36c9c6063ece293010fedac1e6c34d7229e51bd0692d32e32420ce42cd1a2fb2491b83d279aa022cb234f406335f559d66fd6a2150
-  data.tar.gz: 8089ca663ee9a24b144497d2dc462a76e802989f15e3bce9af75e42f1cbba6328349a0d87aac37b8cc183d8680fd62a4c0d6bcf6c1be922f80a42bd1f3c50780
+  metadata.gz: dc3e0058a40aec51c219f24a6fe90f478a607c7f4ea8888133cd382c6abf8dab48cbae9340adf8facf6027e618f53b74b70e8bf2ac67eca777276642de46f251
+  data.tar.gz: 171cb38223df688c0c0cb8596628e339e235403ef15f531f7d0fa70204382e1918feed00dd8cce7f1543789ae6cb78016bb998df6c746e3dcea17f44f9fabf27

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /*.gem
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - "test/**/*"
+    - "act_form.gemspec"
+    - "Rakefile"
+    - "Gemfile"
+
+
+MethodLength:
+  Max: 20
+
+Style/Documentation:
+  Exclude:
+    - "lib/act_form.rb"
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 0.4.3
+* [Feature] issue#6 add `setup` method
+```ruby
+class SomeCommand < Act::Command
+  # use setup to pre-inialize some actions.
+  setup do
+    @ins = 1
+  end
+
+  def perform
+    @ins # use @ins
+  end
+end
+```
+
+# 0.4.2 [yank]
+
 # 0.4.1
 * fix issue#5
 

data/README.md

@@ -144,15 +144,21 @@ AdminForm.new(phone: '12345678901').valid? # => true
 
 Command object almost like form object. Command object can't init by `new`, and it has some new features.
 
-#### API - `perform`, `run`, `success?`, `failure?`
+#### API - `perform`, `run`, `success?`, `failure?`, `setup`
 
 command object must respond to `perform` method.
 
 ```ruby
 class CreateUserCommand < ActForm::Command
   combine UserForm
+
+  # Do some pre-inialize actions.
+  setup do
+    @name = 'foo'
+  end
   
   def perform
+    attributes[:name] = @name
     User.create(attributes)
   end
 end

data/lib/act_form/attributes.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'act_form/type'
 
 module ActForm
-  module Attributes
+  module Attributes # rubocop:disable Style/Documentation
     extend ActiveSupport::Concern
 
     included do
@@ -17,10 +19,11 @@ module ActForm
 
     def get_default(default, default_provided)
       return if default == default_provided
+
       default.respond_to?(:call) ? default.call : default
     end
 
-    module ClassMethods
+    module ClassMethods # rubocop:disable Style/Documentation
       # attribute :name, type: :string
       #   or
       # attribute :name, :string, required: true
@@ -34,7 +37,7 @@ module ActForm
 
         name
       end
-      alias_method :attr, :attribute
+      alias attr attribute
 
       def define_reader_method(name, default: NO_DEFAULT_PROVIDED)
         define_method(name) do
@@ -48,17 +51,14 @@ module ActForm
 
       def define_writer_method(name, cast_type)
         define_method("#{name}=") do |value|
-          _value = ActiveModel::Type.lookup(cast_type).deserialize(value)
-          @attributes = attributes.merge({name => _value})
-          _value
+          val = ActiveModel::Type.lookup(cast_type).deserialize(value)
+          @attributes = attributes.merge({ name => val })
+          val
         end
       end
 
-      private
-
       NO_DEFAULT_PROVIDED = Object.new
       private_constant :NO_DEFAULT_PROVIDED
-
-    end # class_methods
+    end
   end
 end

data/lib/act_form/combinable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module ActForm
-  module Combinable
+  module Combinable # rubocop:disable Style/Documentation
     extend ActiveSupport::Concern
 
     included do
@@ -17,12 +19,14 @@ module ActForm
 
     def combined_forms_valid?(context)
       return if _forms.empty?
+
       _forms.each do |form_class|
         form = form_class.new(attributes)
         form.valid?(context)
         form.errors.details.each do |attr_name, arr|
           arr.each do |error|
             next if error[:error] == :required
+
             errors.add(attr_name, error[:error])
           end
         end
@@ -30,7 +34,6 @@ module ActForm
     end
 
     class_methods do
-
       def combine(*forms)
         forms.each do |form_class|
           raise ArgumentError, "can't combine itself" if form_class == self
@@ -40,9 +43,7 @@ module ActForm
           self.merge_attribute_set_from(form_class)
           self._forms << form_class
         end
-      end
-
+      end # End of combine
     end
-
   end
 end

data/lib/act_form/merge.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ActForm
-  module Merge
+  module Merge # rubocop:disable Style/Documentation
     extend ActiveSupport::Concern
 
     class_methods do
@@ -10,6 +12,5 @@ module ActForm
         end
       end
     end
-
   end
 end

data/lib/act_form/model.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'act_form/attributes'
 require 'act_form/merge'
 require 'act_form/combinable'
 
 module ActForm
-  module Model
+  module Model # rubocop:disable Style/Documentation
     extend ActiveSupport::Concern
     include ActiveModel::Model
     include Attributes
@@ -14,25 +16,27 @@ module ActForm
       set_callback :validate, :before, :validate_required_attributes
     end
 
-    def initialize(attrs={})
+    def initialize(attrs = {})
       super attrs.select { |k, _| respond_to?("#{k}=") }
     end
 
     def record=(record)
       raise ArgumentError, 'Record must respond to attributes method!' unless record.respond_to?(:attributes)
+
       @record = record
     end
 
     # Record must respond_to attributes method
     def init_by(record, **attrs)
       self.record = record
-      _attrs = record.attributes.extract! *self.class.attribute_set.keys.map(&:to_s)
+      _attrs = record.attributes.extract!(*self.class.attribute_set.keys.map(&:to_s))
       assign_attributes _attrs.merge(attrs)
     end
 
     def sync(target)
-      self.class.attribute_set.keys.each do |attr|
+      self.class.attribute_set.each_key do |attr|
         next unless target.respond_to?(attr)
+
         target.public_send "#{attr}=", public_send(attr)
       end
     end
@@ -57,8 +61,9 @@ module ActForm
       self.class.attribute_set.each do |attr_name, arr|
         _, options = arr
         next if options.key?(:default)
-        next if !options[:required]
-        if attributes[attr_name].nil?
+        next if !options[:required] # rubocop:disable Style/NegatedIf
+
+        if attributes[attr_name].nil? # rubocop:disable Style/IfUnlessModifier
           errors.add(attr_name, :required)
         end
       end

data/lib/act_form/runnable.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module ActForm
   class RunError < StandardError; end
+
+  # Define runnable behaivor for form object.
   module Runnable
     extend ActiveSupport::Concern
 
@@ -10,6 +14,10 @@ module ActForm
     end
 
     class_methods do
+      def setup(&block)
+        self.before_validation(&block)
+      end
+
       def run(*args)
         new(*args).run
       end
@@ -19,7 +27,7 @@ module ActForm
       end
     end
 
-    def has_errors?
+    def has_errors? # rubocop:disable Naming/PredicateName
       !errors.empty?
     end
 
@@ -32,7 +40,7 @@ module ActForm
     end
 
     def run!
-      if valid?
+      if valid? # rubocop:disable Style/GuardClause
         @result    = perform
         @performed = true
         result

data/lib/act_form/type.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'active_model/type'
 
 module ActForm
   module Type
+    # Add +Object+ type
     class Object < ActiveModel::Type::Value
       def type
         :object

data/lib/act_form/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActForm
-  VERSION = '0.4.1'
+  VERSION = '0.4.3'
 end

data/lib/act_form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'act_form/version'
 require 'act_form/model'
 require 'act_form/runnable'
@@ -9,6 +11,7 @@ module ActForm
 
   class Command
     include Model
+    include ActiveModel::Validations::Callbacks
     include Runnable
     private_class_method :new
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_form
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - zires
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile