rockstart 0.1.0

data/lib/generators/rockstart/frontend_helpers/templates/titles.en.yml.tt

@@ -0,0 +1,5 @@
+en:
+  titles:
+    # titles.application defaults to the sigficant portion of
+    # <%= Rails.application.class.name %>, which would be:
+    application: <%= default_title %>

data/lib/generators/rockstart/logging/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds better logging to a rails application
+
+Example:
+    rails generate rockstart:logging
+
+    This will create:
+        - Adds and configures lograge

data/lib/generators/rockstart/logging/logging_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Rockstart::LoggingGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def install_lograge
+    gem "lograge"
+    gem "logstash-event"
+
+    copy_file "rockstart/lograge_initializer.rb", "config/initializers/lograge.rb"
+  end
+end

data/lib/generators/rockstart/logging/templates/rockstart/lograge_initializer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  config.lograge.enabled = true
+  config.lograge.formatter = Lograge::Formatters::Logstash.new
+
+  # Update if using Rails in API mode
+  # config.lograge.base_controller_class = ['ActionController::API', 'ActionController::Base']
+
+  config.lograge.custom_options = lambda do |event|
+    exceptions = %w[controller action format id]
+    {
+      params: event.payload[:params].except(*exceptions)
+    }
+  end
+
+  config.lograge.custom_payload do |controller|
+    {
+      host: controller.request.host,
+      remote_ip: controller.request.remote_ip,
+      request_id: controller.request.request_id,
+      user_id: (controller.respond_to?(:current_user) && controller.current_user.try(:id)) || :guest
+    }
+  end
+end
+
+# Report for rack_attack throttle responses in lograge
+ActiveSupport::Notifications.subscribe("throttle.rack_attack") do |_name, start, finish, request_id, payload|
+  req = payload[:request]
+
+  filter_parameters = Rails.application.config.filter_parameters
+  params = ActiveSupport::ParameterFilter.new(filter_parameters).filter(req.params)
+
+  message_payload = {
+    method: req.request_method,
+    path: req.path,
+    format: params[:format] || "html",
+    controller: Rack::Attack.name,
+    action: "throttle",
+    status: 429,
+    duration: (finish - start).to_f.round(2),
+    params: params.except("controller", "action", "format", "id"),
+    host: req.host,
+    remote_ip: req.ip,
+    request_id: request_id
+  }
+  formatted_message = Lograge.lograge_config.formatter.call(message_payload)
+  logger = Lograge.logger.presence || Rails.logger
+  logger.public_send(Lograge.log_level, formatted_message)
+end

data/lib/generators/rockstart/postgres/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Configures a rails application to use postgres in Heroku and Docker
+
+Example:
+    rails generate rockstart:postgres
+
+    This will create:
+        A config/database.yml with known defaults

data/lib/generators/rockstart/postgres/postgres_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Rockstart::PostgresGenerator < Rails::Generators::Base
+  include Rails::Generators::AppName
+  include Rails::Generators::Migration
+
+  # Implement the required interface for Rails::Generators::Migration.
+  def self.next_migration_number(dirname)
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_database_config
+    template "config/database.yml.tt", "config/database.yml"
+  end
+
+  def enable_uuid_support
+    migration_template "migration.rb.tt", "db/migrate/enable_uuid.rb"
+  end
+
+  private
+
+  def rails5_and_up?
+    Rails::VERSION::MAJOR >= 5
+  end
+
+  def migration_version
+    "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5_and_up?
+  end
+end

data/lib/generators/rockstart/postgres/templates/config/database.yml.tt

@@ -0,0 +1,18 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # https://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+development:
+  <<: *default
+  database: <%= app_name %>_development
+
+test:
+  <<: *default
+  url: <%%= ENV.fetch('TEST_DATABASE_URL', "postgres://localhost/<%= app_name %>_test") %>
+
+production:
+  <<: *default
+  url: <%%= ENV['DATABASE_URL'] %>

data/lib/generators/rockstart/postgres/templates/migration.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class EnableUuid < ActiveRecord::Migration<%= migration_version %>
+  def change
+    enable_extension "pgcrypto"
+  end
+end

