rails_app_generator 0.2.21 → 0.2.24

data/lib/rails_app_generator/addons/avo.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Avo to rails application
+    class Avo < RailsAppGenerator::Addon
+      required_gem gem.version('avo', '2.12.0', 'Avo full-featured admin panel abstracts away the common parts of building apps, letting your engineers work on your apps essential components.')
+
+      def apply
+        # copy_file 'config/initializers/avo.rb'
+      end
+
+      def before_template
+        say 'Setting up Avo - before custom template'
+      end
+
+      def before_bundle
+        say 'Setting up Avo - before bundle install'
+      end
+
+      def after_bundle
+        say 'Setting up Avo - after bundle install'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/addons/devise.rb

@@ -3,58 +3,108 @@
 module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
-    # Add Devise authentication to rails application
+    # 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')
 
-      # Requires Testing
       def apply
         generate('devise:install', capture: true)
-        generate(:devise, 'User', 'name', 'admin:boolean', capture: true)
+        generate(:devise, 'User', 'name', 'role:integer', capture: true)
 
-        directory('app/views/devise', 'app/views/devise') if uses?(:views)
+        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_development_rb
-        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
-        create_seed
+        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_development_rb
-        inject_into_file 'config/environments/development.rb', before: /^end/ do
-          <<-RUBY
+      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
+        RUBY
       end
 
-      def db_changes
+      def update_routes_with_devise_controllers
         in_root do
-          migration = Dir.glob('db/migrate/*').max_by { |f| File.mtime(f) }
-          gsub_file migration, /:admin/, ':admin, default: false'
+          gsub_file 'config/routes.rb', /devise_for :users/, 'devise_for :users, controllers: { sessions: "users/sessions", registrations: "users/registrations" }'
         end
       end
 
-      def create_seed
-        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
+      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

data/lib/rails_app_generator/addons/devise_old.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Custom add-ons for RailsAppGenerator
+  module AddOns
+    # Add Devise authentication to rails application
+    class DeviseXxxx < RailsAppGenerator::Addon
+      depends_on :active_record
+
+      required_gem gem.version('devise', '4.8.1', 'Flexible authentication solution for Rails with Warden')
+
+      # Requires Testing
+      def apply
+        update_development_rb
+        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
+        create_seed
+      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

@@ -170,27 +170,38 @@ module RailsAppGenerator
       add_if(:acts_as_list) # tested
       add_if(:administrate) # tested
       add_if(:annotate) # tested
-      add_if(:browser)
+      add_if(:avo) # tested
       add_if(:bcrypt) # tested
-      add_if(:chartkick)
-      add_if(:continuous_integration)
-      add_if(:devise)
-      add_if(:groupdate)
-      add_if(:factory_bot)
-      add_if(:faker)
-      add_if(:generators)
-      add_if(:hexapdf)
-      add_if(:httparty)
-      add_if(:high_voltage)
-      add_if(:honeybadger)
-      add_if(:lograge)
-      add_if(:mini_magick)
-      add_if(:pundit)
-      add_if(:rails_app_generator)
-      add_if(:services)
-      add_if(:shoulda)
-      add_if(:sidekiq)
-      add_if(:twilio_ruby)
+      add_if(:browser) # tested
+      add_if(:chartkick) # tested
+      add_if(:continuous_integration) # TODO: needs work
+      add_if(:devise) # tested
+      # docker_compose
+      # docker
+      add_if(:dotenv) # tested
+      add_if(:factory_bot) # TODO: needs testing
+      add_if(:faker) # tested
+      add_if(:generators) # TODO: needs testing
+      add_if(:groupdate) # TODO: does not have a profile
+      add_if(:hexapdf) # tested
+      add_if(:httparty) # tested
+      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
+      add_if(:phony_rails) # tested
+      add_if(:pundit) # TODO: needs testing
+      add_if(:rails_html_sanitizer) # tested
+      add_if(:rails_app_generator) # TODO: needs testing
+      add_if(:redcarpet) # tested
+      add_if(:services) # TODO: needs testing
+      add_if(:shoulda) # TODO: needs testing
+      add_if(:sidekiq) # TODO: needs testing
+      add_if(:rubocop) # tested
+      add_if(:twilio_ruby) # tested
       add(:views, :errors, :scaffold) if active?(:views)
 
       # invoke :rails_customization
@@ -200,6 +211,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
@@ -422,6 +437,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

@@ -86,17 +86,12 @@ KConfig.configure do |config|
 
   # rag.add_option :add_irbrc                   , type: :boolean, default: false
   # rag.add_option :add_foreman                 , type: :boolean, default: false
-  rag.add_option :add_devise                  , type: :boolean, default: false
-  rag.add_option :add_dotenv                  , type: :boolean, default: false
   # rag.add_option :add_docker                  , type: :boolean, default: false
   # rag.add_option :add_docker_compose          , type: :boolean, default: false
-  rag.add_option :add_rubocop                 , type: :boolean, default: false
-  rag.add_option :add_annotate                , type: :boolean, default: false
   # rag.add_option :add_continuous_integration  , type: :boolean, default: false
   # rag.add_option :add_high_voltage            , type: :boolean, default: false
   # rag.add_option :add_generators              , type: :boolean, default: false
