act_form 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d93ee18c0209358b5bfdd5f8bab5c31b9065ed223a901de2b5a45db192c7eb7a
-  data.tar.gz: 6db591154d02ccb5407ee4cb615de83ef1337891cd8dda2f611c7bb6fe4b8522
+  metadata.gz: cab0f4f82ad6b6e33c6375695d4a74b54e26e3039583e2b1949ff6690de56832
+  data.tar.gz: b6f3dcdabe79a4a0777cae6e38ea4ce4d7c969eae81c3404abc3739f9c7c5026
 SHA512:
-  metadata.gz: 5baa5bcdd152bbc018e1d9faa6df224290af67c98064297636e3fedc69b38c626dd0a442076a32ccac199a88915a7a4725ed076c97af8fce7a16f48565b1b78e
-  data.tar.gz: dccf8fa34e9e10965207b87227ba687926732c27086f59bbe0e5e82bd2d056521ef6399fd7558457a2b3cb9ad8b36cf72dd3489d667ac5ee90dd68634dd7daa9
+  metadata.gz: f4746eb8bc9a2483114fce51de1f71d69c68a7cade4c0508cc8506126f73efb6a77703f3f242730ed5027f160dd13cf03b48d986958d9b7b7a0d427fd00da344
+  data.tar.gz: 4434f45ef372a6bfaca7e9627aabff63c1054e78d69bc9b694a37fdc255b62715aa50d5ea12e897615b994d0c12e7ce5d4268264ab096d25db5897a0aec8724e

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+# 0.5.0
+* [Feature] issue#7 add more attribute type
+* [Feature] issue#3 add `combine` DEPRECATION
+
+With the power of `dry-schema`, ActForm now can support all the features of `dry-schema`, like:
+
+```ruby
+class UserForm < ActForm::Base
+  params do
+    required(:name).filled.desc('Name')
+    optional(:age).value(:integer).desc('Age')
+    optional(:address).desc('Address')
+    optional(:nickname).default('nick').desc('Nick')
+    # below will support in the future
+    # attribute :desc, default: ->{ 'desc' }
+  end
+end
+```
+
+Add we can integrate with `grape` easyly.
+
+```ruby
+module WorkWithGrapeSpec
+  class API < Grape::API
+    format :json
+
+    contract UserForm.contract
+    get '/foo' do
+      'hello world'
+    end
+
+    contract FooService.contract do
+      required(:desc).filled
+    end
+    get '/bar' do
+      'hello world'
+    end
+  end
+end
+```
+
 # 0.4.4
 * [Fix] fix `setup` run before `required` validation
 

data/Gemfile

@@ -4,5 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'grape', '>= 1.8.0'
   gem 'pry'
+  gem 'rack-test', '~> 2.1'
 end

data/README.md

@@ -2,6 +2,45 @@
 
 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.
 
+## About v0.5.0
+
+With the power of `dry-schema`, ActForm now can support all the features of `dry-schema`, like:
+
+```ruby
+class UserForm < ActForm::Base
+  params do
+    required(:name).filled.desc('Name')
+    optional(:age).value(:integer).desc('Age')
+    optional(:address).desc('Address')
+    optional(:nickname).default('nick').desc('Nick')
+    # below will support in the future
+    # attribute :desc, default: ->{ 'desc' }
+  end
+end
+```
+
+Add we can integrate with `grape` easyly.
+
+```ruby
+module WorkWithGrapeSpec
+  class API < Grape::API
+    format :json
+
+    contract UserForm.contract
+    get '/foo' do
+      'hello world'
+    end
+
+    contract UserForm.contract do
+      required(:desc).filled
+    end
+    get '/bar' do
+      'hello world'
+    end
+  end
+end
+```
+
 ## Usage
 
 #### API - `attribute`
@@ -191,14 +230,17 @@ Or install it yourself as:
 
     $ gem install act_form
 
-
 ## Development
 
 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).
 
+### Unit Tests
+
+    $ bundle exec rake test
+
 ## Contributing
 
-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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/simple-and-powerful/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

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'act_form/version'
 
@@ -9,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['zires']
   spec.email         = ['zshuaibin@gmail.com']
 
-  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.summary       = 'A simple way to create form/command/service objects.'
+  spec.description   = 'The simple way to create form objects or command/service objects with ActiveModel.'
   spec.homepage      = 'https://github.com/simple-and-powerful/act-form'
   spec.license       = 'MIT'
 
@@ -27,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activemodel', '>= 5.0.0'
+  spec.add_runtime_dependency 'dry-schema', '>= 1.13.4'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/act_form/combinable.rb

@@ -34,7 +34,9 @@ module ActForm
     end
 
     class_methods do
+      # <b>DEPRECATED:</b> Please use <tt>ruby pure module</tt> instead.
       def combine(*forms)
+        warn '[DEPRECATION] `combine` is deprecated and will be removed in future versions. Instead, please use a pure Ruby module approach. For more details, refer to [link to migration guide].' # rubocop:disable Layout/LineLength
         forms.each do |form_class|
           raise ArgumentError, "can't combine itself" if form_class == self
 

data/lib/act_form/locale/zh-CN.yml

@@ -0,0 +1,5 @@
+zh-CN:
+  errors:
+    messages:
+      required: "是一个必填项"
+

