From b8a4628ad919ac785254414fc753e36ed6579039 Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Wed, 23 May 2018 15:46:10 +0200 Subject: [PATCH 1/9] Setup Devise --- Gemfile | 4 + Gemfile.lock | 16 ++ app/views/layouts/application.html.erb | 1 + app/views/shared/_notices.html.erb | 7 + config/environments/production.rb | 1 + config/initializers/devise.rb | 283 +++++++++++++++++++++++++ 6 files changed, 312 insertions(+) create mode 100644 app/views/shared/_notices.html.erb create mode 100644 config/initializers/devise.rb diff --git a/Gemfile b/Gemfile index c82704a..1fca694 100644 --- a/Gemfile +++ b/Gemfile @@ -10,6 +10,10 @@ gem 'rails-i18n', '~> 5.1' gem 'mysql2', '>= 0.4.4', '< 0.6.0' # Use Puma as the app server gem 'puma', '~> 3.11' + +gem 'devise', '~> 4.4' +gem 'devise-i18n', '~> 1.6' + # Use SCSS for stylesheets gem 'sass-rails', '~> 5.0' # Use Uglifier as compressor for JavaScript assets diff --git a/Gemfile.lock b/Gemfile.lock index ce54755..176c276 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -91,6 +91,14 @@ GEM nokogiri (~> 1.8) concurrent-ruby (1.0.5) crass (1.0.4) + devise (4.4.3) + bcrypt (~> 3.0) + orm_adapter (~> 0.1) + railties (>= 4.1.0, < 6.0) + responders + warden (~> 1.2.3) + devise-i18n (1.6.2) + devise (>= 4.4) erubi (1.7.1) execjs (2.7.0) ffi (1.9.23) @@ -127,6 +135,7 @@ GEM nio4r (2.3.1) nokogiri (1.8.2) mini_portile2 (~> 2.3.0) + orm_adapter (0.5.0) parallel (1.12.1) parser (2.5.1.0) ast (~> 2.4.0) @@ -170,6 +179,9 @@ GEM rb-fsevent (0.10.3) rb-inotify (0.9.10) ffi (>= 0.5.0, < 2) + responders (2.4.0) + actionpack (>= 4.2.0, < 5.3) + railties (>= 4.2.0, < 5.3) rubocop (0.56.0) parallel (~> 1.10) parser (>= 2.5) @@ -220,6 +232,8 @@ GEM uglifier (4.1.10) execjs (>= 0.3.0, < 3) unicode-display_width (1.3.2) + warden (1.2.7) + rack (>= 1.0) web-console (3.6.2) actionview (>= 5.0) activemodel (>= 5.0) @@ -249,6 +263,8 @@ DEPENDENCIES capistrano3-puma capybara (>= 2.15, < 4.0) chromedriver-helper + devise (~> 4.4) + devise-i18n (~> 1.6) jbuilder (~> 2.5) listen (>= 3.0.5, < 3.2) mysql2 (>= 0.4.4, < 0.6.0) diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb index 4f32288..c8596d2 100644 --- a/app/views/layouts/application.html.erb +++ b/app/views/layouts/application.html.erb @@ -10,6 +10,7 @@ + <%= render "shared/notices" %> <%= yield %> diff --git a/app/views/shared/_notices.html.erb b/app/views/shared/_notices.html.erb new file mode 100644 index 0000000..73d7675 --- /dev/null +++ b/app/views/shared/_notices.html.erb @@ -0,0 +1,7 @@ +<% if notice.present? %> + +<% end %> + +<% if alert.present? %> + +<% end %> diff --git a/config/environments/production.rb b/config/environments/production.rb index cc4ffa9..0ea521f 100644 --- a/config/environments/production.rb +++ b/config/environments/production.rb @@ -65,6 +65,7 @@ Rails.application.configure do # Ignore bad email addresses and do not raise email delivery errors. # Set this to true and configure the email server for immediate delivery to raise delivery errors. # config.action_mailer.raise_delivery_errors = false + config.action_mailer.default_url_options = { host: 'chexpire.evolix.org' } config.action_mailer.default_url_options = { host: config.chexpire.fetch("host") } diff --git a/config/initializers/devise.rb b/config/initializers/devise.rb new file mode 100644 index 0000000..58c5af8 --- /dev/null +++ b/config/initializers/devise.rb @@ -0,0 +1,283 @@ +# frozen_string_literal: true + +# Use this hook to configure devise mailer, warden hooks and so forth. +# Many of these configuration options can be set straight in your model. +Devise.setup do |config| + # The secret key used by Devise. Devise uses this key to generate + # random tokens. Changing this key will render invalid all existing + # confirmation, reset password and unlock tokens in the database. + # Devise will use the `secret_key_base` as its `secret_key` + # by default. You can change it below and use your own secret key. + # config.secret_key = '8f549ec39958c29ca197dac83983a245702b03dc82b42a253ce8efadbb92fb239bdaf5c35e38701a8daae56a20ffed8ad60b1d00d55d63547fb238f9c76a04d8' + + # ==> Controller configuration + # Configure the parent class to the devise controllers. + # config.parent_controller = 'DeviseController' + + # ==> Mailer Configuration + # Configure the e-mail address which will be shown in Devise::Mailer, + # note that it will be overwritten if you use your own mailer class + # with default "from" parameter. + config.mailer_sender = 'chexpire@evolix.org' + + # Configure the class responsible to send e-mails. + # config.mailer = 'Devise::Mailer' + + # Configure the parent class responsible to send e-mails. + # config.parent_mailer = 'ActionMailer::Base' + + # ==> ORM configuration + # Load and configure the ORM. Supports :active_record (default) and + # :mongoid (bson_ext recommended) by default. Other ORMs may be + # available as additional gems. + require 'devise/orm/active_record' + + # ==> Configuration for any authentication mechanism + # Configure which keys are used when authenticating a user. The default is + # just :email. You can configure it to use [:username, :subdomain], so for + # authenticating a user, both parameters are required. Remember that those + # parameters are used only when authenticating and not when retrieving from + # session. If you need permissions, you should implement that in a before filter. + # You can also supply a hash where the value is a boolean determining whether + # or not authentication should be aborted when the value is not present. + # config.authentication_keys = [:email] + + # Configure parameters from the request object used for authentication. Each entry + # given should be a request method and it will automatically be passed to the + # find_for_authentication method and considered in your model lookup. For instance, + # if you set :request_keys to [:subdomain], :subdomain will be used on authentication. + # The same considerations mentioned for authentication_keys also apply to request_keys. + # config.request_keys = [] + + # Configure which authentication keys should be case-insensitive. + # These keys will be downcased upon creating or modifying a user and when used + # to authenticate or find a user. Default is :email. + config.case_insensitive_keys = [:email] + + # Configure which authentication keys should have whitespace stripped. + # These keys will have whitespace before and after removed upon creating or + # modifying a user and when used to authenticate or find a user. Default is :email. + config.strip_whitespace_keys = [:email] + + # Tell if authentication through request.params is enabled. True by default. + # It can be set to an array that will enable params authentication only for the + # given strategies, for example, `config.params_authenticatable = [:database]` will + # enable it only for database (email + password) authentication. + # config.params_authenticatable = true + + # Tell if authentication through HTTP Auth is enabled. False by default. + # It can be set to an array that will enable http authentication only for the + # given strategies, for example, `config.http_authenticatable = [:database]` will + # enable it only for database authentication. The supported strategies are: + # :database = Support basic authentication with authentication key + password + # config.http_authenticatable = false + + # If 401 status code should be returned for AJAX requests. True by default. + # config.http_authenticatable_on_xhr = true + + # The realm used in Http Basic Authentication. 'Application' by default. + # config.http_authentication_realm = 'Application' + + # It will change confirmation, password recovery and other workflows + # to behave the same regardless if the e-mail provided was right or wrong. + # Does not affect registerable. + # config.paranoid = true + + # By default Devise will store the user in session. You can skip storage for + # particular strategies by setting this option. + # Notice that if you are skipping storage for all authentication paths, you + # may want to disable generating routes to Devise's sessions controller by + # passing skip: :sessions to `devise_for` in your config/routes.rb + config.skip_session_storage = [:http_auth] + + # By default, Devise cleans up the CSRF token on authentication to + # avoid CSRF token fixation attacks. This means that, when using AJAX + # requests for sign in and sign up, you need to get a new CSRF token + # from the server. You can disable this option at your own risk. + # config.clean_up_csrf_token_on_authentication = true + + # When false, Devise will not attempt to reload routes on eager load. + # This can reduce the time taken to boot the app but if your application + # requires the Devise mappings to be loaded during boot time the application + # won't boot properly. + # config.reload_routes = true + + # ==> Configuration for :database_authenticatable + # For bcrypt, this is the cost for hashing the password and defaults to 11. If + # using other algorithms, it sets how many times you want the password to be hashed. + # + # Limiting the stretches to just one in testing will increase the performance of + # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use + # a value less than 10 in other environments. Note that, for bcrypt (the default + # algorithm), the cost increases exponentially with the number of stretches (e.g. + # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation). + config.stretches = Rails.env.test? ? 1 : 11 + + # Set up a pepper to generate the hashed password. + # config.pepper = '45748e62356c886e2e25a8d4ca2f75324f7a658be0900136868e08784b820449d94913dea5f68336732ed1339939f1c996aebe0913b78d7ed179be600055ab0d' + + # Send a notification to the original email when the user's email is changed. + # config.send_email_changed_notification = false + + # Send a notification email when the user's password is changed. + # config.send_password_change_notification = false + + # ==> Configuration for :confirmable + # A period that the user is allowed to access the website even without + # confirming their account. For instance, if set to 2.days, the user will be + # able to access the website for two days without confirming their account, + # access will be blocked just in the third day. Default is 0.days, meaning + # the user cannot access the website without confirming their account. + # config.allow_unconfirmed_access_for = 2.days + + # A period that the user is allowed to confirm their account before their + # token becomes invalid. For example, if set to 3.days, the user can confirm + # their account within 3 days after the mail was sent, but on the fourth day + # their account can't be confirmed with the token any more. + # Default is nil, meaning there is no restriction on how long a user can take + # before confirming their account. + config.confirm_within = 3.days + + # If true, requires any email changes to be confirmed (exactly the same way as + # initial account confirmation) to be applied. Requires additional unconfirmed_email + # db field (see migrations). Until confirmed, new email is stored in + # unconfirmed_email column, and copied to email column on successful confirmation. + config.reconfirmable = true + + # Defines which key will be used when confirming an account + # config.confirmation_keys = [:email] + + # ==> Configuration for :rememberable + # The time the user will be remembered without asking for credentials again. + config.remember_for = 2.weeks + + # Invalidates all the remember me tokens when the user signs out. + config.expire_all_remember_me_on_sign_out = true + + # If true, extends the user's remember period when remembered via cookie. + # config.extend_remember_period = false + + # Options to be passed to the created cookie. For instance, you can set + # secure: true in order to force SSL only cookies. + # config.rememberable_options = {} + + # ==> Configuration for :validatable + # Range for password length. + config.password_length = 8..128 + + # Email regex used to validate email formats. It simply asserts that + # one (and only one) @ exists in the given string. This is mainly + # to give user feedback and not to assert the e-mail validity. + config.email_regexp = /\A[^@\s]+@[^@\s]+\z/ + + # ==> Configuration for :timeoutable + # The time you want to timeout the user session without activity. After this + # time the user will be asked for credentials again. Default is 30 minutes. + # config.timeout_in = 30.minutes + + # ==> Configuration for :lockable + # Defines which strategy will be used to lock an account. + # :failed_attempts = Locks an account after a number of failed attempts to sign in. + # :none = No lock strategy. You should handle locking by yourself. + # config.lock_strategy = :failed_attempts + + # Defines which key will be used when locking and unlocking an account + # config.unlock_keys = [:email] + + # Defines which strategy will be used to unlock an account. + # :email = Sends an unlock link to the user email + # :time = Re-enables login after a certain amount of time (see :unlock_in below) + # :both = Enables both strategies + # :none = No unlock strategy. You should handle unlocking by yourself. + # config.unlock_strategy = :both + + # Number of authentication tries before locking an account if lock_strategy + # is failed attempts. + # config.maximum_attempts = 20 + + # Time interval to unlock the account if :time is enabled as unlock_strategy. + # config.unlock_in = 1.hour + + # Warn on the last attempt before the account is locked. + # config.last_attempt_warning = true + + # ==> Configuration for :recoverable + # + # Defines which key will be used when recovering the password for an account + # config.reset_password_keys = [:email] + + # Time interval you can reset your password with a reset password key. + # Don't put a too small interval or your users won't have the time to + # change their passwords. + config.reset_password_within = 6.hours + + # When set to false, does not sign a user in automatically after their password is + # reset. Defaults to true, so a user is signed in automatically after a reset. + # config.sign_in_after_reset_password = true + + # ==> Configuration for :encryptable + # Allow you to use another hashing or encryption algorithm besides bcrypt (default). + # You can use :sha1, :sha512 or algorithms from others authentication tools as + # :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20 + # for default behavior) and :restful_authentication_sha1 (then you should set + # stretches to 10, and copy REST_AUTH_SITE_KEY to pepper). + # + # Require the `devise-encryptable` gem when using anything other than bcrypt + # config.encryptor = :sha512 + + # ==> Scopes configuration + # Turn scoped views on. Before rendering "sessions/new", it will first check for + # "users/sessions/new". It's turned off by default because it's slower if you + # are using only default views. + # config.scoped_views = false + + # Configure the default scope given to Warden. By default it's the first + # devise role declared in your routes (usually :user). + # config.default_scope = :user + + # Set this configuration to false if you want /users/sign_out to sign out + # only the current scope. By default, Devise signs out all scopes. + # config.sign_out_all_scopes = true + + # ==> Navigation configuration + # Lists the formats that should be treated as navigational. Formats like + # :html, should redirect to the sign in page when the user does not have + # access, but formats like :xml or :json, should return 401. + # + # If you have any extra navigational formats, like :iphone or :mobile, you + # should add them to the navigational formats lists. + # + # The "*/*" below is required to match Internet Explorer requests. + # config.navigational_formats = ['*/*', :html] + + # The default HTTP method used to sign out a resource. Default is :delete. + config.sign_out_via = :delete + + # ==> OmniAuth + # Add a new OmniAuth provider. Check the wiki for more information on setting + # up on your models and hooks. + # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo' + + # ==> Warden configuration + # If you want to use other strategies, that are not supported by Devise, or + # change the failure app, you can configure them inside the config.warden block. + # + # config.warden do |manager| + # manager.intercept_401 = false + # manager.default_strategies(scope: :user).unshift :some_external_strategy + # end + + # ==> Mountable engine configurations + # When using Devise inside an engine, let's call it `MyEngine`, and this engine + # is mountable, there are some extra configurations to be taken into account. + # The following options are available, assuming the engine is mounted as: + # + # mount MyEngine, at: '/my_engine' + # + # The router that invoked `devise_for`, in the example above, would be: + # config.router_name = :my_engine + # + # When using OmniAuth, Devise cannot automatically set OmniAuth path, + # so you need to do it manually. For the users scope, it would be: + # config.omniauth_path_prefix = '/my_engine/users/auth' +end From cd4286d0238cf75fd8f8e5b19c538fbfafceb589 Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Wed, 23 May 2018 17:57:56 +0200 Subject: [PATCH 2/9] More debug gems --- Gemfile | 4 +++- Gemfile.lock | 15 +++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 1fca694..2070385 100644 --- a/Gemfile +++ b/Gemfile @@ -39,7 +39,9 @@ gem 'bootsnap', '>= 1.1.0', require: false group :development, :test do # Call 'byebug' anywhere in the code to stop execution and get a debugger console - gem 'byebug', platforms: [:mri, :mingw, :x64_mingw] + gem 'binding_of_caller' + gem 'pry-byebug' + gem 'pry-rails' end group :development do diff --git a/Gemfile.lock b/Gemfile.lock index 176c276..c85abda 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -55,6 +55,8 @@ GEM ast (2.4.0) bcrypt (3.1.12) bindex (0.5.0) + binding_of_caller (0.8.0) + debug_inspector (>= 0.0.1) bootsnap (1.3.0) msgpack (~> 1.0) builder (3.2.3) @@ -89,8 +91,10 @@ GEM chromedriver-helper (1.2.0) archive-zip (~> 0.10) nokogiri (~> 1.8) + coderay (1.1.2) concurrent-ruby (1.0.5) crass (1.0.4) + debug_inspector (0.0.3) devise (4.4.3) bcrypt (~> 3.0) orm_adapter (~> 0.1) @@ -140,6 +144,14 @@ GEM parser (2.5.1.0) ast (~> 2.4.0) powerpack (0.1.1) + pry (0.11.3) + coderay (~> 1.1.0) + method_source (~> 0.9.0) + pry-byebug (3.6.0) + byebug (~> 10.0) + pry (~> 0.10) + pry-rails (0.3.6) + pry (>= 0.10.4) public_suffix (3.0.2) puma (3.11.4) rack (2.0.5) @@ -255,6 +267,7 @@ PLATFORMS DEPENDENCIES annotate bcrypt (~> 3.1.7) + binding_of_caller bootsnap (>= 1.1.0) byebug capistrano (~> 3.10) @@ -268,6 +281,8 @@ DEPENDENCIES jbuilder (~> 2.5) listen (>= 3.0.5, < 3.2) mysql2 (>= 0.4.4, < 0.6.0) + pry-byebug + pry-rails puma (~> 3.11) rails (~> 5.2.0) rails-i18n (~> 5.1) From ca4405139ed989bb1162fd6e679e417022f4a293 Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Wed, 23 May 2018 17:58:50 +0200 Subject: [PATCH 3/9] [yarn] rails-ujs --- app/javascript/packs/application.js | 3 +++ package.json | 3 ++- yarn.lock | 4 ++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/app/javascript/packs/application.js b/app/javascript/packs/application.js index a18eca2..6abc989 100644 --- a/app/javascript/packs/application.js +++ b/app/javascript/packs/application.js @@ -9,3 +9,6 @@ import 'bootstrap' import './src/application.scss' +import Rails from 'rails-ujs'; + +Rails.start() diff --git a/package.json b/package.json index bae2ca7..4dc959a 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "@rails/webpacker": "3.5", "bootstrap": "^4.1.1", "jquery": "^3.3.1", - "popper.js": "^1.14.3" + "popper.js": "^1.14.3", + "rails-ujs": "^5.2.0" }, "devDependencies": { "webpack-dev-server": "2.11.2" diff --git a/yarn.lock b/yarn.lock index d51071e..e12e366 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4622,6 +4622,10 @@ querystringify@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/querystringify/-/querystringify-2.0.0.tgz#fa3ed6e68eb15159457c89b37bc6472833195755" +rails-ujs@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/rails-ujs/-/rails-ujs-5.2.0.tgz#d93f7a969a226c0ae67044172955be8c1cdf49fc" + randomatic@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/randomatic/-/randomatic-3.0.0.tgz#d35490030eb4f7578de292ce6dfb04a91a128923" From e4b851fab1f2a0c773c87fd7a7c423be22b18c8d Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Thu, 24 May 2018 15:20:36 +0200 Subject: [PATCH 4/9] [GEM] + letter_opener_web --- Gemfile | 1 + Gemfile.lock | 11 ++++++++++- config/environments/development.rb | 3 +++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/Gemfile b/Gemfile index 2070385..5abedc3 100644 --- a/Gemfile +++ b/Gemfile @@ -54,6 +54,7 @@ group :development do gem 'rubocop', '~> 0.56.0', require: false gem 'annotate', require: false + gem 'letter_opener_web' gem 'capistrano-rails' gem "capistrano", "~> 3.10", require: false diff --git a/Gemfile.lock b/Gemfile.lock index c85abda..921a4e3 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -114,6 +114,14 @@ GEM jbuilder (2.7.0) activesupport (>= 4.2.0) multi_json (>= 1.2) + launchy (2.4.3) + addressable (~> 2.3) + letter_opener (1.6.0) + launchy (~> 2.2) + letter_opener_web (1.3.4) + actionmailer (>= 3.2) + letter_opener (~> 1.0) + railties (>= 3.2) listen (3.1.5) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) @@ -269,7 +277,6 @@ DEPENDENCIES bcrypt (~> 3.1.7) binding_of_caller bootsnap (>= 1.1.0) - byebug capistrano (~> 3.10) capistrano-rails capistrano-rbenv @@ -279,6 +286,8 @@ DEPENDENCIES devise (~> 4.4) devise-i18n (~> 1.6) jbuilder (~> 2.5) + launchy + letter_opener_web listen (>= 3.0.5, < 3.2) mysql2 (>= 0.4.4, < 0.6.0) pry-byebug diff --git a/config/environments/development.rb b/config/environments/development.rb index 3d9294e..1888e36 100644 --- a/config/environments/development.rb +++ b/config/environments/development.rb @@ -34,6 +34,9 @@ Rails.application.configure do # Store uploaded files on the local file system (see config/storage.yml for options) config.active_storage.service = :local + config.action_mailer.delivery_method = :letter_opener_web + config.action_mailer.perform_deliveries = true + # Don't care if the mailer can't send. config.action_mailer.raise_delivery_errors = false From b9b8024233af9afc8575631bbd549109e34eaee6 Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Thu, 24 May 2018 15:22:20 +0200 Subject: [PATCH 5/9] [GEM] +simple_form (with bootstrap) --- Gemfile | 1 + Gemfile.lock | 4 + config/initializers/simple_form.rb | 182 ++++++++ config/initializers/simple_form_bootstrap.rb | 439 +++++++++++++++++++ config/locales/simple_form.en.yml | 31 ++ lib/templates/erb/scaffold/_form.html.erb | 15 + 6 files changed, 672 insertions(+) create mode 100644 config/initializers/simple_form.rb create mode 100644 config/initializers/simple_form_bootstrap.rb create mode 100644 config/locales/simple_form.en.yml create mode 100644 lib/templates/erb/scaffold/_form.html.erb diff --git a/Gemfile b/Gemfile index 5abedc3..b8b7a33 100644 --- a/Gemfile +++ b/Gemfile @@ -13,6 +13,7 @@ gem 'puma', '~> 3.11' gem 'devise', '~> 4.4' gem 'devise-i18n', '~> 1.6' +gem 'simple_form', '~> 4.0' # Use SCSS for stylesheets gem 'sass-rails', '~> 5.0' diff --git a/Gemfile.lock b/Gemfile.lock index 921a4e3..978f671 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -226,6 +226,9 @@ GEM selenium-webdriver (3.12.0) childprocess (~> 0.5) rubyzip (~> 1.2) + simple_form (4.0.1) + actionpack (>= 5.0) + activemodel (>= 5.0) spring (2.0.2) activesupport (>= 4.2) spring-watcher-listen (2.0.1) @@ -298,6 +301,7 @@ DEPENDENCIES rubocop (~> 0.56.0) sass-rails (~> 5.0) selenium-webdriver + simple_form (~> 4.0) spring spring-watcher-listen (~> 2.0.0) turbolinks (~> 5) diff --git a/config/initializers/simple_form.rb b/config/initializers/simple_form.rb new file mode 100644 index 0000000..83718ea --- /dev/null +++ b/config/initializers/simple_form.rb @@ -0,0 +1,182 @@ +# frozen_string_literal: true +# +# Uncomment this and change the path if necessary to include your own +# components. +# See https://github.com/plataformatec/simple_form#custom-components to know +# more about custom components. +# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f } +# +# Use this setup block to configure all options available in SimpleForm. +SimpleForm.setup do |config| + # Wrappers are used by the form builder to generate a + # complete input. You can remove any component from the + # wrapper, change the order or even add your own to the + # stack. The options given below are used to wrap the + # whole input. + config.wrappers :default, class: :input, + hint_class: :field_with_hint, error_class: :field_with_errors, valid_class: :field_without_errors do |b| + ## Extensions enabled by default + # Any of these extensions can be disabled for a + # given input by passing: `f.input EXTENSION_NAME => false`. + # You can make any of these extensions optional by + # renaming `b.use` to `b.optional`. + + # Determines whether to use HTML5 (:email, :url, ...) + # and required attributes + b.use :html5 + + # Calculates placeholders automatically from I18n + # You can also pass a string as f.input placeholder: "Placeholder" + b.use :placeholder + + ## Optional extensions + # They are disabled unless you pass `f.input EXTENSION_NAME => true` + # to the input. If so, they will retrieve the values from the model + # if any exists. If you want to enable any of those + # extensions by default, you can change `b.optional` to `b.use`. + + # Calculates maxlength from length validations for string inputs + # and/or database column lengths + b.optional :maxlength + + # Calculate minlength from length validations for string inputs + b.optional :minlength + + # Calculates pattern from format validations for string inputs + b.optional :pattern + + # Calculates min and max from length validations for numeric inputs + b.optional :min_max + + # Calculates readonly automatically from readonly attributes + b.optional :readonly + + ## Inputs + # b.use :input, class: 'input', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :label_input + b.use :hint, wrap_with: { tag: :span, class: :hint } + b.use :error, wrap_with: { tag: :span, class: :error } + + ## full_messages_for + # If you want to display the full error message for the attribute, you can + # use the component :full_error, like: + # + # b.use :full_error, wrap_with: { tag: :span, class: :error } + end + + # The default wrapper to be used by the FormBuilder. + config.default_wrapper = :default + + # Define the way to render check boxes / radio buttons with labels. + # Defaults to :nested for bootstrap config. + # inline: input + label + # nested: label > input + config.boolean_style = :nested + + # Default class for buttons + config.button_class = 'btn' + + # Method used to tidy up errors. Specify any Rails Array method. + # :first lists the first message for each field. + # Use :to_sentence to list all errors for each field. + # config.error_method = :first + + # Default tag used for error notification helper. + config.error_notification_tag = :div + + # CSS class to add for error notification helper. + config.error_notification_class = 'error_notification' + + # ID to add for error notification helper. + # config.error_notification_id = nil + + # Series of attempts to detect a default label method for collection. + # config.collection_label_methods = [ :to_label, :name, :title, :to_s ] + + # Series of attempts to detect a default value method for collection. + # config.collection_value_methods = [ :id, :to_s ] + + # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none. + # config.collection_wrapper_tag = nil + + # You can define the class to use on all collection wrappers. Defaulting to none. + # config.collection_wrapper_class = nil + + # You can wrap each item in a collection of radio/check boxes with a tag, + # defaulting to :span. + # config.item_wrapper_tag = :span + + # You can define a class to use in all item wrappers. Defaulting to none. + # config.item_wrapper_class = nil + + # How the label text should be generated altogether with the required text. + # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" } + + # You can define the class to use on all labels. Default is nil. + # config.label_class = nil + + # You can define the default class to be used on forms. Can be overriden + # with `html: { :class }`. Defaulting to none. + # config.default_form_class = nil + + # You can define which elements should obtain additional classes + # config.generate_additional_classes_for = [:wrapper, :label, :input] + + # Whether attributes are required by default (or not). Default is true. + # config.required_by_default = true + + # Tell browsers whether to use the native HTML5 validations (novalidate form option). + # These validations are enabled in SimpleForm's internal config but disabled by default + # in this configuration, which is recommended due to some quirks from different browsers. + # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations, + # change this configuration to true. + config.browser_validations = false + + # Collection of methods to detect if a file type was given. + # config.file_methods = [ :mounted_as, :file?, :public_filename, :attached? ] + + # Custom mappings for input types. This should be a hash containing a regexp + # to match as key, and the input type that will be used when the field name + # matches the regexp as value. + # config.input_mappings = { /count/ => :integer } + + # Custom wrappers for input types. This should be a hash containing an input + # type as key and the wrapper that will be used for all inputs with specified type. + # config.wrapper_mappings = { string: :prepend } + + # Namespaces where SimpleForm should look for custom input classes that + # override default inputs. + # config.custom_inputs_namespaces << "CustomInputs" + + # Default priority for time_zone inputs. + # config.time_zone_priority = nil + + # Default priority for country inputs. + # config.country_priority = nil + + # When false, do not use translations for labels. + # config.translate_labels = true + + # Automatically discover new inputs in Rails' autoload path. + # config.inputs_discovery = true + + # Cache SimpleForm inputs discovery + # config.cache_discovery = !Rails.env.development? + + # Default class for inputs + # config.input_class = nil + + # Define the default class of the input wrapper of the boolean input. + config.boolean_label_class = 'checkbox' + + # Defines if the default input wrapper class should be included in radio + # collection wrappers. + # config.include_default_input_wrapper_class = true + + # Defines which i18n scope will be used in Simple Form. + # config.i18n_scope = 'simple_form' + + # Defines validation classes to the input_field. By default it's nil. + # config.input_field_valid_class = 'is-valid' + # config.input_field_error_class = 'is-invalid' +end diff --git a/config/initializers/simple_form_bootstrap.rb b/config/initializers/simple_form_bootstrap.rb new file mode 100644 index 0000000..0178fd5 --- /dev/null +++ b/config/initializers/simple_form_bootstrap.rb @@ -0,0 +1,439 @@ +# frozen_string_literal: true + +# Please do not make direct changes to this file! +# This generator is maintained by the community around simple_form-bootstrap: +# https://github.com/rafaelfranca/simple_form-bootstrap +# All future development, tests, and organization should happen there. +# Background history: https://github.com/plataformatec/simple_form/issues/1561 + +# Uncomment this and change the path if necessary to include your own +# components. +# See https://github.com/plataformatec/simple_form#custom-components +# to know more about custom components. +# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f } + +# Use this setup block to configure all options available in SimpleForm. +SimpleForm.setup do |config| + # Default class for buttons + config.button_class = 'btn' + + # Define the default class of the input wrapper of the boolean input. + config.boolean_label_class = 'form-check-label' + + # How the label text should be generated altogether with the required text. + config.label_text = lambda { |label, required, explicit_label| "#{label} #{required}" } + + # Define the way to render check boxes / radio buttons with labels. + config.boolean_style = :inline + + # You can wrap each item in a collection of radio/check boxes with a tag + config.item_wrapper_tag = :div + + # Defines if the default input wrapper class should be included in radio + # collection wrappers. + config.include_default_input_wrapper_class = false + + # CSS class to add for error notification helper. + config.error_notification_class = 'alert alert-danger' + + # Method used to tidy up errors. Specify any Rails Array method. + # :first lists the first message for each field. + # :to_sentence to list all errors for each field. + config.error_method = :to_sentence + + # add validation classes to `input_field` + config.input_field_error_class = 'is-invalid' + config.input_field_valid_class = 'is-valid' + + + # vertical forms + # + # vertical default_wrapper + config.wrappers :vertical_form, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :maxlength + b.optional :minlength + b.optional :pattern + b.optional :min_max + b.optional :readonly + b.use :label, class: 'form-control-label' + b.use :input, class: 'form-control', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # vertical input for boolean + config.wrappers :vertical_boolean, tag: 'fieldset', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper :form_check_wrapper, tag: 'div', class: 'form-check' do |bb| + bb.use :input, class: 'form-check-input', error_class: 'is-invalid', valid_class: 'is-valid' + bb.use :label, class: 'form-check-label' + bb.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + bb.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + # vertical input for radio buttons and check boxes + config.wrappers :vertical_collection, item_wrapper_class: 'form-check', tag: 'fieldset', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper :legend_tag, tag: 'legend', class: 'col-form-label pt-0' do |ba| + ba.use :label_text + end + b.use :input, class: 'form-check-input', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # vertical input for inline radio buttons and check boxes + config.wrappers :vertical_collection_inline, item_wrapper_class: 'form-check form-check-inline', tag: 'fieldset', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper :legend_tag, tag: 'legend', class: 'col-form-label pt-0' do |ba| + ba.use :label_text + end + b.use :input, class: 'form-check-input', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # vertical file input + config.wrappers :vertical_file, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :maxlength + b.optional :minlength + b.optional :readonly + b.use :label + b.use :input, class: 'form-control-file', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # vertical multi select + config.wrappers :vertical_multi_select, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.use :label, class: 'form-control-label' + b.wrapper tag: 'div', class: 'd-flex flex-row justify-content-between align-items-center' do |ba| + ba.use :input, class: 'form-control mx-1', error_class: 'is-invalid', valid_class: 'is-valid' + end + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # vertical range input + config.wrappers :vertical_range, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :readonly + b.optional :step + b.use :label + b.use :input, class: 'form-control-range', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + + # horizontal forms + # + # horizontal default_wrapper + config.wrappers :horizontal_form, tag: 'div', class: 'form-group row', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :maxlength + b.optional :minlength + b.optional :pattern + b.optional :min_max + b.optional :readonly + b.use :label, class: 'col-sm-3 col-form-label' + b.wrapper :grid_wrapper, tag: 'div', class: 'col-sm-9' do |ba| + ba.use :input, class: 'form-control', error_class: 'is-invalid', valid_class: 'is-valid' + ba.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + ba.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + # horizontal input for boolean + config.wrappers :horizontal_boolean, tag: 'div', class: 'form-group row', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper tag: 'label', class: 'col-sm-3' do |ba| + ba.use :label_text + end + b.wrapper :grid_wrapper, tag: 'div', class: 'col-sm-9' do |wr| + wr.wrapper :form_check_wrapper, tag: 'div', class: 'form-check' do |bb| + bb.use :input, class: 'form-check-input', error_class: 'is-invalid', valid_class: 'is-valid' + bb.use :label, class: 'form-check-label' + bb.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + bb.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + end + + # horizontal input for radio buttons and check boxes + config.wrappers :horizontal_collection, item_wrapper_class: 'form-check', tag: 'div', class: 'form-group row', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.use :label, class: 'col-sm-3 form-control-label' + b.wrapper :grid_wrapper, tag: 'div', class: 'col-sm-9' do |ba| + ba.use :input, class: 'form-check-input', error_class: 'is-invalid', valid_class: 'is-valid' + ba.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + ba.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + # horizontal input for inline radio buttons and check boxes + config.wrappers :horizontal_collection_inline, item_wrapper_class: 'form-check form-check-inline', tag: 'div', class: 'form-group row', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.use :label, class: 'col-sm-3 form-control-label' + b.wrapper :grid_wrapper, tag: 'div', class: 'col-sm-9' do |ba| + ba.use :input, class: 'form-check-input', error_class: 'is-invalid', valid_class: 'is-valid' + ba.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + ba.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + # horizontal file input + config.wrappers :horizontal_file, tag: 'div', class: 'form-group row', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :maxlength + b.optional :minlength + b.optional :readonly + b.use :label, class: 'col-sm-3 form-control-label' + b.wrapper :grid_wrapper, tag: 'div', class: 'col-sm-9' do |ba| + ba.use :input, error_class: 'is-invalid', valid_class: 'is-valid' + ba.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + ba.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + # horizontal multi select + config.wrappers :horizontal_multi_select, tag: 'div', class: 'form-group row', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.use :label, class: 'col-sm-3 control-label' + b.wrapper :grid_wrapper, tag: 'div', class: 'col-sm-9' do |ba| + ba.wrapper tag: 'div', class: 'd-flex flex-row justify-content-between align-items-center' do |bb| + bb.use :input, class: 'form-control mx-1', error_class: 'is-invalid', valid_class: 'is-valid' + end + ba.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + ba.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + # horizontal range input + config.wrappers :horizontal_range, tag: 'div', class: 'form-group row', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :readonly + b.optional :step + b.use :label, class: 'col-sm-3 form-control-label' + b.wrapper :grid_wrapper, tag: 'div', class: 'col-sm-9' do |ba| + ba.use :input, class: 'form-control-range', error_class: 'is-invalid', valid_class: 'is-valid' + ba.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + ba.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + + # inline forms + # + # inline default_wrapper + config.wrappers :inline_form, tag: 'span', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :maxlength + b.optional :minlength + b.optional :pattern + b.optional :min_max + b.optional :readonly + b.use :label, class: 'sr-only' + + b.use :input, class: 'form-control', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + b.optional :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # inline input for boolean + config.wrappers :inline_boolean, tag: 'span', class: 'form-check flex-wrap justify-content-start mr-sm-2', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.use :input, class: 'form-check-input', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :label, class: 'form-check-label' + b.use :error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + b.optional :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + + # bootstrap custom forms + # + # custom input for boolean + config.wrappers :custom_boolean, tag: 'fieldset', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper :form_check_wrapper, tag: 'div', class: 'custom-control custom-checkbox' do |bb| + bb.use :input, class: 'custom-control-input', error_class: 'is-invalid', valid_class: 'is-valid' + bb.use :label, class: 'custom-control-label' + bb.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + bb.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + config.wrappers :custom_boolean_switch, tag: 'fieldset', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper :form_check_wrapper, tag: 'div', class: 'custom-control custom-checkbox-switch' do |bb| + bb.use :input, class: 'custom-control-input', error_class: 'is-invalid', valid_class: 'is-valid' + bb.use :label, class: 'custom-control-label' + bb.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + bb.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + end + + # custom input for radio buttons and check boxes + config.wrappers :custom_collection, item_wrapper_class: 'custom-control', tag: 'fieldset', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper :legend_tag, tag: 'legend', class: 'col-form-label pt-0' do |ba| + ba.use :label_text + end + b.use :input, class: 'custom-control-input', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # custom input for inline radio buttons and check boxes + config.wrappers :custom_collection_inline, item_wrapper_class: 'custom-control custom-control-inline', tag: 'fieldset', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.wrapper :legend_tag, tag: 'legend', class: 'col-form-label pt-0' do |ba| + ba.use :label_text + end + b.use :input, class: 'custom-control-input', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # custom file input + config.wrappers :custom_file, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :maxlength + b.optional :minlength + b.optional :readonly + b.use :label, class: 'form-control-label' + b.wrapper :custom_file_wrapper, tag: 'div', class: 'custom-file' do |ba| + ba.use :input, class: 'custom-file-input', error_class: 'is-invalid', valid_class: 'is-valid' + ba.use :label, class: 'custom-file-label' + ba.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + end + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # custom multi select + config.wrappers :custom_multi_select, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.use :label, class: 'form-control-label' + b.wrapper tag: 'div', class: 'd-flex flex-row justify-content-between align-items-center' do |ba| + ba.use :input, class: 'custom-select mx-1', error_class: 'is-invalid', valid_class: 'is-valid' + end + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # custom range input + config.wrappers :custom_range, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :readonly + b.optional :step + b.use :label, class: 'form-control-label' + b.use :input, class: 'custom-range', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + + # Input Group - custom component + # see example app and config at https://github.com/rafaelfranca/simple_form-bootstrap + # config.wrappers :input_group, tag: 'div', class: 'form-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + # b.use :html5 + # b.use :placeholder + # b.optional :maxlength + # b.optional :minlength + # b.optional :pattern + # b.optional :min_max + # b.optional :readonly + # b.use :label, class: 'form-control-label' + # b.wrapper :input_group_tag, tag: 'div', class: 'input-group' do |ba| + # ba.optional :prepend + # ba.use :input, class: 'form-control', error_class: 'is-invalid', valid_class: 'is-valid' + # ba.optional :append + # end + # b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback d-block' } + # b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + # end + + + # Floating Labels form + # + # floating labels default_wrapper + config.wrappers :floating_labels_form, tag: 'div', class: 'form-label-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.use :placeholder + b.optional :maxlength + b.optional :minlength + b.optional :pattern + b.optional :min_max + b.optional :readonly + b.use :input, class: 'form-control', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :label, class: 'form-control-label' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + # custom multi select + config.wrappers :floating_labels_select, tag: 'div', class: 'form-label-group', error_class: 'form-group-invalid', valid_class: 'form-group-valid' do |b| + b.use :html5 + b.optional :readonly + b.use :input, class: 'custom-select custom-select-lg', error_class: 'is-invalid', valid_class: 'is-valid' + b.use :label, class: 'form-control-label' + b.use :full_error, wrap_with: { tag: 'div', class: 'invalid-feedback' } + b.use :hint, wrap_with: { tag: 'small', class: 'form-text text-muted' } + end + + + # The default wrapper to be used by the FormBuilder. + config.default_wrapper = :vertical_form + + # Custom wrappers for input types. This should be a hash containing an input + # type as key and the wrapper that will be used for all inputs with specified type. + config.wrapper_mappings = { + boolean: :vertical_boolean, + check_boxes: :vertical_collection, + date: :vertical_multi_select, + datetime: :vertical_multi_select, + file: :vertical_file, + radio_buttons: :vertical_collection, + range: :vertical_range, + time: :vertical_multi_select + } + + # enable custom form wrappers + # config.wrapper_mappings = { + # boolean: :custom_boolean, + # check_boxes: :custom_collection, + # date: :custom_multi_select, + # datetime: :custom_multi_select, + # file: :custom_file, + # radio_buttons: :custom_collection, + # range: :custom_range, + # time: :custom_multi_select + # } +end diff --git a/config/locales/simple_form.en.yml b/config/locales/simple_form.en.yml new file mode 100644 index 0000000..2374383 --- /dev/null +++ b/config/locales/simple_form.en.yml @@ -0,0 +1,31 @@ +en: + simple_form: + "yes": 'Yes' + "no": 'No' + required: + text: 'required' + mark: '*' + # You can uncomment the line below if you need to overwrite the whole required html. + # When using html, text and mark won't be used. + # html: '*' + error_notification: + default_message: "Please review the problems below:" + # Examples + # labels: + # defaults: + # password: 'Password' + # user: + # new: + # email: 'E-mail to sign in.' + # edit: + # email: 'E-mail.' + # hints: + # defaults: + # username: 'User name to sign in.' + # password: 'No special characters, please.' + # include_blanks: + # defaults: + # age: 'Rather not say' + # prompts: + # defaults: + # age: 'Select your age' diff --git a/lib/templates/erb/scaffold/_form.html.erb b/lib/templates/erb/scaffold/_form.html.erb new file mode 100644 index 0000000..106b71e --- /dev/null +++ b/lib/templates/erb/scaffold/_form.html.erb @@ -0,0 +1,15 @@ +<%# frozen_string_literal: true %> +<%%= simple_form_for(@<%= singular_table_name %>) do |f| %> + <%%= f.error_notification %> + <%%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %> + +
+ <%- attributes.each do |attribute| -%> + <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %> + <%- end -%> +
+ +
+ <%%= f.button :submit %> +
+<%% end %> From 138b554772c4a8ceb31d54d0ab56549439418386 Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Wed, 23 May 2018 17:59:28 +0200 Subject: [PATCH 6/9] User with devise, basic integration in navbar with simple form & tests --- .travis.yml | 1 + Gemfile | 1 + app/helpers/users_helper.rb | 12 ++++ app/javascript/packs/src/application.scss | 1 + .../packs/src/components/users.scss | 5 ++ app/models/user.rb | 35 +++++++++++ app/views/devise/confirmations/new.html.erb | 12 ++++ .../mailer/confirmation_instructions.html.erb | 4 ++ .../devise/mailer/email_changed.html.erb | 7 +++ .../devise/mailer/password_change.html.erb | 3 + .../reset_password_instructions.html.erb | 8 +++ .../mailer/unlock_instructions.html.erb | 7 +++ app/views/devise/passwords/edit.html.erb | 16 +++++ app/views/devise/passwords/new.html.erb | 11 ++++ app/views/devise/registrations/edit.html.erb | 40 ++++++++++++ app/views/devise/registrations/new.html.erb | 16 +++++ app/views/devise/sessions/new.html.erb | 16 +++++ app/views/devise/shared/_links.html.erb | 25 ++++++++ app/views/devise/unlocks/new.html.erb | 11 ++++ app/views/layouts/application.html.erb | 2 + .../shared/_devise_form_container.html.erb | 7 +++ app/views/shared/_navbar.html.erb | 31 ++++++++++ config/initializers/devise.rb | 2 +- config/locales/en.yml | 38 ++---------- config/routes.rb | 43 ++++++++++--- .../20180523145630_devise_create_users.rb | 44 +++++++++++++ db/schema.rb | 24 +++++++- test/application_system_test_case.rb | 2 +- test/fixtures/users.yml | 39 ++++++++++++ test/models/user_test.rb | 36 +++++++++++ test/system/users_test.rb | 61 +++++++++++++++++++ test/test_helper.rb | 12 ++++ 32 files changed, 530 insertions(+), 42 deletions(-) create mode 100644 app/helpers/users_helper.rb create mode 100644 app/javascript/packs/src/components/users.scss create mode 100644 app/models/user.rb create mode 100644 app/views/devise/confirmations/new.html.erb create mode 100644 app/views/devise/mailer/confirmation_instructions.html.erb create mode 100644 app/views/devise/mailer/email_changed.html.erb create mode 100644 app/views/devise/mailer/password_change.html.erb create mode 100644 app/views/devise/mailer/reset_password_instructions.html.erb create mode 100644 app/views/devise/mailer/unlock_instructions.html.erb create mode 100644 app/views/devise/passwords/edit.html.erb create mode 100644 app/views/devise/passwords/new.html.erb create mode 100644 app/views/devise/registrations/edit.html.erb create mode 100644 app/views/devise/registrations/new.html.erb create mode 100644 app/views/devise/sessions/new.html.erb create mode 100644 app/views/devise/shared/_links.html.erb create mode 100644 app/views/devise/unlocks/new.html.erb create mode 100644 app/views/shared/_devise_form_container.html.erb create mode 100644 app/views/shared/_navbar.html.erb create mode 100644 db/migrate/20180523145630_devise_create_users.rb create mode 100644 test/fixtures/users.yml create mode 100644 test/models/user_test.rb create mode 100644 test/system/users_test.rb diff --git a/.travis.yml b/.travis.yml index 48e05b4..fc77036 100644 --- a/.travis.yml +++ b/.travis.yml @@ -24,3 +24,4 @@ install: script: - bundle exec rubocop - bundle exec rails test + - bundle exec rails test:system diff --git a/Gemfile b/Gemfile index b8b7a33..3a119d1 100644 --- a/Gemfile +++ b/Gemfile @@ -69,6 +69,7 @@ group :test do gem 'selenium-webdriver' # Easy installation and use of chromedriver to run system tests with Chrome gem 'chromedriver-helper' + gem 'launchy' end # Windows does not include zoneinfo files, so bundle the tzinfo-data gem diff --git a/app/helpers/users_helper.rb b/app/helpers/users_helper.rb new file mode 100644 index 0000000..7aa200d --- /dev/null +++ b/app/helpers/users_helper.rb @@ -0,0 +1,12 @@ +module UsersHelper + # Inject a devise template inside a same container + # while translation form keys are still valid + # (original partial scope is preserved) + def devise_form_container + content_for(:devise_form_content) do + yield + end + + render "shared/devise_form_container" + end +end diff --git a/app/javascript/packs/src/application.scss b/app/javascript/packs/src/application.scss index 5de3350..f6121ca 100644 --- a/app/javascript/packs/src/application.scss +++ b/app/javascript/packs/src/application.scss @@ -1 +1,2 @@ @import '~bootstrap/scss/bootstrap'; +@import 'components/users'; diff --git a/app/javascript/packs/src/components/users.scss b/app/javascript/packs/src/components/users.scss new file mode 100644 index 0000000..dc42ca4 --- /dev/null +++ b/app/javascript/packs/src/components/users.scss @@ -0,0 +1,5 @@ +.new_user { + .form-check-label.boolean { + color: inherit; + } +} diff --git a/app/models/user.rb b/app/models/user.rb new file mode 100644 index 0000000..791ed72 --- /dev/null +++ b/app/models/user.rb @@ -0,0 +1,35 @@ +# == Schema Information +# +# Table name: users +# +# id :bigint(8) not null, primary key +# confirmation_sent_at :datetime +# confirmation_token :string(255) +# confirmed_at :datetime +# current_sign_in_at :datetime +# current_sign_in_ip :string(255) +# email :string(255) default(""), not null +# encrypted_password :string(255) default(""), not null +# last_sign_in_at :datetime +# last_sign_in_ip :string(255) +# remember_created_at :datetime +# reset_password_sent_at :datetime +# reset_password_token :string(255) +# sign_in_count :integer default(0), not null +# unconfirmed_email :string(255) +# created_at :datetime not null +# updated_at :datetime not null +# +# Indexes +# +# index_users_on_confirmation_token (confirmation_token) UNIQUE +# index_users_on_email (email) UNIQUE +# index_users_on_reset_password_token (reset_password_token) UNIQUE +# + +class User < ApplicationRecord + # Include default devise modules. Others available are: + # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable + devise :database_authenticatable, :registerable, + :recoverable, :rememberable, :validatable, :confirmable +end diff --git a/app/views/devise/confirmations/new.html.erb b/app/views/devise/confirmations/new.html.erb new file mode 100644 index 0000000..474e5a0 --- /dev/null +++ b/app/views/devise/confirmations/new.html.erb @@ -0,0 +1,12 @@ +<%= devise_form_container do %> +

