rolemodel-rails 0.26.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009bb14699c3ecc612283b81294506fdacc64e881d386d597c6b3e5302d708dd'
-  data.tar.gz: 436e21097154c27592f5f9c89557050ae64ecd6be9c4f6ee767a1aa5d5b37ce9
+  metadata.gz: b0fc94b9f1782c5251c05b2ec1e9f8de40ff8021383c4d358c1cf67dae0c2e86
+  data.tar.gz: 8eb5debdc363920c4b21f06381b4c6789162a5dcd984c40ba377fecfb1eb90a2
 SHA512:
-  metadata.gz: 83ec891bfb8720a836cd4145b2395c5db5b79e11ad2711da22be127d70da963b4cb254217aa530e279b20b68a3f47e148aea0da2643815ce3dbd753f9d0c0272
-  data.tar.gz: be94ed5589774d6f39f26741c01353d28bbcd650b21fb5e05aa94ed763b353a9caeff94eb9639d57cd0039cfe1dd75f719fb593b9d99905e25eaecc8fd8b7e8b
+  metadata.gz: be60dc3620a2d22b8ed1148a1966219c830d685e48df12ed5abafd884cd1f749f4251360173f42b355b10865238f000a95da825624c21ee898fde25c7c9dc9d9
+  data.tar.gz: b76c9375e38755a22e66aff75109727a7a03273d9ee4dc9e44049774259f2b60ca793f3a550b79550cdd729cca9154e400547a2472f2565fe18fedb05cfd10e3

data/lib/generators/rolemodel/base_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators/base'
 require 'rails/generators/bundle_helper'
 require_relative 'replace_content_helper'

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

@@ -1,23 +1,20 @@
 # Github Generator
 
 ## Prerequisites
-You will need the parallel_tests generator to run the CI tests.
 
-## What you get
-
-### ci.yml
-A sensible default `ci.yml` to get you started with Github Actions. This will run linters, model tests, and system tests.
-
-Along with the `ci.yml`, your `database.yml` will be modified to be able to be run in GHA.
-
-### Pull Request Template
+It doesn't need to be run first, but the parallel_tests generator must be run in order for the CI workflow to run successfully on GitHub.
 
-When you open a Pull Request in Github it will use the Markdown file as a [template](./templates/pull_request_template.md) for the content of the PR.
-
-Helpful for reminding collaborators to add specific details to the PR.
-
-### Copilot Instructions
+## What you get
 
-Installed into `.github/instructions`, these are context-specific instructions for Copilot to help it give more accurate
-and relevant results. These are a good starting point but they should be tweaked for your project's frameworks and
-standards.
+- CI workflow
+  - A sensible default `ci.yml` to get you started with Github Actions. This will run linters, model tests, and system tests.
+  - Along with the `ci.yml`, your `database.yml` will be modified to be able to be run in GHA.
+- Pull Request Template
+  - When you open a Pull Request in Github it will use the Markdown file as a [template](./templates/pull_request_template.md) for the content of the PR.
+  - Helpful for reminding collaborators to add specific details to the PR.
+- Copilot Instructions
+  - Installed into `.github/instructions`, these are context-specific instructions for Copilot to help it give more accurate
+  and relevant results. These are a good starting point but they should be tweaked for your project's frameworks and
+  standards.
+- Dependabot Configuration
+  - defines a set of rules that dependabot will use to keep your applications dependencies up-to-date on a weekly basis.

data/lib/generators/rolemodel/github/USAGE

@@ -5,5 +5,8 @@ Example:
     rails generate rolemodel:github
 
     This will create:
-        .github/pull_request_template.md
+        .github/instructions/
         .github/workflows/ci.yml
+        .github/pull_request_template.md
+        .github/dependabot.yml
+        .github/CODEOWNERS

data/lib/generators/rolemodel/github/github_generator.rb

@@ -2,30 +2,36 @@
 
 module Rolemodel
   class GithubGenerator < BaseGenerator
