staples 0.1.0 → 1.0.0

data/lib/templates/app/views/devise/passwords/new.html.erb

@@ -0,0 +1,22 @@
+<% content_for :title, "Forgot your password?" %>
+
+<h1 id="main_label" class="text-center"><%= content_for :title %></h1>
+
+<div class="mx-auto w-100" style="max-width: 400px;">
+  <%= render "card" do %>
+    <%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f| %>
+      <%= render "error_messages", resource: resource %>
+
+      <div class="mb-3">
+        <%= f.label :email, class: "form-label" %>
+        <%= f.email_field :email, autofocus: true, autocomplete: "email", class: "form-control" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.submit "Send me password reset instructions", class: "btn btn-primary" %>
+      </div>
+    <% end %>
+
+    <%= render "devise/shared/links" %>
+  <% end %>
+</div>

data/lib/templates/app/views/devise/registrations/edit.html.erb

@@ -0,0 +1,50 @@
+<% content_for :title, "Edit #{resource_name.to_s.humanize}" %>
+
+<h1 id="main_label" class="text-center"><%= content_for :title %></h1>
+
+<div class="mx-auto w-100" style="max-width: 400px;">
+  <%= render "card" do %>
+    <%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put }) do |f| %>
+      <%= render "error_messages", resource: resource %>
+
+      <div class="mb-3">
+        <%= f.label :email, class: "form-label" %>
+        <%= f.email_field :email, autofocus: true, autocomplete: "email", class: "form-control" %>
+      </div>
+
+      <% if devise_mapping.confirmable? && resource.pending_reconfirmation? %>
+        <div class="alert alert-info">Currently waiting confirmation for: <%= resource.unconfirmed_email %></div>
+      <% end %>
+
+      <div class="mb-3">
+        <%= f.label :password, class: "form-label" %>
+        <div class="form-text">Leave blank if you don't want to change it</div>
+        <%= f.password_field :password, autocomplete: "new-password", class: "form-control" %>
+        <% if @minimum_password_length %>
+          <div class="form-text"><%= @minimum_password_length %> characters minimum</div>
+        <% end %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.label :password_confirmation, class: "form-label" %>
+        <%= f.password_field :password_confirmation, autocomplete: "new-password", class: "form-control" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.label :current_password, class: "form-label" %>
+        <div class="form-text">We need your current password to confirm your changes</div>
+        <%= f.password_field :current_password, autocomplete: "current-password", class: "form-control" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.submit "Update", class: "btn btn-primary" %>
+      </div>
+    <% end %>
+
+    <h2 class="mt-5">Cancel my account</h2>
+
+    <div class="mb-3">Unhappy? <%= button_to "Cancel my account", registration_path(resource_name), data: { confirm: "Are you sure?", turbo_confirm: "Are you sure?" }, method: :delete, class: "btn btn-danger" %></div>
+
+    <%= link_to "Back", :back, class: "btn btn-link" %>
+  <% end %>
+</div>

data/lib/templates/app/views/devise/registrations/new.html.erb

@@ -0,0 +1,35 @@
+<% content_for :title, "Sign up" %>
+
+<h1 id="main_label" class="text-center"><%= content_for :title %></h1>
+
+<div class="mx-auto w-100" style="max-width: 400px;">
+  <%= render "card" do %>
+    <%= form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
+      <%= render "error_messages", resource: resource %>
+
+      <div class="mb-3">
+        <%= f.label :email, class: "form-label" %>
+        <%= f.email_field :email, autofocus: true, autocomplete: "email", class: "form-control" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.label :password, class: "form-label" %>
+        <% if @minimum_password_length %>
+          <div class="form-text"><%= @minimum_password_length %> characters minimum</div>
+        <% end %>
+        <%= f.password_field :password, autocomplete: "new-password", class: "form-control" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.label :password_confirmation, class: "form-label" %>
+        <%= f.password_field :password_confirmation, autocomplete: "new-password", class: "form-control" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.submit "Sign up", class: "btn btn-primary" %>
+      </div>
+    <% end %>
+
+    <%= render "devise/shared/links" %>
+  <% end %>
+</div>

data/lib/templates/app/views/devise/sessions/new.html.erb

