rockstart 0.1.0 → 0.1.1

data/lib/generators/rockstart/deployment/templates/hooks-release.tt

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# hooks-release script generated by rockstart:deployment
+# Run this script during each code release
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  puts "== Migrating Database =="
+  system! "DB_STATEMENT_TIMEOUT=90s bundle exec rake db:migrate"
+end

data/lib/generators/rockstart/deployment/templates/rack_deflater_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "Rack::Deflater", type: :request do
+  describe "gzip compression" do
+    let(:authenticated_user) { create(:user) }
+
+    before do
+      sign_in authenticated_user
+    end
+
+    it "supports gzip compression", :aggregate_failures do
+      ["gzip", "deflate,gzip", "gzip,deflate"].each do |compression_method|
+        get url_for_user_dashboard, headers: { "HTTP_ACCEPT_ENCODING" => compression_method }
+        expect(response.headers["Content-Encoding"]).to eq "gzip"
+        expect(read_gzip_body(response.body)).to be_present
+      end
+    end
+  end
+
+  def read_gzip_body(response_body)
+    require "zlib"
+    require "stringio"
+    gz = Zlib::GzipReader.new(StringIO.new(response_body.to_s))
+    gz.read
+  end
+end

data/lib/generators/rockstart/deployment/templates/web.tt

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec puma -C config/puma.rb

data/lib/generators/rockstart/deployment/templates/worker.tt

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+MALLOC_ARENA_MAX=2 bundle exec sidekiq -t 25

data/lib/generators/rockstart/development/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Runs all rockstart generators used for development
+
+Example:
+    rails generate rockstart:development
+
+    This will generate:
+        Convenient dotfiles for development
+        Useful Rails generator template overrides
+        Setup scripts for using SSL for localhost servers

data/lib/generators/rockstart/development/audited/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Configures Audited gem for history tracking
+
+Example:
+    rails generate rockstart:development:audited
+
+    This will create:
+        Installs the audited gem
+        Updates foreign keys to work for Users with polymorphic uuid
+        Configures it to function without a User model (Auth0)

data/lib/generators/rockstart/development/audited/audited_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/migration_helpers"
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Development
+  class AuditedGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+    include Rockstart::Generators::MigrationHelpers
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    auth0_class_option
+    postgres_class_option
+
+    def add_custom_audit_model
+      template "audit.rb", "app/models/audit.rb"
+      template "audit_spec.rb", "spec/models/audit_spec.rb"
+    end
+
+    def add_initializer
+      copy_initializer "audited"
+    end
+
+    def add_migrations
+      migration_template "install_audited.rb", "db/migrate/install_audited.rb"
+    end
+
+    def add_spec_support
+      copy_spec_support "audited"
+    end
+  end
+end

data/lib/generators/rockstart/development/audited/templates/audit.rb.tt

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Custom Audit model provided by rockstart
+class Audit < Audited::Audit
+  # Anonymize IP Addresses
+  def remote_address=(unsafe_address)
+    addr = unsafe_address.presence && IPAddr.new(unsafe_address)
+    if addr&.ipv4?
+      # set last octet to 0
+      super addr.mask(24).to_s
+    elsif addr&.ipv6?
+      # set last 80 bits to zeros
+      super addr.mask(48).to_s
+    else
+      super nil
+    end
+  end
+<% if auth0? -%>
+
+  def user=(user)
+    if user.is_a?(::User)
+      # Handle PORO User Object for Auth0
+      self.user_uid = user.id
+      super nil
+    else
+      self.user_uid = nil
+      super
+    end
+  end
+
+  def user
+    super || user_uid
+  end
+<% end -%>
+end

data/lib/generators/rockstart/development/audited/templates/audit_spec.rb.tt

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Audit, type: :model do
+  describe "#remote_address" do
+    it "anonymizes IPv4 Address" do
+      audit = Audit.new
+      audit.remote_address = "37.109.235.190"
+      expect(audit.remote_address).to eq "37.109.235.0"
+    end
+
+    it "anonymizes IPv6 Address" do
+      audit = Audit.new
+      audit.remote_address = "c988:1d1:96e:67ca:31bd:b29e:5ff1:c8fb"
+      expect(audit.remote_address).to eq "c988:1d1:96e::"
+    end
+
+    it "handles nil values" do
+      audit = Audit.new
+      audit.remote_address = nil
+      expect(audit.remote_address).to be_nil
+    end
+  end
+<% if auth0? -%>
+
+  describe "#user" do
+    it "handles a User model" do
+      user = build(:user)
+      audit = Audit.new
+      audit.user = user
+      expect(audit.user).to eq user.id
+      expect(audit.user_uid).to eq user.id
+      expect(audit.username).to be_nil
+    end
+
+    it "handles a String" do
+      audit = Audit.new
+      audit.user = "test-user"
+      expect(audit.user).to eq "test-user"
+      expect(audit.user_uid).to be_nil
+      expect(audit.username).to eq "test-user"
+    end
+
+    it "handles nil values" do
+      audit = Audit.new
+      audit.user = nil
+      expect(audit.user).to be_nil
+      expect(audit.user_uid).to be_nil
+      expect(audit.username).to be_nil
+    end
+  end
+<% end -%>
+end

data/lib/generators/rockstart/development/audited/templates/audited_initializer.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.config.after_initialize do
+  Audited.audit_class = ::Audit
+end

data/lib/generators/rockstart/development/audited/templates/audited_support.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "audited-rspec"

