rolemodel-rails 0.26.0

data/lib/generators/rolemodel/heroku/templates/app.json.tt

@@ -0,0 +1,30 @@
+{
+  "name": "<%= @project_name %>",
+  "scripts": {
+    "postdeploy": "bin/rails db:seed"
+  },
+  "env": {
+    "HONEYBADGER_API_KEY": {
+      "required": true
+    },
+    "HONEYBADGER_ENV": {
+      "required": true,
+      "value": "review-app"
+    }
+  },
+  "addons": [
+    "heroku-postgresql",
+    "papertrail"
+  ],
+  "buildpacks": [
+    {
+      "url":"heroku/metrics"
+    },
+    {
+      "url": "heroku/nodejs"
+    },
+    {
+      "url": "heroku/ruby"
+    }
+  ]
+}

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

@@ -0,0 +1,14 @@
+# Kaminari Generator
+
+```
+rails g rolemodel:kaminari
+```
+
+## Depends On
+
+- `rolemodel:optics:base`
+- `rolemodel:optics:icons`
+
+## What you get
+
+Pulls in [Kaminari](https://github.com/kaminari/kaminari) along with templates that use the Optics Pagination Component.

data/lib/generators/rolemodel/kaminari/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Sets up our standard Kaminari configuration with Optics Pagination style applied
+
+Example:
+  rails generate rolemodel:kaminari

data/lib/generators/rolemodel/kaminari/kaminari_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class KaminariGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def install_kaminari
+      bundle_command 'add kaminari'
+
+      generate 'kaminari:config'
+    end
+
+    def copy_templates
+      directory 'app/views/kaminari'
+    end
+  end
+end

data/lib/generators/rolemodel/kaminari/templates/app/views/kaminari/_first_page.html.slim

@@ -0,0 +1,9 @@
+/ Link to the "First" page
+  - available local variables
+    url          : url to the first page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+
+== link_to_unless current_page.first?, material_icon('first_page'), url, remote: remote, class: 'btn btn--small btn--no-border btn--icon'

data/lib/generators/rolemodel/kaminari/templates/app/views/kaminari/_gap.html.slim

@@ -0,0 +1,8 @@
+/ Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+
+.pagination__divider ...

data/lib/generators/rolemodel/kaminari/templates/app/views/kaminari/_last_page.html.slim

@@ -0,0 +1,9 @@
+/ Link to the "Last" page
+  - available local variables
+    url          : url to the last page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+
+== link_to_unless current_page.last?, material_icon('last_page'), url, remote: remote, class: 'btn btn--small btn--no-border btn--icon'

data/lib/generators/rolemodel/kaminari/templates/app/views/kaminari/_next_page.html.slim

@@ -0,0 +1,12 @@
+/ Link to the "Next" page
+  - available local variables
+    url          : url to the next page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+
+- unless current_page.last?
+  = link_to url, rel: 'next', remote: remote, class: 'btn btn--small btn--no-border' do
+    | Next
+    = material_icon('chevron_right')

data/lib/generators/rolemodel/kaminari/templates/app/views/kaminari/_page.html.slim

@@ -0,0 +1,10 @@
+/ Link showing page number
+  - available local variables
+    page         : a page object for "this" page
+    url          : url to this page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+
+= link_to page, url, { remote: remote, rel: page.rel, class: "btn btn--no-border btn--small #{'btn--active' if page.current? }" }

data/lib/generators/rolemodel/kaminari/templates/app/views/kaminari/_paginator.html.slim

@@ -0,0 +1,19 @@
+/ The container tag
+  - available local variables
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+    paginator    : the paginator that renders the pagination tags inside
+
+== paginator.render do
+  nav.pagination
+    == first_page_tag unless current_page.first?
+    == prev_page_tag unless current_page.first?
+    - each_page do |page|
+      - if page.display_tag?
+        == page_tag page
+      - elsif !page.was_truncated?
+        == gap_tag
+    == next_page_tag unless current_page.last?
+    == last_page_tag unless current_page.last?

data/lib/generators/rolemodel/kaminari/templates/app/views/kaminari/_prev_page.html.slim

@@ -0,0 +1,12 @@
+/ Link to the "Previous" page
+  - available local variables
+    url          : url to the previous page
+    current_page : a page object for the currently displayed page
+    total_pages  : total number of pages
+    per_page     : number of items to fetch per page
+    remote       : data-remote
+
+- unless current_page.first?
+  = link_to url, rel: 'prev', remote: remote, class: 'btn btn--small btn--no-border' do
+    = material_icon('chevron_left')
+    | Prev

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

@@ -0,0 +1,32 @@
+# Linters Generator
+
+## What you get
+
+* [Rubocop](./rubocop)
+* [ESLint](./eslint)
+
+## Why do we use linters?
+
+* Catches silly errors - static analysis can catch bug where code may not function in an edge case or just won't compile
+* Teaching tool - a good linter setup is oriented around community best practices and can teach you new techniques
+* Fast feedback loop - having feedback in your editor while working on a feature, can simplify a code review
+  * Note we **strongly** recommend that if you are using linters on a project, every project team member has it setup in their editor. No need for surprises when CI fails.
+
+## What we care about with linters
+
+* It is not a master to bow to
+  * You should not be reorganizing your code _just_ to get the linter to pass. For this reason we recommend turning off or lowering to warnings any line length or complexity metrics. They are hard to believe in and there will always be exceptions.
+  * If a rule doesn't match expectations of the project team, change it and document why in the config. Also consider a PR to this repo with some reasoning.
+* Minimal set of rules
+  * We try to limit our linter config to minimum set of rules we as broader team can agree on (or commit to using).
+  * For CI we also ensure only the most severe errors cause a failing build.
+
+### Editor Setup
+
+* Atom
+  * [linter-rubocop](https://atom.io/packages/linter-rubocop)
+    * Supporting: [rubocop-auto-correct](https://atom.io/packages/rubocop-auto-correct)
+  * [linter-eslint](https://atom.io/packages/linter-eslint)
+* VSCode
+  * [ruby-rubocop](https://marketplace.visualstudio.com/items?itemName=misogi.ruby-rubocop)
+  * [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

data/lib/generators/rolemodel/linters/USAGE

@@ -0,0 +1,5 @@
+Description:
+    runs all the linter generators
+
+Example:
+    rails generate rolemodel:linters:all

data/lib/generators/rolemodel/linters/all_generator.rb

@@ -0,0 +1,14 @@
+module Rolemodel
+  module Linters
+    class AllGenerator < BaseGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def run_all_the_generators
+        Dir.glob(Pathname(File.expand_path('.', __dir__)).join('*', '*generator.rb')).each do |generator|
+          name = File.basename(generator, '_generator.rb')
+          generate "rolemodel:linters:#{name}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/linters/eslint/README.md

@@ -0,0 +1,5 @@
+# Rubocop Generator
+
+## What you get
+
+An ESLint installation with a standard .eslintrc.cjs config.

data/lib/generators/rolemodel/linters/eslint/USAGE

@@ -0,0 +1,8 @@
+Description:
+    generates ESLint config
+
+Example:
+    rails generate rolemodel:linters:eslint
+
+    This will create:
+        .eslintrc.cjs

data/lib/generators/rolemodel/linters/eslint/eslint_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  module Linters
+    class EslintGenerator < BaseGenerator
+      include ReplaceContentHelper
+      source_root File.expand_path('templates', __dir__)
+
+      ESLINT_COMMAND = "eslint 'app/**/*.js' 'spec/**/*.js'"
+      DEV_DEPENDENCIES = %w[
+        eslint
+        eslint-config-airbnb
+        eslint-plugin-import
+        eslint-import-resolver-webpack
+        eslint-plugin-jsx-a11y
+        eslint-plugin-react
+        eslint-plugin-react-hooks
+      ].freeze
+
+      def install_eslint
+        run "yarn add --dev #{DEV_DEPENDENCIES.join(' ')}"
+      end
+
+      def add_config
+        template 'eslint.config.js'
+      end
+
+      def add_eslint_command_to_package_json
+        add_package_json_script 'eslint', ESLINT_COMMAND
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/linters/eslint/templates/eslint.config.js

@@ -0,0 +1,92 @@
+import globals from 'globals'
+
+export default [
+  {
+    ignores: ['app/assets/builds/**/*']
+  },
+  { name: 'airbnb' },
+  {
+    languageOptions: {
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true
+        },
+        ecmaVersion: 'latest',
+        globals: {
+          ...globals.browser,
+          ...globals.es6
+        }
+      }
+    },
+    rules: {
+      'no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_', // Allow unused arguments starting with an underscore
+          varsIgnorePattern: '^_' // Allow unused variables starting with an underscore
+        }
+      ],
+
+      // No semicolons
+      semi: ['error', 'never'],
+      'no-unexpected-multiline': 'error',
+
+      // 1. We follow the convention of naming "private" properties with a leading underscore
+      // 2. This conflicts with the no-unused-vars config
+      'no-underscore-dangle': 'off',
+
+      // Multiple variable declarations (without assignment) on the same line
+      // without multiple let/const
+      'one-var': ['error', { initialized: 'never', uninitialized: 'always' }],
+      'one-var-declaration-per-line': ['error', 'initializations'],
+
+      // Don't require naming all non-arrow functions. Modern browsers can usually
+      // detect the correct name if it's assigned to a variable or property.
+      'func-names': 'off',
+
+      // Don't require instance methods to use `this` (the rule name is confusing)
+      'class-methods-use-this': 'off',
+
+      // Turning this on addresses some quirks with using `var`. It's unnecessary
+      // for `let` and `const`.
+      'no-loop-func': 'off',
+
+      // Turning this on requires destructuring in too many cases
+      'prefer-destructuring': 'off',
+
+      // Turning this on prevents directly importing sub-dependencies
+      'import/no-extraneous-dependencies': 'off',
+
+      // One-liner methods can be readable without the extra spacing
+      'lines-between-class-members': ['error', 'always', { exceptAfterSingleLine: true }],
+
+      // Allow assigning to properties of arguments (might consider completely disabling this rule)
+      'no-param-reassign': ['error', { props: false }],
+
+      // Sufficiently high that it won't be too annoying
+      'max-len': ['warn', 130],
+
+      // Disabled because it complains if you mix `return` with `return <value>` in a function
+      'consistent-return': 'off',
+
+      // Allow patterns like `while ((a = getNextValue()))`
+      'no-cond-assign': ['error', 'except-parens'],
+
+      // 'import/extensions': ['warn', 'ignorePackages'],
+
+      // Default disallows mixing exponentiation with other arithmetic operators
+      'no-mixed-operators': [
+        'error',
+        {
+          allowSamePrecedence: false, // Could also make this true
+          groups: [
+            ['&', '|', '^', '~', '<<', '>>', '>>>'],
+            ['==', '!=', '===', '!==', '>', '>=', '<', '<='],
+            ['&&', '||'],
+            ['in', 'instanceof']
+          ]
+        }
+      ]
+    }
+  }
+]

data/lib/generators/rolemodel/linters/rubocop/README.md

@@ -0,0 +1,7 @@
+# Rubocop Generator
+
+## What you get
+
+A Rubocop installation with a standard .rubocop.yml config.
+A custom cop that ensures form validation error responses use the correct status of `422 Unprocessable Entity`.
+A custom cop that ensures the :chrome tag does not exist in specs.

data/lib/generators/rolemodel/linters/rubocop/USAGE

@@ -0,0 +1,9 @@
+Description:
+    generates Rubocop config
+
+Example:
+    rails generate rolemodel:linters:rubocop
+
+    This will create:
+        .rubocop.yml
+        app/cops/form_error_response.rb

data/lib/generators/rolemodel/linters/rubocop/rubocop_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  module Linters
+    # Install the standard rubocop and a custom cop
+    class RubocopGenerator < BaseGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def install_rubocop
+        gem_group :development, :test do
+          gem 'rubocop'
+          gem 'rubocop-rails'
+        end
+        run_bundle
+      end
+
+      def add_config
+        copy_file '.rubocop.yml', force: true
+        directory 'lib/cops'
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/linters/rubocop/templates/lib/cops/form_error_response.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Cops
+  # Custom Cop to Ensure Form Error Response Statuses
+  #
+  # There are three levels of matching here:
+  # Methods (def on_if)
+  # This scans code and only stops on the method specified.
+  # E.G. `on_if` will only move into the below checks when it encounters an if statement.
+  #
+  # Node matcher (def_node_matcher :form_error)
+  # This scans the block of code (in this case, the else branch of the if block)
+  # using AST (Abstract Tree Syntax) to match certain patterns
+  #
+  # Regex
+  # This checks the specific matching line to ensure it meets our expectations
+  class FormErrorResponse < RuboCop::Cop::Base
+    extend RuboCop::Cop::AutoCorrector
+
+    def self.rack_version
+      Gem.loaded_specs['rack'].version
+    end
+
+    def self.http_status
+      if rack_version >= '3.1'
+        :unprocessable_content
+      else
+        :unprocessable_entity
+      end
+    end
+
+    # Match code in the else branch that either: is the only line and looks like `render :something, ...`
+    # or is not the first line and looks like the same.
+    def_node_matcher :form_error, <<~PATTERN
+      {(... $(send nil? :render (:sym _) ...)) | $(send nil? :render (:sym _) ...)}
+    PATTERN
+
+    MSG = "Use status: :#{self.http_status} for invalid form requests."
+
+    # Ensure the render is returning the correct status, otherwise add the offense
+    STATUS_PAIR = /\(pair\s+\(sym :status\)\s+\(sym :#{self.http_status}\)\)/m
+
+    # Only check within if blocks
+    def on_if(node)
+      form_error(node.else_branch) do |name|
+        next if name.to_s.match?(STATUS_PAIR)
+
+        add_offense(name) do |corrector|
+          corrector.insert_after(name, ", status: :#{self.class.http_status}")
+        end
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/linters/rubocop/templates/lib/cops/no_chrome_tag.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Cops
+  # Detect occurences of the chrome tag in specs, and warn and remove them.
+  class NoChromeTag < RuboCop::Cop::Base
+    include RuboCop::Cop::RangeHelp
+    extend RuboCop::Cop::AutoCorrector
+
+    MSG = 'The :chrome tag is only for testing, and should not be checked into the repository.'
+    RESTRICT_ON_SEND = %i[describe context it feature scenario].freeze
+
+    def on_send(node) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      node.arguments.each do |a|
+        if a.sym_type? && a.value == :chrome
+          range = range_with_surrounding_comma(a.source_range)
+          add_offense(range) do |corrector|
+            corrector.replace(range, '')
+          end
+        end
+
+        next unless a.hash_type?
+
+        a.pairs.each do |pair|
+          next unless pair.key.value == :chrome
+
+          range = range_with_surrounding_comma(pair.source_range)
+          add_offense(range) do |corrector|
+            corrector.replace(range, '')
+          end
+        end
+      end
+    end
+
+    def range_with_surrounding_comma(source_range)
+      buffer = source_range.source_buffer
+      src = buffer.source
+      end_pos = source_range.end_pos
+      comma_index = src[...end_pos].rindex(/\s*,\s*/)
+
+      Parser::Source::Range.new(buffer, comma_index, end_pos)
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# Lograge Generator
+
+## What you get
+
+### Lograge
+
+Installs [Lograge](https://github.com/roidrage/lograge).
+
+Lograge is an opinionated gem that slims down the amount of logs that Rails generates, with the goal of reducing
+noise that's handled by other services. For instance, it removes view rendering logs, which is a duplication of Skylight.

data/lib/generators/rolemodel/lograge/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Sets up our standard Lograge configuration
+
+Example:
+    rails generate rolemodel:lograge
+
+    This will create:
+        config/initializers/lograge.rb

data/lib/generators/rolemodel/lograge/lograge_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class LogrageGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def install_lograge
+      bundle_command 'add lograge'
+    end
+
+    def add_lograge_config
+      copy_file 'config/initializers/lograge.rb'
+    end
+  end
+end

data/lib/generators/rolemodel/lograge/templates/config/initializers/lograge.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  config.lograge.enabled = true
+  config.lograge.custom_payload do |controller|
+    {
+      user_id: controller.current_user.try(:id)
+    }
+  end
+  config.lograge.custom_options = lambda do |event|
+    exceptions = %w[controller action format id]
+    {
+      params: event.payload[:params].except(*exceptions)
+    }
+  end
+end

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

@@ -0,0 +1,13 @@
+# Mailer Generator
+
+Depends on optics:base
+
+## What you get
+
+### Premailer Rails
+
+Installs [Premailer Rails](https://github.com/fphilipe/premailer-rails)
+
+### Email Template
+
+This includes an example for how to user ActionMailer with Premailer Rails

data/lib/generators/rolemodel/mailers/USAGE

@@ -0,0 +1,22 @@
+Description:
+    Sets up our standard ActionMailer configuration with layout using CSS base styles
+
+Example:
+    rails generate rolemodel:mailers
+
+    This will create:
+        app/javascript/packs/mailer_stylesheets.scss
+        app/mailers/user_mailer.rb
+        app/views/layouts/mailer.html.slim
+        app/views/user_mailer/welcome_email.html.slim
+        config/initializers/premailer_rails.rb
+        public/logo.png
+        spec/mailers/previews/user_preview.rb
+
+    This will modify:
+        config/environments/development.rb
+        config/environments/production.rb
+
+    This will remove:
+        app/views/layouts/mailer.html.erb
+        app/views/layouts/mailer.text.erb