rails_app_generator 0.2.22 → 0.2.25

data/docs/last_run/app_generator_data.json

@@ -2,7 +2,7 @@
   "options": {
     "skip_namespace": false,
     "skip_collision_check": false,
-    "ruby": "/Users/davidcruwys/.asdf/installs/ruby/3.1.1/bin/ruby",
+    "ruby": "/Users/davidcruwys/.asdf/installs/ruby/2.7.6/bin/ruby",
     "database": "sqlite3",
     "skip_git": true,
     "skip_keeps": false,
@@ -26,33 +26,36 @@
     "main": false,
     "no_rc": false,
     "api": false,
-    "javascript": "importmap",
+    "javascript": "esbuild",
     "skip_bundle": false,
     "note": "",
     "test": "rspec",
     "add_acts_as_list": false,
-    "add_administrate": true,
+    "add_administrate": false,
     "add_annotate": true,
     "add_avo": false,
     "add_bcrypt": false,
     "add_browser": false,
     "add_chartkick": false,
-    "add_devise": false,
+    "add_devise": true,
+    "add_devise_masquerade": true,
     "add_dotenv": false,
-    "add_faker": true,
+    "add_faker": false,
     "add_groupdate": false,
     "add_hexapdf": false,
     "add_httparty": false,
     "add_honeybadger": false,
     "add_lograge": false,
+    "add_minimal_css": true,
+    "minimal_css_library": "water.css",
     "add_mini_magick": false,
     "add_motor_admin": false,
     "add_public_suffix": false,
     "add_phony_rails": false,
     "add_rails_html_sanitizer": false,
     "add_redcarpet": false,
-    "add_rubocop": true,
+    "add_rubocop": false,
     "add_twilio_ruby": false,
-    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/administrate/_.rb"
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/devise_masquerade/_.rb"
   }
 }

data/docs/last_run/rails_options_class.json

@@ -48,6 +48,7 @@
     "add_browser",
     "add_chartkick",
     "add_devise",
+    "add_devise_masquerade",
     "add_dotenv",
     "add_faker",
     "add_groupdate",
@@ -55,6 +56,8 @@
     "add_httparty",
     "add_honeybadger",
     "add_lograge",
+    "add_minimal_css",
+    "minimal_css_library",
     "add_mini_magick",
     "add_motor_admin",
     "add_public_suffix",
@@ -111,7 +114,7 @@
       "name": "ruby",
       "description": "Path to the Ruby binary of your choice",
       "type": "string",
-      "default": "/Users/davidcruwys/.asdf/installs/ruby/3.1.1/bin/ruby",
+      "default": "/Users/davidcruwys/.asdf/installs/ruby/2.7.6/bin/ruby",
       "required": false
     },
     {
@@ -401,6 +404,13 @@
       "default": false,
       "required": false
     },
+    {
+      "name": "add_devise_masquerade",
+      "description": "",
+      "type": "boolean",
+      "default": false,
+      "required": false
+    },
     {
       "name": "add_dotenv",
       "description": "",
@@ -450,6 +460,20 @@
       "default": false,
       "required": false
     },
