rails_app_generator 0.1.28 → 0.2.0

data/lib/rails_app_generator/app_generator.rb

@@ -5,158 +5,6 @@
 module RailsAppGenerator
   #  AppGenerator is a wrapper for Rails::AppGenerator
   class AppGenerator < Rails::Generators::AppGenerator
-    class_option :test                        , type: :string , default: 'rspec'
-
-    # Gem                              Current  Latest   Requested  Groups
-    # aws-sdk
-    # capistrano-bundler               1.6.0    2.1.0    ~> 1.2     development, test
-    # capybara                         3.33.0   3.37.1   = 3.33.0   development, test
-    # clamby                           1.6.6    1.6.8    = 1.6.6    default
-    # createsend                       5.1.1    6.0.0    ~> 5.1     default
-    # database_cleaner                 1.7.0    2.0.1    = 1.7.0    development, test
-    # erubi                            1.10.0   1.11.0
-    # factory_bot                      5.2.0    6.2.1
-    # factory_bot_rails                5.2.0    6.2.0    = 5.2.0    development, test
-    # guard-bundler                    2.2.1    3.0.0    = 2.2.1    development, test
-    # guard-rubocop                    1.4.0    1.5.0    = 1.4.0    development, test
-    # http-accept                      1.7.0    2.2.0
-    # net-ssh                          6.1.0    7.0.1
-    # oauth2                           1.4.10   2.0.6
-    # omniauth-oauth2                  1.7.3    1.8.0
-    # paper_trail                      10.3.1   12.3.0   ~> 10.3    default
-    # pg                               0.21.0   1.4.2    ~> 0.20    default
-    # pg_search                        2.3.0    2.3.6    ~> 2.0     default
-    # pry                              0.13.1   0.14.1
-    # public_suffix                    2.0.5    5.0.0    ~> 2.0     default
-    # pusher                           1.4.3    2.0.2    ~> 1.3     default
-    # rack-mini-profiler               0.10.7   3.0.0    ~> 0.10    default
-    # rack-test                        0.6.3    2.0.2
-    # rails                            5.0.7.2  7.0.3.1  = 5.0.7.2  default
-    # railties                         5.0.7.2  7.0.3.1
-    # ransack                          1.8.10   3.2.1    ~> 1.8     default
-    # redis                            3.3.5    4.7.1    ~> 3.3     default
-    # redis-store                      1.6.0    1.9.1
-    # regexp_parser                    1.8.2    2.5.0
-    # rspec                            3.10.0   3.11.0
-    # rspec-core                       3.10.1   3.11.0   = 3.10.1   development, test
-    # rspec-expectations               3.10.1   3.11.0   = 3.10.1   development, test
-    # rspec-mocks                      3.10.2   3.11.1   = 3.10.2   development, test
-    # rspec-rails                      4.1.2    5.1.2    = 4.1.2    development, test
-    # rspec-support                    3.10.2   3.11.0   = 3.10.2   development, test
-    # rubyzip                          1.3.0    2.3.2    ~> 1.3     default
-    # scenic                           1.5.4    1.6.0    = 1.5.4    default
-    # scout_apm                        4.1.2    5.2.0    ~> 4.1     default
-    # selenium-webdriver               3.142.7  4.3.0    = 3.142.7  development, test
-    # shoulda-matchers                 4.0.1    5.1.0    = 4.0.1    development, test
-    # sidekiq                          4.2.10   6.5.1    ~> 4.2     default
-    # sidekiq-pool                     1.9.3    2.0.1    ~> 1.8     default
-    # sidekiq-unique-jobs              6.0.25   7.1.27   ~> 6.0     default
-    # spring                           2.1.1    4.0.0    ~> 2.0     development, test
-    # sprockets                        3.7.2    4.1.1    ~> 3.7     default
-    # sprockets-rails                  3.2.2    3.4.2
-    # timecop                          0.8.1    0.9.5    = 0.8.1    development, test
-    # tzinfo                           1.2.10   2.0.5
-    # uglifier                         3.2.0    4.2.0    ~> 3.2     default
-    # unicorn                          5.8.0    6.1.0    ~> 5.3     default
-    # webmock                          3.13.0   3.16.0   = 3.13.0   development, test
-    # websocket-driver                 0.6.5    0.7.5
-
-    # acts_as_list         0.9.19   1.0.4    ~> 0.9     default
-    # arel                 7.1.4    9.0.0
-    # bigdecimal           1.4.4    3.1.2    ~> 1.4     development, test
-    # binding_of_caller    0.8.0    1.0.0    ~> 0.8     default
-    # browser              2.7.1    5.3.1    ~> 2.3     default
-    # capistrano-bundler   1.6.0    2.1.0    ~> 1.2     development, test
-    # capybara             3.33.0   3.37.1   = 3.33.0   development, test
-    # chartkick            2.3.5    4.2.0    ~> 2.3     default
-    # childprocess         3.0.0    4.1.0
-    # clamby               1.6.6    1.6.8    = 1.6.6    default
-    # createsend           5.1.1    6.0.0    ~> 5.1     default
-    # database_cleaner     1.7.0    2.0.1    = 1.7.0    development, test
-    # factory_bot          5.2.0    6.2.1
-    # factory_bot_rails    5.2.0    6.2.0    = 5.2.0    development, test
-    # faker                1.9.6    2.22.0   ~> 1.7     default
-    # groupdate            4.3.0    6.1.0    ~> 4.1     default
-    # guard-bundler        2.2.1    3.0.0    = 2.2.1    development, test
-    # guard-rubocop        1.4.0    1.5.0    = 1.4.0    development, test
-    # hashie               3.6.0    5.0.0
-    # http-accept          1.7.0    2.1.1
-    # k_log                0.0.18   0.0.33   = 0.0.18   development, test
-    # net-ssh              6.1.0    7.0.1
-    # oauth2               1.4.10   2.0.6
-    # omniauth-oauth2      1.7.3    1.8.0
-    # paper_trail          10.3.1   12.3.0   ~> 10.3    default
-    # pg                   0.21.0   1.4.2    ~> 0.20    default
-    # pg_search            2.3.0    2.3.6    ~> 2.0     default
-    # pry                  0.13.1   0.14.1
-    # public_suffix        2.0.5    5.0.0    ~> 2.0     default
-    # pusher               1.4.3    2.0.2    ~> 1.3     default
-    # rack-mini-profiler   0.10.7   3.0.0    ~> 0.10    default
-    # rack-test            0.6.3    2.0.2
-    # rails                5.0.7.2  7.0.3.1  = 5.0.7.2  default
-    # railties             5.0.7.2  7.0.3.1
-    # ransack              1.8.10   3.2.1    ~> 1.8     default
-    # redis                3.3.5    4.7.1    ~> 3.3     default
-    # redis-store          1.6.0    1.9.1
-    # regexp_parser        1.8.2    2.5.0
-    # rspec                3.10.0   3.11.0
-    # rspec-core           3.10.1   3.11.0   = 3.10.1   development, test
-    # rspec-expectations   3.10.1   3.11.0   = 3.10.1   development, test
-    # rspec-mocks          3.10.2   3.11.1   = 3.10.2   development, test
-    # rspec-rails          4.1.2    5.1.2    = 4.1.2    development, test
-    # rspec-support        3.10.2   3.11.0   = 3.10.2   development, test
-    # rubyzip              1.3.0    2.3.2    ~> 1.3     default
-    # scenic               1.5.4    1.6.0    = 1.5.4    default
-    # scout_apm            4.1.2    5.2.0    ~> 4.1     default
-    # selenium-webdriver   3.142.7  4.3.0    = 3.142.7  development, test
-    # shoulda-matchers     4.0.1    5.1.0    = 4.0.1    development, test
-    # sidekiq              4.2.10   6.5.1    ~> 4.2     default
-    # sidekiq-pool         1.9.3    2.0.1    ~> 1.8     default
-    # sidekiq-unique-jobs  6.0.25   7.1.27   ~> 6.0     default
-    # spring               2.1.1    4.0.0    ~> 2.0     development, test
-    # sprockets            3.7.2    4.1.1    ~> 3.7     default
-    # sprockets-rails      3.2.2    3.4.2
-    # timecop              0.8.1    0.9.5    = 0.8.1    development, test
-    # tzinfo               1.2.10   2.0.5
-    # uglifier             3.2.0    4.2.0    ~> 3.2     default
-    # unicorn              5.8.0    6.1.0    ~> 5.3     default
-    # webmock              3.13.0   3.14.0   = 3.13.0   development, test
-    # websocket-driver     0.6.5    0.7.5
-
-    class_option :add_irbrc                   , type: :boolean, default: false
-    class_option :add_foreman                 , type: :boolean, default: false
-    class_option :add_devise                  , type: :boolean, default: false
-    class_option :add_dotenv                  , type: :boolean, default: false
-    class_option :add_docker                  , type: :boolean, default: false
-    class_option :add_docker_compose          , type: :boolean, default: false
-    class_option :add_rubocop                 , type: :boolean, default: false
-    class_option :add_annotate                , type: :boolean, default: false
-    class_option :add_continuous_integration  , type: :boolean, default: false
-    class_option :add_high_voltage            , type: :boolean, default: false
-    class_option :add_generators              , type: :boolean, default: false
-    class_option :add_lograge                 , type: :boolean, default: false
-    class_option :add_pundit                  , type: :boolean, default: false
-    class_option :add_services                , type: :boolean, default: false
-    class_option :add_sidekiq                 , type: :boolean, default: false
-    class_option :add_views                   , type: :boolean, default: false
-    class_option :add_errors                  , type: :boolean, default: false
-    class_option :add_scaffold                , type: :boolean, default: false
-    class_option :add_factory_bot             , type: :boolean, default: false
-    class_option :add_shoulda                 , type: :boolean, default: false
-
-    # NEW GEM ADDONS
-    class_option :add_acts_as_list            , type: :boolean, default: false
-    class_option :add_browser                 , type: :boolean, default: false
-    class_option :add_chartkick               , type: :boolean, default: false
-    class_option :add_faker                   , type: :boolean, default: false
-    class_option :add_groupdate               , type: :boolean, default: false
-    class_option :add_hexapdf                 , type: :boolean, default: false
-    class_option :add_httparty                , type: :boolean, default: false
-    class_option :add_honeybadger             , type: :boolean, default: false
-    class_option :add_mini_magick             , type: :boolean, default: false
-    class_option :add_rails_html_sanitizer    , type: :boolean, default: false
-    class_option :add_twilio_ruby             , type: :boolean, default: false
-
     class << self
       # points to the original rails templates
       attr_writer :rails_template_path
