rolemodel-rails 0.26.0

data/lib/generators/rolemodel/saas/devise/templates/spec/factories/users.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    first_name { 'Default' }
+    last_name { 'User' }
+    sequence :email do |n|
+      "person#{n}@example.com"
+    end
+    organization
+
+    password { 'password123' }
+    password_confirmation { password }
+
+    trait :regular_user do
+      first_name { 'Regular' }
+      last_name { 'User' }
+      role { User.roles[:user] }
+    end
+
+    trait :org_admin do
+      first_name { 'Org' }
+      last_name { 'Admin' }
+      role { User.roles[:admin] }
+    end
+
+    trait :super_admin do
+      first_name { 'Support' }
+      last_name { 'Admin' }
+      super_admin { true }
+    end
+  end
+end

data/lib/generators/rolemodel/saas/devise/templates/spec/mailers/previews/devise_mailer_preview.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# mailers/previews/devise_mailer_preview.rb
+class DeviseMailerPreview < ActionMailer::Preview
+  def email_changed
+    Devise::Mailer.email_changed(User.first)
+  end
+
+  if Devise.mappings[:user].confirmable?
+    def confirmation_instructions
+      Devise::Mailer.confirmation_instructions(User.first, 'faketoken')
+    end
+  end
+
+  if Devise.mappings[:user].recoverable?
+    def password_change
+      Devise::Mailer.password_change(User.first)
+    end
+
+    def reset_password_instructions
+      Devise::Mailer.reset_password_instructions(User.first, 'faketoken')
+    end
+  end
+
+  if Devise.mappings[:user].lockable?
+    def unlock_instructions
+      Devise::Mailer.unlock_instructions(User.first, 'faketoken')
+    end
+  end
+
+  if Devise.mappings[:user].invitable?
+    def invitation_instructions
+      Devise::Mailer.invitation_instructions(User.first, 'faketoken')
+    end
+  end
+end

data/lib/generators/rolemodel/saas/devise/templates/spec/models/user_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe User, type: :model do
+  describe 'validations' do
+    it 'validates the default factory' do
+      expect(build(:user)).to be_valid
+    end
+
+    it 'validates presence of first_name' do
+      user = build(:user, first_name: nil)
+      expect(user).not_to be_valid
+      expect(user.errors[:first_name]).to include("can't be blank")
+    end
+
+    it 'validates presence of last_name' do
+      user = build(:user, last_name: nil)
+      expect(user).not_to be_valid
+      expect(user.errors[:last_name]).to include("can't be blank")
+    end
+
+    it 'validates presence of role' do
+      user = build(:user, role: nil)
+      expect(user).not_to be_valid
+      expect(user.errors[:role]).to include("can't be blank")
+    end
+  end
+end

data/lib/generators/rolemodel/saas/devise/templates/spec/support/devise.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  # Make it load Devise helpers for controller, system tests so you can sign in users
+  config.include Devise::Test::ControllerHelpers, type: :controller
+  config.include Devise::Test::IntegrationHelpers, type: :request
+  config.include Devise::Test::IntegrationHelpers, type: :system
+end

