rsg 0.0.1 → 0.1.0

data/lib/rsg/generators/misc/misc_generator.rb

@@ -1,20 +1,34 @@
-require_relative "../base"
+class Rsg::Generators::Misc::MiscGenerator < Rsg::Generators::Base
+  def banner
+    say "Making some extra tweaks"
+  end
+
+  def remove_assets
+    run "rm -rf app/assets"
+  end
+
+  def remove_gemfile_comments
+    gsub_file "Gemfile", /^ *#\s*[^#\n]+\n/, ""
+  end
+
+  def remove_tzinfo_gem
+    # Remove tzinfo-data since we don't have a need for it in dev / prod env, if
+    # rsg becomes a thing on the platforms it's needed we can revisit
+    gsub_file "Gemfile", /\ngem 'tzinfo-data'[^\n]+\n/, ""
+  end
 
-module Rsg
-  module Misc
-    class MiscGenerator < Generators::Base
-      def self.source_root
-        Pathname.new(__FILE__).dirname.join("templates").expand_path
-      end
+  def remove_gemfile_extra_whitespace
+    gsub_file "Gemfile", /^( *gem[^\n]+)\n\n\n/, "\\1\n\n"
+  end
 
-      def banner
-        say "Making some extra tweaks"
-      end
+  def isolate_rails_gem
+    gsub_file "Gemfile", /^( *)(gem ["']rails["'][^\n]+)\n(?: *)(gem ['"]puma['"][^\n]+)\n$/, "\\1\\2\n\n\\3"
+  end
 
-      def disable_assets_generators
-        return if api_mode?
+  def disable_assets_generators
+    return if api_mode?
 
-        inject_into_file "config/application.rb", <<-CODE, before: /^\s*# Don't generate system test files./
+    inject_into_file "config/application.rb", <<-CODE, before: /^\s*# Don't generate system test files./
 
     # Don't generate CSS files when using scaffolding commands, since we compile assets through webpacker
     config.generators.assets = false
@@ -24,38 +38,33 @@ module Rsg
     # Most of time we can get away with a handful of methods in the default application_helper. Other ones
     # can be introduced as needed
     config.generators.helper = false
-       CODE
-      end
-
-      def configure_pry
-        append_gem "pry-rails", within_group: :development
-      end
+      CODE
+  end
 
-      def remove_assets
-        run "rm -rf app/assets"
-      end
+  def configure_pry
+    append_gem "pry-rails", within_group: :development
+  end
 
-      # TODO: Skip puma on app generator, introduce a new Puma::InstallGenerator
-      def puma_configs
-        copy_file "puma.rb", "config/puma.rb", force: true
-      end
+  # TODO: Skip puma on app generator, introduce a new Puma::InstallGenerator
+  def puma_configs
+    copy_file "puma.rb", "config/puma.rb", force: true
+  end
 
-      # TODO: Move to an i18n generator that does this and more
-      def configure_environments
-        # If by any chance we make use of translations, let them fail and get
-        # caught early on the dev process
-        uncomment_lines "config/environments/development.rb", /raise_on_missing_translations/
-        uncomment_lines "config/environments/test.rb", /raise_on_missing_translations/
-      end
+  # TODO: Move to an i18n generator that does this and more
+  def configure_environments
+    # If by any chance we make use of translations, let them fail and get
+    # caught early on the dev process
+    uncomment_lines "config/environments/development.rb", /raise_on_missing_translations/
+    uncomment_lines "config/environments/test.rb", /raise_on_missing_translations/
+  end
 
-      def healthcheck
-        inject_into_file "config/routes.rb", <<-CODE, before: "end"
+  # TODO: Move to rsg-dox
+  def healthcheck
+    inject_into_file "config/routes.rb", <<-CODE, before: "end"
 
   # Defines a static healthcheck for probes. Please note that this won't
   # output any logs in production
   get :healthcheck, to: proc { [200, {}, ['OK']] }
-        CODE
-      end
-    end
+    CODE
   end
 end

data/lib/rsg/generators/orm/active_record_generator.rb

@@ -1,44 +1,50 @@
-require_relative "../base"
+class Rsg::Generators::Orm::ActiveRecordGenerator < Rsg::Generators::Base
+  include Rails::Generators::Database
 
