rails_app_generator 0.0.2

data/lib/rails_app_generator/notes/option-rules.txt

@@ -0,0 +1,67 @@
+Usage:
+  rails new APP_PATH [options]
+
+Options:
+      [--skip-namespace], [--no-skip-namespace]              # Skip namespace (affects only isolated engines)
+      [--skip-collision-check], [--no-skip-collision-check]  # Skip collision check
+  -r, [--ruby=PATH]                                          # Path to the Ruby binary of your choice
+                                                             # Default: /Users/davidcruwys/.asdf/installs/ruby/2.7.6/bin/ruby
+  -m, [--template=TEMPLATE]                                  # Path to some application template (can be a filesystem path or URL)
+  -d, [--database=DATABASE]                                  # Preconfigure for selected database (options: mysql/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)
+                                                             # Default: sqlite3
+  -G, [--skip-git], [--no-skip-git]                          # Skip .gitignore file
+      [--skip-keeps], [--no-skip-keeps]                      # Skip source control .keep files
+  -M, [--skip-action-mailer], [--no-skip-action-mailer]      # Skip Action Mailer files
+      [--skip-action-mailbox], [--no-skip-action-mailbox]    # Skip Action Mailbox gem
+      [--skip-action-text], [--no-skip-action-text]          # Skip Action Text gem
+  -O, [--skip-active-record], [--no-skip-active-record]      # Skip Active Record files
+      [--skip-active-job], [--no-skip-active-job]            # Skip Active Job
+      [--skip-active-storage], [--no-skip-active-storage]    # Skip Active Storage files
+  -C, [--skip-action-cable], [--no-skip-action-cable]        # Skip Action Cable files
+  -A, [--skip-asset-pipeline], [--no-skip-asset-pipeline]    # Indicates when to generate skip asset pipeline
+  -a, [--asset-pipeline=ASSET_PIPELINE]                      # Choose your asset pipeline [options: sprockets (default), propshaft]
+                                                             # Default: sprockets
+  -J, [--skip-javascript], [--no-skip-javascript]            # Skip JavaScript files
+      [--skip-hotwire], [--no-skip-hotwire]                  # Skip Hotwire integration
+      [--skip-jbuilder], [--no-skip-jbuilder]                # Skip jbuilder gem
+  -T, [--skip-test], [--no-skip-test]                        # Skip test files
+      [--skip-system-test], [--no-skip-system-test]          # Skip system test files
+      [--skip-bootsnap], [--no-skip-bootsnap]                # Skip bootsnap gem
+      [--dev], [--no-dev]                                    # Set up the application with Gemfile pointing to your Rails checkout
+      [--edge], [--no-edge]                                  # Set up the application with Gemfile pointing to Rails repository
+  --master, [--main], [--no-main]                            # Set up the application with Gemfile pointing to Rails repository main branch
+      [--rc=RC]                                              # Path to file containing extra configuration options for rails command
+      [--no-rc], [--no-no-rc]                                # Skip loading of extra configuration options from .railsrc file
+      [--api], [--no-api]                                    # Preconfigure smaller stack for API only apps
+      [--minimal], [--no-minimal]                            # Preconfigure a minimal rails app
+  -j, [--javascript=JAVASCRIPT]                              # Choose JavaScript approach [options: importmap (default), webpack, esbuild, rollup]
+                                                             # Default: importmap
+  -c, [--css=CSS]                                            # Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass... check https://github.com/rails/cssbundling-rails]
+  -B, [--skip-bundle], [--no-skip-bundle]                    # Don't run bundle install
+
+Runtime options:
+  -f, [--force]                    # Overwrite files that already exist
+  -p, [--pretend], [--no-pretend]  # Run but do not make any changes
+  -q, [--quiet], [--no-quiet]      # Suppress status output
+  -s, [--skip], [--no-skip]        # Skip files that already exist
+
+Rails options:
+  -h, [--help], [--no-help]        # Show this help message and quit
+  -v, [--version], [--no-version]  # Show Rails version number and quit
+
+Description:
+    The 'rails new' command creates a new Rails application with a default
+    directory structure and configuration at the path you specify.
+
+    You can specify extra command-line arguments to be used every time
+    'rails new' runs in the .railsrc configuration file in your home directory,
+    or in $XDG_CONFIG_HOME/rails/railsrc if XDG_CONFIG_HOME is set.
+
+    Note that the arguments specified in the .railsrc file don't affect the
+    defaults values shown above in this help message.
+
+Example:
+    rails new ~/Code/Ruby/weblog
+
+    This generates a skeletal Rails installation in ~/Code/Ruby/weblog.
+➜  rails_app_generator git:(main) ✗