-    # Source root is the project-level .github directory
-    # This allows us to use the same templates for both the generated app and this gem
-    source_root File.expand_path('.github')
+    GITHUB_ACTIONS_REPO = 'https://github.com/RoleModel/actions.git'
+    # Files which are both used by the gem source and copied to the target app without modification
+    # are placed in the `.github` folder at the top level of this repository. This folder is then
+    # symlinked to the `templates` folder relative to this generator so they can still be copied over.
+    # Any files which are significantly different or not used by the gem source are just in `templates`.
+    source_root File.expand_path('templates', __dir__)
 
-    def install_pull_request_template
-      template 'pull_request_template.md', '.github/pull_request_template.md'
+    class_option :playwright, type: :boolean, default: true,
+                 desc: 'Request Playwright Setup in CI workflow for system tests?'
+
+    def set_rm_actions_version
+      tags = `git ls-remote --tags #{GITHUB_ACTIONS_REPO}` rescue 'refs/tags/v3'
+      @rm_actions_version = tags.scan(%r{refs/tags/v(\d+)\s*$}).flatten.max_by(&:to_i)
     end
 
-    def remove_rolemodel_rails_version_check
-      gsub_file '.github/pull_request_template.md',
-                "* [ ] Run `bin/bump_version` or `bin/bump_version --patch`\n",
-                ''
+    def set_webdriver
+      @webdriver = options.playwright? ? 'playwright' : 'selenium'
     end
 
-    def install_copilot_instructions
-      copy_file 'instructions/css.instructions.md', '.github/instructions/css.instructions.md'
-      copy_file 'instructions/js.instructions.md', '.github/instructions/js.instructions.md'
-      copy_file 'instructions/project.instructions.md', '.github/instructions/project.instructions.md'
-      copy_file 'instructions/ruby.instructions.md', '.github/instructions/ruby.instructions.md'
-      copy_file 'instructions/slim.instructions.md', '.github/instructions/slim.instructions.md'
+    def install_github_config
+      directory 'instructions', '.github/instructions'
+      directory 'workflows', '.github/workflows', force: true
+      template 'pull_request_template.md', '.github/pull_request_template.md'
     end
 
-    def install_ci_yml
-      copy_file 'templates/ci.yml', '.github/workflows/ci.yml'
+    def install_dependabot_and_codeowners
+      copy_file 'dependabot.yml', '.github/dependabot.yml', force: true
+      copy_file 'CODEOWNERS', '.github/CODEOWNERS'
+
+      say '👉 See CODEOWNERS file for important instructions.', %i[bold red on_blue]
     end
 
     def update_database_yml_for_ci

data/lib/generators/rolemodel/github/templates/CODEOWNERS

@@ -0,0 +1,8 @@
+# This file is used by Dependabot (and more broadly GitHub) to determine who needs to review
+# pull requests which contain changes to specific files. Specifically, the setup below allows
+# for the dependabot PRs to automatically assign (and notify) the Craftsman and Support Dev.
+
+# Dependabot / Dependency reviewers:
+# TODO: Update and uncomment the following lines.
+# yarn.lock @craftsman @supportdev
+# Gemfile.lock @craftsman @supportdev

data/lib/generators/rolemodel/github/templates/dependabot.yml

@@ -0,0 +1,87 @@
+version: 2
+registries:
+  ruby-github:
+    type: rubygems-server
+    url: https://rubygems.pkg.github.com/RoleModel
+    token: ${{ secrets.ROLEMODEL_PACKAGE_REPO_READ_TOKEN }}
+
+updates:
+  - package-ecosystem: bundler
+    insecure-external-code-execution: allow
+    registries:
+      - ruby-github
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    # Ignore specific dependencies or update types which may cause issues. For example:
+    # ignore:
+    #   - dependency-name: 'some-gem'
+    #   - update-types: ['version-update:semver-major']
+    groups:
+      production-security:
+        dependency-type: production
+        applies-to: security-updates
+      production-major-updates:
+        dependency-type: production
+        applies-to: version-updates
+        update-types:
+          - major
+      production-minor-updates:
+        dependency-type: production
+        applies-to: version-updates
+        update-types:
+          - minor
+          - patch
+      development-security:
+        dependency-type: development
+        applies-to: security-updates
+      development-major-updates:
+        dependency-type: development
+        applies-to: version-updates
+        update-types:
+          - major
+      development-minor-updates:
+        dependency-type: development
+        applies-to: version-updates
+        update-types:
+          - minor
+          - patch
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+      day: monday
+    # Ignore specific dependencies or update types which may cause issues. For example:
+    # ignore:
+    #   - dependency-name: 'some-package'
+    #   - update-types: ['version-update:semver-major']
+    groups:
+      production-security:
+        dependency-type: production
+        applies-to: security-updates
+      production-major-updates:
+        dependency-type: production
+        applies-to: version-updates
+        update-types:
+          - major
+      production-minor-updates:
+        dependency-type: production
+        applies-to: version-updates
+        update-types:
+          - minor
+          - patch
+      development-security:
+        dependency-type: development
+        applies-to: security-updates
+      development-major-updates:
+        dependency-type: development
+        applies-to: version-updates
+        update-types:
+          - major
+      development-minor-updates:
+        dependency-type: development
+        applies-to: version-updates
+        update-types:
+          - minor
+          - patch

