rockstart 0.1.0 → 0.1.1

data/lib/generators/rockstart/storage/active_storage/templates/active_storage_initializer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "utils/cloudcube"
+
+Rails.application.configure do
+  # Set active_storage background queues to low priority
+  config.active_storage.queues.analysis = :low
+  config.active_storage.queues.purge = :low
+end

data/lib/generators/rockstart/storage/active_storage/templates/better_s3_service.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "aws-sdk-s3"
+require "active_storage/service/s3_service"
+require "active_support/core_ext/numeric/bytes"
+
+# rubocop:disable Style/ClassAndModuleChildren
+module ActiveStorage
+  # Adds handling of path-prefixes to S3
+  # Adapted from: https://github.com/rails/rails/issues/32790
+  class Service::BetterS3Service < Service::S3Service
+    attr_reader :client, :bucket, :root, :upload_options
+
+    def initialize(bucket:, upload: {}, **options)
+      @root = options.delete(:root)
+      super(bucket: bucket, upload: upload, **options)
+    end
+
+    private
+
+    def object_for(key)
+      path = root.present? ? File.join(root, key) : key
+      bucket.object(path)
+    end
+  end
+end
+# rubocop:enable Style/ClassAndModuleChildren

data/lib/generators/rockstart/storage/active_storage/templates/cloudcube_util.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
+
+module Utils
+  # Utilities for working with Cloudcube
+  module Cloudcube
+    REGION_LOOKUP = {
+      "cloud-cube" =>	"us-east-1",
+      "cloud-cube-eu"	=> "eu-west-1",
+      "cloud-cube-jp" =>	"ap-northeast-1"
+    }.freeze
+
+    def self.region(cloudcube_url)
+      REGION_LOOKUP.fetch bucket(cloudcube_url) if cloudcube_url.present?
+    end
+
+    def self.bucket(cloudcube_url)
+      URI.parse(cloudcube_url).host.split(".").first if cloudcube_url.present?
+    end
+
+    def self.public_prefix(cloudcube_url)
+      prefix(cloudcube_url) + "/public" if cloudcube_url.present?
+    end
+
+    def self.prefix(cloudcube_url)
+      URI.parse(cloudcube_url).path[1..-1] if cloudcube_url.present?
+    end
+  end
+end

data/lib/generators/rockstart/storage/active_storage/templates/cloudcube_util_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "utils/cloudcube"
+
+RSpec.describe Utils::Cloudcube do
+  describe ".bucket" do
+    it "handles US regions" do
+      bucket = described_class.bucket "https://cloud-cube.s3.amazonaws.com/mycube"
+      expect(bucket).to eq "cloud-cube"
+    end
+
+    it "handles EU regions" do
+      bucket = described_class.bucket "https://cloud-cube-eu.s3.amazonaws.com/mycube"
+      expect(bucket).to eq "cloud-cube-eu"
+    end
+
+    it "handles JP regions" do
+      bucket = described_class.bucket "https://cloud-cube-jp.s3.amazonaws.com/mycube"
+      expect(bucket).to eq "cloud-cube-jp"
+    end
+
+    it "handles nil" do
+      bucket = described_class.bucket nil
+      expect(bucket).to be_nil
+    end
+  end
+
+  describe ".region" do
+    it "handles US regions" do
+      region = described_class.region "https://cloud-cube.s3.amazonaws.com/mycube"
+      expect(region).to eq "us-east-1"
+    end
+
+    it "handles EU regions" do
+      region = described_class.region "https://cloud-cube-eu.s3.amazonaws.com/mycube"
+      expect(region).to eq "eu-west-1"
+    end
+
+    it "handles JP regions" do
+      region = described_class.region "https://cloud-cube-jp.s3.amazonaws.com/mycube"
+      expect(region).to eq "ap-northeast-1"
+    end
+
+    it "handles nil" do
+      region = described_class.region nil
+      expect(region).to be_nil
+    end
+  end
+
+  describe ".public_prefix" do
+    it "handles US regions" do
+      public_prefix = described_class.public_prefix "https://cloud-cube.s3.amazonaws.com/mycube"
+      expect(public_prefix).to eq "mycube/public"
+    end
+
+    it "handles nil" do
+      public_prefix = described_class.public_prefix nil
+      expect(public_prefix).to be_nil
+    end
+  end
+
+  describe ".prefix" do
+    it "handles US regions" do
+      prefix = described_class.prefix "https://cloud-cube.s3.amazonaws.com/mycube"
+      expect(prefix).to eq "mycube"
+    end
+
+    it "handles nil" do
+      prefix = described_class.prefix nil
+      expect(prefix).to be_nil
+    end
+  end
+end

