act_form 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50804b31cfd1b52553e16af190b4f8471cdd6e2f
-  data.tar.gz: 6392da038a5fdf1ef6f9e70376b5a0efdf791d30
+  metadata.gz: 439172cc129e1aaa79e835d567a359f643010de0
+  data.tar.gz: af5f2aa3c281e2f5a6b6d2f970700a9105aecd85
 SHA512:
-  metadata.gz: 7cbf1b8b3a10db0f6d9569953593267a1de6935ed7a40ea20e6a902aac71857559f0c5d7cd1f2dfc5bd7dc53166d342589de5006996d1bc605fe9fc10346e1dc
-  data.tar.gz: 251cef49ed01f2133b23cbac6c81b07c45807aee3853e1d1295901723d0603f7209fb78bece6923e755c88382bad6fb03a587db6a909a87bed289a0156da5900
+  metadata.gz: 5e069064c6100585124fa64e66594bbd0a055aaac0b31a809dd90d04ec1450cfb78c0627c0b55f96fc71573fa81f0a225bb721046a968aee56854e6fd63f47dd
+  data.tar.gz: 18b92c9422e7c4585ada6002e5fe4ab0e9e3e9733864caebc7f02780abf3cea6881382bcb0980626a0d560a157be677a9bad139595b4037c95d73f3a47dc992a

data/README.md

@@ -1,9 +1,170 @@
 # 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 then `required` and `validates_presence_of`
+`required` run before validation, 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)
+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.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
+
+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 +179,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,12 +23,10 @@ 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', '>= 5.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/act_form.rb

@@ -7,28 +7,10 @@ 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
     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,57 @@
+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
+
+      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,39 @@
-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
+
+    # Record must respond_to attributes method
+    def init_by(record, **attrs)
+      @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 +46,25 @@ module ActForm
       !!@persisted
     end
 
+    private
+
+    def validate_required_attributes
+      self.class.attribute_set.each do |attr_name, arr|
+        _, options = arr
+        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/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.2.0'
 end

metadata

@@ -1,55 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: act_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - zires
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2016-12-13 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'
+        version: '5.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'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,15 +74,15 @@ 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: {}

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