hoboken 0.9.0 → 0.10.0

data/lib/hoboken/add_ons/internationalization.rb

@@ -10,8 +10,8 @@ module Hoboken
         insert_into_file('app.rb', after: %r{require 'sinatra('|/base')}) do
           "\nrequire 'sinatra/r18n'"
         end
-        insert_into_file('app.rb', after: /Sinatra::Base/) do
-          "\n    register Sinatra::R18n"
+        insert_into_file('config/environment.rb', after: /register Sinatra::Flash/) do
+          "\n      register Sinatra::R18n"
         end
       end
 

data/lib/hoboken/add_ons/metrics.rb

@@ -28,7 +28,7 @@ module Hoboken
         return unless rspec?
 
         insert_into_file 'spec/spec_helper.rb', before: snippet_location do
-          snippet('rspec')
+          snippet('spec')
         end
       end
 
@@ -44,6 +44,7 @@ module Hoboken
           SimpleCov.start do
             add_filter '/bin/'
             add_filter '/config/'
+            add_filter '/db/migrate/'
             add_filter '/#{framework_folder}/'
             coverage_dir 'tmp/coverage'
           end
@@ -52,7 +53,7 @@ module Hoboken
       end
 
       def snippet_location
-        %r{require 'bundler/setup'}
+        %r{require_relative '\.\./config/environment'}
       end
     end
   end

data/lib/hoboken/add_ons/omniauth.rb

@@ -24,8 +24,9 @@ module Hoboken
           end
         CODE
 
-        indentation = classic? ? 2 : 4
-        insert_into_file('app.rb', after: /use Rack::Session::Cookie.+\n/) do
+        indentation = classic? ? 2 : 6
+        location = /use Rack::Session::Cookie.+\n/
+        insert_into_file('config/environment.rb', after: location) do
           "\n#{indent(snippet, indentation)}\n"
         end
       end
@@ -104,12 +105,12 @@ module Hoboken
         append_file('spec/app_spec.rb') do
           <<~CODE
 
-            # rubocop:disable RSpec/DescribeClass
+            # rubocop:disable Metrics/BlockLength
             RSpec.describe 'omniauth', rack: true do
-              before(:each) { OmniAuth.config.test_mode = true }
+              before { OmniAuth.config.test_mode = true }
 
               describe 'GET /login' do
-                before(:each) { get '/login' }
+                before { get '/login' }
 
                 it { expect(last_response).to have_http_status(:ok) }
                 it { expect(last_response).to have_content_type(:html) }
@@ -131,7 +132,7 @@ module Hoboken
                   }
                 end
 
-                before(:each) do
+                before do
                   OmniAuth.config.mock_auth[:#{provider}] = auth_hash
                   get '/auth/#{provider}/callback'
                 end
@@ -145,7 +146,7 @@ module Hoboken
               end
 
               describe 'GET /auth/failure' do
-                before(:each) do
+                before do
                   OmniAuth.config.mock_auth[:#{provider}] = :invalid_credentials
                   get '/auth/failure'
                 end
@@ -153,7 +154,7 @@ module Hoboken
                 it { expect(last_response).to have_http_status(:not_authorized) }
               end
             end
-            # rubocop:enable RSpec/DescribeClass
+            # rubocop:enable Metrics/BlockLength
           CODE
         end
       end

data/lib/hoboken/add_ons/rubocop.rb

@@ -7,8 +7,10 @@ module Hoboken
     class Rubocop < ::Hoboken::Group
       def add_gems
         gem 'rubocop', version: '1.12', group: %i[development test]
+        gem 'rubocop-performance', version: '1.13', group: %i[development test]
         gem 'rubocop-rake', version: '0.5', group: %i[development test]
         gem 'rubocop-rspec', version: '2.2', group: %i[development test] if rspec?
+        gem 'rubocop-sequel', version: '0.2', group: %i[development test] if sequel?
       end
 
       def rubocop_yml
@@ -20,16 +22,20 @@ module Hoboken
           <<~TEXT
             # frozen_string_literal: true
 
-            require 'rubocop/rake_task'
-
-            RuboCop::RakeTask.new
+            begin
+              require 'rubocop/rake_task'
+              RuboCop::RakeTask.new
+            # rubocop:disable Lint/SuppressedException
+            rescue LoadError
+            end
+            # rubocop:enable Lint/SuppressedException
           TEXT
         end
       end
 
       def ci_task
         task_list = if rspec?
-                      '%w[rspec rubocop]'
+                      '%w[spec rubocop]'
                     else
                       "['test:all', 'rubocop']"
                     end

data/lib/hoboken/add_ons/sequel.rb

@@ -8,6 +8,7 @@ module Hoboken
       def add_gems
         gem 'sequel', version: '5.43'
         gem 'sqlite3', version: '1.4', group: %i[development test]
+        gem 'rubocop-sequel', version: '0.2', group: %i[development test] if rubocop?
       end
 
       def setup_directories
@@ -25,9 +26,9 @@ module Hoboken
       end
 
       def require_db_config
-        location = classic? ? 'configure do' : 'module'
-        insert_into_file('app.rb', before: location) do
-          "require_relative 'config/db'\n\n"
+        location = %r{require_relative '\.\./app'}
+        insert_into_file('config/environment.rb', before: location) do
+          "require_relative 'db'\n\n"
         end
       end
 
@@ -49,26 +50,20 @@ module Hoboken
           "\nrequire 'sequel'"
         end
 
-        append_file('test/test_helper.rb') do
-          <<~CODE
-
-            module Test
-              module Database
-                class TestCase < Test::Unit::TestCase
-                  def run(*args, &block)
-                    result = nil
-                    DB.transaction(rollback: :always) { result = super }
-                    result
-                  end
-                end
-              end
-            end
-          CODE
+        snippet = <<~CODE
+          def run(*args, &block)
+            result = nil
+            DB.transaction(rollback: :always) { result = super }
+            result
+          end
+        CODE
+
+        insert_into_file('test/test_helper.rb', after: /include RackHelpers\n/) do
+          "\n#{indent(snippet, 6)}"
         end
       end
       # rubocop:enable Metrics/MethodLength
 
-      # rubocop:disable Metrics/MethodLength
       def add_database_spec_helper
         return unless rspec?
 
@@ -76,21 +71,52 @@ module Hoboken
           "ENV['DATABASE_URL'] = 'sqlite://db/test.db'\n"
         end
 
-        snippet_rack = <<~CODE
-          config.around(:example, rack: true) do |example|
-            DB.transaction(rollback: :always) { example.run }
-          end
-        CODE
-
-        snippet_database = <<~CODE
-          config.around(:example, database: true) do |example|
+        snippet = <<~CODE
+          config.around do |example|
             DB.transaction(rollback: :always) { example.run }
           end
         CODE
 
         location = /RSpec\.configure do \|config\|\n/
         insert_into_file('spec/spec_helper.rb', after: location) do
-          "#{indent(snippet_rack, 2)}\n#{indent(snippet_database, 2)}\n"
+          "#{indent(snippet, 2)}\n"
+        end
+      end
+
+      def update_rubocop_config
+        return unless rubocop?
+
+        insert_into_file('.rubocop.yml', after: /require:\n/) do
+          "    - rubocop-sequel\n"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def update_readme
+        snippet = <<~CODE
+          <tr>
+              <td>DATABASE_URL</td>
+              <td>Yes</td>
+              <td>
+                `sqlite://db/test.db` (for the test environment <em>only</em>)
+              </td>
+              <td>
+                Connection URL to the database. The format varies according
+                database adapter. Refer to the
+                <a href="https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html">
+                Sequel gem documentation</a> for more information. Some examples:
+                <dl>
+                  <dt>Sqlite3</dt>
+                  <dd>`sqlite://db/development.db`</dd>
+                  <dt>PostgreSQL</dt>
+                  <dd>`postgresql://localhost/myapp_development?pool=5`</dd>
+                </dl>
+              </td>
+          </tr>
+        CODE
+
+        insert_into_file('README.md', after: /<tbody>\n/) do
+          indent(snippet, 8)
         end
       end
       # rubocop:enable Metrics/MethodLength
@@ -98,7 +124,7 @@ module Hoboken
       def reminders
         say "\nGemfile updated... don't forget to 'bundle install'"
         say <<~TEXT
-          #{'          '}
+
           Notes:
             * The sqlite3 gem has been installed for dev and test environments only. You will need to specify a gem to use for production.
             * You will need to specify an environment variable 'DATABASE_URL' (either add it to .env or export it)

data/lib/hoboken/add_ons/sidekiq.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Background processing via the Sidekiq gem.
+    #
+    class Sidekiq < ::Hoboken::Group
+      def add_gems
+        gem 'sidekiq', version: '6.2'
+      end
+
+      def adjust_rackup_config
+        gsub_file('config.ru', /run .*::App.*\n/) do |match|
+          <<~CODE
+            require 'sidekiq/web'
+
+            if 'production' == ENV.fetch('RACK_ENV', 'production')
+              Sidekiq::Web.use Rack::Auth::Basic do |username, password|
+                [username, password] == [ENV['SIDEKIQ_USERNAME'], ENV['SIDEKIQ_PASSWORD']]
+              end
+            end
+
+            Sidekiq::Web.use Rack::Session::Cookie, secret: ENV['SESSION_SECRET']
+            run Rack::URLMap.new('/' => #{match[4...-1].chomp}, '/sidekiq' => Sidekiq::Web)
+          CODE
+        end
+      end
+
+      def setup_config
+        template('hoboken/templates/sidekiq.rb.tt', 'config/sidekiq.rb')
+        location = "require_relative '../app'"
+        insert_into_file('config/environment.rb', before: location) do
+          "require_relative 'sidekiq'\n\n"
+        end
+      end
+
+      def example_worker
+        empty_directory('workers')
+        template('hoboken/templates/example_worker.rb.tt', 'workers/example_worker.rb')
+      end
+
+      def worker_test_and_helper
+        return if rspec?
+
+        insert_into_file('test/test_helper.rb', after: "require 'rack/test'") do
+          "\nrequire 'sidekiq/testing'"
+        end
+
+        template(
+          'hoboken/templates/test/unit/example_worker_test.rb.tt',
+          'test/unit/example_worker_test.rb'
+        )
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def worker_spec_and_helper
+        return unless rspec?
+
+        insert_into_file('spec/spec_helper.rb', after: "require 'rack/test'") do
+          "\nrequire 'sidekiq/testing'"
+        end
+
+        snippet = <<~CODE
+          config.before(:each, sidekiq: true) do
+            Sidekiq::Worker.clear_all
+          end
+        CODE
+
+        location = /RSpec\.configure do \|config\|\n/
+        insert_into_file('spec/spec_helper.rb', after: location) do
+          "#{indent(snippet, 2)}\n"
+        end
+
+        template(
+          'hoboken/templates/spec/example_worker_spec.rb.tt',
+          'spec/example_worker_spec.rb'
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def add_worker_to_procfile
+        append_file('Procfile') do
+          "\nworker: bundle exec sidekiq " \
+            '-r ./config/sidekiq.rb ' \
+            '-e $RACK_ENV ' \
+            '-c ${MAX_THREADS:-5} ' \
+            "-v\n"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def update_readme
+        snippet = <<~CODE
+          <tr>
+              <td>REDIS_URL</td>
+              <td>Yes</td>
+              <td>localhost:6379</td>
+              <td>Redis connection URL</td>
+          </tr>
+          <tr>
+              <td>SIDEKIQ_PASSWORD</td>
+              <td>Production Only</td>
+              <td>None</td>
+              <td>Password for SidekiqUI Basic Auth</td>
+          </tr>
+          <tr>
+              <td>SIDEKIQ_USERNAME</td>
+              <td>Production Only</td>
+              <td>None</td>
+              <td>Username for SidekiqUI Basic Auth</td>
+          </tr>
+        CODE
+
+        insert_into_file('README.md', after: /<tbody>\n/) do
+          indent(snippet, 8)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def reminders
+        text = <<~TEXT
+
+          Gemfile updated... don't forget to 'bundle install'
+
+          You can configure a Sidekiq error handing service in `config/sidekiq.rb`.
+
+          Sidekiq UI is available at '/sidekiq'. In production environments
+          the UI is protected with HTTP Basic Auth. Don't forget to set
+          `SIDEKIQ_USERNAME` and `SIDEKIQ_PASSWORD` in your production
+          environment or you won't be able to access the Sidekiq UI.
+        TEXT
+
+        say text, :green
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/turnip.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Gherkin extension for RSpec
+    #
+    class Turnip < ::Hoboken::Group
+      def add_gems
+        return unless rspec?
+
+        gem 'turnip', version: '4.3', group: :test
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def add_sample_files
+        return unless rspec?
+
+        empty_directory('spec/features')
+        empty_directory('spec/support/steps')
+        create_file('spec/features/example.feature') do
+          <<~TEXT
+            @feature
+            Feature: An Example
+                This is an example feature spec that can be deleted.
+
+                Scenario: Name of some scenario
+                    Given nothing
+                    When I do nothing
+                    Then nothing should happen
+          TEXT
+        end
+
+        create_file('spec/support/steps/example_steps.rb') do
+          <<~CODE
+            # frozen_string_literal: true
+
+            # Steps for the example feature that can be deleted.
+
+            step 'nothing' do
+              # ...
+            end
+
+            step 'I do nothing' do
+              # ...
+            end
+
+            step 'nothing should happen' do
+              # ...
+            end
+          CODE
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def add_helper
+        return unless rspec?
+
+        template(
+          'hoboken/templates/spec/turnip_helper.rb.tt',
+          'spec/turnip_helper.rb'
+        )
+      end
+
+      def rake_task
+        return unless rspec?
+
+        create_file('tasks/turnip.rake') do
+          <<~TEXT
+            # frozen_string_literal: true
+
+            require 'rspec/core/rake_task'
+
+            desc 'Run turnip acceptance tests'
+            RSpec::Core::RakeTask.new(:turnip) do |t|
+              t.pattern = './spec{,/*/**}/*.feature'
+              t.rspec_opts = ['-r turnip/rspec']
+            end
+          TEXT
+        end
+      end
+
+      def default_rake_task
+        return unless rspec?
+
+        gsub_file('Rakefile', /task default:.*/, 'task default: %w[spec turnip]')
+      end
+
+      def ci_task
+        return unless rspec?
+
+        gsub_file('Rakefile', /task ci:.*/) do |match|
+          if match.include?('rubocop')
+            'task ci: %w[spec turnip rubocop]'
+          else
+            'task ci: %w[spec turnip]'
+          end
+        end
+      end
+
+      def reminders
+        if rspec?
+          say "Gemfile updated... don't forget to 'bundle install'", :green
+        else
+          say 'Turnip requires RSpec to be setup', :red
+        end
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/twbs.rb

@@ -6,31 +6,26 @@ module Hoboken
     #
     class TwitterBootstrap < ::Hoboken::Group
       def add_gem
-        return unless sprockets?
-
         gem 'bootstrap', version: '5.0.0.beta3', group: :assets
       end
 
       def update_app
-        return unless sprockets?
-
         indentation = classic? ? 2 : 6
-        insert_into_file('app.rb', after: /require.*sprockets_chain.*\n/) do
+        location = /configure do\n/
+        insert_into_file('config/environment.rb', after: location) do
           indent("require 'bootstrap'\n", indentation)
         end
       end
 
       def update_asset_files
-        return unless sprockets?
-
-        prepend_file('assets/styles.scss') do
+        prepend_file('assets/stylesheets/styles.scss') do
           <<~CODE
             @import "bootstrap";
 
           CODE
         end
 
-        prepend_file('assets/app.js') do
+        prepend_file('assets/javascripts/app.js') do
           <<~CODE
             //= require popper
             //= require bootstrap-sprockets
@@ -38,17 +33,7 @@ module Hoboken
         end
       end
 
-      def update_sprockets_rake_tasks
-        return unless sprockets?
-
-        insert_into_file('tasks/sprockets.rake', after: /require 'sprockets'\n/) do
-          "  require 'bootstrap'\n"
-        end
-      end
-
       def remove_normalize_css
-        return unless sprockets?
-
         gsub_file(
           'views/layout.erb',
           '<link rel="stylesheet" type="text/css" ' \
@@ -58,22 +43,7 @@ module Hoboken
       end
 
       def reminders
-        if sprockets?
-          say "\nGemfile updated... don't forget to 'bundle install'"
-        else
-          text = <<~TEXT
-            Sprockets is required. Please install the Sprockets add-on
-            first (hoboken add:sprockets).
-          TEXT
-
-          say text, :red
-        end
-      end
-
-      private
-
-      def sprockets?
-        Dir.exist?('assets')
+        say "\nGemfile updated... don't forget to 'bundle install'"
       end
     end
   end

data/lib/hoboken/add_ons/vcr.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Record your test suite's HTTP interactions and replay them during
+    # future test runs.
+    #
+    class Vcr < ::Hoboken::Group
+      def add_gems
+        gem 'vcr', version: '6.0', group: :test
+        gem 'webmock', version: '3.13', group: :test
+      end
+
+      def add_directories
+        empty_directory(File.join(location, 'fixtures', 'vcr_cassettes'))
+      end
+
+      def add_setup_file
+        template(
+          'hoboken/templates/vcr_setup.rb.tt',
+          File.join(location, 'support/vcr_setup.rb')
+        )
+      end
+
+      def require_vcr_in_test_helper
+        return if rspec?
+
+        snippet_location = "require_relative 'support/rack_helpers'"
+        insert_into_file('test/test_helper.rb', after: snippet_location) do
+          "\nrequire_relative 'support/vcr_setup'"
+        end
+      end
+
+      def require_vcr_in_spec_helper
+        return unless rspec?
+
+        snippet_location = "require 'support/rack_helpers'"
+        insert_into_file('spec/spec_helper.rb', after: snippet_location) do
+          "\nrequire 'support/vcr_setup'"
+        end
+      end
+
+      def reminders
+        say "Gemfile updated... don't forget to 'bundle install'", :green
+      end
+
+      private
+
+      def location
+        rspec? ? 'spec' : 'test'
+      end
+    end
+  end
+end