act_form 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 50804b31cfd1b52553e16af190b4f8471cdd6e2f
-  data.tar.gz: 6392da038a5fdf1ef6f9e70376b5a0efdf791d30
+SHA256:
+  metadata.gz: 6dc112ffc52fbda2d69a6f676564bddd36aa6f428fe554c3cbd66e3d05042a47
+  data.tar.gz: 47845d8f3eaafa6595d1b088273f39075387f5ac342bb421040133af62a8aa49
 SHA512:
-  metadata.gz: 7cbf1b8b3a10db0f6d9569953593267a1de6935ed7a40ea20e6a902aac71857559f0c5d7cd1f2dfc5bd7dc53166d342589de5006996d1bc605fe9fc10346e1dc
-  data.tar.gz: 251cef49ed01f2133b23cbac6c81b07c45807aee3853e1d1295901723d0603f7209fb78bece6923e755c88382bad6fb03a587db6a909a87bed289a0156da5900
+  metadata.gz: 305fa4843044061a4ee4fb299c767cd16f1cb5d09beb0f70476586e4fb959831e723c9e56908a0712aeb0845baa387849dc979e59ed548b5f90e752cc0c09e5b
+  data.tar.gz: 870fb9bbfe96eb6b33325b9c04192517954708b81b96fbd68724f6bd421073efb7ff33edbb8488a0d900a7275dd404273a6aa9cc6bd20e6fab063c8971245c26

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 0.4.0
+* update bundler dependency to `2.1.x`
+* update spec syntex
+* support rails `6.0`
+* add shortcut alias method `attr` for `attribute`
+* fix issue#2 

data/CODE_OF_CONDUCT.md

@@ -35,7 +35,7 @@ This code of conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at alex@qingju.com. All
+reported by contacting a project maintainer at zshuaibin@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. Maintainers are
 obligated to maintain confidentiality with regard to the reporter of an
