RubyGems - rails_app_generator - Versions diffs - 0.2.22 → 0.2.23 - Mend

rails_app_generator 0.2.22 → 0.2.23

Files changed (76) hide show

data/after_templates/rag/testy/_.rb ADDED Viewed

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+# Description goes here
+#
+# exe/rag addons/testy
+self.local_template_path = File.dirname(__FILE__)
+gac 'base rails 7 image created'
+prepare_environment
+add_controller('home', 'index')
+route("root 'home#index'")
+force_copy
+directory "app/controllers"
+directory "app/views/home"
+directory "app/views/layouts"
+template  'app/views/layouts/application.html.erb'        , 'app/views/layouts/application.html.erb'
+template  'db/seeds.rb'                                   , 'db/seeds.rb'
+after_bundle do
+  setup_db
+end
+def setup_db
+  # add_scaffold('post', 'title', 'body:text', 'user:references')
+  # add_scaffold('people', 'first_name', 'last_name', 'age:integer', 'address:text')
+  # add_scaffold('product', 'name', 'price:integer')
+  # db_migrate
+  # db_seed
+end
+# Other template command examples
+# prepare_environment
+# bundle_install
+# css_install('tailwind')
+# rails_command('db:migrate')
+# rails_command('db:migrate')
+# bundle_add('hotwire-rails')
+# rails_command('hotwire:install')
+# run('bin/importmap pin sortablejs')
+# run('npm install daisyui')
+# rubocop
+#
+# directory         'app/assets/images'
+# create_file       'app/assets/stylesheets/custom-bootstrap-import.scss' , read_template('custom-bootstrap-import.scss')
+# append_to_file    'app/assets/config/manifest.js'                       , read_template('manifest.js')
+# insert_into_file  'app/views/layouts/application.html.erb', read_template('application.html.erb'),
+#     before: %(    <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>)
+# gsub_file         'app/views/layouts/application.html.erb', %(container mx-auto mt-28 px-5 flex), 'container mx-auto px-5'
+# template 'home.css', 'app/assets/stylesheets/home.css'
+#
+# add_controller('page', 'benefits', 'faq', 'terms', 'privacy', '--skip-routes')
+# route(<<-'RUBY')
+# PageController.action_methods.each do |action|
+#   get "/#{action}", to: "page##{action}", as: "page_#{action}"
+# end
+# RUBY

data/after_templates/rag/testy/app/controllers/home_controller.rb ADDED Viewed

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/after_templates/rag/testy/app/views/home/index.html.erb ADDED Viewed

@@ -0,0 +1,3 @@
+<h1>Testy</h1>
+<p>Description goes here</p>

data/after_templates/rag/testy/app/views/layouts/_footer.html.erb ADDED Viewed

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

data/after_templates/rag/testy/app/views/layouts/_navbar.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<%= link_to 'Home', root_path %>
+<%# link_to 'Products', products_path %>
+<%# link_to 'Posts', posts_path %>
+<%# link_to 'People', people_path %>
+<hr />

data/after_templates/rag/testy/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,29 @@
+<!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 -%>
+  </head>
+  <body>
+    <header>
+      <%%= render 'layouts/navbar' %>
+      <hr />
+    </header>
+    <main>
+      <%%= yield %>
+    </main>
+    <footer>
+      <%%= render 'layouts/footer' %>
+    </footer>
+  </body>
+</html>

data/after_templates/rag/testy/db/seeds.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# david = User.create(email: 'david@site.com', name: 'david', password: 'password')
+# james = User.create(email: 'james@site.com', name: 'james', password: 'password')
+# sally = User.create(email: 'sally@site.com', name: 'sally', password: 'password')
+# 10.times do |i|
+#   Post.create(title: "Post #{i}", body: "This is the body of post #{i}", user: User.all.sample)
+# end

data/lib/rails_app_generator/addon.rb CHANGED Viewed

@@ -35,6 +35,12 @@ module RailsAppGenerator
         context.options
       end
+      def option?(option_name)
+        value = options[option_name.to_sym]
+        !value.nil?
+      end
       def uses?(addon_name = nil)
         addon_name ||= self.class.addon_name
@@ -94,16 +100,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 ADDED Viewed

@@ -0,0 +1,111 @@
+# 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
+          gsub_file 'config/routes.rb', /devise_for :users/, 'devise_for :users, controllers: { sessions: "users/sessions", registrations: "users/registrations" }'
+        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_old.rb CHANGED Viewed

@@ -4,58 +4,19 @@ module RailsAppGenerator
   # Custom add-ons for RailsAppGenerator
   module AddOns
     # Add Devise authentication to rails application
-    class Devise < RailsAppGenerator::Addon
+    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
-        generate('devise:install', capture: true)
-        generate(:devise, 'User', 'name', 'admin:boolean', capture: true)
-        directory('app/views/devise', 'app/views/devise') if uses?(:views)
-        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
       end
-      private
-      def update_development_rb
-        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
-      end
-      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
-      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
-      end
     end
   end
 end

data/lib/rails_app_generator/app_generator.rb CHANGED Viewed

@@ -175,7 +175,7 @@ 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
       # docker_compose
       # docker
       add_if(:dotenv) # tested
@@ -210,6 +210,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 +436,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 ADDED Viewed

@@ -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 CHANGED Viewed

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

data/lib/rails_app_generator/version.rb CHANGED Viewed

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

data/lib/rails_app_generator.rb CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/package.json CHANGED Viewed

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

data/profiles/addons/devise.json ADDED Viewed

@@ -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/rag/testy.json ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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} RENAMED Viewed

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

data/templates/addons/devise/app/controllers/users/registrations_controller.rb ADDED Viewed

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+class Users::RegistrationsController < Devise::RegistrationsController
+  before_action :configure_sign_up_params, only: [:create]
+  before_action :configure_account_update_params, only: [:update]
+  # GET /resource/sign_up
+  # def new
+  #   super
+  # end
+  # POST /resource
+  # def create
+  #   super
+  # end
+  # GET /resource/edit
+  # def edit
+  #   super
+  # end
+  # PUT /resource
+  # def update
+  #   super
+  # end
+  # DELETE /resource
+  # def destroy
+  #   super
+  # end
+  # GET /resource/cancel
+  # Forces the session data which is usually expired after sign
+  # in to be expired now. This is useful if the user wants to
+  # cancel oauth signing in/up in the middle of the process,
+  # removing all OAuth session data.
+  # def cancel
+  #   super
+  # end
+  # protected
+  # If you have extra params to permit, append them to the sanitizer.
+  def configure_sign_up_params
+    devise_parameter_sanitizer.permit(:sign_up, keys: [:name])
+  end
+  # If you have extra params to permit, append them to the sanitizer.
+  def configure_account_update_params
+    devise_parameter_sanitizer.permit(:account_update, keys: [:name])
+  end
+  # The path used after sign up.
+  # def after_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+  # The path used after sign up for inactive accounts.
+  # def after_inactive_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+end