├── spec ├── support │ ├── test_app │ │ ├── log │ │ │ └── .keep │ │ ├── lib │ │ │ └── assets │ │ │ │ └── .keep │ │ ├── public │ │ │ ├── favicon.ico │ │ │ ├── apple-touch-icon.png │ │ │ ├── apple-touch-icon-precomposed.png │ │ │ ├── 500.html │ │ │ ├── 422.html │ │ │ └── 404.html │ │ ├── app │ │ │ ├── assets │ │ │ │ ├── images │ │ │ │ │ └── .keep │ │ │ │ ├── javascripts │ │ │ │ │ ├── channels │ │ │ │ │ │ └── .keep │ │ │ │ │ ├── cable.js │ │ │ │ │ └── application.js │ │ │ │ ├── config │ │ │ │ │ └── manifest.js │ │ │ │ └── stylesheets │ │ │ │ │ └── application.css │ │ │ ├── models │ │ │ │ ├── concerns │ │ │ │ │ └── .keep │ │ │ │ ├── account.rb │ │ │ │ ├── application_record.rb │ │ │ │ ├── plan.rb │ │ │ │ └── user.rb │ │ │ ├── controllers │ │ │ │ ├── concerns │ │ │ │ │ └── .keep │ │ │ │ └── application_controller.rb │ │ │ ├── views │ │ │ │ └── layouts │ │ │ │ │ ├── mailer.text.erb │ │ │ │ │ ├── mailer.html.erb │ │ │ │ │ └── application.html.erb │ │ │ ├── helpers │ │ │ │ └── application_helper.rb │ │ │ ├── jobs │ │ │ │ └── application_job.rb │ │ │ ├── channels │ │ │ │ └── application_cable │ │ │ │ │ ├── channel.rb │ │ │ │ │ └── connection.rb │ │ │ ├── mailers │ │ │ │ └── application_mailer.rb │ │ │ └── forms │ │ │ │ └── signup_form.rb │ │ ├── bin │ │ │ ├── rake │ │ │ ├── bundle │ │ │ ├── rails │ │ │ ├── yarn │ │ │ ├── update │ │ │ └── setup │ │ ├── config │ │ │ ├── spring.rb │ │ │ ├── environment.rb │ │ │ ├── routes.rb │ │ │ ├── initializers │ │ │ │ ├── session_store.rb │ │ │ │ ├── mime_types.rb │ │ │ │ ├── filter_parameter_logging.rb │ │ │ │ ├── application_controller_renderer.rb │ │ │ │ ├── cookies_serializer.rb │ │ │ │ ├── backtrace_silencers.rb │ │ │ │ ├── wrap_parameters.rb │ │ │ │ ├── assets.rb │ │ │ │ ├── inflections.rb │ │ │ │ ├── new_framework_defaults.rb │ │ │ │ ├── content_security_policy.rb │ │ │ │ └── new_framework_defaults_5_2.rb │ │ │ ├── boot.rb │ │ │ ├── cable.yml │ │ │ ├── database.yml │ │ │ ├── application.rb │ │ │ ├── locales │ │ │ │ └── en.yml │ │ │ ├── secrets.yml │ │ │ ├── storage.yml │ │ │ ├── environments │ │ │ │ ├── test.rb │ │ │ │ ├── development.rb │ │ │ │ └── production.rb │ │ │ └── puma.rb │ │ ├── config.ru │ │ ├── db │ │ │ ├── migrate │ │ │ │ ├── 20161030205226_create_plans.rb │ │ │ │ ├── 20161030205450_create_accounts.rb │ │ │ │ └── 20161030204225_create_users.rb │ │ │ └── schema.rb │ │ └── Rakefile │ ├── factories │ │ ├── plan.rb │ │ └── user.rb │ ├── shoulda.rb │ └── factory_bot.rb ├── spec_helper.rb ├── rails_helper.rb ├── integration │ └── forms │ │ └── signup_form_spec.rb └── unit │ └── base_form │ └── form_spec.rb ├── .rspec ├── lib ├── base_form │ ├── version.rb │ └── form.rb └── base_form.rb ├── Gemfile ├── .gitignore ├── Rakefile ├── .codeclimate.yml ├── bin ├── rspec └── rubocop ├── .travis.yml ├── MIT-LICENSE ├── base_form.gemspec ├── .rubocop.yml ├── Gemfile.lock └── README.md /spec/support/test_app/log/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/lib/assets/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/public/favicon.ico: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --color 2 | --require spec_helper 3 | -------------------------------------------------------------------------------- /spec/support/test_app/app/assets/images/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/app/models/concerns/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/app/controllers/concerns/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/public/apple-touch-icon.png: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/app/assets/javascripts/channels/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/public/apple-touch-icon-precomposed.png: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /spec/support/test_app/app/views/layouts/mailer.text.erb: -------------------------------------------------------------------------------- 1 | <%= yield %> 2 | -------------------------------------------------------------------------------- /spec/support/test_app/app/helpers/application_helper.rb: -------------------------------------------------------------------------------- 1 | module ApplicationHelper 2 | end 3 | -------------------------------------------------------------------------------- /spec/support/test_app/app/jobs/application_job.rb: -------------------------------------------------------------------------------- 1 | class ApplicationJob < ActiveJob::Base 2 | end 3 | -------------------------------------------------------------------------------- /lib/base_form/version.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module BaseForm 4 | VERSION = '0.1.4' 5 | end 6 | -------------------------------------------------------------------------------- /spec/support/test_app/bin/rake: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | require_relative '../config/boot' 3 | require 'rake' 4 | Rake.application.run 5 | -------------------------------------------------------------------------------- /spec/support/test_app/app/models/account.rb: -------------------------------------------------------------------------------- 1 | class Account < ApplicationRecord 2 | belongs_to :plan 3 | 4 | has_many :users 5 | end 6 | -------------------------------------------------------------------------------- /spec/support/test_app/app/models/application_record.rb: -------------------------------------------------------------------------------- 1 | class ApplicationRecord < ActiveRecord::Base 2 | self.abstract_class = true 3 | end 4 | -------------------------------------------------------------------------------- /spec/support/test_app/app/channels/application_cable/channel.rb: -------------------------------------------------------------------------------- 1 | module ApplicationCable 2 | class Channel < ActionCable::Channel::Base 3 | end 4 | end 5 | -------------------------------------------------------------------------------- /spec/support/factories/plan.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | FactoryBot.define do 4 | factory :plan do 5 | name { 'Basic' } 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /spec/support/test_app/app/channels/application_cable/connection.rb: -------------------------------------------------------------------------------- 1 | module ApplicationCable 2 | class Connection < ActionCable::Connection::Base 3 | end 4 | end 5 | -------------------------------------------------------------------------------- /spec/support/test_app/app/assets/config/manifest.js: -------------------------------------------------------------------------------- 1 | 2 | //= link_tree ../images 3 | //= link_directory ../javascripts .js 4 | //= link_directory ../stylesheets .css 5 | -------------------------------------------------------------------------------- /spec/support/test_app/app/controllers/application_controller.rb: -------------------------------------------------------------------------------- 1 | class ApplicationController < ActionController::Base 2 | protect_from_forgery with: :exception 3 | end 4 | -------------------------------------------------------------------------------- /spec/support/test_app/app/mailers/application_mailer.rb: -------------------------------------------------------------------------------- 1 | class ApplicationMailer < ActionMailer::Base 2 | default from: 'from@example.com' 3 | layout 'mailer' 4 | end 5 | -------------------------------------------------------------------------------- /spec/support/test_app/bin/bundle: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) 3 | load Gem.bin_path('bundler', 'bundle') 4 | -------------------------------------------------------------------------------- /spec/support/test_app/config/spring.rb: -------------------------------------------------------------------------------- 1 | %w( 2 | .ruby-version 3 | .rbenv-vars 4 | tmp/restart.txt 5 | tmp/caching-dev.txt 6 | ).each { |path| Spring.watch(path) } 7 | -------------------------------------------------------------------------------- /spec/support/test_app/app/models/plan.rb: -------------------------------------------------------------------------------- 1 | class Plan < ApplicationRecord 2 | validates :name, presence: true 3 | 4 | def self.default 5 | Plan.first 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /spec/support/test_app/config.ru: -------------------------------------------------------------------------------- 1 | # This file is used by Rack-based servers to start the application. 2 | 3 | require_relative 'config/environment' 4 | 5 | run Rails.application 6 | -------------------------------------------------------------------------------- /spec/support/test_app/bin/rails: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | APP_PATH = File.expand_path('../config/application', __dir__) 3 | require_relative '../config/boot' 4 | require 'rails/commands' 5 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | source 'https://rubygems.org' 4 | 5 | gemspec 6 | 7 | group :development, :test do 8 | gem 'shoulda-matchers', '~> 4' 9 | end 10 | -------------------------------------------------------------------------------- /spec/support/test_app/config/environment.rb: -------------------------------------------------------------------------------- 1 | # Load the Rails application. 2 | require_relative 'application' 3 | 4 | # Initialize the Rails application. 5 | Rails.application.initialize! 6 | -------------------------------------------------------------------------------- /spec/support/test_app/config/routes.rb: -------------------------------------------------------------------------------- 1 | Rails.application.routes.draw do 2 | # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html 3 | end 4 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/session_store.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | Rails.application.config.session_store :cookie_store, key: '_test_app_session' 4 | -------------------------------------------------------------------------------- /spec/support/factories/user.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | FactoryBot.define do 4 | factory :user do 5 | sequence(:email) { |i| "test_#{i}@test.com" } 6 | password { '12345678' } 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /spec/support/shoulda.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | Shoulda::Matchers.configure do |config| 4 | config.integrate do |with| 5 | with.test_framework :rspec 6 | with.library :rails 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/mime_types.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new mime types for use in respond_to blocks: 4 | # Mime::Type.register "text/richtext", :rtf 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .bundle/ 2 | log/*.log 3 | pkg/ 4 | spec/support/test_app/db/*.sqlite3 5 | spec/support/test_app/db/*.sqlite3-journal 6 | spec/support/test_app/log/*.log 7 | spec/support/test_app/tmp/ 8 | coverage/ 9 | *.gem 10 | -------------------------------------------------------------------------------- /spec/support/test_app/config/boot.rb: -------------------------------------------------------------------------------- 1 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) 2 | 3 | require 'bundler/setup' # Set up gems listed in the Gemfile. 4 | require 'bootsnap/setup' # Speed up boot time by caching expensive operations. 5 | -------------------------------------------------------------------------------- /spec/support/test_app/db/migrate/20161030205226_create_plans.rb: -------------------------------------------------------------------------------- 1 | class CreatePlans < ActiveRecord::Migration[5.0] 2 | def change 3 | create_table :plans do |t| 4 | t.string :name 5 | 6 | t.timestamps 7 | end 8 | end 9 | end 10 | -------------------------------------------------------------------------------- /lib/base_form.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # require dependencies gems 4 | require 'active_support' 5 | require 'active_model' 6 | require 'virtus' 7 | 8 | # require lib files 9 | require 'base_form/form' 10 | 11 | module BaseForm 12 | end 13 | -------------------------------------------------------------------------------- /spec/support/test_app/app/models/user.rb: -------------------------------------------------------------------------------- 1 | class User < ApplicationRecord 2 | attr_accessor :password_confirmation 3 | 4 | validates :email, :password, presence: true 5 | validates :email, uniqueness: true 6 | validates :password, length: { minimum: 8 } 7 | end 8 | -------------------------------------------------------------------------------- /spec/support/test_app/db/migrate/20161030205450_create_accounts.rb: -------------------------------------------------------------------------------- 1 | class CreateAccounts < ActiveRecord::Migration[5.0] 2 | def change 3 | create_table :accounts do |t| 4 | t.integer :plan_id 5 | 6 | t.timestamps 7 | end 8 | end 9 | end 10 | -------------------------------------------------------------------------------- /spec/support/test_app/Rakefile: -------------------------------------------------------------------------------- 1 | # Add your own tasks in files placed in lib/tasks ending in .rake, 2 | # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake. 3 | 4 | require_relative 'config/application' 5 | 6 | Rails.application.load_tasks 7 | -------------------------------------------------------------------------------- /spec/support/test_app/config/cable.yml: -------------------------------------------------------------------------------- 1 | development: 2 | adapter: async 3 | 4 | test: 5 | adapter: async 6 | 7 | production: 8 | adapter: redis 9 | url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %> 10 | channel_prefix: test_app_production 11 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/filter_parameter_logging.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Configure sensitive parameters which will be filtered from the log file. 4 | Rails.application.config.filter_parameters += [:password] 5 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/application_controller_renderer.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # ActiveSupport::Reloader.to_prepare do 4 | # ApplicationController.renderer.defaults.merge!( 5 | # http_host: 'example.org', 6 | # https: false 7 | # ) 8 | # end 9 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/cookies_serializer.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Specify a serializer for the signed and encrypted cookie jars. 4 | # Valid options are :json, :marshal, and :hybrid. 5 | Rails.application.config.action_dispatch.cookies_serializer = :json 6 | -------------------------------------------------------------------------------- /spec/support/test_app/app/views/layouts/mailer.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | <%= yield %> 12 | 13 | 14 | -------------------------------------------------------------------------------- /spec/support/test_app/db/migrate/20161030204225_create_users.rb: -------------------------------------------------------------------------------- 1 | class CreateUsers < ActiveRecord::Migration[5.0] 2 | def change 3 | create_table :users do |t| 4 | t.string :email 5 | t.string :password 6 | t.integer :account_id 7 | t.boolean :account_owner, default: false 8 | 9 | t.timestamps 10 | end 11 | end 12 | end 13 | -------------------------------------------------------------------------------- /spec/support/test_app/bin/yarn: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | APP_ROOT = File.expand_path('..', __dir__) 3 | Dir.chdir(APP_ROOT) do 4 | begin 5 | exec "yarnpkg", *ARGV 6 | rescue Errno::ENOENT 7 | $stderr.puts "Yarn executable was not detected in the system." 8 | $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install" 9 | exit 1 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /spec/support/factory_bot.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'factory_bot' 4 | require 'factory_bot_rails' 5 | 6 | Dir["#{File.dirname(__FILE__)}/factories/**/*.rb"].sort.each do |f| 7 | require f 8 | end 9 | 10 | RSpec.configure do |config| 11 | config.include FactoryBot::Syntax::Methods 12 | 13 | config.before(:suite) do 14 | FactoryBot.find_definitions 15 | end 16 | end 17 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | RSpec.configure do |config| 4 | config.expect_with :rspec do |expectations| 5 | expectations.include_chain_clauses_in_custom_matcher_descriptions = true 6 | end 7 | 8 | config.mock_with :rspec do |mocks| 9 | mocks.verify_partial_doubles = true 10 | end 11 | 12 | config.shared_context_metadata_behavior = :apply_to_host_groups 13 | end 14 | -------------------------------------------------------------------------------- /spec/support/test_app/app/views/layouts/application.html.erb: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | TestApp 5 | <%= csrf_meta_tags %> 6 | 7 | <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %> 8 | <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %> 9 | 10 | 11 | 12 | <%= yield %> 13 | 14 | 15 | -------------------------------------------------------------------------------- /spec/support/test_app/app/assets/javascripts/cable.js: -------------------------------------------------------------------------------- 1 | // Action Cable provides the framework to deal with WebSockets in Rails. 2 | // You can generate new channels where WebSocket features live using the rails generate channel command. 3 | // 4 | //= require action_cable 5 | //= require_self 6 | //= require_tree ./channels 7 | 8 | (function() { 9 | this.App || (this.App = {}); 10 | 11 | App.cable = ActionCable.createConsumer(); 12 | 13 | }).call(this); 14 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/backtrace_silencers.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces. 4 | # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ } 5 | 6 | # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code. 7 | # Rails.backtrace_cleaner.remove_silencers! 8 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | begin 4 | require 'bundler/setup' 5 | rescue LoadError 6 | puts 'You must `gem install bundler` and `bundle install` to run rake tasks' 7 | end 8 | 9 | require 'rdoc/task' 10 | 11 | RDoc::Task.new(:rdoc) do |rdoc| 12 | rdoc.rdoc_dir = 'rdoc' 13 | rdoc.title = 'BaseForm' 14 | rdoc.options << '--line-numbers' 15 | rdoc.rdoc_files.include('README.md') 16 | rdoc.rdoc_files.include('lib/**/*.rb') 17 | end 18 | 19 | require 'bundler/gem_tasks' 20 | -------------------------------------------------------------------------------- /.codeclimate.yml: -------------------------------------------------------------------------------- 1 | --- 2 | engines: 3 | bundler-audit: 4 | enabled: true 5 | duplication: 6 | enabled: true 7 | config: 8 | languages: 9 | - ruby 10 | - javascript 11 | - python 12 | - php 13 | fixme: 14 | enabled: true 15 | rubocop: 16 | enabled: true 17 | ratings: 18 | paths: 19 | - Gemfile.lock 20 | - "**.inc" 21 | - "**.js" 22 | - "**.jsx" 23 | - "**.module" 24 | - "**.php" 25 | - "**.py" 26 | - "**.rb" 27 | exclude_paths: 28 | - spec/ 29 | -------------------------------------------------------------------------------- /bin/rspec: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # frozen_string_literal: true 3 | 4 | # 5 | # This file was generated by Bundler. 6 | # 7 | # The application 'rspec' is installed as part of a gem, and 8 | # this file is here to facilitate running it. 9 | # 10 | 11 | require 'pathname' 12 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', 13 | Pathname.new(__FILE__).realpath) 14 | 15 | require 'rubygems' 16 | require 'bundler/setup' 17 | 18 | load Gem.bin_path('rspec-core', 'rspec') 19 | -------------------------------------------------------------------------------- /bin/rubocop: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # frozen_string_literal: true 3 | 4 | # 5 | # This file was generated by Bundler. 6 | # 7 | # The application 'rubocop' is installed as part of a gem, and 8 | # this file is here to facilitate running it. 9 | # 10 | 11 | require 'pathname' 12 | ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', 13 | Pathname.new(__FILE__).realpath) 14 | 15 | require 'rubygems' 16 | require 'bundler/setup' 17 | 18 | load Gem.bin_path('rubocop', 'rubocop') 19 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | 3 | rvm: 4 | - 2.6.0 5 | 6 | cache: bundler 7 | 8 | sudo: false 9 | 10 | before_install: 11 | - gem install bundler -v '< 2' 12 | 13 | before_script: 14 | - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter 15 | - chmod +x ./cc-test-reporter 16 | - ./cc-test-reporter before-build 17 | 18 | script: 19 | - bundle exec rspec 20 | - bundle exec rubocop 21 | 22 | after_script: 23 | - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT 24 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/wrap_parameters.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # This file contains settings for ActionController::ParamsWrapper which 4 | # is enabled by default. 5 | 6 | # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array. 7 | ActiveSupport.on_load(:action_controller) do 8 | wrap_parameters format: [:json] 9 | end 10 | 11 | # To enable root element in JSON for ActiveRecord objects. 12 | # ActiveSupport.on_load(:active_record) do 13 | # self.include_root_in_json = true 14 | # end 15 | -------------------------------------------------------------------------------- /spec/support/test_app/app/forms/signup_form.rb: -------------------------------------------------------------------------------- 1 | class SignupForm < BaseForm::Form 2 | use_form_records :account, :user 3 | 4 | attribute :email 5 | attribute :password 6 | attribute :password_confirmation 7 | attribute :plan, Plan, default: proc { Plan.default } 8 | 9 | validates :plan, presence: true 10 | 11 | private 12 | 13 | def persist 14 | @account ||= Account.create plan: plan 15 | @user ||= account.users.create user_params 16 | end 17 | 18 | def user_params 19 | { 20 | email: email, 21 | password: password, 22 | password_confirmation: password_confirmation, 23 | account_owner: true 24 | } 25 | end 26 | end 27 | -------------------------------------------------------------------------------- /spec/support/test_app/config/database.yml: -------------------------------------------------------------------------------- 1 | # SQLite version 3.x 2 | # gem install sqlite3 3 | # 4 | # Ensure the SQLite 3 gem is defined in your Gemfile 5 | # gem 'sqlite3' 6 | # 7 | default: &default 8 | adapter: sqlite3 9 | pool: 5 10 | timeout: 5000 11 | 12 | development: 13 | <<: *default 14 | database: db/development.sqlite3 15 | 16 | # Warning: The database defined as "test" will be erased and 17 | # re-generated from your development database when you run "rake". 18 | # Do not set this db to the same as development or production. 19 | test: 20 | <<: *default 21 | database: db/test.sqlite3 22 | 23 | production: 24 | <<: *default 25 | database: db/production.sqlite3 26 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/assets.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Version of your assets, change this if you want to expire all your assets. 4 | Rails.application.config.assets.version = '1.0' 5 | 6 | # Add additional assets to the asset load path. 7 | # Rails.application.config.assets.paths << Emoji.images_path 8 | # Add Yarn node_modules folder to the asset load path. 9 | Rails.application.config.assets.paths << Rails.root.join('node_modules') 10 | 11 | # Precompile additional assets. 12 | # application.js, application.css, and all non-JS/CSS in the app/assets 13 | # folder are already added. 14 | # Rails.application.config.assets.precompile += %w( admin.js admin.css ) 15 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/inflections.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Add new inflection rules using the following format. Inflections 4 | # are locale specific, and you may define rules for as many different 5 | # locales as you wish. All of these examples are active by default: 6 | # ActiveSupport::Inflector.inflections(:en) do |inflect| 7 | # inflect.plural /^(ox)$/i, '\1en' 8 | # inflect.singular /^(ox)en/i, '\1' 9 | # inflect.irregular 'person', 'people' 10 | # inflect.uncountable %w( fish sheep ) 11 | # end 12 | 13 | # These inflection rules are supported but not enabled by default: 14 | # ActiveSupport::Inflector.inflections(:en) do |inflect| 15 | # inflect.acronym 'RESTful' 16 | # end 17 | -------------------------------------------------------------------------------- /spec/support/test_app/config/application.rb: -------------------------------------------------------------------------------- 1 | require_relative 'boot' 2 | 3 | require 'rails/all' 4 | 5 | # Require the gems listed in Gemfile, including any gems 6 | # you've limited to :test, :development, or :production. 7 | Bundler.require(*Rails.groups) 8 | 9 | module TestApp 10 | class Application < Rails::Application 11 | # Initialize configuration defaults for originally generated Rails version. 12 | config.load_defaults 5.0 13 | 14 | # Settings in config/environments/* take precedence over those specified here. 15 | # Application configuration can go into files in config/initializers 16 | # -- all .rb files in that directory are automatically loaded after loading 17 | # the framework and any gems in your application. 18 | end 19 | end 20 | -------------------------------------------------------------------------------- /spec/support/test_app/app/assets/javascripts/application.js: -------------------------------------------------------------------------------- 1 | // This is a manifest file that'll be compiled into application.js, which will include all the files 2 | // listed below. 3 | // 4 | // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts, 5 | // or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path. 6 | // 7 | // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the 8 | // compiled file. JavaScript code in this file should be added after the last require_* statement. 9 | // 10 | // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details 11 | // about supported directives. 12 | // 13 | //= require_tree . 14 | -------------------------------------------------------------------------------- /spec/rails_helper.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'spec_helper' 4 | ENV['RAILS_ENV'] ||= 'test' 5 | 6 | require 'support/test_app/config/environment' 7 | 8 | # Prevent database truncation if the environment is production 9 | abort('The Rails environment is running in production mode!') if Rails.env.production? 10 | require 'rails/all' 11 | require 'rspec/rails' 12 | 13 | # Require support files 14 | Dir[Rails.root.join('..', '*.rb')].sort.each { |f| require f } 15 | 16 | # Require this lib 17 | require 'base_form' 18 | 19 | ActiveRecord::Migration.maintain_test_schema! 20 | 21 | # set up db 22 | # be sure to update the schema if required by doing 23 | # - cd spec/rails_app 24 | # - rake db:migrate 25 | ActiveRecord::Schema.verbose = false 26 | load 'support/test_app/db/schema.rb' # use db agnostic schema by default 27 | -------------------------------------------------------------------------------- /spec/support/test_app/app/assets/stylesheets/application.css: -------------------------------------------------------------------------------- 1 | /* 2 | * This is a manifest file that'll be compiled into application.css, which will include all the files 3 | * listed below. 4 | * 5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets, 6 | * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path. 7 | * 8 | * You're free to add application-wide styles to this file and they'll appear at the bottom of the 9 | * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS 10 | * files in this directory. Styles in this file should be added after the last require_* statement. 11 | * It is generally better to create a new file per style scope. 12 | * 13 | *= require_tree . 14 | *= require_self 15 | */ 16 | -------------------------------------------------------------------------------- /spec/support/test_app/bin/update: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | require 'fileutils' 3 | include FileUtils 4 | 5 | # path to your application root. 6 | APP_ROOT = File.expand_path('..', __dir__) 7 | 8 | def system!(*args) 9 | system(*args) || abort("\n== Command #{args} failed ==") 10 | end 11 | 12 | chdir APP_ROOT do 13 | # This script is a way to update your development environment automatically. 14 | # Add necessary update steps to this file. 15 | 16 | puts '== Installing dependencies ==' 17 | system! 'gem install bundler --conservative' 18 | system('bundle check') || system!('bundle install') 19 | 20 | # Install JavaScript dependencies if using Yarn 21 | # system('bin/yarn') 22 | 23 | puts "\n== Updating database ==" 24 | system! 'bin/rails db:migrate' 25 | 26 | puts "\n== Removing old logs and tempfiles ==" 27 | system! 'bin/rails log:clear tmp:clear' 28 | 29 | puts "\n== Restarting application server ==" 30 | system! 'bin/rails restart' 31 | end 32 | -------------------------------------------------------------------------------- /spec/support/test_app/config/locales/en.yml: -------------------------------------------------------------------------------- 1 | # Files in the config/locales directory are used for internationalization 2 | # and are automatically loaded by Rails. If you want to use locales other 3 | # than English, add the necessary files in this directory. 4 | # 5 | # To use the locales, use `I18n.t`: 6 | # 7 | # I18n.t 'hello' 8 | # 9 | # In views, this is aliased to just `t`: 10 | # 11 | # <%= t('hello') %> 12 | # 13 | # To use a different locale, set it with `I18n.locale`: 14 | # 15 | # I18n.locale = :es 16 | # 17 | # This would use the information in config/locales/es.yml. 18 | # 19 | # The following keys must be escaped otherwise they will not be retrieved by 20 | # the default I18n backend: 21 | # 22 | # true, false, on, off, yes, no 23 | # 24 | # Instead, surround them with single quotes. 25 | # 26 | # en: 27 | # 'true': 'foo' 28 | # 29 | # To learn more, please read the Rails Internationalization guide 30 | # available at http://guides.rubyonrails.org/i18n.html. 31 | 32 | en: 33 | hello: "Hello world" 34 | -------------------------------------------------------------------------------- /spec/support/test_app/config/secrets.yml: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Your secret key is used for verifying the integrity of signed cookies. 4 | # If you change this key, all old signed cookies will become invalid! 5 | 6 | # Make sure the secret is at least 30 characters and all random, 7 | # no regular words or you'll be exposed to dictionary attacks. 8 | # You can use `rails secret` to generate a secure secret key. 9 | 10 | # Make sure the secrets in this file are kept private 11 | # if you're sharing your code publicly. 12 | 13 | development: 14 | secret_key_base: 60a146ffd4c2ecdddd88dfc0d3ef3814ad1cc8208320aba88a95e67eee381cd2deb5d1b0738dee96dc621d96ac9cb252e3f436e6e22908f1d3ac16af3ca0c01d 15 | 16 | test: 17 | secret_key_base: 313a5f88e55bd52b9b6d065fbacea8f35ff12252720c116366a661acd2c394fab3588a18548be9f168f7f5b66f34b0a901d153154624ddc61c1db311cd18f92e 18 | 19 | # Do not keep production secrets in the repository, 20 | # instead read values from the environment. 21 | production: 22 | secret_key_base: <%= ENV["SECRET_KEY_BASE"] %> 23 | -------------------------------------------------------------------------------- /MIT-LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2016 andrerpbts 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining 4 | a copy of this software and associated documentation files (the 5 | "Software"), to deal in the Software without restriction, including 6 | without limitation the rights to use, copy, modify, merge, publish, 7 | distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to 9 | the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be 12 | included in all copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /spec/support/test_app/bin/setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | require 'fileutils' 3 | include FileUtils 4 | 5 | # path to your application root. 6 | APP_ROOT = File.expand_path('..', __dir__) 7 | 8 | def system!(*args) 9 | system(*args) || abort("\n== Command #{args} failed ==") 10 | end 11 | 12 | chdir APP_ROOT do 13 | # This script is a starting point to setup your application. 14 | # Add necessary setup steps to this file. 15 | 16 | puts '== Installing dependencies ==' 17 | system! 'gem install bundler --conservative' 18 | system('bundle check') || system!('bundle install') 19 | 20 | # Install JavaScript dependencies if using Yarn 21 | # system('bin/yarn') 22 | 23 | # puts "\n== Copying sample files ==" 24 | # unless File.exist?('config/database.yml') 25 | # cp 'config/database.yml.sample', 'config/database.yml' 26 | # end 27 | 28 | puts "\n== Preparing database ==" 29 | system! 'bin/rails db:setup' 30 | 31 | puts "\n== Removing old logs and tempfiles ==" 32 | system! 'bin/rails log:clear tmp:clear' 33 | 34 | puts "\n== Restarting application server ==" 35 | system! 'bin/rails restart' 36 | end 37 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/new_framework_defaults.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | # 3 | # This file contains migration options to ease your Rails 5.0 upgrade. 4 | # 5 | # Read the Rails 5.0 release notes for more info on each option. 6 | 7 | # Enable per-form CSRF tokens. Previous versions had false. 8 | Rails.application.config.action_controller.per_form_csrf_tokens = true 9 | 10 | # Enable origin-checking CSRF mitigation. Previous versions had false. 11 | Rails.application.config.action_controller.forgery_protection_origin_check = true 12 | 13 | # Make Ruby 2.4 preserve the timezone of the receiver when calling `to_time`. 14 | # Previous versions had false. 15 | ActiveSupport.to_time_preserves_timezone = true 16 | 17 | # Require `belongs_to` associations by default. Previous versions had false. 18 | Rails.application.config.active_record.belongs_to_required_by_default = true 19 | 20 | # Configure SSL options to enable HSTS with subdomains. Previous versions had false. 21 | Rails.application.config.ssl_options = { hsts: { subdomains: true } } 22 | 23 | Rails.application.config.active_record.sqlite3.represent_boolean_as_integer = true 24 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/content_security_policy.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | 3 | # Define an application-wide content security policy 4 | # For further information see the following documentation 5 | # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy 6 | 7 | # Rails.application.config.content_security_policy do |policy| 8 | # policy.default_src :self, :https 9 | # policy.font_src :self, :https, :data 10 | # policy.img_src :self, :https, :data 11 | # policy.object_src :none 12 | # policy.script_src :self, :https 13 | # policy.style_src :self, :https 14 | 15 | # # Specify URI for violation reports 16 | # # policy.report_uri "/csp-violation-report-endpoint" 17 | # end 18 | 19 | # If you are using UJS then enable automatic nonce generation 20 | # Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) } 21 | 22 | # Report CSP violations to a specified URI 23 | # For further information see the following documentation: 24 | # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only 25 | # Rails.application.config.content_security_policy_report_only = true 26 | -------------------------------------------------------------------------------- /spec/support/test_app/config/storage.yml: -------------------------------------------------------------------------------- 1 | test: 2 | service: Disk 3 | root: <%= Rails.root.join("tmp/storage") %> 4 | 5 | local: 6 | service: Disk 7 | root: <%= Rails.root.join("storage") %> 8 | 9 | # Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key) 10 | # amazon: 11 | # service: S3 12 | # access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %> 13 | # secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %> 14 | # region: us-east-1 15 | # bucket: your_own_bucket 16 | 17 | # Remember not to checkin your GCS keyfile to a repository 18 | # google: 19 | # service: GCS 20 | # project: your_project 21 | # credentials: <%= Rails.root.join("path/to/gcs.keyfile") %> 22 | # bucket: your_own_bucket 23 | 24 | # Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key) 25 | # microsoft: 26 | # service: AzureStorage 27 | # storage_account_name: your_account_name 28 | # storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %> 29 | # container: your_container_name 30 | 31 | # mirror: 32 | # service: Mirror 33 | # primary: local 34 | # mirrors: [ amazon, google, microsoft ] 35 | -------------------------------------------------------------------------------- /base_form.gemspec: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | $LOAD_PATH.push File.expand_path('lib', __dir__) 4 | 5 | # Maintain your gem's version: 6 | require 'base_form/version' 7 | 8 | # Describe your gem and declare its dependencies: 9 | Gem::Specification.new do |s| 10 | s.name = 'base_form' 11 | s.version = BaseForm::VERSION 12 | s.authors = ['andrerpbts'] 13 | s.email = ['andrerpbts@gmail.com'] 14 | s.homepage = 'https://github.com/andrerpbts/base_form' 15 | s.summary = 'A simple and small form objects Rails plugin' 16 | s.description = 'BaseForm is a small and simple Rails plugin to work with Form Objects' 17 | s.license = 'MIT' 18 | 19 | s.files = Dir['{app,config,db,lib}/**/*', 'MIT-LICENSE', 'Rakefile', 'README.md'] 20 | 21 | s.add_development_dependency 'bootsnap', '~> 1.4' 22 | s.add_development_dependency 'bundler', '~> 2.1.4' 23 | s.add_development_dependency 'factory_bot_rails', '~> 6.0' 24 | s.add_development_dependency 'listen', '~> 3.0' 25 | s.add_development_dependency 'rails', '~> 5.2' 26 | s.add_development_dependency 'rspec-rails', '~> 4.0' 27 | s.add_development_dependency 'rubocop', '0.86.0' 28 | s.add_development_dependency 'sqlite3', '~> 1.4.1' 29 | 30 | s.add_runtime_dependency 'activesupport', '>= 3.2' 31 | s.add_runtime_dependency 'virtus', '~> 1.0' 32 | end 33 | -------------------------------------------------------------------------------- /spec/support/test_app/db/schema.rb: -------------------------------------------------------------------------------- 1 | # This file is auto-generated from the current state of the database. Instead 2 | # of editing this file, please use the migrations feature of Active Record to 3 | # incrementally modify your database, and then regenerate this schema definition. 4 | # 5 | # Note that this schema.rb definition is the authoritative source for your 6 | # database schema. If you need to create the application database on another 7 | # system, you should be using db:schema:load, not running all the migrations 8 | # from scratch. The latter is a flawed and unsustainable approach (the more migrations 9 | # you'll amass, the slower it'll run and the greater likelihood for issues). 10 | # 11 | # It's strongly recommended that you check this file into your version control system. 12 | 13 | ActiveRecord::Schema.define(version: 20161030205450) do 14 | 15 | create_table "accounts", force: :cascade do |t| 16 | t.integer "plan_id" 17 | t.datetime "created_at", null: false 18 | t.datetime "updated_at", null: false 19 | end 20 | 21 | create_table "plans", force: :cascade do |t| 22 | t.string "name" 23 | t.datetime "created_at", null: false 24 | t.datetime "updated_at", null: false 25 | end 26 | 27 | create_table "users", force: :cascade do |t| 28 | t.string "email" 29 | t.string "password" 30 | t.integer "account_id" 31 | t.boolean "account_owner", default: false 32 | t.datetime "created_at", null: false 33 | t.datetime "updated_at", null: false 34 | end 35 | 36 | end 37 | -------------------------------------------------------------------------------- /spec/integration/forms/signup_form_spec.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'rails_helper' 4 | 5 | RSpec.describe SignupForm, type: :model do 6 | it { is_expected.to validate_presence_of(:plan) } 7 | it { is_expected.to respond_to(:account) } 8 | it { is_expected.to respond_to(:user) } 9 | 10 | describe '#save' do 11 | let!(:basic_plan) { create :plan, name: 'Basic' } 12 | let(:user) { build :user } 13 | 14 | subject { described_class.new email: user.email, password: user.password } 15 | 16 | before do 17 | subject.save 18 | end 19 | 20 | context 'correct registration' do 21 | it { expect(subject).to be_valid } 22 | it { expect(subject.errors).to be_empty } 23 | it { expect(subject.account).to be_valid } 24 | it { expect(subject.account.plan).not_to be_nil } 25 | it { expect(subject.user).to be_valid } 26 | end 27 | 28 | context 'incorrect registration' do 29 | subject { described_class.new email: nil, password: '1234' } 30 | 31 | it { expect(subject).not_to be_valid } 32 | it { expect(subject.errors).not_to be_empty } 33 | it { expect(subject.errors[:email]).to eq(['can\'t be blank']) } 34 | 35 | it 'validates the password lenght' do 36 | expect(subject.errors[:password]) 37 | .to eq(['is too short (minimum is 8 characters)']) 38 | end 39 | end 40 | 41 | context 'existing user' do 42 | let(:user) { create :user } 43 | 44 | it { expect(subject).not_to be_valid } 45 | it { expect(subject.errors).not_to be_empty } 46 | it { expect(subject.errors[:email]).to eq(['has already been taken']) } 47 | end 48 | end 49 | end 50 | -------------------------------------------------------------------------------- /.rubocop.yml: -------------------------------------------------------------------------------- 1 | AllCops: 2 | Exclude: 3 | - 'spec/support/test_app/**/*' 4 | - !ruby/regexp /old_and_unused\.rb$/ 5 | - vendor/bundle/**/* 6 | 7 | Style/Documentation: 8 | Enabled: false 9 | 10 | Metrics/AbcSize: 11 | Max: 25 12 | 13 | Metrics/LineLength: 14 | Max: 99 15 | 16 | Metrics/MethodLength: 17 | CountComments: false 18 | Max: 25 19 | 20 | Metrics/BlockLength: 21 | Exclude: 22 | - 'spec/**/*' 23 | 24 | Naming/PredicateName: 25 | Enabled: false 26 | 27 | Naming/MemoizedInstanceVariableName: 28 | Enabled: false 29 | 30 | Style/AndOr: 31 | Enabled: false 32 | 33 | Style/ClassAndModuleChildren: 34 | Enabled: false 35 | 36 | Style/EachWithObject: 37 | Enabled: false 38 | 39 | Style/FrozenStringLiteralComment: 40 | Enabled: true 41 | 42 | Style/RedundantReturn: 43 | Enabled: false 44 | 45 | Style/Semicolon: 46 | AllowAsExpressionSeparator: true 47 | 48 | Layout/EmptyLinesAroundAttributeAccessor: 49 | Enabled: true 50 | 51 | Layout/SpaceAroundMethodCallOperator: 52 | Enabled: true 53 | 54 | Lint/DeprecatedOpenSSLConstant: 55 | Enabled: true 56 | 57 | Lint/MixedRegexpCaptureTypes: 58 | Enabled: true 59 | 60 | Lint/RaiseException: 61 | Enabled: true 62 | 63 | Lint/StructNewOverride: 64 | Enabled: true 65 | 66 | Style/ExponentialNotation: 67 | Enabled: true 68 | 69 | Style/HashEachMethods: 70 | Enabled: true 71 | 72 | Style/HashTransformKeys: 73 | Enabled: true 74 | 75 | Style/HashTransformValues: 76 | Enabled: true 77 | 78 | Style/RedundantFetchBlock: 79 | Enabled: true 80 | 81 | Style/RedundantRegexpCharacterClass: 82 | Enabled: true 83 | 84 | Style/RedundantRegexpEscape: 85 | Enabled: true 86 | 87 | Style/SlicingWithRange: 88 | Enabled: true 89 | 90 | -------------------------------------------------------------------------------- /spec/support/test_app/public/500.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | We're sorry, but something went wrong (500) 5 | 6 | 55 | 56 | 57 | 58 | 59 |
60 |
61 |