+    {
+      "name": "add_minimal_css",
+      "description": "",
+      "type": "boolean",
+      "default": false,
+      "required": false
+    },
+    {
+      "name": "minimal_css_library",
+      "description": "Minimal CSS library to get you started. [options: water.css (default)]",
+      "type": "string",
+      "default": "water.css",
+      "required": false
+    },
     {
       "name": "add_mini_magick",
       "description": "",

data/docs/last_run/rails_options_data.json

@@ -6,8 +6,8 @@
     "pretend": false,
     "quiet": false,
     "skip": false,
-    "ruby": "/Users/davidcruwys/.asdf/installs/ruby/3.1.1/bin/ruby",
-    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/administrate/_.rb",
+    "ruby": "/Users/davidcruwys/.asdf/installs/ruby/2.7.6/bin/ruby",
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/devise_masquerade/_.rb",
     "database": "sqlite3",
     "skip_git": true,
     "skip_keeps": false,
@@ -35,33 +35,37 @@
     "version": false,
     "api": false,
     "minimal": false,
-    "javascript": "importmap",
+    "javascript": "esbuild",
     "css": "",
     "skip_bundle": false,
     "note": "",
     "test": "rspec",
     "add_acts_as_list": false,
-    "add_administrate": true,
+    "add_administrate": false,
     "add_annotate": true,
     "add_avo": false,
     "add_bcrypt": false,
     "add_browser": false,
     "add_chartkick": false,
-    "add_devise": false,
+    "add_devise": true,
+    "add_devise_masquerade": true,
     "add_dotenv": false,
-    "add_faker": true,
+    "add_faker": false,
     "add_groupdate": false,
     "add_hexapdf": false,
     "add_httparty": false,
     "add_honeybadger": false,
     "add_lograge": false,
+    "add_minimal_css": true,
+    "minimal_css_library": "water.css",
     "add_mini_magick": false,
     "add_motor_admin": false,
     "add_public_suffix": false,
     "add_phony_rails": false,
     "add_rails_html_sanitizer": false,
     "add_redcarpet": false,
-    "add_rubocop": true,
-    "add_twilio_ruby": false
+    "add_rubocop": false,
+    "add_twilio_ruby": false,
+    "notes": "there is a name conflict if the rails application has the same name as the gem and so devise_masquerade has been renamed to devise_masquerade_sample"
   }
 }

data/lib/rails_app_generator/addon.rb

@@ -35,6 +35,22 @@ module RailsAppGenerator
         context.options
       end
 
+      def add_flag?(option_name)
+        value = options["add_#{option_name}".to_sym]
+
+        return false if value.nil?
+
+        value == true
+      end
+
+      def active?(option_name)
+        add_flag?(option_name) # || !skip_flag?(option_name)
+      end
+
+      def option?(option_name)
+        !options[option_name.to_sym].nil?
+      end
+
       def uses?(addon_name = nil)
         addon_name ||= self.class.addon_name
 
@@ -94,16 +110,28 @@ module RailsAppGenerator
         @gem_entries ||= []
       end
 
-      protected
-
       def depends_on(*addon)
         @dependencies = addon.map(&:to_sym)
       end
 
       def required_gem(gem_entry)
+        existing_gem = gem_entries.find { |gem| gem.name == gem_entry.name }
+
+        if existing_gem
+          return if Gem::Version.new(gem_entry.version) < Gem::Version.new(existing_gem.version)
+
+          existing_gem.version = gem_entry.version
+          existing_gem.comment = gem_entry.comment
+          return
+        end
+
         gem_entries << gem_entry
       end
 
+      def reset_gem_entries
+        @gem_entries = []
+      end
+
       def gem
         Rails::Generators::AppBase::GemfileEntry
       end