-module Rsg
-  module Orm
-    class ActiveRecordGenerator < Generators::Base
-      include Rails::Generators::Database
+  SUPPORTED_DBS = %w(sqlite3 mysql postgres)
+  class_option :database, type: :string, default: nil, desc: "Configure for selected database (options: #{SUPPORTED_DBS.join("/")})"
+  class_option :auto_migrate, type: :boolean, default: nil, desc: "Automatically run rake db:migrate"
 
-      SUPPORTED_DBS = %w(sqlite3 mysql postgres)
-      class_option :database, type: :string, default: nil, desc: "Configure for selected database (options: #{SUPPORTED_DBS.join("/")})"
-
-      def self.source_root
-        Pathname.new(__FILE__).dirname.join("templates").expand_path
-      end
+  def self.source_root
+    Pathname.new(__FILE__).dirname.join("templates").expand_path
+  end
 
-      def banner
-        say "Configuring active record"
-      end
+  def self.source_paths
+    @__source_paths ||= [
+      Rails::Generators::AppGenerator.source_root,
+      Pathname.new(__FILE__).dirname.join("templates").expand_path
+    ]
+  end
 
-      def enable_active_record
-        enable_railtie "active_record"
-      end
+  def banner
+    say "Configuring active record"
+  end
 
-      def configure_driver
-        database = options.fetch(:database) { ask("Which database you'd like to use?", limited_to: SUPPORTED_DBS, default: "sqlite3") }
-        template "active_record/#{database}.yml", "config/database.yml"
+  def enable_active_record
+    enable_railtie "active_record"
+  end
 
-        name, version = gem_for_database(database)
-        append_gem name, version: version
-      end
+  def configure_driver
+    database ||= options.fetch(:database) { ask("Which database you'd like to use?", limited_to: SUPPORTED_DBS, default: "sqlite3") }
+    # From the core rails template
+    template "config/databases/#{database}.yml", "config/database.yml"
 
-      def write_db_sample
-        copy_file "db.rake", "lib/tasks/db.rake"
-        copy_file "seeds.rb", "db/seeds.rb"
-        copy_file "samples.rb", "db/samples.rb"
-      end
+    name, version = gem_for_database(database)
+    append_gem name, version: version
+  end
 
-      def migrate
-        return if no?("Would you like to create the database schema?")
+  def write_db_sample
+    copy_file "db.rake", "lib/tasks/db.rake"
+    copy_file "seeds.rb", "db/seeds.rb"
+    copy_file "samples.rb", "db/samples.rb"
+  end
 
-        rake "db:create db:migrate"
-      end
+  def migrate
+    if options.key?(:auto_migrate)
+      rake "db:create db:migrate" if options[:auto_migrate]
+      return
     end
+
+    rake "db:create db:migrate" unless no?("Would you like to create the database schema?")
   end
 end

data/lib/rsg/generators/testing/rspec_generator.rb

@@ -1,33 +1,27 @@
-require_relative "../base"
-
-module Rsg
-  module Testing
-    class RspecGenerator < Generators::Base
-      def banner
-        say "Configuring rspec"
-      end
+class Rsg::Generators::Testing::RspecGenerator < Rsg::Generators::Base
+  def banner
+    say "Configuring rspec"
+  end
 
-      def add_rspec
-        append_gem "rspec-rails", within_group: [:development, :test]
-      end
+  def add_rspec
+    append_gem "rspec-rails", within_group: [:development, :test]
+  end
 
-      def gitignore
-        append_file ".gitignore", "\n# Ignore rspec state\n/spec/examples.txt\n"
-      end
+  def gitignore
+    append_file ".gitignore", "\n# Ignore rspec state\n/spec/examples.txt\n"
+  end
 
-      def install
-        generate("rspec:install")
-      end
+  def install
+    generate("rspec:install")
+  end
 
-      def enable_recommendations
-        gsub_file "spec/spec_helper.rb", /^# The settings below[^=]+=begin\n(.+)\n=end/m, '\1'
-      end
+  def enable_recommendations
+    gsub_file "spec/spec_helper.rb", /^# The settings below[^=]+=begin\n(.+)\n=end/m, '\1'
+  end
 
-      def no_ci_focus
-        gsub_file "spec/spec_helper.rb", /^  config\.filter_run_when_matching :focus$/ do
-          "  if ENV.key?(\"CI\")\n    config.filter_run_when_matching :focus\n  end"
-        end
-      end
+  def no_ci_focus
+    gsub_file "spec/spec_helper.rb", /^  config\.filter_run_when_matching :focus$/ do
+      "  if ENV.key?(\"CI\")\n    config.filter_run_when_matching :focus\n  end"
     end
   end
 end

