rolemodel-rails 0.26.0

data/lib/generators/rolemodel/soft_destroyable/templates/soft_destroyable_behavior.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a soft destroyable' do |factory_name, **options|
+  let(:factory_traits) { options[:factory_traits] }
+  let(:dependent_destroy_relations) { options[:dependent_destroy_relations] }
+
+  # we want to access the local variables of the block scope above, which
+  # you lose when you enter an instance method scope, but retain when you
+  # enter a block scope.
+  define_method(:create_instance) do
+    create factory_name, *factory_traits
+  end
+
+  describe '.kept' do
+    it 'only returns records that haven\'t been deleted' do
+      # given
+      first_destroyable = create_instance
+      second_destroyable = create_instance
+      first_destroyable.soft_destroy!
+      klass = first_destroyable.class
+      # when
+      remaining = klass.kept
+      # then
+      expect(remaining).to include(second_destroyable)
+      expect(remaining).not_to include(first_destroyable)
+    end
+  end
+
+  describe '.only_deleted' do
+    it 'only returns records that have been deleted' do
+      # given
+      first_destroyable = create_instance
+      second_destroyable = create_instance
+      first_destroyable.soft_destroy!
+      klass = first_destroyable.class
+      # when
+      deleted = klass.only_deleted
+      # then
+      expect(deleted).to include(first_destroyable)
+      expect(deleted).not_to include(second_destroyable)
+    end
+  end
+
+  describe '#assign_attributes' do
+    it 'ignores other attributes when _soft_destroy is present' do
+      destroyable = create_instance
+      destroyable.assign_attributes(updated_at: Time.current, _soft_destroy: '1')
+      expect(destroyable.changes).to_not include(:updated_at)
+    end
+
+    it 'includes all attributes when _soft_destroy is not present' do
+      destroyable = create_instance
+      destroyable.assign_attributes(updated_at: Time.current)
+      expect(destroyable.changes).to include(:updated_at)
+    end
+  end
+
+  describe '#soft_destroy!' do
+    it 'sets deleted_at' do
+      # given
+      destroyable = create_instance
+      expect(destroyable.deleted_at).to be_nil
+      # when
+      destroyable.soft_destroy!
+      # then
+      expect(destroyable.deleted_at).not_to be_nil
+    end
+    context 'with dependents', if: options[:dependent_destroy_relations]&.present? do
+      it 'soft_destroys dependents' do
+        # given
+        destroyable = create_instance
+        dependent_objects = dependent_destroy_relations.map { |relation_name| destroyable.send(relation_name) }.flatten
+        dependent_deleted_timestamps = dependent_objects.map(&:deleted_at)
+        expect(dependent_deleted_timestamps.compact).to be_empty
+        # when
+        destroyable.soft_destroy!
+        # then
+        dependent_deleted_timestamps = dependent_objects.map { |dependent_object| dependent_object.reload.deleted_at }.compact.uniq
+        expect(dependent_deleted_timestamps).not_to be_empty
+      end
+      it 'uses the parent deleted_at timestamp for children' do
+        # given
+        destroyable = create_instance
+        dependent_objects = dependent_destroy_relations.map { |relation_name| destroyable.send(relation_name) }.flatten
+        dependent_deleted_timestamps = dependent_objects.map(&:deleted_at)
+        expect(dependent_deleted_timestamps.compact).to be_empty
+        # when
+        destroyable.soft_destroy!
+        # then
+        dependent_deleted_timestamps = dependent_objects.map { |dependent_object| dependent_object.reload.deleted_at }.compact.uniq
+        expect(dependent_deleted_timestamps.size).to eq(1)
+        expect(dependent_deleted_timestamps.first).to eq(destroyable.reload.deleted_at)
+      end
+    end
+
+    it 'raises errors when they are encountered' do
+      destroyable = create_instance
+      destroyable.define_singleton_method(:update) do |_arg|
+        errors.add(:base, 'This record is invalid')
+        false
+      end
+      expect { destroyable.soft_destroy! }.to raise_error(ActiveModel::ValidationError)
+    end
+  end
+
+  describe 'restore!' do
+    it 'clears out deleted_at' do
+      # given
+      destroyable = create_instance
+      destroyable.update(deleted_at: 1.day.ago)
+      expect(destroyable.deleted_at).not_to be_nil
+      # when
+      destroyable.restore!
+      # then
+      expect(destroyable.deleted_at).to be_nil
+    end
+    context 'with dependents', if: options[:dependent_destroy_relations]&.present? do
+      it 'restores dependents (that were soft_destroyed at the same time)' do
+        destroyable = create_instance
+        timestamp = 1.day.ago
+        destroyable.update(deleted_at: timestamp)
+        deleted_associated_objects = []
+        dependent_destroy_relations.each do |assoc|
+          associated_objects = Array.wrap(destroyable.send(assoc))
+          associated_objects.each do |obj|
+            obj.update(deleted_at: timestamp)
+            deleted_associated_objects << obj
+          end
+        end
+        # when
+        destroyable.reload.restore!
+        # then
+        expect(deleted_associated_objects).not_to be_empty
+        deleted_associated_objects.each { |obj| expect(obj.reload).not_to be_soft_destroyed }
+      end
+      it 'does not restore dependents (when they have different deleted_at timestamps)' do
+        destroyable = create_instance
+        timestamp = 1.day.ago
+        destroyable.update(deleted_at: timestamp)
+        associated_objects_that_were_already_deleted = []
+        dependent_destroy_relations.each do |assoc|
+          associated_objects = Array.wrap(destroyable.send(assoc))
+          associated_objects.each do |obj|
+            obj.update(deleted_at: 2.days.ago)
+            associated_objects_that_were_already_deleted << obj
+          end
+        end
+        # when
+        destroyable.reload.restore!
+        # then
+        expect(associated_objects_that_were_already_deleted).not_to be_empty
+        expect(associated_objects_that_were_already_deleted.map(&:reload)).to all be_soft_destroyed
+      end
+    end
+
+    it 'raises errors when they are encountered' do
+      destroyable = create_instance
+      destroyable.update(deleted_at: 1.day.ago)
+      destroyable.define_singleton_method(:update) do |_arg|
+        errors.add(:base, 'This record is invalid')
+        false
+      end
+      expect { destroyable.restore! }.to raise_error(ActiveModel::ValidationError)
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# Rack middleware Generator
+
+## What you get
+
+* Rack middleware for serving source maps
+* Enhanced assets rake tasks to relocate and manage source map files
+
+Adds Rack middleware for serving js source maps only to allowed users in a production environment.
+
+## Usage
+
+* Ensure that app uses Warden::Manager middleware
+* Set ENV['SOURCE_MAPS_ALLOWED_USERS_EMAILS'] to a comma-separated list of emails or update the middleware to allow all super admins

