rsg 0.0.1

data/lib/rsg/generators/orm/templates/active_record/mysql.yml

@@ -0,0 +1,59 @@
+# MySQL. Versions 5.5.8 and up are supported.
+#
+# Install the MySQL driver
+#   gem install mysql2
+#
+# Ensure the MySQL gem is defined in your Gemfile
+#   gem 'mysql2'
+#
+# And be sure to use new-style password hashing:
+#   https://dev.mysql.com/doc/refman/5.7/en/password-hashing.html
+#
+default: &default
+  adapter: mysql2
+  encoding: utf8mb4
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  username: root
+  password:
+<% if mysql_socket -%>
+  socket: <%= mysql_socket %>
+<% else -%>
+  host: localhost
+<% end -%>
+
+development:
+  <<: *default
+  database: <%= app_name %>_development
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: <%= app_name %>_test
+
+# As with config/credentials.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password or a full connection URL as an environment
+# variable when you boot the app. For example:
+#
+#   DATABASE_URL="mysql2://myuser:mypass@localhost/somedatabase"
+#
+# If the connection URL is provided in the special DATABASE_URL environment
+# variable, Rails will automatically merge its configuration values on top of
+# the values provided in this file. Alternatively, you can specify a connection
+# URL environment variable explicitly:
+#
+#   production:
+#     url: <%%= ENV['MY_APP_DATABASE_URL'] %>
+#
+# Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full overview on how database connection configuration can be specified.
+#
+production:
+  <<: *default
+  database: <%= app_name %>_production
+  username: <%= app_name %>
+  password: <%%= ENV['<%= app_name.upcase %>_DATABASE_PASSWORD'] %>

data/lib/rsg/generators/orm/templates/active_record/postgresql.yml

@@ -0,0 +1,86 @@
+# PostgreSQL. Versions 9.3 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On macOS with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On macOS with MacPorts:
+#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem 'pg'
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # https://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+development:
+  <<: *default
+  database: <%= app_name %>_development
+
+  # The specified database role being used to connect to postgres.
+  # To create additional roles in postgres see `$ createuser --help`.
+  # When left blank, postgres will use the default role. This is
+  # the same name as the operating system user running Rails.
+  #username: <%= app_name %>
+
+  # The password associated with the postgres role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: <%= app_name %>_test
+
+# As with config/credentials.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password or a full connection URL as an environment
+# variable when you boot the app. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# If the connection URL is provided in the special DATABASE_URL environment
+# variable, Rails will automatically merge its configuration values on top of
+# the values provided in this file. Alternatively, you can specify a connection
+# URL environment variable explicitly:
+#
+#   production:
+#     url: <%%= ENV['MY_APP_DATABASE_URL'] %>
+#
+# Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full overview on how database connection configuration can be specified.
+#
+production:
+  <<: *default
+  database: <%= app_name %>_production
+  username: <%= app_name %>
+  password: <%%= ENV['<%= app_name.upcase %>_DATABASE_PASSWORD'] %>

data/lib/rsg/generators/orm/templates/active_record/sqlite3.yml

@@ -0,0 +1,25 @@
+# SQLite. Versions 3.8.0 and up are supported.
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/lib/rsg/generators/orm/templates/db.rake

@@ -0,0 +1,7 @@
+namespace :db do
+  desc "Generate sample data for the application"
+  task sample: :environment do
+    raise "Can't run in production" if Rails.env.production? || ENV["FORCE_SAMPLE"]
+    load Rails.root.join("db/samples.rb")
+  end
+end

data/lib/rsg/generators/orm/templates/samples.rb

@@ -0,0 +1,10 @@
+# This file should contain all the record creation needed to populate sample data to use the application. The
+# data created here differs from the data created in db/seeds.rb as we don't expect the script to be idempotent
+# and assume that the script might be executed multiple times.
+#
+# The data can then be loaded with the bin/rails db:sample command.
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/lib/rsg/generators/orm/templates/seeds.rb

@@ -0,0 +1,9 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
+#
+# NOTE: This script should be idempotent!
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

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

@@ -0,0 +1,33 @@
+require_relative "../base"
+
+module Rsg
+  module Testing
+    class RspecGenerator < Generators::Base
+      def banner
+        say "Configuring rspec"
+      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 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 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
+  end
+end

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

@@ -0,0 +1,51 @@
+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"
+
+ root 'landing#show'
+        CODE
+      end
+    end
+  end
+end

data/lib/rsg/generators/webpacker/templates/application.js

