rails_app_generator 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36f0ee4d5e320c70147846a8027fd7c746914d87dd34366d9f1e8ce48f169623
-  data.tar.gz: acaf4240b30348911d75621ea66227c96ca789826422e8e97c0a73e96b4c88f5
+  metadata.gz: c7729b3a10ff4b9d4608b9c5cbd2e3fefe036a43b90066b447f4048b252a893b
+  data.tar.gz: 02c9a488f5a9296402f5923935fdcd88b69346d8f2337b34dc335640b532cd45
 SHA512:
-  metadata.gz: 4a4f3c1774c6a0a0fff82e4e82426ad69b3243f56efa4439b3af1f6c6a314ba9b788176613e1d1763149e8ea5e4733af73d43e473dcf45ef8d57dbf2c7a816b0
-  data.tar.gz: f9e78e1b2de8972af6f01cb0000738a234856dacc790683f96068712e901b600718c20dd20472f8ea7b2d64d58fe9178a00edc721aa3fcf83b67ff808addf11c
+  metadata.gz: dae7db0f0f6c5656253178dc635e141cd84289fab9d5c7bd621e337732d14f752969902df3e8458fbf43c8ff6239e79fb2d8f077a023ba1e6cb8ae539a5f6070
+  data.tar.gz: d14b704ed3d27d52f85bfd36e07be35490fb0c42f05a182504073c0fbcc59a5d27511a2ce59dfa54209438d449472ac3d71e28687c2e04d8cd7e3f3d9dc25c7d

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,26 @@
+## [0.0.6](https://github.com/klueless-io/rails_app_generator/compare/v0.0.5...v0.0.6) (2022-07-21)
+
+
+### Bug Fixes
+
+* add a bunch of addons ([b781af6](https://github.com/klueless-io/rails_app_generator/commit/b781af66d7fe7d7dcd2550577166213deefc06c6))
+* add a bunch of addons ([d9a85b7](https://github.com/klueless-io/rails_app_generator/commit/d9a85b7b32c2c25577d98b4b3be9aab7947ff6e9))
+* update template paths in app_generator ([9b28a5e](https://github.com/klueless-io/rails_app_generator/commit/9b28a5ee58535a761581e619eb01dc3059a79948))
+
+## [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)
+
+
+### Bug Fixes
+
+* add map string options ([50a22ba](https://github.com/klueless-io/rails_app_generator/commit/50a22ba1bdefc7726e687d072009d73bbfd21b83))
+
 ## [0.0.3](https://github.com/klueless-io/rails_app_generator/compare/v0.0.2...v0.0.3) (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
@@ -32,7 +41,6 @@ See all [stories](./STORIES.md)
 
 
 ## Usage
-xxxxxxxxxxxxxxxx <help name="blah blah" />
 See all [usage examples](./USAGE.md)
 
 

data/after_templates/test.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+# after_bundle do
+#   setup_rails.after_bundle
+# end
+
+add_scaffold('post', 'title', 'content:text')
+add_scaffold('book', 'title', 'content:text')
+# add_resource("comment", "post:references", 'content:text')
+# add_mailer("posts", "submitted", "broken")

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