panacea-rails 0.1.0

data/lib/panacea/rails/runner.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "arguments_parser"
+require_relative "customizer"
+
+module Panacea # :nodoc:
+  module Rails # :nodoc:
+    ###
+    # == Panacea::Rails::Runner
+    #
+    # This module is where Panacea's work start.
+    module Runner
+      extend ArgumentsParser
+
+      class << self
+        ###
+        # This method receives the App's name and the arguments passed to Panacea command.
+        #
+        # It uses the Panacea::Rails::ArgumentsParser.parse_arguments method to transform the passed arguments.
+        #
+        # It also starts the Panacea::Rails::Customizer which is in charge of asking the configuration questions.
+        #
+        # Then, it appends the Panacea's Template option to the list of parsed arguments.
+        #
+        # It finally runs the rails new command with the App's name and the final list of arguments.
+        def call(app_name, rails_args)
+          parsed_arguments = parse_arguments(rails_args)
+          Customizer.start(app_name, parsed_arguments.dup)
+
+          panacea_template = __dir__ + "/template.rb"
+          parsed_arguments << " --template=#{panacea_template}"
+          parsed_arguments = parsed_arguments.split(" ")
+
+          system("rails", "new", app_name, *parsed_arguments)
+        end
+      end
+    end
+  end
+end

data/lib/panacea/rails/stats.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+
+module Panacea # :nodoc:
+  module Rails # :nodoc:
+    ###
+    # == Panacea::Rails::Stats
+    #
+    # This class tracks the end users answers if they agree to.
+    class Stats
+      ###
+      # Hash with the question's answers + ruby version + passed arguments
+      attr_reader :params
+
+      ###
+      # Panacea's Stats App endpoint
+      API_BASE = "https://stats.panacea.website/statistics"
+
+      ###
+      # It sends the end user's answers to the Panacea's Stats App.
+      def self.track(params)
+        new(params)
+      end
+
+      ###
+      # Panacea::Rails::Stats initialize method.
+      def initialize(params)
+        @params = params
+        track
+      end
+
+      ###
+      # Makes an async call to the Panacea's Stats App.
+      def track
+        request_async_post(params)
+      end
+
+      private
+
+      def request_async_post(params)
+        Thread.new do
+          request_post(params)
+        end
+      end
+
+      def request_post(params)
+        uri = URI(API_BASE)
+        response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
+          request = Net::HTTP::Post.new(uri)
+          request["Accept"] = "application/json"
+          request["Content-Type"] = "application/json"
+          request.body = params.to_json
+
+          http.request(request)
+        end
+
+        response.code == "201" || response.code != "422"
+      rescue Net::OpenTimeout, Errno::ECONNREFUSED
+        false
+      end
+    end
+  end
+end

data/lib/panacea/rails/template.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+###
+# == Panacea::Rails::Template
+#
+# Template passed to the rails new command.
+#
+# If you want more information about what's happening you can read Panacea::Rails::Generator docs.
+
+require "yaml"
+require_relative "generator"
+
+###
+# Panacea's Installation directory
+ROOT_DIR = File.expand_path("../../../", __dir__)
+
+# Read .panacea configurations file
+configurations_file = File.join(ROOT_DIR, ".panacea")
+panacea_config = YAML.safe_load(File.read(configurations_file))
+panacea_config["ruby_version"] = RUBY_VERSION
+
+# Start running Panacea Generator Actions via Rails Generator / Thor
+panacea_generator = Panacea::Rails::Generator.new(self, panacea_config, ROOT_DIR)
+
+panacea_generator.update_source_paths
+panacea_generator.copy_gemfile
+panacea_generator.copy_readme
+panacea_generator.generate_panacea_document
+panacea_generator.setup_rubocop
+panacea_generator.setup_letter_opener
+panacea_generator.setup_timezone
+panacea_generator.setup_default_locale
+panacea_generator.setup_oj if panacea_config.dig("oj")
+panacea_generator.setup_dotenv if panacea_config.dig("dotenv")
+
+panacea_generator.after_bundle_hook do |generator|
+  generator.setup_bullet
+  generator.setup_test_suite
+  generator.override_test_helper
+  generator.setup_simplecov
+  generator.setup_background_job if panacea_config.dig("background_job") != "none"
+  generator.override_application_system_test if panacea_config.dig("headless_chrome")
+  generator.setup_devise if panacea_config.dig("devise")
+  generator.setup_money_rails if panacea_config.dig("money_rails")
+  generator.setup_kaminari if panacea_config.dig("kaminari")
+  generator.setup_webpack if panacea_config.dig("webpack")
+  generator.setup_foreman if panacea_config.dig("foreman")
+  generator.setup_pundit if panacea_config.dig("pundit")
+
+  # This should be always at the end
+  generator.fix_offenses!
+  generator.commit! if panacea_config.dig("autocommit")
+  generator.setup_githook if panacea_config.dig("githook") && !options[:skip_git]
+
+  generator.bye_message
+end