We're sorry, but something went wrong.

62 |
63 |

If you are the application owner check the logs for more information.

64 |
65 | 66 | 67 | -------------------------------------------------------------------------------- /spec/support/test_app/public/422.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The change you wanted was rejected (422) 5 | 6 | 55 | 56 | 57 | 58 | 59 |
60 |
61 |

The change you wanted was rejected.

62 |

Maybe you tried to change something you didn't have access to.

63 |
64 |

If you are the application owner check the logs for more information.

65 |
66 | 67 | 68 | -------------------------------------------------------------------------------- /spec/support/test_app/public/404.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | The page you were looking for doesn't exist (404) 5 | 6 | 55 | 56 | 57 | 58 | 59 |
60 |
61 |

The page you were looking for doesn't exist.

62 |

You may have mistyped the address or the page may have moved.

63 |
64 |

If you are the application owner check the logs for more information.

65 |
66 | 67 | 68 | -------------------------------------------------------------------------------- /spec/unit/base_form/form_spec.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require 'rails_helper' 4 | 5 | module BaseForm 6 | RSpec.describe Form do 7 | describe '#persisted?' do 8 | let(:dummy) { Dummy.new(the_dumbass: the_dumbass) } 9 | 10 | before do 11 | class Dummy < BaseForm::Form 12 | use_form_records :dumbass 13 | 14 | attribute :the_dumbass 15 | 16 | def persist 17 | @dumbass ||= the_dumbass 18 | end 19 | end 20 | 21 | dummy.save 22 | end 23 | 24 | subject { dummy.persisted? } 25 | 26 | context 'when dummy is saved normally' do 27 | let(:the_dumbass) do 28 | double :the_dumbass, errors: [] 29 | end 30 | 31 | it { is_expected.to be_truthy } 32 | end 33 | 34 | context 'when dummy is not saved normally' do 35 | let(:the_dumbass) do 36 | double :the_dumbass, errors: [{ attribute: 'foo', error: 'bar' }] 37 | end 38 | 39 | it { is_expected.to be_falsey } 40 | end 41 | end 42 | 43 | describe '#persist' do 44 | let(:wrong_dummy) { WrongDummy.new } 45 | 46 | before do 47 | class WrongDummy < BaseForm::Form; end 48 | end 49 | 50 | subject { wrong_dummy.save } 51 | 52 | it { expect { subject }.to raise_error(NotImplementedError) } 53 | end 54 | 55 | describe '.save' do 56 | let(:params) { { foo: 'bar' } } 57 | let(:save) { double :save, save: true } 58 | 59 | before do 60 | allow(described_class).to receive(:new) 61 | .with(params) 62 | .and_return(save) 63 | end 64 | 65 | subject { described_class.save(params) } 66 | 67 | it 'calls the save method as static method' do 68 | expect(save).to receive(:save) 69 | 70 | subject 71 | end 72 | end 73 | end 74 | end 75 | -------------------------------------------------------------------------------- /spec/support/test_app/config/initializers/new_framework_defaults_5_2.rb: -------------------------------------------------------------------------------- 1 | # Be sure to restart your server when you modify this file. 2 | # 3 | # This file contains migration options to ease your Rails 5.2 upgrade. 4 | # 5 | # Once upgraded flip defaults one by one to migrate to the new default. 6 | # 7 | # Read the Guide for Upgrading Ruby on Rails for more info on each option. 8 | 9 | # Make Active Record use stable #cache_key alongside new #cache_version method. 10 | # This is needed for recyclable cache keys. 11 | # Rails.application.config.active_record.cache_versioning = true 12 | 13 | # Use AES-256-GCM authenticated encryption for encrypted cookies. 14 | # Also, embed cookie expiry in signed or encrypted cookies for increased security. 15 | # 16 | # This option is not backwards compatible with earlier Rails versions. 17 | # It's best enabled when your entire app is migrated and stable on 5.2. 18 | # 19 | # Existing cookies will be converted on read then written with the new scheme. 20 | # Rails.application.config.action_dispatch.use_authenticated_cookie_encryption = true 21 | 22 | # Use AES-256-GCM authenticated encryption as default cipher for encrypting messages 23 | # instead of AES-256-CBC, when use_authenticated_message_encryption is set to true. 24 | # Rails.application.config.active_support.use_authenticated_message_encryption = true 25 | 26 | # Add default protection from forgery to ActionController::Base instead of in 27 | # ApplicationController. 28 | # Rails.application.config.action_controller.default_protect_from_forgery = true 29 | 30 | # Store boolean values are in sqlite3 databases as 1 and 0 instead of 't' and 31 | # 'f' after migrating old data. 32 | # Rails.application.config.active_record.sqlite3.represent_boolean_as_integer = true 33 | 34 | # Use SHA-1 instead of MD5 to generate non-sensitive digests, such as the ETag header. 35 | # Rails.application.config.active_support.use_sha1_digests = true 36 | 37 | # Make `form_with` generate id attributes for any generated HTML tags. 38 | # Rails.application.config.action_view.form_with_generates_ids = true 39 | -------------------------------------------------------------------------------- /spec/support/test_app/config/environments/test.rb: -------------------------------------------------------------------------------- 1 | Rails.application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb. 3 | 4 | # The test environment is used exclusively to run your application's 5 | # test suite. You never need to work with it otherwise. Remember that 6 | # your test database is "scratch space" for the test suite and is wiped 7 | # and recreated between test runs. Don't rely on the data there! 8 | config.cache_classes = true 9 | 10 | # Do not eager load code on boot. This avoids loading your whole application 11 | # just for the purpose of running a single test. If you are using a tool that 12 | # preloads Rails for running tests, you may have to set it to true. 13 | config.eager_load = false 14 | 15 | # Configure public file server for tests with Cache-Control for performance. 16 | config.public_file_server.enabled = true 17 | config.public_file_server.headers = { 18 | 'Cache-Control' => "public, max-age=#{1.hour.to_i}" 19 | } 20 | 21 | # Show full error reports and disable caching. 22 | config.consider_all_requests_local = true 23 | config.action_controller.perform_caching = false 24 | 25 | # Raise exceptions instead of rendering exception templates. 26 | config.action_dispatch.show_exceptions = false 27 | 28 | # Disable request forgery protection in test environment. 29 | config.action_controller.allow_forgery_protection = false 30 | 31 | # Store uploaded files on the local file system in a temporary directory 32 | config.active_storage.service = :test 33 | 34 | config.action_mailer.perform_caching = false 35 | 36 | # Tell Action Mailer not to deliver emails to the real world. 37 | # The :test delivery method accumulates sent emails in the 38 | # ActionMailer::Base.deliveries array. 39 | config.action_mailer.delivery_method = :test 40 | 41 | # Print deprecation notices to the stderr. 42 | config.active_support.deprecation = :stderr 43 | 44 | # Raises error for missing translations 45 | # config.action_view.raise_on_missing_translations = true 46 | end 47 | -------------------------------------------------------------------------------- /spec/support/test_app/config/puma.rb: -------------------------------------------------------------------------------- 1 | # Puma can serve each request in a thread from an internal thread pool. 2 | # The `threads` method setting takes two numbers a minimum and maximum. 3 | # Any libraries that use thread pools should be configured to match 4 | # the maximum value specified for Puma. Default is set to 5 threads for minimum 5 | # and maximum, this matches the default thread size of Active Record. 6 | # 7 | threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i 8 | threads threads_count, threads_count 9 | 10 | # Specifies the `port` that Puma will listen on to receive requests, default is 3000. 11 | # 12 | port ENV.fetch("PORT") { 3000 } 13 | 14 | # Specifies the `environment` that Puma will run in. 15 | # 16 | environment ENV.fetch("RAILS_ENV") { "development" } 17 | 18 | # Specifies the number of `workers` to boot in clustered mode. 19 | # Workers are forked webserver processes. If using threads and workers together 20 | # the concurrency of the application would be max `threads` * `workers`. 21 | # Workers do not work on JRuby or Windows (both of which do not support 22 | # processes). 23 | # 24 | # workers ENV.fetch("WEB_CONCURRENCY") { 2 } 25 | 26 | # Use the `preload_app!` method when specifying a `workers` number. 27 | # This directive tells Puma to first boot the application and load code 28 | # before forking the application. This takes advantage of Copy On Write 29 | # process behavior so workers use less memory. If you use this option 30 | # you need to make sure to reconnect any threads in the `on_worker_boot` 31 | # block. 32 | # 33 | # preload_app! 34 | 35 | # The code in the `on_worker_boot` will be called if you are using 36 | # clustered mode by specifying a number of `workers`. After each worker 37 | # process is booted this block will be run, if you are using `preload_app!` 38 | # option you will want to use this block to reconnect to any threads 39 | # or connections that may have been created at application boot, Ruby 40 | # cannot share connections between processes. 41 | # 42 | # on_worker_boot do 43 | # ActiveRecord::Base.establish_connection if defined?(ActiveRecord) 44 | # end 45 | 46 | # Allow puma to be restarted by `rails restart` command. 47 | plugin :tmp_restart 48 | -------------------------------------------------------------------------------- /spec/support/test_app/config/environments/development.rb: -------------------------------------------------------------------------------- 1 | Rails.application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb. 3 | 4 | # In the development environment your application's code is reloaded on 5 | # every request. This slows down response time but is perfect for development 6 | # since you don't have to restart the web server when you make code changes. 7 | config.cache_classes = false 8 | 9 | # Do not eager load code on boot. 10 | config.eager_load = false 11 | 12 | # Show full error reports. 13 | config.consider_all_requests_local = true 14 | 15 | # Enable/disable caching. By default caching is disabled. 16 | # Run rails dev:cache to toggle caching. 17 | if Rails.root.join('tmp', 'caching-dev.txt').exist? 18 | config.action_controller.perform_caching = true 19 | 20 | config.cache_store = :memory_store 21 | config.public_file_server.headers = { 22 | 'Cache-Control' => "public, max-age=#{2.days.to_i}" 23 | } 24 | else 25 | config.action_controller.perform_caching = false 26 | 27 | config.cache_store = :null_store 28 | end 29 | 30 | # Store uploaded files on the local file system (see config/storage.yml for options) 31 | config.active_storage.service = :local 32 | 33 | # Don't care if the mailer can't send. 34 | config.action_mailer.raise_delivery_errors = false 35 | 36 | config.action_mailer.perform_caching = false 37 | 38 | # Print deprecation notices to the Rails logger. 39 | config.active_support.deprecation = :log 40 | 41 | # Raise an error on page load if there are pending migrations. 42 | config.active_record.migration_error = :page_load 43 | 44 | # Highlight code that triggered database queries in logs. 45 | config.active_record.verbose_query_logs = true 46 | 47 | # Debug mode disables concatenation and preprocessing of assets. 48 | # This option may cause significant delays in view rendering with a large 49 | # number of complex assets. 50 | config.assets.debug = true 51 | 52 | # Suppress logger output for asset requests. 53 | config.assets.quiet = true 54 | 55 | # Raises error for missing translations 56 | # config.action_view.raise_on_missing_translations = true 57 | 58 | # Use an evented file watcher to asynchronously detect changes in source code, 59 | # routes, locales, etc. This feature depends on the listen gem. 60 | config.file_watcher = ActiveSupport::EventedFileUpdateChecker 61 | end 62 | -------------------------------------------------------------------------------- /lib/base_form/form.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module BaseForm 4 | # This class is the main core functionality, by being an inheritable 5 | # class, which controls the form attributes assignments, validations 6 | # and persisting. 7 | # 8 | # Basically you should create your own Form Object Class, and inherit 9 | # this class (BaseForm::Form). After that you should put all records 10 | # in the `@form_records` variable, through `use_form_records` class 11 | # method. In your `persist` method implementation, just create the 12 | # record objects associating it to each variable in `form_records.` 13 | class Form 14 | include ActiveModel::Model 15 | include Virtus.model 16 | 17 | class << self 18 | attr_reader :form_records 19 | 20 | protected 21 | 22 | def use_form_records(*records) 23 | attr_reader(*records) 24 | 25 | @form_records = records 26 | end 27 | end 28 | 29 | def self.save(*params) 30 | new(*params).save 31 | end 32 | 33 | # This method will make the things happen. It'll try run validations 34 | # set in your form class, and if it passes, it'll run your persist 35 | # instructions in a block of ActiveRecord transaction. If some 36 | # record fails it's persistence/validation, then a rollback will be 37 | # raised, the form will return those errors grouped in it. Otherwise 38 | # everything is commited and `persisted?` method will return true. 39 | def save 40 | perform_in_transaction { persist } if valid? 41 | 42 | self 43 | end 44 | 45 | def valid? 46 | errors.empty? && super 47 | end 48 | 49 | def persisted? 50 | @persisted 51 | end 52 | 53 | protected 54 | 55 | def persist 56 | raise NotImplementedError 57 | end 58 | 59 | def perform_in_transaction 60 | ActiveRecord::Base.transaction do 61 | yield if block_given? 62 | 63 | records_errors.each { |error| add_errors_for(error) } 64 | raise ActiveRecord::Rollback if errors.any? 65 | 66 | @persisted = true 67 | end 68 | end 69 | 70 | def records_errors 71 | self.class.form_records.map do |form_record| 72 | send(form_record).try(:errors) 73 | end.compact.flatten 74 | end 75 | 76 | def add_errors_for(error) 77 | error.each do |attribute, message| 78 | errors.add attribute, message 79 | end 80 | end 81 | end 82 | end 83 | -------------------------------------------------------------------------------- /spec/support/test_app/config/environments/production.rb: -------------------------------------------------------------------------------- 1 | Rails.application.configure do 2 | # Settings specified here will take precedence over those in config/application.rb. 3 | 4 | # Code is not reloaded between requests. 5 | config.cache_classes = true 6 | 7 | # Eager load code on boot. This eager loads most of Rails and 8 | # your application in memory, allowing both threaded web servers 9 | # and those relying on copy on write to perform better. 10 | # Rake tasks automatically ignore this option for performance. 11 | config.eager_load = true 12 | 13 | # Full error reports are disabled and caching is turned on. 14 | config.consider_all_requests_local = false 15 | config.action_controller.perform_caching = true 16 | 17 | # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"] 18 | # or in config/master.key. This key is used to decrypt credentials (and other encrypted files). 19 | # config.require_master_key = true 20 | 21 | # Disable serving static files from the `/public` folder by default since 22 | # Apache or NGINX already handles this. 23 | config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present? 24 | 25 | # Compress JavaScripts and CSS. 26 | config.assets.js_compressor = :uglifier 27 | # config.assets.css_compressor = :sass 28 | 29 | # Do not fallback to assets pipeline if a precompiled asset is missed. 30 | config.assets.compile = false 31 | 32 | # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb 33 | 34 | # Enable serving of images, stylesheets, and JavaScripts from an asset server. 35 | # config.action_controller.asset_host = 'http://assets.example.com' 36 | 37 | # Specifies the header that your server uses for sending files. 38 | # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache 39 | # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX 40 | 41 | # Store uploaded files on the local file system (see config/storage.yml for options) 42 | config.active_storage.service = :local 43 | 44 | # Mount Action Cable outside main process or domain 45 | # config.action_cable.mount_path = nil 46 | # config.action_cable.url = 'wss://example.com/cable' 47 | # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ] 48 | 49 | # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. 50 | # config.force_ssl = true 51 | 52 | # Use the lowest log level to ensure availability of diagnostic information 53 | # when problems arise. 54 | config.log_level = :debug 55 | 56 | # Prepend all log lines with the following tags. 57 | config.log_tags = [ :request_id ] 58 | 59 | # Use a different cache store in production. 60 | # config.cache_store = :mem_cache_store 61 | 62 | # Use a real queuing backend for Active Job (and separate queues per environment) 63 | # config.active_job.queue_adapter = :resque 64 | # config.active_job.queue_name_prefix = "test_app_#{Rails.env}" 65 | 66 | config.action_mailer.perform_caching = false 67 | 68 | # Ignore bad email addresses and do not raise email delivery errors. 69 | # Set this to true and configure the email server for immediate delivery to raise delivery errors. 70 | # config.action_mailer.raise_delivery_errors = false 71 | 72 | # Enable locale fallbacks for I18n (makes lookups for any locale fall back to 73 | # the I18n.default_locale when a translation cannot be found). 74 | config.i18n.fallbacks = true 75 | 76 | # Send deprecation notices to registered listeners. 77 | config.active_support.deprecation = :notify 78 | 79 | # Use default logging formatter so that PID and timestamp are not suppressed. 80 | config.log_formatter = ::Logger::Formatter.new 81 | 82 | # Use a different logger for distributed setups. 83 | # require 'syslog/logger' 84 | # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name') 85 | 86 | if ENV["RAILS_LOG_TO_STDOUT"].present? 87 | logger = ActiveSupport::Logger.new(STDOUT) 88 | logger.formatter = config.log_formatter 89 | config.logger = ActiveSupport::TaggedLogging.new(logger) 90 | end 91 | 92 | # Do not dump schema after migrations. 93 | config.active_record.dump_schema_after_migration = false 94 | end 95 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | base_form (0.1.4) 5 | activesupport (>= 3.2) 6 | virtus (~> 1.0) 7 | 8 | GEM 9 | remote: https://rubygems.org/ 10 | specs: 11 | actioncable (5.2.4.3) 12 | actionpack (= 5.2.4.3) 13 | nio4r (~> 2.0) 14 | websocket-driver (>= 0.6.1) 15 | actionmailer (5.2.4.3) 16 | actionpack (= 5.2.4.3) 17 | actionview (= 5.2.4.3) 18 | activejob (= 5.2.4.3) 19 | mail (~> 2.5, >= 2.5.4) 20 | rails-dom-testing (~> 2.0) 21 | actionpack (5.2.4.3) 22 | actionview (= 5.2.4.3) 23 | activesupport (= 5.2.4.3) 24 | rack (~> 2.0, >= 2.0.8) 25 | rack-test (>= 0.6.3) 26 | rails-dom-testing (~> 2.0) 27 | rails-html-sanitizer (~> 1.0, >= 1.0.2) 28 | actionview (5.2.4.3) 29 | activesupport (= 5.2.4.3) 30 | builder (~> 3.1) 31 | erubi (~> 1.4) 32 | rails-dom-testing (~> 2.0) 33 | rails-html-sanitizer (~> 1.0, >= 1.0.3) 34 | activejob (5.2.4.3) 35 | activesupport (= 5.2.4.3) 36 | globalid (>= 0.3.6) 37 | activemodel (5.2.4.3) 38 | activesupport (= 5.2.4.3) 39 | activerecord (5.2.4.3) 40 | activemodel (= 5.2.4.3) 41 | activesupport (= 5.2.4.3) 42 | arel (>= 9.0) 43 | activestorage (5.2.4.3) 44 | actionpack (= 5.2.4.3) 45 | activerecord (= 5.2.4.3) 46 | marcel (~> 0.3.1) 47 | activesupport (5.2.4.3) 48 | concurrent-ruby (~> 1.0, >= 1.0.2) 49 | i18n (>= 0.7, < 2) 50 | minitest (~> 5.1) 51 | tzinfo (~> 1.1) 52 | arel (9.0.0) 53 | ast (2.4.1) 54 | axiom-types (0.1.1) 55 | descendants_tracker (~> 0.0.4) 56 | ice_nine (~> 0.11.0) 57 | thread_safe (~> 0.3, >= 0.3.1) 58 | bootsnap (1.4.6) 59 | msgpack (~> 1.0) 60 | builder (3.2.4) 61 | coercible (1.0.0) 62 | descendants_tracker (~> 0.0.1) 63 | concurrent-ruby (1.2.2) 64 | crass (1.0.6) 65 | descendants_tracker (0.0.4) 66 | thread_safe (~> 0.3, >= 0.3.1) 67 | diff-lcs (1.4.2) 68 | equalizer (0.0.11) 69 | erubi (1.9.0) 70 | factory_bot (6.0.2) 71 | activesupport (>= 5.0.0) 72 | factory_bot_rails (6.0.0) 73 | factory_bot (~> 6.0.0) 74 | railties (>= 5.0.0) 75 | ffi (1.13.1) 76 | globalid (1.1.0) 77 | activesupport (>= 5.0) 78 | i18n (1.13.0) 79 | concurrent-ruby (~> 1.0) 80 | ice_nine (0.11.2) 81 | listen (3.2.1) 82 | rb-fsevent (~> 0.10, >= 0.10.3) 83 | rb-inotify (~> 0.9, >= 0.9.10) 84 | loofah (2.21.3) 85 | crass (~> 1.0.2) 86 | nokogiri (>= 1.12.0) 87 | mail (2.7.1) 88 | mini_mime (>= 0.1.1) 89 | marcel (0.3.3) 90 | mimemagic (~> 0.3.2) 91 | method_source (1.0.0) 92 | mimemagic (0.3.5) 93 | mini_mime (1.0.2) 94 | mini_portile2 (2.8.2) 95 | minitest (5.18.0) 96 | msgpack (1.3.3) 97 | nio4r (2.5.2) 98 | nokogiri (1.15.2) 99 | mini_portile2 (~> 2.8.2) 100 | racc (~> 1.4) 101 | parallel (1.19.2) 102 | parser (2.7.1.4) 103 | ast (~> 2.4.1) 104 | racc (1.6.2) 105 | rack (2.2.7) 106 | rack-test (1.1.0) 107 | rack (>= 1.0, < 3) 108 | rails (5.2.4.3) 109 | actioncable (= 5.2.4.3) 110 | actionmailer (= 5.2.4.3) 111 | actionpack (= 5.2.4.3) 112 | actionview (= 5.2.4.3) 113 | activejob (= 5.2.4.3) 114 | activemodel (= 5.2.4.3) 115 | activerecord (= 5.2.4.3) 116 | activestorage (= 5.2.4.3) 117 | activesupport (= 5.2.4.3) 118 | bundler (>= 1.3.0) 119 | railties (= 5.2.4.3) 120 | sprockets-rails (>= 2.0.0) 121 | rails-dom-testing (2.0.3) 122 | activesupport (>= 4.2.0) 123 | nokogiri (>= 1.6) 124 | rails-html-sanitizer (1.6.0) 125 | loofah (~> 2.21) 126 | nokogiri (~> 1.14) 127 | railties (5.2.4.3) 128 | actionpack (= 5.2.4.3) 129 | activesupport (= 5.2.4.3) 130 | method_source 131 | rake (>= 0.8.7) 132 | thor (>= 0.19.0, < 2.0) 133 | rainbow (3.0.0) 134 | rake (13.0.1) 135 | rb-fsevent (0.10.4) 136 | rb-inotify (0.10.1) 137 | ffi (~> 1.0) 138 | regexp_parser (1.7.1) 139 | rexml (3.2.4) 140 | rspec-core (3.9.2) 141 | rspec-support (~> 3.9.3) 142 | rspec-expectations (3.9.2) 143 | diff-lcs (>= 1.2.0, < 2.0) 144 | rspec-support (~> 3.9.0) 145 | rspec-mocks (3.9.1) 146 | diff-lcs (>= 1.2.0, < 2.0) 147 | rspec-support (~> 3.9.0) 148 | rspec-rails (4.0.1) 149 | actionpack (>= 4.2) 150 | activesupport (>= 4.2) 151 | railties (>= 4.2) 152 | rspec-core (~> 3.9) 153 | rspec-expectations (~> 3.9) 154 | rspec-mocks (~> 3.9) 155 | rspec-support (~> 3.9) 156 | rspec-support (3.9.3) 157 | rubocop (0.86.0) 158 | parallel (~> 1.10) 159 | parser (>= 2.7.0.1) 160 | rainbow (>= 2.2.2, < 4.0) 161 | regexp_parser (>= 1.7) 162 | rexml 163 | rubocop-ast (>= 0.0.3, < 1.0) 164 | ruby-progressbar (~> 1.7) 165 | unicode-display_width (>= 1.4.0, < 2.0) 166 | rubocop-ast (0.0.3) 167 | parser (>= 2.7.0.1) 168 | ruby-progressbar (1.10.1) 169 | shoulda-matchers (4.3.0) 170 | activesupport (>= 4.2.0) 171 | sprockets (4.0.2) 172 | concurrent-ruby (~> 1.0) 173 | rack (> 1, < 3) 174 | sprockets-rails (3.2.1) 175 | actionpack (>= 4.0) 176 | activesupport (>= 4.0) 177 | sprockets (>= 3.0.0) 178 | sqlite3 (1.4.2) 179 | thor (1.0.1) 180 | thread_safe (0.3.6) 181 | tzinfo (1.2.11) 182 | thread_safe (~> 0.1) 183 | unicode-display_width (1.7.0) 184 | virtus (1.0.5) 185 | axiom-types (~> 0.1) 186 | coercible (~> 1.0) 187 | descendants_tracker (~> 0.0, >= 0.0.3) 188 | equalizer (~> 0.0, >= 0.0.9) 189 | websocket-driver (0.7.2) 190 | websocket-extensions (>= 0.1.0) 191 | websocket-extensions (0.1.5) 192 | 193 | PLATFORMS 194 | ruby 195 | 196 | DEPENDENCIES 197 | base_form! 198 | bootsnap (~> 1.4) 199 | bundler (~> 2.1.4) 200 | factory_bot_rails (~> 6.0) 201 | listen (~> 3.0) 202 | rails (~> 5.2) 203 | rspec-rails (~> 4.0) 204 | rubocop (= 0.86.0) 205 | shoulda-matchers (~> 4) 206 | sqlite3 (~> 1.4.1) 207 | 208 | BUNDLED WITH 209 | 2.1.4 210 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # BaseForm 2 | [![Code Climate](https://codeclimate.com/github/andrerpbts/base_form/badges/gpa.svg)](https://codeclimate.com/github/andrerpbts/base_form) 3 | [![Test Coverage](https://codeclimate.com/github/andrerpbts/base_form/badges/coverage.svg)](https://codeclimate.com/github/andrerpbts/base_form/coverage) 4 | [![Build Status](https://travis-ci.org/andrerpbts/base_form.svg?branch=master)](https://travis-ci.org/andrerpbts/base_form) 5 | 6 | A simple and small Form Objects Rails plugin for ActiveRecord based projects. 7 | 8 | ## Why? 9 | In a development day-to-day basis, we commonly are confronted with situations where we 10 | need to save data in more than one database table, running it's own validations, and 11 | the validations of the all context together. In most cases a Form Object is a perfect 12 | solution to deliver those records in a fun and maintenable code. 13 | 14 | Actually, there are a lot of options you can pick in terms of gems to do that, like the great 15 | [reform](https://github.com/apotonick/reform) or 16 | [activeform-rails](https://github.com/GCorbel/activeform-rails), which are a more complete 17 | solution for this problem. But, if you are looking for something lighter, maybe this 18 | gem could fit well for you. 19 | 20 | ## Installation 21 | Add this line to your application's Gemfile: 22 | 23 | ```ruby 24 | gem 'base_form' 25 | ``` 26 | 27 | And then execute: 28 | ```bash 29 | $ bundle 30 | ``` 31 | 32 | Or install it yourself as: 33 | ```bash 34 | $ gem install base_form 35 | ``` 36 | 37 | ## Usage 38 | Let's suppose you want to create a 39 | signup form (you can check this example in the dummy app on this gem specs), with 40 | receiving a user email, a user password, a user password confirmation, and a plan. In your 41 | signup form, you need to create an account for this user, associate it to a entrance plan 42 | if it's not given, and make this user as an owner of this recently created account. Of course, 43 | in this case, a simple user model saving will not be sufficient to save all those data and 44 | accomplish with the requested business logic. So, you go to the Form Objects way, 45 | installs this gem, creates your Ruby class to handle all this logic: 46 | 47 | ```ruby 48 | class SignupForm < BaseForm::Form 49 | 50 | end 51 | ``` 52 | 53 | With this empty class created, the easy way to start may be adding the attributes expected 54 | in this form, like: 55 | 56 | ```ruby 57 | class SignupForm < BaseForm::Form 58 | attribute :email 59 | attribute :password 60 | attribute :password_confirmation 61 | attribute :plan, Plan, default: proc { Plan.default } 62 | end 63 | ``` 64 | 65 | Note, if you don't specifies a Plan to this form, it will call a default value, which in 66 | this case is calling a proc that will call a `default` method in `Plan` model and probably 67 | this will return the default plan instance, fetched from the database or something like that. 68 | 69 | Let's put some form specific validation here. For example, we don't want the Plan being forced 70 | with an empty string for example: 71 | 72 | ```ruby 73 | class SignupForm < BaseForm::Form 74 | # ... attributes, validations ... 75 | 76 | validates :plan, presence: true 77 | end 78 | ``` 79 | 80 | Now you may be asking: What about email and password? Shouldn't they be validated as well? 81 | Well, you could, in fact, add all validations in this form instead put it in your models, 82 | but sometimes you don't have much control of that. 83 | Then, I'm showing here the case that `User` model has those validations. Don't be mad ok? :) 84 | 85 | The form validations are the first validations tha are performed before it try to persist 86 | something here. If this validation fails, for an example, the persist method will not even 87 | be called, and we're done with it. Otherwise, it wil try to persist your logic, which we'll 88 | implement next. 89 | 90 | Ok, now, you need to set the records that you will persist here. 91 | In this case is the `:user` you want to save, and the `:account` you will want to associate 92 | to this user. So, you add it there (I recommend you let this in the top of the class to make 93 | it clear): 94 | 95 | ```ruby 96 | class SignupForm < BaseForm::Form 97 | use_form_records :user, :account 98 | 99 | # ... attributes, validations ... 100 | end 101 | ``` 102 | 103 | This line will automatically generate `attr_readers` to each record there, and will add these 104 | symbols in an array called `form_records` in your class. To understand it better, let's talk 105 | about the `persist` implementation itself. 106 | 107 | By the rule, the `persist` method is obligatory, and not implementing it, will cause your form 108 | raise a `NotImplementedError` when calling `save` to it. 109 | 110 | All things written inside `persist` method will automatically run in a ActiveRecord transaction, 111 | and if some record have its validation failed, this will perform a rollback and deliver the form 112 | to you with those errors grouped through `errors` method, like any AR model you are already 113 | familiar with. 114 | 115 | Let me stop to talk and show you something we can call as implementation of this: 116 | 117 | ```ruby 118 | class SignupForm < BaseForm::Form 119 | # form records, attributes, validations, whatever 120 | 121 | private # because isolation is still a necessary evil ;) 122 | 123 | def persist 124 | @account ||= Account.create plan: plan 125 | @user ||= account.users.create user_params 126 | end 127 | 128 | def user_params 129 | { 130 | email: email, 131 | password: password, 132 | password_confirmation: password_confirmation, 133 | account_owner: true 134 | } 135 | end 136 | end 137 | ``` 138 | 139 | So, here is the thing: check the variables names I've associated there are the names of 140 | form_records I've defined before. It tries to create an account setting a plan to it 141 | and then tries to create a user associated to this brand new account. 142 | 143 | This `form_records` will call each object associated here to check its errors, 144 | and group it in `errors` object in your form itself in case of some validation fails. 145 | If all is fine, the form instance is returned to you and you will be able to call 146 | methods like `persisted?`, `account`, `user`, `valid?` and etc... 147 | 148 | Are you still there? :D 149 | 150 | Let's see this class complete? 151 | 152 | ```ruby 153 | class SignupForm < BaseForm 154 | use_form_records :account, :user 155 | 156 | attribute :email 157 | attribute :password 158 | attribute :password_confirmation 159 | attribute :plan, Plan, default: proc { Plan.default } 160 | 161 | validates :plan, presence: true 162 | 163 | private 164 | 165 | def persist 166 | @account ||= Account.create plan: plan 167 | @user ||= account.users.create user_params 168 | end 169 | 170 | def user_params 171 | { 172 | email: email, 173 | password: password, 174 | password_confirmation: password_confirmation, 175 | account_owner: true 176 | } 177 | end 178 | end 179 | ``` 180 | 181 | Hmmm, this looks pretty nice! 182 | 183 | I hope this helps someone in the same way it helped me. Thanks! 184 | 185 | ## Contributing 186 | - Fork it 187 | - Make your implementations 188 | - Send me a pull request 189 | 190 | Thank you! 191 | 192 | ## License 193 | The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). 194 | --------------------------------------------------------------------------------