rails-interactive 1.0.0 → 2.1.1

data/lib/cli/prompt.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "tty/prompt"
+
+module RailsInteractive
+  class CLI
+    # Prompt class for commands
+    class Prompt
+      # Create a new instance
+      #
+      # @param msg [String] the message to display
+      # @param type [String] the type of prompt
+      # @param options [Array] the options to display
+      # @param required [Boolean] whether the prompt value is required
+      #
+      # @return [Interactive::Prompt] the new instance
+      def initialize(msg, type, options = nil, required: false)
+        @msg = msg
+        @type = type
+        @options = options
+        @required = required
+        @prompt = TTY::Prompt.new
+      end
+
+      # Perform the prompt
+      #
+      # @return [String] the value of the prompt
+      def perform
+        case @type
+        when "ask"
+          @prompt.ask(@msg, required: @required)
+        when "select"
+          @prompt.select(@msg, @options, required: @required)
+        when "multi_select"
+          @prompt.multi_select(@msg, @options)
+        else
+          puts "Invalid parameter"
+        end
+      end
+    end
+  end
+end

data/lib/cli/templates/setup_active_admin.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+run "bundle add activeadmin"
+run "bundle add bcrypt"
+Bundler.with_unbundled_env { run "bundle" }
+
+rails_command "generate active_admin:install"
+rails_command "db:migrate"

data/lib/cli/templates/setup_avo.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+run "rails db:prepare"
+run "bundle add avo"
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+rails_command("generate avo:install")
+
+puts "Avo is installed! You can go to http://localhost:3000/avo for next steps"

data/lib/cli/templates/setup_awesome_print.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+run 'bundle add awesome_print --group "development"'
+Bundler.with_unbundled_env { run "bundle install" }

data/lib/cli/templates/setup_better_errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+gem_group :development do
+  gem "better_errors"
+  gem "binding_of_caller"
+end
+
+Bundler.with_unbundled_env { run "bundle install" }

data/lib/cli/templates/setup_brakeman.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+run 'bundle add brakeman --group "development"'
+Bundler.with_unbundled_env { run "bundle install" }
+run "bundle binstubs brakeman"
+run "bin/brakeman"

data/lib/cli/templates/setup_bullet.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+run "bundle add bullet --group 'development'"
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+run "bundle exec rails g bullet:install"

data/lib/cli/templates/setup_cancancan.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+run "bundle add cancancan"
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+rails_command "generate cancan:ability"

data/lib/cli/templates/setup_devise.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+run "bundle add devise"
+Bundler.with_unbundled_env { run "bundle install" }
+
+rails_command "generate devise:install"
+
+run "rails generate devise User"
+run "rails db:prepare"
+run "rails db:migrate"

data/lib/cli/templates/setup_faker.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+run "bundle add faker --group 'development' 'test'"
+
+Bundler.with_unbundled_env { run "bundle install" }

data/lib/cli/templates/setup_friendly_id.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+run "bundle add 'friendly_id'"
+
+rails_command "generate friendly_id"

data/lib/cli/templates/setup_graphql.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+run "rails db:prepare"
+run "bundle add graphql"
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+rails_command("generate graphql:install")
+
+puts "GraphQL is installed!"

data/lib/cli/templates/setup_haml.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+def bundle_install
+  Bundler.with_unbundled_env { run "bundle install" }
+end
+
+run "bundle add haml"
+bundle_install
+
+if yes?("Would you like to convert your existing *.erb files to *.haml files? [y/n]")
+  run "bundle add erb2haml --group 'development'"
+  bundle_install
+  if yes?("Would you like to keep the original *.erb files? [y/n]")
+    rake "haml:convert_erbs"
+  else
+    rake "haml:replace_erbs"
+  end
+end

data/lib/cli/templates/setup_kaminari.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+run "bundle add kaminari"
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+puts "Kaminari is installed!"

