rails_app_generator 0.0.3 → 0.0.6

data/lib/rails_app_generator/notes/kw01.txt

@@ -0,0 +1,91 @@
+create
+create  README.md
+create  Rakefile
+create  .ruby-version
+create  config.ru
+create  Gemfile
+create  app
+create  app/assets/config/manifest.js
+create  app/assets/stylesheets/application.css
+create  app/channels/application_cable/channel.rb
+create  app/channels/application_cable/connection.rb
+create  app/controllers/application_controller.rb
+create  app/helpers/application_helper.rb
+create  app/jobs/application_job.rb
+create  app/mailers/application_mailer.rb
+create  app/models/application_record.rb
+create  app/views/layouts/application.html.erb
+create  app/views/layouts/mailer.html.erb
+create  app/views/layouts/mailer.text.erb
+create  app/assets/images
+create  app/assets/images/.keep
+create  app/controllers/concerns/.keep
+create  app/models/concerns/.keep
+create  bin
+create  bin/rails
+create  bin/rake
+create  bin/setup
+create  config
+create  config/routes.rb
+create  config/application.rb
+create  config/environment.rb
+create  config/cable.yml
+create  config/puma.rb
+create  config/storage.yml
+create  config/environments
+create  config/environments/development.rb
+create  config/environments/production.rb
+create  config/environments/test.rb
+create  config/initializers
+create  config/initializers/assets.rb
+create  config/initializers/content_security_policy.rb
+create  config/initializers/cors.rb
+create  config/initializers/filter_parameter_logging.rb
+create  config/initializers/inflections.rb
+create  config/initializers/new_framework_defaults_7_0.rb
+create  config/initializers/permissions_policy.rb
+create  config/locales
+create  config/locales/en.yml
+create  config/master.key
+create  config/boot.rb
+create  config/database.yml
+create  db
+create  db/seeds.rb
+create  lib
+create  lib/tasks
+create  lib/tasks/.keep
+create  lib/assets
+create  lib/assets/.keep
+create  log
+create  log/.keep
+create  public
+create  public/404.html
+create  public/422.html
+create  public/500.html
+create  public/apple-touch-icon-precomposed.png
+create  public/apple-touch-icon.png
+create  public/favicon.ico
+create  public/robots.txt
+create  tmp
+create  tmp/.keep
+create  tmp/pids
+create  tmp/pids/.keep
+create  tmp/cache
+create  tmp/cache/assets
+create  vendor
+create  vendor/.keep
+create  test/system
+create  test/system/.keep
+create  test/application_system_test_case.rb
+create  storage
+create  storage/.keep
+create  tmp/storage
+create  tmp/storage/.keep
+remove  config/initializers/cors.rb
+remove  config/initializers/new_framework_defaults_7_0.rb
+finish template
+run  bundle install
+run  bundle binstubs bundler
+rails  javascript:install:esbuild
+rails  turbo:install stimulus:install
+rails  css:install:bootstrap

data/lib/rails_app_generator/options/base_map_option.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Simple pass through mapper for options that do not yet have a mapper defined
+  class BaseMapOption
+    def option_name(name)
+      "--#{name.to_s.gsub('_', '-')}"
+    end
+  end
+end

data/lib/rails_app_generator/options/build_option.rb

@@ -47,9 +47,11 @@ module RailsAppGenerator
     def sane_mapper
       case type
       when :boolean
-        RailsAppGenerator::MapOptionBooleanFlag
+        RailsAppGenerator::MapOptionBooleanFlag.new
+      when :string
+        RailsAppGenerator::MapOptionString.new
       else
-        RailsAppGenerator::MapOptionValue
+        RailsAppGenerator::MapOptionIgnore.new
       end
     end
   end

data/lib/rails_app_generator/options/map_option_boolean_flag.rb

@@ -3,9 +3,9 @@
 module RailsAppGenerator
   # Map a boolean true to a command line flag in the format "--flag-name"
   # false is ignored