<%= t('.resend_confirmation_instructions') %>

+ + <%= simple_form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %> + <%= f.input :email, autofocus: true, autocomplete: "email", + label: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email) %> + + <%= f.button :submit, t('.resend_confirmation_instructions'), class: "btn-primary" %> + <% end %> + + <%= render "devise/shared/links" %> +<% end %> diff --git a/app/views/devise/mailer/confirmation_instructions.html.erb b/app/views/devise/mailer/confirmation_instructions.html.erb new file mode 100644 index 0000000..c57770b --- /dev/null +++ b/app/views/devise/mailer/confirmation_instructions.html.erb @@ -0,0 +1,4 @@ +

<%= t('.greeting', recipient: @email) %>

+ +

<%= t('.instruction') %>

+

<%= link_to t('.action'), confirmation_url(@resource, confirmation_token: @token) %>

diff --git a/app/views/devise/mailer/email_changed.html.erb b/app/views/devise/mailer/email_changed.html.erb new file mode 100644 index 0000000..0402428 --- /dev/null +++ b/app/views/devise/mailer/email_changed.html.erb @@ -0,0 +1,7 @@ +

<%= t('.greeting', recipient: @email) %>

+ +<% if @resource.try(:unconfirmed_email?) %> +

<%= t('.message', email: @resource.unconfirmed_email) %>