data/lib/rsg/generators/webpacker/bootstrap_generator.rb

@@ -0,0 +1,27 @@
+class Rsg::Generators::Webpacker::BootstrapGenerator < Rsg::Generators::Base
+  def sanity_check
+    raise "Can't configure bootstrap on API apps" if api_mode?
+  end
+
+  def banner
+    say("Configuring Bootstrap")
+  end
+
+  def add_bootstrap
+    return say("Bootstrap already installed, skipping") if File.read("yarn.lock") =~ /^bootstrap[^:]+:/
+    run "yarn add bootstrap bootstrap-icons"
+  end
+
+  def application_sass
+    copy_file "bootstrap/application.sass", "app/javascript/stylesheets/application.sass"
+  end
+
+  def htmls
+    # TODO: These will ask to confirm for an overwrite, should we just force?
+    template "bootstrap/layout.html.erb", "app/views/layouts/application.html.erb"
+    template "bootstrap/landing.html.erb", "app/views/landing/show.html.erb"
+    # template "bootstrap/about.html.erb", "app/views/landing/about.html.erb"
+    # template "bootstrap/contact.html.erb", "app/views/landing/contact.html.erb"
+    # template "bootstrap/login.html.erb", "app/views/landing/login.html.erb"
+  end
+end

data/lib/rsg/generators/webpacker/install_generator.rb

@@ -1,51 +1,41 @@
-require_relative "../base"
-
-module Rsg
-  module Webpacker
-    class InstallGenerator < Generators::Base
-      def self.source_root
-        Pathname.new(__FILE__).dirname.join("templates").expand_path
-      end
-
-      def sanity_check
-        raise "Can't configure webpacker on API apps yet" if api_mode?
-      end
-
-      def banner
-        say("Configuring webpacker")
-      end
-
-      def add_webpacker
-        append_gem("webpacker", version: "~> 5.0")
-      end
-
-      def install_webpacker
-        rake("webpacker:install")
-      end
-
-      def configure_js
-        copy_file "application.js", "app/javascript/packs/application.js", force: true
-
-        inject_into_file "app/views/layouts/application.html.erb",
-          "  <%= javascript_pack_tag 'application' %>\n  ",
-          before: /<\/body>/
-      end
-
-      def configure_sass
-        copy_file "application.sass", "app/javascript/stylesheets/application.sass"
-        gsub_file "app/views/layouts/application.html.erb",
-          "stylesheet_link_tag",
-          "stylesheet_pack_tag"
-      end
-
-      def configure_landing
-        template "landing_controller.rb.erb", "app/controllers/landing_controller.rb"
-        copy_file "landing_show.html.erb", "app/views/landing/show.html.erb"
-        inject_into_file "config/routes.rb", <<-CODE, before: "end"
+class Rsg::Generators::Webpacker::InstallGenerator < Rsg::Generators::Base
+  def sanity_check
+    raise "Can't configure webpacker on API apps" if api_mode?
+  end
+
+  def banner
+    say("Configuring webpacker")
+  end
+
+  def add_webpacker
+    append_gem("webpacker", version: "~> 5.0")
+  end
+
+  def install_webpacker
+    rake("webpacker:install")
+  end
+
+  def configure_js
+    copy_file "application.js", "app/javascript/packs/application.js", force: true
+
+    inject_into_file "app/views/layouts/application.html.erb",
+      "  <%= javascript_pack_tag 'application' %>\n  ",
+      before: /<\/body>/
+  end
+
+  def configure_sass
+    copy_file "application.sass", "app/javascript/stylesheets/application.sass"
+    gsub_file "app/views/layouts/application.html.erb",
+      "stylesheet_link_tag",
+      "stylesheet_pack_tag"
+  end
+
+  def configure_landing
+    template "landing_controller.rb.erb", "app/controllers/landing_controller.rb"
+    copy_file "landing_show.html.erb", "app/views/landing/show.html.erb"
+    inject_into_file "config/routes.rb", <<-CODE, before: "end"
 
  root 'landing#show'
-        CODE
-      end
-    end
+    CODE
   end
 end

data/lib/rsg/generators/webpacker/templates/bootstrap/application.sass