-  class MapOptionBooleanFlag
-    def self.map(name, value)
-      value == true ? "--#{name.to_s.gsub('_', '-')}" : ''
+  class MapOptionBooleanFlag < BaseMapOption
+    def map(name, value)
+      value == true ? option_name(name) : ''
     end
   end
 end

data/lib/rails_app_generator/options/{map_option_pass_through.rb → map_option_ignore.rb}

@@ -2,9 +2,9 @@
 
 module RailsAppGenerator
   # Simple pass through mapper for options that do not yet have a mapper defined
-  class MapOptionValue
-    def self.map(_name, value)
-      value
+  class MapOptionIgnore < BaseMapOption
+    def map(_name, _value)
+      nil
     end
   end
 end

data/lib/rails_app_generator/options/map_option_string.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Simple pass through mapper for options that do not yet have a mapper defined
+  class MapOptionString < BaseMapOption
+    def map(name, value)
+      return '' if value.nil? || value.empty?
+
+      value = value.to_s
+      value = "\"#{value}\"" if value.include?(' ')
+      "#{option_name(name)}=#{value}"
+    end
+  end
+end

data/lib/rails_app_generator/options/{build_options.rb → options_builder.rb}

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  #  Build options for RailsAppGenerator::Starter
-  class BuildOptions
+  # OptionBuilder can work standalone or as the base class
+  # for application generator options used by RailsAppGenerator::Starter
+  class OptionsBuilder
     attr_reader :options
 
     def initialize(opts)
@@ -20,6 +21,9 @@ module RailsAppGenerator
         @registered_options_lookup ||= {}
       end
 
+      # Future options are placeholders for options that are not yet implemented
+      def future_option(name, **args); end
+
       def register_option(name, **args)
         return if registered_options_lookup.key?(name)
 
@@ -43,6 +47,13 @@ module RailsAppGenerator
       end.reject(&:blank?)
     end
 
+    def debug
+      puts '[ Options JSON ]----------------------------------------------------'
+      puts JSON.pretty_generate(options)
+      puts '[ Options Command Line ]--------------------------------------------'
+      puts cmd_line_options
+    end
+
     private
 
     def default_options