+<% else %> +

<%= t('.message', email: @resource.email) %>

+<% end %> diff --git a/app/views/devise/mailer/password_change.html.erb b/app/views/devise/mailer/password_change.html.erb new file mode 100644 index 0000000..a30313b --- /dev/null +++ b/app/views/devise/mailer/password_change.html.erb @@ -0,0 +1,3 @@ +

<%= t('.greeting', recipient: @resource.email) %>

+ +

<%= t('.message') %>

diff --git a/app/views/devise/mailer/reset_password_instructions.html.erb b/app/views/devise/mailer/reset_password_instructions.html.erb new file mode 100644 index 0000000..6c22abf --- /dev/null +++ b/app/views/devise/mailer/reset_password_instructions.html.erb @@ -0,0 +1,8 @@ +

<%= t('.greeting', recipient: @resource.email) %>

+ +

<%= t('.instruction') %>

+ +

<%= link_to t('.action'), edit_password_url(@resource, reset_password_token: @token) %>

+ +

<%= t('.instruction_2') %>

+

<%= t('.instruction_3') %>

diff --git a/app/views/devise/mailer/unlock_instructions.html.erb b/app/views/devise/mailer/unlock_instructions.html.erb new file mode 100644 index 0000000..84d0981 --- /dev/null +++ b/app/views/devise/mailer/unlock_instructions.html.erb @@ -0,0 +1,7 @@ +

