rails_app_generator 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af4adc7a1c56e1146ad7c09a5de8e937a9dcf9c6dbe9c44b5792e498c5432050
-  data.tar.gz: bfb7e1727d74d4090ad8ee9f5bad62091abfce6631e22164483527ae9cafa486
+  metadata.gz: a9db638d5387a342cec3c8ad01cf7aa69298a2e592f005608a603c17ec336b20
+  data.tar.gz: 192fd7e39c98346954ddb9752fba2c7cd5380e306d07e32b638d8d5c0201a637
 SHA512:
-  metadata.gz: c3e0485f02a267715227db3fd75c9e7b8f02d031661e40d3880edcc07a95f1351f7b94c5456456407d623b0ed3b2d8457e689a4f94cb6d9b5fc57f1ab0d11e68
-  data.tar.gz: 7f7ec8819fb75ba55e0b4e20f5532382e8bca334ea6ee895e2eb73001b34423538ff8876c1e54370c394bc9cac4a2b45e909954cfb9e3d5292092f187619dfcb
+  metadata.gz: b3d1733fb92b31e44eaaa31cf062038e7f8715cca8adf2e29351e7363e74c24a5ba488186143c803be5d814d17bfcc80b8fa5b945b9bd06cd0e2da966244c065
+  data.tar.gz: 1f2955850cf06ad10529dc86355f9db15af680bc017284ec01524f3c83c7314cb903b6deff6beefb7673ab78fc2d57152fef36a015d7a7b282df03310509dc24

data/.rubocop.yml

@@ -16,6 +16,7 @@ Metrics/BlockLength:
   Exclude:
     - "**/spec/**/*"
     - "*.gemspec"
