rockstart 0.1.0 → 0.1.1

data/lib/generators/rockstart/frontend_app/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Installs common helpers for Frontend Apps
+
+Example:
+    rails generate rockstart:frontend_app
+
+    This will create:
+        Installs simple_form
+        Installs the titles gem
+        Adds a common helper for application urls

data/lib/generators/rockstart/frontend_app/application_urls/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Builds a helper for managing application urls
+
+Example:
+    rails generate rockstart:frontend_app:application_urls
+
+    This will create:
+        An Application Urls file containing editable links

data/lib/generators/rockstart/frontend_app/application_urls/application_urls_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Rockstart::FrontendApp
+  class ApplicationUrlsGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def add_application_urls_concern
+      copy_file "application_urls.rb", application_urls_concern_path
+      inject_into_file "app/controllers/application_controller.rb",
+                       "  include ApplicationUrls\n",
+                       before: /^end$/
+    end
+
+    def add_application_urls_helper
+      copy_file "application_urls_helper.rb", application_urls_helper_path
+    end
+
+    private
+
+    def application_urls_concern_path
+      File.join("app", "controllers", "concerns", "application_urls.rb")
+    end
+
+    def application_urls_helper_path
+      File.join("spec", "support", "application_urls_helper.rb")
+    end
+  end
+end

data/lib/generators/rockstart/frontend_app/assets/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Configures Rails for handling assets
+
+Example:
+    rails generate rockstart:frontend_app:assets
+
+    This will create:
+        adds a assets:rm_node_modules rake task for removing node modules

data/lib/generators/rockstart/frontend_app/assets/assets_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rockstart::FrontendApp
+  class AssetsGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def add_asset_rake_task
+      copy_file "assets.rake", "lib/tasks/assets.rake"
+    end
+  end
+end

data/lib/generators/rockstart/frontend_app/assets/templates/assets.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Adapted from https://github.com/heroku/heroku-buildpack-ruby/issues/792
+namespace :assets do
+  desc "Remove 'node_modules' folder"
+  task rm_node_modules: :environment do
+    Rails.logger.info "Removing node_modules folder"
+    FileUtils.remove_dir("node_modules", true)
+  end
+end
+
+skip_clean = %w[no false n f].include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_clean
+  if Rake::Task.task_defined?("assets:clean")
+    Rake::Task["assets:clean"].enhance do
+      Rake::Task["assets:rm_node_modules"].invoke
+    end
+  else
+    Rake::Task.define_task("assets:clean" => "assets:rm_node_modules")
+  end
+end

data/lib/generators/rockstart/frontend_app/frontend_app_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rockstart/base_generator"
+
+class Rockstart::FrontendAppGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :force_url_helpers, type: :boolean,
+                                   desc: "Force creation of blank Application URL Helpers",
+                                   default: false
+
+  def setup_assets
+    generate "rockstart:frontend_app:assets"
+  end
+
+  def add_simple_form
+    generate "rockstart:frontend_app:simple_form"
+  end
+
+  def install_titles
+    generate "rockstart:frontend_app:titles"
+  end
+
+  def add_application_urls
+    if !force_url_helpers? &&
+       File.exist?(Rails.root.join("app", "controllers", "concerns", "application_urls.rb"))
+      return # Don't override existing helpers
+    end
+
+    generate "rockstart:frontend_app:application_urls"
+  end
+
+  private
+
+  def force_url_helpers?
+    options.fetch(:force_url_helpers)
+  end
+end

data/lib/generators/rockstart/frontend_app/simple_form/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Setups up Simple Form for a Frontend App
+
+Example:
+    rails generate rockstart:frontend_app:simple_form
+
+    This will create:
+        Installs simple_form and overrides templates

data/lib/generators/rockstart/frontend_app/simple_form/simple_form_generator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rockstart::FrontendApp
+  class SimpleFormGenerator < Rails::Generators::Base
+    def install_simple_form
+      generate "simple_form:install", "--skip"
+    end
+  end
+end

data/lib/generators/rockstart/frontend_app/titles/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds a helper for adding titles to a Layout
+
+Example:
+    rails generate rockstart:frontend_app:titles
+
+    This will create:
+        Installs the titles gem

data/lib/generators/rockstart/frontend_app/titles/titles_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Rockstart::FrontendApp
+  class TitlesGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def add_titles_locale
+      template "titles.en.yml.tt", "config/locales/titles.en.yml"
+    end
+
+    def update_application_template
+      gsub_file "app/views/layouts/application.html.erb", %r{\<title(.+)\</title},
+                "<title><%= title %></title"
+    end
+
+    private
+
+    def default_title
+      Rails.application.class.to_s.split("::").first
+    end
+  end
+end

data/lib/generators/rockstart/gemset/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs all gems requested by rockstart
+
+Example:
+    rails generate rockstart:gemset
+
+    This will create:
+        All gems requested by rockstart generators