<%= t('.greeting', recipient: @resource.email) %>

+ +

<%= t('.message') %>

+ +

<%= t('.instruction') %>

+ +

<%= link_to t('.action'), unlock_url(@resource, unlock_token: @token) %>

diff --git a/app/views/devise/passwords/edit.html.erb b/app/views/devise/passwords/edit.html.erb new file mode 100644 index 0000000..964ded5 --- /dev/null +++ b/app/views/devise/passwords/edit.html.erb @@ -0,0 +1,16 @@ +<%= devise_form_container do %> +

<%= t('.change_your_password') %>

+ + <%= simple_form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %> + <%= f.hidden_field :reset_password_token %> + + <%= f.input :password, label: t('.new_password'), autocomplete: "off", + hint: t('devise.shared.minimum_password_length', count: @minimum_password_length) %> + + <%= f.input :password_confirmation, label: t('.confirm_new_password'), autocomplete: "off" %> + + <%= f.button :submit, t('.change_my_password'), class: "btn-primary" %> + <% end %> + + <%= render "devise/shared/links" %> +<% end %> diff --git a/app/views/devise/passwords/new.html.erb b/app/views/devise/passwords/new.html.erb new file mode 100644 index 0000000..0fefc18 --- /dev/null +++ b/app/views/devise/passwords/new.html.erb @@ -0,0 +1,11 @@ +<%= devise_form_container do %> +