data/lib/panacea/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Panacea # :nodoc:
+  module Rails # :nodoc:
+    VERSION = "0.1.0"
+  end
+end

data/panacea-rails.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "panacea/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "panacea-rails"
+  spec.version       = Panacea::Rails::VERSION
+  spec.authors       = ["Guillermo Moreno", "Rafael Ramos", "Eduardo Figarola"]
+  spec.email         = ["guillermo@michelada.io", "rafael@michelada.io", "eduardo@michelada.io"]
+
+  spec.summary       = "Rails Apps Generator"
+  spec.homepage      = "https://www.panacea.website"
+  spec.license       = "MIT"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1"
+  spec.add_dependency "slop", "~> 4.6"
+  spec.add_dependency "tty-prompt", "~> 0.17"
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.58"
+  spec.add_development_dependency "sdoc", "~> 1.0"
+end

data/templates/Gemfile.tt

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+<%- db_gem = database_gemfile_entry -%>
+
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "<%= @panacea.dig("ruby_version") %>"
+gem "rails", "~> 5.2.1"
+gem "<%= db_gem.name %>"<%= %(, '#{db_gem.version}') if db_gem.version %>
+
+gem "bootsnap", ">= 1.1.0", require: false
+<% if @panacea.dig("devise") -%>
+gem "devise"
+<% end -%>
+gem "haml-rails"
+gem "interactor-rails"
+<% if @panacea.dig("kaminari") -%>
+gem "kaminari"
+<% end -%>
+<% if @panacea.dig("oj") -%>
+gem "oj", "~> 3"
+<% end -%>
+<% if @panacea.dig("money_rails") -%>
+gem "money-rails", "~> 1"
+<% end -%>
+<% if @panacea.dig("pg_search") -%>
+gem "pg_search"
+<% end -%>
+gem "puma", "~> 3.11"
+<% if @panacea.dig("pundit") -%>
+gem "pundit"
+<% end -%>
+<% if @panacea.dig("markdown") -%>
+gem "redcarpet"
+<% end -%>
+gem "sass-rails", "~> 5.0"
+gem "turbolinks", "~> 5"
+gem "uglifier", ">= 1.3.0"
+<% if @panacea.dig("webpack") -%>
+gem "webpacker"
+<% end -%>
+
+<% if @panacea.dig("background_job") != "none" -%>
+# Background Jobs Adapter
+gem "<%= @panacea.dig("background_job") %>"
+<% end -%>
+
+# Test Suite Gem
+gem "<%= @panacea.dig("test_suite") %>-rails", group: [:development, :test]
+
+group :development, :test do
+  <% if @panacea.dig("awesome_print") -%>
+  gem "awesome_print"
+  <% end -%>
+  <% if @panacea.dig("dotenv") -%>
+  gem "dotenv-rails"
+  <% end -%>
+  <% if @panacea.dig("factory_bot") -%>
+  gem "factory_bot_rails", "~> 4.0"
+  <% end -%>
+  gem "pry"
+  gem "rubocop-rails_config"
+end
+
+group :development do
+  gem "brakeman"
+  gem "bullet"
+  gem "web-console", ">= 3.3.0"
+  gem "listen", ">= 3.0.5", "< 3.2"
+  gem "spring"
+  gem "spring-watcher-listen", "~> 2.0.0"
+  gem "letter_opener"
+end
+
+group :test do
+  gem "capybara", ">= 2.15", "< 4.0"
+  gem "capybara-selenium"
+  gem "chromedriver-helper"
+  <% if @panacea.dig("faker") -%>
+  gem "faker"
+  <% end -%>
+  gem "selenium-webdriver"
+  gem "simplecov", require: false
+  <% if @panacea.dig("http_stubs") != "none" -%>
+  gem "<%= @panacea.dig("http_stubs") %>"
+  <% end -%>
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/templates/PANACEA.tt