data/lib/generators/rockstart/development/audited/templates/install_audited.rb.tt

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class InstallAudited < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :audits, force: true do |t|
+      t.column :auditable_id, :integer
+      t.column :auditable_type, :string
+      t.column :associated_id, :integer
+      t.column :associated_type, :string
+<% if auth0? -%>
+      t.column :user_uid, :string
+<% end -%>
+<% if postgres? -%>
+      t.column :user_id, :uuid
+      t.column :user_type, :string
+<% else -%>
+      t.column :user_id, :index
+      t.column :user_type, :string
+<% end -%>
+      t.column :username, :string
+      t.column :action, :string
+<% if postgres? -%>
+      t.column :audited_changes, :jsonb
+<% else -%>
+      t.column :audited_changes, :text
+<% end -%>
+      t.column :version, :integer, default: 0
+      t.column :comment, :string
+      t.column :remote_address, :string
+      t.column :request_uuid, :string
+      t.column :created_at, :datetime
+
+      t.index %i[auditable_type auditable_id version], name: "auditable_index"
+      t.index %i[associated_type associated_id], name: "associated_index"
+      t.index %i[user_type user_id], name: "user_index"
+      t.index :user_uid, name: "user_uid_index"
+      t.index :request_uuid
+      t.index :created_at
+    end
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/lib/generators/rockstart/development/development_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+class Rockstart::DevelopmentGenerator < Rails::Generators::Base
+  include Rockstart::Generators::ClassOptionHelpers
+
+  desc "Sets up your app for a Rocking time writing code"
+
+  auth0_class_option
+  devise_class_option
+  postgres_class_option
+  pundit_class_option
+
+  def generate_dotfiles
+    generate "rockstart:development:env", devise_option
+  end
+
+  def generate_scaffold_templates
+    generate "rockstart:development:scaffolds", auth0_option, pundit_option
+  end
+
+  def generate_localhost_setup
+    generate "rockstart:development:localhost_setup"
+  end
+
+  def setup_audited
+    generate "rockstart:development:audited", auth0_option, postgres_option
+  end
+
+  def setup_friendly_id
+    generate "rockstart:development:friendly_id"
+  end
+
+  def setup_generator_overrides
+    generate "rockstart:development:generator_overrides"
+  end
+
+  def generate_readme
+    generate "rockstart:development:readme", auth0_option
+  end
+end

data/lib/generators/rockstart/development/env/USAGE

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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+
+module Rockstart::Development
+  class EnvGenerator < Rails::Generators::Base
+    include Rockstart::Generators::ClassOptionHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    devise_class_option
+
+    def add_development_dotenv
+      template "dotenv.development.tt", ".env.development"
+    end
+  end
+end

data/lib/generators/rockstart/development/env/templates/dotenv.development.tt

@@ -0,0 +1,4 @@
+APP_HOST=localhost:3000
+<%- if devise? -%>
+DEVISE_MAILER_SENDER=devise-mailer@localhost
+<%- end -%>

data/lib/generators/rockstart/development/friendly_id/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Sets up friendly_id gem
+
+Example:
+    rails generate rockstart:development:friendly_id
+
+    This will create:
+        A basic configuration file for friendly_id

data/lib/generators/rockstart/development/friendly_id/friendly_id_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Development
+  class FriendlyIdGenerator < Rails::Generators::Base
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    def add_initializer
+      copy_initializer "friendly_id"
+    end
+  end
+end

data/lib/generators/rockstart/development/friendly_id/templates/friendly_id_initializer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# FriendlyId Global Configuration
+#
+# Use this to set up shared configuration options for your entire application.
+# Any of the configuration options shown here can also be applied to single
+# models by passing arguments to the `friendly_id` class method or defining
+# methods in your model.
+#
+# To learn more, check out the guide:
+#
+# http://norman.github.io/friendly_id/file.Guide.html
+
+FriendlyId.defaults do |config|
+  # ## Reserved Words
+  #
+  # Some words could conflict with Rails's routes when used as slugs, or are
+  # undesirable to allow as slugs. Edit this list as needed for your app.
+  config.use :reserved
+
+  config.reserved_words = %w[
+    new edit index session login logout users admin
+    page
+    stylesheets assets javascripts images
+    wp-admin wp-login password passwd
+  ]
+
+  config.treat_reserved_as_conflict = false
+
+  ## Slugs
+
+  # Use slugged for all friendly_ids
+  config.use :slugged
+
+  # Provide smaller (prettier) conflict resolution slug
+  config.use(Module.new do
+    def resolve_friendly_id_conflict(candidates)
+      uuid = SecureRandom.uuid
+      [
+        apply_slug_limit(candidates.first, uuid),
+        SecureRandom.hex(5)
+      ].compact.join(friendly_id_config.sequence_separator)
+    end
+  end)
+
+  # By default, FriendlyId's :slugged addon expects the slug column to be named
+  # 'slug', but you can change it if you wish.
+  config.slug_column = "slug"
+
+  # By default, slug has no size limit, but you can change it if you wish.
+  config.slug_limit = 100
+end

data/lib/generators/rockstart/development/generator_overrides/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate generator_overrides Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/rockstart/development/generator_overrides/generator_overrides_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Rockstart::Development
+  class GeneratorOverridesGenerator < Rails::Generators::Base
+    include Rails::Generators::AppName
+
+    source_root File.expand_path("templates", __dir__)
+
+    def add_custom_resource_routes_generator
+      template "resource_route_generator.rb",
+               "lib/generators/rails/#{app_name}_resource_route_generator.rb"
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def override_generator_defaults
+      application do
+        <<~DEFAULTS
+          config.generators do |g|
+            g.assets false
+            g.helper false
+            g.javascripts false
+            g.scaffold_stylesheet false
+            g.stylesheets false
+            g.resource_route :#{app_name}_resource_route
+          end
+        DEFAULTS
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end