<%= t('.forgot_your_password') %>

+ + <%= simple_form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f| %> + <%= f.input :email, autofocus: true, autocomplete: "email" %> + + <%= f.button :submit, t('.send_me_reset_password_instructions'), class: "btn-primary" %> + <% end %> + + <%= render "devise/shared/links" %> +<% end %> diff --git a/app/views/devise/registrations/edit.html.erb b/app/views/devise/registrations/edit.html.erb new file mode 100644 index 0000000..9d99eb0 --- /dev/null +++ b/app/views/devise/registrations/edit.html.erb @@ -0,0 +1,40 @@ +<%= devise_form_container do %> +

<%= t('.title', resource: resource_name.to_s.humanize) %>

+ + + <%= simple_form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f| %> + <%= f.input :email, autofocus: true, autocomplete: "email" %> + + <% if devise_mapping.confirmable? && resource.pending_reconfirmation? %> +
+ <%= t('.currently_waiting_confirmation_for_email', email: resource.unconfirmed_email) %> +
+ <% end %> + + <%= f.input :current_password, + autocomplete: "off", + hint: t('.we_need_your_current_password_to_confirm_your_changes') %> + +
+

Want to change your password ?

+ <%= f.input :password, + autocomplete: "off", + hint: (t('devise.shared.minimum_password_length', count: @minimum_password_length) + + " " + t('.leave_blank_if_you_don_t_want_to_change_it'))%> + + <%= f.input :password_confirmation, autocomplete: "off" %> +
+ + + <%= f.button :submit, t('.update'), class: "btn-primary" %> + <% end %> + +

