active_form_model 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f0169a331b87482d384004270960ba223bea6c9155f1f90c81ff62263f635a
-  data.tar.gz: 9941258627c2434915e1e009fcb0f0636490ffff31d88dff22bc1925fa069b47
+  metadata.gz: 3fa5b1a5d67328998e1001805d4ff580315861877e7d6bd423de7dc280fa80a9
+  data.tar.gz: 95779536fb96ffa77cf4bf984c58ab992fedb5dfa1e5c8fa5eef6455f076ffd1
 SHA512:
-  metadata.gz: 4259f13547d8b20608b99678863b885605f9b028cab61f0c18ef7317ae43dd5f29ad8664d4a18c55880451b63ffe2fcc0ef16901553ee604975197abc84338f7
-  data.tar.gz: 2dd3e719e35c7480611d48f1e77ad3582f7fb2612dd2b0f5c525153559d863e36b55f974e459330c0e63cddea7d7f580b36db455da0bc83e4f41d2694a3e2aa6
+  metadata.gz: 2c192c1f9f633ebb23ff7a0e16c4186f251e31063103124f11d2a51b73783077c0336478686f38b517d6ac67a522ce4eac9e72cf9c68d27019659d08363f9353
+  data.tar.gz: eb21b19c8e05a3409699d3f56d8bce70d84e3d2b0f27ea1ec1fa7cd7dc9f1aed4d39e8fcaf81a444f9ccc37a3131bacb20322a7eaaa544d9262308299d38368c

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: main
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.7, '3.0', head]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: run test
+      run: make test

data/.rubocop.yml

@@ -0,0 +1,20 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+require:
+ - rubocop-minitest
+ - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -1,7 +1,16 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in active_form_model.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
+gem 'minitest'
+
+gem 'rake'
+
+gem 'rubocop'
+
+gem 'minitest-power_assert'
+gem 'rubocop-minitest'
+gem 'rubocop-rake'

data/Makefile

@@ -7,6 +7,9 @@ console:
 test:
 	bundle exec rake test
 
+lint:
+	bundle exec rubocop -A
+
 release:
 	bundle exec rake release
 

data/README.md

@@ -1,5 +1,7 @@
 # ActiveFormModel
 