@@ -0,0 +1,32 @@
+<% content_for :title, "Log in" %>
+
+<h1 id="main_label" class="text-center"><%= content_for :title %></h1>
+
+<div class="mx-auto w-100" style="max-width: 400px;">
+  <%= render "card" do %>
+    <%= form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
+      <div class="mb-3">
+        <%= f.label :email, class: "form-label" %>
+        <%= f.email_field :email, autofocus: true, autocomplete: "email", class: "form-control" %>
+      </div>
+
+      <div class="mb-3">
+        <%= f.label :password, class: "form-label" %>
+        <%= f.password_field :password, autocomplete: "current-password", class: "form-control" %>
+      </div>
+
+      <% if devise_mapping.rememberable? %>
+        <div class="mb-3 form-check">
+          <%= f.check_box :remember_me, class: "form-check-input" %>
+          <%= f.label :remember_me, class: "form-check-label" %>
+        </div>
+      <% end %>
+
+      <div class="mb-3">
+        <%= f.submit "Log in", class: "btn btn-primary" %>
+      </div>
+    <% end %>
+
+    <%= render "devise/shared/links" %>
+  <% end %>
+</div>

data/lib/templates/app/views/devise/shared/_links.html.erb

@@ -0,0 +1,27 @@
+<div class="mt-3">
+  <%- if controller_name != 'sessions' %>
+    <div class="mb-2"><%= link_to "Log in", new_session_path(resource_name) %></div>
+  <% end %>
+
+  <%- if devise_mapping.registerable? && controller_name != 'registrations' %>
+    <div class="mb-2"><%= link_to "Sign up", new_registration_path(resource_name) %></div>
+  <% end %>
+
+  <%- if devise_mapping.recoverable? && controller_name != 'passwords' && controller_name != 'registrations' %>
+    <div class="mb-2"><%= link_to "Forgot your password?", new_password_path(resource_name) %></div>
+  <% end %>
+
+  <%- if devise_mapping.confirmable? && controller_name != 'confirmations' %>
+    <div class="mb-2"><%= link_to "Didn't receive confirmation instructions?", new_confirmation_path(resource_name) %></div>
+  <% end %>
+
+  <%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %>
+    <div class="mb-2"><%= link_to "Didn't receive unlock instructions?", new_unlock_path(resource_name) %></div>
+  <% end %>
+
+  <%- if devise_mapping.omniauthable? %>
+    <%- resource_class.omniauth_providers.each do |provider| %>
+      <div class="mb-2"><%= button_to "Sign in with #{OmniAuth::Utils.camelize(provider)}", omniauth_authorize_path(resource_name, provider), data: { turbo: false }, class: "btn btn-outline-secondary" %></div>
+    <% end %>
+  <% end %>
+</div>

data/lib/templates/app/views/pages/home.html.erb

@@ -0,0 +1,21 @@
+<% content_for :title, "Hello world!" %>
+
+<h1 id="main_label"><%= content_for :title %></h1>
+
+<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal">
+  Click Here
+</button>
+
+<div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
+  <div class="modal-dialog">
+    <div class="modal-content">
+      <div class="modal-header">
+        <h2 class="modal-title fs-5" id="exampleModalLabel">Hello world!</h2>
+        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+      </div>
+      <div class="modal-body">
+        If you can read this, Staples has successfully installed.
+      </div>
+    </div>
+  </div>
+</div>

data/lib/templates/base.rb