data/lib/rails_app_generator/notes/usage-gem.txt

@@ -0,0 +1,133 @@
+BUNDLE-GEM(1)                                                      BUNDLE-GEM(1)
+
+NAME
+       bundle-gem - Generate a project skeleton for creating a rubygem
+
+SYNOPSIS
+       bundle gem GEM_NAME OPTIONS
+
+DESCRIPTION
+       Generates a directory named GEM_NAME with a Rakefile, GEM_NAME.gemspec,
+       and other supporting files and directories that can be used to develop a
+       rubygem with that name.
+
+       Run rake -T in the resulting project for a list of Rake tasks that can be
+       used to test and publish the gem to rubygems.org.
+
+       The generated project skeleton can be customized with OPTIONS, as
+       explained below. Note that these options can also be specified via
+       Bundler´s global configuration file using the following names:
+
+       •   gem.coc
+
+       •   gem.mit
+
+       •   gem.test
+
+
+
+
+OPTIONS
+       --exe or -b or --bin
+              Specify that Bundler should create a binary executable (as
+              exe/GEM_NAME) in the generated rubygem project. This binary will
+              also be added to the GEM_NAME.gemspec manifest. This behavior is
+              disabled by default.
+
+       --no-exe
+              Do not create a binary (overrides --exe specified in the global
+              config).
+
+       --coc  Add a CODE_OF_CONDUCT.md file to the root of the generated
+              project. If this option is unspecified, an interactive prompt will
+              be displayed and the answer will be saved in Bundler´s global
+              config for future bundle gem use.
+
+       --no-coc
+              Do not create a CODE_OF_CONDUCT.md (overrides --coc specified in
+              the global config).
+
+       --ext  Add boilerplate for C extension code to the generated project.
+              This behavior is disabled by default.
+
+       --no-ext
+              Do not add C extension code (overrides --ext specified in the
+              global config).
+
+       --mit  Add an MIT license to a LICENSE.txt file in the root of the
+              generated project. Your name from the global git config is used
+              for the copyright statement. If this option is unspecified, an
+              interactive prompt will be displayed and the answer will be saved
+              in Bundler´s global config for future bundle gem use.
+
+       --no-mit
+              Do not create a LICENSE.txt (overrides --mit specified in the
+              global config).
+
+       -t, --test=minitest, --test=rspec, --test=test-unit
+              Specify the test framework that Bundler should use when generating
+              the project. Acceptable values are minitest, rspec and test-unit.
+              The GEM_NAME.gemspec will be configured and a skeleton test/spec
+              directory will be created based on this option. Given no option is
+              specified:
+
+              When Bundler is configured to generate tests, this defaults to
+              Bundler´s global config setting gem.test.
+
+              When Bundler is configured to not generate tests, an interactive
+              prompt will be displayed and the answer will be used for the
+              current rubygem project.
+
+              When Bundler is unconfigured, an interactive prompt will be
+              displayed and the answer will be saved in Bundler´s global config
+              for future bundle gem use.
+
+       --ci, --ci=github, --ci=travis, --ci=gitlab, --ci=circle
+              Specify the continuous integration service that Bundler should use
+              when generating the project. Acceptable values are github, travis,
+              gitlab and circle. A configuration file will be generated in the
+              project directory. Given no option is specified:
+
+              When Bundler is configured to generate CI files, this defaults to
+              Bundler´s global config setting gem.ci.
+
+              When Bundler is configured to not generate CI files, an
+              interactive prompt will be displayed and the answer will be used
+              for the current rubygem project.
+
+              When Bundler is unconfigured, an interactive prompt will be
+              displayed and the answer will be saved in Bundler´s global config
+              for future bundle gem use.
+
+       --linter, --linter=rubocop, --linter=standard
+              Specify the linter and code formatter that Bundler should add to
+              the project´s development dependencies. Acceptable values are
+              rubocop and standard. A configuration file will be generated in
+              the project directory. Given no option is specified:
+
+              When Bundler is configured to add a linter, this defaults to
+              Bundler´s global config setting gem.linter.
+
+              When Bundler is configured not to add a linter, an interactive
+              prompt will be displayed and the answer will be used for the
+              current rubygem project.
+
+              When Bundler is unconfigured, an interactive prompt will be
+              displayed and the answer will be saved in Bundler´s global config
+              for future bundle gem use.
+
+       -e, --edit[=EDITOR]
+              Open the resulting GEM_NAME.gemspec in EDITOR, or the default
+              editor if not specified. The default is $BUNDLER_EDITOR, $VISUAL,
+              or $EDITOR.
+
+SEE ALSO
+       •   bundle config(1) bundle-config.1.html
+
+
+
+
+
+
+
+                                    May 2022                       BUNDLE-GEM(1)

