rolemodel-rails 0.26.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009bb14699c3ecc612283b81294506fdacc64e881d386d597c6b3e5302d708dd'
-  data.tar.gz: 436e21097154c27592f5f9c89557050ae64ecd6be9c4f6ee767a1aa5d5b37ce9
+  metadata.gz: d3e11cf41b7d9e5afb68a8eaca61a30785b10dcb9032fc327a52f40ea8271a2e
+  data.tar.gz: 4b4388ba6e3b2608135be47000bc9ba655b32bd4936e096d2e3ba8cafe4904c3
 SHA512:
-  metadata.gz: 83ec891bfb8720a836cd4145b2395c5db5b79e11ad2711da22be127d70da963b4cb254217aa530e279b20b68a3f47e148aea0da2643815ce3dbd753f9d0c0272
-  data.tar.gz: be94ed5589774d6f39f26741c01353d28bbcd650b21fb5e05aa94ed763b353a9caeff94eb9639d57cd0039cfe1dd75f719fb593b9d99905e25eaecc8fd8b7e8b
+  metadata.gz: 173f38c6b5f5f0101a143aaf8a5301afd7a69295d68e1c8eb54a5bd2cf06b57254f658e312a19a3a2605f6920ddab05f6f8941a0797ce7400e83c2e3ff13ac38
+  data.tar.gz: 77b6be040efd20cd738c14c44c92c57ac84241a75685cc157bfa86ddc3b6b7b6675eec3b2ad8a3b8c6dfb83c7e568aca7420746b6b81ef7d1172d6392c490c47

data/README.md

@@ -28,9 +28,7 @@ rails db:create
 Add this line to your application's Gemfile:
 
 ```ruby
-group :development do
-  gem 'rolemodel-rails', github: 'RoleModel/rolemodel_rails'
-end
+gem 'rolemodel-rails', group: :development
 ```
 
 And then execute:
@@ -115,7 +113,7 @@ e.g.
 bin/new_generator testing/fantasitic_specs 'A Fantastic Testing Framework'
 ```
 
-We use the embeded Rails apps (`example_rails*`) to test generators against. They reference the rolemodel-rails gem by local path,
+We use the embeded Rails apps (`example_rails_current` & `example_rails_legacy`) to test generators against. They reference the rolemodel-rails gem by local path,
 so you can navigate into one of them and run your generator for immediate feedback while developing.
 
 > [!IMPORTANT]
@@ -146,6 +144,19 @@ RSpec.describe Rolemodel::Testing::JasminePlaywrightGenerator, type: :generator
 end
 ```
 