@@ -0,0 +1,246 @@
+def source_paths
+  Array(super) + [__dir__]
+end
+
+def install_gems
+  gem "active_link_to"
+  gem "devise", github: "heartcombo/devise"
+  gem "high_voltage"
+  gem "sidekiq"
+  gem "strong_migrations"
+
+  gem_group :development, :test do
+    gem "capybara-email"
+    gem "factory_bot_rails"
+  end
+
+  gem_group :test do
+    gem "capybara_accessibility_audit"
+  end
+end
+
+install_gems
+
+after_bundle do
+  # Generators
+  generate_devise
+  generate_strong_migrations
+
+  # Initializers & Configuration
+  configure_environments
+  configure_database
+  add_high_voltage_initializer
+  add_sidekiq_initializer
+
+  # CI
+  configure_ci
+
+  # Database
+  add_migrations
+
+  # Deployment
+  add_procfiles
+
+  # Application Code
+  add_application_code
+  configure_routes
+  add_rake_tasks
+
+  # Test Suite
+  add_test_suite
+
+  # Assets
+  configure_sass
+
+  # Finalization
+  run_migrations
+  update_readme
+  lint_codebase
+
+  print_message
+end
+
+def generate_devise
+  rails_command "generate devise:install"
+  gsub_file "config/initializers/devise.rb", /config\.mailer_sender = ['"]please-change-me-at-config-initializers-devise@example\.com['"]/, 'config.mailer_sender = ENV.fetch("MAILER_SENDER", "contact@example.com")'
+end
+
+def generate_strong_migrations
+  rails_command "generate strong_migrations:install"
+end
+
+def configure_ci
+  uncomment_lines ".github/workflows/ci.yml", /RAILS_MASTER_KEY/
+end
+
+def add_migrations
+  copy_file "db/migrate/20251121192825_devise_create_users.rb"
+  copy_file "db/migrate/20251122141432_create_organizations.rb"
+  copy_file "db/migrate/20251122141520_create_memberships.rb"
+end
+
+def add_procfiles
+  copy_file "Procfile"
+  append_to_file "Procfile.dev", "worker: bundle exec sidekiq -c 10"
+end
+
+def configure_database
+  gsub_file "config/database.yml", /^production:.*?password:.*?\n/m, <<~YAML
+    production:
+      <<: *default
+      url: <%= ENV["DATABASE_URL"] %>
+  YAML
+end
+
+def add_application_code
+  # Controllers and Pages
+  copy_file "app/controllers/pages_controller.rb"
+  copy_file "app/views/pages/home.html.erb"
+
+  # Models
+  copy_file "app/models/membership.rb"
+  copy_file "app/models/organization.rb"
+  copy_file "app/models/user.rb"
+  copy_file "app/models/user/account.rb"
+
+  # Application Partials
+  copy_file "app/views/application/_card.html.erb"
+  copy_file "app/views/application/_error_messages.html.erb"
+  copy_file "app/views/application/_flashes.html.erb"
+  copy_file "app/views/application/_nav.html.erb"
+
+  # Devise Views
+  copy_file "app/views/devise/confirmations/new.html.erb"
+  copy_file "app/views/devise/passwords/edit.html.erb"
+  copy_file "app/views/devise/passwords/new.html.erb"
+  copy_file "app/views/devise/registrations/edit.html.erb"
+  copy_file "app/views/devise/registrations/new.html.erb"
+  copy_file "app/views/devise/sessions/new.html.erb"
+  copy_file "app/views/devise/shared/_links.html.erb"
+
+  # Application Layout
+  gsub_file "app/views/layouts/application.html.erb", /<html>/, "<html lang=\"<%= I18n.locale %>\">"
+  application_html_erb = <<-ERB
+    <%= render "nav" %>
+    <main class="container" aria-labelledby="main_label">
+      <%= render "flashes" %>
+      <%= yield %>
+    </main>
+  ERB
+  gsub_file "app/views/layouts/application.html.erb", /^    <%= yield %>\n/, application_html_erb
+end
+
+def configure_environments
+  environment "config.active_job.queue_adapter = :sidekiq"
+  environment "config.active_record.strict_loading_by_default = true"
+  environment "config.active_record.strict_loading_mode = :n_plus_one_only"
+  environment "config.require_master_key = true"
+
+  environment "config.sandbox_by_default = true", env: "production"
+  environment "config.active_record.action_on_strict_loading_violation = :log", env: "production"
+  gsub_file "config/environments/production.rb", /# config\.asset_host =.*$/, 'config.asset_host = ENV["ASSET_HOST"]'
+  gsub_file "config/environments/production.rb", /config\.action_mailer\.default_url_options = \{ host: .*? \}/, 'config.action_mailer.default_url_options = { host: ENV.fetch("APPLICATION_HOST") }'
+
+  environment "config.active_model.i18n_customize_full_message = true", env: "development"
+  uncomment_lines "config/environments/development.rb", /config\.i18n\.raise_on_missing_translations/
+  uncomment_lines "config/environments/development.rb", /config\.generators\.apply_rubocop_autocorrect_after_generate!/
+
+  gsub_file "config/environments/test.rb", /config\.action_dispatch\.show_exceptions = :rescuable/, "config.action_dispatch.show_exceptions = :none"
+  gsub_file "config/environments/test.rb", /config\.action_mailer\.default_url_options = \{ host: .*? \}/, "config.action_mailer.default_url_options = { host: \"localhost\", port: 3001 }"
+  uncomment_lines "config/environments/test.rb", /config\.i18n\.raise_on_missing_translations/
+  environment "config.active_job.queue_adapter = :inline", env: "test"
+end
+
+def add_high_voltage_initializer
+  copy_file "config/initializers/high_voltage.rb"
+end
+
+def add_sidekiq_initializer
+  copy_file "config/initializers/sidekiq.rb"
+end
+
+def configure_routes
+  prepend_to_file "config/routes.rb", "require \"sidekiq/web\"\n\n"
+  sidekiq_route = <<-RUBY
+    if Rails.env.local?
+      mount Sidekiq::Web => "/sidekiq"
+    end
+
+  RUBY
+
+  insert_into_file "config/routes.rb", sidekiq_route, after: "Rails.application.routes.draw do\n  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html\n"
+  route "devise_for :users"
+  route 'root to: "pages#show", id: "home"'
+  gsub_file "config/routes.rb", /  # Defines the root path route.*\n  # root "posts#index"\n/, ""
+end
+
+def add_rake_tasks
+  copy_file "lib/development/seeder.rb"
+  copy_file "lib/tasks/development.rake"
+end
+
+def add_test_suite
+  copy_file "test/controllers/devise/registrations_controller_test.rb"
+  copy_file "test/factories/memberships.rb"
+  copy_file "test/factories/organizations.rb"
+  copy_file "test/factories/users.rb"
+  copy_file "test/models/membership_test.rb"
+  copy_file "test/models/organization_test.rb"
+  copy_file "test/models/user_test.rb"
+  copy_file "test/system/authentication_stories_test.rb"
+
+  application_system_test_case = <<-RUBY
+
+    def sign_in_as(user)
+      visit new_user_session_path
+
+      fill_in "Email", with: user.email
+      fill_in "Password", with: user.password
+      click_button "Log in"
+
+      assert_text I18n.translate("devise.sessions.signed_in")
+    end
+  RUBY
+  insert_into_file "test/application_system_test_case.rb", application_system_test_case, before: "end\n"
+
+  test_helper_config = <<-RUBY
+      include Devise::Test::IntegrationHelpers
+      include Capybara::Email::DSL
+      include FactoryBot::Syntax::Methods
+
+      Capybara.configure do |config|
+        Rails.application.config.action_mailer.default_url_options => { host:, port: }
+
+        config.server = :puma, { Silent: true }
+        config.server_port = port
+        config.app_host = "http://\#{host}:\#{port}"
+      end
+
+  RUBY
+  insert_into_file "test/test_helper.rb", test_helper_config, after: "class TestCase\n"
+  insert_into_file "test/test_helper.rb", "require \"capybara/email\"\n", after: "require \"rails/test_help\"\n"
+end
+
+def configure_sass
+  gsub_file "package.json", /"build:css:compile": "sass \.\/app\/assets\/stylesheets\/application\.bootstrap\.scss:\.\/app\/assets\/builds\/application\.css --no-source-map --load-path=node_modules"/, '"build:css:compile": "sass ./app/assets/stylesheets/application.bootstrap.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules --silence-deprecation=import --silence-deprecation=global-builtin --silence-deprecation=color-functions"'
+end
+
+def run_migrations
+  rails_command "db:create"
+  rails_command "db:migrate"
+end
+
+def update_readme
+  remove_file "README.md"
+  copy_file "README.md"
+end
+
+def lint_codebase
+  run "bin/rubocop -a"
+end
+
+def print_message
+  say "*" * 50
+  say "Installation complete! 🎉"
+  say "*" * 50
+end

data/lib/templates/config/initializers/high_voltage.rb

@@ -0,0 +1,3 @@
+HighVoltage.configure do |config|
+  config.routes = false
+end

data/lib/templates/config/initializers/sidekiq.rb

@@ -0,0 +1,12 @@
+SIDEKIQ_REDIS_CONFIGURATION = {
+  url: ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), nil), # use REDIS_PROVIDER for Redis environment variable name, defaulting to REDIS_URL
+  ssl_params: {verify_mode: OpenSSL::SSL::VERIFY_NONE} # we must trust Heroku and AWS here
+}
+
+Sidekiq.configure_server do |config|
+  config.redis = SIDEKIQ_REDIS_CONFIGURATION
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = SIDEKIQ_REDIS_CONFIGURATION
+end

