rails_app_generator 0.0.5 → 0.0.8

data/after_templates/rag_tailwind.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Rails 7 with Bootstrap CSS and custom CSS
+# resources:
+#   https://www.youtube.com/watch?v=tYr8yn7yRKw
+#   https://youtu.be/phOUsR0dm5s?t=493
+#   https://www.youtube.com/watch?v=nxKDTtuKOo4
+
+require 'pry'
+
+self.local_template_path = File.join(File.dirname(__FILE__), 'rag_bootstrap')
+
+gac 'base rails 7 image created'
+
+add_controller('home', 'index', 'about')
+route("root 'home#index'")
+
+# # need a join template method
+# index_content     = join_templates(
+#   'component-nav.html',
+#   'component-hero.html',
+#   'component-cards-fancy.html',
+#   'component-cards-staff.html',
+#   'component-cards-styled.html',
+#   'component-modal.html',
+#   'component-footer.html',
+# )
+
+# move the nav bar into
+# 'app/views/shared/_navbar.html.erb'
+# and add the nav bar to the layout
+# 'app/views/layouts/application.html.erb'
+# <%= render partial: 'shared/navbar' %>
+
+# create_file       'app/views/home/index.html.erb', index_content, force: true
+
+# gem               'sassc-rails'
+
+after_bundle do
+  # add_css_customizations
+
+  # add_crud_people
+
+  # rails_command("db:migrate")
+end
+
+def add_css_customizations
+  # Update the manifest to include the stylesheets
+  append_to_file    'app/assets/config/manifest.js'                       , read_template('manifest.js')
+
+  # This is how you would add custom styling via @import in the application.bootstrap.css
+  append_to_file    'app/assets/stylesheets/application.bootstrap.scss'   , "@import 'custom-bootstrap-import.scss';"
+  create_file       'app/assets/stylesheets/custom-bootstrap-import.scss' , read_template('custom-bootstrap-import.scss')
+
+  # This is how you would add custom styling using standard CSS
+  create_file       'app/assets/stylesheets/custom-using-css.css'         , read_template('custom-using-css.css')
+
+  # This is how you would add custom styling using standard SAAS/SCSS
+  create_file       'app/assets/stylesheets/custom-using-scss.scss'       , read_template('custom-using-scss.scss')
+
+  # This is custom CSS for the fancier components
+  create_file       'app/assets/stylesheets/custom-component.css'         , join_templates('component-cards-fancy.css', 'component-cards-staff.css')
+
+  # Update the layout so that the stylesheets are included
+  insert_into_file  'app/views/layouts/application.html.erb', read_template('application.html.erb'),
+                    before: %(    <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>)
+  gsub_file         'app/views/layouts/application.html.erb', %(    <%= yield %>), read_template('application-yield.html.erb')
+end
+
+def add_crud_people
+  # Need to get the bootstrap form styling working
+  # Follow the instructions at: https://youtu.be/phOUsR0dm5s?t=493
+  add_scaffold('people', 'first_name', 'last_name', 'age:integer', 'address:text')
+end

data/exe/rag

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+require 'pry'
+
+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 profile 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
+
+profile_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../profiles")
+profile_name = ARGV[0]
+profile_name += '.json' unless profile_name.end_with?('.json')
+profile_file = File.join(profile_path, profile_name)
+
+if File.exist?(profile_file)
+  puts "Using profile #{profile_file}"
+
+  profile = JSON.parse(File.read(profile_file), symbolize_names: true)
+  args = profile[:args]
+  opts = profile[:opts]
+  rails_options = RailsAppGenerator::RailsOptions.new(opts)
+
+  instance = RailsAppGenerator::Starter.new(args)
+  FileUtils.rm_rf(instance.target_path)
+  instance.start(rails_options)
+else
+  puts "Profile #{profile_file} not found"
+  exit 1
+end

data/lib/rails_app_generator/add_on.rb

@@ -0,0 +1,73 @@
+# 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)
+        @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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
+  # The application builder allows you to override elements of the application
+  # generator without being forced to reverse the operations of the default generator.
   class AppBuilder < Rails::AppBuilder
     # def bin
     #   super
@@ -10,15 +12,15 @@ 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
-    #   template 'README.md.erb', 'README.md'
-    # end
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
 
     # def ruby_version
-    #   Schienenzeppelin::AddOns::RubyVersion.new(Context.new(options)).apply
+    #   RailsAppGenerator::AddOns::RubyVersion.new(Context.new(options)).apply
     # end
 
     # def gemfile