data/lib/cli/templates/setup_letter_opener.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+run 'bundle add letter_opener --group "development"'
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+inject_into_file "config/environments/development.rb", after: "config.action_mailer.perform_caching = false\n" do
+  <<-RUBY
+
+  config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.perform_deliveries = true
+  RUBY
+end
+
+puts "Letter Opener is now installed!"

data/lib/cli/templates/setup_omniauth.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+run "bundle add omniauth"
+
+run "bundle install"
+
+# rubocop:disable Layout/LineLength
+rails_command "generate model identity user:references provider:string:index uid:string:index token:string:index refresh_token:string:index"
+# rubocop:enable Layout/LineLength
+
+rails_command "generate migration AddIdentityToUsers identities_count:integer"
+
+rails_command "db:migrate"
+
+inject_into_file "config/routes.rb", after: "devise_for :users\n" do
+  " # devise_for :users, controllers: { omniauth_callbacks: 'omniauth' }"
+end
+
+inject_into_file "app/models/user.rb", after: ":database_authenticatable, " do
+  ":omniauthable, "
+end
+
+inject_into_file "app/models/identity.rb", after: "belongs_to :user" do
+  ", counter_cache: true"
+end
+
+inject_into_file "app/models/user.rb", after: "class User < ApplicationRecord\n" do
+  # rubocop:disable Naming/HeredocDelimiterNaming
+  <<-EOF
+  has_many :identities, dependent: :destroy
+
+  def self.from_omniauth(auth)
+    if auth.present? && auth.provider.present? && auth.uid.present?
+      identity = Identity.where(provider: auth.provider, uid: auth.uid).first_or_initialize
+      if auth.credentials.present?
+        identity.token = auth.credentials.token
+        identity.refresh_token = auth.credentials.refresh_token
+      end
+      if identity.user.nil? && auth.info.email.present?
+        user = User.where(email: auth.info.email).first_or_initialize
+        user.name = auth.info.name
+        user.password = Devise.friendly_token if user.new_record?
+        user.save!
+        identity.user = user
+      end
+      identity.save!
+      identity.user
+    end
+  end
+
+  EOF
+  # rubocop:enable Naming/HeredocDelimiterNaming
+end
+
+file "app/controllers/omniauth_controller.rb", <<~CODE
+  class OmniauthController < Devise::OmniauthCallbacksController
+
+  end
+CODE
+
+puts "IMPORTANT: Add devise_for :users, controllers: { omniauth_callbacks: 'omniauth' } to your routes.rb"

data/lib/cli/templates/setup_pundit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+run "bundle add pundit"
+
+puts "Add - Pundit module to Application Controller"
+puts ""
+
+inject_into_file "app/controllers/application_controller.rb",
+                 after: "class ApplicationController < ActionController::Base\n" do
+  "  include Pundit\n"
+end
+
+puts "Run - Pundit Generator"
+
+rails_command("generate pundit:install")

data/lib/cli/templates/setup_rails_admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+run "rails db:prepare"
+run "bundle add rails_admin"
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+rails_command("generate rails_admin:install")
+
+puts "RailsAdmin is installed! You can go to your admin panel at /admin"

data/lib/cli/templates/setup_rspec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+run "spring stop"
+
+gem_group :development, :test do
+  gem "rspec-rails"
+end
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+rails_command "generate rspec:install"
+
+puts "RSpec is installed!"

data/lib/cli/templates/setup_rubocop.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+gem_group :development do
+  gem "rubocop", require: false
+end
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+run "rubocop --auto-gen-config"
+run "bundle binstubs rubocop"

data/lib/cli/templates/setup_sassc_rails.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+run "bundle add sassc-rails"
+Bundler.with_unbundled_env { run "bundle" }