<%= t('.cancel_my_account') %>

+ +

<%= t('.unhappy') %> <%= + button_to t('.cancel_my_account'), registration_path(resource_name), + class: "btn btn-danger", + data: { confirm: t('.are_you_sure') }, method: :delete %>

+ + <%= link_to t('devise.shared.links.back'), :back %> +<% end %> diff --git a/app/views/devise/registrations/new.html.erb b/app/views/devise/registrations/new.html.erb new file mode 100644 index 0000000..ed81d21 --- /dev/null +++ b/app/views/devise/registrations/new.html.erb @@ -0,0 +1,16 @@ +<%= devise_form_container do %> +

<%= t('.sign_up') %>

+ + <%= simple_form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %> + <%= f.input :email, autofocus: true, autocomplete: "email" %> + + <%= f.input :password, autocomplete: "off", + hint: t('devise.shared.minimum_password_length', count: @minimum_password_length) %> + + <%= f.input :password_confirmation, autocomplete: "off" %> + + <%= f.button :submit, t('.sign_up'), class: "btn-primary" %> + <% end %> + + <%= render "devise/shared/links" %> +<% end %> diff --git a/app/views/devise/sessions/new.html.erb b/app/views/devise/sessions/new.html.erb new file mode 100644 index 0000000..a40f03a --- /dev/null +++ b/app/views/devise/sessions/new.html.erb @@ -0,0 +1,16 @@ +<%= devise_form_container do %> +

<%= t('.sign_in') %>

+ + <%= simple_form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %> + <%= f.input :email, autofocus: true, autocomplete: "email" %> + <%= f.input :password, autocomplete: "off" %> + + <% if devise_mapping.rememberable? -%> + <%= f.input :remember_me, as: :boolean %> + <% end -%> + + <%= f.button :submit, t('.sign_in'), class: "btn-primary" %> + <% end %> + + <%= render "devise/shared/links" %> +<% end %> diff --git a/app/views/devise/shared/_links.html.erb b/app/views/devise/shared/_links.html.erb new file mode 100644 index 0000000..f07506a --- /dev/null +++ b/app/views/devise/shared/_links.html.erb @@ -0,0 +1,25 @@ +<%- if controller_name != 'sessions' %> + <%= link_to t(".sign_in"), new_session_path(resource_name) %>
+<% end -%> + +<%- if devise_mapping.registerable? && controller_name != 'registrations' %> + <%= link_to t(".sign_up"), new_registration_path(resource_name) %>
+<% end -%> + +<%- if devise_mapping.recoverable? && controller_name != 'passwords' && controller_name != 'registrations' %> + <%= link_to t(".forgot_your_password"), new_password_path(resource_name) %>
+<% end -%> + +<%- if devise_mapping.confirmable? && controller_name != 'confirmations' %> + <%= link_to t('.didn_t_receive_confirmation_instructions'), new_confirmation_path(resource_name) %>
+<% end -%> + +<%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %> + <%= link_to t('.didn_t_receive_unlock_instructions'), new_unlock_path(resource_name) %>
+<% end -%> + +<%- if devise_mapping.omniauthable? %> + <%- resource_class.omniauth_providers.each do |provider| %> + <%= link_to t('.sign_in_with_provider', provider: OmniAuth::Utils.camelize(provider)), omniauth_authorize_path(resource_name, provider) %>
+ <% end -%> +<% end -%> diff --git a/app/views/devise/unlocks/new.html.erb b/app/views/devise/unlocks/new.html.erb new file mode 100644 index 0000000..ea83e83 --- /dev/null +++ b/app/views/devise/unlocks/new.html.erb @@ -0,0 +1,11 @@ +<%= devise_form_container do %> +

<%= t('.resend_unlock_instructions') %>