data/lib/generators/rolemodel/github/templates/instructions

@@ -0,0 +1 @@
+../../../../../.github/instructions

data/lib/generators/rolemodel/github/templates/pull_request_template.md

@@ -0,0 +1,18 @@
+## Why?
+
+Why were the changes needed? What issues were the changes addressing?
+(Note: some changes may seem unrelated to the ticket, this is a great place to explain further.)
+
+## What Changed
+
+What changed in this PR?
+
+* [ ] Change 1
+
+## Pre-merge checklist
+
+* [ ] Update relevant READMEs
+
+## Screenshots
+
+If any UI changes need to be shown off, please add screenshots here.

data/lib/generators/rolemodel/github/templates/workflows/ci.yml.tt

@@ -0,0 +1,81 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+env:
+  CI: true
+  RAILS_ENV: test
+  POSTGRES_USER: postgres
+  POSTGRES_PASSWORD: password
+
+jobs:
+  project-stats:
+    name: Project Stats
+    runs-on: blacksmith-4vcpu-ubuntu-2404
+    timeout-minutes: 3
+    steps:
+      - uses: actions/checkout@v6
+      - uses: RoleModel/actions/project-stats@v<%= @rm_actions_version %>
+
+  compile-assets:
+    name: Compile Assets
+    runs-on: blacksmith-8vcpu-ubuntu-2404
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v6
+      - uses: RoleModel/actions/compile-assets@v<%= @rm_actions_version %>
+        id: check-asset-cache
+
+  non-system-test:
+    name: Linting & Ruby Non-System Tests
+    runs-on: blacksmith-4vcpu-ubuntu-2404
+    timeout-minutes: 5
+    services:
+      postgres:
+        image: postgres:17
+        ports: [ "5432:5432" ]
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with: { bundler-cache: true }
+      - run: bin/bundler-audit
+      - run: bin/brakeman --quiet --no-pager --exit-on-warn --exit-on-error
+      - run: bundle exec rubocop --format github
+      - uses: RoleModel/actions/linting-and-non-system-tests@v<%= @rm_actions_version %>
+        with:
+          needs-compiled-assets: false
+
+  system-test:
+    name: Ruby System Tests
+    runs-on: blacksmith-8vcpu-ubuntu-2404
+    timeout-minutes: 15
+    needs: compile-assets
+    services:
+      postgres:
+        image: postgres:17
+        ports: [ "5432:5432" ]
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+
+    steps:
+      - uses: actions/checkout@v6
+      # Uncomment the following if your app require VIPS for processing ActiveStorage variant images in system tests.
+      # - name: Setup vips
+      #   run: |
+      #       sudo apt-get update
+      #       sudo apt-get install -y libvips
+      - uses: RoleModel/actions/system-tests@v<%= @rm_actions_version %>
+        with:
+          web-driver: <%= @webdriver %>
+          # failure-screenshot-dir: tmp/screenshots

data/lib/generators/rolemodel/testing/rspec/templates/support/helpers/capybara_helper.rb

@@ -1,51 +1,5 @@
 # frozen_string_literal: true
 
