application_form 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05c6c488f4f25253c2fb3889eda3776207218a8a1bfb7101b18e9fc38fc5e663
+  data.tar.gz: e8c073b39558f58391202b6d7353cc4be57e7c4df01987f31b1b624012fd010f
+SHA512:
+  metadata.gz: e174c55c53544fd420808519c705f546fe166a44965c279a09ac25ccbd52c47e09329c06031aa3f1e143987400678322f870fa5736717f68c7397f7579097b86
+  data.tar.gz: d1f64700776c503711dc40a6ee4530963058cac534bfd49473a5567c01b2bda117b375f223eeedb434196ee3fb2275ca35db7ad6c165f7ee3da14138383f6552

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.5, 2.6, 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/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# 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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mokevnin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 mokevnin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,19 @@
+install:
+	bin/setup
+
+console:
+	bin/console
+
+test:
+	bundle exec rake test
+
+lint:
+	bundle exec rubocop -A
+
+release:
+	bundle exec rake release
+
+build:
+	bundle exec rake build
+
+.PHONY: test

data/README.md

@@ -0,0 +1,93 @@
+# ApplicationForm
+
+![github action status](https://github.com/rbbr_io/application_form/workflows/main/badge.svg)
+
+Painless forms for ActiveRecord. Based on Inheritance. Included:
+
+* Strong parameters
+* Validation (based on the model validation)
+* Data normalization
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'application_form'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install application_form
+
+## Usage
+
+1. Create directory *app/forms*
+1. Add Form class for a model
+1. Add permitted params inside the class
+1. Use it as a normal model (without strong_params)
+
+## Generator
+
+Use the supplied generator to generate forms:
+
+    $ rails g application_form:form sign_up --model=user
+
+or with namespace model
+
+    $ rails g application_form:form admin_post --model=blog/post
+
+### Example
+
+```ruby
+# app/forms/user_sign_up_form.rb
+class UserSignUpForm < User
+  include ApplicationForm
+
+  # list all the permitted params
+  permit :first_name, :email, :password
+
+  # add validation if necessary
+  # they will be merged with base class' validation
+  validates :password, presence: true
+
+  # optional data normalization
+  def email=(email)
+    if email.present?
+      write_attribute(:email, email.downcase)
+    else
+      super
+    end
+  end
+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):
+
+```ruby
+user = User.find(params[:id])
+form = user.becomes(UserSignUpForm)
+```
+
+## 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.
+
+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/rbbr_io/application_form. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rbbr_io/application_form/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ApplicationForm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rbbr_io/application_form/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# 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']
+end
+
+task default: :test

data/application_form.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/application_form/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'application_form'
+  spec.version       = ApplicationForm::VERSION
+  spec.authors       = ['Kirill Mokevnin', 'Ivan Nemytchenko']
+  spec.email         = ['nemytchenko@gmail.com']
+
+  spec.summary       = 'Painless forms for ActiveRecord'
+  spec.description   = 'Lightweight inheritance based forms solution'
+  spec.homepage      = 'https://github.com/rbbr_io/application_form'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rbbr_io/application_form.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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activesupport', '>= 3')
+
+  spec.add_development_dependency('actionpack', '>= 5')
+  spec.add_development_dependency('activemodel', '>= 5')
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'application_form'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/application_form.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'application_form/version'
+require 'active_support/concern'
+
+module ApplicationForm
+  class Error < StandardError; end
+
+  extend ActiveSupport::Concern
+
+  included do
+    prepend Included
+    # raise superclass.inspect
+    # parent.extend ActiveModel::Naming
+  end
+
+  module Included
+    def initialize(attrs = {})
+      permitted_attrs = permit_attrs(attrs)
+      super(permitted_attrs)
+    end
+  end
+
+  module ClassMethods
+    delegate :sti_name, to: :superclass
+    delegate :human_attribute_name, to: :superclass
+    # NOTE: too many side effects if it is enabled
+    # examples: form names, translations
+    # 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
+  end
+end

data/lib/application_form/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApplicationForm
+  VERSION = '0.4.0'
+end

data/lib/generators/application_form/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a form for a model with the given name.
+
+Example:
+    rails generate application_form:form sign_up --model=user
+
+    This will create:
+        app/forms/user_form.rb

data/lib/generators/application_form/form_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ApplicationForm
+  module Generators
+    class FormGenerator < ::Rails::Generators::NamedBase
+      class_option :model, type: :string
+      source_root File.expand_path('templates', __dir__)
+
+      def create_form
+        template 'form.rb', File.join('app/forms', class_path, "#{file_name}_form.rb")
+      end
+    end
+  end
+end

data/lib/generators/application_form/templates/form.rb

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name %>Form < <%= options['model'].classify %>
+  include ApplicationForm
+end
+<% end -%>

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: application_form
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Kirill Mokevnin
+- Ivan Nemytchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Lightweight inheritance based forms solution
+email:
+- nemytchenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- application_form.gemspec
+- bin/console
+- bin/setup
+- lib/application_form.rb
+- lib/application_form/version.rb
+- lib/generators/application_form/USAGE
+- lib/generators/application_form/form_generator.rb
+- lib/generators/application_form/templates/form.rb
+homepage: https://github.com/rbbr_io/application_form
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rbbr_io/application_form
+  source_code_uri: https://github.com/rbbr_io/application_form.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Painless forms for ActiveRecord
+test_files: []