rolemodel-rails 2.0.1 → 2.2.0

data/lib/rolemodel/utility/task_tools.rb

@@ -12,6 +12,7 @@ module Rolemodel
         say '%.4fs' % time.real, subitem: true
       end
 
+      # based on the migration helper of the same name
       def say(message, subitem: false)
         puts "#{subitem ? '   ->' : '--'} #{message}" # rubocop:disable Rails/Output
       end
@@ -32,11 +33,37 @@ module Rolemodel
         print("#{PROGRESS.next} #{to_percent(index, total) if total}\r") # rubocop:disable Rails/Output
       end
 
+      ##
+      # Enables a pattern for dry-run mode in tasks. Assumes usage of other utility methods
+      # like `say_with_time` and `indicate_progress` that provide user feedback, separate from the actions they perform.
+      #
+      # Tasks can be updated to support this mode by adding `unless dry_run?` to lines of code that write to the file system or database.
+      def dry_run?
+        ENV['DRY_RUN'].present?
+      end
+
+      ##
+      # Improves the usability of Rake::Task arguments which are positional and don't support default values.
+      # This method allows invocation with skipped arguments via `_` and supports a defaults hash.
+      def sanitize_arguments(args, defaults = {})
+        defaults.merge(ArgumentSanitizer.new(args).to_h)
+      end
+
       private
 
       def to_percent(index, total)
         '%3.f%%' % (index / total.to_f * 100.0)
       end
     end
+
+    class ArgumentSanitizer
+      def initialize(args)
+        @args = args.to_h
+      end
+
+      def to_h
+        @args.transform_values { it.to_s.strip.match?('_') ? nil : it.to_s.strip }.compact
+      end
+    end
   end
 end

data/lib/rolemodel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  VERSION = '2.0.1'
+  VERSION = '2.2.0'
 end

data/lib/rolemodel-rails.rb

@@ -2,6 +2,7 @@
 
 module Rolemodel
   NODE_VERSION = '24.12.0'