@@ -179,6 +27,35 @@ module RailsAppGenerator
         @addon_template_path ||= gem_template_path('rails_app_generator', 'templates/addons/%<addon>s')
       end
 
+      def add_class_option(option)
+        find_name = option.name.to_s
+        existing_option = class_options.find { |class_option| class_option[1].name == find_name }
+
+        return if existing_option
+
+        args = {
+          type: option.type,
+          default: option.default,
+          required: option.required
+        }
+
+        # for some reason, Railties uses :desc while thor uses :description and thor has nice humanization when key is missing
+        args[:desc] = option.description unless option.description
+
+        class_option(option.name, **args)
+      end
+
+      def to_h
+        thor_options = class_options.map { |o| o[1] }
+        options_hash = RailsAppGenerator::Util.thor_options_to_hash(thor_options)
+
+        # class_options_detailed: options_hash,
+        {
+          class_option_keys: options_hash.map { |option| option[:name] },
+          class_options: options_hash.map { |option| option.slice(:name, :description, :type, :default, :required) }
+        }
+      end
+
       private
 
       def gem_template_path(gem_name, template_path)
@@ -202,16 +79,11 @@ module RailsAppGenerator
 
     attr_reader :addon_instances
 
-    # attr_reader :before_bundle_addon_callbacks
-    # attr_reader :after_bundle_addon_callbacks
-
     def initialize(*args)
       super
 
       @force_copy = false
       @addon_instances = []
