panacea-rails 0.1.0

data/exe/panacea

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "panacea/rails"
+
+Panacea::Rails.init

data/lib/panacea/rails.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "slop"
+require "panacea/rails/version"
+require "panacea/rails/runner"
+
+module Panacea # :nodoc:
+  ###
+  # == Panacea::Rails
+  #
+  # This module is the access point to the configuration questions and the Panacea::Rails::Generator.
+  module Rails
+    class << self
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength, Metrics/BlockLength
+
+      ###
+      # This method uses Slop to handle the CLI command and its arguments.
+      # It accepts most of the default Rails arguments.
+      #
+      # If App's name is not passed as an argument we show the command help.
+      #
+      # When the App's name is passed, we start the Panacea::Rails::Runner
+      def init
+        opts = Slop.parse do |o|
+          o.banner = "usage: panacea your-app-name [options]"
+          o.separator ""
+          o.string "-d", "--database", "# Options (mysql/postgresql/sqlite3/oracle/frontbase/im_db/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)", default: "postgresql"
+          o.bool "--skip-namespace", "# Skip namespace (affects only isolated applications)", default: false
+          o.bool "--skip-yarn", "# Don't use Yarn for managing JavaScript dependencies", default: false
+          o.bool "--skip-git", "# Skip .gitignore file", default: false
+          o.bool "--skip-keeps", "# Skip source control .keep files", default: false
+          o.bool "--skip-action-mailer", "# Skip Action Mailer files", default: false
+          o.bool "--skip-active-record", "# Skip Active Record files", default: false
+          o.bool "--skip-active-storage", "# Skip Active Storage files", default: false
+          o.bool "--skip-puma", "# Skip Puma related files", default: false
+          o.bool "--skip-action-cable", "# Skip Action Cable files", default: false
+          o.bool "--skip-sprockets", "# Skip Sprockets files", default: false
+          o.bool "--skip-spring", "# Don't install Spring application preloader", default: false
+          o.bool "--skip-listen", "# Don't generate configuration that depends on the listen gem", default: false
+          o.bool "--skip-coffee", "# Don't use CoffeeScript", default: false
+          o.bool "--skip-javascript", "# Skip JavaScript files", default: false
+          o.bool "--skip-turbolinks", "# Skip turbolinks gem", default: false
+          o.bool "--skip-test", "# Skip test files", default: false
+          o.bool "--skip-system-test", "# Skip system test files", default: false
+          o.bool "--skip-bootsnap", "# Skip bootsnap gem", default: false
+          o.bool "--dev", "# Setup the application with Gemfile pointing to your Rails checkout", default: false
+          o.bool "--edge", "# Setup the application with Gemfile pointing to Rails repository", default: false
+          o.string "--rc", "# Path to file containing extra configuration options for rails command", default: nil
+          o.bool "--no-rc", "# Skip loading of extra configuration options from .railsrc file", default: false
+          o.bool "--api", "# Preconfigure smaller stack for API only apps", default: false
+          o.bool "--skip-bundle", "# Don't run bundle install", default: false
+          o.separator ""
+          o.separator "Runtime options:"
+          o.bool "--force", "# Overwrite files that already exist", default: false
+          o.bool "--pretend", "# Run but do not make any changes", default: false
+          o.bool "--quiet", "# Suppress status output", default: false
+          o.bool "--skip", "# Skip files that already exist", default: false
+          o.separator ""
+          o.separator "Panacea options:"
+          o.on "-v", "--version" do
+            puts Panacea::Rails::VERSION
+            exit
+          end
+          o.on "-h", "--help" do
+            puts o
+            exit
+          end
+        end
+
+        return puts(opts) if opts.arguments.empty?
+
+        Runner.call(opts.arguments.first, opts.to_hash)
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength, Metrics/BlockLength
+    end
+  end
+end

data/lib/panacea/rails/arguments_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Panacea # :nodoc:
+  module Rails # :nodoc:
+    ###
+    # == Panacea::Rails::ArgumentsParser
+    #
+    # This module is in charge Parsing Slop Arguments.
+    module ArgumentsParser
+      ###
+      # This method builds an arguments String from the Slop args Hash.
+      #
+      # The string will be passed to the `rails new` command and it will be also
+      # tracked if the end user agrees to share Panacea's usage information
+      def parse_arguments(arguments)
+        arguments.each_with_object([]) do |arg, parsed_args|
+          case arg.last.class.to_s
+          when "String"
+            parsed_args << "--#{arg.first}=#{arg.last}"
+          when "TrueClass"
+            parsed_args << "--#{arg.first}"
+          end
+        end.join(" ")
+      end
+    end
+  end
+end