data/lib/generators/rockstart/pundit/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds authentication to a project with simple authentication needs
+
+Example:
+    rails generate rockstart:pundit
+
+    This will create:
+        Installs pundit gem

data/lib/generators/rockstart/pundit/pundit_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Rockstart::PunditGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def install_pundit
+    gem "pundit"
+    gem "pundit-matchers", group: :test
+
+    Bundler.clean_system("bundle install --quiet")
+  end
+
+  def add_pundit_exception_handling
+    application <<~PUNDIT
+      # Treat Pundit authentication failures as forbidden
+      config.action_dispatch.rescue_responses["Pundit::NotAuthorizedError"] = :forbidden
+    PUNDIT
+  end
+
+  def add_pundit_to_application_controller
+    inject_into_file "app/controllers/application_controller.rb",
+                     "  include Pundit\n",
+                     before: /^end$/
+  end
+
+  def add_pundit_overrides_and_helpers
+    directory "app"
+    directory "config"
+    directory "lib"
+    directory "spec"
+  end
+end

data/lib/generators/rockstart/pundit/templates/app/controllers/concerns/pundit_error_handling.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Handling for any Pundit-thrown errors
+module PunditErrorHandling
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
+  end
+
+  protected
+
+  # redirect path for failed authentication attempts
+  def authentication_failed_redirect_path_for(_resource)
+    after_sign_in_path_for(current_user)
+  end
+
+  private
+
+  def user_not_authorized(exception)
+    policy_name = exception.policy.class.to_s.underscore
+
+    # e.g. I18n.t("pundit.example_policy.show?")
+    flash[:error] = t "#{policy_name}.#{exception.query}", scope: "pundit", default: :default
+
+    # redirect to the either the previous page or the default sign in page
+    redirect_to authentication_failed_redirect_path_for(exception.record)
+  end
+end

data/lib/generators/rockstart/pundit/templates/app/policies/application_policy.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Default application policy generated by rockstart
+class ApplicationPolicy
+  attr_reader :user, :record
+
+  def initialize(user, record)
+    @user = user || User.new
+    @record = record
+  end
+
+  # Abilities
+
+  def index?
+    false
+  end
+
+  def show?
+    false
+  end
+
+  def create?
+    false
+  end
+
+  def new?
+    create?
+  end
+
+  def update?
+    false
+  end
+
+  def edit?
+    update?
+  end
+
+  def destroy?
+    false
+  end
+
+  # Attributes
+
+  def permitted_attributes
+    []
+  end
+
+  def permitted_attributes_for_create
+    permitted_attributes
+  end
+
+  def permitted_attributes_for_update
+    permitted_attributes
+  end
+
+  # Scopes
+
+  # Scope filter used to limit access to resources
+  class Scope
+    attr_reader :user, :scope
+
+    def initialize(user, scope)
+      @user = user || User.new
+      @scope = scope
+    end
+
+    def resolve
+      scope.none
+    end
+  end
+end

data/lib/generators/rockstart/pundit/templates/app/policies/user_policy.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Policy for updating profiles, provided by rockstart
+class UserPolicy < ApplicationPolicy
+  # def index?
+  #   false
+  # end
+
+  # def show?
+  #   false
+  # end
+
+  # def create?
+  #   false
+  # end
+
+  def update?
+    current_user?
+  end
+
+  def destroy?
+    # Prevent admins from destroying themselves
+    current_user? && !record.admin?
+  end
+
+  def permitted_attributes
+    if current_user?
+      # Allow a user to update their own details
+      %i[name]
+    else
+      []
+    end
+  end
+
+  private
+
+  def current_user?
+    user.persisted? && user.id == record.id
+  end
+
+  # Safe scope for User
+  class Scope < Scope
+    def resolve
+      user.persisted? ? scope.where(id: user.id) : scope.none
+    end
+  end
+end

data/lib/generators/rockstart/pundit/templates/config/locales/pundit.en.yml

@@ -0,0 +1,6 @@
+en:
+  pundit:
+    default: 'You cannot perform this action.'
+    # example_policy:
+    #   update?: 'You cannot edit this Example!'
+    #   create?: 'You cannot create Examples!'