data/lib/generators/rolemodel/saas/devise/templates/spec/system/users_spec.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Users', type: :system do # rubocop:disable Metrics/BlockLength
+  describe 'Signing up' do
+    let(:user) { build(:user) }
+
+    it 'allows user to sign up' do
+      visit new_user_registration_path
+      fill_in 'First name', with: user.first_name
+      fill_in 'Last name', with: user.last_name
+      fill_in 'Organization name', with: user.organization_name
+      fill_in 'Email', with: user.email
+      fill_in 'user[password]', with: 'password123'
+      fill_in 'Password confirmation', with: 'password123'
+      expect { click_on 'Sign up' }.to change(User, :count).by 1
+      expect(page).to have_content 'Welcome! You have signed up successfully.'
+      expect(User.last.first_name).to eq user.first_name
+      expect(User.last.last_name).to eq user.last_name
+      expect(User.last.email).to eq user.email
+    end
+  end
+
+  describe 'Signing in' do
+    let(:password) { 'password123' }
+    let!(:user) do
+      create(
+        :user,
+        password: password,
+        password_confirmation: password
+      )
+    end
+
+    it 'requires user to log in before visiting application' do
+      visit root_path
+      expect(page).to have_current_path(new_user_session_path)
+    end
+
+    it 'allows user to sign in' do
+      visit new_user_session_path
+      fill_in 'Email', with: user.email
+      fill_in 'Password', with: password
+      click_on 'Login'
+      expect(page).to have_current_path(root_path)
+      expect(page).to have_content('Signed in successfully.')
+    end
+  end
+
+  describe 'Signing out' do
+    let!(:user) { create(:user) }
+
+    before do
+      sign_in user
+    end
+
+    it 'allows user to sign out' do
+      visit root_path
+      click_on 'Sign Out'
+      expect(page).to have_current_path(new_user_session_path)
+      expect(page).to have_content('Login')
+    end
+  end
+
+  describe 'Editing account info' do # rubocop:disable Metrics/BlockLength
+    let(:password) { 'password123' }
+    let!(:user) do
+      create(
+        :user,
+        password: password,
+        password_confirmation: password
+      )
+    end
+    let(:new_user_info) do
+      {
+        first_name: 'New',
+        last_name: 'Name',
+        email: 'new_email@example.com'
+      }
+    end
+
+    before do
+      sign_in user
+    end
+
+    it 'allows user to update account info' do
+      visit root_path
+      click_on 'Edit Profile'
+      fill_in 'First name', with: new_user_info[:first_name]
+      fill_in 'Last name', with: new_user_info[:last_name]
+      fill_in 'Email', with: new_user_info[:email]
+      fill_in 'Current password', with: password
+      click_on 'Update'
+      expect(user.reload.first_name).to eq new_user_info[:first_name]
+      expect(user.last_name).to eq new_user_info[:last_name]
+      expect(user.email).to eq new_user_info[:email]
+    end
+
+    it 'does not show Organization name field if user is not admin' do
+      visit edit_user_registration_path
+      expect(page).not_to have_field 'Organization name'
+      sign_out user
+
+      org_admin = create(:user, :org_admin)
+      sign_in org_admin
+      refresh
+
+      expect(page).to have_field 'Organization name'
+    end
+
+    it 'allows admin user to update associated organization name' do
+      user.admin!
+      old_organization_name = user.organization_name
+      new_organization_name = 'New Org Name'
+      old_organization_id = user.organization.id
+
+      visit edit_user_registration_path
+      fill_in 'Organization name', with: new_organization_name
+      fill_in 'Current password', with: password
+      click_on 'Update'
+      expect(user.organization.reload.name).to_not eq old_organization_name
+      expect(user.organization_name).to eq new_organization_name
+
+      # ensure it doesn't create a new organization
+      expect(user.organization.id).to eq old_organization_id
+    end
+  end
+end

data/lib/generators/rolemodel/semaphore/README.md

@@ -0,0 +1,15 @@
+# Semaphore Generator
+
+## What you get
+
+* semaphore.yml file to run the relevant CI commands
+* heroku-deployment-commands.sh file with commands to deploy to heroku
+* staging-deploy.yml file with commands to deploy to staging
+* production-deploy.yml file with commands to deploy to production
+
+This is the basic config needed to use semaphore.
+
+## Note
+This config assumes
+ - `main` is the base branch
+ - `yarn test` is the command to run JS tests

data/lib/generators/rolemodel/semaphore/USAGE

@@ -0,0 +1,11 @@
+Description:
+  Sets up our standard semaphore configuration
+
+Example:
+  rails generate rolemodel:semaphore
+
+  This will create:
+    semaphore.yml
+    heroku-deployment-commands.sh
+    staging-deploy.yml
+    production-deploy.yml

data/lib/generators/rolemodel/semaphore/semaphore_generator.rb