data/lib/cli/templates/setup_sidekiq.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+def file_contains?(filename, string)
+  File.foreach(filename).detect { |line| line.include?(string) }
+end
+
+run "bundle add sidekiq"
+run "bundle add redis" unless file_contains? "Gemfile", "Gem 'redis'"
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+# rubocop:disable Naming/HeredocDelimiterNaming
+application do
+  <<~EOF
+    config.active_job.queue_adapter = :sidekiq
+  EOF
+end
+
+inject_into_file "config/routes.rb" do
+  <<~EOF
+    require "sidekiq/web"
+    if Rails.env.production?
+      Sidekiq::Web.use Rack::Auth::Basic do |username, password|
+        ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest(ENV["SIDEKIQ_USERNAME"])) &
+          ActiveSupport::SecurityUtils.secure_compare(::Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest(ENV["SIDEKIQ_PASSWORD"]))
+      end
+    end
+  EOF
+end
+# rubocop:enable Naming/HeredocDelimiterNaming
+
+route 'mount Sidekiq::Web => "/sidekiq"'

data/lib/cli/templates/setup_slim.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+def bundle_install
+  Bundler.with_unbundled_env { run "bundle install" }
+end
+
+run "bundle add slim-rails"
+
+bundle_install
+
+if yes?("Would you like to convert your existing *.erb files to *.slim files? [y/n]")
+  run "bundle add html2slim --group 'development'"
+  bundle_install
+  if yes?("Would you like to keep the original *.erb files? [y/n]")
+    run "erb2slim app/views"
+  else
+    run "erb2slim app/views -d"
+  end
+end

data/lib/cli/templates/setup_standardrb.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+gem_group :development, :test do
+  gem "standard"
+end
+
+Bundler.with_unbundled_env { run "bundle install" }
+
+puts "You can then run Standard from the command line with:"
+puts "bundle exec standardrb"

data/lib/cli/utils.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module RailsInteractive
+  class CLI
+    class Utils
+      def self.humanize(value)
+        return nil if value.nil?
+
+        value
+          .gsub(/^[\s_]+|[\s_]+$/, "")
+          .gsub(/[_\s]+/, " ")
+          .gsub(/^[a-z]/, &:upcase)
+      end
+
+      def self.remove_templates(_project_name)
+        FileUtils.rm_rf("templates")
+      end
+
+      def self.go_to_project_directory(project_name)
+        Dir.chdir "./#{project_name}"
+      end
+
+      def self.copy_templates_to_project(project_name)
+        FileUtils.cp_r "#{__dir__}/templates", "./#{project_name}"
+
+        go_to_project_directory(project_name)
+      end
+
+      def self.sign_project
+        file = "README.md"
+        msg = "\n> This project was generated by [Rails Interactive CLI](https://github.com/oguzsh/rails-interactive)"
+        File.write(file, msg, mode: "a+")
+      end
+    end
+  end
+end

data/lib/{rails_interactive → cli}/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module RailsInteractive
-  VERSION = "1.0.0"
+  class CLI
+    VERSION = "2.1.1"
+  end
 end

data/lib/rails_interactive.rb

@@ -1,14 +1,20 @@
 # frozen_string_literal: true
 
-require "rails_interactive/prompt"
-require "rails_interactive/message"
-require "fileutils"
+require "cli/prompt"
+require "cli/message"
+require "cli/command"
+require "cli/category"
+require "cli/utils"
+require "cli/command_handler"
 
 module RailsInteractive
   # CLI class for the interactive CLI module
   class CLI
     def initialize
       @inputs = {}
+      @commands = Command.new
+      @categories = Category.new
+      @handler = CommandHandler.new
     end
 
     def perform(key)
@@ -23,67 +29,109 @@ module RailsInteractive
       end
     end
 
+    private
+
+    def categories_with_commands
+      @categories.all.each do |category|
+        commands = []
+        @commands.all.each { |command| commands << command if command["category"] == category["name"] }
+        category["commands"] = commands
+      end
+    end
+
     def initialize_project
       name
       type
       database
-      css_frameworks
 
-      create
+      categories_with_commands.each do |category|
+        category_name = category["name"]
+        category_type = category["type"]
+        category_command_list = create_command_list(category["commands"], category_type)
+
+        @inputs[category_name.to_sym] =
+          Prompt.new("Choose #{Utils.humanize(category_name)} gems: ", category_type.to_s,
+                     category_command_list).perform
+      end
+
+      create_project
     end
 
