rolemodel-rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0fc94b9f1782c5251c05b2ec1e9f8de40ff8021383c4d358c1cf67dae0c2e86
-  data.tar.gz: 8eb5debdc363920c4b21f06381b4c6789162a5dcd984c40ba377fecfb1eb90a2
+  metadata.gz: d3e11cf41b7d9e5afb68a8eaca61a30785b10dcb9032fc327a52f40ea8271a2e
+  data.tar.gz: 4b4388ba6e3b2608135be47000bc9ba655b32bd4936e096d2e3ba8cafe4904c3
 SHA512:
-  metadata.gz: be60dc3620a2d22b8ed1148a1966219c830d685e48df12ed5abafd884cd1f749f4251360173f42b355b10865238f000a95da825624c21ee898fde25c7c9dc9d9
-  data.tar.gz: b76c9375e38755a22e66aff75109727a7a03273d9ee4dc9e44049774259f2b60ca793f3a550b79550cdd729cca9154e400547a2472f2565fe18fedb05cfd10e3
+  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/github_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  class GithubGenerator < BaseGenerator
+  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

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

data/lib/generators/rolemodel/mcp/templates/app/assets/stylesheets/components/doorkeeper.css

@@ -0,0 +1,140 @@
+.doorkeeper {
+  position: fixed;
+  inset: 0;
+  box-sizing: border-box;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  padding: var(--op-space-x-large) var(--op-space-large);
+  overflow: auto;
+  background-color: var(--op-color-neutral-plus-eight);
+  color: var(--op-color-neutral-minus-max);
+  font-family: var(--op-font-family);
+}
+
+.doorkeeper__card {
+  width: min(100%, 48rem);
+  background-color: var(--op-color-white);
+  border: var(--op-border-width) solid var(--op-color-neutral-plus-six);
+  border-radius: var(--op-radius-x-large);
+  box-shadow: var(--op-shadow-large);
+  display: flex;
+  flex-direction: column;
+  gap: var(--op-space-large);
+  padding: var(--op-space-2x-large);
+}
+
+.doorkeeper__brand {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  gap: var(--op-space-large);
+  margin-bottom: var(--op-space-small);
+}
+
+.doorkeeper__logo {
+  width: 180px;
+  height: auto;
+}
+
+.doorkeeper__title {
+  margin: 0;
+  font-size: var(--op-font-2x-large);
+  font-weight: var(--op-font-weight-bold);
+  color: var(--op-color-primary-minus-two);
+  text-align: center;
+  letter-spacing: -0.04em;
+}
+
+.doorkeeper__prompt {
+  margin: 0;
+  font-size: var(--op-font-large);
+  line-height: var(--op-line-height-loose);
+  color: var(--op-color-neutral-minus-three);
+  text-align: center;
+}
+
+.doorkeeper__client-name {
+  color: var(--op-color-primary-base);
+  font-weight: var(--op-font-weight-bold);
+}
+
+.doorkeeper__permissions {
+  background-color: var(--op-color-primary-plus-eight);
+  border: var(--op-border-width) solid var(--op-color-primary-plus-six);
+  border-radius: var(--op-radius-medium);
+  padding: var(--op-space-large);
+  display: flex;
+  flex-direction: column;
+  gap: var(--op-space-medium);
+}
+
+.doorkeeper__permissions-label {
+  margin: 0;
+  font-size: var(--op-font-small);
+  text-transform: uppercase;
+  letter-spacing: 0.05em;
+  font-weight: var(--op-font-weight-bold);
+  color: var(--op-color-primary-minus-three);
+}
+
+.doorkeeper__scope-list {
+  margin: 0;
+  padding-left: var(--op-space-large);
+  display: grid;
+  gap: var(--op-space-small);
+  color: var(--op-color-primary-minus-max);
+}
+
+.doorkeeper__scope-item {
+  line-height: var(--op-line-height-base);
+  font-weight: var(--op-font-weight-medium);
+}
+
+.doorkeeper__actions {
+  display: flex;
+  flex-direction: column;
+  gap: var(--op-space-medium);
+  margin-top: var(--op-space-medium);
+}
+
+.doorkeeper__error {
+  align-self: stretch;
+}
+
+.doorkeeper__error-description {
+  margin: 0;
+  font-size: var(--op-font-medium);
+  line-height: var(--op-line-height-base);
+  white-space: pre-wrap;
+  overflow-wrap: anywhere;
+}
+
+.doorkeeper__form {
+  margin: 0;
+}
+
+.doorkeeper__button {
+  width: 100%;
+  justify-content: center;
+  font-weight: var(--op-font-weight-semi-bold);
+}
+
+@media (max-width: 640px) {
+  .doorkeeper {
+    padding: var(--op-space-large) var(--op-space-medium);
+  }
+
+  .doorkeeper__card {
+    padding: var(--op-space-large);
+    border-radius: var(--op-radius-large);
+  }
+
+  .doorkeeper__logo {
+    width: 140px;
+  }
+
+  .doorkeeper__title {
+    font-size: var(--op-font-x-large);
+  }
+}