data/lib/rails_app_generator/options/rails_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  class RailsOptions < OptionsBuilder
+    # NOTE: Currently you need to register new options in two places
+    #       here and in lib/rails_app_generator/app_generator.rb
+
+    future_option   :template                   , type: :string                               # , desc: "Path to some #{name} template (can be a filesystem path or URL)"
+    future_option   :database                   , type: :string , default: 'sqlite3'          # , desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+    register_option :skip_git                   , type: :boolean, default: false              # , desc: "Skip .gitignore file"
+    future_option   :skip_keeps                 , type: :boolean, default: false              # , desc: "Skip source control .keep files"
+    future_option   :skip_action_mailer         , type: :boolean, default: false              # , desc: "Skip Action Mailer files"
+    future_option   :skip_action_mailbox        , type: :boolean, default: false              # , desc: "Skip Action Mailbox gem"
+    future_option   :skip_action_text           , type: :boolean, default: false              # , desc: "Skip Action Text gem"
+    future_option   :skip_active_record         , type: :boolean, default: false              # , desc: "Skip Active Record files"
+    future_option   :skip_active_job            , type: :boolean, default: false              # , desc: "Skip Active Job"
+    future_option   :skip_active_storage        , type: :boolean, default: false              # , desc: "Skip Active Storage files"
+    future_option   :skip_action_cable          , type: :boolean, default: false              # , desc: "Skip Action Cable files"
+    future_option   :skip_asset_pipeline        , type: :boolean, default: false              #
+    future_option   :asset_pipeline             , type: :string , default: 'sprockets'        # , desc: "Choose your asset pipeline [options: sprockets (default), propshaft]"
+    future_option   :skip_javascript            , type: :boolean, default: false # name == 'plugin'   # , desc: "Skip JavaScript files"
+    future_option   :skip_hotwire               , type: :boolean, default: false              # , desc: "Skip Hotwire integration"
+    future_option   :skip_jbuilder              , type: :boolean, default: false              # , desc: "Skip jbuilder gem"
+    register_option :skip_test                  , type: :boolean, default: false              # , desc: "Skip test files"
+    register_option :test                       , type: :string , default: 'rspec'            # , desc: "minitest or rspec (default: rspec)"
+    future_option   :skip_system_test           , type: :boolean, default: false              # , desc: "Skip system test files"
+    future_option   :skip_bootsnap              , type: :boolean, default: false              # , desc: "Skip bootsnap gem"
+    future_option   :dev                        , type: :boolean, default: false              # , desc: "Set up the #{name} with Gemfile pointing to your Rails checkout"
+    future_option   :edge                       , type: :boolean, default: false              # , desc: "Set up the #{name} with Gemfile pointing to Rails repository"
+    future_option   :main                       , type: :boolean, default: false              # , desc: "Set up the #{name} with Gemfile pointing to Rails repository main branch"
+    future_option   :rc                         , type: :string , default: nil                # , desc: "Path to file containing extra configuration options for rails command"
+    future_option   :no_rc                      , type: :boolean, default: false              # , desc: "Skip loading of extra configuration options from .railsrc file"
+    future_option   :help                       , type: :boolean                              # , group: :rails               # , desc: "Show this help message and quit"
+    future_option   :version                    , type: :boolean                              # , group: :rails, desc: "Show Rails version number and quit"
+    future_option   :api                        , type: :boolean                              # , desc: "Preconfigure smaller stack for API only apps"
+    future_option   :minimal                    , type: :boolean                              # , desc: "Preconfigure a minimal rails app"
+    future_option   :javascript                 , type: :string , default: 'importmap'        # , desc: "Choose JavaScript approach [options: importmap (default), webpack, esbuild, rollup]"
+    register_option :css                        , type: :string                               # , desc: "Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass... check https://github.com/rails/cssbundling-rails]"
+    register_option :skip_bundle                , type: :boolean, default: false              # , desc: "Don't run bundle install"
+
+    register_option :add_irbrc                  , type: :boolean, default: false
+    register_option :add_foreman                , type: :boolean, default: false
+    register_option :add_dotenv                 , type: :boolean, default: false
+    register_option :add_docker                 , type: :boolean, default: false
+    register_option :add_docker_compose         , type: :boolean, default: false
+    register_option :add_rubocop                , type: :boolean, default: false
+    register_option :add_annotate               , type: :boolean, default: false
+    register_option :add_continuous_integration , type: :boolean, default: false
+    register_option :add_high_voltage           , type: :boolean, default: false
+    register_option :add_generators             , type: :boolean, default: false
+    register_option :add_lograge                , type: :boolean, default: false
+    register_option :add_pundit                 , type: :boolean, default: false
+    register_option :add_services               , type: :boolean, default: false
+    register_option :add_sidekiq                , type: :boolean, default: false
+    register_option :add_views                  , type: :boolean, default: false
+    register_option :add_errors                 , type: :boolean, default: false
+    register_option :add_scaffold               , type: :boolean, default: false
+    register_option :add_factory_bot            , type: :boolean, default: false
+    register_option :add_shoulda                , type: :boolean, default: false
+
+    # if options[:minimal]
+    #   self.options = options.merge(
+    #     skip_action_cable: true,
+    #     skip_action_mailer: true,
+    #     skip_action_mailbox: true,
+    #     skip_action_text: true,
+    #     skip_active_job: true,
+    #     skip_active_storage: true,
+    #     skip_bootsnap: true,
+    #     skip_dev_gems: true,
+    #     skip_javascript: true,
+    #     skip_jbuilder: true,
+    #     skip_system_test: true,
+    #     skip_hotwire: true).freeze
+    # end
+  end
+end