+ + <%= simple_form_for(resource, as: resource_name, url: unlock_path(resource_name), html: { method: :post }) do |f| %> + <%= f.input :email, autofocus: true, autocomplete: "email" %> + + <%= f.button :submit, t('.resend_unlock_instructions'), class: "btn-primary" %> + <% end %> + + <%= render "devise/shared/links" %> +<% end %> diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb index c8596d2..36ba294 100644 --- a/app/views/layouts/application.html.erb +++ b/app/views/layouts/application.html.erb @@ -10,7 +10,9 @@ + <%= render "shared/navbar" %> <%= render "shared/notices" %> + <%= yield %> diff --git a/app/views/shared/_devise_form_container.html.erb b/app/views/shared/_devise_form_container.html.erb new file mode 100644 index 0000000..606116b --- /dev/null +++ b/app/views/shared/_devise_form_container.html.erb @@ -0,0 +1,7 @@ +
+
+
+ <%= yield :devise_form_content %> +
+
+
diff --git a/app/views/shared/_navbar.html.erb b/app/views/shared/_navbar.html.erb new file mode 100644 index 0000000..613e917 --- /dev/null +++ b/app/views/shared/_navbar.html.erb @@ -0,0 +1,31 @@ + diff --git a/config/initializers/devise.rb b/config/initializers/devise.rb index 58c5af8..5b9c47c 100644 --- a/config/initializers/devise.rb +++ b/config/initializers/devise.rb @@ -136,7 +136,7 @@ Devise.setup do |config| # their account can't be confirmed with the token any more. # Default is nil, meaning there is no restriction on how long a user can take # before confirming their account. - config.confirm_within = 3.days + config.confirm_within = 7.days # If true, requires any email changes to be confirmed (exactly the same way as # initial account confirmation) to be applied. Requires additional unconfirmed_email diff --git a/config/locales/en.yml b/config/locales/en.yml index decc5a8..d6fe953 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -1,33 +1,7 @@ -# Files in the config/locales directory are used for internationalization -# and are automatically loaded by Rails. If you want to use locales other -# than English, add the necessary files in this directory. -# -# To use the locales, use `I18n.t`: -# -# I18n.t 'hello' -# -# In views, this is aliased to just `t`: -# -# <%= t('hello') %> -# -# To use a different locale, set it with `I18n.locale`: -# -# I18n.locale = :es -# -# This would use the information in config/locales/es.yml. -# -# The following keys must be escaped otherwise they will not be retrieved by -# the default I18n backend: -# -# true, false, on, off, yes, no -# -# Instead, surround them with single quotes. -# -# en: -# 'true': 'foo' -# -# To learn more, please read the Rails Internationalization guide -# available at http://guides.rubyonrails.org/i18n.html. - en: - hello: "Hello world" + shared: + navbar: + sign_up: "Sign up" + sign_in: "Sign in" + sign_out: "Sign out" + profile: "Profile" diff --git a/config/routes.rb b/config/routes.rb index 1203ed0..8e61b24 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -1,16 +1,45 @@ # == Route Map # -# Prefix Verb URI Pattern Controller#Action -# root GET / pages#home -# rails_service_blob GET /rails/active_storage/blobs/:signed_id/*filename(.:format) active_storage/blobs#show -# rails_blob_representation GET /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) active_storage/representations#show -# rails_disk_service GET /rails/active_storage/disk/:encoded_key/*filename(.:format) active_storage/disk#show -# update_rails_disk_service PUT /rails/active_storage/disk/:encoded_token(.:format) active_storage/disk#update -# rails_direct_uploads POST /rails/active_storage/direct_uploads(.:format) active_storage/direct_uploads#create +# Prefix Verb URI Pattern Controller#Action +# new_user_session GET /users/sign_in(.:format) devise/sessions#new +# user_session POST /users/sign_in(.:format) devise/sessions#create +# destroy_user_session DELETE /users/sign_out(.:format) devise/sessions#destroy +# new_user_password GET /users/password/new(.:format) devise/passwords#new +# edit_user_password GET /users/password/edit(.:format) devise/passwords#edit +# user_password PATCH /users/password(.:format) devise/passwords#update +# PUT /users/password(.:format) devise/passwords#update +# POST /users/password(.:format) devise/passwords#create +# cancel_user_registration GET /users/cancel(.:format) devise/registrations#cancel +# new_user_registration GET /users/sign_up(.:format) devise/registrations#new +# edit_user_registration GET /users/edit(.:format) devise/registrations#edit +# user_registration PATCH /users(.:format) devise/registrations#update +# PUT /users(.:format) devise/registrations#update +# DELETE /users(.:format) devise/registrations#destroy +# POST /users(.:format) devise/registrations#create +# new_user_confirmation GET /users/confirmation/new(.:format) devise/confirmations#new +# user_confirmation GET /users/confirmation(.:format) devise/confirmations#show +# POST /users/confirmation(.:format) devise/confirmations#create +# root GET / pages#home +# letter_opener_web /letter_opener LetterOpenerWeb::Engine +# rails_service_blob GET /rails/active_storage/blobs/:signed_id/*filename(.:format) active_storage/blobs#show +# rails_blob_representation GET /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) active_storage/representations#show +# rails_disk_service GET /rails/active_storage/disk/:encoded_key/*filename(.:format) active_storage/disk#show +# update_rails_disk_service PUT /rails/active_storage/disk/:encoded_token(.:format) active_storage/disk#update +# rails_direct_uploads POST /rails/active_storage/direct_uploads(.:format) active_storage/direct_uploads#create +# +# Routes for LetterOpenerWeb::Engine: +# clear_letters DELETE /clear(.:format) letter_opener_web/letters#clear +# delete_letter DELETE /:id(.:format) letter_opener_web/letters#destroy +# letters GET / letter_opener_web/letters#index +# letter GET /:id(/:style)(.:format) letter_opener_web/letters#show +# GET /:id/attachments/:file(.:format) letter_opener_web/letters#attachment # In order to update the route map above, # run `bundle exec annotate -r` after modifying this file Rails.application.routes.draw do # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html + devise_for :users root to: "pages#home" + + mount LetterOpenerWeb::Engine, at: "/letter_opener" if Rails.env.development? end diff --git a/db/migrate/20180523145630_devise_create_users.rb b/db/migrate/20180523145630_devise_create_users.rb new file mode 100644 index 0000000..4ba28dc --- /dev/null +++ b/db/migrate/20180523145630_devise_create_users.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +class DeviseCreateUsers < ActiveRecord::Migration[5.2] + def change + create_table :users do |t| + ## Database authenticatable + t.string :email, null: false, default: "" + t.string :encrypted_password, null: false, default: "" + + ## Recoverable + t.string :reset_password_token + t.datetime :reset_password_sent_at + + ## Rememberable + t.datetime :remember_created_at + + ## Trackable + t.integer :sign_in_count, default: 0, null: false + t.datetime :current_sign_in_at + t.datetime :last_sign_in_at + t.string :current_sign_in_ip + t.string :last_sign_in_ip + + ## Confirmable + t.string :confirmation_token + t.datetime :confirmed_at + t.datetime :confirmation_sent_at + t.string :unconfirmed_email # Only if using reconfirmable + + ## Lockable + # t.integer :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts + # t.string :unlock_token # Only if unlock strategy is :email or :both + # t.datetime :locked_at + + + t.timestamps null: false + end + + add_index :users, :email, unique: true + add_index :users, :reset_password_token, unique: true + add_index :users, :confirmation_token, unique: true + # add_index :users, :unlock_token, unique: true + end +end diff --git a/db/schema.rb b/db/schema.rb index 52ab025..da6be3d 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,6 +10,28 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema.define(version: 0) do +ActiveRecord::Schema.define(version: 2018_05_23_145630) do + + create_table "users", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t| + t.string "email", default: "", null: false + t.string "encrypted_password", default: "", null: false + t.string "reset_password_token" + t.datetime "reset_password_sent_at" + t.datetime "remember_created_at" + t.integer "sign_in_count", default: 0, null: false + t.datetime "current_sign_in_at" + t.datetime "last_sign_in_at" + t.string "current_sign_in_ip" + t.string "last_sign_in_ip" + t.string "confirmation_token" + t.datetime "confirmed_at" + t.datetime "confirmation_sent_at" + t.string "unconfirmed_email" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.index ["confirmation_token"], name: "index_users_on_confirmation_token", unique: true + t.index ["email"], name: "index_users_on_email", unique: true + t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true + end end diff --git a/test/application_system_test_case.rb b/test/application_system_test_case.rb index d19212a..27aacc6 100644 --- a/test/application_system_test_case.rb +++ b/test/application_system_test_case.rb @@ -1,5 +1,5 @@ require "test_helper" class ApplicationSystemTestCase < ActionDispatch::SystemTestCase - driven_by :selenium, using: :chrome, screen_size: [1400, 1400] + driven_by :headless_chrome end diff --git a/test/fixtures/users.yml b/test/fixtures/users.yml new file mode 100644 index 0000000..5f2b5ad --- /dev/null +++ b/test/fixtures/users.yml @@ -0,0 +1,39 @@ +# == Schema Information +# +# Table name: users +# +# id :bigint(8) not null, primary key +# confirmation_sent_at :datetime +# confirmation_token :string(255) +# confirmed_at :datetime +# current_sign_in_at :datetime +# current_sign_in_ip :string(255) +# email :string(255) default(""), not null +# encrypted_password :string(255) default(""), not null +# last_sign_in_at :datetime +# last_sign_in_ip :string(255) +# remember_created_at :datetime +# reset_password_sent_at :datetime +# reset_password_token :string(255) +# sign_in_count :integer default(0), not null +# unconfirmed_email :string(255) +# created_at :datetime not null +# updated_at :datetime not null +# +# Indexes +# +# index_users_on_confirmation_token (confirmation_token) UNIQUE +# index_users_on_email (email) UNIQUE +# index_users_on_reset_password_token (reset_password_token) UNIQUE +# + +# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html + +# This model initially had no columns defined. If you add columns to the +# model remove the '{}' from the fixture names and add the columns immediately +# below each fixture, per the syntax in the comments below +# +user1: + email: user@chexpire.org + encrypted_password: <%= User.new.send(:password_digest, 'password') %> + confirmed_at: <%= 1.minute.ago %> diff --git a/test/models/user_test.rb b/test/models/user_test.rb new file mode 100644 index 0000000..469c567 --- /dev/null +++ b/test/models/user_test.rb @@ -0,0 +1,36 @@ +# == Schema Information +# +# Table name: users +# +# id :bigint(8) not null, primary key +# confirmation_sent_at :datetime +# confirmation_token :string(255) +# confirmed_at :datetime +# current_sign_in_at :datetime +# current_sign_in_ip :string(255) +# email :string(255) default(""), not null +# encrypted_password :string(255) default(""), not null +# last_sign_in_at :datetime +# last_sign_in_ip :string(255) +# remember_created_at :datetime +# reset_password_sent_at :datetime +# reset_password_token :string(255) +# sign_in_count :integer default(0), not null +# unconfirmed_email :string(255) +# created_at :datetime not null +# updated_at :datetime not null +# +# Indexes +# +# index_users_on_confirmation_token (confirmation_token) UNIQUE +# index_users_on_email (email) UNIQUE +# index_users_on_reset_password_token (reset_password_token) UNIQUE +# + +require "test_helper" + +class UserTest < ActiveSupport::TestCase + # test "the truth" do + # assert true + # end +end diff --git a/test/system/users_test.rb b/test/system/users_test.rb new file mode 100644 index 0000000..3031785 --- /dev/null +++ b/test/system/users_test.rb @@ -0,0 +1,61 @@ +require "application_system_test_case" + +class UsersTest < ApplicationSystemTestCase + test "an user can signup from the homepage and confirm its account" do + visit root_path + + click_on I18n.t("shared.navbar.sign_up") + email = "new@chexpire.org" + password = "password" + + fill_in("user[email]", with: email) + fill_in("user[password]", with: password) + fill_in("user[password_confirmation]", with: password) + + click_button I18n.t("devise.registrations.new.sign_up") + + assert_equal root_path, page.current_path + user = User.find_by!(email: email, confirmed_at: nil) + assert_not_nil user + + confirmation_path = user_confirmation_path(confirmation_token: user.confirmation_token) + + confirmation_email = ActionMailer::Base.deliveries.last + + assert confirmation_email.body.include?(confirmation_path) + + visit confirmation_path + assert_equal new_user_session_path, page.current_path + assert page.has_css?(".alert-success") + end + + test "an user can signin from the homepage" do + user = users(:user1) + visit root_path + + click_on I18n.t("shared.navbar.sign_in") + + fill_in "user[email]", with: user.email + fill_in "user[password]", with: "password" + + click_button I18n.t("devise.sessions.new.sign_in") + + assert_equal root_path, page.current_path + assert page.has_content?(user.email) + end + + test "an user can signout from the homepage" do + user = users(:user1) + + login_as user + visit root_path + + find ".navbar" do + click_on user.email + click_on I18n.t("shared.navbar.sign_out") + end + + assert_equal root_path, page.current_path + assert page.has_content?(I18n.t("shared.navbar.sign_in")) + end +end diff --git a/test/test_helper.rb b/test/test_helper.rb index e92cf16..04f5f23 100644 --- a/test/test_helper.rb +++ b/test/test_helper.rb @@ -6,5 +6,17 @@ class ActiveSupport::TestCase # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order. fixtures :all + include Warden::Test::Helpers + Warden.test_mode! + # Add more helper methods to be used by all tests here... end + +Capybara.register_driver :headless_chrome do |app| + capabilities = Selenium::WebDriver::Remote::Capabilities.chrome( + "chromeOptions" => { args: %w[headless disable-gpu] + ["window-size=1280,800"] }, + ) + Capybara::Selenium::Driver.new app, browser: :chrome, desired_capabilities: capabilities +end +Capybara.save_path = Rails.root.join("tmp/capybara") +Capybara.javascript_driver = :headless_chrome From fab75c03df8e4036d93a8b190acbd90b9f8d494b Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Thu, 24 May 2018 16:01:08 +0200 Subject: [PATCH 7/9] Fixed travis with devise --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index fc77036..7bb89d3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,6 +15,7 @@ addons: before_install: - cp config/database.example.yml config/database.yml - cp config/chexpire.test.yml config/chexpire.yml + - cp config/secrets.example.yml config/secrets.yml install: - bundle install From 9d74bb4c2b44a89cd1af28f1e33476a9692af653 Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Thu, 24 May 2018 22:55:20 +0200 Subject: [PATCH 8/9] Travis: fix chrome crash & system tests --- .travis.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 7bb89d3..025f452 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,8 +7,7 @@ cache: node_js: 9 -sudo: false - +sudo: required # required with chrome addon addons: chrome: stable From c0d5099a23da59d8235abe488c3cb5cb3302a365 Mon Sep 17 00:00:00 2001 From: Colin Darie Date: Thu, 24 May 2018 23:40:23 +0200 Subject: [PATCH 9/9] Users forms: TOS acceptance, notifications deactivation --- app/controllers/application_controller.rb | 8 +++ .../packs/src/components/users.scss | 6 +-- app/models/user.rb | 4 ++ app/views/devise/registrations/edit.html.erb | 2 +- app/views/devise/registrations/new.html.erb | 2 + config/locales/en.yml | 11 +++++ .../20180523145630_devise_create_users.rb | 1 - ...180524205809_add_custom_fields_to_users.rb | 6 +++ db/schema.rb | 4 +- test/fixtures/users.yml | 3 ++ test/models/user_test.rb | 2 + test/system/users_test.rb | 49 +++++++++++++++++++ 12 files changed, 91 insertions(+), 7 deletions(-) create mode 100644 db/migrate/20180524205809_add_custom_fields_to_users.rb diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index 09705d1..37ba566 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -1,2 +1,10 @@ class ApplicationController < ActionController::Base + before_action :configure_devise_parameters, if: :devise_controller? + + protected + + def configure_devise_parameters + devise_parameter_sanitizer.permit(:sign_up, keys: [:tos_accepted]) + devise_parameter_sanitizer.permit(:account_update, keys: [:notifications_enabled]) + end end diff --git a/app/javascript/packs/src/components/users.scss b/app/javascript/packs/src/components/users.scss index dc42ca4..05ae08f 100644 --- a/app/javascript/packs/src/components/users.scss +++ b/app/javascript/packs/src/components/users.scss @@ -1,5 +1,3 @@ -.new_user { - .form-check-label.boolean { - color: inherit; - } +.form-check-label.optional.boolean { + color: inherit; } diff --git a/app/models/user.rb b/app/models/user.rb index 791ed72..a398135 100644 --- a/app/models/user.rb +++ b/app/models/user.rb @@ -12,10 +12,12 @@ # encrypted_password :string(255) default(""), not null # last_sign_in_at :datetime # last_sign_in_ip :string(255) +# notifications_enabled :boolean default(TRUE), not null # remember_created_at :datetime # reset_password_sent_at :datetime # reset_password_token :string(255) # sign_in_count :integer default(0), not null +# tos_accepted :boolean default(FALSE), not null # unconfirmed_email :string(255) # created_at :datetime not null # updated_at :datetime not null @@ -32,4 +34,6 @@ class User < ApplicationRecord # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable devise :database_authenticatable, :registerable, :recoverable, :rememberable, :validatable, :confirmable + + validates :tos_accepted, acceptance: true end diff --git a/app/views/devise/registrations/edit.html.erb b/app/views/devise/registrations/edit.html.erb index 9d99eb0..4ab2468 100644 --- a/app/views/devise/registrations/edit.html.erb +++ b/app/views/devise/registrations/edit.html.erb @@ -1,7 +1,6 @@ <%= devise_form_container do %>

