hephaestus 0.0.1

data/lib/hephaestus/generators/app_generator.rb

@@ -0,0 +1,158 @@
+# typed: false
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Hephaestus
+  class AppGenerator < Rails::Generators::AppGenerator
+    include ExitOnFailure
+
+    hide!
+
+    class_option :version,
+      type: :boolean,
+      aliases: "-v",
+      group: :hephaestus,
+      desc: "Show Hephaestus version number and quit"
+
+    class_option :help,
+      type: :boolean,
+      aliases: "-h",
+      group: :hephaestus,
+      desc: "Show this help message and quit"
+
+    def finish_template
+      say("Invoking Hephaestus customization")
+      invoke(:hephaestus_customization)
+      super
+    end
+
+    def leftovers
+      build(:replace_generic_variables)
+      generate("hephaestus:license")
+      generate("hephaestus:rubocop")
+
+      generate("hephaestus:sorbet")
+      invoke(:commit)
+      invoke(:outro)
+    end
+
+    def hephaestus_customization
+      invoke(:customize_gemfile)
+      invoke(:copy_github_actions)
+      invoke(:setup_development_environment)
+      invoke(:setup_staging_environment)
+      invoke(:setup_production_environment)
+      invoke(:setup_test_environment)
+      invoke(:configure_app)
+      invoke(:purge_unneeded_files)
+      invoke(:copy_vscode_settings)
+      invoke(:generate_default)
+      invoke(:create_github_repo)
+    end
+
+    def customize_gemfile
+      build(:replace_gemfile)
+      bundle_command("install")
+      bundle_command("lock --add-platform x86_64-linux")
+    end
+
+    def copy_github_actions
+      source = File.join(Hephaestus::AppGenerator.source_root, ".github")
+      directory(source, ".github")
+    end
+
+    def setup_development_environment
+      say("Setting up the development environment")
+      build(:configure_local_mail)
+      build(:raise_on_delivery_errors)
+      build(:configure_dev_hosting)
+      build(:copy_setup_scripts)
+    end
+
+    def copy_vscode_settings
+      source = File.join(Hephaestus::AppGenerator.source_root, ".vscode")
+      directory(source, ".vscode")
+    end
+
+    def purge_unneeded_files
+      remove_dir("app/assets")
+      remove_file("app/controllers/concerns/.keep")
+      remove_dir("app/helpers")
+      remove_dir("app/models")
+      remove_dir("app/views/layouts")
+      remove_dir("lib/assets")
+      remove_dir("lib/tasks/.keep")
+      remove_dir("test/helpers")
+      remove_dir("test/channels")
+      remove_dir("test/models")
+    end
+
+    def setup_staging_environment
+      build(:setup_staging_environment)
+    end
+
+    def setup_production_environment
+      say("Setting up the production environment")
+      build(:setup_asset_host)
+      build(:setup_background_worker)
+      build(:setup_slack_logger)
+    end
+
+    def setup_test_environment
+      say("Setting up the production environment")
+      build(:setup_test_environment)
+    end
+
+    def configure_app
+      say("Configuring app")
+      build(:configure_time_formats)
+    end
+
+    def create_github_repo
+      if !options[:skip_git] && options[:github]
+        say("Creating Github repo")
+        build(:create_github_repo, options[:github])
+      end
+    end
+
+    def generate_default
+      run("spring stop > /dev/null 2>&1 || true")
+
+      generate("hephaestus:core")
+      generate("hephaestus:deployment")
+      generate("hephaestus:lib")
+
+      # keep this at the end
+      generate("hephaestus:config")
+    end
+
+    def commit
+      run("git add .")
+      run("git commit -m 'Initial commit'")
+    end
+
+    def outro
+      say("\nCongratulations! You just made a plug.")
+      say("\nTry running `rails c` to ensure that everything was set up correctly.")
+      say("\nRunning `rake test` is also a good idea.")
+    end
+
+    class << self
+      def banner
+        "hephaestus #{arguments.map(&:usage).join(" ")} [options]"
+      end
+    end
+
+    protected
+
+    def get_builder_class # rubocop:disable Naming/AccessorMethodName
+      Hephaestus::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/hephaestus/generators/base.rb

