mkbrut 0.1.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49cd2e6faac641d120b2648a5d40bb859e042494d483bda48c4637bfbe693b23
-  data.tar.gz: d72aeb805b18f85086b3f5476b4d658c073d1223e2c7e3d1b3fc65f78649b1b4
+  metadata.gz: e824bb238690c5bedee83be7104bc4a8a4e82c5a46fbf4aa75253e16c83ef036
+  data.tar.gz: 495469a00fc5fee4adf35057cd03cb6f942551c60954d8639b780fe2896d5aff
 SHA512:
-  metadata.gz: 43e48d2ae6524b03a1735530c90af8afb01c0635dd6e2f72c04bc3966fbddadc33379e0e7026c67d09b6ee52fccb17321a1515394d1126d9af804e7fe202e8f1
-  data.tar.gz: 307ae6b40477978aa51bf3031f8c58d2f9d9b99c51148e9c33303d33a8e9b79f7a8a1db3f4052ff0e84eacf78ffb12843f30e0558f95c51190574bb56cb1bbcc
+  metadata.gz: 6518144e68422c5673413ab1539a064721d3f230a6953b785dbb23056b03e8cc6ebdeb9ae02bd7b57aa8f21a854747396aa65b45e6b7d1c0269a79c639ccd7ab
+  data.tar.gz: d101e05f6d7afef6115be141f3307f8360bde7f1976ef1129ed3584cbd2fe6a502d721be27042afd7d296a3fd12a15974e79c5c3ff387d484bd8827a1a65b620

data/lib/mkbrut/app.rb

@@ -43,6 +43,18 @@ module MKBrut
           templates_dir:
         )
       end
+      app_options.segments.each do |segment|
+        case segment
+        when "heroku"
+          @segments << MKBrut::Segments::Heroku.new(
+            app_options:,
+            current_dir:,
+            templates_dir:
+          )
+        else
+          raise "Segment #{segment} is not supported"
+        end
+      end
     end
 
     def create!

data/lib/mkbrut/app_options.rb

@@ -1,5 +1,5 @@
 class MKBrut::AppOptions
-  attr_reader :app_name, :app_id, :prefix, :organization, :demo, :versions
+  attr_reader :app_name, :app_id, :prefix, :organization, :demo, :versions, :segments
 
   def initialize(
     app_name:,
@@ -9,7 +9,7 @@ class MKBrut::AppOptions
     organization: nil,
     demo: false,
     versions: nil,
-    **ignore
+    **rest
   )
     if app_name.nil?
       raise ArgumentError, "app_name is required"
@@ -22,6 +22,13 @@ class MKBrut::AppOptions
     @dry_run      = !!dry_run
     @demo         = !!demo
     @versions     =   versions
+    @segments     = rest.map { |key,value|
+      if key =~ /^segment-(.+)$/ && value
+        $1
+      else
+        nil
+      end
+    }.compact
   end
 
   def dry_run? = @dry_run

data/lib/mkbrut/cli.rb

@@ -28,7 +28,7 @@ module MKBrut
       1
     end
 
-    def show_help
+    def show_help(versions)
       @out.puts @option_parser
       @out.puts
       @out.puts "ARGUMENTS"
@@ -39,6 +39,14 @@ module MKBrut
       @out.puts
       @out.puts "  BRUT_CLI_RAISE_ON_ERROR - if set to 'true', any error will raise an exception instead of printing to stderr"
       @out.puts
+      @out.puts "BRUT VERSIONS"
+      @out.puts
+      @out.puts "   Your app will be set up to use these versions:"
+      @out.puts
+      @out.puts "     BrutRB  - #{versions.brut_version_specifier}"
+      @out.puts "     BrutJS  - #{versions.brut_js_version_specifier}"
+      @out.puts "     BrutCSS - #{versions.brut_css_version_specifier}"
+      @out.puts
 
     end
 
@@ -57,7 +65,18 @@ module MKBrut
         opts.accept(MKBrut::Organization) do |prefix|
           MKBrut::Organization.new(prefix)
         end
-        opts.banner = "Usage: mkbrut [options] app-name\n\n    Creates a new Brut-powered app\n\nOPTIONS\n\n"
+        opts.banner = [
+          "Usage: mkbrut [options] app-name",
+          "",
+          "    Creates a new Brut-powered app",
+          "",
+          "VERSION",
+          "",
+          "    #{MKBrut::VERSION}",
+          "",
+          "OPTIONS",
+          "",
+        ].join("\n")
 
         opts.on("-a", "--app-id=ID", MKBrut::AppId,
                 "App identifier, which must be able to be used as a hostname or other Internet identifier. Derived from your app name, if omitted")