data/lib/generators/rolemodel/mcp/templates/app/controllers/doorkeeper/base_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  class BaseController < ::ApplicationController
+    skip_forgery_protection
+  end
+end

data/lib/generators/rolemodel/mcp/templates/app/controllers/mcp_controller.rb.tt

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+class MCPController < ApplicationController
+  # skip_before_action :authenticate_user!
+  skip_forgery_protection
+
+  before_action :authorize_mcp
+  before_action :set_current_user
+
+  def handle
+    server = build_server
+    transport = MCP::Server::Transports::StreamableHTTPTransport.new(server, stateless: true)
+    server.transport = transport
+
+    status, response_headers, body = transport.handle_request(request)
+    respond_with(status, response_headers, body)
+  end
+
+  private
+
+  def respond_with(status, headers, body)
+    headers.each { |key, value| response.set_header(key, value) }
+    response.status = status
+    self.response_body = body
+  end
+
+  def authorize_mcp
+    doorkeeper_authorize! :mcp
+    set_mcp_resource_metadata_header if response.status == 401
+  end
+
+  def set_current_user
+    @current_user = User.find_by(id: doorkeeper_token&.resource_owner_id)
+    unauthorized_request if @current_user.blank?
+  end
+
+  def unauthorized_request
+    set_mcp_resource_metadata_header
+    render json: { error: 'Unauthorized' }, status: :unauthorized
+  end
+
+  def set_mcp_resource_metadata_header
+    metadata = %(resource_metadata="#{request.base_url}/.well-known/oauth-protected-resource")
+    response.set_header('WWW-Authenticate', %(Bearer realm="<%= application_name.titleize %>", #{metadata}))
+  end
+
+  def build_server
+    server = MCP::Server.new(**mcp_server_config)
+    handle_resources(server)
+
+    server
+  end
+
+  def handle_resources(server) # rubocop:disable Metrics/MethodLength
+    controllers = [
+      Resources::DocsController
+    ]
+
+    server.resources_read_handler do |params|
+      uri = params[:uri].to_s
+      controller = controllers.find { |h| h.serves?(uri) }
+
+      unless controller
+        raise MCP::Server::RequestHandlerError.new(
+          "Unable to serve resource for URI: #{uri}. Supported schemas: #{controllers.map(&:schema).join(', ')}",
+          params,
+          error_type: :invalid_params
+        )
+      end
+
+      controller.call(params, server_context)
+    end
+  end
+
+  def mcp_server_config # rubocop:disable Metrics/MethodLength
+    {
+      name: '<%= application_name.underscore %>_mcp',
+      version: '1.0.0',
+      tools: [Tools::Sample],
+      prompts: [Prompts::Sample],
+      server_context:,
+      resources: [
+        *Resources::DocsController.resource_list,
+      ],
+    }
+  end
+
+  def server_context
+    @server_context ||= { current_user: @current_user }
+  end
+end

data/lib/generators/rolemodel/mcp/templates/app/controllers/oauth_registrations_controller.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class OauthRegistrationsController < ApplicationController
+  # skip_before_action :authenticate_user!
+  skip_forgery_protection
+
+  def create
+    app = Doorkeeper::Application.new(doorkeeper_params)
+    return client_metadata_error('redirect_uris is required') if app.redirect_uri.blank?
+
+    if app.save
+      render json: base_response(app), status: :created
+    else
+      client_metadata_error(app.errors.full_messages.join(', '))
+    end
+  end
+
+  private
+
+  def base_response(app)
+    {
+      client_id: app.uid,
+      client_name: app.name,
+      redirect_uris: app.redirect_uri.split("\n"),
+      grant_types: %w[authorization_code refresh_token],
+      response_types: ['code'],
+      token_endpoint_auth_method: app.confidential? ? 'client_secret_basic' : 'none',
+      client_id_issued_at: app.created_at.to_i,
+      scope: 'mcp',
+      client_secret: app.confidential? ? app.secret : nil,
+    }.compact
+  end
+
+  def client_metadata_error(description)
+    render json: { error: 'invalid_client_metadata', error_description: description }, status: :bad_request
+  end
+
+  def doorkeeper_params
+    {
+      name: params[:client_name].presence || 'MCP Client',
+      redirect_uri: params[:redirect_uris].is_a?(Array) ? params[:redirect_uris].join("\n") : params[:redirect_uris],
+      scopes: 'mcp',
+      confidential: params[:token_endpoint_auth_method] != 'none',
+    }
+  end
+end

data/lib/generators/rolemodel/mcp/templates/app/controllers/well_known_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class WellKnownController < ApplicationController
+  # skip_before_action :authenticate_user!
+  before_action :set_base_url
+
+  def oauth_protected_resource
+    render json: {
+      resource: "#{@base_url}/mcp",
+      authorization_servers: [@base_url],
+    }
+  end
+
+  def oauth_authorization_server
+    render json: authorization_server_metadata
+  end
+
+  private
+
+  def authorization_server_metadata # rubocop:disable Metrics/MethodLength
+    {
+      issuer: @base_url,
+      authorization_endpoint: "#{@base_url}/oauth/authorize",
+      token_endpoint: "#{@base_url}/oauth/token",
+      registration_endpoint: "#{@base_url}/oauth/register",
+      revocation_endpoint: "#{@base_url}/oauth/revoke",
+      introspection_endpoint: "#{@base_url}/oauth/introspect",
+      scopes_supported: ['mcp'],
+      response_types_supported: ['code'],
+      grant_types_supported: %w[authorization_code client_credentials refresh_token],
+      token_endpoint_auth_methods_supported: %w[none client_secret_basic client_secret_post],
+      code_challenge_methods_supported: ['S256'],
+    }
+  end
+
+  def set_base_url
+    @base_url = request.base_url
+  end
+end

data/lib/generators/rolemodel/mcp/templates/app/mcp/prompts/sample.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Prompts
+  class Sample < ::MCP::Prompt
+    prompt_name 'sample_prompt'
+    title 'Sample Prompt'
+    description 'Sample prompt description'
+
+    class << self
+      def template(_args, _server_context: nil)
+        ::MCP::Prompt::Result.new(
+          description: 'Sample prompt result description',
+          messages: [
+            ::MCP::Prompt::Message.new(
+              role: 'assistant',
+              content: ::MCP::Content::Text.new(instructions_text),
+            ),
+          ],
+        )
+      end
+
+      private
+
+      def instructions_text
+        <<~TEXT
+          This is a sample prompt.
+
+          MCP prompts can return instructions for the agent, which can be used to guide the agent's behavior.
+          For example, you might include instructions on how to query a specific resource or use a specific tool.
+          Think of it like a system prompt in a conversational agent, but it can be dynamically generated based on the
+          context of the request.
+        TEXT
+      end
+    end
+  end
+end