data/lib/generators/rockstart/pundit/templates/lib/templates/pundit/policy/policy.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %>Policy < ApplicationPolicy
+  def index?
+    user.persisted?
+  end
+
+  def show?
+    user.persisted?
+  end
+
+  def create?
+    user.admin?
+  end
+
+  def update?
+    user.admin?
+  end
+
+  def destroy?
+    user.admin?
+  end
+
+  def permitted_attributes
+    super
+  end
+
+  # Safe scope for <%= class_name %>
+  class Scope < Scope
+    def resolve
+      user.persisted? ? scope.all : scope.none
+    end
+  end
+end
+<% end -%>

data/lib/generators/rockstart/pundit/templates/lib/templates/rspec/policy/policy_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe <%= class_name %>Policy, type: :policy do
+  subject { described_class.new(user, <%= file_name %>_record) }
+
+  let(:resolved_scope) { described_class::Scope.new(user, <%= class_name %>.all).resolve }
+
+  let(:<%= file_name %>_record) { <%= class_name %>.new }
+
+  context "with a guest" do
+    let(:user) { nil }
+
+    it { is_expected.to forbid_action(:index) }
+    it { is_expected.to forbid_action(:show) }
+    it { is_expected.to forbid_actions(%i[new create]) }
+    it { is_expected.to forbid_actions(%i[edit update]) }
+    it { is_expected.to forbid_action(:destroy) }
+
+    it "returns no items in scope" do
+      expect(resolved_scope.to_sql).to eq(<%= class_name %>.none.to_sql)
+    end
+  end
+
+  context "with a user" do
+    let(:user) { build_stubbed(:user) }
+
+    it { is_expected.to permit_action(:index) }
+    it { is_expected.to permit_action(:show) }
+    it { is_expected.to forbid_actions(%i[new create]) }
+    it { is_expected.to forbid_actions(%i[edit update]) }
+    it { is_expected.to forbid_action(:destroy) }
+
+    it "returns all items in scope" do
+      expect(resolved_scope.to_sql).to eq(<%= class_name %>.all.to_sql)
+    end
+  end
+
+  context "with an admin" do
+    let(:user) { build_stubbed(:user, :admin) }
+
+    it { is_expected.to permit_action(:index) }
+    it { is_expected.to permit_action(:show) }
+    it { is_expected.to permit_actions(%i[new create]) }
+    it { is_expected.to permit_actions(%i[edit update]) }
+    it { is_expected.to permit_action(:destroy) }
+
+    # it { is_expected.to permit_mass_assignment_of(:name).for_action(:create) }
+
+    # it { is_expected.to permit_mass_assignment_of(:name).for_action(:update) }
+    # it { is_expected.to forbid_mass_assignment_of(:birthdate).for_action(:update) }
+
+    it "returns all items in scope" do
+      expect(resolved_scope.to_sql).to eq(<%= class_name %>.all.to_sql)
+    end
+  end
+end