data/lib/generators/rolemodel/source_map/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Adds Rack middleware for serving js source maps
+
+Example:
+    rails generate rolemodel:source_map
+
+    This will create:
+        lib/middleware/rolemodel/source_map.rb
+        lib/tasks/assets.rake

data/lib/generators/rolemodel/source_map/source_map_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class SourceMapGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def inject_config_for_production
+      inject_into_file 'config/environments/production.rb',
+                       "\nrequire_relative Rails.root.join('lib/middleware/rolemodel/source_map.rb')\n", after: "require \"active_support/core_ext/integer/time\"\n"
+      inject_into_file 'config/environments/production.rb',
+                       "\n  config.middleware.insert_after Warden::Manager, Middleware::Rolemodel::SourceMap\n\n", after: "Rails.application.configure do\n"
+    end
+
+    def copy_middleware_files
+      copy_file 'lib/middleware/rolemodel/source_map.rb'
+    end
+
+    def copy_assets_rake_task
+      copy_file 'lib/tasks/assets.rake'
+    end
+  end
+end

data/lib/generators/rolemodel/source_map/templates/lib/middleware/rolemodel/source_map.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Middleware
+  module Rolemodel
+    class SourceMap
+      def initialize(app, **options)
+        root = options.delete(:root) || 'maps'
+        default_headers = { 'Set-Cookie' => 'Same-Site=None', 'Cache-Control' => 'max-age=0;no-cache' }
+        custom_headers = default_headers.merge(options.delete(:headers) || {})
+        @app = app
+        @allowed_users_emails = ENV.fetch('SOURCE_MAPS_ALLOWED_USERS_EMAILS', '').split(',')
+        @file_server = Rack::Files.new(root, custom_headers)
+      end
+
+      def call(env)
+        if allowed_sourcemap?(env)
+          @file_server.call(env.tap { |env| env['PATH_INFO'].sub!(%r{^/[\w-]+[^/]}, '') })
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def allowed_sourcemap?(env)
+        return false unless env['PATH_INFO'].end_with?('.map')
+
+        permit_user?(env)
+      end
+
+      def permit_user?(env)
+        # Alternatively, allow sourcemaps for all super admins
+        # current_user(env)&.super_admin?
+        current_user_email = current_user(env)&.email
+        return false if current_user_email.blank?
+
+        @allowed_users_emails.include?(current_user_email)
+      end
+
+      def current_user(env)
+        env['warden']&.user
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/source_map/templates/lib/tasks/assets.rake

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+namespace :assets do
+  task clean_sourcemaps: :environment do
+    maps_root = Rails.root.join('maps')
+    next unless maps_root.exist?
+
+    assets_root = Rails.public_path.join('assets')
+
+    puts 'Cleaning sourcemaps folder'
+    maps_root.glob('*.map').each do |map_file|
+      asset_file = map_file.basename('.map')
+      map_file.delete unless assets_root.join(asset_file).exist?
+    end
+  end
+
+  task relocate_sourcemaps: :environment do
+    maps_root = Rails.root.join('maps')
+    maps_root.mkpath
+
+    puts 'Relocating sourcemap files'
+    Rails.root.glob('public/assets/*.map').each do |map_file|
+      map_file.rename(maps_root.join(map_file.basename))
+    end
+  end
+
+  task clear_sourcemaps: :environment do
+    maps_root = Rails.root.join('maps')
+    maps_root.rmtree if maps_root.exist?
+  end
+end
+
+Rake::Task['assets:clean'].enhance do
+  Rake::Task['assets:clean_sourcemaps'].invoke
+end
+
+Rake::Task['assets:precompile'].enhance do
+  Rake::Task['assets:relocate_sourcemaps'].invoke
+end
+
+Rake::Task['assets:clobber'].enhance do
+  Rake::Task['assets:clear_sourcemaps'].invoke
+end

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