data/lib/rails_app_generator/notes/usage-rails.txt

@@ -0,0 +1,67 @@
+Usage:
+  rails new APP_PATH [options]
+
+Options:
+      [--skip-namespace], [--no-skip-namespace]              # Skip namespace (affects only isolated engines)
+      [--skip-collision-check], [--no-skip-collision-check]  # Skip collision check
+  -r, [--ruby=PATH]                                          # Path to the Ruby binary of your choice
+                                                             # Default: /Users/davidcruwys/.asdf/installs/ruby/2.7.6/bin/ruby
+  -m, [--template=TEMPLATE]                                  # Path to some application template (can be a filesystem path or URL)
+  -d, [--database=DATABASE]                                  # Preconfigure for selected database (options: mysql/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)
+                                                             # Default: sqlite3
+  -G, [--skip-git], [--no-skip-git]                          # Skip .gitignore file
+      [--skip-keeps], [--no-skip-keeps]                      # Skip source control .keep files
+  -M, [--skip-action-mailer], [--no-skip-action-mailer]      # Skip Action Mailer files
+      [--skip-action-mailbox], [--no-skip-action-mailbox]    # Skip Action Mailbox gem
+      [--skip-action-text], [--no-skip-action-text]          # Skip Action Text gem
+  -O, [--skip-active-record], [--no-skip-active-record]      # Skip Active Record files
+      [--skip-active-job], [--no-skip-active-job]            # Skip Active Job
+      [--skip-active-storage], [--no-skip-active-storage]    # Skip Active Storage files
+  -C, [--skip-action-cable], [--no-skip-action-cable]        # Skip Action Cable files
+  -A, [--skip-asset-pipeline], [--no-skip-asset-pipeline]    # Indicates when to generate skip asset pipeline
+  -a, [--asset-pipeline=ASSET_PIPELINE]                      # Choose your asset pipeline [options: sprockets (default), propshaft]
+                                                             # Default: sprockets
+  -J, [--skip-javascript], [--no-skip-javascript]            # Skip JavaScript files
+      [--skip-hotwire], [--no-skip-hotwire]                  # Skip Hotwire integration
+      [--skip-jbuilder], [--no-skip-jbuilder]                # Skip jbuilder gem
+  -T, [--skip-test], [--no-skip-test]                        # Skip test files
+      [--skip-system-test], [--no-skip-system-test]          # Skip system test files
+      [--skip-bootsnap], [--no-skip-bootsnap]                # Skip bootsnap gem
+      [--dev], [--no-dev]                                    # Set up the application with Gemfile pointing to your Rails checkout
+      [--edge], [--no-edge]                                  # Set up the application with Gemfile pointing to Rails repository
+  --master, [--main], [--no-main]                            # Set up the application with Gemfile pointing to Rails repository main branch
+      [--rc=RC]                                              # Path to file containing extra configuration options for rails command
+      [--no-rc], [--no-no-rc]                                # Skip loading of extra configuration options from .railsrc file
+      [--api], [--no-api]                                    # Preconfigure smaller stack for API only apps
+      [--minimal], [--no-minimal]                            # Preconfigure a minimal rails app
+  -j, [--javascript=JAVASCRIPT]                              # Choose JavaScript approach [options: importmap (default), webpack, esbuild, rollup]
+                                                             # Default: importmap
+  -c, [--css=CSS]                                            # Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass... check https://github.com/rails/cssbundling-rails]
+  -B, [--skip-bundle], [--no-skip-bundle]                    # Don't run bundle install
+
+Runtime options:
+  -f, [--force]                    # Overwrite files that already exist
+  -p, [--pretend], [--no-pretend]  # Run but do not make any changes
+  -q, [--quiet], [--no-quiet]      # Suppress status output
+  -s, [--skip], [--no-skip]        # Skip files that already exist
+
+Rails options:
+  -h, [--help], [--no-help]        # Show this help message and quit
+  -v, [--version], [--no-version]  # Show Rails version number and quit
+
+Description:
+    The 'rails new' command creates a new Rails application with a default
+    directory structure and configuration at the path you specify.
+
+    You can specify extra command-line arguments to be used every time
+    'rails new' runs in the .railsrc configuration file in your home directory,
+    or in $XDG_CONFIG_HOME/rails/railsrc if XDG_CONFIG_HOME is set.
+
+    Note that the arguments specified in the .railsrc file don't affect the
+    defaults values shown above in this help message.
+
+Example:
+    rails new ~/Code/Ruby/weblog
+
+    This generates a skeletal Rails installation in ~/Code/Ruby/weblog.
+➜  rails_app_generator git:(main) ✗