data/lib/rails_app_generator/starter.rb

@@ -29,56 +29,72 @@ module RailsAppGenerator
 
     attr_reader :app_path
     attr_reader :destination_root
+
+    # points to the original rails templates
     attr_reader :rails_template_path
-    attr_reader :custom_template_path
+
+    # points to the overriding templates related to rails
+    attr_reader :override_template_path
+
+    # points to templates related to rails addons
+    attr_reader :addon_template_path
+
+    attr_reader :console_output
 
     def initialize(**args)
-      @app_path = args[:app_path] || '.'
-      @destination_root = args[:destination_root] || Dir.pwd
-      @rails_template_path = args[:rails_template_path] || Rails::Generators::AppGenerator.source_root
-      @custom_template_path = args[:custom_template_path] || File.expand_path(File.join(__dir__, '../../templates'))
+      @app_path               = args[:app_path]                     || '.'
+      @destination_root       = args[:destination_root]             || Dir.pwd
+      @rails_template_path    = args[:rails_template_path]          || AppGenerator.rails_template_path
+      @override_template_path = args[:override_template_path]       || AppGenerator.override_template_path
+      @addon_template_path    = args[:addon_template_path]          || AppGenerator.addon_template_path
     end
 
     def target_path
       File.expand_path(File.join(destination_root, app_path))
     end
 
-    def start
+    def start(options = [])
       puts "Target path: #{target_path}"
 
-      RailsAppGenerator::AppGenerator.source_root(rails_template_path)
-      RailsAppGenerator::AppGenerator.source_paths << rails_template_path
-      RailsAppGenerator::AppGenerator.source_paths << custom_template_path
-
-      # opts = [
-      #   '--skip-namespace',
-      #   '--skip-collision-check',
-      #   '--skip-git',
-      #   '--skip-keeps',
-      #   '--skip-action-mailer',
-      #   '--skip-action-mailbox',
-      #   '--skip-action-text',
-      #   '--skip-active-record',
-      #   '--skip-active-job',
-      #   '--skip-active-storage',
-      #   '--skip-action-cable',
-      #   '--skip-asset-pipeline',
-      #   '--skip-javascript',
-      #   '--skip-hotwire',
-      #   '--skip-jbuilder',
-      #   '--skip-test',
-      #   '--skip-system-test',
-      #   '--skip-bootsnap',
-      #   '--skip-bundle'
-      # ]
-
-      opts = [
-        '--skip-git',
-        '--skip-test',
-        '--skip-bundle'
-      ]
-
-      RailsAppGenerator::AppGenerator.start ['.'] + opts, destination_root: destination_root
+      # RailsAppGenerator::AppGenerator.source_root(rails_template_path)
+      # # RailsAppGenerator::AppGenerator.source_paths << rails_template_path
+      # RailsAppGenerator::AppGenerator.source_paths << addon_template_path
+
+      opts = extract_rails_options(app_path, options)
+
+      @console_output = capture_console do
+        RailsAppGenerator::AppGenerator.start(opts, destination_root: destination_root)
+      end
+    end
+
+    private
+
+    def capture_console
+      $stdout = StringIO.new
+      yield
+      output = $stdout.string
+      $stdout.close
+      output
+    ensure
+      $stdout = STDOUT
+      $stdout.puts output
+    end
+
+    # Rails options returns a flat array of options
+    #
+    # It can work accept a flat array of options or a
+    # an object that implements cmd_line_options such as OptionsBuilder
+    #
+    # @param [Array<String>, OptionsBuilder] options
+    # @return [Array<String>]
+    def extract_rails_options(app_path, options)
+      opts = nil
+      opts = options.cmd_line_options if options.respond_to?(:cmd_line_options)
+      opts = options if options.is_a?(Array)
+
+      raise ArgumentError, 'options is required' unless opts
+
+      [app_path] + opts
     end
   end
 end