@@ -0,0 +1,7 @@
+# TailoredSelect Generator
+
+`rails g rolemodel:tailored_select`
+
+## What you get
+
+The [Tailored Select](https://github.com/RoleModel/tailored-select) web component

data/lib/generators/rolemodel/tailored_select/USAGE

@@ -0,0 +1,5 @@
+Description:
+  runs the tailored select generator
+
+Example:
+  rails generate rolemodel:tailored_select

data/lib/generators/rolemodel/tailored_select/tailored_select_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class TailoredSelectGenerator < BaseGenerator
+    source_root File.expand_path('templates', __dir__)
+
+    def add_tailored_select_package
+      say 'Installing Tailored Select package', :green
+
+      run 'yarn add @rolemodel/tailored-select'
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# Testing Generator
+
+[USAGE](./USAGE)
+
+## What you get
+
+* [RSpec](./rspec)
+* [JasminePlaywright](./jasmine_playwright)
+* [FactoryBot](./factory_bot)
+* [TestProf](./test_prof)
+* [ParallelTests](./parallel_tests)

data/lib/generators/rolemodel/testing/USAGE

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

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

@@ -0,0 +1,17 @@
+module Rolemodel
+  module Testing
+    class AllGenerator < BaseGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def run_all_the_generators
+        generate 'rolemodel:testing:factory_bot'
+        if yes?('Would you like to add jasmine-playwright-runner for browser testing?')
+          generate 'rolemodel:testing:jasmine_playwright'
+        end
+        generate 'rolemodel:testing:parallel_tests'
+        generate 'rolemodel:testing:rspec'
+        generate 'rolemodel:testing:test_prof'
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/testing/factory_bot/README.md

@@ -0,0 +1,18 @@
+# FactoryBot Generator
+
+Depends on [RSpec Generator](../rspec)
+
+## What you get
+
+Installs [factory_bot_rails](https://github.com/thoughtbot/factory_bot_rails)
+
+### Factory Syntax methods
+
+Allow you to use the short hand methods for creating or building factories
+
+```ruby
+it 'tests something' do
+  created_user = create(:user)
+  built_user = build(:user)
+end
+```

data/lib/generators/rolemodel/testing/factory_bot/USAGE

@@ -0,0 +1,8 @@
+Description:
+    installs and configures FactoryBot
+
+Example:
+    rails generate rolemodel:testing:factory_bot
+
+    This will create:
+        spec/support/factory_bot.rb

data/lib/generators/rolemodel/testing/factory_bot/factory_bot_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  module Testing
+    class FactoryBotGenerator < BaseGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def install_factory_bot_rails
+        gem_group :development, :test do
+          gem 'factory_bot_rails'
+        end
+        run_bundle
+      end
+
+      def add_spec_files
+        template 'support/factory_bot.rb', 'spec/support/factory_bot.rb'
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/testing/factory_bot/templates/support/factory_bot.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/lib/generators/rolemodel/testing/jasmine_playwright/README.md

@@ -0,0 +1,9 @@
+# Jasmine Playwright Generator
+Sets up Jasmine Playwright
+
+**Notes**:
+* Configured for testing Web Components and generic DOM. If you need tests for stimulus controllers and/or react components, see the documentation for jasmine-playwright-runner.
+
+## What you get
+* A command for running component tests (yarn test:browser)
+* An example test (example_spec.js)

data/lib/generators/rolemodel/testing/jasmine_playwright/jasmine_playwright_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  module Testing
+    class JasminePlaywrightGenerator < BaseGenerator
+      include ReplaceContentHelper
+      source_root File.expand_path('templates', __dir__)
+      class_option :github_package_token, type: :string, default: ENV['GITHUB_PACKAGES_TOKEN'], desc: 'GitHub Packages token with access to @rolemodel packages'
+
+      TEST_COMMAND = 'NODE_ENV=test jp-runner --config jp-runner.config.mjs --webpack-config webpack.config.cjs'
+      DEV_DEPENDENCIES = %w[
+        @rolemodel/jasmine-playwright-runner
+        playwright
+        lit-html
+      ].freeze
+
+      def fail_without_github_token
+        raise 'a --github_package_token option or GITHUB_PACKAGES_TOKEN environment variable is required' if options[:github_package_token].blank?
+      end
+
+      def yarn_init_unless_package_json_exists
+        run 'yarn init' unless File.exist?(File.expand_path('package.json', destination_root))
+      end
+
+      def add_browser_test_script
+        say 'Adding yarn test:browser command', :green
+
+        add_package_json_script 'test:browser', TEST_COMMAND
+      end
+
+      def set_node_version
+        say "Setting local Node version to #{set_color(NODE_VERSION, :yellow)}", :green
+
+        create_file '.node-version', NODE_VERSION, force: true
+      end
+
+      def add_dev_dependencies
+        say 'Adding new dev dependency to package.json', :green
+
+        run "yarn add --dev #{DEV_DEPENDENCIES.join(' ')}"
+      end
+
+      def add_spec_config_files
+        say 'Adding Jasmine Playwright configuration files', :green
+
+        template 'spec/javascript/browser/example_spec.js'
+        template 'jp-runner.config.mjs'
+        template 'spec/javascript/browser/setupTests.js'
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/testing/jasmine_playwright/templates/jp-runner.config.mjs

@@ -0,0 +1,5 @@
+export default {
+  setupFiles: [
+    'spec/javascript/browser/setupTests.js'
+  ]
+}

data/lib/generators/rolemodel/testing/jasmine_playwright/templates/spec/javascript/browser/example_spec.js

@@ -0,0 +1,15 @@
+import { html } from '@rolemodel/jasmine-playwright-runner/dom'
+import { page } from '@rolemodel/jasmine-playwright-runner/page'
+
+describe('example', () => {
+  it('is there', async () => {
+    const content = 'Hello World'
+    await html`
+    <div>
+      ${content}
+    </div>
+    `
+
+    await expectAsync(page.getByText(content)).toBeInTheDocument()
+  })
+})

data/lib/generators/rolemodel/testing/jasmine_playwright/templates/spec/javascript/browser/setupTests.js

@@ -0,0 +1,3 @@
+import { setup as setupDom } from '@rolemodel/jasmine-playwright-runner/dom'
+
+setupDom()

data/lib/generators/rolemodel/testing/jasmine_playwright/templates/support/react.mjs

@@ -0,0 +1,26 @@
+import React from 'react'
+import ReactDOM from 'react-dom'
+
+let reactDOMRoot
+
+export function setup() {
+  window.React = React
+  window.ReactDOM = ReactDOM
+
+  afterEach(() => {
+    if (reactDOMRoot) {
+      ReactDOM.unmountComponentAtNode(reactDOMRoot)
+      reactDOMRoot.remove()
+      reactDOMRoot = undefined
+    }
+  })
+}
+
+export function render(reactNode) {
+  if (!reactDOMRoot) {
+    reactDOMRoot = document.createElement('div')
+    document.body.append(reactDOMRoot)
+  }
+
+  ReactDOM.render(reactNode, reactDOMRoot)
+}

data/lib/generators/rolemodel/testing/parallel_tests/README.md

@@ -0,0 +1,53 @@
+# Parallel Tests Generator
+
+## What you get
+
+### Parallel Tests Setup
+
+This generator configures your Rails application to run RSpec tests in parallel, greatly reducing the time it takes to run your test suite.
+
+### Gemfile Addition
+
+The generator will add the `parallel_tests`, `turbo_tests`, and `rspec_junit_formatter` gems to your Gemfile and run bundle install.
+
+```rb
+group :development, :test do
+  gem 'parallel_tests'
+  gem 'turbo_tests', require: false
+  gem 'rspec_junit_formatter', require: false
+end
+```
+
+### RSpec Configuration
+The generator will create a `.rspec_parallel` file in your Rails root directory.
+
+```
+--format RspecJunitFormatter --out tmp/rspec-<%= ENV['TEST_ENV_NUMBER'] %>.xml
+--format ParallelTests::RSpec::RuntimeLogger --out tmp/turbo_rspec_runtime.log
+--format ParallelTests::RSpec::FailuresLogger
+```
+
+### Database Configuration
+
+Your `database.yml` will be updated to support parallel test databases. This allows each test process to use its own isolated database.
+
+```yaml
+test:
+  # ...existing configuration...
+  database: your_app_test<%= ENV['TEST_ENV_NUMBER'] %>
+```
+
+### Running Parallel Tests
+
+Once configured, you can run your tests in parallel using:
+
+```bash
+# Run entire test suite in parallel
+bundle exec rake parallel:spec
+
+# Run specific tests in parallel
+bundle exec rake parallel:spec[spec/models]
+
+# Specify number of processes (default is the number of CPUs)
+bundle exec rake parallel:spec[spec,4]
+```

data/lib/generators/rolemodel/testing/parallel_tests/USAGE

@@ -0,0 +1,12 @@
+Description:
+    generates configuration for running RSpec tests in parallel
+
+Example:
+    rails generate rolemodel:testing:parallel_rspec
+
+    This will add:
+        parallel_tests to your Gemfile
+        turbo_tests to your Gemfile for a nicer testing experience
+        rspec_junit_formatter for test reporting
+        .rspec_parallel file for RSpec configuration
+        database.yml configuration for parallel testing

data/lib/generators/rolemodel/testing/parallel_tests/parallel_tests_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  module Testing
+    class ParallelTestsGenerator < BaseGenerator # rubocop:disable Style/Documentation
+      source_root File.expand_path('templates', __dir__)
+
+      def install_parallel_tests
+        gem_group :development, :test do
+          gem 'parallel_tests'
+          gem 'turbo_tests', require: false
+          gem 'rspec_junit_formatter', require: false
+        end
+        run_bundle
+      end
+
+      def add_rspec_parallel_file
+        template '.rspec_parallel', '.rspec_parallel'
+      end
+
+      def configure_database_for_parallel_testing
+        say_status :update, 'Updating database.yml for parallel testing', :blue
+
+        # If there is, append the TEST_ENV_NUMBER to it
+        gsub_file 'config/database.yml', /(test:.*\n\s+database:.*_test)/m, "\\1<%= ENV['TEST_ENV_NUMBER'] %>"
+
+        say_status :update, 'Updated database configuration successfully', :green
+      end
+
+      def setup_parallel_test_databases
+        say_status :setup, 'Setting up parallel test databases...', :blue
+        bundle_command 'exec rake parallel:setup'
+      end
+
+      def display_post_install_message
+        say_status :info, 'Parallel Tests has been configured!', :green
+        say_status :info, 'You can now run your tests in parallel with:', :green
+        say_status :info, 'bundle exec rake parallel:spec', :green
+      end
+    end
+  end
+end