data/lib/generators/rockstart/storage/active_storage/templates/storage.yml.tt

@@ -0,0 +1,15 @@
+test:
+  service: Disk
+  root: <%%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%%= Rails.root.join("storage") %>
+
+cloudcube:
+  service: BetterS3
+  access_key_id: <%%= ENV["CLOUDCUBE_ACCESS_KEY_ID"] %>
+  secret_access_key: <%%= ENV["CLOUDCUBE_SECRET_ACCESS_KEY"] %>
+  region: <%%= Utils::Cloudcube.region ENV["CLOUDCUBE_URL"] %>
+  bucket: <%%= Utils::Cloudcube.bucket ENV["CLOUDCUBE_URL"] %>
+  root: <%%= Utils::Cloudcube.<%= public_files? ? "public_" : "" %>prefix ENV["CLOUDCUBE_URL"] %>

data/lib/generators/rockstart/storage/memcached/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Uses Memcached as a Rails cache
+
+Example:
+    rails generate rockstart:storage:memcached
+
+    This will create:
+        Configures memcached as the default Rails.cache

data/lib/generators/rockstart/storage/memcached/memcached_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Rockstart::Storage
+  class MemcachedGenerator < Rails::Generators::Base
+    # rubocop:disable Metrics/MethodLength
+    def configure_production_env
+      application(nil, env: :production) do
+        <<~MEMCACHED
+          # Use Memcached for Rails cache store
+          memcache_servers = ENV.fetch("MEMCACHE_SERVERS") { ENV.fetch("MEMCACHIER_SERVERS", "") }
+          config.cache_store = :mem_cache_store,
+                               memcache_servers.split(","),
+                               {
+                                 username: ENV["MEMCACHIER_USERNAME"],
+                                 password: ENV["MEMCACHIER_PASSWORD"],
+                                 failover: true,
+                                 socket_timeout: 1.5,
+                                 socket_failure_delay: 0.2,
+                                 down_retry_delay: 60,
+                                 pool_size: ENV.fetch("RAILS_MAX_THREADS") { 5 }
+                               }
+        MEMCACHED
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end

data/lib/generators/rockstart/{postgres → storage/postgres}/USAGE

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/migration_helpers"
+
+module Rockstart::Storage
+  class PostgresGenerator < Rails::Generators::Base
+    include Rails::Generators::AppName
+    include Rockstart::Generators::MigrationHelpers
+
+    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
+  end
+end

data/lib/generators/rockstart/{postgres → storage/postgres}/templates/config/database.yml.tt

@@ -4,6 +4,12 @@ default: &default
   # For details on connection pooling, see Rails configuration guide
   # https://guides.rubyonrails.org/configuring.html#database-pooling
   pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  connect_timeout: <%%= ENV.fetch("DB_CONNECT_TIMEOUT") { 2 } %>
+  checkout_timeout: <%%= ENV.fetch("DB_CHECKOUT_TIMEOUT") { 5 } %>
+  variables:
+    # Prevent single queries from taking up all of your database’s resources
+    # https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts#postgresql
+    statement_timeout: <%%= ENV.fetch("DB_STATEMENT_TIMEOUT") { "5s" } %>
 
 development:
   <<: *default

data/lib/generators/rockstart/storage/storage_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+class Rockstart::StorageGenerator < Rails::Generators::Base
+  include Rockstart::Generators::ClassOptionHelpers
+
+  postgres_class_option
+  memcached_class_option
+
+  def generate_postgres
+    return unless postgres?
+
+    generate "rockstart:storage:postgres"
+  end
+
+  def generate_memcached
+    return unless memcached?
+
+    generate "rockstart:storage:memcached"
+  end
+
+  def generate_active_storage
+    generate "rockstart:storage:active_storage"
+  end
+end

