rails-interactive 0.1.9 → 2.1.0

data/lib/cli/config/commands.yml

@@ -0,0 +1,128 @@
+---
+-
+  identifier: rubocop
+  name: Rubocop
+  category: code_quality
+  description: "A Ruby static code analyzer and formatter, based on the community Ruby style guide. For details: https://github.com/rubocop/rubocop"
+  dependencies: null
+-
+  identifier: graphql
+  name: GraphQL
+  category: features
+  description: "Ruby implementation of GraphQL. For details: https://github.com/rmosolgo/graphql-ruby"
+  dependencies: null
+-
+  identifier: avo
+  name: Avo
+  category: admin_panel
+  description: "Configuration-based, no-maintenance, extendable Ruby on Rails admin. For details: https://github.com/avo-hq/avo"
+  dependencies: null
+-
+  identifier: awesome_print
+  name: AwesomePrint
+  category: development
+  description: "Pretty print your Ruby objects with style. For details: https://github.com/awesome-print/awesome_print"
+  dependencies: null
+-
+  identifier: better_errors
+  name: BetterErrors
+  category: development
+  description: "Better error page for Rack apps. For details: https://github.com/BetterErrors/better_errors"
+  dependencies: null
+-
+  identifier: brakeman
+  name: Brakeman
+  category: security
+  description: "A static analysis security vulnerability scanner for Ruby on Rails applications. For details: https://github.com/presidentbeef/brakeman"
+  dependencies: null
+-
+  identifier: bullet
+  name: Bullet
+  category: development
+  description: "Bullet helps to solve N+1 queries and unused eager loading. For details: https://github.com/flyerhzm/bullet"
+  dependencies: null
+-
+  identifier: cancancan
+  name: CanCanCan
+  category: authorization
+  description: "CanCanCan is an authorization library for Ruby and Ruby on Rails which restricts what resources a given user is allowed to access. For details: https://github.com/CanCanCommunity/cancancan"
+  dependencies: null
+-
+  identifier: devise
+  name: Devise
+  category: authentication
+  description: "Flexible authentication solution for Rails with Warden. For details: https://github.com/heartcombo/devise"
+  dependencies: null
+-
+  identifier: faker
+  name: Faker
+  category: development
+  description: "A library for generating fake data such as names, addresses, and phone numbers. For details: https://github.com/faker-ruby/faker"
+  dependencies: null
+-
+  identifier: friendly_id
+  name: FriendlyID
+  category: development
+  description: "FriendlyId is the 'Swiss Army bulldozer' of slugging and permalink plugins for Active Record. It lets you create pretty URLs and work with human-friendly strings as if they were numeric ids. For details: https://github.com/norman/friendly_id"
+  dependencies: null
+-
+  identifier: haml
+  name: Haml
+  category: template_engine
+  description: "HTML Abstraction Markup Language. For details: https://github.com/haml/haml"
+  dependencies: null
+-
+  identifier: kaminari
+  name: Kaminari
+  category: features
+  description: "A Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Ruby webapps. For details: https://github.com/kaminari/kaminari"
+  dependencies: null
+-
+  identifier: letter_opener
+  name: LetterOpener
+  category: development
+  description: "Preview email in the default browser instead of sending it on development mode. For details: https://github.com/ryanb/letter_opener"
+  dependencies: null
+-
+  identifier: omniauth
+  name: OmniAuth
+  category: authentication
+  description: "OmniAuth is a flexible authentication system utilizing Rack middleware. For details: https://github.com/omniauth/omniauth"
+  dependencies:
+    - devise
+-
+  identifier: pundit
+  name: Pundit
+  category: authorization
+  description: "Minimal authorization through OO design and pure Ruby classes. For details: https://github.com/varvet/pundit"
+  dependencies: null
+-
+  identifier: rails_admin
+  name: RailsAdmin
+  category: admin_panel
+  description: "RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data. For details: https://github.com/railsadminteam/rails_admin"
+  dependencies: null
+-
+  identifier: rspec
+  name: RSpec
+  category: testing
+  description: "A unit test framework for the Ruby programming language. For details: https://github.com/rspec"
+  dependencies: null
+-
+  identifier: sidekiq
+  name: Sidekiq
+  category: background_job
+  description: "Simple, efficient background processing for Ruby. For details: https://github.com/mperham/sidekiq"
+  dependencies: null
+-
+  identifier: slim
+  name: Slim
+  category: template_engine
+  description: "Slim is a template language whose goal is to reduce the syntax to the essential parts without becoming cryptic. For details: https://github.com/slim-template/slim"
+  dependencies: null
+-
+  identifier: standart_rb
+  name: StandartRB
+  category: code_quality
+  description: " Ruby Style Guide, with linter & automatic code fixer. For details: https://github.com/testdouble/standard"
+  dependencies: null