data/lib/rails_app_generator/addons/devise.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Devise to rails application
+    class Devise < RailsAppGenerator::Addon
+      depends_on :active_record
+
+      required_gem gem.version('devise', '4.8.1', 'Flexible authentication solution for Rails with Warden')
+
+      def apply
+        generate('devise:install', capture: true)
+        generate(:devise, 'User', 'name', 'role:integer', capture: true)
+
+        update_migration
+
+        add_trackable       if option?(:devise_has_trackable)
+        add_confirmable     if option?(:devise_has_confirmable)
+        add_lockable        if option?(:devise_has_lockable)
+
+        add_turbo_support
+
+        generate('devise:views', capture: true)
+        generate('devise:controllers', 'users', capture: true)
+
+        update_routes_with_devise_controllers
+
+        copy_file('app/controllers/users/registrations_controller.rb', 'app/controllers/users/registrations_controller.rb', force: true)
+
+        enable_devise_mailer
+
+        directory('app/views', force: true)
+      end
+
+      def before_bundle
+        prepend_to_file 'db/seeds.rb', seed, force: true
+      end
+
+      private
+
+      def update_migration
+        in_root do
+          migration = Dir.glob('db/migrate/*').max_by { |f| File.mtime(f) }
+          gsub_file migration, /:role/, ':role, default: 0'
+        end
+      end
+
+      def enable_devise_mailer
+        inject_into_file 'config/environments/development.rb', <<-RUBY, after: %(config.action_mailer.raise_delivery_errors = false)
+
+  # Enable devise mailer
+  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+        RUBY
+      end
+
+      def update_routes_with_devise_controllers
+        in_root do
+          controller_config = [
+            'sessions: "users/sessions"',
+            'registrations: "users/registrations"'
+          ]
+          controller_config << 'masquerades: "users/masquerades"' if active?(:devise_masquerade)
+
+          devise_for_replacement = "devise_for :users, controllers: { #{controller_config.join(', ')} }"
+
+          gsub_file 'config/routes.rb', /devise_for :users/, devise_for_replacement
+        end
+      end
+
+      def add_trackable
+        # TODO: remove these comments in generated file
+
+        ## Trackable
+        # t.integer  :sign_in_count, default: 0, null: false
+        # t.datetime :current_sign_in_at
+        # t.datetime :last_sign_in_at
+        # t.string   :current_sign_in_ip
+        # t.string   :last_sign_in_ip
+      end
+
+      def add_confirmable
+        # TODO: remove these comments in generated file
+
+        ## Confirmable
+        # t.string   :confirmation_token
+        # t.datetime :confirmed_at
+        # t.datetime :confirmation_sent_at
+        # t.string   :unconfirmed_email # Only if using reconfirmable
+      end
+
+      def add_lockable
+        # TODO: remove these comments in generated file
+
+        ## Lockable
+        # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
+        # t.string   :unlock_token # Only if unlock strategy is :email or :both
+        # t.datetime :locked_at
+      end
+
+      def add_turbo_support
+        copy_file('app/controllers/turbo_devise_controller.rb', 'app/controllers/turbo_devise_controller.rb')
+        copy_file('config/initializers/devise_turbo.rb', 'config/initializers/devise_turbo.rb')
+      end
+
+      def seed
+        <<~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.role = :admin
+          end
+
+        RUBY
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/devise_masquerade.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add DeviseMasquerade to rails application
+    class DeviseMasquerade < RailsAppGenerator::Addon
+      depends_on :devise
+
+      required_gem gem.version('devise_masquerade', '1.3.12', 'Devise extension that enables login as another user functionality')
+
+      def apply
+        # NOTE: update_routes_with_devise_controllers is being handled in devise.rb addon
+      end
+
+      # def update_routes_with_devise_controllers
+      #   in_root do
+      #     gsub_file 'config/routes.rb', /registrations: "users\/registrations"/, 'registrations: "users/registrations", masquerades: "users/masquerades"'
+      #   end
+      # end
+    end
+  end
+end

data/lib/rails_app_generator/addons/minimal_css.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add MinimalCss to rails application
+    class MinimalCss < RailsAppGenerator::Addon
+      LIBRARIES = {
+        water: {
+          source: 'https://watercss.kognise.dev',
+          content: '<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css">'
+        },
+        picnic: {
+          source: 'https://picnicss.com',
+          content: '<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/picnic">'
+        },
+        chota: {
+          source: 'https://jenil.github.io/chota/',
+          content: '<link rel="stylesheet" href="https://unpkg.com/chota@latest">'
+        }
+      }.freeze
+
+      # https://purecss.io/
+      # https://bulma.io/
+      # https://get.foundation/
+      # https://www.blazeui.com/
+      # https://getbase.org/
+      # https://cirrus-ui.netlify.app/
+      # https://vanillaframework.io/
+      # https://www.patternfly.org/v4/
+      # https://tachyons.io/
+      # https://nostalgic-css.github.io/NES.css/
+      # https://selekkt.dk/skelet/v3/
+      # https://picturepan2.github.io/spectre/
+      # https://kylelogue.github.io/mustard-ui/
+      # https://www.bonsaicss.com/
+      # https://ajusa.github.io/lit/
+      # https://www.cutestrap.com/
+      # https://kbrsh.github.io/wing/
+      # https://devinhunt.github.io/typebase.css/
+      # http://getskeleton.com/
+      # https://semantic-ui.com/
+      # https://getuikit.com/
+
+      # ANIMATION
+      # https://animate.style/
+      # https://www.csswand.dev/
+      # http://animation.kaustubhmenon.com/
+      # https://www.minimamente.com/project/magic/
+
+      def apply; end
+
+      def after_bundle
+        library_key = (options[:minimal_css_library] || 'water').to_sym
+
+        insert_into_file 'app/views/layouts/application.html.erb', head(library_key), before: %r{^\s+</head>}, force: true
+      end
+
+      private
+
+      def head(library_key)
+        library = LIBRARIES[library_key] || LIBRARIES[:water]
+
+        content = library[:content]
+
+        "    #{content}\n"
+      end
+    end
+  end
+end

