rails_app_generator 0.1.25 → 0.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8402636b2b1998543616a2cd272805b60b2f2376ccf9d0820d2763b92f204b8d
-  data.tar.gz: 3708271f45646622588ab76a546f685e0227c6eaa0c8bf4e8f7f17d98ee2e844
+  metadata.gz: b5005b34988e8bf214b22d0f09e109ec5df50c29dfac7c677586ecf7b53c112d
+  data.tar.gz: 1a2e5b7f16bb4f98d401ed8d475373925b4f72c50e67f38c51d53272989ab74c
 SHA512:
-  metadata.gz: 225821de9ffbc1335ebbac6b5dd916257b3e4f5b26da84d67b79d331df4bf93d9f2b6f6524c81c55c9f8dda9bd57e96db29bb6d220eac0aacdd3574a9070fe38
-  data.tar.gz: 8e60366f1eacf5aabf9f34a44cac3d078818e314c9dda1576325942468ec922322f072a4ade15ec569b1a09868ffdec57d4c365b653528b4469c84c4236b807f
+  metadata.gz: 587960fc7b519882bc63ae213a0af9309597b2a367ce8f556ca1f0216748f5f963b65167f4b71e30ab517074adeaaf709a9eee4d4adee80b1d934d6cf7816f17
+  data.tar.gz: beba122ba762ab6dfa425ad3ccf30c25de6da726ea9caf49e7c68c4552f23b7ba6e2a52ab655629d30aa1707bb7b2d7e1e8c54f13c19e18947dc962137328f96

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [0.1.27](https://github.com/klueless-io/rails_app_generator/compare/v0.1.26...v0.1.27) (2022-08-06)
+
+
+### Bug Fixes
+
+* add addon_util and specs ([55e96be](https://github.com/klueless-io/rails_app_generator/commit/55e96bef66e05f33c7c1c1347fd04ff70166d352))
+
+## [0.1.26](https://github.com/klueless-io/rails_app_generator/compare/v0.1.25...v0.1.26) (2022-08-06)
+
+
+### Bug Fixes
+
+* profile mini_magick ([f44b932](https://github.com/klueless-io/rails_app_generator/commit/f44b932df8fa7d817e2064d74af49476f82710d3))
+* profile mini_magick ([6935964](https://github.com/klueless-io/rails_app_generator/commit/69359640e7791691052aac1496b43aa1a5fd99c0))
+
+## [0.1.25](https://github.com/klueless-io/rails_app_generator/compare/v0.1.24...v0.1.25) (2022-08-06)
+
+
+### Bug Fixes
+
+* addon mini_magick ([7897e60](https://github.com/klueless-io/rails_app_generator/commit/7897e60e6aaa63813135251f7337b0dab23525a5))
+
 ## [0.1.24](https://github.com/klueless-io/rails_app_generator/compare/v0.1.23...v0.1.24) (2022-08-06)
 
 

data/after_templates/addons/mini_magick/_.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# require 'pry'
+
+# Manipulate images with minimal use of memory via ImageMagick / GraphicsMagick
+#
+# exe/rag addons/mini_magick
+
+self.local_template_path = File.dirname(__FILE__)
+
+gac 'base rails 7 image created'
+
+add_controller('home', 'index')
+route("root 'home#index'")
+
+force_copy
+
+copy_file 'app/controllers/home_controller.rb'            , 'app/controllers/home_controller.rb'
+copy_file 'app/views/home/index.html.erb'                 , 'app/views/home/index.html.erb'
+
+copy_file 'app/views/layouts/_alerts.html.erb'            , 'app/views/layouts/_alerts.html.erb'
+copy_file 'app/views/layouts/_navbar.html.erb'            , 'app/views/layouts/_navbar.html.erb'
+copy_file 'app/views/layouts/_footer.html.erb'            , 'app/views/layouts/_footer.html.erb'
+template  'app/views/layouts/application.html.erb'        , 'app/views/layouts/application.html.erb'
+
+copy_file 'app/assets/images/cat1.jpg'                           , 'app/assets/images/cat1.jpg'
+copy_file 'app/assets/images/cat2.jpg'                           , 'app/assets/images/cat2.jpg'
+copy_file 'app/assets/images/cat3.jpg'                           , 'app/assets/images/cat3.jpg'

data/after_templates/addons/mini_magick/app/controllers/home_controller.rb

@@ -0,0 +1,43 @@
+class HomeController < ApplicationController
+  def index
+    @img = get_image
+
+    @img_rotate = get_image do |options|
+      options.resize("300x300")
+      options.rotate "-45"
+    end
+
+    @img_negate = get_image do |options|
+      options.resize("300x300")
+      options.negate
+    end
+
+    @img_distort = get_image do |options|
+      options.resize("300x300")
+      options.distort("Perspective", "0,0,0,0 0,45,0,45 69,0,60,10 69,45,60,35")
+    end
+  end
+
+  private
+
+  def image_name
+    @variable ||= begin
+      image_names = [
+        'cat1.jpg',
+        'cat2.jpg',
+        'cat3.jpg'
+      ]
+
+      "app/assets/images/#{image_names.sample}"
+    end
+  end
+
+  def get_image(&block)
+    puts image_name
+    image = MiniMagick::Image.open(image_name)
+    image.combine_options(&block)
+
+    Base64.encode64(image.to_blob)
+  end
+end
+

data/after_templates/addons/mini_magick/app/views/home/index.html.erb

@@ -0,0 +1,25 @@
+<h1>Mini magick</h1>
+
+<h2>Manipulate images with minimal use of memory via ImageMagick / GraphicsMagick</h2>
+
+<table>
+<tr>
+<td>
+  <h3>Plain</h3>
+  <%= image_tag "data://image/png;base64,#{@img}" %>
+</td>
+<td>
+  <h3>Rotate</h3>
+  <%= image_tag "data://image/png;base64,#{@img_rotate}" %>
+</td>
+<td>
+  <h3>Negate</h3>
+  <%= image_tag "data://image/png;base64,#{@img_negate}" %>
+</td>
+<td>
+  <h3>Distort</h3>
+  <%= image_tag "data://image/png;base64,#{@img_distort}" %>
+</td>
+</tr>
+</table>
+

data/after_templates/addons/mini_magick/app/views/layouts/_alerts.html.erb

@@ -0,0 +1,2 @@
+<% flash.each do |type, msg| %><div class="<%= type %>"><%= msg %></div><% end %>
+<% if flash.any? %><hr /><% end %>

data/after_templates/addons/mini_magick/app/views/layouts/_footer.html.erb

@@ -0,0 +1,3 @@
+<footer>
+  <hr />
+</footer>

data/after_templates/addons/mini_magick/app/views/layouts/_navbar.html.erb

@@ -0,0 +1,2 @@
+<header>
+</header>

data/after_templates/addons/mini_magick/app/views/layouts/application.html.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= camelized %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%%= csrf_meta_tags %>
+    <%%= csp_meta_tag %>
+
+    <%- if options[:skip_hotwire] || options[:skip_javascript] -%>
+    <%%= stylesheet_link_tag "application" %>
+    <%- else -%>
+    <%%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%- end -%>
+    <style>
+    .alert { color: red; }
+    .notice { color: green; }
+    </style>
+  </head>
+
+  <body>
+    <%%= render 'layouts/navbar' %>
+    <main>
+      <%%= render 'layouts/alerts' %>
+      <%%= yield %>
+    </main>
+    <%%= render 'layouts/footer' %>
+  </body>
+</html>

data/lib/rails_app_generator/{add_on.rb → addon.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  # XXXX
-  class AddOn < Rails::Generators::Base
+  # Base class for all add-ons
+  class Addon < Rails::Generators::Base
     include Thor::Actions
     include Rails::Generators::Actions
     include Rails::Generators::AppName
@@ -41,7 +41,7 @@ module RailsAppGenerator
         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)
+        klass = addon_name.nil? ? self.class : AddonUtil.get(addon_name)
         Dependencies.new(klass, context).satisfied?
       end
 
@@ -82,29 +82,6 @@ module RailsAppGenerator
     # rubocop:enable Metrics/BlockLength
 
     class << self
-      # attr_reader :before_bundle_callback
-      # attr_reader :after_bundle_callback
-
-      # def before_bundle(&block)
-      #   @before_bundle_callback = block
-      # end
-
-      # def after_bundle(&block)
-      #   @after_bundle_callback = block
-      # end
-
-      # 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

data/lib/rails_app_generator/addon_util.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Utility methods for accessing Addons
+  class AddonUtil
+    class << self
+      # Get the Addon classes that are stored in the RailsAppGenerator::Addons::* namespace
+      def classes
+        AddOns.constants
+              .map { |addon_klass_name| AddOns.const_get(addon_klass_name) }
+              .select { |klass| klass.ancestors.include?(RailsAppGenerator::Addon) }
+      end
+
+      # Convert a string to a symbol to a fully qualified class constant
+      def get(addon)
+        addon = addon.to_s.capitalize.camelize
+        "RailsAppGenerator::AddOns::#{addon}".constantize
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/acts_as_list.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add ActsAsList to rails application
-    class ActsAsList < AddOn
+    class ActsAsList < RailsAppGenerator::Addon
       depends_on :active_record
       required_gem gem.version('acts_as_list', '1.0.4', <<~COMMENT)
         This "acts_as" extension provides the capabilities for sorting and reordering a number of objects in a list.

data/lib/rails_app_generator/addons/annotate.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Annotate for ActiveRecord models to rails application
-    class Annotate < AddOn
+    class Annotate < RailsAppGenerator::Addon
       depends_on :active_record
 
       required_gem gem.version('annotate', '3.2.0', 'Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema.')

data/lib/rails_app_generator/addons/browser.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Browser to rails application
-    class Browser < AddOn
+    class Browser < RailsAppGenerator::Addon
       required_gem gem.version('browser', '5.3.1', 'Do some browser detection with Ruby.')
 
       def apply; end

data/lib/rails_app_generator/addons/chartkick.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Chartkick to rails application
-    class Chartkick < AddOn
+    class Chartkick < RailsAppGenerator::Addon
       required_gem gem.version('chartkick', '4.2.1', 'Create beautiful JavaScript charts with one line of Ruby')
 
       def apply; end

data/lib/rails_app_generator/addons/continuous_integration.rb

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

data/lib/rails_app_generator/addons/devise.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Devise authentication to rails application
-    class Devise < AddOn
+    class Devise < RailsAppGenerator::Addon
       depends_on :active_record
 
       required_gem gem.version('devise', '4.8.1', 'Flexible authentication solution for Rails with Warden')

data/lib/rails_app_generator/addons/docker.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Docker to rails application
-    class Docker < AddOn
+    class Docker < RailsAppGenerator::Addon
       def apply
         template 'Dockerfile.erb', 'Dockerfile'
         template '.dockerignore.erb', '.dockerignore'

data/lib/rails_app_generator/addons/docker_compose.rb

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

data/lib/rails_app_generator/addons/dotenv.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add DotEnv to rails application
-    class Dotenv < AddOn
+    class Dotenv < RailsAppGenerator::Addon
       def apply
         template '.env.development.erb', '.env.development'
       end

data/lib/rails_app_generator/addons/factory_bot.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add FactoryBot to rails application
-    class FactoryBot < AddOn
+    class FactoryBot < RailsAppGenerator::Addon
       depends_on :active_record, :test
 
       def apply

data/lib/rails_app_generator/addons/faker.rb

@@ -7,7 +7,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Faker to rails application
-    class Faker < AddOn
+    class Faker < RailsAppGenerator::Addon
       required_gem gem.version('faker', '2.22.0', 'Faker, a port of Data::Faker from Perl, is used to easily generate fake data: names, addresses, phone numbers, etc.')
 
       def apply; end

data/lib/rails_app_generator/addons/foreman.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Foreman process management for applications with multiple components
-    class Foreman < AddOn
+    class Foreman < RailsAppGenerator::Addon
       def apply
         template '.foreman.erb', '.foreman'
         template 'Procfile.erb', 'Procfile'

data/lib/rails_app_generator/addons/generators.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Rails Generator configuration to rails application
-    class Generators < AddOn
+    class Generators < RailsAppGenerator::Addon
       def apply
         directory('lib/generators/rails/navigation', 'lib/generators/rails/navigation') if uses?(:views)
 

data/lib/rails_app_generator/addons/groupdate.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Groupdate to rails application
-    class Groupdate < AddOn
+    class Groupdate < RailsAppGenerator::Addon
       required_gem gem.version('groupdate', '6.1.0', 'The simplest way to group temporal data')
 
       # NOTE: in the examples, the Groupdate gem is used in conjunction with Chartkick.

data/lib/rails_app_generator/addons/hexapdf.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Hexapdf to rails application
-    class Hexapdf < AddOn
+    class Hexapdf < RailsAppGenerator::Addon
       required_gem gem.version('hexapdf', '0.24.0', 'HexaPDF is a pure Ruby library with an accompanying application for working with PDF files.')
 
       def apply; end

data/lib/rails_app_generator/addons/high_voltage.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add High Voltage rails engine for static pages.
-    class HighVoltage < AddOn
+    class HighVoltage < RailsAppGenerator::Addon
       depends_on :views
 
       def apply

data/lib/rails_app_generator/addons/honeybadger.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Honeybadger to rails application
-    class Honeybadger < AddOn
+    class Honeybadger < RailsAppGenerator::Addon
       required_gem gem.version('honeybadger', '4.12.1', 'Make managing application errors a more pleasant experience.')
 
       def apply

data/lib/rails_app_generator/addons/httparty.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Httparty to rails application
-    class Httparty < AddOn
+    class Httparty < RailsAppGenerator::Addon
       required_gem gem.version('httparty', '0.20.0', 'Makes http fun! Also, makes consuming restful web services dead easy.')
 
       def apply; end

data/lib/rails_app_generator/addons/inline_svg.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add InlineSvg support to rails application
-    class InlineSvg < AddOn
+    class InlineSvg < RailsAppGenerator::Addon
       depends_on :views
     end
   end

data/lib/rails_app_generator/addons/irbrc.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add IrbRc to rails application
-    class Irbrc < RailsAppGenerator::AddOn
+    class Irbrc < RailsAppGenerator::Addon
       def apply
         template '.irbrc.erb', '.irbrc'
       end

data/lib/rails_app_generator/addons/lograge.rb

@@ -4,7 +4,7 @@ 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
+    class Lograge < RailsAppGenerator::Addon
       def apply
         template 'config/initializers/lograge.rb'
       end

data/lib/rails_app_generator/addons/mini_magick.rb

@@ -4,27 +4,10 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add MiniMagick to rails application
-    class MiniMagick < AddOn
+    class MiniMagick < RailsAppGenerator::Addon
       required_gem gem.version('mini_magick', '4.11.0', 'Manipulate images with minimal use of memory via ImageMagick / GraphicsMagick')
 
-      def apply
-        say 'Setting up MiniMagick'
-        # template('mini_magick_template.rb', 'target/mini_magick.rb', force: true)
-        # template('app/javascript/stylesheets/components.scss')
-        # create_file('target/mini_magick.rb', 'put your content here')
-        # directory 'app/template', 'app/target', force: true
-        # empty_directory 'app/target'
-        # inject_into_file('app/application.js', "some content")
-        # rails_command('tailwindcss:install')
-      end
-
-      def before_bundle
-        say 'Setting up MiniMagick - before bundle install'
-      end
-
-      def after_bundle
-        say 'Setting up MiniMagick - after bundle install'
-      end
+      def apply; end
     end
   end
 end

data/lib/rails_app_generator/addons/pundit.rb

@@ -6,7 +6,7 @@ module RailsAppGenerator
     # 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
+    class Pundit < RailsAppGenerator::Addon
       def apply
         directory 'app/policies', 'app/policies'
         template 'app/controllers/authorized_controller.rb.erb', 'app/controllers/authorized_controller.rb'

data/lib/rails_app_generator/addons/rails_html_sanitizer.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Rails HTML Sanitizer
-    class RailsHtmlSanitizer < AddOn
+    class RailsHtmlSanitizer < RailsAppGenerator::Addon
       required_gem gem.version('rails-html-sanitizer', '1.4.3',
                                'Rails Html Sanitizers are responsible for sanitizing HTML fragments in Rails applications, i.e. in the sanitize, sanitize_css, strip_tags and strip_links methods')
 

data/lib/rails_app_generator/addons/rspec.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add RSpec unit testing support to rails application
-    class Rspec < AddOn
+    class Rspec < RailsAppGenerator::Addon
       depends_on :test
 
       def apply

data/lib/rails_app_generator/addons/rubocop.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Rubocop to rails application
-    class Rubocop < AddOn
+    class Rubocop < RailsAppGenerator::Addon
       def apply
         template '.rubocop.yml.erb', '.rubocop.yml'
       end

data/lib/rails_app_generator/addons/scaffold.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Tailwind CSS support to rails application
-    class Scaffold < AddOn
+    class Scaffold < RailsAppGenerator::Addon
       depends_on :tailwind
 
       def apply

data/lib/rails_app_generator/addons/services.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add DotEnv to rails application
-    class Services < AddOn
+    class Services < RailsAppGenerator::Addon
       def apply
         directory 'app/services', 'app/services'
       end

data/lib/rails_app_generator/addons/sidekiq.rb

@@ -6,9 +6,9 @@ module RailsAppGenerator
     # 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
+    # `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
+    class Sidekiq < RailsAppGenerator::Addon
       def apply
         say 'setup sidekiq'
         directory('app/workers', 'app/workers')

data/lib/rails_app_generator/addons/stimulus.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Stimulus components
-    class Stimulus < AddOn
+    class Stimulus < RailsAppGenerator::Addon
       depends_on :javascript
 
       def apply

data/lib/rails_app_generator/addons/stimulus_components.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Stimulus components
-    class StimulusComponents < AddOn
+    class StimulusComponents < RailsAppGenerator::Addon
       depends_on :stimulus
 
       def apply

data/lib/rails_app_generator/addons/tailwind.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Tailwind CSS support to rails application
-    class Tailwind < AddOn
+    class Tailwind < RailsAppGenerator::Addon
       depends_on :javascript
 
       def apply

data/lib/rails_app_generator/addons/views.rb

@@ -4,7 +4,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add default rails views
-    class Views < AddOn
+    class Views < RailsAppGenerator::Addon
       depends_on :tailwind
 
       def apply

data/lib/rails_app_generator/app_generator.rb

@@ -492,13 +492,6 @@ module RailsAppGenerator
         end
       end
 
-      # def apply(context = Context.new({}))
-      #   instance = new(context)
-      #   return unless instance.uses?
-
-      #   instance.apply
-      # end
-
       def add_if(addon)
         add(addon) if active?(addon)
       end
@@ -526,7 +519,7 @@ module RailsAppGenerator
       def uses?(addon)
         return false unless active?(addon)
 
-        addon = AddOn.get(addon)
+        addon = AddonUtil.get(addon)
         Dependencies.new(addon, context).satisfied?
       end
 
@@ -538,14 +531,8 @@ module RailsAppGenerator
         end
       end
 
-      def addon_classes
-        AddOns.constants
-              .map { |addon_klass_name| AddOns.const_get(addon_klass_name) }
-              .select { |klass| klass.is_a?(Class) && klass.respond_to?(:addon_name) }
-      end
-
       def active_addon_classes
-        addon_classes.select { |klass| active?(klass.addon_name) }
+        AddonUtil.classes.select { |klass| active?(klass.addon_name) }
       end
 
       def addon_gemfile_entries

data/lib/rails_app_generator/context.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  # Context passes
+  # Context stores the template folder and options
   class Context
     attr_reader :rails_template_path
     attr_reader :rails_override_template_path

data/lib/rails_app_generator/dependencies.rb

@@ -24,8 +24,8 @@ module RailsAppGenerator
 
       return true if @context.default_addons.include?(addon)
 
-      visited << addon
-      dependencies = AddOn.get(addon).dependencies - visited
+      visited << RailsAppGenerator::Addon
+      dependencies = AddonUtil.get(addon).dependencies - visited
       dependencies.each do |dependency|
         return false unless dependencies_satisfied?(dependency, visited)
       end

data/lib/rails_app_generator/options/options_builder.rb

@@ -13,34 +13,37 @@ module RailsAppGenerator
     end
 
     class << self
-      def registered_options
-        @registered_options ||= []
+      def class_options
+        @class_options ||= []
       end
 
-      def registered_options_lookup
-        @registered_options_lookup ||= {}
+      def class_options_lookup
+        @class_options_lookup ||= {}
       end
 
       # Future options are placeholders for options that are not yet implemented
       def future_option(name, **args); end
 
-      def register_option(name, **args)
-        return if registered_options_lookup.key?(name)
+      # Register an option with the builder, this method has the same signature as Thor.
+      #
+      # This is so options can be used interchangeably between OptionsBuilder and Thor.
+      def class_option(name, **args)
+        return if class_options_lookup.key?(name)
 
         option = BuildOption.new(**{ name: name }.merge(args))
 
-        registered_options_lookup[name] = option
-        registered_options << option
+        class_options_lookup[name] = option
+        class_options << option
       end
 
       def reset
-        @registered_options = nil
-        @registered_options_lookup = nil
+        @class_options = nil
+        @class_options_lookup = nil
       end
     end
 
     def cmd_line_options
-      self.class.registered_options.map do |option|
+      self.class.class_options.map do |option|
         mapper = option.mapper
         value = options[option.name]
         mapper.map(option.name, value)
@@ -57,35 +60,7 @@ module RailsAppGenerator
     private
 
     def default_options
-      self.class.registered_options.to_h { |option| [option.name, option.default] }
+      self.class.class_options.to_h { |option| [option.name, option.default] }
     end
   end
-
-  # 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"
-  # ]
 end

data/lib/rails_app_generator/options/rails_options.rb

@@ -4,9 +4,9 @@ module RailsAppGenerator
   class RailsOptions < OptionsBuilder
     # NOTE: Currently you need to register new options in two places
     #       here and in lib/rails_app_generator/app_generator.rb
-    register_option :template                   , type: :string                               # , desc: "Path to some #{name} template (can be a filesystem path or URL)"
+    class_option    :template                   , type: :string                               # , desc: "Path to some #{name} template (can be a filesystem path or URL)"
     future_option   :database                   , type: :string , default: 'sqlite3'          # , desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
-    register_option :skip_git                   , type: :boolean, default: false              # , desc: "Skip .gitignore file"
+    class_option    :skip_git                   , type: :boolean, default: false              # , desc: "Skip .gitignore file"
     future_option   :skip_keeps                 , type: :boolean, default: false              # , desc: "Skip source control .keep files"
     future_option   :skip_action_mailer         , type: :boolean, default: false              # , desc: "Skip Action Mailer files"
     future_option   :skip_action_mailbox        , type: :boolean, default: false              # , desc: "Skip Action Mailbox gem"
@@ -20,8 +20,8 @@ module RailsAppGenerator
     future_option   :skip_javascript            , type: :boolean, default: false # name == 'plugin'   # , desc: "Skip JavaScript files"
     future_option   :skip_hotwire               , type: :boolean, default: false              # , desc: "Skip Hotwire integration"
     future_option   :skip_jbuilder              , type: :boolean, default: false              # , desc: "Skip jbuilder gem"
-    register_option :skip_test                  , type: :boolean, default: false              # , desc: "Skip test files"
-    register_option :test                       , type: :string , default: 'rspec'            # , desc: "minitest or rspec (default: rspec)"
+    class_option    :skip_test                  , type: :boolean, default: false              # , desc: "Skip test files"
+    class_option    :test                       , type: :string , default: 'rspec'            # , desc: "minitest or rspec (default: rspec)"
     future_option   :skip_system_test           , type: :boolean, default: false              # , desc: "Skip system test files"
     future_option   :skip_bootsnap              , type: :boolean, default: false              # , desc: "Skip bootsnap gem"
     future_option   :dev                        , type: :boolean, default: false              # , desc: "Set up the #{name} with Gemfile pointing to your Rails checkout"
@@ -34,42 +34,42 @@ module RailsAppGenerator
     future_option   :api                        , type: :boolean                              # , desc: "Preconfigure smaller stack for API only apps"
     future_option   :minimal                    , type: :boolean                              # , desc: "Preconfigure a minimal rails app"
     future_option   :javascript                 , type: :string , default: 'importmap'        # , desc: "Choose JavaScript approach [options: importmap (default), webpack, esbuild, rollup]"
-    register_option :css                        , type: :string                               # , desc: "Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass... check https://github.com/rails/cssbundling-rails]"
-    register_option :skip_bundle                , type: :boolean, default: false              # , desc: "Don't run bundle install"
+    class_option    :css                        , type: :string                               # , desc: "Choose CSS processor [options: tailwind, bootstrap, bulma, postcss, sass... check https://github.com/rails/cssbundling-rails]"
+    class_option    :skip_bundle                , type: :boolean, default: false              # , desc: "Don't run bundle install"
 
-    register_option :add_irbrc                  , type: :boolean, default: false
-    register_option :add_foreman                , type: :boolean, default: false
-    register_option :add_devise                 , type: :boolean, default: false
-    register_option :add_dotenv                 , type: :boolean, default: false
-    register_option :add_docker                 , type: :boolean, default: false
-    register_option :add_docker_compose         , type: :boolean, default: false
-    register_option :add_rubocop                , type: :boolean, default: false
-    register_option :add_annotate               , type: :boolean, default: false
-    register_option :add_continuous_integration , type: :boolean, default: false
-    register_option :add_high_voltage           , type: :boolean, default: false
-    register_option :add_generators             , type: :boolean, default: false
-    register_option :add_lograge                , type: :boolean, default: false
-    register_option :add_pundit                 , type: :boolean, default: false
-    register_option :add_services               , type: :boolean, default: false
-    register_option :add_sidekiq                , type: :boolean, default: false
-    register_option :add_views                  , type: :boolean, default: false
-    register_option :add_errors                 , type: :boolean, default: false
-    register_option :add_scaffold               , type: :boolean, default: false
-    register_option :add_factory_bot            , type: :boolean, default: false
-    register_option :add_shoulda                , type: :boolean, default: false
+    class_option    :add_irbrc                  , type: :boolean, default: false
+    class_option    :add_foreman                , type: :boolean, default: false
+    class_option    :add_devise                 , 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
 
     # NEW GEM ADDONS
-    register_option :add_acts_as_list           , type: :boolean, default: false
-    register_option :add_browser                , type: :boolean, default: false
-    register_option :add_chartkick              , type: :boolean, default: false
-    register_option :add_faker                  , type: :boolean, default: false
-    register_option :add_groupdate              , type: :boolean, default: false
-    register_option :add_hexapdf                , type: :boolean, default: false
-    register_option :add_httparty               , type: :boolean, default: false
-    register_option :add_honeybadger            , type: :boolean, default: false
-    register_option :add_mini_magick            , type: :boolean, default: false
-    register_option :add_rails_html_sanitizer   , type: :boolean, default: false
-    register_option :add_twilio_ruby            , type: :boolean, default: false
+    class_option    :add_acts_as_list           , type: :boolean, default: false
+    class_option    :add_browser                , type: :boolean, default: false
+    class_option    :add_chartkick              , type: :boolean, default: false
+    class_option    :add_faker                  , type: :boolean, default: false
+    class_option    :add_groupdate              , type: :boolean, default: false
+    class_option    :add_hexapdf                , type: :boolean, default: false
+    class_option    :add_httparty               , type: :boolean, default: false
+    class_option    :add_honeybadger            , type: :boolean, default: false
+    class_option    :add_mini_magick            , type: :boolean, default: false
+    class_option    :add_rails_html_sanitizer   , type: :boolean, default: false
+    class_option    :add_twilio_ruby            , type: :boolean, default: false
 
     # if options[:minimal]
     #   self.options = options.merge(

data/lib/rails_app_generator/version.rb

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

data/lib/rails_app_generator.rb

@@ -25,13 +25,15 @@ require 'rails_app_generator/options/options_builder'
 require 'rails_app_generator/options/rails_options'
 require 'rails_app_generator/context'
 require 'rails_app_generator/dependencies'
-require 'rails_app_generator/add_on'
-Dir[File.join(__dir__, 'rails_app_generator', 'addons', '*.rb')].sort.each { |file| require file }
+require 'rails_app_generator/addon'
+require 'rails_app_generator/addon_util'
 require 'rails_app_generator/formatted_gem_entry'
 require 'rails_app_generator/app_builder'
 require 'rails_app_generator/app_generator'
 require 'rails_app_generator/starter'
 
+Dir[File.join(__dir__, 'rails_app_generator', 'addons', '*.rb')].sort.each { |file| require file }
+
 module RailsAppGenerator
   # raise RailsAppGenerator::Error, 'Sample message'
   Error = Class.new(StandardError)

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "rails_app_generator",
-  "version": "0.1.25",
+  "version": "0.1.28",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "rails_app_generator",
-      "version": "0.1.25",
+      "version": "0.1.28",
       "dependencies": {
         "daisyui": "^2.20.0"
       },

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_app_generator",
-  "version": "0.1.25",
+  "version": "0.1.28",
   "description": "Create new Rails Application with custom opinions",
   "scripts": {
     "release": "semantic-release"

data/profiles/addons/mini_magick.json

@@ -0,0 +1,12 @@
+{
+  "args": {
+    "app_path": "mini_magick",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/addons"
+  },
+  "opts": {
+    "skip_git": true,
+    "skip_test": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/mini_magick/_.rb",
+    "add_mini_magick": true
+  }
+}

data/tasks/addon.thor

@@ -6,8 +6,8 @@ require 'net/http'
 require 'json'
 require_relative 'gem_info'
 
-# Thor task to create a new AddOn for Rails App Generator
-class AddOn < Thor
+# Thor task to create a new Addon for Rails App Generator
+class Addon < Thor
   include Thor::Actions
 
   source_root(File.expand_path('../templates/thor_task', File.dirname(__FILE__)))
@@ -27,9 +27,9 @@ class AddOn < Thor
 
   # method_option :from, :required => true
   desc 'new', 'Create a new Addon for Rails App Generator'
-  method_option :gem  , type: :string, default: nil, desc: 'Add required_gem helper to the AddOn. Gem name is looked up to find version and description'
+  method_option :gem  , type: :string, default: nil, desc: 'Add required_gem helper to the Addon. Gem name is looked up to find version and description'
   method_option :force, type: :boolean, default: false, desc: 'Overwrite existing files'
-  method_option :depends_on, type: :string, desc: 'This AddOn depends on another AddOn/Gem. active_record is a common dependency'
+  method_option :depends_on, type: :string, desc: 'This Addon depends on another Addon/Gem. active_record is a common dependency'
   def new(name)
     self.name = snake(name)
     self.data = build_data

data/templates/thor_task/addon/addon.tt

@@ -11,7 +11,7 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add <%= data.name_camel %> to rails application
-    class <%= data.name_camel %> < AddOn
+    class <%= data.name_camel %> < RailsAppGenerator::Addon
 <%= data.addon_config_code %>
       def apply
         say 'Setting up <%= data.name_camel %>'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_app_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.25
+  version: 0.1.28
 platform: ruby
 authors:
 - David Cruwys
@@ -218,6 +218,16 @@ files:
 - after_templates/addons/httparty/app/views/layouts/_footer.html.erb
 - after_templates/addons/httparty/app/views/layouts/_navbar.html.erb
 - after_templates/addons/httparty/app/views/layouts/application.html.erb
+- after_templates/addons/mini_magick/_.rb
+- after_templates/addons/mini_magick/app/assets/images/cat1.jpg
+- after_templates/addons/mini_magick/app/assets/images/cat2.jpg
+- after_templates/addons/mini_magick/app/assets/images/cat3.jpg
+- after_templates/addons/mini_magick/app/controllers/home_controller.rb
+- after_templates/addons/mini_magick/app/views/home/index.html.erb
+- after_templates/addons/mini_magick/app/views/layouts/_alerts.html.erb
+- after_templates/addons/mini_magick/app/views/layouts/_footer.html.erb
+- after_templates/addons/mini_magick/app/views/layouts/_navbar.html.erb
+- after_templates/addons/mini_magick/app/views/layouts/application.html.erb
 - after_templates/addons/rails_html_sanitizer/_.rb
 - after_templates/addons/rails_html_sanitizer/home/index.html.erb
 - after_templates/addons/twilio_ruby/_.rb
@@ -355,7 +365,8 @@ files:
 - docs/videos.md
 - exe/rag
 - lib/rails_app_generator.rb
-- lib/rails_app_generator/add_on.rb
+- lib/rails_app_generator/addon.rb
+- lib/rails_app_generator/addon_util.rb
 - lib/rails_app_generator/addons/acts_as_list.rb
 - lib/rails_app_generator/addons/annotate.rb
 - lib/rails_app_generator/addons/browser.rb
@@ -389,7 +400,6 @@ files:
 - lib/rails_app_generator/addons/stimulus_components.rb
 - lib/rails_app_generator/addons/tailwind.rb
 - lib/rails_app_generator/addons/views.rb
-- lib/rails_app_generator/addons/xmen.rb
 - lib/rails_app_generator/app_builder.rb
 - lib/rails_app_generator/app_generator.rb
 - lib/rails_app_generator/cli/diff.rb
@@ -402,9 +412,6 @@ files:
 - lib/rails_app_generator/diff/processor.rb
 - lib/rails_app_generator/diff/report.rb
 - lib/rails_app_generator/formatted_gem_entry.rb
-- lib/rails_app_generator/generators/advisories_generator.rb
-- lib/rails_app_generator/generators/base.rb
-- lib/rails_app_generator/generators/foo_generator.rb
 - lib/rails_app_generator/notes/commands-list.txt
 - lib/rails_app_generator/notes/methods-class.txt
 - lib/rails_app_generator/notes/methods-instance.txt
@@ -431,6 +438,7 @@ files:
 - profiles/addons/hexapdf.json
 - profiles/addons/honeybadger.json
 - profiles/addons/httparty.json
+- profiles/addons/mini_magick.json
 - profiles/addons/rails-html-sanitizer.json
 - profiles/addons/twilio_ruby.json
 - profiles/rag-add-some-pages.json

data/lib/rails_app_generator/addons/xmen.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module RailsAppGenerator
-  # Custom add-ons for RailsAppGenerator
-  module AddOns
-    # Add Xmen to rails application
-    class Xmen < AddOn
-      # depends_on :active_record
-
-      # required_gem gem.version('annotate', '3.2.0', 'Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema.')
-
-      def apply
-        template('auto_annotate_models.rake', 'lib/tasks/auto_annotate_models.rake', force: true)
-      end
-    end
-  end
-end

data/lib/rails_app_generator/generators/advisories_generator.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module RailsAppGenerator
-  # xxxx
-  class AdvisoriesGenerator < Generators::Base
-    def bundler_audit_gem
-      gem 'bundler-audit', '>= 0.7.0', require: false, group: %i[development test]
-      Bundler.with_unbundled_env { run 'bundle install' }
-    end
-
-    def rake_task
-      copy_file 'bundler_audit.rake', 'lib/tasks/bundler_audit.rake'
-      append_file 'Rakefile', %(\ntask default: "bundle:audit"\n)
-    end
-  end
-end

data/lib/rails_app_generator/generators/base.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-# require "rails/generators"
-# require_relative "../actions"
-
-module RailsAppGenerator
-  module Generators
-    class Base < Rails::Generators::Base
-      # include Suspenders::Actions
-      # include ExitOnFailure
-
-      # def self.default_source_root
-      #   File.expand_path(File.join("..", "..", "..", "templates"), __dir__)
-      # end
-
-      # def self.inherited(subclass)
-      #   super
-
-      #   description_file = File.expand_path(
-      #     File.join(
-      #       default_source_root,
-      #       "descriptions",
-      #       "#{subclass.generator_name}.md"
-      #     )
-      #   )
-
-      #   subclass.desc File.read(description_file)
-      # rescue Errno::ENOENT
-      # end
-
-      # def app_name
-      #   Rails.app_class.module_parent_name.demodulize.underscore.dasherize
-      # end
-
-      # def empty_directory_with_keep_file(destination)
-      #   empty_directory(destination, {})
-      #   keep_file(destination)
-      # end
-
-      # def keep_file(destination)
-      #   create_file(File.join(destination, ".keep"))
-      # end
-
-      # def append_template_to_file(destination, source, *args)
-      #   partial = File.expand_path(find_in_source_paths(source))
-      #   append_to_file(destination, File.read(partial, *args))
-      # end
-
-      # def prepend_template_to_file(destination, source, *args)
-      #   partial = File.expand_path(find_in_source_paths(source))
-      #   prepend_to_file(destination, File.read(partial, *args))
-      # end
-
-      # def inject_template_into_file(destination, source, *args)
-      #   partial = File.expand_path(find_in_source_paths(source))
-      #   inject_into_file(destination, File.read(partial), *args)
-      # end
-    end
-  end
-end

data/lib/rails_app_generator/generators/foo_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-# Some comment
-module RailsAppGenerator
-  # xxx
-  class FooGenerator < Generators::Base
-    def bundler_audit_gem
-      puts '11111111111'
-    end
-
-    def rake_task
-      puts '22222222222'
-    end
-  end
-end