@@ -0,0 +1,25 @@
+module Rolemodel
+  class SemaphoreGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def create_base_semaphore_config
+      @project_name = Rails.application.class.try(:parent_name) || Rails.application.class.module_parent_name
+      template 'semaphore.yml.erb', '.semaphore/semaphore.yml'
+
+      if yes?('Does your project have JavaScript tests and/or eslint?')
+        uncomment_lines('.semaphore/semaphore.yml', '- yarn test')
+        uncomment_lines('.semaphore/semaphore.yml', '- yarn run eslint')
+      end
+    end
+
+    def create_deplyment_commands
+      default_heroku_prefix = (Rails.application.class.try(:parent_name) || Rails.application.class.module_parent_name).underscore.dasherize
+
+      @heroku_prefix = ask('Enter the heroku project prefix', default: default_heroku_prefix)
+
+      template 'heroku-deployment-commands.sh', '.semaphore/heroku-deployment-commands.sh'
+      template 'staging-deploy.yml.erb', '.semaphore/staging-deploy.yml'
+      template 'production-deploy.yml.erb', '.semaphore/production-deploy.yml'
+    end
+  end
+end

data/lib/generators/rolemodel/semaphore/templates/heroku-deployment-commands.sh

@@ -0,0 +1,3 @@
+checkout --use-cache
+heroku git:remote -a $HEROKU_APP_NAME
+git push heroku -f $SEMAPHORE_GIT_BRANCH:main

data/lib/generators/rolemodel/semaphore/templates/production-deploy.yml.erb

@@ -0,0 +1,17 @@
+version: v1.0
+name: Deploy to Production
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+blocks:
+  - name: Deploy
+    task:
+      secrets:
+        - name: heroku_http_auth
+      env_vars:
+        - name: HEROKU_APP_NAME
+          value: <%= "#{@heroku_prefix}-production" %>
+      jobs:
+        - name: 'Push code to Production'
+          commands_file: heroku-deployment-commands.sh

data/lib/generators/rolemodel/semaphore/templates/semaphore.yml.erb