data/lib/rails_app_generator/app_generator.rb

@@ -175,7 +175,8 @@ module RailsAppGenerator
       add_if(:browser) # tested
       add_if(:chartkick) # tested
       add_if(:continuous_integration) # TODO: needs work
-      add_if(:devise) # TODO: needs testing
+      add_if(:devise) # tested
+      add_if(:devise_masquerade) # tested
       # docker_compose
       # docker
       add_if(:dotenv) # tested
@@ -188,6 +189,7 @@ module RailsAppGenerator
       add_if(:high_voltage) # TODO: needs testing
       add_if(:honeybadger) # tested
       add_if(:lograge) # tested
+      add_if(:minimal_css) # tested (this is NOT a GEM)
       add_if(:mini_magick) # tested
       add_if(:motor_magick) # tested
       add_if(:public_suffix) # tested
@@ -210,6 +212,10 @@ module RailsAppGenerator
 
     # Fire any callbacks defined on addons either before running the custom template
     def apply_rails_template
+      # currently running prepare_environment in the template
+      # this is doing a bundle install
+      # unfortunately this bundle install happens before the normal bundle install, but for now
+      # I have to do it until I figure out the why I need the prepare_environment method anyway.
       addon_instances.select { |addon| addon.respond_to?(:before_template) }.each(&:before_template)
       super
     end
@@ -432,6 +438,10 @@ module RailsAppGenerator
         add_flag?(option_name) # || !skip_flag?(option_name)
       end
 
+      def option?(option_name)
+        !options[option_name.to_sym].nil?
+      end
+
       def uses?(addon)
         return false unless active?(addon)
 

data/lib/rails_app_generator/gem_query.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Retrieve GemInfo from RubyGems.org
+module RailsAppGenerator
+  # GemQuery queries RubyGems for GemEntry.
+  class GemQuery
+    class << self
+      def get(name)
+        gem_info = query_ruby_gems(name)
+
+        return gem_info if gem_info
+
+        return query_ruby_gems(name.gsub('_', '-')) if name.include?('_')
+        return query_ruby_gems(name.gsub('-', '_')) if name.include?('-')
+
+        abort "Cannot find GEM (#{name}) on RubyGems.org"
+      end
+
+      private
+
+      def query_ruby_gems(name)
+        link = "https://rubygems.org/api/v1/gems/#{name.downcase}.json"
+        info = Net::HTTP.get(URI.parse(link))
+        json = JSON.parse(info)
+
+        Rails::Generators::AppBase::GemfileEntry.new(json['name'], json['version'], json['description'])
+      rescue SocketError
+        abort 'Internet connection cannot be established to RubyGems.org'
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+end

data/lib/rails_app_generator/rag_initializer.rb

@@ -99,6 +99,7 @@ KConfig.configure do |config|
   # rag.add_option :add_scaffold                , type: :boolean, default: false
   # rag.add_option :add_factory_bot             , type: :boolean, default: false
   # rag.add_option :add_shoulda                 , type: :boolean, default: false
+  # letter_opener
 
   # NEW GEM ADDONS
   rag.add_option :add_acts_as_list            , type: :boolean, default: false