data/lib/rails_app_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  VERSION = '0.0.3'
+  VERSION = '0.0.6'
 end

data/lib/rails_app_generator.rb

@@ -10,13 +10,20 @@ require 'rails/generators/rails/app/app_generator'
 require 'bundler'
 
 require 'rails_app_generator/version'
-require 'rails_app_generator/options/map_option_pass_through'
+require 'rails_app_generator/options/base_map_option'
+require 'rails_app_generator/options/map_option_ignore'
+require 'rails_app_generator/options/map_option_string'
 require 'rails_app_generator/options/map_option_boolean_flag'
 require 'rails_app_generator/options/build_option'
-require 'rails_app_generator/options/build_options'
-require 'rails_app_generator/starter'
+require 'rails_app_generator/options/options_builder'
+require 'rails_app_generator/options/rails_options'
+require_relative 'rails_app_generator/context'
+require_relative 'rails_app_generator/dependencies'
+require_relative 'rails_app_generator/add_on'
+Dir[File.join(__dir__, 'rails_app_generator', 'addons', '*.rb')].sort.each { |file| require file }
 require 'rails_app_generator/app_builder'
 require 'rails_app_generator/app_generator'
+require 'rails_app_generator/starter'
 
 # require "rails_app_generator/generators/base"
 # require "rails_app_generator/generators/foo_generator"

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "rails_app_generator",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "rails_app_generator",
-      "version": "0.0.3",
+      "version": "0.0.6",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_app_generator",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "Create new Rails Application with custom opinions",
   "scripts": {
     "release": "semantic-release"

data/templates/addons/annotate/auto_annotate_models.rake

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+if Rails.env.development?
+  require 'annotate'
+  # rubocop:disable Metrics/BlockLength
+  task set_annotation_options: :environment do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults(
+      'active_admin' => 'false',
+      'additional_file_patterns' => [],
+      'routes' => 'false',
+      'models' => 'true',
+      'position_in_routes' => 'before',
+      'position_in_class' => 'before',
+      'position_in_test' => 'before',
+      'position_in_fixture' => 'before',
+      'position_in_factory' => 'before',
+      'position_in_serializer' => 'before',
+      'show_foreign_keys' => 'true',
+      'show_complete_foreign_keys' => 'false',
+      'show_indexes' => 'true',
+      'simple_indexes' => 'false',
+      'model_dir' => 'app/models',
+      'root_dir' => '',
+      'include_version' => 'false',
+      'require' => '',
+      'exclude_tests' => 'true',
+      'exclude_fixtures' => 'true',
+      'exclude_factories' => 'true',
+      'exclude_serializers' => 'true',
+      'exclude_scaffolds' => 'true',
+      'exclude_controllers' => 'true',
+      'exclude_helpers' => 'true',
+      'exclude_sti_subclasses' => 'false',
+      'ignore_model_sub_dir' => 'false',
+      'ignore_columns' => nil,
+      'ignore_routes' => nil,
+      'ignore_unknown_models' => 'false',
+      'hide_limit_column_types' => 'integer,bigint,boolean',
+      'hide_default_column_types' => 'json,jsonb,hstore',
+      'skip_on_db_migrate' => 'false',
+      'format_bare' => 'true',
+      'format_rdoc' => 'false',
+      'format_yard' => 'false',
+      'format_markdown' => 'false',
+      'sort' => 'false',
+      'force' => 'false',
+      'frozen' => 'false',
+      'classified_sort' => 'true',
+      'trace' => 'false',
+      'wrapper_open' => nil,
+      'wrapper_close' => nil,
+      'with_comment' => 'true'
+    )
+  end
+  # rubocop:enable Metrics/BlockLength
+
+  Annotate.load_tasks
+end

data/templates/addons/continuous_integration/.github/workflows/build.yml.erb

@@ -0,0 +1,49 @@
+name: <%= camelized %> CI 🚀
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    env:
+      RAILS_ENV: test
+      DATABASE_HOST: localhost
+      DATABASE_USERNAME: <%= app_name %>
+      DATABASE_PASSWORD: <%= app_name %>
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_PASSWORD: <%= app_name %>
+          POSTGRES_USER: <%= app_name %>
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: <%= RUBY_VERSION %>
+          bundler-cache: true
+      - name: Set up Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.9
+      - name: Install dependencies
+        run: |
+          sudo apt-get -yqq install libpq-dev build-essential libcurl4-openssl-dev
+          gem install bundler
+          bundle install --jobs 4
+          yarn install
+      - name: Setup databases
+        run: |
+          bin/rails db:setup
+      - name: Run tests
+        run: bin/rails test

data/templates/addons/devise/app/views/devise/confirmations/new.html.erb

@@ -0,0 +1,24 @@
+<% content_for :devise_form do %>
+
+  <h2 class="pt-4 mb-8 text-4xl font-bold heading">Resend confirmation instructions</h2>
+
+  <%= form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: { method: :post }) do |f| %>
+    <%= render "devise/shared/error_messages", resource: resource %>
+
+    <div class="input-group">
+      <%= f.label :email, class: "label" %>
+      <%= f.email_field :email, autofocus: true, autocomplete: "email", value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email), class: "input" %>
+    </div>
+
+    <div class="input-group">
+      <%= f.submit "Resend confirmation instructions", class: "btn btn-default" %>
+    </div>
+  <% end %>
+
+  <hr class="mt-6 border" />
+
+  <%= render "devise/shared/links" %>
+
+<% end %>
+
+<%= render "devise/shared/form_wrap" %>