@@ -46,4 +46,4 @@ version 1.3.0, available at
 [http://contributor-covenant.org/version/1/3/0/][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -1,9 +1,174 @@
 # ActForm
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/form_model`. To experiment with that code, run `bin/console` for an interactive prompt.
+ActForm is the gem that provide a simple way to create `form object` or `command object` or `service object`, it only depends on `activemodel >= 5` and provides few api.
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+#### API - `attribute`
+
+```ruby
+class UserForm < ActForm::Base
+  attribute :name, required: true
+  attribute :age,  type: :integer
+  attribute :address
+  attribute :nickname, default: 'nick'
+  attribute :desc, default: ->{ 'desc' }
+end
+
+form = UserForm.new(name: 'su', age: '18', address: 'somewhere')
+form.name # => 'su'
+form.age # => 18
+form.address # => 'somewhere'
+form.nickname # => 'nick'
+form.desc # => 'desc'
+# override default
+form.nickname = 'hello'
+form.nickname # => 'hello'
+
+# required
+form = UserForm.new(age: '18', address: 'somewhere')
+form.valid? # => false
+form.errors.full_messages # => ["Name require a value"]
+```
+
+#### Difference between `required` and `validates_presence_of`
+`required` will run before the validation, and it will cancel other validations if return false.
+
+### form object
+
+#### API - `valid?`
+Compliant with the active model api
+```ruby
+class PhoneForm < ActForm::Base
+  attribute :phone
+  
+  validates_format_of :phone, with: /\A\d{11}\z/i
+end
+
+form = PhoneForm.new
+form.valid? # => false
+form.errors.full_messages # => ["Phone is invalid"]
+
+PhoneForm.new(phone: '12345678901').valid? # => true
+```
+
+#### API - `sync`
+sync only copy attributes to target, will not trigger validate
+```ruby
+target = Class.new do
+  attr_accessor :phone
+end.new
+
+form = PhoneForm.new(phone: '12345678901')
+form.sync(target)
+target.phone # => '12345678901'
+```
+
+#### API - `save`
+sync to the target and call the save method when passed the validation
+```ruby
+target = Class.new do
+  attr_accessor :phone
+  attr_reader :saved
+  
+  def save
+    @saved = true
+  end
+end.new
+
+form = PhoneForm.new(phone: '12345678901')
+form.save(target) # same as form.sync(target) and target.save
+target.phone # => '12345678901'
+target.saved # => true
+form.persisted? # => true
+```
+
+#### API - `init_by`
+`init_by` will copy attributes form target to the form, and set default target.
+```ruby
+target = Class.new do
+  attr_accessor :phone
+  attr_reader :saved
+  
+  def save
+    @saved = true
+  end
+end.new
+
+target.phone = '12345678901'
+
+form = PhoneForm.new
+form.init_by(target)
+form.phone # => '12345678901'
+form.save # => true
+target.saved # => true
+```
+
+#### API - `combine`
+form can combine to other forms
+```ruby
+class PhoneForm < ActForm::Base
+  attribute :phone
+  validates_format_of :phone, with: /\A\d{11}\z/i
+end
+
+class EmailForm < ActForm::Base
+  attribute :email
+  
+  validate :check_email
+  
+  def check_email
+    errors.add(:email, :blank) if email.blank?
+  end
+end
+
+class UserForm < ActForm::Base
+  combine PhoneForm, EmailForm
+end
+
+class AdminForm < ActForm::Base
+  combine PhoneForm
+end
+
+user_form = UserForm.new
+user_form.valid?
+user_form.errors.full_messages # => ["Phone is invalid", "Email can't be blank"]
+UserForm.new(phone: '12345678901', email: '1').valid? # => true
+admin_form = AdminForm.new
+admin_form.valid?
+admin_form.errors.full_messages # => ["Phone is invalid"]
+AdminForm.new(phone: '12345678901').valid? # => true
+```
+
+### command/service object
 
+Command object almost like form object. Command object can't init by `new`, and it has some new features.
+
+#### API - `perform`, `run`, `success?`, `failure?`
+
+command object must respond to `perform` method.
+
+```ruby
+class CreateUserCommand < ActForm::Command
+  combine UserForm
+  
+  def perform
+    User.create(attributes)
+  end
+end
+
+CreateUserCommand.new 
+# => NoMethodError: private method `new' called for CreateUserCommand:Class 
+
+command = CreateUserCommand.run(phone: '12345678901')
+if command.success?
+  @user = command.result
+  # do something...
+else
+  command.errors.full_messages # => ["Email can't be blank"]
+  # do something...
+end
+```
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,21 +183,16 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install form_model
-
-## Usage
+    $ gem install act_form
 
-TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/form_model. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/act_form. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/act_form.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A simple way to create form/command/service objects.}
   spec.description   = %q{The simple way to create form objects or command/service objects with ActiveModel.}
-  spec.homepage      = 'https://github.com/simple-and-powerful/form-model'
+  spec.homepage      = 'https://github.com/simple-and-powerful/act-form'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -23,13 +23,11 @@ Gem::Specification.new do |spec|
   # end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'virtus', '~> 1.0', '>= 1.0.0'
-  spec.add_runtime_dependency 'activemodel', '~> 4.0', '>= 4.0.0'
+  spec.add_runtime_dependency 'activemodel', '>= 5.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

data/lib/act_form.rb

@@ -7,28 +7,11 @@ module ActForm
     include Model
   end
 
-  class RecordForm < Base
-    attr_reader :record
-    def initialize(record, **attrs)
-      @record = record
-      @extract_attrs = @record.attributes.extract! *self.class.attribute_set.map(&:name).map(&:to_s)
-      super(@extract_attrs.merge(attrs))
-    end
-
-    def save
-      if valid?
-        sync(@record)
-        @persisted = @record.save
-      else
-        false
-      end
-    end
-  end
-
-  class Command < Base
+  class Command
+    include Model
     include Runnable
     private_class_method :new
   end
 end
 
-require 'act_form/railtie' if defined?(Rails)
+I18n.load_path << "#{File.dirname(__FILE__)}/act_form/locale/en.yml"

data/lib/act_form/attributes.rb

@@ -0,0 +1,58 @@
+require 'act_form/type'
+
+module ActForm
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :attribute_set, instance_accessor: false
+      self.attribute_set = {}
+    end
+
+    def attributes
+      @attributes || {}
+    end
+
+    private
+
+    def get_default(default, default_provided)
+      return if default == default_provided
+      default.respond_to?(:call) ? default.call : default
+    end
+
+    module ClassMethods
+      # attribute :name, type: :string
+      #   or
+      # attribute :name, :string, required: true
+      def attribute(name, cast_type = :object, **options)
+        name = name.to_s
+        cast_type = options[:type] || cast_type
+        self.attribute_set = attribute_set.merge(name => [cast_type, options])
+
+        define_reader_method name, **options.slice(:default)
+        define_writer_method name, cast_type
+
+        name
+      end
+      alias_method :attr, :attribute
+
+      def define_reader_method(name, default: NO_DEFAULT_PROVIDED)
+        define_method(name) { attributes[name] || get_default(default, NO_DEFAULT_PROVIDED) }
+      end
+
+      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
+        end
+      end
+
+      private
+
+      NO_DEFAULT_PROVIDED = Object.new
+      private_constant :NO_DEFAULT_PROVIDED
+
+    end # class_methods
+  end
+end

data/lib/act_form/combinable.rb

@@ -1,5 +1,4 @@
 require 'active_support/concern'
-require 'act_form/utils'
 
 module ActForm
   module Combinable
@@ -10,40 +9,38 @@ module ActForm
       self._forms = []
     end
 
+    def valid?(context = nil)
+      super
+      combined_forms_valid?(context)
+      errors.empty?
+    end
+
+    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
+      end
+    end
+
     class_methods do
 
       def combine(*forms)
         forms.each do |form_class|
-          raise ArgumentError, 'Can not combine itself' if form_class == self
+          raise ArgumentError, "can't combine itself" if form_class == self
 
           next if self._forms.include?(form_class)
 
+          self.merge_attribute_set_from(form_class)
           self._forms << form_class
-
-          self.attribute_set.merge(form_class.attribute_set)
-
-          Utils.merge(self._validators, form_class._validators)
-
-          method_name = form_class.model_name.singular
-          define_method(method_name) { form_class.new(attributes) }
-          form_class._validate_callbacks.each do |callback|
-            filter = callback.filter
-            if filter.is_a?(Symbol) || filter.is_a?(String)
-              class_eval <<-RUBY, __FILE__, __LINE__ + 1
-                def #{filter}
-                  form = #{method_name}
-                  form.send(:#{filter})
-                  form.errors.messages.each do |attr, _errors|
-                    _errors.each { |err| errors.add(attr, err) }
-                  end
-                end
-                private :#{filter}
-              RUBY
-            end
-          end
-          self._validate_callbacks.append *form_class._validate_callbacks
-        end # forms.each
-      end # combine
+        end
+      end
 
     end
 

data/lib/act_form/locale/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      required: "require a value"

data/lib/act_form/merge.rb

@@ -0,0 +1,15 @@
+module ActForm
+  module Merge
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def merge_attribute_set_from(other)
+        other.attribute_set.each do |attr_name, arr|
+          cast_type, options = arr
+          attribute attr_name, cast_type, options
+        end
+      end
+    end
+
+  end
+end

data/lib/act_form/model.rb

@@ -1,27 +1,44 @@
-require 'active_support/core_ext/object/deep_dup'
 require 'active_model'
-require 'virtus'
+require 'act_form/attributes'
+require 'act_form/merge'
 require 'act_form/combinable'
 
 module ActForm
   module Model
     extend ActiveSupport::Concern
-    include ActiveModel::Validations
-    include ActiveModel::Conversion
+    include ActiveModel::Model
+    include Attributes
+    include Merge
 
     included do
-      extend ActiveModel::Naming
-      extend ActiveModel::Translation
-      include Virtus.model
+      set_callback :validate, :before, :validate_required_attributes
+    end
+
+    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)
+      assign_attributes _attrs.merge(attrs)
     end
 
     def sync(target)
-      self.class.attribute_set.map(&:name).each do |attr|
-        target.public_send("#{attr}=", public_send(attr)) if target.respond_to?(attr)
+      self.class.attribute_set.keys.each do |attr|
+        next unless target.respond_to?(attr)
+        target.public_send "#{attr}=", public_send(attr)
       end
     end
 
-    def save(target)
+    def save(target = nil)
+      target ||= @record
       if valid?
         sync(target)
         @persisted = target.save
@@ -34,14 +51,25 @@ module ActForm
       !!@persisted
     end
 
+    private
+
+    def validate_required_attributes
+      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?
+          errors.add(attr_name, :required)
+        end
+      end
+      throw(:abort) unless errors.empty?
+    end
+
     class_methods do
-      private
       def inherited(child_class)
-        child_class._validators = self._validators.deep_dup
-        child_class._validate_callbacks = self._validate_callbacks.deep_dup
         child_class.include Combinable
         super
       end
-    end
+    end # class_methods
   end
 end

data/lib/act_form/runnable.rb

@@ -1,6 +1,7 @@
 require 'active_support/concern'
 
 module ActForm
+  class RunError < StandardError; end
   module Runnable
     extend ActiveSupport::Concern
 
@@ -12,6 +13,10 @@ module ActForm
       def run(*args)
         new(*args).run
       end
+
+      def run!(*args)
+        new(*args).run!
+      end
     end
 
     def has_errors?
@@ -26,6 +31,16 @@ module ActForm
       self
     end
 
+    def run!
+      if valid?
+        @result    = perform
+        @performed = true
+        result
+      else
+        raise RunError, 'Verification failed'
+      end
+    end
+
     def perform; end
 
     def success?

data/lib/act_form/type.rb

@@ -0,0 +1,13 @@
+require 'active_model/type'
+
+module ActForm
+  module Type
+    class Object < ActiveModel::Type::Value
+      def type
+        :object
+      end
+    end
+  end
+end
+
+ActiveModel::Type.register(:object, ActForm::Type::Object)

data/lib/act_form/version.rb

@@ -1,3 +1,3 @@
 module ActForm
-  VERSION = "0.1.0"
+  VERSION = '0.4.0'
 end

metadata

@@ -1,83 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: act_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - zires
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2020-07-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: virtus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: The simple way to create form objects or command/service objects with
   ActiveModel.
 email:
@@ -87,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -94,19 +69,19 @@ files:
 - Rakefile
 - act_form.gemspec
 - lib/act_form.rb
+- lib/act_form/attributes.rb
 - lib/act_form/combinable.rb
+- lib/act_form/locale/en.yml
+- lib/act_form/merge.rb
 - lib/act_form/model.rb
-- lib/act_form/railtie.rb
 - lib/act_form/runnable.rb
-- lib/act_form/utils.rb
+- lib/act_form/type.rb
 - lib/act_form/version.rb
-- lib/generators/act_form/install_generator.rb
-- lib/generators/templates/forms/record_form.rb
-homepage: https://github.com/simple-and-powerful/form-model
+homepage: https://github.com/simple-and-powerful/act-form
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,9 +96,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.7
+signing_key:
 specification_version: 4
 summary: A simple way to create form/command/service objects.
 test_files: []

data/lib/act_form/railtie.rb

@@ -1,7 +0,0 @@
-module ActForm
-  class Railtie < ::Rails::Railtie
-    generators do
-      require 'generators/form_model/install_generator'
-    end
-  end
-end

data/lib/act_form/utils.rb

@@ -1,11 +0,0 @@
-module ActForm
-  class Utils
-    class << self
-      def merge(a_validators, b_validators)
-        b_validators.each do |k, v|
-          a_validators[k] ? (a_validators[k] += v) : (a_validators[k] = v)
-        end
-      end # merge
-    end
-  end
-end

data/lib/generators/act_form/install_generator.rb

@@ -1,12 +0,0 @@
-module ActForm
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path('../../templates', __FILE__)
-
-      desc 'Create the forms dir and copy record_form.rb'
-      def copy_initializer
-        directory 'forms', 'app/forms'
-      end
-    end
-  end
-end

data/lib/generators/templates/forms/record_form.rb

@@ -1,2 +0,0 @@
-class RecordForm < ActForm::RecordForm
-end