hephaestus 0.8.12 → 0.8.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06528561509ef978d2df34dc6ae67b75a91d26a67fda79fa97fbdd4dde886ab4'
-  data.tar.gz: eb3559c45d3a7bf42221d346a344baaabbe44880dd755c87da5ff8109da11e93
+  metadata.gz: 946513d5bfb959191872e0404f6eb0c95c4a6d4ded918425926ba0ca24f09dce
+  data.tar.gz: 0524cf36eb6e3717eb1c1b7fab0de51438cbce348b0882a77e50422d5c25747a
 SHA512:
-  metadata.gz: 56d6a0b8f9f823cc930230c9d2462d6f0fec6f801487acdbae3add9a63d7508100cf862c48c836e18bdfdcd30f7b261b77726469be194db352cb55ba90fdb119
-  data.tar.gz: 1ea2bffff5ee8de27ae0de2a4657775bbad4bdddb82f369787e09ebb3fc9ec541316564e69609eb3fa70e708c9970667816e6f7e57a596fd50f567071c514a3a
+  metadata.gz: 15f88a25cfea5f83d2fb5ac629d163ab2d8b1205bc3b5a99cf38282b8628cac6da86a31f68c99e4e9eb0511e6a5f270ce562aada76e76db9eebf31a2f25073aa
+  data.tar.gz: 4271659d3c4302dcfa5cb991b8b9c01f20a8d2e8d13b3b554cfea8a79417117ee86ee2228188984bc1a78b7f42e5a81325386ebade0714c32dd14a7d8a5168c0

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v0.8.12.2] - 17-12-2024
+## What's Changed
+* Fixups by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/97
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.12.1...v0.8.12.2
+# [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

data/README.md