@@ -70,8 +89,14 @@ module MKBrut
 
         opts.on("--dry-run", "Only show what would happen, don't actually do anything")
         opts.on("--[no-]demo", "Include, or not, additional files that demonstrate Brut's features (default is true for now")
+        {
+          "sidekiq" => "Use Sidekiq for background jobs",
+          "heroku" => "Use Heroku for container-based deployment",
+        }.each do |segment,description|
+          opts.on("--segment-#{segment}", description)
+        end
         opts.on("-h", "--help", "Show this help message") do
-          show_help
+          show_help(versions)
           exit
         end
       end

data/lib/mkbrut/segments/heroku.rb

@@ -0,0 +1,30 @@
+class MKBrut::Segments::Heroku < MKBrut::Base
+  def self.friendly_name = "Heroku-based Deployment"
+
+  def initialize(app_options:, current_dir:, templates_dir:)
+    @project_root  = current_dir / app_options.app_name
+    @templates_dir = templates_dir / "segments" / "Heroku"
+    @erb_binding   = MKBrut::ErbBindingDelegate.new(app_options)
+  end
+
+  def add!
+    operations = copy_files(@templates_dir, @project_root) + 
+                 other_operations
+
+    operations.each do |operation|
+      operation.call
+    end
+  end
+
+  def other_operations
+    [
+      MKBrut::Ops::AppendToFile.new(
+        file: @project_root / ".gitignore",
+        content: %{
+# These are generated by bin/deploy
+deploy/Dockerfile.*
+}
+      )
+    ]
+  end
+end

data/lib/mkbrut/segments.rb

@@ -3,5 +3,6 @@ module MKBrut
     autoload :BareBones, "mkbrut/segments/bare_bones"
     autoload :Demo, "mkbrut/segments/demo"
     autoload :Sidekiq, "mkbrut/segments/demo"
+    autoload :Heroku, "mkbrut/segments/heroku"
   end
 end

data/lib/mkbrut/version.rb

@@ -1,3 +1,3 @@
 module MKBrut
-  VERSION = "0.1.6"
+  VERSION = "0.2.7"
 end

data/lib/mkbrut.rb

@@ -14,4 +14,5 @@ module MKBrut
   autoload :Segments, "mkbrut/segments"
   autoload :Versions, "mkbrut/versions"
   autoload :PrefixedIO, "mkbrut/prefixed_io"
+  autoload :VERSION, "mkbrut/version"
 end

data/templates/segments/Heroku/bin/deploy

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.require
+require "pathname"
+require "brut/cli/apps/heroku_container_based_deploy"
+
+exit Brut::CLI.app(
+  Brut::CLI::Apps::HerokuContainerBasedDeploy,
+  project_root: Pathname($0).dirname / ".."
+)

data/templates/segments/Heroku/deploy/Dockerfile

