hephaestus 0.8.11 → 0.8.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd5c6432d34e4e2eb90d9973085cd3f5c35a2e8782d5f606c1034216c38f2e4
-  data.tar.gz: 248400d20b246514c39493ae7c7f8431c684094681031f05d366e66e73ad9fb8
+  metadata.gz: 89c0585bf79ff89a4a35d183a6bdec69ec180effa6c5254aec22467093efeefa
+  data.tar.gz: 0aefd45fc0dd8549a845f49b510ba9ec7fbe991c85af3f7c9e65e79ed613c9ca
 SHA512:
-  metadata.gz: 1838be4d97e454204df1799da18b27f39ab071641e0750836eddd6e9855c9e94545ea790a566aecb73a8b108a9935d835f2b4e056a8f6d5c56321e4a6dd9284b
-  data.tar.gz: 30e903eefb0ceeee367ca1b07d7cdc07586b4cbc34a2500e54e5c9987c6f11e1412880f81d758cb5f095939ab2114e9c1c3f3f4a2fdb3173de87e7711fe9fd4a
+  metadata.gz: 1dcf277f2074215cbf3b207d99534f5bdcf2fd6deb9ed62d6c10e3c87680da8184a30a7e5cfce6ce58e05df6173fb1d808e1fc48edb45f4f1ee4627af2bf2054
+  data.tar.gz: 96c5fbb95236e5fe15fd538742c89010e6d9a581b2cfbf3ce70677b7412a1a48301c8f58a68521b7f0b0d45a79f253ca0f5eb31f2475049584d322c491b6214a

data/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.3.6

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v0.8.12.1] - 16-12-2024
+## What's Changed
+* general updates by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/95
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.12...v0.8.12.1
+# [v0.8.12] - 16-12-2024
+## What's Changed
+* Update template generator by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/93
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.11...v0.8.12
 # [v0.8.11] - 11-12-2024
 **Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.10...v0.8.11
 # [v0.8.10] - 10-12-2024

data/README.md

@@ -26,11 +26,13 @@ Where `app` represents the name of the platform you'd like to interact with, lik
 If you're working on updating/testing this gem locally, you may also try:
 
 ```
-rm -rf plug-app && DEBUG=1 hephaestus/bin/hephaestus plug-app
+rm -rf plug-app && DEBUG=1 bundle exec bin/hephaestus plug-app
 ```
 
 This way you can wipe the dir and quickly iterate on new changes.
 
+If you're having trouble connecting to the Internet, you can set `HEPHAESTUS_NO_EXTERNAL=1`.
+
 ## Building upon the base
 
 Most of the files which Hephaestus creates for you shouldn't need much modification. The information below is part-informative, part-guidelines on how to extend the generated code for your specific plug.

data/bin/hephaestus

@@ -34,25 +34,6 @@ if (str = ARGV.first)
   end
 end
 
-puts Rainbow("Checking to see if Hephaestus is the latest and greatest...").green
-require "net/http"
-begin
-  Net::HTTP.get(URI("https://www.yetto.app"))
-rescue Socket::ResolutionError
-  puts Rainbow("Unable to check for updates. Are you connected to the internet?").red
-  exit(1)
-end
-
-%x(gem outdated).split("\n").each do |line|
-  if line.include?("hephaestus")
-    puts Rainbow("There is a new version of Hephaestus available (`#{line}`). Please run 'gem update hephaestus' to update.").red
-    exit(1)
-  end
-end
-
-require "rails"
-require "hephaestus/engine"
-
 if ARGV.empty?
   puts "Please provide a path for the new application"
   puts
@@ -63,6 +44,31 @@ elsif ["-v", "--version"].include?(ARGV[0])
   exit 0
 end
 