@@ -26,7 +26,7 @@ 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 bundle exec bin/hephaestus plug-app
+rm -rf plug-app && DEBUG=1 bundle exec hephaestus/bin/hephaestus plug-app
 ```
 
 This way you can wipe the dir and quickly iterate on new changes.

data/bin/hephaestus

@@ -34,6 +34,16 @@ if (str = ARGV.first)
   end
 end
 
+if ARGV.empty?
+  puts "Please provide a path for the new application"
+  puts
+  puts "See --help for more info"
+  exit 0
+elsif ["-v", "--version"].include?(ARGV[0])
+  puts Hephaestus::VERSION
+  exit 0
+end
+
 if ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") == "1"
   puts Rainbow("Skipping Hephaestus check...").yellow
 else
@@ -57,54 +67,34 @@ if ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") != "1"
   end
 end
 
-puts Rainbow("Looking good! Proceeding...").blue
-
-if ARGV.empty?
-  puts "Please provide a path for the new application"
-  puts
-  puts "See --help for more info"
-  exit 0
-elsif ["-v", "--version"].include?(ARGV[0])
-  puts Hephaestus::VERSION
-  exit 0
-end
-
-path = ARGV.first
-if File.exist?(path)
-  puts Rainbow("\nError: The directory #{path} already exists.").red
-  exit 1
-end
-
-unless path.start_with?("plug-")
-  puts Rainbow("\nError: The directory name must start with 'plug-'").red
-  exit 1
-end
-
-if path.split("-").length < 2
-  puts Rainbow("\nError: The directory name must start with 'plug-'").red
-  exit 1
-end
+puts Rainbow("You're on the latest version of Hephaestus! Proceeding...").blue
 
 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"])
+# 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
-
-ARGV.push("--minimal")
-ARGV.push("--no-skip-active-job")
-ARGV.push("--skip-asset-pipeline")
-ARGV.push("--skip-active-record")
-ARGV.push("--skip-docker")
-ARGV.push("--skip_bundle")
+
+# Since we're hijacking Rails' generation process,
+# we *do not* want any of Rails' generators to interfere.
+# Rails provides its own list of generators,
+# and then attaches Hephaestus' generators to that list;
+# so, we'll remove any generators that come before Hephaestus' generators.
+config = Hephaestus::AppGenerator.all_commands
+
+delete_keys = true
+config.keys.each do |key|
+  break if key == "hephaestus_generator"
+
+  config.delete(key) if delete_keys
+end
 
 Hephaestus::AppGenerator.start

data/lib/hephaestus/engine.rb

@@ -16,7 +16,8 @@ module Hephaestus
     when "production", "staging"
       ENV["GIT_SHA"] || ""
     when "development"
-      %x(git rev-parse HEAD)
+      result = %x(git rev-parse HEAD 2>&1)
+      $CHILD_STATUS == 0 ? result : "deadbeef" # check if the child process exited cleanly.
     when "test"
       "deadbeef"
     end.chomp

data/lib/hephaestus/generators/app_generator.rb

@@ -4,12 +4,16 @@
 require "rails/generators"
 require "rails/generators/rails/app/app_generator"
 require "tempfile"
+require "bundler"
 
+require "hephaestus/actions"
 require "hephaestus/app_name"
 module Hephaestus
   class AppGenerator < Rails::Generators::AppGenerator
-    include ExitOnFailure
     include Hephaestus::AppName
+    include Hephaestus::Actions
+
+    attr_reader :result_dir
 
     hide!
 
@@ -25,16 +29,29 @@ module Hephaestus
       group: :hephaestus,
       desc: "Show this help message and quit"
 
-    def finish_template
-      invoke(:hephaestus_initialize)
-      # super
-    end
-
-    def hephaestus_initialize
+    # This method name is important as everything before it is added by
+    # Rails::Generators::AppGenerator; this is our true entrypoint.
+    def hephaestus_generator
       say(set_color("Invoking Hephaestus customizations...", :cyan))
 
-      invoke(:init_git)
-      invoke(:customize_gemfile)
+      path = ARGV.first
+      if File.exist?(path)
+        raise(Rainbow("\nError: The directory #{path} already exists.").red.to_s)
+      end
+
+      unless path.start_with?("plug-")
+        raise(Rainbow("\nError: The directory name must start with 'plug-'").red.to_s)
+      end
+
+      if path.split("-").length < 2
+        raise(Rainbow("\nError: The directory name must start with 'plug-'").red.to_s)
+      end
+
+      @destination_stack << @app_path
+
+      @result_dir = @destination_stack.join(File::SEPARATOR)
+
+      invoke(:copy_basics)
 
       invoke(:copy_github_actions)
       invoke(:copy_vscode_settings)
@@ -45,23 +62,20 @@ module Hephaestus
       invoke(:setup_test_environment)
 
       invoke(:configure_app)
-      invoke(:leftovers)
+      invoke(:finalize)
+      invoke(:first_commit)
+      invoke(:outro)
     end
 
-    def init_git
-      run("git remote add origin https://github.com/yettoapp/#{app_name}.git")
-      run("git branch -m production")
-    end
+    def copy_basics
+      capture_stdout do
+        directory("root", ".")
 
-    def customize_gemfile
-      say(set_color("Customizing Gemfile...", :cyan))
-      build(:replace_gemfile)
-      unless ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") == "1"
-        capture_stdout do
-          bundle_command("install")
-          bundle_command("update")
-          bundle_command("lock --add-platform x86_64-linux")
+        Dir.glob(File.join(destination_root, "hephaestus_*")).each do |file|
+          File.rename(file, file.gsub("hephaestus_", "."))
         end
+
+        copy_file("root/hephaestus_env.sample", ".env")
       end
     end
 
@@ -69,7 +83,7 @@ module Hephaestus
       say(set_color("Copying GitHub Actions...", :cyan))
 
       capture_stdout do
-        directory(Hephaestus.source_path(".github"), ".github", force: true)
+        directory("hephaestus_github", ".github", force: true)
       end
     end
 
@@ -77,113 +91,157 @@ 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(:copy_setup_scripts)
+        copy_file("config/environments/blank.rb", "config/environments/development.rb", force: true)
+
+        directory(Hephaestus.source_path("script"), "script")
+
+        chmod_dir("script")
       end
     end
 
     def setup_staging_environment
       say(set_color("Setting up the staging environment...", :cyan))
-      build(:setup_staging_environment)
+
       capture_stdout do
+        copy_file("config/environments/blank.rb", "config/environments/staging.rb", force: true)
       end
     end
 
     def setup_production_environment
       say(set_color("Setting up the production environment...", :cyan))
-      build(:setup_production_environment)
+
       capture_stdout do
+        copy_file("config/environments/blank.rb", "config/environments/production.rb", force: true)
       end
     end
 
     def setup_test_environment
       say(set_color("Setting up the test environment...", :cyan))
-      build(:setup_test_environment)
+
+      capture_stdout do
+        copy_file("config/environments/blank.rb", "config/environments/test.rb", force: true)
+      end
     end
 
     def configure_app
       say(set_color("Configuring app...", :cyan))
 
       capture_stdout do
-        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
-
-      # 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)
-
-      # 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
+        # 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)
+
+        # 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.
         directory("lib/schemas/api/2023-03-06", "lib/schemas/api/2023-03-06")
-      end
 
-      # This is h
-      # 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)
+        # 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)
+        chmod_dir("bin")
 
-      say(set_color("\n*** All these upcoming `HEAD` errors are okay to ignore! ***\n", :cyan))
+        # we do this to specify the template source, otherwise the generator wants to use Rails' own dir
+        ["controllers", "jobs", "services", "views"].each do |dir|
+          source = File.join(Hephaestus::Engine.root, "templates", "app", dir)
+          directory(source, "app/#{dir}", force: true)
+        end
 
-      capture_stdout do
-        generate("hephaestus:core")
+        directory("db", "db")
 
-        generate("hephaestus:db")
-        generate("hephaestus:deployment")
-        generate("hephaestus:lib")
+        directory("vendor/fly", "vendor/fly")
+
+        directory("lib/tasks", "lib/tasks")
+
+        remove_file("config/credentials.yml.enc")
 
         # keep this at the end
-        generate("hephaestus:config")
+        directory("config", "config", force: true, exclude_pattern: /blank.rb/)
       end
     end
 
-    # 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)
+    # Think of this as the final step in the process
+    # started by `hephaestus_generator`. All the relevant commands are run in the context of the
+    # new app directory.
+    def finalize
+      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"))
+
+      replace_in_file(File.join("lib", "schemas", "api", "2023-03-06", "openapi.json"), %r{paths/app.json}, "paths/#{plug_name}.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"))
+
+      Dir.chdir(shell.base.result_dir) do
+        unless ENV.fetch("HEPHAESTUS_NO_EXTERNAL", "0") == "1"
+          say(set_color("Installing gems...", :cyan))
+          capture_stdout do
+            run("bundle install", abort_on_failure: false)
+            run("bundle update")
+            run("bundle lock --add-platform x86_64-linux")
+          end
+        end
 
-      say(set_color("Generating `hephaestus:license`...", :cyan))
-      capture_stdout do
-        generate("hephaestus:license")
-      end
+        result = nil
+        say(set_color("Generating `hephaestus:license`...", :cyan))
+        Bundler.with_unbundled_env do
+          capture_stdout do
+            capture_stderr do
+              result = run("script/licenses --update", quiet: true, abort_on_failure: false)
+            end
+          end
+        end
 
-      say(set_color("Generating `hephaestus:rubocop`...", :cyan))
-      capture_stdout do
-        generate("hephaestus:rubocop")
-      end
+        unless result
+          say(set_color("Error generating licenses. When Hephaestus finishes executing, run `script/licenses --update`.", :red))
+          sleep(3)
+        end
 
-      # say(set_color("Generating `hephaestus:sorbet`...", :cyan))
-      # capture_stdout do
-      #   generate("hephaestus:sorbet")
-      # end
+        # say(set_color("Generating `hephaestus:sorbet`...", :cyan))
+        #   Bundler.with_unbundled_env do
+        #     run("bundle exec tapioca init")
+        #     run("bundle exec tapioca require")
+        #     run("script/sorbet --update")
+        #   end
+
+        say(set_color("Generating `hephaestus:rubocop`...", :cyan))
+        Bundler.with_unbundled_env do
+          capture_stdout do
+            capture_stderr do
+              result = run("bundle exec rubocop -A", abort_on_failure: false)
+            end
+          end
+        end
 
-      say(set_color("Creating first commit...", :cyan))
-      capture_stdout do
-        invoke(:commit)
+        unless result
+          say(set_color("Could not run Rubocop. When Hephaestus finishes executing, run `bundle exec rubocop -A`.", :red))
+          sleep(3)
+        end
       end
-
-      invoke(:outro)
     end
 
-    def commit
-      run("git add .")
-      run("git commit -m 'Initial commit'", capture: true)
+    def first_commit
+      say(set_color("Creating first commit...", :cyan))
+
+      Dir.chdir(shell.base.result_dir) do
+        capture_stdout do
+          run("git init")
+          run("git remote add origin https://github.com/yettoapp/#{app_name}.git")
+          run("git branch -m production")
+
+          run("git add .")
+          run("git commit -m 'Initial commit'", capture: true)
+        end
+      end
     end
 
     def outro
@@ -239,13 +297,46 @@ module Hephaestus
       !options[:skip_active_record]
     end
 
-    private def capture_stdout
-      out = StringIO.new
-      $stdout = out
+    private def capture_stdout(&block)
+      capture_stream("stdout", &block)
+    end
+
+    private def capture_stderr(&block)
+      capture_stream("stderr", &block)
+    end
+
+    private def capture_stream(stream)
+      captured_stream = Tempfile.new(stream)
+      stream_io = eval("$#{stream}", binding, __FILE__, __LINE__) # rubocop:disable Security/Eval
+      origin_stream = stream_io.dup
+      stream_io.reopen(captured_stream)
+
       yield
-      out.string
-    ensure
-      $stdout = STDOUT
+
+      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?
+    end
+
+    private def chmod_dir(dir)
+      Dir.glob(File.join(destination_root, dir, "**", "*")).each do |file|
+        next if File.directory?(file)
+
+        # Rails adds this
+        if file == ".keep"
+          remove_file(file)
+          next
+        end
+
+        # this is because we might have *.tt templates, which aren't executable,
+        # so we gotta re-execute-em all
+        chmod(file, 0o755)
+      end
     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
@@ -33,14 +32,6 @@ module Hephaestus
 
       private
 
-      def app_name
-        Rails.app_class.module_parent_name.demodulize.underscore.dasherize
-      end
-
-      def short_app_name
-        app_name.sub(/plug-/i, "")
-      end
-
       def empty_directory_with_keep_file(destination)
         empty_directory(destination, {})
         keep_file(destination)

data/lib/hephaestus/version.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Hephaestus
-  VERSION = "0.8.12"
+  VERSION = "0.8.12.2"
   RAILS_VERSION = ">= 8.0"
   RUBY_VERSION = File
     .read("#{File.dirname(__FILE__)}/../../.ruby-version")

data/lib/hephaestus.rb

@@ -8,25 +8,17 @@ def debugging?
 end
 
 require "debug" if debugging?
+require "amazing_print" if debugging?
 
 require "hephaestus/version"
 require "hephaestus/engine"
-require "hephaestus/exit_on_failure"
 
 require "hephaestus/generators/app_generator"
-require "hephaestus/generators/config_generator"
-require "hephaestus/generators/core_generator"
-require "hephaestus/generators/db_generator"
-require "hephaestus/generators/deployment_generator"
-require "hephaestus/generators/lib_generator"
-require "hephaestus/generators/license_generator"
-require "hephaestus/generators/rubocop_generator"
-require "hephaestus/generators/sorbet_generator"
 
 require "hephaestus/actions"
 require "hephaestus/app_name"
+
 require "hephaestus/actions/strip_comments_action"
-require "hephaestus/app_builder"
 
 module Hephaestus
   class << self

data/templates/bin/bundle

@@ -41,7 +41,7 @@ m = Module.new do
 
   def gemfile
     gemfile = ENV["BUNDLE_GEMFILE"]
-    return gemfile if gemfile.present?
+    return gemfile if gemfile && !gemfile.empty? # rubocop:disable Rails/Present
 
     File.expand_path("../Gemfile", __dir__)
   end

data/templates/hephaestus_github/dependabot.yml

@@ -0,0 +1,27 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: weekly
+      day: monday
+      time: "09:00"
+      timezone: "Etc/UTC"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: monthly
+      day: monday
+      time: "09:00"
+      timezone: "Etc/UTC"
+    open-pull-requests-limit: 10
+    groups:
+      bundler-dependencies:
+        patterns:
+          - "*"

data/templates/hephaestus_github/workflows/automerge.yml

@@ -0,0 +1,14 @@
+name: PR auto-{approve,merge}
+
+on:
+  workflow_dispatch:
+  pull_request_target:
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  bot-check:
+    uses: yettoapp/actions/.github/workflows/automerge.yml@main
+    secrets: inherit

data/templates/hephaestus_github/workflows/deploy.yml

@@ -0,0 +1,30 @@
+name: Deployments
+on:
+  push:
+    branches:
+      - production
+  workflow_dispatch:
+    inputs:
+      target:
+        required: true
+        type: choice
+        description: The name of the environment that you're deploying the application to
+        options:
+          - staging
+          - production
+      forced:
+        description: "Whether to perform the deploy regardless of test state."
+        required: false
+        type: boolean
+        default: false
+
+jobs:
+  deployment:
+    name: Deploy app
+    uses: yettoapp/actions/.github/workflows/fly_deployment.yml@main
+    with:
+      target: ${{ github.event_name != 'workflow_dispatch' && 'production' || inputs.target }}
+      forced: ${{ github.event_name == 'workflow_dispatch' && inputs.forced || false }}
+    secrets:
+      gh_token: ${{ secrets.GH_DEPLOYMENTS_TOKEN }}
+      fly_token: ${{ inputs.target == 'staging' && secrets.FLY_STAGING_API_TOKEN || secrets.FLY_PRODUCTION_API_TOKEN }}