@@ -0,0 +1,65 @@
+# typed: false
+# frozen_string_literal: true
+
+require "rails/generators"
+require_relative "../actions"
+
+module Hephaestus
+  module Generators
+    class Base < Rails::Generators::Base
+      include Hephaestus::Actions
+      include ExitOnFailure
+
+      class << self
+        def default_source_root
+          File.expand_path(File.join("..", "..", "..", "templates"), __dir__)
+        end
+
+        def inherited(subclass)
+          super
+
+          description_file = File.expand_path(
+            File.join(
+              default_source_root,
+              "descriptions",
+              "#{subclass.generator_name}.md",
+            ),
+          )
+
+          subclass.desc(File.read(description_file))
+        rescue Errno::ENOENT # rubocop:disable Lint/SuppressedException
+        end
+      end
+
+      private
+
+      def app_name
+        Rails.app_class.module_parent_name.demodulize.underscore.dasherize
+      end
+
+      def empty_directory_with_keep_file(destination)
+        empty_directory(destination, {})
+        keep_file(destination)
+      end
+
+      def keep_file(destination)
+        create_file(File.join(destination, ".keep"))
+      end
+
+      def append_template_to_file(destination, source, *args)
+        partial = File.expand_path(find_in_source_paths(source))
+        append_to_file(destination, File.read(partial, *args))
+      end
+
+      def prepend_template_to_file(destination, source, *args)
+        partial = File.expand_path(find_in_source_paths(source))
+        prepend_to_file(destination, File.read(partial, *args))
+      end
+
+      def inject_template_into_file(destination, source, *args)
+        partial = File.expand_path(find_in_source_paths(source))
+        inject_into_file(destination, File.read(partial), *args)
+      end
+    end
+  end
+end

data/lib/hephaestus/generators/config_generator.rb

@@ -0,0 +1,102 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class ConfigGenerator < Generators::Base
+    def application
+      config = <<~CONFIG
+
+
+        if ENV.fetch("DEBUG", false) && defined?(Rails::Server) && Rails.env.development?
+          require "debug/open_nonstop"
+        end
+
+      CONFIG
+
+      inject_into_file(
+        "config/application.rb",
+        config,
+        after: "require \"rails/test_unit/railtie\"",
+      )
+      inject_into_file(
+        "config/application.rb",
+        "\n  CURRENT_VERSION = \"2023-03-06\"\n\n",
+        before: "class Application < Rails::Application",
+      )
+
+      config = <<~CONFIG
+
+        # Only loads a smaller set of middleware suitable for API only apps.
+        # Middleware like session, flash, cookies can be added back manually.
+        # Skip views, helpers and assets when generating a new resource.
+        config.api_only = true
+
+        Rails.root.glob("app/lib/#{app_name.underscore}/middleware/*.{rb}").each { |file| require_relative file }
+
+        config.middleware.insert(0, PlugEmail::Middleware::TracingAttributes)
+        config.middleware.insert(0, PlugEmail::Middleware::MalformedRequest)
+
+        config.middleware.use(PlugEmail::Middleware::OpenapiValidation)
+
+        GIT_SHA = %x(git rev-parse HEAD).chomp
+      CONFIG
+
+      inject_into_file(
+        "config/application.rb",
+        config,
+        before: "\n  end",
+      )
+
+      replace_in_file(
+        "config/application.rb",
+        "require \"rails\"\n",
+        "",
+      )
+
+      comment_lines("config/application.rb", "require \"active_model/railtie\"")
+      uncomment_lines("config/application.rb", "require \"active_job/railtie\"")
+    end
+
+    def boot
+      boot = "require \"bootsnap/setup\" # Speed up boot time by caching expensive operations."
+      inject_into_file(
+        "config/boot.rb",
+        boot,
+      )
+    end
+
+    def initializers
+      remove_dir("config/initializers")
+      directory("config/initializers", "config/initializers")
+    end
+
+    def configure_routes
+      routes = <<~ROUTES
+        root "root#index"
+
+        # events into the plug, usually from yetto
+        get "/api/2023-03-06/settings", to: "settings#index"
+        post "/api/2023-03-06/:event/:record_type", to: "yetto#event"
+
+        # Staff pages
+        get "staff", to: "staff#index"
+        require "sidekiq/web"
+        constraints ->(request) { StaffController.staff_request?(request) } do
+          mount Sidekiq::Web => "staff/sidekiq"
+        end
+      ROUTES
+
+      replace_in_file(
+        "config/routes.rb",
+        "# root \"articles#index\"",
+        routes,
+      )
+    end
+
+    def sidekiq
+      copy_file("config/sidekiq.yml", "config/sidekiq.yml")
+    end
+  end
+end

data/lib/hephaestus/generators/core_generator.rb