@@ -0,0 +1,40 @@
+// This is a manifest file that'll be compiled into application.css.
+
+@import "bootstrap"
+
+$bootstrap-icons-font-src: url("~bootstrap-icons/font/fonts/bootstrap-icons.woff2") format("woff2"), url("~bootstrap-icons/font/fonts/bootstrap-icons.woff") format("woff")
+@import "bootstrap-icons/font/bootstrap-icons.scss"
+
+.bd-placeholder-img
+  font-size: 1.125rem
+  text-anchor: middle
+  -webkit-user-select: none
+  -moz-user-select: none
+  user-select: none
+
+@media (min-width: 768px)
+  .bd-placeholder-img-lg
+    font-size: 3.5rem
+
+.nav
+  .nav-link
+    padding: .25rem 0
+    font-weight: 700
+    color: rgba(255, 255, 255, .5)
+    background-color: transparent
+    border-bottom: .25rem solid transparent
+
+  .nav-link:hover,
+  .nav-link:focus
+    border-bottom-color: rgba(255, 255, 255, .25)
+
+  .nav-link + .nav-link
+    margin-left: 1rem
+
+  .active
+    color: #fff
+    border-bottom-color: #fff
+
+.landing-show
+  @extend .bg-dark
+  @extend .text-white

data/lib/rsg/generators/webpacker/templates/bootstrap/landing.html.erb

@@ -0,0 +1,18 @@
+<%%# https://getbootstrap.com/docs/5.1/examples/cover/ %>
+<main class="px-3 text-center">
+  <h1>
+    <i class="bi-gem"></i>
+    Welcome to <%= app_name.humanize %>!
+    <i class="bi-gem"></i>
+  </h1>
+  <p class="lead">
+    TODO: Some "lorem ipsum", show Rails and RSG versions
+  </p>
+  <p class="lead">
+    <a href="#" class="btn btn-lg btn-success fw-bold">
+      <i class="bi-currency-dollar"></i>
+      Call to action
+      <i class="bi-currency-dollar"></i>
+    </a>
+  </p>
+</main>

data/lib/rsg/generators/webpacker/templates/bootstrap/layout.html.erb

@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html class="h-100">
+  <head>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta charset="utf-8">
+    <%%= csrf_meta_tags %>
+    <%%= csp_meta_tag %>
+    <title><%= app_name.humanize %></title>
+    <%%= stylesheet_pack_tag 'application', media: 'all' %>
+  </head>
+
+  <body class="d-flex flex-column mx-auto h-100 w-100 bg-light <%%= controller_name.dasherize %>-<%%= action_name.dasherize %>">
+    <div class="bg-dark w-100 mb-auto">
+      <header class="container d-flex justify-content-between py-2">
+        <h3 class=" text-white"><%= app_name.humanize %></h3>
+        <nav class="nav justify-content-center ">
+          <a class="nav-link active" aria-current="page" href="#">Home</a>
+          <a class="nav-link" href="#">Features</a>
+          <a class="nav-link" href="#">Contact</a>
+        </nav>
+      </header>
+    </div>
+
+    <div class="container px-0 pt-3">
+      <%%= yield %>
+    </div>
+
+    <div class="bg-dark mt-auto py-3 text-center">
+      <footer class="container text-white-50">
+        © <%%= Date.today.year %> <%= app_name.humanize %>, inc.
+      </footer>
+    </div>
+    <%%= javascript_pack_tag 'application' %>
+  </body>
+</html>

data/lib/rsg/generators/webpacker/templates/landing_controller.rb.erb

@@ -1,6 +1,6 @@
 class LandingController < ApplicationController
   def show
-    @rails_version = Rails::VERSION
+    @rails_version = Rails.version
     @rsg_version = "<%= Rsg::VERSION %>"
   end
 end

data/lib/rsg/version.rb

@@ -1,4 +1,4 @@
 module Rsg
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
   RAILS_VERSION = "~> 6.1.4"
 end

data/lib/rsg.rb

@@ -1,19 +1,7 @@
-require_relative "rsg/version"
+require "zeitwerk"
 
-require_relative "rsg/generators/actions"
-require_relative "rsg/generators/options"
-require_relative "rsg/generators/base"
-
-require_relative "rsg/generators/app/app_generator"
-require_relative "rsg/generators/dotenv/install_generator"
-require_relative "rsg/generators/gemfile/cleanup_generator"
-require_relative "rsg/generators/install/install_generator"
-require_relative "rsg/generators/logging/common_generator"
-require_relative "rsg/generators/logging/lograge_generator"
-require_relative "rsg/generators/misc/misc_generator"
-require_relative "rsg/generators/orm/active_record_generator"
-require_relative "rsg/generators/testing/rspec_generator"
-require_relative "rsg/generators/webpacker/install_generator"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 module Rsg
   def self.app_templates_sources