+[![github action status](https://github.com/Hexlet/active_form_model/workflows/main/badge.svg)](https://actions-badge.atrox.dev/hexlet/hexlet-cv/goto)
+
 Painless forms for ActiveRecord. Based on Inheritance. Included:
 
 * Strong parameters
@@ -47,7 +49,7 @@ class UserSignUpForm < User
   include ActiveFormModel
 
   # list all the permitted params
-  permit :first_name, :email, :password
+  fields :first_name, :email, :password
 
   # add validation if necessary
   # they will be merged with base class' validation
@@ -64,13 +66,45 @@ class UserSignUpForm < User
 end
 ```
 
-In some cases it is necessary to use ActiveRecord object directly without form. For such cases conveniently to use method `become()` (built-in ActiveRecord):
+In some cases it is necessary to use ActiveRecord object directly without form. For such cases conveniently to use method `becomes()` (built-in ActiveRecord):
 
 ```ruby
 user = User.find(params[:id])
 form = user.becomes(UserSignUpForm)
 ```
 
+If you want to build virtual form that is not tied to any class:
+
+```ruby
+# frozen_string_literal: true
+
+class SignInForm
+  include ActiveFormModel::Virtual
+
+  fields :email, :password
+
+  validates :email, presence: true
+  validates :password, presence: true
+  validate :user_exists, :user_can_sign_in
+
+  def user_can_sign_in
+    errors.add(:password, :cannot_sign_in) if password.present? && !user&.valid_password?(password)
+  end
+
+  def user_exists
+    errors.add(:email, :user_does_not_exist_html) if email.present? && !user
+  end
+
+  def user
+    @user ||= User.find_by(email: email)
+  end
+
+  def email=(value)
+    @email = value.downcase
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/active_form_model.gemspec

@@ -1,34 +1,36 @@
+# frozen_string_literal: true
+
 require_relative 'lib/active_form_model/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "active_form_model"
+  spec.name          = 'active_form_model'
   spec.version       = ActiveFormModel::VERSION
-  spec.authors       = ["Kirill"]
-  spec.email         = ["mokevnin@gmail.com"]
+  spec.authors       = ['Kirill']
+  spec.email         = ['mokevnin@gmail.com']
 
-  spec.summary       = %q{Painless forms for ActiveRecord}
-  spec.description   = %q{Based on inheritance}
-  spec.homepage      = "https://github.com/Hexlet/active_form_model"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Painless forms for ActiveRecord'
+  spec.description   = 'Based on inheritance'
+  spec.homepage      = 'https://github.com/Hexlet/active_form_model'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/Hexlet/form-model.git"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Hexlet/form-model.git'
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency("activesupport", ">= 3")
+  spec.add_dependency('activesupport', '>= 3')
 
-  spec.add_development_dependency("activemodel", ">= 5")
-  spec.add_development_dependency("actionpack", ">= 5")
+  spec.add_development_dependency('actionpack', '>= 5')
+  spec.add_development_dependency('activemodel', '>= 5')
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "active_form_model"
+require 'bundler/setup'
+require 'active_form_model'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "active_form_model"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/active_form_model/permittable.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'active_support/deprecation/reporting'
+
+module ActiveFormModel
+  module Permittable
+    extend ActiveSupport::Concern
+
+    included do
+      prepend Prepended
+    end
+
+    module Prepended
+      def initialize(attrs = {})
+        permitted_attrs = permit_attrs(attrs)
+        super(permitted_attrs)
+      end
+    end
+
+    class_methods do
+      def fields(*args)
+        @_permitted_args = args
+      end
+
+      def permit(*args)
+        ActiveSupport::Deprecation.warn('permit is deprecated in favor of fields')
+        @_permitted_args = args
+      end
+
+      def _permitted_args
+        @_permitted_args || (superclass.respond_to?(:_permitted_args) && superclass._permitted_args) || []
+      end
+    end
+
+    def update(attrs = {})
+      permitted_attrs = permit_attrs(attrs)
+      super(permitted_attrs)
+    end
+
+    def update!(attrs = {})
+      permitted_attrs = permit_attrs(attrs)
+      super(permitted_attrs)
+    end
+
+    def assign_attributes(attrs = {})
+      permitted_attrs = permit_attrs(attrs)
+      super(permitted_attrs)
+    end
+
+    private
+
+    def permit_attrs(attrs)
+      attrs.respond_to?(:permit) ? attrs.send(:permit, self.class._permitted_args) : attrs
+    end
+  end
+end

data/lib/active_form_model/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveFormModel
-  VERSION = "0.3.0"
+  VERSION = '0.4.1'
 end

data/lib/active_form_model/virtual.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveFormModel
+  module Virtual
+    extend ActiveSupport::Concern
+
+    include Permittable
+    include ActiveModel::Model
+
+    class_methods do
+      def fields(*attrs)
+        send(:attr_accessor, *attrs)
+        super(attrs)
+      end
+    end
+  end
+end

data/lib/active_form_model.rb

@@ -1,52 +1,24 @@
+# frozen_string_literal: true
+
 require 'active_form_model/version'
 require 'active_support/concern'
 
 module ActiveFormModel
+  autoload :Virtual, 'active_form_model/virtual'
+  autoload :Permittable, 'active_form_model/permittable'
+
   class Error < StandardError; end
 
   extend ActiveSupport::Concern
 
-  included do
-    prepend Included
-  end
-
-  module Included
-    def initialize(attrs = {})
-      permitted_attrs = permit_attrs(attrs)
-      super(permitted_attrs)
-    end
-  end
+  include Permittable
 
-  module ClassMethods
+  class_methods do
     delegate :sti_name, to: :superclass
     delegate :human_attribute_name, to: :superclass
-    # delegate :name, to: :superclass
-
-    def permit(*args)
-      @_permitted_args = args
-    end
-
-    def _permitted_args
-      @_permitted_args || (superclass.respond_to?(:_permitted_args) && superclass._permitted_args) || []
-    end
-  end
-
-  def update(attrs = {})
-    permitted_attrs = permit_attrs(attrs)
-    super(permitted_attrs)
-  end
-
-  def update!(attrs = {})
-    permitted_attrs = permit_attrs(attrs)
-    super(permitted_attrs)
-  end
-
-  def assign_attributes(attrs = {})
-    permitted_attrs = permit_attrs(attrs)
-    super(permitted_attrs)
-  end
 
-  def permit_attrs(attrs)
-    attrs.respond_to?(:permit) ? attrs.send(:permit, self.class._permitted_args) : attrs
+    # NOTE: too many side effects if it is enabled
+    # examples: form names, translations
+    # delegate :name, to: :superclass
   end
 end

data/lib/generators/active_form_model/form_generator.rb

@@ -7,7 +7,7 @@ module ActiveFormModel
       source_root File.expand_path('templates', __dir__)
 
       def create_form
-        template 'form.rb', File.join('app/forms', class_path, "#{file_name}_form.rb")
+        template 'form.rb', File.join('app/forms', class_path, "#{file_name}_form.erb")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_form_model
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Kirill
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,8 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -71,10 +72,12 @@ files:
 - bin/console
 - bin/setup
 - lib/active_form_model.rb
+- lib/active_form_model/permittable.rb
 - lib/active_form_model/version.rb
+- lib/active_form_model/virtual.rb
 - lib/generators/active_form_model/USAGE
 - lib/generators/active_form_model/form_generator.rb
-- lib/generators/active_form_model/templates/form.rb
+- lib/generators/active_form_model/templates/form.erb
 homepage: https://github.com/Hexlet/active_form_model
 licenses:
 - MIT
@@ -89,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Painless forms for ActiveRecord

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.4