-      # @before_bundle_addon_callbacks = []
-      # @after_bundle_addon_callbacks = []
 
       # puts '----------------------------------------------------'
       # puts options
@@ -271,6 +143,8 @@ module RailsAppGenerator
     # end
 
     def create_root_files
+      RailsAppGenerator::Util.write_last_run('app_generator_data.json', to_h)
+
       super
 
       add_if(:irbrc)
@@ -331,6 +205,12 @@ module RailsAppGenerator
     end
 
     no_commands do
+      def to_h
+        {
+          options: options
+        }
+      end
+
       # https://codingpackets.com/blog/rails-generators-cheat-sheet/
 
       # OLD style will be removed soon

data/lib/rails_app_generator/cli/profile.rb

@@ -26,7 +26,9 @@ module RailsAppGenerator
         args          = profile[:args]
         opts          = RailsAppGenerator::RailsOptions.new(profile[:opts])
 
-        starter       = RailsAppGenerator::Starter.new(args)
+        RailsAppGenerator::Util.write_last_run('rails_options_data.json', opts.to_h)
+
+        starter = RailsAppGenerator::Starter.new(args)
 
         starter.delete_target_folder
         starter.start(opts)

data/lib/rails_app_generator/configuration/rag_configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Structure for storing Rails Application Generator configuration
+  class RagConfiguration
+    # include KLog::Logging
+
+    attr_reader :options
+
+    def initialize
+      @options = []
+    end
+
+    def add_option(name, **args)
+      @options << RailsAppGenerator::BuildOption.new(name, **args)
+    end
+  end
+end