<%= t('.title', resource: resource_name.to_s.humanize) %>

- <%= simple_form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f| %> <%= f.input :email, autofocus: true, autocomplete: "email" %> @@ -25,6 +24,7 @@ <%= f.input :password_confirmation, autocomplete: "off" %> + <%= f.input :notifications_enabled %> <%= f.button :submit, t('.update'), class: "btn-primary" %> <% end %> diff --git a/app/views/devise/registrations/new.html.erb b/app/views/devise/registrations/new.html.erb index ed81d21..69a0e09 100644 --- a/app/views/devise/registrations/new.html.erb +++ b/app/views/devise/registrations/new.html.erb @@ -9,6 +9,8 @@ <%= f.input :password_confirmation, autocomplete: "off" %> + <%= f.input :tos_accepted, label: t('.tos_acceptance_html') %> + <%= f.button :submit, t('.sign_up'), class: "btn-primary" %> <% end %> diff --git a/config/locales/en.yml b/config/locales/en.yml index d6fe953..c7c3395 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -1,4 +1,15 @@ en: + activerecord: + attributes: + user: + tos_accepted: "Terms of service" + notifications_enabled: "Notifications enabled" + + devise: + registrations: + new: + tos_acceptance_html: "You must accept our Terms of service" + shared: navbar: sign_up: "Sign up" diff --git a/db/migrate/20180523145630_devise_create_users.rb b/db/migrate/20180523145630_devise_create_users.rb index 4ba28dc..b0c5e73 100644 --- a/db/migrate/20180523145630_devise_create_users.rb +++ b/db/migrate/20180523145630_devise_create_users.rb @@ -32,7 +32,6 @@ class DeviseCreateUsers < ActiveRecord::Migration[5.2] # t.string :unlock_token # Only if unlock strategy is :email or :both # t.datetime :locked_at - t.timestamps null: false end diff --git a/db/migrate/20180524205809_add_custom_fields_to_users.rb b/db/migrate/20180524205809_add_custom_fields_to_users.rb new file mode 100644 index 0000000..2864b70 --- /dev/null +++ b/db/migrate/20180524205809_add_custom_fields_to_users.rb @@ -0,0 +1,6 @@ +class AddCustomFieldsToUsers < ActiveRecord::Migration[5.2] + def change + add_column :users, :tos_accepted, :boolean, null: false, default: false + add_column :users, :notifications_enabled, :boolean, null: false, default: true + end +end diff --git a/db/schema.rb b/db/schema.rb index da6be3d..8483285 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,7 +10,7 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema.define(version: 2018_05_23_145630) do +ActiveRecord::Schema.define(version: 2018_05_24_205809) do create_table "users", options: "ENGINE=InnoDB DEFAULT CHARSET=utf8", force: :cascade do |t| t.string "email", default: "", null: false @@ -29,6 +29,8 @@ ActiveRecord::Schema.define(version: 2018_05_23_145630) do t.string "unconfirmed_email" t.datetime "created_at", null: false t.datetime "updated_at", null: false + t.boolean "tos_accepted", default: false, null: false + t.boolean "notifications_enabled", default: true, null: false t.index ["confirmation_token"], name: "index_users_on_confirmation_token", unique: true t.index ["email"], name: "index_users_on_email", unique: true t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true diff --git a/test/fixtures/users.yml b/test/fixtures/users.yml index 5f2b5ad..b6f3831 100644 --- a/test/fixtures/users.yml +++ b/test/fixtures/users.yml @@ -12,10 +12,12 @@ # encrypted_password :string(255) default(""), not null # last_sign_in_at :datetime # last_sign_in_ip :string(255) +# notifications_enabled :boolean default(TRUE), not null # remember_created_at :datetime # reset_password_sent_at :datetime # reset_password_token :string(255) # sign_in_count :integer default(0), not null +# tos_accepted :boolean default(FALSE), not null # unconfirmed_email :string(255) # created_at :datetime not null # updated_at :datetime not null @@ -37,3 +39,4 @@ user1: email: user@chexpire.org encrypted_password: <%= User.new.send(:password_digest, 'password') %> confirmed_at: <%= 1.minute.ago %> + tos_accepted: true diff --git a/test/models/user_test.rb b/test/models/user_test.rb index 469c567..11697d6 100644 --- a/test/models/user_test.rb +++ b/test/models/user_test.rb @@ -12,10 +12,12 @@ # encrypted_password :string(255) default(""), not null # last_sign_in_at :datetime # last_sign_in_ip :string(255) +# notifications_enabled :boolean default(TRUE), not null # remember_created_at :datetime # reset_password_sent_at :datetime # reset_password_token :string(255) # sign_in_count :integer default(0), not null +# tos_accepted :boolean default(FALSE), not null # unconfirmed_email :string(255) # created_at :datetime not null # updated_at :datetime not null diff --git a/test/system/users_test.rb b/test/system/users_test.rb index 3031785..03e456a 100644 --- a/test/system/users_test.rb +++ b/test/system/users_test.rb @@ -11,6 +11,7 @@ class UsersTest < ApplicationSystemTestCase fill_in("user[email]", with: email) fill_in("user[password]", with: password) fill_in("user[password_confirmation]", with: password) + check "user[tos_accepted]" click_button I18n.t("devise.registrations.new.sign_up") @@ -58,4 +59,52 @@ class UsersTest < ApplicationSystemTestCase assert_equal root_path, page.current_path assert page.has_content?(I18n.t("shared.navbar.sign_in")) end + + test "tos must be accepted at signup" do + visit new_user_registration_path + + email = "user@example.org" + fill_in("user[email]", with: email) + fill_in("user[password]", with: "password") + fill_in("user[password_confirmation]", with: "password") + + click_button I18n.t("devise.registrations.new.sign_up") + + assert_nil User.find_by(email: email) + + within ".user_tos_accepted" do + page.has_selector? ".invalid-feedback" + end + + # email is prefilled + assert_equal email, find_field("user[email]").value + + fill_in("user[password]", with: "password") + fill_in("user[password_confirmation]", with: "password") + check "user[tos_accepted]" + + click_button I18n.t("devise.registrations.new.sign_up") + + assert_equal root_path, page.current_path + assert_not_nil User.find_by!(email: email, tos_accepted: true) + end + + test "an user can globally disable its notifications" do + user = users(:user1) + login_as user + + visit edit_user_registration_path + + assert_equal user.email, find_field("user[email]").value + + assert find_field("user[notifications_enabled]").value + uncheck "user[notifications_enabled]" + + fill_in("user[current_password]", with: "password") + + click_button I18n.t("devise.registrations.edit.update") + + user.reload + refute user.notifications_enabled + end end