@@ -0,0 +1,188 @@
+# Panacea::Rails
+
+Here is what Panacea has setup for you:
+
+### Application Settings
+
+#### Timezone
+
+Default timezone was set to: **<%= @panacea.dig("timezone") %>** in *config/application.rb*
+
+#### Locale
+
+Default locale was set to: **<%= @panacea.dig("locale") %>** in *config/application.rb*
+
+### Development Tools
+
+<% if @panacea.dig("awesome_print") -%>
+#### awesome_print
+The gem was included in Gemfile.
+<% end -%>
+
+#### Bullet
+* The gem was included in Gemfile.
+* `config/environments/development.rb` was modified.
+
+<% if @panacea.dig("foreman") -%>
+#### Foreman
+* Foreman gem was installed in system if needed.
+* **Procfile** was created.
+<% end -%>
+
+<% if @panacea.dig("githook") -%>
+#### Git hook
+The Git hook was installed in *.git/hooks/<%= @panacea.dig("githook_type") %>*
+<% end -%>
+
+### General Purpose
+
+<% if @panacea.dig("devise") -%>
+#### devise
+* The gem was included in Gemfile.
+* `app/models/<%= @panacea.dig("devise_model_name") %>.rb` was created.
+* <%= @panacea.dig("devise_override_views") ? "Devise views were created." : "Devise views were not created." %>
+<% end -%>
+
+<% if @panacea.dig("dotenv") -%>
+#### dotenv-rails
+* The gem was included in Gemfile.
+* `.env` file was created
+* `.env` file was added to .gitignore
+<% end -%>
+
+#### haml-rails
+The gem was included in Gemfile.
+
+#### interactor-rails
+The gem was included in Gemfile.
+
+<% if @panacea.dig("kaminari") -%>
+#### Kaminari
+* The gem was included in Gemfile.
+* The `rails generate kaminari:config` generator was ran.
+<% end -%>
+
+#### letter_opener
+* The gem was included in Gemfile.
+* `config/environments/development.rb` was modified.
+
+<% if @panacea.dig("money_rails") -%>
+#### money-rails
+* The gem was included in Gemfile.
+* The `rails generate money_rails:initializer` generator was ran.
+<% end -%>
+
+<% if @panacea.dig("oj") -%>
+#### oj
+* The gem was included in Gemfile.
+* The `config/initializers/oj.rb` file was created
+<% end -%>
+
+#### pry
+The gem was included in Gemfile.
+
+<% if @panacea.dig("pg_search") -%>
+#### pg_search
+The gem was included in Gemfile.
+<% end -%>
+
+<% if @panacea.dig("pundit") -%>
+#### pundit
+* The gem was included in Gemfile.
+* `app/controllers/application_controller.rb` was modified.
+* The `rails generate pundit:install` generator was ran.
+<% end -%>
+
+<% if @panacea.dig("markdown") -%>
+#### redcarpet
+The gem was included in Gemfile.
+<% end -%>
+
+<% if @panacea.dig("webpack") -%>
+### Assets
+
+#### webpacker
+* The gem was included in Gemfile.
+* **<%= @panacea.dig("webpack_type") %>** was the chosen framework.
+<% end -%>
+
+### Background Job
+
+#### <%= @panacea.dig("background_job") %>
+<% if @panacea.dig("background_job") != "none" -%>
+* The gem was included in Gemfile.
+* `config/application.rb` was modified.
+<% end -%>
+<% if @panacea.dig("background_job") =~ /sidekiq|resque/ -%>
+* `config/routes.rb` were updated.
+<% end -%>
+<% if @panacea.dig("background_job") == "resque" -%>
+* `Rakefile` was updated
+<% end -%>
+
+### Security
+
+#### brakeman
+The gem was included in Gemfile.
+
+### Code Coverage
+
+#### simplecov
+* The gem was included in Gemfile.
+* The expected code coverage was set to: <%= @panacea.dig("expected_coverage") %>
+<% if @panacea.dig("test_suite") == "minitest" -%>
+* `test/support/simplecov.rb` was created.
+<% else -%>
+* `spec/support/simplecov.rb` was created.
+<% end -%>
+
+### Linting
+
+#### rubocop-rails_config
+* The gem was included in Gemfile.
+* The `.rubocop.yml` file was created.
+
+### Testing
+
+<% if @panacea.dig("factory_bot") -%>
+#### factory_bot
+* The gem was included in Gemfile.
+<% if @panacea.dig("test_suite") == "minitest" -%>
+* `test/test_helper.rb` was modified.
+<% else -%>
+* `spec/rails_helper.rb` was modified.
+<% end -%>
+<% end -%>
+
+<% if @panacea.dig("faker") -%>
+#### Faker
+* The gem was included in Gemfile.
+<% if @panacea.dig("test_suite") == "minitest" -%>
+* `test/test_helper.rb` was modified.
+<% else -%>
+* `spec/rails_helper.rb` was modified.
+<% end -%>
+<% end -%>
+
+#### <%= @panacea.dig("test_suite") %>-rails
+* The gem was included in Gemfile.
+<% if @panacea.dig("test_suite") == "minitest" -%>
+* `test/test_helper.rb` was created.
+<% else -%>
+* `spec/rails_helper.rb` was created.
+<% end -%>
+
+<% if @panacea.dig("headless_chrome") -%>
+#### Headless Chrome
+The System Tests were configured to run using a Headless Chrome Driver.
+<% end -%>
+
+<% if @panacea.dig("http_stubs") != "none" -%>
+#### <%= @panacea.dig("http_stubs") %>
+* The gem was included in Gemfile.
+<% if @panacea.dig("test_suite") == "minitest" -%>
+* `test/test_helper.rb` was modified.
+<% else -%>
+* `spec/rails_helper.rb` was modified.
+<% end -%>
+<% end -%>