data/lib/rails_app_generator/configuration/rag_configuration_extension.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Register this configuration access extension for Rag configuration
+  module RagConfigurationExtension
+    def rag
+      return @rag if defined? @rag
+
+      @rag = RagConfiguration.new
+    end
+  end
+end
+
+KConfig::Configuration.register(:rag, RailsAppGenerator::RagConfigurationExtension)

data/lib/rails_app_generator/options/build_option.rb

@@ -6,17 +6,12 @@ module RailsAppGenerator
   # This class maps closely (but not exactly) to Thor's options
   # The pattern is not exactly the same, it is easy to map the options
   # you need from other generators such as: railties/lib/rails/generators/app_base.rb
-  #
-  # @example
-  # class_option    :skip_git, type: :boolean, default: false, desc: "Skip .gitignore file"
-  # becomes
-  # register_option :skip_git, type: :boolean, default: false, desc: "Skip .gitignore file"
   class BuildOption
-    attr_reader :name, :desc, :type, :default, :required, :mapper
+    attr_reader :name, :description, :type, :default, :required, :mapper
 
-    def initialize(**args)
-      @name = args[:name]
-      @desc = args[:desc] || ''
+    def initialize(name, **args)
+      @name = name
+      @description = args[:description] || ''
       @type = args[:type] || :string
       @required = args.fetch(:required, false)
       @default = args[:default] || sane_default
@@ -27,6 +22,16 @@ module RailsAppGenerator
 
     def cmd_option(value); end
 
+    def to_h
+      {
+        name: name,
+        description: description,
+        type: type,
+        default: default,
+        required: required
+      }
+    end
+
     private
 
     def sane_default

data/lib/rails_app_generator/options/options_builder.rb

@@ -21,34 +21,76 @@ module RailsAppGenerator
         @class_options_lookup ||= {}
       end
 
-      # Future options are placeholders for options that are not yet implemented
-      def future_option(name, **args); end
-
       # Register an option with the builder, this method has the same signature as Thor.
       #
       # This is so options can be used interchangeably between OptionsBuilder and Thor.
       def class_option(name, **args)
-        return if class_options_lookup.key?(name)
+        option = BuildOption.new(name, args)
+
+        add_class_option(option)
+      end
 
-        option = BuildOption.new(**{ name: name }.merge(args))
+      def add_class_option(option)
+        if class_options_lookup.key?(option.name)
+          # raise ArgumentError, "Option #{option.name} already registered"
+          puts "Option #{option.name} already registered"
+          return
+        end
 
-        class_options_lookup[name] = option
+        class_options_lookup[option.name.to_sym] = option
         class_options << option
       end
 
+      def add_thor_class_option(thor_option)
+        args = {
+          description: thor_option.description,
+          type: thor_option.type,
+          default: thor_option.default,
+          required: thor_option.required
+        }
+        option = BuildOption.new(thor_option.name, args)
+
+        add_class_option(option)
+      end
+
       def reset
         @class_options = nil
         @class_options_lookup = nil
       end