+if ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") == "1"
+  puts Rainbow("Skipping Hephaestus check...").yellow
+else
+  puts Rainbow("Checking to see if Hephaestus is the latest and greatest...").green
+  require "net/http"
+  begin
+    Net::HTTP.get(URI("https://www.yetto.app"))
+  rescue Socket::ResolutionError
+    puts Rainbow("Unable to check for updates. Are you connected to the internet?").red
+    puts Rainbow("You can also set `HEPHAESTUS_NO_EXTERNAL=1` to skip this.").red
+    exit(1)
+  end
+end
+
+if ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") != "1"
+  %x(gem outdated).split("\n").each do |line|
+    if line.include?("hephaestus")
+      puts Rainbow("There is a new version of Hephaestus available (`#{line}`). Please run 'gem update hephaestus' to update.").red
+      exit(1)
+    end
+  end
+end
+
+puts Rainbow("Looking good! Proceeding...").blue
+
 path = ARGV.first
 if File.exist?(path)
   puts Rainbow("\nError: The directory #{path} already exists.").red
@@ -79,6 +85,17 @@ if path.split("-").length < 2
   exit 1
 end
 
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/hephaestus/engine", __dir__)
+APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "hephaestus"
+
 templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
 Hephaestus::AppGenerator.source_root(templates_root)
 Hephaestus::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
@@ -88,5 +105,6 @@ ARGV.push("--no-skip-active-job")
 ARGV.push("--skip-asset-pipeline")
 ARGV.push("--skip-active-record")
 ARGV.push("--skip-docker")
+ARGV.push("--skip_bundle")
 
 Hephaestus::AppGenerator.start

data/lib/hephaestus/app_builder.rb

@@ -17,17 +17,8 @@ module Hephaestus
       copy_file("hephaestus_gitignore", ".gitignore")
     end
 
-    # it is, apparently, extraordinarly important to keep this as an erb
-    def gemfile
-      template("Gemfile.erb", "Gemfile")
-    end
-
-    def raise_on_delivery_errors
-      replace_in_file(
-        "config/environments/development.rb",
-        "raise_delivery_errors = false",
-        "raise_delivery_errors = true",
-      )
+    def setup_dev_environment
+      copy_file("config/environments/blank.rb", "config/environments/development.rb", force: true)
     end
 
     def copy_setup_scripts
@@ -35,151 +26,48 @@ module Hephaestus
       Dir.glob("script/**/*").each do |file|
         next if File.directory?(file)
 
-        chmod(file, 0o755)
-      end
-    end
-
-    def configure_dev_hosting
-      config = <<~EOD
-        # Let dev server run on GitHub Codespaces
-        config.hosts << /[a-z0-9-]+.githubpreview.dev/
-
-        # Let dev server run on ngrok domains
-        config.hosts << /[a-z0-9-]+.ngrok.io/
-      EOD
-
-      configure_environment("development", config)
-    end
-
-    def setup_asset_host
-      config = <<~EOD
-        config.public_file_server.headers = {
-            "Cache-Control" => "public, max-age=31557600",
-          }
-      EOD
-
-      configure_environment("production", config)
-    end
-
-    def setup_background_worker
-      config = <<~EOD
-        # Use a real queuing backend for Active Job (and separate queues per environment).
-        config.active_job.queue_adapter = :sidekiq
-      EOD
-      configure_environment("production", config)
-      configure_environment("staging", config)
-    end
-
-    def setup_slack_logger
-      config = <<~EOD
-        config.after_initialize do
-          Rails.logger.broadcast_to(SlackWebhookLogger.logger)
+        # Rails adds this
+        if file == ".keep"
+          remove_file(file)
+          next
         end
-      EOD
-      configure_environment("production", config)
-      configure_environment("staging", config)
-      configure_environment("test", config)
-    end
 
-    def setup_ssl
-      ssl = <<~SSL
-        config.force_ssl = true
-        config.ssl_options = { hsts: { subdomains: true, preload: true, expires: 1.year } }
-      SSL
-
-      replace_in_file(
-        "config/environments/production.rb",
-        "# config.force_ssl = true",
-        ssl,
-      )
+        # this is because we might have *.tt templates, which aren't executable,
+        # so we gotta re-execute-em all
+        chmod(file, 0o755)
+      end
     end
 
     def setup_staging_environment