data/lib/act_form/merge.rb

@@ -8,7 +8,7 @@ module ActForm
       def merge_attribute_set_from(other)
         other.attribute_set.each do |attr_name, arr|
           cast_type, options = arr
-          attribute attr_name, cast_type, options
+          attribute attr_name, cast_type, **options
         end
       end
     end

data/lib/act_form/model.rb

@@ -2,6 +2,7 @@
 
 require 'active_model'
 require 'act_form/attributes'
+require 'act_form/schema'
 require 'act_form/merge'
 require 'act_form/combinable'
 
@@ -11,10 +12,12 @@ module ActForm
     include ActiveModel::Model
     include ActiveModel::Validations::Callbacks
     include Attributes
+    include Schema
     include Merge
 
     included do
       set_callback :validation, :before, :validate_required_attributes
+      set_callback :validation, :before, :validate_contract
     end
 
     def initialize(attrs = {})
@@ -71,6 +74,17 @@ module ActForm
       throw(:abort) unless errors.empty?
     end
 
+    def validate_contract
+      return if self.class._schema.nil?
+
+      result = self.class._schema.validate(self.attributes)
+      return if result.success?
+
+      result.errors(full: true).each do |err|
+        errors.add(err.path.first, :invalid, message: err.text)
+      end
+    end
+
     class_methods do
       def inherited(child_class)
         child_class.include Combinable

data/lib/act_form/schema/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ActForm
+  module Schema
+    class Base # rubocop:disable Style/Documentation
+      attr_reader :ins
+
+      def initialize(*parents, &block)
+        parent_arr = parents.map(&:contract)
+        @ins = ::Dry::Schema.Params(parent: parent_arr, &block)
+        @json = @ins.json_schema(loose: true)
+        @defaults = @ins.schema_dsl.defaults
+        @descriptions = @ins.schema_dsl.descriptions
+      end
+
+      def each # rubocop:disable Metrics/AbcSize
+        @ins.key_map.each do |key|
+          name = key.name.to_sym
+          opts = {
+            required: @json[:required].include?(key.name)
+          }
+          opts[:default] = @defaults[name] if @defaults.key?(name)
+          t = @json[:properties].dig(name, :type)
+          t = if t.is_a?(Array)
+                :object
+              else
+                t ? t.to_sym : :object
+              end
+          opts[:type] = t
+          yield name, opts
+        end
+      end
+
+      def validate(attrs)
+        _attrs = {}.merge!(attrs)
+        _attrs.merge!(@defaults)
+        @ins.call(_attrs)
+      end
+    end
+  end
+end

data/lib/act_form/schema/extensions.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActForm
+  module Schema
+    module Extensions
+      # Add defaults and descriptions to schema_dsl
+      module DSLExtension
+        def defaults
+          @_defaults ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
+        end
+
+        def descriptions
+          @_descriptions ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
+        end
+      end
+
+      # Add default and desc macros
+      module MacrosExtension
+        def default(value)
+          schema_dsl.defaults[name] = value
+          self
+        end
+
+        def desc(value)
+          schema_dsl.descriptions[name] = value
+        end
+      end
+    end
+  end
+end

data/lib/act_form/schema.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActForm
+  module Schema # rubocop:disable Style/Documentation
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_schema, instance_accessor: false
+      self._schema = nil
+    end
+
+    module ClassMethods # rubocop:disable Style/Documentation
+      def contract
+        self._schema.ins
+      end
+
+      def params(*parents, &block)
+        self._schema = Base.new(*parents, &block)
+        self._schema.each { |k, opts| self.attribute(k, **opts) }
+      end
+    end
+  end
+end

data/lib/act_form/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActForm
-  VERSION = '0.4.4'
+  VERSION = '0.5.0'
 end

data/lib/act_form.rb

@@ -4,6 +4,14 @@ require 'act_form/version'
 require 'act_form/model'
 require 'act_form/runnable'
 
+require 'dry/schema'
+Dry::Schema.load_extensions(:json_schema)
+
+require 'act_form/schema/base'
+require 'act_form/schema/extensions'
+::Dry::Schema::DSL.include(::ActForm::Schema::Extensions::DSLExtension)
+::Dry::Schema::Macros::DSL.include(::ActForm::Schema::Extensions::MacrosExtension)
+
 module ActForm
   class Base
     include Model
@@ -17,3 +25,4 @@ module ActForm
 end
 
 I18n.load_path << "#{File.dirname(__FILE__)}/act_form/locale/en.yml"
+I18n.load_path << "#{File.dirname(__FILE__)}/act_form/locale/zh-CN.yml"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_form
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - zires
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,16 +87,20 @@ files:
 - lib/act_form/attributes.rb
 - lib/act_form/combinable.rb
 - lib/act_form/locale/en.yml
+- lib/act_form/locale/zh-CN.yml
 - lib/act_form/merge.rb
 - lib/act_form/model.rb
 - lib/act_form/runnable.rb
+- lib/act_form/schema.rb
+- lib/act_form/schema/base.rb
+- lib/act_form/schema/extensions.rb
 - lib/act_form/type.rb
 - lib/act_form/version.rb
 homepage: https://github.com/simple-and-powerful/act-form
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.1
+signing_key:
 specification_version: 4
 summary: A simple way to create form/command/service objects.
 test_files: []