+  YARN_VERSION = '4.13.0'
   RUBY_VERSION = '4.0.1'
 
   GEM_LIB = File.expand_path(__dir__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - RoleModel Software Inc
@@ -163,6 +163,9 @@ files:
 - lib/generators/rolemodel/README.md
 - lib/generators/rolemodel/USAGE
 - lib/generators/rolemodel/all_generator.rb
+- lib/generators/rolemodel/core_setup/README.md
+- lib/generators/rolemodel/core_setup/USAGE
+- lib/generators/rolemodel/core_setup/core_setup_generator.rb
 - lib/generators/rolemodel/editors/README.md
 - lib/generators/rolemodel/editors/USAGE
 - lib/generators/rolemodel/editors/editors_generator.rb
@@ -175,6 +178,8 @@ files:
 - lib/generators/rolemodel/github/templates/instructions
 - lib/generators/rolemodel/github/templates/pull_request_template.md
 - lib/generators/rolemodel/github/templates/workflows/ci.yml.tt
+- lib/generators/rolemodel/github/templates/workflows/deploy-production.yml
+- lib/generators/rolemodel/github/templates/workflows/deploy-staging.yml
 - lib/generators/rolemodel/good_job/README.md
 - lib/generators/rolemodel/good_job/USAGE
 - lib/generators/rolemodel/good_job/good_job_generator.rb
@@ -185,6 +190,7 @@ files:
 - lib/generators/rolemodel/heroku/heroku_generator.rb
 - lib/generators/rolemodel/heroku/templates/Procfile
 - lib/generators/rolemodel/heroku/templates/app.json.tt
+- lib/generators/rolemodel/heroku/templates/deploy-app/SKILL.md
 - lib/generators/rolemodel/kaminari/README.md
 - lib/generators/rolemodel/kaminari/USAGE
 - lib/generators/rolemodel/kaminari/kaminari_generator.rb
@@ -205,8 +211,6 @@ files:
 - lib/generators/rolemodel/linters/rubocop/README.md
 - lib/generators/rolemodel/linters/rubocop/USAGE
 - lib/generators/rolemodel/linters/rubocop/rubocop_generator.rb
-- lib/generators/rolemodel/linters/rubocop/templates/lib/cops/form_error_response.rb
-- lib/generators/rolemodel/linters/rubocop/templates/lib/cops/no_chrome_tag.rb
 - lib/generators/rolemodel/lograge/README.md
 - lib/generators/rolemodel/lograge/USAGE
 - lib/generators/rolemodel/lograge/lograge_generator.rb
@@ -282,13 +286,11 @@ files:
 - lib/generators/rolemodel/saas/devise/templates/spec/models/user_spec.rb
 - lib/generators/rolemodel/saas/devise/templates/spec/support/devise.rb
 - lib/generators/rolemodel/saas/devise/templates/spec/system/users_spec.rb
-- lib/generators/rolemodel/semaphore/README.md
-- lib/generators/rolemodel/semaphore/USAGE
-- lib/generators/rolemodel/semaphore/semaphore_generator.rb
-- lib/generators/rolemodel/semaphore/templates/heroku-deployment-commands.sh
-- lib/generators/rolemodel/semaphore/templates/production-deploy.yml.erb
-- lib/generators/rolemodel/semaphore/templates/semaphore.yml.erb
-- lib/generators/rolemodel/semaphore/templates/staging-deploy.yml.erb
+- lib/generators/rolemodel/sentry/README.md
+- lib/generators/rolemodel/sentry/USAGE
+- lib/generators/rolemodel/sentry/sentry_generator.rb
+- lib/generators/rolemodel/sentry/templates/app/javascript/initializers/sentry.js
+- lib/generators/rolemodel/sentry/templates/config/initializers/sentry.rb
 - lib/generators/rolemodel/simple_form/README.md
 - lib/generators/rolemodel/simple_form/USAGE
 - lib/generators/rolemodel/simple_form/simple_form_generator.rb
@@ -297,7 +299,6 @@ files:
 - lib/generators/rolemodel/simple_form/templates/app/inputs/grouped_collection_select_input.rb
 - lib/generators/rolemodel/simple_form/templates/app/inputs/segmented_control_input.rb
 - lib/generators/rolemodel/simple_form/templates/app/inputs/switch_checkbox_input.rb
-- lib/generators/rolemodel/simple_form/templates/app/inputs/tailored_select_input.rb
 - lib/generators/rolemodel/simple_form/templates/config/initializers/simple_form.rb
 - lib/generators/rolemodel/simple_form/templates/config/locales/simple_form.en.yml
 - lib/generators/rolemodel/simple_form/templates/lib/templates/slim/scaffold/_form.html.slim.tt
@@ -324,6 +325,7 @@ files:
 - lib/generators/rolemodel/tailored_select/README.md
 - lib/generators/rolemodel/tailored_select/USAGE
 - lib/generators/rolemodel/tailored_select/tailored_select_generator.rb
+- lib/generators/rolemodel/tailored_select/templates/app/inputs/tailored_select_input.rb
 - lib/generators/rolemodel/testing/README.md
 - lib/generators/rolemodel/testing/USAGE
 - lib/generators/rolemodel/testing/all_generator.rb
@@ -391,7 +393,6 @@ files:
 - lib/generators/rolemodel/webpack/README.md
 - lib/generators/rolemodel/webpack/USAGE
 - lib/generators/rolemodel/webpack/templates/app/assets/stylesheets/application.scss
-- lib/generators/rolemodel/webpack/templates/app/javascript/initializers/honeybadger.js
 - lib/generators/rolemodel/webpack/templates/postcss.config.cjs
 - lib/generators/rolemodel/webpack/templates/webpack.config.js
 - lib/generators/rolemodel/webpack/webpack_generator.rb

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

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

@@ -1,45 +0,0 @@
-# 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/semaphore/README.md

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

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

@@ -1,25 +0,0 @@
-module Rolemodel
-  class SemaphoreGenerator < GeneratorBase
-    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

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

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

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

@@ -1,17 +0,0 @@
-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/webpack/templates/app/javascript/initializers/honeybadger.js

@@ -1,26 +0,0 @@
-import Honeybadger from '@honeybadger-io/js'
-
-if (process.env.RAILS_ENV === 'production') {
-  Honeybadger.configure({
-    apiKey: process.env.HONEYBADGER_API_KEY,
-    environment: process.env.HONEYBADGER_ENV,// ‘production’ or ‘review-app’ from app.json
-    revision: process.env.SOURCE_VERSION // provided by heroku
-  })
-
-  const IGNORE_ERRORS = [
-    /AbortError/,
-    /UnhandledPromiseRejectionWarning: {}/,
-    /UnhandledPromiseRejectionWarning.*Load failed/,
-    /UnhandledPromiseRejectionWarning: Object Not Found Matching/,
-    /UnhandledPromiseRejectionWarning.*Failed to fetch/,
-    /ResizeObserver loop completed with undelivered notifications./,
-  ]
-
-  Honeybadger.beforeNotify((notice) => {
-    for (const ignoreError of IGNORE_ERRORS) {
-      if (ignoreError.test(notice.message)) {
-        return false
-      }
-    }
-  })
-}