rails-interactive 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ed0537b6d53cb2eb3f395bbde2c35b9b798c9b74361a28fd26420ff450f5088
-  data.tar.gz: 1d41ee1c12f1979dcb372a36d340bf670ef03b2146c3b8bec781456a9284a9c4
+  metadata.gz: 7bbe64281e0e3224cf7ca9a041eb42c42c7e69028406b7e10d3e60a9efbae743
+  data.tar.gz: b69196bc79adb05559963c6f1cfee8fc2dda46fe795bf4c5449c35673080fa19
 SHA512:
-  metadata.gz: 483c4f42d0c78380e98722b8c5f84dc4e6bdc66e041eca02b6a82ed036e138eca618cd97d43a79089c785ed969e3ec4f7b8094a910cb38c8a4a66e724a034f9b
-  data.tar.gz: 4f847ee3dcfcaba3091121a1672c922e74e2bae30b8f5231811a24ca8b6151229b29950c287e5f7e7a91005fe84e6cbe8a2eca728bc678e3c76d7f6a632b513c
+  metadata.gz: f72def1e7699e42baa285164308ef728d5c118bf7611972441242486c442d154d3ee00a8c3cf05a29c3eeb6aa453bb61a05f60c406880aa4942c8c64858593d5
+  data.tar.gz: d53e7c764ca1ecbee3378a4304070ced64c18825b7f2ef7b53700612c442fced35128b05f8c4be6cbe12090a08784a5d9b747a0f0be4cf83f29412b30b604b8e

data/.rubocop.yml

@@ -11,3 +11,12 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 12
+
+Metrics/CyclomaticComplexity:
+  Max: 25

data/Gemfile.lock

@@ -1,73 +1,73 @@
 PATH
   remote: .
   specs:
-    rails-interactive (0.1.9)
+    rails-interactive (2.0.0)
       tty-prompt
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actioncable (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actionmailbox (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      actionview (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actionmailer (7.0.3)
+      actionpack (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activesupport (= 7.0.3)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.2.2)
-      actionview (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actionpack (7.0.3)
+      actionview (= 7.0.3)
+      activesupport (= 7.0.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actiontext (7.0.3)
+      actionpack (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.2.2)
-      activesupport (= 7.0.2.2)
+    actionview (7.0.3)
+      activesupport (= 7.0.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.2.2)
-      activesupport (= 7.0.2.2)
+    activejob (7.0.3)
+      activesupport (= 7.0.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activerecord (7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
-    activestorage (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activestorage (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activesupport (= 7.0.3)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.2.2)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -75,8 +75,9 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     byebug (11.1.3)
+    coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.5.0)
     digest (3.1.0)
@@ -85,8 +86,7 @@ GEM
       activesupport (>= 5.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    io-wait (0.2.1)
-    loofah (2.14.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -103,56 +103,58 @@ GEM
       digest
       net-protocol
       timeout
-    net-protocol (0.1.2)
-      io-wait
+    net-protocol (0.1.3)
       timeout
     net-smtp (0.3.1)
       digest
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.4-x86_64-darwin)
+    nokogiri (1.13.6-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.4-x86_64-linux)
+    nokogiri (1.13.6-x86_64-linux)
       racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     racc (1.6.0)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (7.0.2.2)
-      actioncable (= 7.0.2.2)
-      actionmailbox (= 7.0.2.2)
-      actionmailer (= 7.0.2.2)
-      actionpack (= 7.0.2.2)
-      actiontext (= 7.0.2.2)
-      actionview (= 7.0.2.2)
-      activejob (= 7.0.2.2)
-      activemodel (= 7.0.2.2)
-      activerecord (= 7.0.2.2)
-      activestorage (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    rails (7.0.3)
+      actioncable (= 7.0.3)
+      actionmailbox (= 7.0.3)
+      actionmailer (= 7.0.3)
+      actionpack (= 7.0.3)
+      actiontext (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activemodel (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
       bundler (>= 1.15.0)
-      railties (= 7.0.2.2)
+      railties (= 7.0.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (7.0.2.2)
-      actionpack (= 7.0.2.2)
-      activesupport (= 7.0.2.2)
+    railties (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -163,25 +165,25 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.26.0)
+    rubocop (1.30.0)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    strscan (3.0.1)
+    strscan (3.0.3)
     thor (1.2.1)
-    timeout (0.2.0)
+    timeout (0.3.0)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
     tty-prompt (0.23.1)
@@ -199,6 +201,7 @@ GEM
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     wisper (2.0.1)
+    yaml (0.2.0)
     zeitwerk (2.5.4)
 
 PLATFORMS
@@ -209,12 +212,14 @@ DEPENDENCIES
   bundler
   byebug (~> 11.1.2)
   colorize
+  pry
   rails
   rails-interactive!
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)
   tty-prompt
+  yaml
 
 BUNDLED WITH
    2.2.22

data/bin/console

@@ -4,12 +4,5 @@
 require "bundler/setup"
 require "rails_interactive"
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/lib/cli/categories.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module RailsInteractive
+  class CLI
+    # Categories class for the interactive CLI module
+    class Categories
+      def initialize
+        @categories = YAML.load_file("#{__dir__}/config/categories.yml").uniq
+      end
+
+      def all
+        @categories.sort_by { |category| category["weight"] }
+      end
+    end
+  end
+end

data/lib/cli/commands.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module RailsInteractive
+  class CLI
+    # Commands class for the interactive CLI module
+    class Commands
+      def initialize
+        @commands = YAML.load_file("#{__dir__}/config/commands.yml").uniq
+      end
+
+      def all
+        @commands
+      end
+
+      def find_by_identifier(identifier)
+        @commands.find { |command| command["identifier"] == identifier }
+      end
+    end
+  end
+end

data/lib/cli/config/categories.yml

@@ -0,0 +1,51 @@
+---
+-
+    name: authentication
+    weight: 1
+    type: "multi_select"
+    required: false
+-
+    name: authorization
+    weight: 2
+    type: "select"
+    required: false
+-
+    name: testing
+    weight: 3
+    type: "select"
+    required: false
+-
+    name: template_engine
+    weight: 4
+    type: "select"
+    required: false
+-
+    name: code_quality
+    weight: 5
+    type: "select"
+    required: false
+-
+    name: background_job
+    weight: 6
+    type: "select"
+    required: false
+-
+    name: security
+    weight: 7
+    type: "select"
+    required: false
+-
+    name: admin_panel
+    weight: 8
+    type: "select"
+    required: false
+-
+    name: features
+    weight: 9
+    type: "multi_select"
+    required: false
+-
+    name: development
+    weight: 10
+    type: "multi_select"
+    required: false

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_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"