@@ -0,0 +1,50 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class CoreGenerator < Generators::Base
+    def controllers
+      remove_file("app/controllers/application_controller.rb")
+      copy_file("app/controllers/application_controller.rb", "app/controllers/application_controller.rb")
+
+      copy_file("app/controllers/root_controller.rb", "app/controllers/root_controller.rb")
+      copy_file("app/controllers/settings_controller.rb", "app/controllers/settings_controller.rb")
+      copy_file("app/controllers/staff_controller.rb", "app/controllers/staff_controller.rb")
+      copy_file("app/controllers/yetto_controller.rb", "app/controllers/yetto_controller.rb")
+
+      copy_file("app/controllers/concerns/authable.rb", "app/controllers/concerns/authable.rb")
+    end
+
+    def jobs
+      copy_file("app/jobs/application_job.rb", "app/jobs/application_job.rb")
+      copy_file("app/jobs/update_yetto_job.rb", "app/jobs/update_yetto_job.rb")
+    end
+
+    def libs
+      bare_app_name = app_name.split("-").last
+      copy_file("app/lib/body_parameter/yetto_parameters.rb", "app/lib/body_parameter/yetto_parameters.rb")
+      copy_file("app/lib/constants/app.rb", "app/lib/constants/#{bare_app_name}.rb")
+      copy_file("app/lib/headers/yetto.rb", "app/lib/headers/yetto.rb")
+      copy_file("app/lib/path_parameter/yetto_parameters.rb", "app/lib/path_parameter/yetto_parameters.rb")
+      directory("app/lib/plug_app", "app/lib/#{app_name.underscore}")
+
+      copy_file("app/lib/body_parameter.rb", "app/lib/body_parameter.rb")
+      copy_file("app/lib/headers.rb", "app/lib/headers.rb")
+      copy_file("app/lib/path_parameter.rb", "app/lib/path_parameter.rb")
+    end
+
+    def serializers
+      copy_file("app/serializers/error_serializer.rb", "app/serializers/error_serializer.rb")
+    end
+
+    def services
+      copy_file("app/services/yetto_service.rb", "app/services/yetto_service.rb")
+    end
+
+    def views
+      copy_file("app/views/settings/index.json.jbuilder", "app/views/settings/index.json.jbuilder")
+    end
+  end
+end

data/lib/hephaestus/generators/deployment_generator.rb

@@ -0,0 +1,18 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class DeploymentGenerator < Generators::Base
+    def procfile
+      copy_file("Procfile.dev", "Procfile.dev")
+      copy_file("Procfile.debug", "Procfile.debug")
+    end
+
+    def sample_env
+      copy_file(".env.test", ".env.test")
+      copy_file(".env.test", ".env")
+    end
+  end
+end

data/lib/hephaestus/generators/lib_generator.rb

@@ -0,0 +1,16 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class LibGenerator < Generators::Base
+    def lib_plug
+      directory("lib/plug_app", "lib/#{app_name.underscore}")
+    end
+
+    def lib_tasks
+      directory("lib/tasks", "lib/tasks")
+    end
+  end
+end

data/lib/hephaestus/generators/license_generator.rb

@@ -0,0 +1,16 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class LicenseGenerator < Generators::Base
+    def licensed
+      copy_file(".licensed.yml", ".licensed.yml")
+    end
+
+    def generate_licenses
+      run("script/licenses --update")
+    end
+  end
+end

data/lib/hephaestus/generators/rubocop_generator.rb

@@ -0,0 +1,18 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class RubocopGenerator < Generators::Base
+    def rubocop
+      copy_file(".rubocop.yml", ".rubocop.yml")
+    end
+
+    def lint
+      Bundler.with_unbundled_env do
+        run("bundle exec rubocop -A", abort_on_failure: false)
+      end
+    end
+  end
+end

data/lib/hephaestus/generators/sorbet_generator.rb

@@ -0,0 +1,16 @@
+# typed: false
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Hephaestus
+  class SorbetGenerator < Generators::Base
+    def sorbet
+      copy_file("sorbet/custom.rbi", "sorbet/custom.rbi")
+      Bundler.with_unbundled_env do
+        run("bundle exec tapioca init")
+        run("script/typecheck --update")
+      end
+    end
+  end
+end

data/lib/hephaestus/version.rb

@@ -0,0 +1,11 @@
+# typed: false
+# frozen_string_literal: true
+
+module Hephaestus
+  VERSION = "0.0.1"
+  RAILS_VERSION = "~> 7.0.0"
+  RUBY_VERSION = File
+    .read("#{File.dirname(__FILE__)}/../../.ruby-version")
+    .strip
+    .freeze
+end