-  rag.add_option :add_lograge                 , type: :boolean, default: false
-  # rag.add_option :add_pundit                  , type: :boolean, default: false
+  # rag.add_option :add_pundit                  , type: :boolean, default: false # cancancan vs action_policy vs pundit
   # rag.add_option :add_services                , type: :boolean, default: false
   # rag.add_option :add_sidekiq                 , type: :boolean, default: false
   # rag.add_option :add_views                   , type: :boolean, default: false
@@ -104,24 +99,45 @@ 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
   rag.add_option :add_administrate            , type: :boolean, default: false
-  rag.add_option :add_browser                 , type: :boolean, default: false
+  rag.add_option :add_annotate                , type: :boolean, default: false
+  rag.add_option :add_avo                     , type: :boolean, default: false
   rag.add_option :add_bcrypt                  , type: :boolean, default: false
+  rag.add_option :add_browser                 , type: :boolean, default: false
   rag.add_option :add_chartkick               , type: :boolean, default: false
+  # continuous_integration
+  rag.add_option :add_devise                  , type: :boolean, default: false
+  # docker_compose
+  # docker
+  rag.add_option :add_dotenv                  , type: :boolean, default: false
+  # factory_bot
   rag.add_option :add_faker                   , type: :boolean, default: false
+  # generators
   rag.add_option :add_groupdate               , type: :boolean, default: false
   rag.add_option :add_hexapdf                 , type: :boolean, default: false
   rag.add_option :add_httparty                , type: :boolean, default: false
+  # 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_phony_rails             , type: :boolean, default: false
   rag.add_option :add_public_suffix           , type: :boolean, default: false
+  rag.add_option :add_phony_rails             , type: :boolean, default: false
+  # pundit
   rag.add_option :add_rails_html_sanitizer    , type: :boolean, default: false
+  # rails_app_generator
+  # RANSACK
   rag.add_option :add_redcarpet               , type: :boolean, default: false
+  # services
+  # shoulda
+  # sidekiq
+  rag.add_option :add_rubocop                 , type: :boolean, default: false
   rag.add_option :add_twilio_ruby             , type: :boolean, default: false
 end
 

data/lib/rails_app_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  VERSION = '0.2.21'
+  VERSION = '0.2.24'
 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.21",
+  "version": "0.2.24",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "rails_app_generator",
-      "version": "0.2.21",
+      "version": "0.2.24",
       "dependencies": {
         "daisyui": "^2.20.0"
       },

data/package.json

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

data/profiles/addons/avo.json

@@ -0,0 +1,16 @@
+{
+  "args": {
+    "app_path": "avo",
+    "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/avo/_.rb",
+    "add_annotate": true,
+    "add_avo": true,
+    "add_devise": true,
+    "add_faker": true,
+    "add_rubocop": true
+  }
+}

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/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

data/tasks/profile.thor

@@ -2,8 +2,8 @@
 
 # https://codecrate.com/2014/01/replace-rake-with-thor.html
 
-require_relative 'gem_info'
 require 'cmdlet'
+require 'rails_app_generator'
 
 # Thor task to create a new Profile for Rails App Generator
 class Profile < Thor
@@ -70,7 +70,7 @@ class Profile < Thor
     def build_data
       gi = gem_info(name)
 
-      description = gi ? gi.description : 'Description goes here'
+      description = gi ? gi.comment : 'Description goes here'
 
       Data.new(
         name: name,
@@ -104,7 +104,7 @@ class Profile < Thor
 
       gem_name = options[:gem] == 'gem' ? name : options[:gem]
 
-      GemInfo.get(gem_name)
+      RailsAppGenerator::GemQuery.get(gem_name)
     end
 
     def human(value)

data/templates/Gemfile.erb

@@ -1,6 +1,7 @@
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
+# xmen
 ruby <%= "'#{RUBY_VERSION}'" -%>
 
 <% gems.each do |gem| %><%= gem %>

data/{after_templates/rag/devise/turbo_controller.rb → templates/addons/devise/app/controllers/turbo_devise_controller.rb}

@@ -1,16 +1,10 @@
-class TurboController < ApplicationController
-
-  # This is required for Devise to work.
-  # See: https://youtu.be/m3uhldUGVes?t=1432
-  #
-  # Having issues with devise/turbo.
-  # See: https://gorails.com/episodes/devise-hotwire-turbo
+class TurboDeviseController < ApplicationController
   class Responder < ActionController::Responder
     def to_turbo_stream
       controller.render(options.merge(formats: :html))
-    rescue ActionView::MissingTemplate => error
+    rescue ActionView::MissingTemplate => e
       if get?
-        raise error
+        raise e
       elsif has_errors? && default_action
         render rendering_options.merge(formats: :html, status: :unprocessable_entity)
       else
@@ -21,4 +15,4 @@ class TurboController < ApplicationController
 
   self.responder = Responder
   respond_to :html, :turbo_stream
-end
+end