data/lib/generators/rockstart/pundit/templates/spec/policies/user_policy_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe UserPolicy, type: :policy do
+  subject { described_class.new(user, user_record) }
+
+  let(:resolved_scope) { described_class::Scope.new(user, User.all).resolve }
+
+  let(:user_record) do
+    build_stubbed(:user).tap do |record|
+      allow(record).to receive(:id).and_return(123)
+    end
+  end
+
+  context "with a guest" do
+    let(:user) { nil }
+
+    it { is_expected.to forbid_action(:index) }
+    it { is_expected.to forbid_action(:show) }
+    it { is_expected.to forbid_actions(%i[new create]) }
+    it { is_expected.to forbid_actions(%i[edit update]) }
+    it { is_expected.to forbid_action(:destroy) }
+
+    it "returns no items in scope" do
+      expect(resolved_scope.to_sql).to eq(User.none.to_sql)
+    end
+  end
+
+  context "with the same user" do
+    let(:user) { user_record }
+
+    it { is_expected.to permit_actions(%i[edit update]) }
+    it { is_expected.to permit_action(:destroy) }
+
+    it { is_expected.to forbid_action(:index) }
+    it { is_expected.to forbid_action(:show) }
+    it { is_expected.to forbid_actions(%i[new create]) }
+
+    it { is_expected.to permit_mass_assignment_of(:name).for_action(:update) }
+
+    it "returns the a scope with only the user" do
+      expect(resolved_scope.to_sql).to eq(User.where(id: user.id).to_sql)
+    end
+
+    context "when the user is an admin" do
+      before do
+        user.admin = true
+      end
+
+      it { is_expected.to permit_actions(%i[edit update]) }
+
+      it { is_expected.to forbid_action(:index) }
+      it { is_expected.to forbid_action(:show) }
+      it { is_expected.to forbid_actions(%i[new create]) }
+      it { is_expected.to forbid_action(:destroy) }
+
+      it { is_expected.to permit_mass_assignment_of(:name).for_action(:update) }
+
+      it "returns the a scope with only the user" do
+        expect(resolved_scope.to_sql).to eq(User.where(id: user.id).to_sql)
+      end
+    end
+  end
+
+  context "with a different user" do
+    let(:user) do
+      build_stubbed(:user).tap do |user|
+        allow(user).to receive(:id).and_return(987)
+      end
+    end
+
+    it { is_expected.to forbid_action(:index) }
+    it { is_expected.to forbid_action(:show) }
+    it { is_expected.to forbid_actions(%i[new create]) }
+    it { is_expected.to forbid_actions(%i[edit update]) }
+    it { is_expected.to forbid_action(:destroy) }
+
+    it { is_expected.to forbid_mass_assignment_of(:name).for_action(:update) }
+
+    context "when the user is an admin" do
+      before do
+        user.admin = true
+      end
+
+      it { is_expected.to forbid_action(:index) }
+      it { is_expected.to forbid_action(:show) }
+      it { is_expected.to forbid_actions(%i[new create]) }
+      it { is_expected.to forbid_actions(%i[edit update]) }
+      it { is_expected.to forbid_action(:destroy) }
+
+      it { is_expected.to forbid_mass_assignment_of(:name).for_action(:update) }
+    end
+  end
+end

data/lib/generators/rockstart/pundit/templates/spec/support/pundit_matchers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "pundit/matchers"
+
+Pundit::Matchers.configure do |config|
+  config.user_alias = :user
+end

data/lib/generators/rockstart/quality/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Adds code quality tools to a Rails project.
+
+Example:
+    rails generate quality
+
+    This will create:
+        .rubocop.yml # with common default values
+        .rubocop_todo.yml # a todo-list of all outstanding issues
+        lib/tasks/quality.rake # A Rake task for running code quality tools

data/lib/generators/rockstart/quality/quality_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Rockstart::QualityGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  desc "This generator configures code quality rules"
+
+  class_option :rebuild_todo, type: :boolean,
+                              desc: "Bundle installs rubocop and regenerates .rubocop_todo.yml",
+                              default: true
+
+  def add_quality_rake_task
+    copy_file "quality.rake", "lib/tasks/quality.rake"
+  end
+
+  def install_rubocop
+    copy_file "rubocop.yml", ".rubocop.yml"
+
+    gem "rubocop-rails", require: false
+
+    copy_file "rubocop.rake", "lib/tasks/rubocop.rake"
+
+    return unless options[:rebuild_todo]
+
+    # Rebuild .rubocop_todo.yml, ensuring only existing code is excluded
+    run "bundle install --quiet && bundle exec rubocop --auto-gen-config --exclude-limit 100"
+  end
+end

data/lib/generators/rockstart/quality/templates/quality.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc "Run all code quality tools"
+task quality: ["rubocop"]

data/lib/generators/rockstart/quality/templates/rubocop.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new

data/lib/generators/rockstart/quality/templates/rubocop.yml

@@ -0,0 +1,45 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    # Exclude auto-generated files
+    - bin/*
+    - db/schema.rb
+    - db/seeds.rb
+    - lib/templates/**/*
+    - node_modules/**/*
+
+Layout/LineLength:
+  Max: 100 # Set line width to more sensible default
+  Exclude:
+    - config/environments/*
+    - config/initializers/*
+    - db/migrate/*
+    - spec/**/*
+    - test/**/*
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes # prefer double quotes
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true # immutable code where possible
+
+Style/HashEachMethods:
+  Enabled: false # Skip unsafe rules
+
+Style/HashTransformKeys:
+  Enabled: false # Skip unsafe rules
+
+Style/HashTransformValues:
+  Enabled: false # Skip unsafe rules