data/lib/generators/rockstart/gemset/gemset_generator.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/content_security_options"
+require "rockstart/generators/system_helpers"
+
+class Rockstart::GemsetGenerator < Rails::Generators::Base
+  include Rockstart::Generators::ClassOptionHelpers
+  include Rockstart::Generators::ContentSecurityOptions
+  include Rockstart::Generators::SystemHelpers
+
+  all_class_options
+
+  def install_gems
+    gem "namae"
+  end
+
+  def install_auth0_gems
+    return unless auth0?
+
+    gem "omniauth-auth0", "~> 2.2"
+    gem "omniauth-rails_csrf_protection", "~> 0.1"
+  end
+
+  def install_devise_gems
+    return unless devise?
+
+    gem "devise"
+  end
+
+  def install_memcached_gems
+    return unless memcached?
+
+    gem "dalli"
+    gem "connection_pool"
+  end
+
+  def install_postgres_gems
+    return unless postgres?
+
+    gem "zero_downtime_migrations"
+  end
+
+  def install_active_storage_gems
+    gem "aws-sdk-s3", require: false
+  end
+
+  def install_sidekiq_gems
+    return unless sidekiq?
+
+    gem "sidekiq"
+  end
+
+  def install_pundit_gems
+    return unless pundit?
+
+    gem "pundit"
+    gem "pundit-matchers", group: :test
+  end
+
+  def install_frontend_gems
+    return unless frontend?
+
+    gem "simple_form"
+    gem "title", github: "calebthompson/title"
+  end
+
+  def install_development_gems
+    gem "acts_as_list"
+    gem "audited", "~> 4.9"
+    gem "friendly_id"
+    gem "kaminari"
+  end
+
+  def install_lograge_gems
+    gem "lograge"
+    gem "logstash-event"
+  end
+
+  def install_rollbar_gems
+    return unless rollbar?
+
+    gem "rollbar", "~> 2.25.0"
+  end
+
+  def install_okcomputer_gems
+    gem "okcomputer"
+  end
+
+  def install_rubocop_gems
+    gem "rubocop-rails", require: false, group: %i[development test]
+  end
+
+  def install_security_gems
+    gem "brakeman", group: %i[development test]
+    gem "bundler-audit", github: "rubysec/bundler-audit", group: %i[development test]
+    gem "ip_anonymizer"
+    gem "rack-attack"
+  end
+
+  def install_testing_gems
+    gem "climate_control", group: :test
+    gem "webmock", group: :test
+    gem "vcr", group: :test
+  end
+
+  def install_rspec_gems
+    gem "capybara", ">= 2.15", group: :test
+    gem "dotenv-rails", groups: %i[development test]
+    gem "factory_bot_rails", group: %i[development test]
+    gem "faker", group: %i[development test]
+    gem "rspec-rails", "~> 4.0.0", group: %i[development test]
+    gem "shoulda-matchers", group: :test
+  end
+
+  def install_simplecov_gems
+    gem "simplecov", group: :test
+  end
+
+  def remove_unused_tzinfo
+    comment_lines "Gemfile", /gem ['"]tzinfo-data['"]/
+  end
+
+  def bundle_install
+    Bundler.with_clean_env do
+      system! "bundle install"
+    end
+  end
+end

data/lib/generators/rockstart/mailers/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Gets your Emails ready to Rock
+
+Example:
+    rails generate rockstart:mailers
+
+    This will create:
+        SMTP Mailers

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Rockstart::MailersGenerator < Rails::Generators::Base
+  def add_smtp_mailer
+    generate "rockstart:mailers:smtp_mailer"
+  end
+end

data/lib/generators/rockstart/mailers/smtp_mailer/smtp_mailer_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Mailers
+  class SmtpMailerGenerator < Rails::Generators::Base
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    def configure_test_environment
+      application(nil, env: :test) do
+        'config.action_mailer.default_url_options = { host: "www.example.com" }'
+      end
+    end
+
+    def configure_development_environment
+      application(nil, env: :development) do
+        'config.action_mailer.default_url_options = { host: "localhost", port: 3000 }'
+      end
+    end
+
+    def configure_production_environment
+      application(nil, env: :production) do
+        <<~MAILER
+          config.action_mailer.default_url_options = { host: ENV["APP_HOST"] }
+          config.action_mailer.delivery_method = :smtp
+        MAILER
+      end
+    end
+
+    def add_initializers
+      copy_initializer "action_mailer"
+    end
+  end
+end

data/lib/generators/rockstart/monitoring/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Keeps an eye on your App while it's Rocking
+
+Example:
+    rails generate rockstart:monitoring
+
+    This will create:
+        Format controller logs using Lograge

data/lib/generators/rockstart/{logging → monitoring/lograge}/USAGE

@@ -2,7 +2,7 @@ Description:
     Adds better logging to a rails application
 
 Example:
-    rails generate rockstart:logging
+    rails generate rockstart:monitoring:lograge
 
     This will create:
         - Adds and configures lograge

data/lib/generators/rockstart/monitoring/lograge/lograge_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Monitoring
+  class LogrageGenerator < Rails::Generators::Base
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    def add_lograge_util
+      copy_file "lograge_util.rb", "lib/lograge_util.rb"
+    end
+
+    def install_lograge
+      copy_initializer "lograge"
+    end
+  end
+end

data/lib/generators/rockstart/monitoring/lograge/templates/lograge_initializer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "lograge_util"
+
+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: IpAnonymizer.mask_ip(controller.request.remote_ip),
+      request_id: controller.request.request_id
+    }.tap do |payload|
+      if controller.respond_to?(:current_user)
+        payload[:user_id] = controller.current_user&.id || :guest
+      end
+    end
+  end
+end
+
+# rubocop:disable Layout/LineLength
+# Report for rack-attack throttle responses in lograge
+ActiveSupport::Notifications.subscribe("throttle.rack_attack") do |name, start, finish, request_id, payload|
+  logger = Lograge.logger.presence || Rails.logger
+  logger.warn LogrageUtil.format_rack_attack_throttle(name, start, finish, request_id, payload)
+end
+
+# Report for rack-attack blocklist responses in lograge
+ActiveSupport::Notifications.subscribe("blocklist.rack_attack") do |name, start, finish, request_id, payload|
+  logger = Lograge.logger.presence || Rails.logger
+  logger.warn LogrageUtil.format_rack_attack_blocklist(name, start, finish, request_id, payload)
+end
+# rubocop:enable Layout/LineLength