-# Update the link_or_button selector so that we can use `click_on` with gc-menu-item
-Capybara.modify_selector(:link_or_button) do
-  label 'link or button'
-
-  xpath do |locator, **options|
-    %i[link button].map do |selector|
-      expression_for(selector, locator, **options)
-    end.reduce(:union)
-  end
-end
-
-module LoadStateWaitingLogic
-  module_function
-
-  def add_wait_for_load_state(method_names)
-    method_names.each do |method_name|
-      define_method(method_name) do |*args, **kwargs, &block|
-        super(*args, **kwargs, &block).tap do
-          return unless CapybaraHelper.supports_javascript?
-
-          Capybara.page.driver.with_playwright_page do |page|
-            page.wait_for_load_state(state: 'networkidle')
-          end
-        end
-      end
-    end
-  end
-end
-
-module LoadStateWaiter
-  include LoadStateWaitingLogic
-
-  INTERACTIVE_METHODS = %i[choose check uncheck select fill_in].freeze
-  LoadStateWaitingLogic.add_wait_for_load_state(INTERACTIVE_METHODS)
-end
-
-module ElementLoadStateWaiter
-  include LoadStateWaitingLogic
-
-  INTERACTIVE_METHODS = %i[send_keys click select].freeze
-  LoadStateWaitingLogic.add_wait_for_load_state(INTERACTIVE_METHODS)
-end
-
-Capybara::Node::Actions.prepend(LoadStateWaiter)
-Capybara::Node::Element.prepend(ElementLoadStateWaiter)
-
 module CapybaraHelper
   TIMEOUT = 10
 

data/lib/generators/rolemodel/testing/rspec/templates/support/helpers/playwright_helper.rb

@@ -22,64 +22,4 @@ module PlaywrightHelper
 
     puts "Screenshot saved to \e[4;96m#{directory}/#{filename}.png\e[0m" if print_message
   end
-
-  def self.scope_stack
-    @scope_stack ||= []
-  end
-
-  def current_scope
-    PlaywrightHelper.scope_stack.last || pw_page
-  end
-
-  def within(selector, **, &block)
-    if supports_javascript?
-      begin
-        pw_locator = if selector.is_a?(Capybara::Node::Element)
-                       pw_page.locator("xpath=#{selector.path}")
-                     else
-                       pw_page.locator(selector)
-                     end
-
-        PlaywrightHelper.scope_stack.push(pw_locator)
-
-        super
-      ensure
-        PlaywrightHelper.scope_stack.pop
-      end
-    else
-      super
-    end
-  end
-
-  def click_on(text = nil, **args)
-    if supports_javascript? && text.present?
-      scope = current_scope
-      locator = nil
-
-      %w[button link gc-menu-item summary].each do |tag|
-        loc = scope.get_by_role(tag).get_by_text(text)
-        loc = scope.get_by_role(tag).get_by_text(text, exact: true) if loc.count > 1
-        loc = scope.locator(tag).get_by_text(text) unless loc.count == 1
-        locator = loc if loc.count == 1
-        break if locator.present?
-      end
-
-      locator = scope.get_by_text(text, exact: true) if locator.blank?
-
-      raise "No element matching text: '#{text}'" if locator.count < 1
-
-      if locator.count > 1
-        raise "Multiple elements matching text: '#{text}'" unless args[:match] == :first
-
-        result = locator.first.click
-      else
-        result = locator.click
-      end
-
-      pw_page.wait_for_load_state(state: 'networkidle')
-      result
-    else
-      Capybara.click_on(text, **args)
-    end
-  end
 end

data/lib/rolemodel/version.rb

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

data/lib/rolemodel-rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rolemodel
   NODE_VERSION = '24.12.0'
   RUBY_VERSION = '4.0.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 1.0.0
 platform: ruby
 authors:
 - RoleModel Software Inc
@@ -157,6 +157,11 @@ files:
 - lib/generators/rolemodel/github/README.md
 - lib/generators/rolemodel/github/USAGE
 - lib/generators/rolemodel/github/github_generator.rb
+- lib/generators/rolemodel/github/templates/CODEOWNERS
+- lib/generators/rolemodel/github/templates/dependabot.yml
+- 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/good_job/README.md
 - lib/generators/rolemodel/good_job/USAGE
 - lib/generators/rolemodel/good_job/good_job_generator.rb