+    - "lib/rails_app_generator/app_generator.rb"
   IgnoredMethods:
     - configure
     - context

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "docwriter.hotkey.mac": "⌥ + ."
+}

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.0.5](https://github.com/klueless-io/rails_app_generator/compare/v0.0.4...v0.0.5) (2022-07-19)
+
+
+### Bug Fixes
+
+* add console output capture ([0d66a3b](https://github.com/klueless-io/rails_app_generator/commit/0d66a3ba19c2adbd0f2c0747b8212e7e628c22ba))
+
 ## [0.0.4](https://github.com/klueless-io/rails_app_generator/compare/v0.0.3...v0.0.4) (2022-07-19)
 
 

data/README.md

@@ -22,6 +22,15 @@ Or install it yourself as:
 gem install rails_app_generator
 ```
 
+## Notes
+
+You can use rails_app_generator to create Rails 7 applications
+You can use rails_app_generator with ruby 2.7 or 3.1
+
+Rails new uses a batteries included approach, this means that you get everything and if you don't want a feature you need to turn it off explicitly using --skip-feature
+I hope to change the focus in this project so that you get very minimal installation and then you turn on what you want explicitly.
+Templates for rails are separated from templates for addons
+
 ## Stories
 
 ### Main Story

data/exe/rails_app_generator

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+
+source_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../lib")
+$LOAD_PATH << source_path
+
+require 'rails_app_generator'
+
+# if ARGV.empty?
+#   puts 'Please provide a path for the new application'
+#   puts
+#   puts 'See --help for more info'
+#   exit 0
+# elsif %w[-v --version].include? ARGV[0]
+#   puts RailsAppGenerator::VERSION
+#   exit 0
+# end
+
+# templates_root = File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+# RailsAppGenerator::AppGenerator.source_root templates_root
+# RailsAppGenerator::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+# RailsAppGenerator::AppGenerator.start
+require 'pry'
+
+args = {
+  app_path: 'kw01_bootstrap',
+  destination_root: '/Users/davidcruwys/dev/kweb'
+}
+opts = {
+  skip_git: true,
+  skip_bundle: false
+  # css: 'bootstrap'
+}
+
+# RailsAppGenerator::AppGenerator.override_template_path = '/Users/davidcruwys/dev/kgems/rails_app_generator/templates'
+# RailsAppGenerator::AppGenerator.addon_template_path = '/Users/davidcruwys/dev/kgems/rails_app_generator/templates/addons/%<addon>'
+
+instance = RailsAppGenerator::Starter.new(args)
+FileUtils.rm_rf(instance.target_path)
+
+rails_options = RailsAppGenerator::RailsOptions.new(opts)
+instance.start(rails_options)
+
+# system 'gem env'
+
+# console_output_file = File.expand_path('../../../lib/rails_app_generator/notes/kw01.txt', File.join(File.dirname(__FILE__)))
+
+# File.write(console_output_file, instance.console_output.split("\n").compact.collect(&:strip).join("\n"))

data/lib/rails_app_generator/add_on.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # XXXX
+  class AddOn < Rails::Generators::Base
+    include Thor::Actions
+    include Rails::Generators::Actions
+    include Rails::Generators::AppName
+
+    attr_reader :dependencies, :context
+
+    def initialize(context)
+      super
+      @context = context
+      @dependencies = self.class.dependencies || []
+    end
+
+    def apply; end
+
+    # list any methods that you want access to, but not to be exposed as a thor command
+    no_commands do
+      def source_paths
+        [
+          format(context.addon_template_path, addon: self.class.addon_name),
+          context.rails_override_template_path,
+          context.rails_template_path
+        ]
+      end
+
+      def options
+        context.options
+      end
+
+      def uses?(addon_name = nil)
+        addon_name ||= self.class.addon_name
+
+        return false  if options["skip_#{addon_name}".to_sym]
+        return true   if context.default_addons.include?(addon_name)
+
+        klass = addon_name.nil? ? self.class : self.class.get(addon_name)
+        Dependencies.new(klass, context).satisfied?
+      end
+    end
+
+    class << self
+      def apply(context = Context.new({}))
+        instance = new(context)
+        return unless instance.uses?
+
+        instance.apply
+      end
+
+      def get(addon)
+        addon = addon.to_s.capitalize.camelize
+        "RailsAppGenerator::AddOns::#{addon}".constantize
+      end
+
+      def addon_name
+        name.demodulize.underscore.to_sym
+      end
+
+      def dependencies
+        @dependencies ||= []
+      end
+
+      protected
+
+      def depends_on(*addon)
+        puts addon
+        @dependencies = addon.map(&:to_sym)
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/annotate.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Annotate for ActiveRecord models to rails application
+    class Annotate < AddOn
+      depends_on :active_record
+
+      def apply
+        template('auto_annotate_models.rake', 'lib/tasks/auto_annotate_models.rake', force: true)
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/continuous_integration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add GitHub Actions continuous integration
+    class ContinuousIntegration < AddOn
+      def apply
+        say 'continuous integration - Setup GitHub Actions'
+        template('github/workflows/build.yml.erb', '.github/workflows/build.yml')
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/devise.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Devise authentication to rails application
+    class Devise < AddOn
+      depends_on :active_record
+
+      def apply
+        generate('devise:install', capture: true)
+        generate(:devise, 'User', 'name', 'admin:boolean', capture: true)
+
+        directory('app/views/devise', 'app/views/devise') if uses?(:views)
+
+        inject_into_file 'config/environments/development.rb', before: /^end/ do
+          <<-RUBY
+
+  # Enable devise mailer
+  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+          RUBY
+        end
+
+        gsub_file 'config/initializers/devise.rb', /# config.pepper = .+/, "  # config.pepper = 'pepper'"
+        gsub_file 'config/initializers/devise.rb', /# config.secret_key = .+/, "  # config.secret_key = 'secret_key'"
+
+        db_changes
+      end
+
+      private
+
+      def db_changes
+        in_root do
+          migration = Dir.glob('db/migrate/*').max_by { |f| File.mtime(f) }
+          gsub_file migration, /:admin/, ':admin, default: false'
+        end
+        insert_into_file 'db/seeds.rb' do
+          <<~RUBY
+            # Create an initial admin user for development
+            User.find_or_create_by(email: "admin@admin.com") do |user|
+              user.name = 'Admin'
+              user.password = 'password'
+              user.admin = true
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/docker.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Docker to rails application
+    class Docker < AddOn
+      def apply
+        template 'Dockerfile.erb', 'Dockerfile'
+        template '.dockerignore.erb', '.dockerignore'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/docker_compose.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Docker Compose to rails application
+    class DockerCompose < AddOn
+      def apply
+        template 'docker-compose.yml.erb', 'docker-compose.yml'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/dotenv.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add DotEnv to rails application
+    class Dotenv < AddOn
+      def apply
+        template '.env.development.erb', '.env.development'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/factory_bot.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add FactoryBot to rails application
+    class FactoryBot < AddOn
+      depends_on :active_record, :test
+
+      def apply
+        # TODO: Make this work for minitest
+        return unless uses?(:factory_bot)
+
+        empty_directory 'spec/factories'
+        template('spec/support/factory_bot.rb')
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/foreman.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Foreman process management for applications with multiple components
+    class Foreman < AddOn
+      def apply
+        template '.foreman.erb', '.foreman'
+        template 'Procfile.erb', 'Procfile'
+        template 'Procfile.dev.erb', 'Procfile.dev'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/generators.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Rails Generator configuration to rails application
+    class Generators < AddOn
+      def apply
+        directory('lib/generators/rails/navigation', 'lib/generators/rails/navigation') if uses?(:views)
+
+        template = 'lib/generators/rails/scaffold_controller_generator.rb'
+        template(template) if uses?(:scaffold)
+
+        generators = <<-RUBY
+    config.generators do |generate|
+        #{"require_relative '../lib/generators/rails/scaffold_controller_generator'" if uses?(:scaffold)}
+        generate.helper false
+        generate.javascripts false
+        generate.request_specs false
+        generate.routing_specs false
+        generate.stylesheets false
+        #{'generate.test_framework :rspec' if uses?(:rspec)}
+        generate.view_specs false
+        #{'generate.factory_bot true' if uses?(:factory_bot)}
+    end
+        RUBY
+        inject_into_file 'config/application.rb', generators, before: /^ {2}end\n/
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/high_voltage.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add High Voltage rails engine for static pages.
+    class HighVoltage < AddOn
+      depends_on :views
+
+      def apply
+        template('config/initializers/high_voltage.rb')
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/inline_svg.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add InlineSvg support to rails application
+    class InlineSvg < AddOn
+      depends_on :views
+    end
+  end
+end

data/lib/rails_app_generator/addons/irbrc.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add IrbRc to rails application
+    class Irbrc < RailsAppGenerator::AddOn
+      def apply
+        template '.irbrc.erb', '.irbrc'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/lograge.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add LogRage - Tame Rails' multi-line logging into a single line per request
+    class Lograge < AddOn
+      def apply
+        template 'config/initializers/lograge.rb'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/pundit.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Pundit - Pundit provides a set of helpers which guide you in
+    # leveraging regular Ruby classes and object oriented design patterns
+    # to build a simple, robust and scalable authorization system.
+    class Pundit < AddOn
+      def apply
+        directory 'app/policies', 'app/policies'
+        template 'app/controllers/authorized_controller.rb.erb', 'app/controllers/authorized_controller.rb'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/rspec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add RSpec unit testing support to rails application
+    class Rspec < AddOn
+      depends_on :test
+
+      def apply
+        create_file('.rspec', '--require spec_helper')
+        template('spec/rails_helper.rb')
+        template('spec/spec_helper.rb')
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/rubocop.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Rubocop to rails application
+    class Rubocop < AddOn
+      def apply
+        template '.rubocop.yml.erb', '.rubocop.yml'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/scaffold.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Tailwind CSS support to rails application
+    class Scaffold < AddOn
+      depends_on :tailwind
+
+      def apply
+        directory 'lib/templates/erb/scaffold', 'lib/templates/erb/scaffold'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/services.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add DotEnv to rails application
+    class Services < AddOn
+      def apply
+        directory 'app/services', 'app/services'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/sidekiq.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Sidekiq to rails application
+    #
+    # Sidekiq is a job server that can be used to process jobs in the background.
+    # `Sidekiq` is a subclass of `AddOn` that adds a `apply` method that says "setup sidekiq" and
+    # copies the `app/workers` directory from the `templates` directory to the `app` directory
+    class Sidekiq < AddOn
+      def apply
+        say 'setup sidekiq'
+        directory('app/workers', 'app/workers')
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/stimulus.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Stimulus components
+    class Stimulus < AddOn
+      depends_on :javascript
+
+      def apply
+        rails_command('stimulus:install')
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/stimulus_components.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Stimulus components
+    class StimulusComponents < AddOn
+      depends_on :stimulus
+
+      def apply
+        run('yarn add tailwindcss-stimulus-components')
+        inject_into_file('app/javascript/packs/application.js') do
+          <<~JS
+            import { Application } from "stimulus"
+            import { definitionsFromContext } from "stimulus/webpack-helpers"
+
+            const application = Application.start();
+            const context = require.context("controllers", true, /.js$/);
+            application.load(definitionsFromContext(context));
+
+            import { Dropdown, Modal, Tabs, Popover, Toggle, Slideover } from "tailwindcss-stimulus-components"
+            application.register('dropdown', Dropdown)
+            application.register('modal', Modal)
+            application.register('tabs', Tabs)
+            application.register('popover', Popover)
+            application.register('toggle', Toggle)
+            application.register('slideover', Slideover)
+          JS
+        end
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/tailwind.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Tailwind CSS support to rails application
+    class Tailwind < AddOn
+      depends_on :javascript
+
+      def apply
+        rails_command('tailwindcss:install')
+        template('app/javascript/stylesheets/components.scss')
+        insert_into_file 'app/javascript/stylesheets/application.scss' do
+          <<~CSS
+
+            @import "components";
+          CSS
+        end
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/views.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add default rails views
+    class Views < AddOn
+      depends_on :tailwind
+
+      def apply
+        say 'Setting up custom landing page'
+        directory 'app/views/layouts', 'app/views/layouts', force: true
+        directory 'app/views/shared', 'app/views/shared'
+        directory 'app/views/pages', 'app/views/pages' if uses?(:high_voltage)
+        # Make sure we can access any images put into the images folder
+        inject_into_file('app/javascript/packs/application.js', "require.context('../images', true)")
+        directory 'app/javascript/images', 'app/javascript/images'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/app_builder.rb

@@ -10,7 +10,7 @@ module RailsAppGenerator
     # def credentials
     #   super
     #   # This sets up credentials using a custom template for both development and production use
-    #   Schienenzeppelin::AddOns::Credentials.apply
+    #   RailsAppGenerator::AddOns::Credentials.apply
     # end
 
     # def readme
@@ -18,7 +18,7 @@ module RailsAppGenerator
     # end
 
     # def ruby_version
-    #   Schienenzeppelin::AddOns::RubyVersion.new(Context.new(options)).apply
+    #   RailsAppGenerator::AddOns::RubyVersion.new(Context.new(options)).apply
     # end
 
     # def gemfile