data/lib/cli/message.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "colorize"
+
+module RailsInteractive
+  class CLI
+    # Utils class for the interactive CLI module
+    class Message
+      def self.greet
+        render_ascii
+        puts "Welcome to Rails Interactive CLI".colorize(:yellow)
+      end
+
+      def self.help
+        puts "bin/interactive new - Create a new Rails Project".colorize(:yellow)
+        puts "bin/interactive help - List all commands".colorize(:yellow)
+        exit
+      end
+
+      def self.render_ascii
+        # rubocop:disable Naming/HeredocDelimiterNaming
+        puts <<-'EOF'
+  _____       _ _     _____       _                      _   _
+ |  __ \     (_) |   |_   _|     | |                    | | (_)
+ | |__) |__ _ _| |___  | |  _ __ | |_ ___ _ __ __ _  ___| |_ ___   _____
+ |  _  // _` | | / __| | | | '_ \| __/ _ \ '__/ _` |/ __| __| \ \ / / _ \
+ | | \ \ (_| | | \__ \_| |_| | | | ||  __/ | | (_| | (__| |_| |\ V /  __/
+ |_|  \_\__,_|_|_|___/_____|_| |_|\__\___|_|  \__,_|\___|\__|_| \_/ \___|
+
+        EOF
+        # rubocop:enable Naming/HeredocDelimiterNaming
+      end
+
+      def self.prepare
+        puts ""
+        puts "Project created successfully ✅".colorize(:green)
+        puts "Go to your project folder and ready to go 🎉".colorize(:green)
+        rails_commands
+      end
+
+      def self.rails_commands
+        puts "You can run several commands:".colorize(:green)
+
+        puts "Starts the webpack development server".colorize(:cyan)
+        puts "> bin/webpack-dev-server".colorize(:yellow)
+
+        puts "Starts the rails server".colorize(:cyan)
+        puts "> bin/rails s or bin/rails server".colorize(:yellow)
+
+        puts "Starts the rails console".colorize(:cyan)
+        puts "> bin/rails c or bin/rails console".colorize(:yellow)
+      end
+    end
+  end
+end

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_friendly_id.rb

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

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 = "0.1.9"
+  class CLI
+    VERSION = "2.1.0"
+  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,137 +29,102 @@ 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
-      features
-      code_quality_tool
-      template_engines
-      admin_panel
-      testing_tools
-      development_tools
-
-      create
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    def create
-      # Install gems
-      system("bin/setup")
-      # Create project
-      system(setup)
-
-      copy_templates_to_project
-
-      # Move to project folder and install gems
-      Dir.chdir "./#{@inputs[:name]}"
 
-      # Features Templates
-      handle_multi_options(key: :features)
+      categories_with_commands.each do |category|
+        category_name = category["name"]
+        category_type = category["type"]
+        category_command_list = create_command_list(category["commands"], category_type)
 
-      # Code Quality Template
-      system("bin/rails app:template LOCATION=templates/setup_#{@inputs[:code_quality_tool]}.rb")
-
-      # HTML Template Engines
-      system("bin/rails app:template LOCATION=templates/setup_#{@inputs[:template_engine]}.rb")
-
-      # Admin Panel Template
-      system("bin/rails app:template LOCATION=templates/setup_#{@inputs[:admin_panel]}.rb")
-
-      # Testing tools Template
-      handle_multi_options(key: :testing_tools)
-
-      # Development tools Template
-      handle_multi_options(key: :development_tools)
+        @inputs[category_name.to_sym] =
+          Prompt.new("Choose #{Utils.humanize(category_name)} gems: ", category_type.to_s,
+                     category_command_list).perform
+      end
 
-      # Prepare project requirements and give instructions
-      sign_project
-      Message.prepare
+      create_project
     end
-    # rubocop:enable Metrics/MethodLength
 
     def setup
       base = "rails new"
       cmd = ""
 
-      @inputs.first(3).each { |_key, value| cmd += "#{value} " }
+      @inputs.first(3).each { |_key, value| cmd += "#{value} " unless value.empty? }
 
-      "#{base} #{cmd}".strip!
+      "#{base} #{cmd} -q"
     end
 
-    def copy_templates_to_project
-      FileUtils.cp_r "#{__dir__}/rails_interactive/templates", "./#{@inputs[:name]}"
-    end
-
-    private
-
-    def handle_multi_options(key:)
-      @inputs[key].each do |value|
-        system("bin/rails app:template LOCATION=templates/setup_#{value}.rb")
-      end
+    def create_project
+      # Install gems
+      system("bin/setup")
+      # Create project
+      system(setup)
+      # Install gems
+      intall_gems
+      # Prepare project requirements and give instructions
+      Utils.sign_project
+      Message.prepare
     end
 
-    def name
-      @inputs[:name] = Prompt.new("Enter the name of the project: ", "ask", required: true).perform
-    end
+    def create_command_list(commands, category_type)
+      return nil if commands.nil? || category_type.nil?
 
-    def type
-      types = { "App" => "", "API" => "--api" }
-      @inputs[:type] = Prompt.new("Choose project type: ", "select", types, required: true).perform
-    end
+      list = category_type == "select" ? {} : []
 
-    def database
-      database_types = { "PostgreSQL" => "-d postgresql", "MySQL" => "-d mysql", "SQLite" => "" }
+      commands.each do |command|
+        if list.is_a?(Hash)
+          list["None"] = nil
+          list[command["name"]] = command["identifier"]
+        else
+          list << command["identifier"]
+        end
+      end
 
-      @inputs[:database] = Prompt.new("Choose project's database: ", "select", database_types, required: true).perform
+      list
     end
 
-    def features
-      features = %w[devise cancancan omniauth pundit brakeman sidekiq graphql kaminari]
+    def intall_gems
+      # Copy template files to project folder
+      Utils.copy_templates_to_project(@inputs[:name])
 
-      @inputs[:features] = Prompt.new("Choose project features: ", "multi_select", features).perform
-    end
-
-    def code_quality_tool
-      code_quality_tool = { "Rubocop" => "rubocop", "StandardRB" => "standardrb" }
+      @inputs.each do |key, value|
+        next if %i[name type database].include?(key) || value.is_a?(Array) && value.empty? || value.nil?
 
-      @inputs[:code_quality_tool] =
-        Prompt.new("Choose project code quality tool: ", "select", code_quality_tool).perform
-    end
+        dependencies = @commands.dependencies(value)
 
-    def admin_panel
-      admin_panel = { "RailsAdmin" => "rails_admin", "Avo" => "avo" }
+        @handler.handle_multi_options(value, dependencies) if value.is_a?(Array)
+        @handler.handle_option(value, dependencies) if value.is_a?(String)
+      end
 
-      @inputs[:admin_panel] =
-        Prompt.new("Choose project's admin panel: ", "select", admin_panel).perform
+      # Remove templates folder from project folder
+      Utils.remove_templates(@inputs[:name])
     end
 
-    def testing_tools
-      testing_tools = %w[rspec]
-
-      @inputs[:testing_tools] =
-        Prompt.new("Choose project's testing tools: ", "multi_select", testing_tools).perform
+    def name
+      @inputs[:name] = Prompt.new("Project name: ", "ask", required: true).perform
     end
 
-    def template_engines
-      template_engines = { "HAML" => "haml", "SLIM" => "slim" }
-
-      @inputs[:template_engine] =
-        Prompt.new("Choose project's template engine: ", "select", template_engines).perform
+    def type
+      types = { "App" => "", "Api" => "--api" }
+      @inputs[:type] = Prompt.new("Type: ", "select", types, required: true).perform
     end
 
-    def development_tools
-      development_tools = %w[bullet faker friendly_id better_errors letter_opener awesome_print]
-
-      @inputs[:development_tools] =
-        Prompt.new("Choose project's development tools: ", "multi_select", development_tools).perform
-    end
+    def database
+      database_types = { "PostgreSQL" => "-d postgresql", "MySQL" => "-d mysql", "SQLite" => "" }
 
-    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[:database] = Prompt.new("Database: ", "select", database_types, required: true).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"