@@ -34,3 +22,6 @@ module Rsg
     return nil
   end
 end
+
+# Required, or the classes for the generators won't be defined
+loader.eager_load

data/rsg.gemspec

@@ -25,4 +25,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", Rsg::RAILS_VERSION
+
+  # Rails already adds zeitwerk as a dependency but since we rely on it for
+  # autoloading constants we belive it is good to call it out
+  spec.add_dependency "zeitwerk"
 end

data/templates/rsg-bootstrap.rb

@@ -0,0 +1,7 @@
+# rsg --template rsg-bootstrap path/to/app
+rsg_apply_default!({
+  active_record: { auto_migrate: true },
+  webpacker: true,
+})
+
+rsg_generate "rsg:webpacker:bootstrap"

data/templates/rsg-default.rb

@@ -6,12 +6,19 @@ git_add_commit "Rails app generated with rsg v#{Rsg::VERSION}, api_mode=#{option
 say("Adding rsg gem to application")
 rsg_install
 
-rsg_generate "rsg:gemfile:cleanup"
 rsg_generate "rsg:misc:misc"
 rsg_generate "rsg:logging:common"
 rsg_generate "rsg:dotenv:install"
-rsg_generate "rsg:orm:active_record" if confirm?("Do you want to configure active_record?")
-rsg_generate "rsg:webpacker:install" unless options[:api]
+
+rsg_skip_or_confirm(:active_record, "Do you want to configure active_record?") do
+  rsg_generate "rsg:orm:active_record", rsg_options[:active_record]
+end
+
+if !options[:api]
+  rsg_skip_or_confirm(:webpacker, "Do you want to configure webpacker?") do
+    rsg_generate "rsg:webpacker:install"
+  end
+end
 
 rsg_generate "rsg:logging:lograge"
 rsg_generate "rsg:testing:rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Doximity Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.4
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - engineering@doximity.com
@@ -54,30 +68,30 @@ files:
 - lib/rsg/generators/dotenv/install_generator.rb
 - lib/rsg/generators/dotenv/templates/env.development
 - lib/rsg/generators/dotenv/templates/env.test
-- lib/rsg/generators/gemfile/cleanup_generator.rb
-- lib/rsg/generators/install/install_generator.rb
 - lib/rsg/generators/logging/common_generator.rb
 - lib/rsg/generators/logging/lograge_generator.rb
-- lib/rsg/generators/logging/templates/initializer_lograge.rb
+- lib/rsg/generators/logging/templates/initializer_lograge.rb.tt
 - lib/rsg/generators/misc/misc_generator.rb
-- lib/rsg/generators/misc/templates/puma.rb
+- lib/rsg/generators/misc/templates/puma.rb.tt
 - lib/rsg/generators/options.rb
 - lib/rsg/generators/orm/active_record_generator.rb
-- lib/rsg/generators/orm/templates/active_record/mysql.yml
-- lib/rsg/generators/orm/templates/active_record/postgresql.yml
-- lib/rsg/generators/orm/templates/active_record/sqlite3.yml
-- lib/rsg/generators/orm/templates/db.rake
-- lib/rsg/generators/orm/templates/samples.rb
-- lib/rsg/generators/orm/templates/seeds.rb
+- lib/rsg/generators/orm/templates/db.rake.tt
+- lib/rsg/generators/orm/templates/samples.rb.tt
+- lib/rsg/generators/orm/templates/seeds.rb.tt
 - lib/rsg/generators/testing/rspec_generator.rb
+- lib/rsg/generators/webpacker/bootstrap_generator.rb
 - lib/rsg/generators/webpacker/install_generator.rb
 - lib/rsg/generators/webpacker/templates/application.js
 - lib/rsg/generators/webpacker/templates/application.sass
+- lib/rsg/generators/webpacker/templates/bootstrap/application.sass
+- lib/rsg/generators/webpacker/templates/bootstrap/landing.html.erb
+- lib/rsg/generators/webpacker/templates/bootstrap/layout.html.erb
 - lib/rsg/generators/webpacker/templates/landing_controller.rb.erb
 - lib/rsg/generators/webpacker/templates/landing_show.html.erb
 - lib/rsg/version.rb
 - rsg.gemspec
 - templates/README.md
+- templates/rsg-bootstrap.rb
 - templates/rsg-default.rb
 homepage: https://github.com/doximity/rsg
 licenses: