rails_app_generator 0.0.5 → 0.0.8

data/lib/rails_app_generator/app_generator.rb

@@ -7,54 +7,84 @@ module RailsAppGenerator
   class AppGenerator < Rails::Generators::AppGenerator
     class_option :test, type: :string, default: 'rspec'
 
-    def initialize(*args)
-      super
-
-      puts '----------------------------------------------------'
-      puts options
-      puts '----------------------------------------------------'
-
-      # return unless options[:api]
-
-      # self.options = options.merge(
-      #   skip_errors: true,
-      #   skip_high_voltage: true,
-      #   skip_stimulus: true,
-      #   skip_tailwind: true,
-      #   skip_views: true
-      # ).freeze
-    end
-
-    def create_test_files
-      return if options[:skip_test]
-
-      super if options[:test] == 'minitest'
-      # puts options[:testing_framework]
-
-      # add(:rspec) if options[:testing_framework] == 'rspec'
+    class_option :add_irbrc                   , type: :boolean, default: false
+    class_option :add_foreman                 , 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
+
+    class << self
+      # points to the original rails templates
+      attr_writer :rails_template_path
+
+      def rails_template_path
+        @rails_template_path ||= gem_template_path('railties', 'lib/rails/generators/rails/app/templates')
+      end
+
+      # points to the custom templates related to rails
+      attr_writer :override_template_path
+
+      def override_template_path
+        @override_template_path ||= gem_template_path('rails_app_generator', 'templates')
+      end
+
+      # points to templates related to rails addons
+      attr_writer :addon_template_path
+
+      def addon_template_path
+        @addon_template_path ||= gem_template_path('rails_app_generator', 'templates/addons/%<addon>')
+      end
+
+      private
+
+      def gem_template_path(gem_name, template_path)
+        gem_path = gem_path(gem_name)
+
+        File.join(gem_path, template_path)
+      end
+
+      def gem_path(gem_name)
+        gem = Gem.loaded_specs[gem_name]
+        return gem.full_gem_path if gem
+
+        puts "gem not available for '#{gem_name}'"
+
+        return Dir.pwd if Dir.pwd.end_with?('dev/kgems/rails_app_generator') # code smell: this is for my local development environment
+
+        raise "'#{gem_name}' not available"
+      end
     end
 
-    # def create_root_files
+    # def initialize(*args)
     #   super
 
-    #   # add(:irbrc)
-    #   # add(:foreman)
-    #   # add(:dotenv)
-    #   # add(:docker)
-    #   # add(:docker_compose)
-    #   # add(:rubocop)
-    # end
-
-    # include KLog::Logging
+    #   # puts '----------------------------------------------------'
+    #   # puts options
+    #   # puts '----------------------------------------------------'
 
-    # def finish_template
-    #   puts 'finish template'
-    #   invoke :rails_customization
-    #   super
-    # end
+    #   # return unless options[:api]
 
-    # def fuck
-    #   puts 'fuckity'
+    #   # self.options = options.merge(
+    #   #   skip_errors: true,
+    #   #   skip_high_voltage: true,
+    #   #   skip_stimulus: true,
+    #   #   skip_tailwind: true,
+    #   #   skip_views: true
+    #   # ).freeze
     # end
 
     # def rails_customization
@@ -100,84 +130,142 @@ module RailsAppGenerator
     #   # generate("suspenders:advisories")
     # end
 
-    # private
+    def create_root_files
+      super
+
+      add_if(:irbrc)
+      add_if(:foreman)
+      add_if(:dotenv)
+      add_if(:docker)
+      add_if(:docker_compose)
+      add_if(:rubocop)
+    end
+
+    # def create_test_files
+    #   return if options[:skip_test]
+
+    #   super if options[:test] == 'minitest'
+
+    #   # puts options[:testing_framework]
+
+    #   # add(:rspec) if options[:testing_framework] == 'rspec'
+    # end
+
+    def finish_template
+      puts 'finish template'
+
+      add_if(:annotate)
+      add_if(:continuous_integration)
+      add_if(:high_voltage)
+      add_if(:generators)
+      add_if(:lograge)
+      add_if(:pundit)
+      add_if(:services)
+      add_if(:sidekiq)
+      add(:views, :errors, :scaffold) if options[:add_views]
+      add_if(:factory_bot)
+      add_if(:shoulda)
+
+      # invoke :rails_customization
+      super
+    end
 
-    # def run_rails_generator1
-    #   #   gem_path = Gem.loaded_specs["railties"].full_gem_path
-    #   #   # lib/rails/generators/rails/app/templates
-    #   #   templates_root = File.expand_path(File.join(gem_path, "lib/rails/generators/rails/app/templates"))
+    no_commands do
+      # USED BY AFTER_TEMPLATE
+      def gac(message)
+        return unless active?(:git)
 
-    #   # Rails::AppGenerator.source_root templates_root
-    #   # destination_root = "/Users/davidcruwys/dev/kweb/xmen"
+        git add: '.'
+        git commit: " -m '#{message}'"
+      end
 
-    #   # Rails::Generators::AppGenerator.start [output_folder, '--skip-bundle']
+      def add_controller(name, *args)
+        generate(:controller, name, *args)
+      end
 
-    #   gem_path = Gem.loaded_specs['suspenders'].full_gem_path
-    #   templates_root = File.expand_path(File.join(gem_path, 'templates'))
+      def add_scaffold(name, *args)
+        generate(:scaffold, name, *args)
+      end
 
-    #   Suspenders::AppGenerator.source_root templates_root
-    #   Suspenders::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+      def read_template(template_file)
+        path = find_in_source_paths(template_file)
 
-    #   puts '--------------------------------------------------------------'
-    #   puts "1 #{templates_root}"
-    #   puts "2 #{Suspenders::AppGenerator.source_root}"
-    #   puts "3 #{Suspenders::AppGenerator.source_paths}"
-    #   puts "4 #{Rails::Generators::AppGenerator.source_root}"
+        File.read(path)
+      end
 
-    #   opts = {}
+      def join_templates(*template_files, join: "\n\n")
+        template_files.map { |template_file| read_template(template_file) }.join(join)
+      end
 
-    #   # generator = KStarter::AppGenerator.new([folder], opts)
-    #   # generator.destination_root = destination_root
-    #   FileUtils.rm_rf(output_folder)
+      # Local template path is handy when you want template files used when working with the --template flag
+      attr_accessor :local_template_path
 
-    #   Suspenders::AppGenerator.start([output_folder, '--skip-bundle'])
-    # end
+      def source_paths
+        paths = local_template_path ? [local_template_path] : []
+        paths << context.rails_override_template_path
+        paths << context.rails_template_path
+        paths
+      end
 
-    # def run_rails_generator2
-    #   gem_path = Gem.loaded_specs['rails_app_generator'].full_gem_path
-    #   templates_root = File.expand_path(File.join(gem_path, 'templates'))
+      # Context wraps the configured options and can be made available to addons
+      # TODO: should I add local_template_path to the context?
+      def context
+        @context ||= Context.new(
+          self.class.rails_template_path,
+          self.class.override_template_path,
+          self.class.addon_template_path,
+          options
+        )
+      end
 
-    #   puts '--------------------------------------------------------------'
-    #   puts "1 #{templates_root}"
-    #   puts "2 #{Rails::Generators::AppGenerator.source_root}"
-    #   puts "3 #{Rails::Generators::AppGenerator.source_paths}"
-    #   puts "4 #{Rails::Generators::AppGenerator.source_root}"
+      def add(*addons)
+        addons.each do |addon|
+          addon = addon.to_s.capitalize.camelize
+          addon = "RailsAppGenerator::AddOns::#{addon}"
 
-    #   opts = {}
+          addon.constantize.apply(context)
+        end
+      end
 
-    #   # generator = KStarter::AppGenerator.new([folder], opts)
-    #   # generator.destination_root = destination_root
-    #   FileUtils.rm_rf(output_folder)
+      def add_if(addon)
+        option_name = "add_#{addon}".to_sym
+        add(addon) if options[option_name]
+      end
 
-    #   Rails::Generators::AppGenerator.start([output_folder, '--skip-bundle'])
-    # end
+      def skip_flag?(option_name)
+        value = options["skip_#{option_name}".to_sym]
 
-    # def dry_run
-    #   @dry_run_info = DryRunInfo.new(
-    #     output_folder: output_folder
-    #   )
+        return false if value.nil?
 
-    #   # Rails::Generators::AppGenerator.source_root(defaults_rails_templates)
+        value == true
+      end
 
-    #   opts = {}
+      def add_flag?(option_name)
+        value = options["add_#{option_name}".to_sym]
 
-    #   # KStarter::AppGenerator.source_root(defaults_rails_templates)
-    #   # Rails::Generators::AppGenerator
+        return false if value.nil?
 
-    #   generator = Rails::Generators::AppGenerator.new([output_folder], opts)
-    #   generator.app_path
-    #   # generator.destination_root = destination_root
-    #   # generator.destination_root
-    #   generator.source_paths
-    #   generator.class.source_root
-    #   # => ["/Users/davidcruwys/.asdf/installs/ruby/2.7.6/lib/ruby/gems/2.7.0/gems/railties-7.0.3.1/lib/rails/generators/rails/app/templates"]
-    #   # g.find_in_source_paths('README.MD')
+        value == true
+      end
 
-    #   # FileUtils.rm_rf(destination_root)
+      def active?(option_name)
+        add_flag?(option_name) || !skip_flag?(option_name)
+      end
 
-    #   # generator.destination_root
+      def uses?(addon)
+        return false unless active?(addon)
 
-    #   log.structure(dry_run_info)
-    # end
+        addon = AddOn.get(addon)
+        Dependencies.new(addon, context).satisfied?
+      end
+    end
+
+    protected
+
+    # rubocop:disable Naming/AccessorMethodName
+    def get_builder_class
+      RailsAppGenerator::AppBuilder
+    end
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

data/lib/rails_app_generator/context.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Context passes
+  class Context
+    attr_reader :rails_template_path
+    attr_reader :rails_override_template_path
+    attr_reader :addon_template_path
+
+    attr_reader :options
+
+    # Build a context object from the given arguments to be passed around within Rails Generator and AddOns.
+    #
+    # @param rails_template_path [String] The path to the Rails template.
+    # @param rails_override_template_path [String] This is the path to the templates that will override the default Rails templates.
+    # @param addon_template_path [String] The path to the addon's templates.
+    # @param options [Hash] A hash of options that can be used to customize the template. Defaults to {}
+    def initialize(rails_template_path, rails_override_template_path, addon_template_path, options = {})
+      @rails_template_path = rails_template_path
+      @rails_override_template_path = rails_override_template_path
+      @addon_template_path = addon_template_path
+
+      @options = options
+    end
+
+    def addons
+      AddOns.constants.select { |klass| AddOns.const_get(klass).is_a?(Class) }.map { |klass| AddOns.const_get(klass) }
+            .map(&:to_s) # .map(&:name) only works in Ruby 3.0+
+            .map(&:underscore)
+    end
+
+    # Skippable parts of the default Rails generator, e.g. active_record, active_job...
+    def default_addons
+      addon_options = addons.map { |option| "skip_#{option}".to_sym }
+      skip_options = RailsAppGenerator::AppGenerator.class_options.keys.grep(/skip_/)
+      (skip_options - addon_options).map { |option| option.to_s.delete_prefix('skip_').to_sym }
+    end
+
+    def debug
+      kv('rails_template_path', rails_template_path)
+      kv('rails_override_template_path', rails_override_template_path)
+      kv('addon_template_path', addon_template_path)
+
+      debug_default_addons
+      debug_addons
+      debug_options
+    end
+
+    private
+
+    def debug_default_addons
+      puts '-[ default_addons ]--------------------------------------------'
+      default_addons.each { |addon| puts addon }
+    end
+
+    def debug_addons
+      puts '-[ addons ]----------------------------------------------------'
+      addons.each { |addon| puts addon }
+    end
+
+    def debug_options
+      puts '-[ options ]----------------------------------------------------'
+      options.each { |key, value| kv(key, value) }
+    end
+
+    def kv(label, value, len = 35)
+      return ' ' * len if label.nil?
+
+      label = label.to_s if label.is_a?(Symbol)
+      label = label.length > len ? label.slice(0..len) : label.ljust(len, ' ')
+
+      puts "#{label}: #{value}"
+    end
+  end
+end

data/lib/rails_app_generator/dependencies.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # XXXX
+  class Dependencies
+    def initialize(addon, context)
+      @addon = addon
+      @context = context
+      @options = context.options
+    end
+
+    def satisfied?
+      @addon.dependencies.each do |dependency|
+        return false unless dependencies_satisfied?(dependency)
+      end
+
+      true
+    end
+
+    private
+
+    def dependencies_satisfied?(addon, visited = [])
+      return false if @options["skip_#{addon}".to_sym]
+
+      return true if @context.default_addons.include?(addon)
+
+      visited << addon
+      dependencies = AddOn.get(addon).dependencies - visited
+      dependencies.each do |dependency|
+        return false unless dependencies_satisfied?(dependency, visited)
+      end
+    end
+  end
+end

data/lib/rails_app_generator/notes/a1.txt

@@ -83,4 +83,4 @@ create  tmp/storage
 create  tmp/storage/.keep
 remove  config/initializers/cors.rb
 remove  config/initializers/new_framework_defaults_7_0.rb
-example at ./spec/lib/rails_app_generator/starter_spec.rb:110
+finish template

data/lib/rails_app_generator/notes/a2.txt

@@ -83,4 +83,4 @@ create  tmp/storage
 create  tmp/storage/.keep
 remove  config/initializers/cors.rb
 remove  config/initializers/new_framework_defaults_7_0.rb
-example at ./spec/lib/rails_app_generator/starter_spec.rb:110
+finish template

data/lib/rails_app_generator/notes/kw01-b.txt

@@ -0,0 +1,86 @@
+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

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/map_option_string.rb

@@ -4,6 +4,8 @@ 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}"