@@ -0,0 +1,18 @@
+/* eslint no-console:0 */
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application logic in
+// a relevant structure within app/javascript and only use these pack files to reference
+// that code so it'll be compiled.
+//
+// To reference this file, add <%= javascript_pack_tag 'application' %> to the appropriate
+// layout file, like app/views/layouts/application.html.erb
+
+
+// Uncomment to copy all static images under ../images to the output folder and reference
+// them with the image_pack_tag helper in views (e.g <%= image_pack_tag 'rails.png' %>)
+// or the `imagePath` JavaScript helper below.
+//
+// const images = require.context('../images', true)
+// const imagePath = (name) => images(name, true)
+
+import "../stylesheets/application.sass";

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

@@ -0,0 +1,19 @@
+// This is a manifest file that'll be compiled into application.css.
+
+// If want to use a CSS framework, you can add it to Webpacker by following the instructions to load the
+// framework as an NPM module using yarn, typically `yarn add <framework>`.
+// The framework should have instructions on importing it into a SASS / SCSS file.
+
+// For application specific styles, you are encouraged to just write them below. As it grows, you can
+// extract into logically grouped files under `app/javascript/stylesheets/*.sass` and `import` them here.
+//
+// Example:
+//   @import "reset.sass"
+//   @import "global.sass"
+//   @import "components.sass"
+//   ...
+
+// This is just for the automagically generated landing page, feel free to remove once you change that page
+// to something that makes sense to your application.
+pre
+  color: #444

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

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

data/lib/rsg/generators/webpacker/templates/landing_show.html.erb

@@ -0,0 +1,8 @@
+<br>
+<pre>
+Hello, it's <%= Time.now.as_json %> now!
+
+You're running Rails <%= @rails_version %> and you've generated the app using RSG <%= @rsg_version %>.
+
+You probably want to change this file, which lives at `app/views/landing/show.html.erb`
+</pre>

data/lib/rsg/version.rb

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

data/lib/rsg.rb

@@ -0,0 +1,36 @@
+require_relative "rsg/version"
+
+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"
+
+module Rsg
+  def self.app_templates_sources
+    @app_templates_sources ||= [
+      Pathname.new(__FILE__).dirname.join("../templates").expand_path
+    ]
+  end
+
+  def self.lookup_app_template(template_name)
+    return if template_name =~ %r{^https?\://}
+    return if File.exists?(template_name)
+
+    app_templates_sources.each do |src|
+      template = "#{src}/#{template_name}.rb"
+      return template if File.exists?(template)
+    end
+
+    return nil
+  end
+end

data/rsg.gemspec

@@ -0,0 +1,28 @@
+require_relative "lib/rsg/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rsg"
+  spec.version = Rsg::VERSION
+  spec.authors = ["Doximity Engineering"]
+  spec.email = ["engineering@doximity.com"]
+
+  spec.summary = "A custom generator that scaffolds Rails apps with Doximity conventions baked in"
+  spec.homepage = "https://github.com/doximity/rsg"
+  spec.license = "Apache-2.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", Rsg::RAILS_VERSION
+end

data/templates/README.md

@@ -0,0 +1,4 @@
+# Application templates
+
+This is a folder that contains the default template alongside other ways of
+configuring apps on top of the base app generated by default by RSG.

data/templates/rsg-default.rb

@@ -0,0 +1,17 @@
+# Default RSG template, the one that gets executed when none is specified
+
+run "bundle check || bundle install"
+git_add_commit "Rails app generated with rsg v#{Rsg::VERSION}, api_mode=#{options["api"]}"
+
+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_generate "rsg:logging:lograge"
+rsg_generate "rsg:testing:rspec"

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rsg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Doximity Engineering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+description: 
+email:
+- engineering@doximity.com
+executables:
+- rsg
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rsg
+- lib/rsg.rb
+- lib/rsg/generators/actions.rb
+- lib/rsg/generators/app/USAGE
+- lib/rsg/generators/app/app_builder.rb
+- lib/rsg/generators/app/app_generator.rb
+- lib/rsg/generators/app/templates/README.md.erb
+- lib/rsg/generators/base.rb
+- 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/misc/misc_generator.rb
+- lib/rsg/generators/misc/templates/puma.rb
+- 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/testing/rspec_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/landing_controller.rb.erb
+- lib/rsg/generators/webpacker/templates/landing_show.html.erb
+- lib/rsg/version.rb
+- rsg.gemspec
+- templates/README.md
+- templates/rsg-default.rb
+homepage: https://github.com/doximity/rsg
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/doximity/rsg
+  source_code_uri: https://github.com/doximity/rsg
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A custom generator that scaffolds Rails apps with Doximity conventions baked
+  in
+test_files: []