data/lib/templates/db/migrate/20251121192825_devise_create_users.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class DeviseCreateUsers < ActiveRecord::Migration[8.0]
+  def change
+    create_table :users do |t|
+      ## Database authenticatable
+      t.string :email, null: false, default: ""
+      t.string :encrypted_password, null: false, default: ""
+
+      ## Recoverable
+      t.string :reset_password_token
+      t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Trackable
+      t.integer :sign_in_count, default: 0, null: false
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string :current_sign_in_ip
+      t.string :last_sign_in_ip
+
+      ## Confirmable
+      t.string :confirmation_token
+      t.datetime :confirmed_at
+      t.datetime :confirmation_sent_at
+      t.string :unconfirmed_email # Only if using reconfirmable
+
+      t.timestamps null: false
+    end
+
+    add_index :users, :email, unique: true
+    add_index :users, :reset_password_token, unique: true
+    add_index :users, :confirmation_token, unique: true
+  end
+end

data/lib/templates/db/migrate/20251122141432_create_organizations.rb

@@ -0,0 +1,7 @@
+class CreateOrganizations < ActiveRecord::Migration[8.0]
+  def change
+    create_table :organizations do |t|
+      t.timestamps
+    end
+  end
+end

data/lib/templates/db/migrate/20251122141520_create_memberships.rb