-      FileUtils.cp(File.join(destination_root, "config/environments/production.rb"), File.join(destination_root, "config/environments/staging.rb"))
+      copy_file("config/environments/blank.rb", "config/environments/staging.rb", force: true)
     end
 
-    def replace_gemfile
-      template("Gemfile.erb", "Gemfile", force: true) do |content|
-        if development_env?
-          content.gsub(/gem .hephaestus./) { |s| %(#{s}, path: "#{root_path}") }
-        else
-          content
-        end
-      end
+    def setup_production_environment
+      copy_file("config/environments/blank.rb", "config/environments/production.rb", force: true)
     end
 
-    def restore_gemfile
-      replace_in_file("Gemfile", /gem "hephaestus".+/, "gem \"hephaestus\"")
+    def setup_test_environment
+      copy_file("config/environments/blank.rb", "config/environments/test.rb", force: true)
     end
 
     def ruby_version
       create_file(".ruby-version", "#{Hephaestus::RUBY_VERSION}\n")
     end
 
-    def configure_time_formats
-      replace_in_file("config/application.rb", /# config.time_zone = .*/, "config.time_zone = \"UTC\"")
-    end
-
-    def create_github_repo(repo_name)
-      run("gh repo create #{repo_name}", exit_on_failure: false)
-    end
-
-    def remove_config_comment_lines
-      config_files = [
-        "application.rb",
-        "environment.rb",
-        "environments/development.rb",
-        "environments/production.rb",
-        "environments/test.rb",
-      ]
-
-      config_files.each do |config_file|
-        path = Pathname(destination_root).join("config", config_file)
-        source = Actions::StripCommentsAction.call(path.read)
-
-        path.write(source)
-      end
-    end
+    def replace_generic_variables
+      say(set_color("Replacing generic file names...", :cyan))
 
-    def remove_routes_comment_lines
-      replace_in_file(
-        "config/routes.rb",
-        /Rails\.application\.routes\.draw do.*end/m,
-        "Rails.application.routes.draw do\nend",
-      )
-    end
+      File.rename(File.join(destination_root, "app", "controllers", "app_controller.rb"), File.join(destination_root, "app", "controllers", "#{plug_name}_controller.rb"))
+      File.rename(File.join(destination_root, "app", "services", "app_service.rb"), File.join(destination_root, "app", "services", "#{plug_name}_service.rb"))
+      File.rename(File.join(destination_root, "test", "controllers", "app_controller_test.rb"), File.join(destination_root, "test", "controllers", "#{plug_name}_controller_test.rb"))
+      File.rename(File.join(destination_root, "test", "support", "webmocks", "app_webmock.rb"), File.join(destination_root, "test", "support", "webmocks", "#{plug_name}_webmock.rb"))
 
-    def setup_test_environment
-      remove_dir("test")
-      source = File.join(Hephaestus::AppGenerator.source_root, "test")
-      directory(source, "test")
-    end
-
-    def replace_generic_variables
-      say(set_color("Replacing generic variable names...", :cyan))
-      replace_in_files(destination_root, /App(?!lication)/, short_app_name.capitalize)
-
-      replace_in_files(destination_root, %r{(?<!yetto|sw|plugs\.yetto\.)app(?!lication|/|roximate)}, short_app_name.downcase)
-      replace_in_file("test/support/api.rb", "/app/", "/#{short_app_name.downcase}/")
-
-      replace_in_files(destination_root, "PlugApp", app_name.underscore.camelcase)
-      replace_in_files(destination_root, "plug-app", app_name.dasherize)
-      replace_in_files("#{destination_root}/.github/workflows", "plug-app", app_name.dasherize)
-      replace_in_files(destination_root, "PLUG_APP", app_name.underscore.upcase)
-      replace_in_files(destination_root, "plug_app", app_name.underscore)
-
-      # these are erroneously changed
-      replace_in_file("script/server", "/usr/src/#{short_app_name.downcase}", "/usr/src/app")
-      replace_in_file("vendor/fly/fly-production.toml", "#{short_app_name.downcase} = ", "app = ")
-      replace_in_file("vendor/fly/fly-staging.toml", "#{short_app_name.downcase} = ", "app =")
+      replace_in_file(File.join("lib", "schemas", "api", "2023-03-06", "openapi.json"), %r{app/paths.json}, "#{plug_name}/paths.json")
+      File.rename(File.join(destination_root, "lib", "schemas", "api", "2023-03-06", "paths", "app.json"), File.join(destination_root, "lib", "schemas", "api", "2023-03-06", "paths", "#{plug_name}.json"))
     end
 
     private
 
-    def short_app_name
-      app_name.split("_").last
-    end
-
     def root_path
       @root_path ||= Pathname(__dir__).join("..", "..").expand_path
     end
@@ -187,15 +75,5 @@ module Hephaestus
     def development_env?
       root_path.join("hephaestus.gemspec").exist?
     end
-
-    def raise_on_missing_translations_in(environment)
-      config = "config.i18n.raise_on_missing_translations = true"
-
-      uncomment_lines("config/environments/#{environment}.rb", config)
-    end
-
-    def heroku_adapter
-      @heroku_adapter ||= Adapters::Heroku.new(self)
-    end
   end
 end

data/lib/hephaestus/app_name.rb

@@ -0,0 +1,33 @@
+# typed: false
+# frozen_string_literal: true
+
+module Hephaestus
+  module AppName
+    # like, `plug-slack`
+    def app_name
+      send(:original_app_name)
+    rescue NoMethodError # we're in the context of Rails, so we can't call the generator method
+      "plug-#{Rails.application.class.module_parent.name.underscore[5..-1]}"
+    end
+
+    # like, `slack`
+    def plug_name
+      app_name.split("-", 2).last
+    end
+
+    # like, `Slack`, or `html_proofer => HtmlProofer`
+    def capital_plug_name
+      plug_name.camelcase
+    end
+
+    # like, `SLACK`
+    def upcase_plug_name
+      plug_name.upcase
+    end
+
+    # like, `slack`, or `HTMLProofer => html_proofer``
+    def underscore_plug_name
+      plug_name.underscore
+    end
+  end
+end

data/lib/hephaestus/generators/app_generator.rb

@@ -5,9 +5,10 @@ require "rails/generators"
 require "rails/generators/rails/app/app_generator"
 require "tempfile"
 
+require "hephaestus/app_name"
 module Hephaestus
   class AppGenerator < Rails::Generators::AppGenerator
-    include ExitOnFailure
+    include Hephaestus::AppName
 
     hide!
 
@@ -24,14 +25,14 @@ module Hephaestus
       desc: "Show this help message and quit"
 
     def finish_template
-      invoke(:hephaestus_customization)
-      super
+      invoke(:hephaestus_initialize)
+      # super
     end
 
-    def hephaestus_customization
+    def hephaestus_initialize
       say(set_color("Invoking Hephaestus customizations...", :cyan))
 
-      run("rails app:update:bin")
+      invoke(:init_git)
       invoke(:customize_gemfile)
 
       invoke(:copy_github_actions)
@@ -41,20 +42,30 @@ module Hephaestus
       invoke(:setup_production_environment)
       invoke(:setup_staging_environment)
       invoke(:setup_test_environment)
-      invoke(:setup_shared_environment_logic)
 
       invoke(:configure_app)
-      invoke(:create_github_repo)
+      invoke(:leftovers)
+    end
+
+    def init_git
+      run("git remote add origin https://github.com/yettoapp/#{app_name}.git")
+      run("git branch -m production")
     end
 
     def customize_gemfile
       say(set_color("Customizing Gemfile...", :cyan))
-      build(:replace_gemfile)
-      capture_stdout do
-        bundle_command("install")
-        bundle_command("update")
-        bundle_command("binstub foreman")
-        bundle_command("lock --add-platform x86_64-linux")
+      template("Gemfile", "Gemfile", force: true)
+      # FIXME: unsure why, but when the generators are called, Rails expects Gemfiles in these locations?
+      copy_file("Gemfile", File.join(Hephaestus::AppGenerator.source_root, "Gemfile"))
+      copy_file("Gemfile", File.join(Hephaestus::AppGenerator.source_root, "..", "Gemfile"))
+      replace_in_files(Hephaestus::AppGenerator.source_root, %|ruby File.read(".ruby-version").strip|, %|ruby "#{Hephaestus::RUBY_VERSION}"|)
+
+      unless ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") == "1"
+        capture_stdout do
+          run("BUNDLE_GEMFILE=\"#{destination_root}/Gemfile\" bundle install", abort_on_failure: false)
+          run("BUNDLE_GEMFILE=\"#{destination_root}/Gemfile\" bundle update")
+          run("BUNDLE_GEMFILE=\"#{destination_root}/Gemfile\" bundle lock --add-platform x86_64-linux")
+        end
       end
     end
 
@@ -62,7 +73,7 @@ module Hephaestus
       say(set_color("Copying GitHub Actions...", :cyan))
 
       capture_stdout do
-        directory(Hephaestus.source_path(".github"), ".github")
+        directory("hephaestus_github", ".github", force: true)
       end
     end
 
@@ -70,67 +81,71 @@ module Hephaestus
       say(set_color("Copying .vscode/...", :cyan))
 
       capture_stdout do
-        directory(Hephaestus.source_path(".vscode"), ".vscode")
+        directory("hephaestus_vscode", ".vscode")
       end
     end
 
     def setup_development_environment
       say(set_color("Setting up the development environment...", :cyan))
+      build(:setup_dev_environment)
       capture_stdout do
-        build(:raise_on_delivery_errors)
-        build(:configure_dev_hosting)
         build(:copy_setup_scripts)
       end
     end
 
-    def setup_production_environment
-      say(set_color("Setting up the production environment...", :cyan))
+    def setup_staging_environment
+      say(set_color("Setting up the staging environment...", :cyan))
+      build(:setup_staging_environment)
       capture_stdout do
-        build(:setup_asset_host)
-        build(:setup_ssl)
       end
     end
 
-    def setup_staging_environment
-      say(set_color("Setting up the staging environment...", :cyan))
+    def setup_production_environment
+      say(set_color("Setting up the production environment...", :cyan))
+      build(:setup_production_environment)
       capture_stdout do
-        build(:setup_staging_environment)
       end
     end
 
     def setup_test_environment
       say(set_color("Setting up the test environment...", :cyan))
-      capture_stdout do
-        build(:setup_test_environment)
-      end
+      build(:setup_test_environment)
     end
 
-    def setup_shared_environment_logic
+    def configure_app
+      say(set_color("Configuring app...", :cyan))
+
       capture_stdout do
-        build(:setup_background_worker)
-        build(:setup_slack_logger)
+        remove_dir("bin")
+        remove_dir("app/helpers")
+        remove_dir("app/models")
+        remove_dir("app/views/layouts")
+        remove_dir("lib/assets")
+        remove_file("lib/tasks/.keep")
       end
-    end
 
-    def configure_app
-      say(set_color("Configuring app...", :cyan))
+      # This must be here, rather than a generator, because generators are run in a Rails environment,
+      # and the bootup process requires the fake PEM key file to be present.
+      # we do this to specify the template source, otherwise the generator wants to use its own `test` dir
+      source = File.join(Hephaestus::AppGenerator.source_root, "test")
+      directory(source, "test", force: true)
 
-      remove_dir("app/assets")
-      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")
+      # This must be here, rather than a generator, because generators are run in a Rails environment,
+      # and the OpenAPI middleware, which is loaded when the app boots, requires the schema files to be present.
+      capture_stdout do
+        directory("lib/schemas/api/2023-03-06", "lib/schemas/api/2023-03-06")
+      end
 
-      build(:configure_time_formats)
+      # we do this to specify the template source, otherwise the generator wants to use Rails own `bin` dir
+      source = File.join(Hephaestus::Engine.root, "templates", "bin")
+      directory(source, "bin", force: true)
 
-      bundle_command("binstubs bundler")
+      say(set_color("\n*** All these upcoming `HEAD` errors are okay to ignore! ***\n", :cyan))
 
       capture_stdout do
         generate("hephaestus:core")
+
+        generate("hephaestus:db")
         generate("hephaestus:deployment")
         generate("hephaestus:lib")
 
@@ -139,16 +154,10 @@ module Hephaestus
       end
     end
 
-    def create_github_repo
-      if !options[:skip_git] && options[:github]
-        say(set_color("Creating repository via `gh repo`...", :cyan))
-        build(:create_github_repo, options[:github])
-      end
-    end
-
-    # NOTE: this function name is important as it overrides
-    # a Rails function of the same name (that function performs work
-    # that we don't want to do)
+    # NOTE: this function name is important as it matches
+    # a Rails function of the same name (that performs work
+    # that we don't want to do). Think of this as the final step in the process
+    # started by `finish_template`.
     def leftovers
       build(:replace_generic_variables)
 
@@ -156,20 +165,25 @@ module Hephaestus
       capture_stdout do
         generate("hephaestus:license")
       end
+
       say(set_color("Generating `hephaestus:rubocop`...", :cyan))
       capture_stdout do
         generate("hephaestus:rubocop")
       end
-      say(set_color("Generating `hephaestus:sorbet`...", :cyan))
-      capture_stdout do
-        generate("hephaestus:sorbet")
-      end
+
+      # say(set_color("Generating `hephaestus:sorbet`...", :cyan))
+      # capture_stdout do
+      #   generate("hephaestus:sorbet")
+      # end
+
+      replace_in_file(File.join("lib", "schemas", "api", "2023-03-06", "openapi.json"), %r{app/paths.json}, "#{plug_name}/paths.json")
+      File.rename(File.join(destination_root, "lib", "schemas", "api", "2023-03-06", "paths", "app.json"), File.join(destination_root, "lib", "schemas", "api", "2023-03-06", "paths", "#{plug_name}.json"))
+
       say(set_color("Creating first commit...", :cyan))
       capture_stdout do
         invoke(:commit)
       end
 
-      build(:restore_gemfile)
       invoke(:outro)
     end
 
@@ -195,7 +209,7 @@ module Hephaestus
 
         Store this in 1Password too; you don't need the .env file for staging/production.
 
-        For `SIGNING_SECRET` and `YETTO_PLUG_ID`, you'll need to generate those values yourself.
+        For `YETTO_SIGNING_SECRET` and `YETTO_PLUG_ID`, you'll need to generate those values yourself.
 
         Then, try running `bin/rails c` to ensure that everything was set up correctly.
         Running `rake test` is also a good idea.
@@ -232,22 +246,12 @@ module Hephaestus
     end
 
     private def capture_stdout
-      # stream = "stdout"
-      # captured_stream = Tempfile.new(stream)
-      # stream_io = eval("$#{stream}", binding, __FILE__, __LINE__)
-      # origin_stream = stream_io.dup
-      # stream_io.reopen(captured_stream)
-
+      out = StringIO.new
+      $stdout = out
       yield
-
-      # stream_io.rewind
-      # captured_stream.read
-
-      # unless captured_stream.nil?
-      #   captured_stream.close
-      #   captured_stream.unlink
-      # end
-      # stream_io.reopen(origin_stream) unless stream_io.nil?
+      out.string
+    ensure
+      $stdout = STDOUT
     end
   end
 end

data/lib/hephaestus/generators/base.rb

@@ -8,7 +8,6 @@ module Hephaestus
   module Generators
     class Base < Rails::Generators::Base
       include Hephaestus::Actions
-      include ExitOnFailure
 
       class << self
         def default_source_root