@@ -0,0 +1,145 @@
+version: v1.0
+name: <%= @project_name %>
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu2004
+auto_cancel:
+  running:
+    when: branch != 'main'
+global_job_config:
+  env_vars:
+    - name: RAILS_ENV
+      value: test
+    - name: HONEYBADGER_SOURCE_MAP_DISABLED
+      value: 'true'
+    - name: DATABASE_URL
+      value: 'postgres://postgres:@0.0.0.0/<%= Rails.application.config.database_configuration['test']['database'] %>'
+    - name: GOOGLE_CHROME_BIN
+      value: 'google-chrome'
+    # https://github.com/renderedtext/test-boosters#rspec-booster
+    - name: TB_RSPEC_OPTIONS
+      value: '--format RspecJunitFormatter --out tmp/test_results/rspec_junit.xml --format documentation'
+  secrets:
+    - name: rmsbackup_ssh_private_key
+  prologue:
+    commands:
+      # Add keys
+      - ssh-keyscan -H github.com >> ~/.ssh/known_hosts
+      - chmod 600 ~/.ssh/id_rsa_rmsbackup_ssh_private_key
+      - ssh-add ~/.ssh/id_rsa_rmsbackup_ssh_private_key
+
+      - checkout
+
+      # Ruby setup
+      - sem-service start postgres 14
+      - sem-version ruby $(cat .ruby-version)
+      - gem install bundler --no-document
+      - bundle config set deployment 'true'
+      - bundle config set path 'vendor/bundle'
+
+      # Node setup
+      - sem-version node $(cat .node-version)
+      - npm i -g yarn
+
+      # Cache setup
+      - cache restore gems-$(checksum .ruby-version)-$(checksum Gemfile.lock)
+      - cache restore yarn-cache-$(checksum .node-version)-$(checksum yarn.lock)
+      - cache restore yarn-node-modules-$(checksum .node-version)-$(checksum yarn.lock)
+blocks:
+  - name: Build
+    dependencies: []
+    task:
+      jobs:
+        - name: Install Dependencies
+          commands:
+            - bundle check || bundle install
+            - yarn check || yarn install
+      epilogue:
+        commands:
+          - cache store gems-$(checksum .ruby-version)-$(checksum Gemfile.lock) vendor/bundle
+          - cache store yarn-cache-$(checksum .node-version)-$(checksum yarn.lock) /home/semaphore/.cache/yarn
+          - cache store yarn-node-modules-$(checksum .node-version)-$(checksum yarn.lock) node_modules
+  - name: Ruby/JS/Linting
+    execution_time_limit:
+      minutes: 20
+    dependencies:
+      - Build
+    task:
+      jobs:
+        - name: Ruby Test/JS Tests/Audit/Linting
+          commands:
+            - bundle exec rails db:setup db:test:prepare
+            - bundle exec rspec --exclude-pattern "spec/system/**/*_spec.rb" --format RspecJunitFormatter --out tmp/test_results/rspec_junit.xml --format documentation
+            - bundle exec bundle-audit update
+            - bundle exec bundle-audit check
+            # - bundle exec rubocop --fail-level warning --display-only-fail-level-offenses
+            # - yarn test
+            # - yarn run eslint
+      epilogue:
+        always:
+          commands:
+            - test-results publish tmp/test_results
+        on_fail:
+          commands:
+            - artifact push job log/test.log
+  - name: Assets Compile
+    dependencies:
+      - Build
+    execution_time_limit:
+      minutes: 20
+    task:
+      jobs:
+        - name: Webpack Compile and Store Assets
+          commands:
+            - bundle check || bundle install --without legacy_data_migration
+            - yarn check || yarn install
+            - yarn build
+            - cache store assets-public-$SEMAPHORE_WORKFLOW_ID public
+  - name: System Tests
+    dependencies:
+      - Assets Compile
+    execution_time_limit:
+      minutes: 20
+    task:
+      agent:
+        machine:
+          type: e1-standard-2
+          os_image: ubuntu2004
+      env_vars:
+        - name: TEST_BOOSTERS_RSPEC_TEST_FILE_PATTERN
+          value: spec/system/**/*_spec.rb
+      prologue:
+        commands:
+          - gem install semaphore_test_boosters
+          - bundle exec rails db:setup db:test:prepare
+          - cache restore assets-public-$SEMAPHORE_WORKFLOW_ID
+      jobs:
+        - name: Ruby System Tests
+          parallelism: 2
+          commands:
+            - rspec_booster --job $SEMAPHORE_JOB_INDEX/$SEMAPHORE_JOB_COUNT
+      epilogue:
+        always:
+          commands:
+            - test-results publish tmp/test_results
+            - cache delete assets-public-$SEMAPHORE_WORKFLOW_ID
+        on_fail:
+          commands:
+            - artifact push job log/test.log
+            - artifact push workflow tmp/capybara
+after_pipeline:
+  task:
+    jobs:
+      - name: Publish Results
+        commands:
+          - test-results gen-pipeline-report
+promotions:
+  - name: Deploy Staging
+    pipeline_file: staging-deploy.yml
+    auto_promote_on:
+      - result: passed
+        branch:
+          - main
+  - name: Deploy Production
+    pipeline_file: production-deploy.yml

data/lib/generators/rolemodel/semaphore/templates/staging-deploy.yml.erb

@@ -0,0 +1,17 @@
+version: v1.0
+name: Deploy to Staging
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+blocks:
+  - name: Deploy
+    task:
+      secrets:
+        - name: heroku_http_auth
+      env_vars:
+        - name: HEROKU_APP_NAME
+          value: <%= "#{@heroku_prefix}-staging" %>
+      jobs:
+        - name: 'Push code to staging'
+          commands_file: heroku-deployment-commands.sh

data/lib/generators/rolemodel/simple_form/README.md

@@ -0,0 +1,10 @@
+# SimpleForm Generator
+
+## What you get
+
+* SimpleForm config
+* SimpleForm en.yml
+* SimpleForm input wrapper classes
+* SimpleForm scaffold generation template
+
+Adds SimpleForm for simplified and unified styling that automatically wraps inputs with classes

data/lib/generators/rolemodel/simple_form/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Add SimpleForm and configuration
+
+Example:
+    rails generate rolemodel:simple_form
+
+    This will create:
+        config/initializers/simple_form.rb
+        config/locales/simple_form.en.yml
+        simple_form input wrapper classes
+        simple_form template file

data/lib/generators/rolemodel/simple_form/simple_form_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class SimpleFormGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def add_gem
+      Bundler.with_unbundled_env do
+        bundle_command 'add simple_form'
+      end
+    end
+
+    def add_files
+      directory 'app/inputs'
+      directory 'lib/templates/slim/scaffold'
+      copy_file 'config/initializers/simple_form.rb'
+      copy_file 'config/locales/simple_form.en.yml'
+    end
+  end
+end