@@ -0,0 +1,11 @@
+class CreateMemberships < ActiveRecord::Migration[8.0]
+  def change
+    create_table :memberships do |t|
+      t.belongs_to :user, null: false, foreign_key: true
+      t.belongs_to :organization, null: false, foreign_key: true
+      t.index [:user_id, :organization_id], unique: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/templates/lib/development/seeder.rb

@@ -0,0 +1,10 @@
+module Development
+  class Seeder
+    def self.load_seeds
+      new.load_seeds
+    end
+
+    def load_seeds
+    end
+  end
+end

data/lib/templates/lib/tasks/development.rake

@@ -0,0 +1,15 @@
+if Rails.env.local?
+  namespace :development do
+    namespace :db do
+      desc "Loads seed data for the local environment."
+      task seed: :environment do
+        Development::Seeder.load_seeds
+      end
+
+      namespace :seed do
+        desc "Truncate tables of each database for development and loads seed data."
+        task replant: ["environment", "db:truncate_all", "development:db:seed"]
+      end
+    end
+  end
+end

data/lib/templates/test/controllers/devise/registrations_controller_test.rb

@@ -0,0 +1,40 @@
+require "test_helper"
+
+module Devise
+  class RegistrationsController::CreateTest < ActionDispatch::IntegrationTest
+    test "creates initial organization on successful registration" do
+      attributes_for(:user) => {email:, password:}
+
+      assert_changes -> { User.count }, from: 0, to: 1 do
+        assert_changes -> { Organization.count }, from: 0, to: 1 do
+          post user_registration_path, params: {
+            user: {
+              email:,
+              password:,
+              password_confirmation: password
+            }
+          }
+        end
+      end
+
+      user = User.sole
+      organization = Organization.sole
+
+      assert_equal organization, user.organization
+    end
+
+    test "does not create initial organization on unsuccessful registration" do
+      assert_no_changes -> { User.count }, from: 0 do
+        assert_no_changes -> { Organization.count }, from: 0 do
+          post user_registration_path, params: {
+            user: {
+              email: "",
+              password: "",
+              password_confirmation: ""
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/templates/test/factories/memberships.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :membership do
+    user
+    organization
+  end
+end

data/lib/templates/test/factories/organizations.rb

@@ -0,0 +1,4 @@
+FactoryBot.define do
+  factory :organization do
+  end
+end

data/lib/templates/test/factories/users.rb

@@ -0,0 +1,12 @@
+FactoryBot.define do
+  sequence(:user_factory_email) { "person-#{_1}@example.com" }
+
+  factory :user do
+    sequence(:email) { "user-#{_1}@example.com" }
+    password { "s3kret" } # avoid 'password', since Chrome will render a security dialog
+
+    trait :confirmed do
+      confirmed_at { Time.current }
+    end
+  end
+end

data/lib/templates/test/models/membership_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+class Membership::DatabaseConstraintTest < ActiveSupport::TestCase
+  test "uniqueness constraint" do
+    membership = create(:membership)
+    user = membership.user
+    organization = membership.organization
+
+    assert_raises ActiveRecord::RecordNotUnique do
+      create(:membership, user:, organization:)
+    end
+  end
+end

data/lib/templates/test/models/organization_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+
+class Organization::DestroyTest < ActiveSupport::TestCase
+  test "raises" do
+    user = create(:user)
+
+    assert_raise ActiveRecord::DeleteRestrictionError do
+      user.organization.destroy
+    end
+  end
+
+  test "destroys" do
+    organization = create(:organization)
+
+    assert_changes -> { Organization.count }, from: 1, to: 0 do
+      organization.destroy
+    end
+  end
+end