+If the generator you're testing depends on being run after another generator, you should run that one first.
+
+e.g.
+
+```ruby
+RSpec.describe Rolemodel::MyGenerator, type: :generator do
+  before do
+    run_generator_against_test_app(generator: ::Rolemodel::PrereqGenerator)
+    run_generator_against_test_app
+  end
+end
+```
+
 Additional information about testing generators and the available assertions & matchers can be found at the following resources.
 
 * [Rails Guide](https://guides.rubyonrails.org/generators.html#testing-generators)

data/lib/generators/rolemodel/all_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class AllGenerator < BaseGenerator
+  class AllGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def run_all_the_generators
@@ -24,6 +24,7 @@ module Rolemodel
       generate 'rolemodel:editors'
       # generate 'rolemodel:tailored_select' # Not production ready
       generate 'rolemodel:lograge'
+      generate 'rolemodel:mcp'
     end
   end
 end

data/lib/generators/rolemodel/editors/editors_generator.rb

@@ -4,7 +4,7 @@ require_relative 'vscode_helpers'
 
 module Rolemodel
   # Add standard editorconfig and any extensions to enable it
-  class EditorsGenerator < BaseGenerator
+  class EditorsGenerator < GeneratorBase
     include Rolemodel::VSCodeHelpers
 
     # This is bringing in the root from this gem, so we only modify

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

@@ -1,31 +1,37 @@
 # frozen_string_literal: true
 
 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')
+  class GithubGenerator < GeneratorBase
+    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/good_job/good_job_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class GoodJobGenerator < BaseGenerator
+  class GoodJobGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_good_job

data/lib/generators/rolemodel/heroku/heroku_generator.rb

@@ -1,5 +1,5 @@
 module Rolemodel
-  class HerokuGenerator < BaseGenerator
+  class HerokuGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_app_json

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class KaminariGenerator < BaseGenerator
+  class KaminariGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_kaminari

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

@@ -1,6 +1,6 @@
 module Rolemodel
   module Linters
-    class AllGenerator < BaseGenerator
+    class AllGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def run_all_the_generators

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

@@ -2,7 +2,7 @@
 
 module Rolemodel
   module Linters
-    class EslintGenerator < BaseGenerator
+    class EslintGenerator < GeneratorBase
       include ReplaceContentHelper
       source_root File.expand_path('templates', __dir__)
 

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

@@ -3,7 +3,7 @@
 module Rolemodel
   module Linters
     # Install the standard rubocop and a custom cop
-    class RubocopGenerator < BaseGenerator
+    class RubocopGenerator < GeneratorBase
       source_root File.expand_path('templates', __dir__)
 
       def install_rubocop

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class LogrageGenerator < BaseGenerator
+  class LogrageGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_lograge

data/lib/generators/rolemodel/mailers/mailers_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class MailersGenerator < BaseGenerator
+  class MailersGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
     def install_premailer_rails

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

@@ -0,0 +1,13 @@
+# MCP Generator
+
+Install boilerplate for your very own MCP server.
+
+## What you get
+
+### Doorkeeper
+
+OAuth 2.1-enabled flow with dynamic application registration.
+
+### MCP
+
+A basic MCP controller that you can build on to serve tools, resources, and prompts.

data/lib/generators/rolemodel/mcp/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Sets up RoleModel MCP support and any required application wiring for the MCP endpoint.
+
+Example:
+    rails generate rolemodel:mcp
+
+    This generator adds the files and route updates needed to enable RoleModel MCP
+    in your Rails application.

data/lib/generators/rolemodel/mcp/mcp_generator.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class McpGenerator < GeneratorBase
+    source_root File.expand_path('templates', __dir__)
+
+    def update_inflections
+      inflections_path = File.join(destination_root, 'config/initializers/inflections.rb')
+      block_start = "\nActiveSupport::Inflector.inflections(:en) do |inflect|\n"
+
+      return if File.read(inflections_path).include?("inflect.acronym 'MCP'")
+
+      if File.read(inflections_path).include?(block_start)
+        inject_into_file inflections_path, "  inflect.acronym 'MCP'\n", after: block_start
+      else
+        append_to_file inflections_path, <<~RUBY
+
+          ActiveSupport::Inflector.inflections(:en) do |inflect|
+            inflect.acronym 'MCP'
+          end
+        RUBY
+      end
+    end
+
+    def install_mcp
+      bundle_command 'add mcp'
+      template 'app/controllers/mcp_controller.rb'
+      copy_file 'spec/requests/mcp_controller_spec.rb'
+
+      route <<~RUBY
+        match '/mcp', to: 'mcp#handle', via: %i[get post delete]
+      RUBY
+    end
+
+    def add_sample_mcp_resource
+      copy_file 'app/mcp/resources/controller.rb'
+      copy_file 'spec/mcp/resources/controller_spec.rb'
+
+      copy_file 'app/mcp/resources/docs/SAMPLE_DOC.md'
+      copy_file 'app/mcp/resources/docs_controller.rb'
+      copy_file 'spec/mcp/resources/docs_controller_spec.rb'
+    end
+
+    def add_sample_mcp_prompt
+      copy_file 'app/mcp/prompts/sample.rb'
+      copy_file 'spec/mcp/prompts/sample_spec.rb'
+    end
+
+    def add_sample_mcp_tool
+      copy_file 'app/mcp/tools/sample.rb'
+      copy_file 'spec/mcp/tools/sample_spec.rb'
+    end
+
+    def install_doorkeeper
+      bundle_command 'add doorkeeper'
+      run_bundle
+      generate 'doorkeeper:install'
+    end
+
+    def configure_doorkeeper
+      copy_file 'config/initializers/doorkeeper.rb', force: true
+      copy_file 'app/controllers/doorkeeper/base_controller.rb'
+
+      copy_file 'app/views/layouts/doorkeeper.html.slim'
+      template 'app/views/doorkeeper/authorizations/new.html.slim'
+      template 'app/views/doorkeeper/authorizations/error.html.slim'
+
+      copy_file 'app/assets/stylesheets/components/doorkeeper.css'
+
+      route 'use_doorkeeper'
+    end
+
+    def apply_doorkeeper_css
+      css_manifest = if File.exist?(File.join(destination_root, 'app/assets/stylesheets/application.scss'))
+        'app/assets/stylesheets/application.scss'
+      else
+        'app/assets/stylesheets/application.css'
+      end
+
+      return if File.read(File.join(destination_root, css_manifest)).include?("@import 'components/doorkeeper.css';")
+
+      append_to_file css_manifest, <<~CSS
+        @import 'components/doorkeeper.css';
+      CSS
+    end
+
+    def add_oauth_dynamic_registrations
+      copy_file 'app/controllers/oauth_registrations_controller.rb'
+      copy_file 'spec/requests/oauth_registrations_controller_spec.rb'
+      route <<~RUBY
+        post '/oauth/register', to: 'oauth_registrations#create'
+      RUBY
+    end
+
+    def add_well_known_route
+      copy_file 'app/controllers/well_known_controller.rb'
+      copy_file 'spec/requests/well_known_controller_spec.rb'
+      route <<~RUBY
+        get '/.well-known/oauth-protected-resource', to: 'well_known#oauth_protected_resource'
+        get '/.well-known/oauth-authorization-server', to: 'well_known#oauth_authorization_server'
+      RUBY
+    end
+
+    private
+
+    def application_name
+      Rails.application.name
+    end
+  end
+end