data/lib/panacea/rails/customizer.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require "tty/prompt"
+require "yaml"
+require_relative "stats"
+
+module Panacea # :nodoc:
+  module Rails # :nodoc:
+    ###
+    # == Panacea::Rails::Customizer
+    #
+    # This class is in charge of asking the configuration questions.
+    # It saves the answers on the .panacea file.
+    class Customizer
+      # rubocop:disable Style/FormatStringToken
+
+      ###
+      # ASCII art displayed at the start of the Panacea command
+      WELCOME_MESSAGE = <<~MSG
+         _____________________________
+        |            .....      //    |
+        |        _d^^^^^^^^^b_ //     |
+        |     .d''           ``       |
+        |   .p'                      /|
+        |  .d'                     .//| Welcome to Panacea!
+        | .d'  -----------      - `b. | You are about to boost your fresh
+        | :: --------------------- :: | %{app_name} Rails App
+        | :: --- P A N A C E A --- :: |
+        | :: --------------------- :: | Full documentation here: https://panacea.website
+        | `p. ------------------- .q' | Most of the defaults are false or disabled,
+        |  `p. ----------------- .q'  | if you want to enable a feature please answer yes
+        |   `b. --------------- .d'   |
+        |     `q.. -------- ..p'      |
+        |        ^q........p^         |
+        |____________''''_____________|
+
+      MSG
+      # rubocop:enable Style/FormatStringToken
+
+      ###
+      # This method receives the App's name and the passed arguments.
+      #
+      # It creates a new instance of Panacea::Rails::Customizer class and
+      # executes the start instance method.
+      def self.start(app_name, passed_args)
+        new(app_name, passed_args).start
+      end
+
+      ###
+      # A Hash with the questions loaded from config/questions.yaml file
+      attr_reader :questions
+
+      ###
+      # A TTY::Prompt instance
+      attr_reader :prompt
+
+      ###
+      # A Hash where each question's answer is stored
+      attr_reader :answers
+
+      ###
+      # App's name
+      attr_reader :app_name
+
+      ###
+      # A String with the arguments passed to the Panacea command
+      attr_reader :passed_args
+
+      ###
+      # Panacea::Rails::Customizer initialize method
+      #
+      # A TTY::Prompt instance is used as default prompt.
+      def initialize(app_name, passed_args, prompt: TTY::Prompt.new)
+        @app_name = app_name
+        @passed_args = passed_args
+        @answers = {}
+        @prompt = prompt
+      end
+
+      ###
+      # This method shows the Welcome message.
+      # Then, it ask the questions using the default prompt.
+      # It also tracks the answers only if the end user agrees to.
+      # At the end, it saves the answers to the .panacea file.
+      def start
+        welcome_message
+        ask_questions
+        track_answers
+        save_answers
+      end
+
+      private
+
+      def welcome_message
+        message = format(WELCOME_MESSAGE, app_name: app_name.capitalize)
+        prompt.say(message, color: :blue)
+      end
+
+      def ask_questions(questions = load_questions)
+        questions.each do |key, question|
+          answer = ask_question(key, question)
+          subquestions = question.dig("subquestions")
+
+          ask_questions(subquestions) if !subquestions.nil? && answer
+        end
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Security/Eval
+      def ask_question(key, question)
+        title = question.dig("title")
+        default = question.dig("default")
+        condition = question.dig("condition")
+
+        unless condition.nil?
+          return unless eval(condition)
+        end
+
+        answer = nil
+
+        case question.dig("type")
+        when "boolean"
+          answer = prompt.yes?(title) { |q| q.default(default) }
+        when "range"
+          answer = prompt.ask(title, default: default) { |q| q.in(question.dig("range")) }
+        when "text"
+          answer = prompt.ask(title, default: default)
+        when "select"
+          answer = prompt.select(title, question.dig("options"))
+        else
+          raise StandardError, "Question type not supported."
+        end
+
+        update_answer(key, answer)
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Security/Eval
+
+      def update_answer(key, answer)
+        answers[key] = answer
+      end
+
+      def load_questions
+        questions_file = File.join(File.expand_path("../../../config", __dir__), "questions.yml")
+        @questions = YAML.safe_load(File.read(questions_file))
+      end
+
+      def save_answers
+        root_dir = File.expand_path("../../../", __dir__)
+        configurations_file = File.join(root_dir, ".panacea")
+
+        File.open(configurations_file, "w") { |f| f.write(answers.to_yaml) }
+      end
+
+      def track_answers
+        share_usage_info = answers.delete("share_usage_info")
+        return unless share_usage_info
+
+        params = answers.dup
+        params[:ruby_version] = RUBY_VERSION
+        params[:arguments] = passed_args
+        Stats.track(params)
+      end
+    end
+  end
+end

data/lib/panacea/rails/generator.rb

@@ -0,0 +1,316 @@
+# frozen_string_literal: true
+
+module Panacea # :nodoc:
+  module Rails # :nodoc:
+    # rubocop:disable Metrics/ClassLength
+
+    ###
+    # == Panacea::Rails::Generator
+    #
+    # This class is in charge of grouping all the actions to be executed via Panacea::Rails::Template
+    class Generator
+      ###
+      # The Rails::Generators::AppGenerator context
+      attr_reader :app_generator
+
+      ###
+      # A String with Panacea's installation directory
+      attr_reader :root_dir
+
+      ###
+      # The Panacea's Configuration Hash
+      attr_reader :config
+
+      ###
+      # This methods receive the context of the  Rails::Generators::AppGenerator
+      # So it executes all methods against it.
+      #
+      # It also receives the Panacea's Config Hash and the Panacea's Gem Root dir
+      # in order to update  Rails::Generators::AppGenerator source paths.
+      def initialize(app_generator, panacea_config, root_dir)
+        @app_generator = app_generator
+        @config = panacea_config
+        @app_generator.instance_variable_set :@panacea, @config
+        @root_dir = root_dir
+      end
+
+      ###
+      # Send any unknown method to the Rails::Generators::AppGenerator context.
+      # That context also know Thor actions.
+      def method_missing(method_name, *args, &block)
+        super unless app_generator.respond_to?(method_name)
+        app_generator.send(method_name, *args, &block)
+      end
+
+      ###
+      # Whitelist of Rails::Generator::AppGenerator and Thor methods.
+      #
+      # Add here any new method to be used from Thor / Rails Generator
+      def respond_to_missing?(method_name, include_private = false)
+        %i[
+          after_bundle generate rails_command template
+          run git source_paths empty_directory append_to_file
+          environment application say inject_into_class
+        ].include?(method_name) || super
+      end
+
+      ###
+      # All the methods passed via block are executed on the Rails::Generators::AppGenerator
+      # after_bundle hook.
+      def after_bundle_hook
+        after_bundle do
+          run "spring stop"
+          yield self
+        end
+      end
+
+      ###
+      # Update Rails::Generators::AppGenerator source paths, making Panacea's Templates under
+      # templates/ directory available.
+      def update_source_paths
+        source_paths.unshift(root_dir)
+      end
+
+      ###
+      # Update the Gemfile
+      def copy_gemfile
+        template "templates/Gemfile.tt", "Gemfile", force: true
+      end
+
+      ###
+      # Update the README.md
+      def copy_readme
+        template "templates/README.tt", "README.md", force: true
+      end
+
+      ###
+      # Creates the PANACEA.md file
+      def generate_panacea_document
+        template "templates/PANACEA.tt", "PANACEA.md"
+      end
+
+      ###
+      # Create .rubocop.yml in generated Rails app.
+      def setup_rubocop
+        template "templates/rubocop.tt", ".rubocop.yml"
+      end
+
+      ###
+      # Setup the test suite (rspec or minitest).
+      def setup_test_suite
+        return unless config.dig("test_suite") == "rspec"
+
+        generate "rspec:install"
+        run "rm -r test"
+      end
+
+      ###
+      # Setup Simplecov based on the chosen test suite.
+      def setup_simplecov
+        path = if config.dig("test_suite") == "minitest"
+                 "test/support"
+               else
+                 "spec/support"
+               end
+
+        template "templates/simplecov.tt", "#{path}/simplecov.rb"
+        append_to_file ".gitignore", "\n# Ignore Coverage files \n/coverage\n"
+      end
+
+      ###
+      # Override test helper based on the chosen test suite.
+      def override_test_helper
+        if config.dig("test_suite") == "minitest"
+          template "templates/minitest_test_helper.tt", "test/test_helper.rb", force: true
+        else
+          template "templates/rspec_test_helper.tt", "spec/rails_helper.rb", force: true
+        end
+      end
+
+      ###
+      # Setup Headless Chrome Driver based on chosen test suite.
+      def override_application_system_test
+        return unless config.dig("test_suite") == "minitest"
+        template "templates/application_system_test.tt", "test/application_system_test_case.rb", force: true
+      end
+
+      ###
+      # Setup OJ gem.
+      def setup_oj
+        template "templates/oj_initializer.tt", "config/initializers/oj.rb"
+      end
+
+      ###
+      # Setup Dotenv gem.
+      def setup_dotenv
+        template "templates/dotenv.tt", ".env"
+        append_to_file ".gitignore", "\n# Ignore .env file \n.env\n"
+      end
+
+      ###
+      # Setup chosen Background Job gem.
+      def setup_background_job
+        background_job = config.dig("background_job")
+
+        application nil do
+          <<~CONFS
+            # Default adapter queue
+            config.active_job.queue_adapter = :#{background_job}
+
+          CONFS
+        end
+
+        if background_job == "sidekiq"
+          route "mount Sidekiq::Web => '/sidekiq'"
+          route "require 'sidekiq/web'"
+        elsif background_job == "resque"
+          route "mount Resque::Server, at: '/jobs'"
+          route "require 'resque/server'"
+
+          template("templates/Rakefile.tt", "Rakefile", force: true)
+        end
+      end
+
+      ###
+      # Setup the application's timezone.
+      def setup_timezone
+        timezone = config.dig("timezone").split("-").first.chomp(" ")
+
+        application nil do
+          <<~CONFS
+            # Default timezone
+            config.time_zone = "#{timezone}"
+
+          CONFS
+        end
+      end
+
+      ###
+      # Setup the application's locale.
+      def setup_default_locale
+        locale = config.dig("locale").split("- ").last
+
+        application nil do
+          <<~CONFS
+            # Default i18n locale
+            config.i18n.default_locale = :#{locale}
+
+          CONFS
+        end
+
+        template "templates/default_locale.tt", "config/locales/#{locale}.yml" if locale != "en"
+      end
+
+      ###
+      # Setup Bullet gem
+      def setup_bullet
+        environment nil, env: "development" do
+          <<~CONFS
+            # Settings for Bullet gem
+            config.after_initialize do
+              Bullet.enable        = true
+              Bullet.alert         = true
+              Bullet.bullet_logger = true
+              Bullet.console       = true
+              Bullet.rails_logger  = true
+              Bullet.add_footer    = true
+            end
+
+          CONFS
+        end
+      end
+
+      ###
+      # Setup letter_opener gem.
+      def setup_letter_opener
+        environment nil, env: "development" do
+          <<~CONFS
+            # Settings for Letter Opener
+            config.action_mailer.delivery_method = :letter_opener
+            config.action_mailer.perform_deliveries = true
+            config.action_mailer.default_url_options = { host: "localhost", port: 3000 }
+
+          CONFS
+        end
+      end
+
+      ###
+      # Setup Devise gem.
+      def setup_devise
+        model_name = config.dig("devise_model_name").downcase
+        plural_model_name = model_name.downcase.pluralize
+
+        generate "devise:install"
+        generate "devise", model_name
+        generate "devise:views", plural_model_name if config.dig("devise_override_views")
+
+        rails_command "db:migrate"
+      end
+
+      ###
+      # Setup money_rails gem.
+      def setup_money_rails
+        generate "money_rails:initializer"
+      end
+
+      ###
+      # Setup Kaminari gem.
+      def setup_kaminari
+        generate "kaminari:config"
+      end
+
+      ###
+      # Setup webpacker gem.
+      def setup_webpack
+        rails_command "webpacker:install"
+        rails_command "webpacker:install:#{config.dig('webpack_type')}" if config.dig("webpack_type") != "none"
+      end
+
+      ###
+      # Setup foreman gem
+      def setup_foreman
+        run "gem install foreman" unless system("gem list -i foreman")
+
+        template("templates/Procfile.tt", "Procfile")
+      end
+
+      ###
+      # Setup Pundit gem
+      def setup_pundit
+        generate "pundit:install"
+        inject_into_class "app/controllers/application_controller.rb", "ApplicationController", "  include Pundit\n"
+      end
+
+      ###
+      # Creates chosen Git hook.
+      def setup_githook
+        hook_file = ".git/hooks/#{config.dig('githook_type')}"
+        template "templates/githook.tt", hook_file
+        run "chmod ug+x #{hook_file}"
+      end
+
+      ###
+      # This needs to be run before commiting.
+      #
+      # Fix existing application's style offenses.
+      def fix_offenses!
+        run "rubocop -a --format=simple"
+      end
+
+      ###
+      # Commit only if end users want to.
+      def commit!
+        git add: "."
+        git commit: "-m '#{config.dig('commit_msg')}'"
+      end
+
+      ###
+      # Display good bye message.
+      def bye_message
+        message = "Panacea's work is done, enjoy!"
+        say "\n\n\e[34m#{message}\e[0m"
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
+  end
+end