data/lib/generators/rockstart/testing/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Prepare your app for some testing before your Rock
+
+Example:
+    rails generate rockstart:testing
+
+    This will create:
+        Installs RSpec
+        Sets up SimpleCov for code quality coverage

data/lib/generators/rockstart/testing/env/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates useful dotfiles for testing
+
+Example:
+    rails generate rockstart:testing:env
+
+    This will create:
+        Creates a dotfile with common configuration values

data/lib/generators/rockstart/testing/env/env_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Testing
+  class EnvGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    devise_class_option
+    auth0_class_option
+
+    def add_dotenv_files
+      template "dotenv.test.tt", ".env.test"
+    end
+
+    def add_climate_control_helpers
+      copy_spec_support "climate_control_helpers"
+    end
+  end
+end

data/lib/generators/rockstart/testing/env/templates/climate_control_helpers_support.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "climate_control"
+
+# Helpers for managing ENV configuration within a Test Suite
+module ClimateControlHelpers
+  def with_modified_env(options, &block)
+    ClimateControl.modify(options, &block)
+  end
+end
+
+RSpec.configure do |config|
+  config.include ClimateControlHelpers
+end

data/lib/generators/rockstart/testing/env/templates/dotenv.test.tt

@@ -0,0 +1,8 @@
+APP_HOST=www.example.com
+<%- if devise? -%>
+DEVISE_MAILER_SENDER=devise-mailer@example.com
+<%- elsif auth0? -%>
+AUTH0_CLIENT_ID="auth0-client-id"
+AUTH0_CLIENT_SECRET="auth0-client-secret"
+AUTH0_DOMAIN="auth0-domain"
+<%- end -%>

data/lib/generators/rockstart/{rspec → testing/rspec}/USAGE

@@ -2,7 +2,7 @@ Description:
     Installs RSpec with test libraries
 
 Example:
-    rails generate rockstart:rspec
+    rails generate rockstart:testing:rspec
 
     This will create:
         - installs rspec-rails

data/lib/generators/rockstart/testing/rspec/rspec_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "rockstart/base_generator"
+
+module Rockstart::Testing
+  class RspecGenerator < Rockstart::BaseGenerator
+    source_root File.expand_path("templates", __dir__)
+
+    def install_rspec_rails
+      Dir.mktmpdir do |dir|
+        generate_rspec_install(dir)
+        template File.join(dir, ".rspec"), ".rspec"
+        directory File.join(dir, "spec"), "spec"
+      end
+    end
+
+    def add_rspec_support
+      directory "support", "spec/support"
+    end
+
+    private
+
+    def generate_rspec_install(dir)
+      require "generators/rspec/install/install_generator"
+
+      initializer = ::Rspec::Generators::InstallGenerator.new(
+        report_stream: StringIO.new
+      )
+      initializer.destination_root = dir
+      initializer.invoke_all
+
+      prepend_simplecov_start(dir)
+      enable_support_directory(dir)
+    end
+
+    def prepend_simplecov_start(dir)
+      prepend_file File.join(dir, "spec", "spec_helper.rb"), <<~SIMPLECOV
+        # frozen_string_literal: true
+
+        require "simplecov"
+        SimpleCov.start("rails") do
+          add_filter "/lib/templates"
+        end
+
+      SIMPLECOV
+    end
+
+    def enable_support_directory(dir)
+      uncomment_lines File.join(dir, "spec", "rails_helper.rb"), /Dir.+spec.+support.+\.rb/
+    end
+  end
+end

data/lib/generators/rockstart/testing/rspec/templates/support/vcr.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "vcr"
+
+VCR.configure do |c|
+  # Use rspec tags for vcr cassettes
+  c.configure_rspec_metadata!
+
+  c.cassette_library_dir = "spec/vcr"
+  c.hook_into :webmock
+end

data/lib/generators/rockstart/testing/simplecov/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Installs SimpleCov for coverage metrics
+
+Example:
+    rails generate rockstart:testing:simple_cov
+
+    This will create:
+        Installs simple_cov
+        Updates rspec to require it first

data/lib/generators/rockstart/testing/simplecov/simplecov_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rockstart::Testing
+  class SimplecovGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def add_coverage_to_gitignore
+      append_file ".gitignore", "coverage/\n"
+    end
+  end
+end