data/templates/addons/devise/app/views/devise/passwords/edit.html.erb

@@ -0,0 +1,34 @@
+<% content_for :devise_form do %>
+  <h2 class="pt-4 mb-8 text-4xl font-bold heading">Change your password</h2>
+
+  <%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %>
+    <%= render "devise/shared/error_messages", resource: resource %>
+    <%= f.hidden_field :reset_password_token %>
+
+    <div class="input-group">
+      <div class="flex">
+        <%= f.label :password, "New password", class:"label" %>
+        <% if @minimum_password_length %>
+          <em>(<%= @minimum_password_length %> characters minimum)</em>
+        <% end %>
+      </div>
+      <%= f.password_field :password, autofocus: true, autocomplete: "new-password", class: "input" %>
+    </div>
+
+    <div class="input-group">
+      <%= f.label :password_confirmation, "Confirm new password", class: "label" %>
+      <%= f.password_field :password_confirmation, autocomplete: "off", class: "input" %>
+    </div>
+
+    <div class="input-group">
+      <%= f.submit "Change my password", class: "btn btn-default" %>
+    </div>
+  <% end %>
+
+  <hr class="mt-6 border" />
+
+  <%= render "devise/shared/links" %>
+
+<% end %>
+
+<%= render "devise/shared/form_wrap" %>

data/templates/addons/devise/app/views/devise/passwords/new.html.erb

@@ -0,0 +1,23 @@
+<% content_for :devise_form do %>
+
+  <h2 class="pt-4 mb-8 text-4xl font-bold heading">Forgot your password?</h2>
+
+  <%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :post }) do |f| %>
+    <%= render "devise/shared/error_messages", resource: resource %>
+
+    <div class="input-group">
+      <%= f.label :email, class: "label" %>
+      <%= f.email_field :email, autofocus: true, autocomplete: "email", class: "input" %>
+    </div>
+
+    <div class="input-group">
+      <%= f.submit "Send me reset password instructions", class: "btn btn-default" %>
+    </div>
+  <% end %>
+
+  <hr class="mt-6 border" />
+
+  <%= render "devise/shared/links" %>
+<% end %>
+
+<%= render "devise/shared/form_wrap" %>