data/lib/generators/rolemodel/simple_form/templates/app/inputs/collection_check_boxes_input.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CollectionCheckBoxesInput < SimpleForm::Inputs::CollectionCheckBoxesInput
+  def item_wrapper_class
+    'form__group--checkbox'
+  end
+end

data/lib/generators/rolemodel/simple_form/templates/app/inputs/collection_select_input.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CollectionSelectInput < SimpleForm::Inputs::CollectionSelectInput
+  def input_html_classes
+    super.push('form__dropdown')
+  end
+end

data/lib/generators/rolemodel/simple_form/templates/app/inputs/grouped_collection_select_input.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class GroupedCollectionSelectInput < SimpleForm::Inputs::GroupedCollectionSelectInput
+  def input_html_classes
+    super.push('form__dropdown')
+  end
+end

data/lib/generators/rolemodel/simple_form/templates/app/inputs/segmented_control_input.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# SegmentedControlInput is a custom input type for SimpleForm that renders a radio group as an optics (v2.2.0+) segmented control
+#
+# Options:
+#   :size (:small, :medium, :large) - renders the control at different sizes
+#   :full_width - renders the control to take the full width of its container
+#
+# Usage:
+# <%= f.input :my_field, as: :segmented_control, collection: collection_options %>
+# <%= f.input :my_field, as: :segmented_control, collection: collection_options, size: :small %>
+# <%= f.input :my_field, as: :segmented_control, collection: collection_options, disabled: true %>
+# <%= f.input :my_field, as: :segmented_control, collection: collection_options, full_width: true %>
+class SegmentedControlInput < SimpleForm::Inputs::CollectionRadioButtonsInput
+  def input_type
+    'radio_buttons'
+  end
+
+  def input_options
+    options = super
+    options[:item_wrapper_tag] = false
+    options[:collection_wrapper_tag] = 'div'
+    options[:collection_wrapper_class] = collection_wrapper_classes
+    options[:item_label_class] = 'segmented-control__label'
+    options
+  end
+
+  def input_html_options
+    super.tap do |options|
+      options[:class].delete('form-control')
+    end
+  end
+
+  def input_html_classes
+    super.push('segmented-control__input')
+  end
+
+  private
+
+  def collection_wrapper_classes
+    class_names(
+      'segmented-control',
+      options[:class],
+      "segmented-control--#{options[:size]}": options[:size].present?,
+      'segmented-control--full-width': options[:full_width].present?
+    )
+  end
+end

data/lib/generators/rolemodel/simple_form/templates/app/inputs/switch_checkbox_input.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# SwitchCheckboxInput is a custom input type for SimpleForm that renders a checkbox as an optics (v0.5.0+) switch control
+#
+# Options:
+#   :small - renders a smaller switch control
+#   :label_after_input - renders the label after the switch control
+#   :wrapper - the wrapper to use for this input, defaults to :inline_switch_wrapper. :switch_wrapper is also available.
+#
+# Usage:
+# <%= f.input :my_field, as: :switch_checkbox %>
+# <%= f.input :my_field, as: :switch_checkbox, small: true %>
+# <%= f.input :my_field, as: :switch_checkbox, disabled: true %>
+# <%= f.input :my_field, as: :switch_checkbox, label_after_input: true %>
+# <%= f.input :my_field, as: :switch_checkbox, wrapper: :switch_wrapper %>
+class SwitchCheckboxInput < SimpleForm::Inputs::BooleanInput
+  def input(wrapper_options = nil)
+    merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
+
+    switch_group = template.content_tag(:div, class: "switch #{'switch--small' if options[:small]}") do
+      if include_hidden?
+        build_check_box(unchecked_value, merged_input_options)
+      else
+        build_check_box_without_hidden_field(merged_input_options)
+      end +
+      label(wrapper_options)
+    end
+
+    if options[:label_after_input]
+      switch_group + label(wrapper_options)
+    else
+      label(wrapper_options) + switch_group
+    end
+  end
+
+  def input_html_classes
+    []
+  end
+end