@@ -0,0 +1,125 @@
+# This is a multi-stage build, meaning one image will be built that
+# has necessarily dev tools in it, and that image is used to create artifacts
+# that will be copied into the second build, which will create the image
+# you deploy to production.
+#
+# # Maintaing this file
+#
+# You own this file now.  While there could be a way to create it from
+# the Dockerfile.dx, for now, you'll need to stay on top of it:
+#
+# 1 - ensure the versions of Ruby match
+# 2 - ensure the versions of NodeJS match
+# 3 - ensure that anything you installed in Dockerfile.dx to make 
+#     the app work or to pre-generate assets is set up here as well.
+#     You are advised to make that setup identical.
+#
+# You can test this locally but using the `--plaform` flag to `bin/deploy deploy`
+# and running a container locally.  You'll need all infrastructure available
+# but it can be done to test things before you deploy. If you need to.
+
+# Use Ruby 3.4 as a base.
+FROM docker.io/library/ruby:3.4 AS base
+
+# bin/deploy will inject this value so that your app's GIT SHA1
+# is in the environment in production, thus allowing you to be more
+# sure of what's actually running.
+ARG app_git_sha1
+
+WORKDIR /brut-app
+
+# Install base packages
+#
+# - ca-certificates is needed for other installs 
+# - curl is needed generally for other installs and by Heroku
+# - gnupg is a PGP replacement used in making sure new APT repos work
+# - libjemalloc2 in theory speeds up Ruby
+# - lsb-release is used to generically access information for this OS's version
+# - wget allows us to copy/paste commands from vendors about how to install
+#   software even though it does the same thing as curl
+RUN apt-get update --quiet --yes && \
+    apt-get install --no-install-recommends --quiet --yes \
+      ca-certificates \
+      curl \
+      gnupg \
+      libjemalloc2 \
+      lsb-release \
+      rsync \
+      wget && \
+		rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Install the PostgreSQL client.  The latest version is not available
+# from Debian, so we set up our own. This should match what's in Dockerfile.dx
+# and ideally the version of Postgres used in production.
+#
+# Incancation is based on: https://www.postgresql.org/download/linux/debian/
+RUN sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+    wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+    apt-get update && \
+    apt-get --yes --quiet install postgresql-client-16 && \
+		rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Set basic env vars for production
+ENV RACK_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development" \
+    APP_GIT_SHA1="${app_git_sha1}"
+
+# This makes a new image that we'll throw away after building
+# needed artifacts.
+FROM base AS build
+
+# - build-essential is needed for almost any build tool we have to install
+# - git is needed to install some things
+# - libpq-dev is needed by postgres
+# - pkg-config is, I guess, not considered "essential" (as in build-essential),
+#   but still needed to install downstream stuff
+RUN apt-get update --quiet --yes && \
+    apt-get install --no-install-recommends --quiet --yes \
+			build-essential \
+			git \
+      libpq-dev \
+			pkg-config
+
+# Install NodeJS, per https://nodejs.org/en/download
+RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash && \
+    \. "$HOME/.nvm/nvm.sh" && \
+    nvm install 22 && \
+    node -v && nvm current && npm -v
+
+# Copy the app into the file, excluding the contents of .dockerignore
+COPY . .
+
+# Install RubyGems from app's Gemfile
+RUN bundle install --verbose && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
+
+# Install Node Modules from package.json
+RUN \. "$HOME/.nvm/nvm.sh" && \
+    nvm use default && \
+    npm clean-install --no-audit --no-fund --verbose
+
+# Build all assets
+RUN \. "$HOME/.nvm/nvm.sh" && \
+    nvm use default && \
+    bin/build-assets && \
+    rm -rf node_modules
+
+# We are now switching back to building the image that will be deployed.
+
+FROM base
+# Copy built artifacts from the throwaway image: gems, application
+COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --from=build /brut-app /brut-app
+
+# For security, set directories that will be written to be owned by non-root
+RUN groupadd --system --gid 1000 brut && \
+    useradd brut --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
+    chown -R brut:brut logs tmp
+USER 1000:1000
+
+# This is used to execute other commands.  When the app is run in production,
+# this script is used to run it.
+ENTRYPOINT ["/brut-app/deploy/docker-entrypoint"]
+

data/templates/segments/Heroku/deploy/heroku_config.rb

@@ -0,0 +1,26 @@
+# This contains settings for your Heroku setup.
+# You own and maintain this file.  It is required by
+# build/deploy
+class HerokuConfig
+
+  # Return a Hash oif additional images to run, beyond "web" and "release".
+  #
+  # The format of this Hash is:
+  #
+  # {
+  #   "«image name» => {
+  #     cmd: "«command line for Dockerfile RUN directive»",
+  #   }
+  # }
+  #
+  # For example, if you have the Sidekiq segment installed, `bin/run-sidekiq`
+  # runs Sidekiq, so you would return this hash:
+  #
+  # {
+  #   "sidekiq" => {
+  #     cmd: "bin/run-sidekiq",
+  #   }
+  # }
+  def self.additional_images = {}
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mkbrut
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Dave Copeland
@@ -76,6 +76,7 @@ files:
 - lib/mkbrut/segments.rb
 - lib/mkbrut/segments/bare_bones.rb
 - lib/mkbrut/segments/demo.rb
+- lib/mkbrut/segments/heroku.rb
 - lib/mkbrut/segments/sidekiq.rb
 - lib/mkbrut/version.rb
 - lib/mkbrut/versions.rb
@@ -178,6 +179,9 @@ files:
 - templates/segments/Demo/specs/front_end/pages/guestbook_page.spec.rb
 - templates/segments/Demo/specs/front_end/pages/guestbook_page/message_component.spec.rb
 - templates/segments/Demo/specs/front_end/pages/new_guestbook_message_page.spec.rb
+- templates/segments/Heroku/bin/deploy
+- templates/segments/Heroku/deploy/Dockerfile
+- templates/segments/Heroku/deploy/heroku_config.rb
 homepage: https://brutrb.com
 licenses: []
 metadata: {}