data/lib/rails_app_generator/starter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+# require 'active_model/railtie'
+# active_record/railtie
+# active_storage/engine
+# action_controller/railtie
+# action_view/railtie
+# action_mailer/railtie
+# active_job/railtie
+# action_cable/engine
+# action_mailbox/engine
+# action_text/engine
+# rails/test_unit/railtie
+
+module RailsAppGenerator
+  #  Starter is a wrapper for Rails::AppGenerator
+  #
+  # example:
+  #   RailsAppGenerator::Starter.new.start
+  #   RailsAppGenerator::Starter.new(app_path: '.', destination_root: Dir.pwd).start
+  #   RailsAppGenerator::Starter.new(app_path: 'xmen', destination_root: '~/projects_path').start
+  #   RailsAppGenerator::Starter.new(app_path: '.', destination_root: '~/projects_path/xmen').start
+  class Starter
+    # include KLog::Logging
+
+    attr_reader :app_path
+    attr_reader :destination_root
+    attr_reader :rails_template_path
+    attr_reader :custom_template_path
+
+    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'))
+    end
+
+    def target_path
+      File.expand_path(File.join(destination_root, app_path))
+    end
+
+    def start
+      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
+    end
+  end
+end

data/lib/rails_app_generator/version.rb

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

data/lib/rails_app_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# require 'k_log'
+
+require 'rails/command/base'
+require 'rails/generators/app_base'
+require 'rails/generators'
+require 'rails/generators/app_name'
+require 'rails/generators/rails/app/app_generator'
+require 'bundler'
+
+require 'rails_app_generator/version'
+require 'rails_app_generator/build_option'
+require 'rails_app_generator/build_options'
+require 'rails_app_generator/starter'
+require 'rails_app_generator/app_builder'
+require 'rails_app_generator/app_generator'
+
+# require "rails_app_generator/generators/base"
+# require "rails_app_generator/generators/foo_generator"
+# require "rails_app_generator/generators/advisories_generator"
+
+module RailsAppGenerator
+  # raise RailsAppGenerator::Error, 'Sample message'
+  Error = Class.new(StandardError)
+
+  # Your code goes here...
+end
+
+if ENV.fetch('KLUE_DEBUG', 'false').downcase == 'true'
+  namespace = 'RailsAppGenerator::Version'
+  file_path = $LOADED_FEATURES.find { |f| f.include?('rails_app_generator/version') }
+  version   = RailsAppGenerator::VERSION.ljust(9)
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
+end