@@ -110,6 +111,7 @@ KConfig.configure do |config|
   rag.add_option :add_chartkick               , type: :boolean, default: false
   # continuous_integration
   rag.add_option :add_devise                  , type: :boolean, default: false
+  rag.add_option :add_devise_masquerade       , type: :boolean, default: false
   # docker_compose
   # docker
   rag.add_option :add_dotenv                  , type: :boolean, default: false
@@ -122,6 +124,8 @@ KConfig.configure do |config|
   # high_voltage
   rag.add_option :add_honeybadger             , type: :boolean, default: false
   rag.add_option :add_lograge                 , type: :boolean, default: false
+  rag.add_option :add_minimal_css             , type: :boolean, default: false
+  rag.add_option :minimal_css_library         , type: :string, default: 'water.css', description: "Minimal CSS library to get you started. [options: water.css (default)]"
   rag.add_option :add_mini_magick             , type: :boolean, default: false
   rag.add_option :add_motor_admin             , type: :boolean, default: false
   rag.add_option :add_public_suffix           , type: :boolean, default: false

data/lib/rails_app_generator/version.rb

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

data/lib/rails_app_generator.rb

@@ -28,6 +28,7 @@ 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/gem_query'
 require 'rails_app_generator/addon'
 require 'rails_app_generator/addon_util'
 require 'rails_app_generator/formatted_gem_entry'

data/package-lock.json

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

data/package.json

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

data/profiles/addons/devise.json

@@ -0,0 +1,16 @@
+{
+  "args": {
+    "app_path": "devise",
+    "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/devise/_.rb",
+    "notes": "javascript: esbuild is used for the demonstration of this addon so that the destroy_user_session_path can be used as a link using turbo_method: :delete",
+    "javascript": "esbuild",
+    "add_annotate": true,
+    "add_devise": true,
+    "add_faker": true
+  }
+}

data/profiles/addons/devise_masquerade.json

@@ -0,0 +1,17 @@
+{
+  "args": {
+    "app_path": "r7_devise_masquerade",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/addons"
+  },
+  "opts": {
+    "notes": "there is a name conflict if the rails application has the same name as the gem and so devise_masquerade has been renamed to devise_masquerade_sample",
+    "skip_git": true,
+    "skip_test": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/devise_masquerade/_.rb",
+    "javascript": "esbuild",
+    "add_annotate": true,
+    "add_devise": true,
+    "add_devise_masquerade": true,
+    "add_minimal_css": true
+  }
+}

data/profiles/addons/minimal_css.json

@@ -0,0 +1,15 @@
+{
+  "args": {
+    "app_path": "minimal_css",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/addons"
+  },
+  "opts": {
+    "skip_git": true,
+    "skip_test": true,
+    "note": "minimal_css_library is optional and will default to water if not specified.",
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/addons/minimal_css/_.rb",
+    "add_faker": true,
+    "add_minimal_css": true,
+    "minimal_css_library": "water"
+  }
+}

data/profiles/rag/testy.json

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

data/tasks/addon.thor

@@ -4,7 +4,9 @@
 
 require 'net/http'
 require 'json'
-require_relative 'gem_info'
+require 'pry'
+require 'cmdlet'
+require 'rails_app_generator'
 
 # Thor task to create a new Addon for Rails App Generator
 class Addon < Thor
@@ -46,9 +48,11 @@ class Addon < Thor
     end
 
     def build_required_gem_code
+      return nil unless options[:gem]
+
       info = gem_info
 
-      "      required_gem gem.version('#{info.name}', '#{info.version}', '#{info.description}')"
+      "      required_gem gem.version('#{info.name}', '#{info.version}', '#{info.comment}')"
     end
 
     # example: 'https://rubygems.org/api/v1/gems/draper.json'
@@ -57,7 +61,7 @@ class Addon < Thor
 
       gem_name = options[:gem] == 'gem' ? name : options[:gem]
 
-      ::GemInfo.get(gem_name)
+      RailsAppGenerator::GemQuery.get(gem_name)
     end
 
     def build_data