-    def create
+    def setup
+      base = "rails new"
+      cmd = ""
+
+      @inputs.first(3).each { |_key, value| cmd += "#{value} " unless value.empty? }
+
+      "#{base} #{cmd} -q"
+    end
+
+    def create_project
       # Install gems
       system("bin/setup")
-
       # Create project
       system(setup)
-
+      # Install gems
+      intall_gems
       # Prepare project requirements and give instructions
-      Dir.chdir "./#{@inputs[:name]}"
-      system("rails db:create")
-
-      sign_project
+      Utils.sign_project
       Message.prepare
     end
 
-    def setup
-      base = "rails new"
-      cmd = ""
+    def create_command_list(commands, category_type)
+      return nil if commands.nil? || category_type.nil?
+
+      list = category_type == "select" ? {} : []
 
-      @inputs.each { |_key, value| cmd += "#{value} " }
+      commands.each do |command|
+        if list.is_a?(Hash)
+          list["None"] = nil
+          list[command["name"]] = command["identifier"]
+        else
+          list << command["identifier"]
+        end
+      end
 
-      "#{base} #{cmd}".strip!
+      list
     end
 
-    private
+    def intall_gems
+      # Copy template files to project folder
+      Utils.copy_templates_to_project(@inputs[:name])
+
+      @inputs.each do |key, value|
+        next if %i[name type database].include?(key) || value.is_a?(Array) && value.empty? || value.nil?
+
+        dependencies = @commands.dependencies(value)
+
+        @handler.handle_multi_options(value, dependencies) if value.is_a?(Array)
+        @handler.handle_option(value, dependencies) if value.is_a?(String)
+      end
+
+      # Remove templates folder from project folder
+      Utils.remove_templates(@inputs[:name])
+    end
 
     def name
-      @inputs[:name] = Prompt.new("Enter the name of the project: ", "ask", required: true).perform
+      @inputs[:name] = Prompt.new("Project name: ", "ask", required: true).perform
     end
 
     def type
-      types = { "App" => "", "API" => "--api" }
-      @inputs[:type] = Prompt.new("Choose project type: ", "select", types, required: true).perform
+      types = { "App" => "", "Api" => "--api" }
+      @inputs[:type] = Prompt.new("Type: ", "select", types, required: true).perform
     end
 
     def database
       database_types = { "PostgreSQL" => "-d postgresql", "MySQL" => "-d mysql", "SQLite" => "" }
 
-      @inputs[:database] = Prompt.new("Choose project's database: ", "select", database_types, required: true).perform
+      @inputs[:database] = Prompt.new("Database: ", "select", database_types, required: true).perform
     end
 
-    def css_frameworks
-      css_frameworks = { "None" => "", "Bootstrap" => "--css=bootstrap", "Tailwind" => "--css=tailwind" }
-
-      @inputs[:css_framework] =
-        Prompt.new("Choose project's CSS framework: ", "select", css_frameworks, required: true).perform
-    end
+    def admin_panel
+      admin_panel = { "ActiveAdmin" => "active_admin" }
 
-    def sign_project
-      file = "README.md"
-      msg = "\n> This project was generated by [Rails Interactive CLI](https://github.com/oguzsh/rails-interactive)"
-      File.write(file, msg, mode: "a+")
+      @inputs[:admin_panel] =
+        Prompt.new("Choose project admin panel: ", "select", admin_panel).perform
     end
   end
 end

data/rails-interactive.gemspec

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "lib/rails_interactive/version"
+require_relative "lib/cli/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rails-interactive"
-  spec.version       = RailsInteractive::VERSION
+  spec.version       = RailsInteractive::CLI::VERSION
   spec.authors       = ["Oguzhan Ince"]
   spec.email         = ["oguzhan824@gmail.com"]
 
@@ -29,9 +29,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug", "~> 11.1.2"
   spec.add_development_dependency "colorize"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yaml"
 
   spec.add_dependency "tty-prompt"