+
+      def to_h
+        {
+          class_option_keys: class_options.map(&:name),
+          class_options: class_options.map(&:to_h)
+        }
+      end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def cmd_line_options
-      self.class.class_options.map do |option|
+      available_options = options.clone
+
+      result = self.class.class_options.map do |option|
         mapper = option.mapper
-        value = options[option.name]
+        key = option.name.to_sym
+        value = options[key]
+        available_options.delete(key)
+        # if available_options.delete(option.name.to_sym)
+        #   puts "option IS  registered: #{option.name}"
+        # else
+        #   puts "option not registered: #{option.name}"
+        # end
+
         mapper.map(option.name, value)
       end.reject(&:blank?)
+
+      return result if available_options.empty?
+
+      puts "options not registered: #{available_options.keys.join(', ')}"
+      result
+      # raise 'Unknown options'
     end
+    # rubocop:enable Metrics/AbcSize
 
     def debug
       puts '[ Options JSON ]----------------------------------------------------'
@@ -57,10 +99,16 @@ module RailsAppGenerator
       puts cmd_line_options
     end
 
+    def to_h
+      {
+        options: options
+      }
+    end
+
     private
 
     def default_options
-      self.class.class_options.to_h { |option| [option.name, option.default] }
+      self.class.class_options.to_h { |option| [option.name.to_sym, option.default] }
     end
   end
 end

data/lib/rails_app_generator/options/rails_options.rb

@@ -2,74 +2,12 @@
 
 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
-    class_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('/')})"
-    class_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"
-    class_option    :skip_test                  , type: :boolean, default: false              # , desc: "Skip test files"
-    class_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]"
-    class_option    :css                        , type: :string                               # , desc: "Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass... check https://github.com/rails/cssbundling-rails]"
-    class_option    :skip_bundle                , type: :boolean, default: false              # , desc: "Don't run bundle install"
-
-    class_option    :add_irbrc                  , type: :boolean, default: false
-    class_option    :add_foreman                , type: :boolean, default: false
-    class_option    :add_devise                 , type: :boolean, default: false
-    class_option    :add_dotenv                 , type: :boolean, default: false
-    class_option    :add_docker                 , type: :boolean, default: false
-    class_option    :add_docker_compose         , type: :boolean, default: false
-    class_option    :add_rubocop                , type: :boolean, default: false
-    class_option    :add_annotate               , type: :boolean, default: false
-    class_option    :add_continuous_integration , type: :boolean, default: false
-    class_option    :add_high_voltage           , type: :boolean, default: false
-    class_option    :add_generators             , type: :boolean, default: false
-    class_option    :add_lograge                , type: :boolean, default: false
-    class_option    :add_pundit                 , type: :boolean, default: false
-    class_option    :add_services               , type: :boolean, default: false
-    class_option    :add_sidekiq                , type: :boolean, default: false
-    class_option    :add_views                  , type: :boolean, default: false
-    class_option    :add_errors                 , type: :boolean, default: false
-    class_option    :add_scaffold               , type: :boolean, default: false
-    class_option    :add_factory_bot            , type: :boolean, default: false
-    class_option    :add_shoulda                , type: :boolean, default: false
-
-    # NEW GEM ADDONS
-    class_option    :add_acts_as_list           , type: :boolean, default: false
-    class_option    :add_browser                , type: :boolean, default: false
-    class_option    :add_chartkick              , type: :boolean, default: false
-    class_option    :add_faker                  , type: :boolean, default: false
-    class_option    :add_groupdate              , type: :boolean, default: false
-    class_option    :add_hexapdf                , type: :boolean, default: false
-    class_option    :add_httparty               , type: :boolean, default: false
-    class_option    :add_honeybadger            , type: :boolean, default: false
-    class_option    :add_mini_magick            , type: :boolean, default: false
-    class_option    :add_rails_html_sanitizer   , type: :boolean, default: false
-    class_option    :add_twilio_ruby            , type: :boolean, default: false
+    # FIND MORE TEMPLATES HERE
+    # https://railsbytes.com/public/templates
+    # http://www.railscomposer.com/
+    # https://github.com/RailsApps/rails-composer
+    # https://github.com/carbonfive/raygun-rails
+    # https://github.com/abhaynikam/boring_generators
 
     # if options[:minimal]
     #   self.options = options.merge(