data/lib/hephaestus.rb

@@ -0,0 +1,21 @@
+# typed: false
+# frozen_string_literal: true
+
+DEBUG = ENV.fetch("DEBUG", false)
+
+def debugging?
+  DEBUG
+end
+
+require "debug" if debugging?
+
+require "hephaestus/version"
+require "hephaestus/exit_on_failure"
+require "hephaestus/generators/app_generator"
+Dir.glob(File.join(__dir__, "hephaestus", "generators", "*.rb")).each do |file|
+  require file
+end
+
+require "hephaestus/actions"
+require "hephaestus/actions/strip_comments_action"
+require "hephaestus/app_builder"

data/templates/Gemfile.erb

@@ -0,0 +1,121 @@
+source "https://rubygems.org"
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+ruby "<%= Hephaestus::RUBY_VERSION %>"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.0"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", "~> 6.1"
+
+# for making kick-ass http queries
+gem "httpx", "~> 0.22"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder", "~> 2.11"
+
+# Use Redis adapter to run Action Cable in production
+gem "redis", "~> 5.0"
+
+# Use hiredis to get better performance than the "redis" gem
+gem "hiredis", "~> 0.6"
+
+# better loggin'
+gem "lograge", "~> 0.12"
+
+# provides middleware to make OpenAPI parsing simpler
+gem "openapi_first", "~> 0.20"
+
+# For Honeycomb.io
+gem "opentelemetry-sdk", "~> 1.1"
+gem "opentelemetry-exporter-otlp", "~> 0.23"
+gem "opentelemetry-semantic_conventions", "~> 1.1"
+
+gem "opentelemetry-instrumentation-rack", "~> 0.22"
+gem "opentelemetry-instrumentation-rails", "~> 0.24"
+gem "opentelemetry-instrumentation-concurrent_ruby", "~> 0.20"
+
+gem "opentelemetry-instrumentation-net_http", "~> 0.21"
+
+gem "opentelemetry-instrumentation-active_job", "~> 0.4"
+gem "opentelemetry-instrumentation-redis", "~> 0.24"
+gem "opentelemetry-instrumentation-sidekiq", "~> 0.23"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+gem "safety_dance", "~> 1.0"
+
+# Use Sidekiq for the jobs queue
+gem "sidekiq", "~> 7.0"
+
+# sends logs to Slack
+gem "slack_webhook_logger", "~> 0.1"
+
+group :development, :test do
+  # better debug output with `ap`
+  gem "amazing_print"
+
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: [:mri, :mingw, :x64_mingw], require: false
+
+  gem "faker", "~> 2.20"
+  gem "rubocop", require: false
+  gem "rubocop-standard", require: false
+end
+
+group :development do
+  gem "dotenv-rails"
+
+  gem "foreman", "~> 0.87"
+
+  gem "licensed", "~> 4.0"
+
+  gem "ruby-lsp", "~> 0.3", require: false
+
+  gem "spoom"
+  gem "sorbet"
+  gem "tapioca", require: false
+end
+gem "sorbet-runtime"
+
+group :test do
+  # Adds support for Capybara system testing and selenium driver
+  gem "capybara", "~> 3.26"
+
+  # track down flakey tests
+  gem "minitest-bisect"
+
+  # mocking lib
+  gem "mocha"
+
+  # allow easier middleware testing
+  gem "rack-test", "~> 2.0"
+
+  # navigate website
+  gem "selenium-webdriver"
+
+  # jump around through time
+  gem "timecop", "~> 0.9"
+
+  # Easy installation and use of web drivers to run system tests with browsers
+  gem "webdrivers", "~> 5.0", require: false
+
+  # prevents real http requests
+  gem "webmock", "~> 3.8"
+end
+
+group :ci do
+  gem "brakeman", "~> 5.3"
+  gem "bundle-audit", "~> 0.1"
+end
+
+gem "hephaestus", group: [:development, :test]

data/templates/Procfile.debug

@@ -0,0 +1,2 @@
+web: rdbg -n --open=vscode -c -- bin/rails server -p 6661
+worker: bundle exec sidekiq -c 2

data/templates/Procfile.dev

@@ -0,0 +1,2 @@
+web: bin/rails server -p 6661
+worker: bundle exec sidekiq -c 2

data/templates/README.md.erb

@@ -0,0 +1 @@
+# <%= app_name.titlecase %>