hoboken 0.9.0 → 0.10.0

data/lib/hoboken/templates/spec/example_worker_spec.rb.tt

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Refer to the Sidekiq documentation[1] for more information about testing
+# workers.
+#
+# [1]: https://github.com/mperham/sidekiq/wiki/Testing
+#
+RSpec.describe ExampleWorker, sidekiq: true do
+  subject(:worker) { described_class }
+
+  it 'performs work' do
+    expect {
+      worker.perform_async
+    }.to change(worker.jobs, :size).by(1)
+  end
+end

data/lib/hoboken/templates/spec/rack_matchers.rb.tt

@@ -7,16 +7,18 @@ RSpec::Matchers.define :have_http_status do |expected|
 
   failure_message do |response|
     'expected last response status to be ' \
-    "#{response_codes.fetch(expected, 'unknown')}, " \
-    "but was #{response.status}"
+      "#{response_codes.fetch(expected, 'unknown')}, " \
+      "but was #{response.status}"
   end
 
   def response_codes
     {
       ok: 200,
+      no_content: 204,
       not_authorized: 401,
       not_found: 404,
-      redirect: 302
+      redirect: 302,
+      server_error: 500
     }.freeze
   end
 end
@@ -28,8 +30,8 @@ RSpec::Matchers.define :have_content_type do |expected|
 
   failure_message do |response|
     'expected last response to have content type ' \
-    "'#{content_types.fetch(expected, 'unknown')}', " \
-    "but was '#{response.content_type}'"
+      "'#{content_types.fetch(expected, 'unknown')}', " \
+      "but was '#{response.content_type}'"
   end
 
   def content_types
@@ -47,7 +49,7 @@ RSpec::Matchers.define :redirect_to do |expected|
 
   failure_message do |response|
     "expected last response to redirect to '#{expected}', " \
-    "but it redirected to '#{path(response)}'"
+      "but it redirected to '#{path(response)}'"
   end
 
   def path(response)

data/lib/hoboken/templates/spec/spec_helper.rb.tt

@@ -2,21 +2,17 @@
 
 ENV['RACK_ENV'] = 'test'
 
-require 'bundler/setup'
+require_relative '../config/environment'
 
 require 'warning'
 
 # Ignore all warnings in Gem dependencies
 Gem.path.each { |path| Warning.ignore(//, path) }
 
-require 'dotenv'
+require 'pry-byebug'
 require 'rack/test'
 require 'support/rack_helpers'
 
-require_relative '../app'
-
-Dotenv.load
-
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.include RackHelpers, rack: true

data/lib/hoboken/templates/spec/turnip_helper.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+Dir.glob('spec/support/steps/**/*_steps.rb') { |f| load f, true }
+
+RSpec.configure do |config|
+  config.raise_error_for_unimplemented_steps = true
+  config.include RackHelpers, feature: true
+end

data/lib/hoboken/templates/styles.css.tt

@@ -41,7 +41,7 @@ footer {
   text-align: center;
 }
 .wrapper {
-  background: url("../img/sinatra.png") no-repeat bottom right;
+  background: url("../images/sinatra.png") no-repeat bottom right;
   width: 1280px;
   margin: 0 auto;
 }

data/lib/hoboken/templates/support/rack_test_assertions.rb.tt

@@ -5,9 +5,11 @@ module Rack
     module Assertions
       RESPONSE_CODES = {
         ok: 200,
+        no_content: 204,
         not_authorized: 401,
         not_found: 404,
-        redirect: 302
+        redirect: 302,
+        server_error: 500
       }.freeze
 
       CONTENT_TYPES = {
@@ -26,7 +28,7 @@ module Rack
       end
 
       def assert_content_type(content_type)
-        unless CONTENT_TYPES.keys.include?(content_type)
+        unless CONTENT_TYPES.key?(content_type)
           raise ArgumentError, "unrecognized content_type (#{content_type})"
         end
 
@@ -65,7 +67,7 @@ module Rack
       def assert_session_has_key(key, message=nil)
         assert_has_session
         msg = build_message(message, 'expected session to have key named <?>', key)
-        assert_block(msg) { last_request.env['rack.session'].keys.include?(key.to_s) }
+        assert_block(msg) { last_request.env['rack.session'].key?(key.to_s) }
       end
 
       def assert_session(key, expected, message=nil)

data/lib/hoboken/templates/test/test_helper.rb.tt

@@ -2,22 +2,19 @@
 
 ENV['RACK_ENV'] = 'test'
 
-require 'bundler/setup'
+require_relative '../config/environment'
 
 require 'warning'
 
 # Ignore all warnings in Gem dependencies
 Gem.path.each { |path| Warning.ignore(//, path) }
 
-require 'dotenv'
 require 'test/unit'
 require 'contest'
+require 'pry-byebug'
 require 'rack/test'
 
 require_relative 'support/rack_helpers'
-require_relative '../app'
-
-Dotenv.load
 
 module Test
   module Unit

data/lib/hoboken/templates/test/unit/example_worker_test.rb.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+# Refer to the Sidekiq documentation[1] for more information about testing
+# workers.
+#
+# [1]: https://github.com/mperham/sidekiq/wiki/Testing
+#
+class ExampleWorkerTest < Test::Unit::TestCase
+  setup do
+    Sidekiq::Worker.clear_all
+  end
+
+  test 'performs work' do
+    assert_equal 0, ExampleWorker.jobs.size
+    ExampleWorker.perform_async
+    assert_equal 1, ExampleWorker.jobs.size
+  end
+end

data/lib/hoboken/templates/vcr_setup.rb.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'vcr'
+
+VCR.configure do |c|
+<% if rspec? -%>
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+<% else -%>
+  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+<% end -%>
+  c.hook_into :webmock
+<% if rspec? -%>
+  c.configure_rspec_metadata!
+<% end -%>
+end

data/lib/hoboken/templates/views/index.erb.tt

@@ -1,6 +1,6 @@
 <div class="wrapper">
   <h1>Hoboken</h1>
-  <img src="img/hoboken.png" />
+  <img src="<%%= image_path('images/hoboken.png') %>" />
   <div class="main">
     <h2>Getting Started</h2>
     <p>Smoke test successful!</p>

data/lib/hoboken/templates/views/layout.erb.tt

@@ -2,15 +2,15 @@
 <html>
 <head>
   <title><%= titleized_name %></title>
-  <link rel="icon" type="image/png" href="img/favicon.png" />
+  <link rel="icon" type="image/png" href="<%%= image_path('images/favicon.png') %>" />
   <link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/normalize/2.1.3/normalize.min.css">
-  <link rel="stylesheet" type="text/css" href="css/styles.css">
-  <script type="text/javascript" src="js/app.js"></script>
+  <%%== stylesheet_tag 'stylesheets/styles' %>
 </head>
 <body>
 <% unless options[:api_only] -%>
   <%%= styled_flash %>
 <% end -%>
   <%%== yield %>
+  <%%== javascript_tag 'javascripts/app' %>
 </body>
 </html>

data/lib/hoboken/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoboken
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/lib/hoboken.rb

@@ -26,11 +26,25 @@ module Hoboken
       File.read('app.rb').include?("require 'sinatra'")
     end
 
+    def modular?
+      !classic?
+    end
+
     def rspec?
       Dir.exist?('spec')
     end
+
+    def rubocop?
+      File.exist?('.rubocop.yml')
+    end
+
+    def sequel?
+      File.exist?('tasks/sequel.rake')
+    end
   end
 
+  require_relative 'hoboken/add_ons/active_record'
+  require_relative 'hoboken/add_ons/airbrake'
   require_relative 'hoboken/add_ons/github_action'
   require_relative 'hoboken/add_ons/heroku'
   require_relative 'hoboken/add_ons/internationalization'
@@ -38,9 +52,11 @@ module Hoboken
   require_relative 'hoboken/add_ons/omniauth'
   require_relative 'hoboken/add_ons/rubocop'
   require_relative 'hoboken/add_ons/sequel'
-  require_relative 'hoboken/add_ons/sprockets'
+  require_relative 'hoboken/add_ons/sidekiq'
   require_relative 'hoboken/add_ons/travis'
+  require_relative 'hoboken/add_ons/turnip'
   require_relative 'hoboken/add_ons/twbs'
+  require_relative 'hoboken/add_ons/vcr'
 
   # Hoboken's command-line interface.
   #
@@ -54,10 +70,17 @@ module Hoboken
     tasks['generate'].options = Hoboken::Generate.class_options
 
     register(
-      AddOns::Heroku,
-      'add:heroku',
-      'add:heroku',
-      'Heroku deployment support'
+      AddOns::ActiveRecord,
+      'add:active_record',
+      'add:active_record',
+      'ActiveRecord database access via sinatra-activerecord gem'
+    )
+
+    register(
+      AddOns::Airbrake,
+      'add:airbrake',
+      'add:airbrake',
+      'Support for official Airbrake library for Ruby applications'
     )
 
     register(
@@ -67,6 +90,13 @@ module Hoboken
       'Github action that runs CI task'
     )
 
+    register(
+      AddOns::Heroku,
+      'add:heroku',
+      'add:heroku',
+      'Heroku deployment support'
+    )
+
     register(
       AddOns::Internationalization,
       'add:i18n',
@@ -103,10 +133,10 @@ module Hoboken
     )
 
     register(
-      AddOns::Sprockets,
-      'add:sprockets',
-      'add:sprockets',
-      'Rack-based asset packaging system'
+      AddOns::Sidekiq,
+      'add:sidekiq',
+      'add:sidekiq',
+      'Background processing with the Sidekiq gem'
     )
 
     register(
@@ -116,11 +146,25 @@ module Hoboken
       'Basic Travis-CI YAML config'
     )
 
+    register(
+      AddOns::Turnip,
+      'add:turnip',
+      'add:turnip',
+      'Gherkin extension for RSpec'
+    )
+
     register(
       AddOns::TwitterBootstrap,
       'add:twbs',
       'add:twbs',
-      'Twitter Bootstrap (requires Sprockets add-on)'
+      'Twitter Bootstrap'
+    )
+
+    register(
+      AddOns::Vcr,
+      'add:vcr',
+      'add:vcr',
+      'Record HTTP interactions and replay them during test runs'
     )
 
     def self.exit_on_failure?

data/test/integration/active_record_test.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class ActiveRecord < IntegrationTestCase
+  # rubocop:disable Metrics/MethodLength
+  def test_activerecord_add_on
+    run_hoboken(:generate) do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:active_record")
+      execute('echo "DATABASE_URL=sqlite3:db/development.db" > .env')
+
+      assert_file('Gemfile', 'sinatra-activerecord', 'sqlite3')
+      assert_file('db/seeds.rb')
+      assert_file('tasks/active_record.rake')
+
+      assert_file('config/environment.rb', "require 'sinatra/activerecord'")
+      assert_file('config/puma.rb', 'ActiveRecord::Base.establish_connection')
+
+      assert_file(
+        'test/test_helper.rb',
+        %r{ENV\['DATABASE_URL'\] = 'sqlite3:db/test\.db'}
+      )
+
+      assert_file('test/test_helper.rb', <<-CODE
+      def run(*args, &block)
+        result = nil
+        ActiveRecord::Base.connection.transaction do
+          result = super
+          raise ActiveRecord::Rollback
+        end
+        result
+      end
+      CODE
+      )
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # rubocop:disable Metrics/MethodLength
+  def test_activerecord_add_on_with_rspec
+    run_hoboken(:generate, test_framework: 'rspec') do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:active_record")
+      execute("#{bin_path} add:rubocop")
+      execute('echo "DATABASE_URL=sqlite3:db/development.db" > .env')
+
+      assert_file(
+        'spec/spec_helper.rb',
+        %r{ENV\['DATABASE_URL'\] = 'sqlite3:db/test\.db'}
+      )
+
+      assert_file('spec/spec_helper.rb', <<-CODE
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      ActiveRecord::Rollback
+    end
+  end
+
+      CODE
+      )
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+end

data/test/integration/airbrake_test.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class AirbrakeTest < IntegrationTestCase
+  def test_airbrake_add_on_with_classic
+    run_hoboken(:generate) do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:airbrake")
+      assert_file('Gemfile', 'airbrake')
+      assert_file('README.md', 'AIRBRAKE_PROJECT_ID')
+      assert_file('README.md', 'AIRBRAKE_PROJECT_KEY')
+      assert_file('config/airbrake.rb')
+      assert_file('config/environment.rb', "require_relative 'airbrake'")
+      assert_file('config/environment.rb', 'use Airbrake::Rack::Middleware')
+    end
+  end
+
+  def test_airbrake_add_on_with_modular
+    run_hoboken(:generate, type: :modular) do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:airbrake")
+      assert_file('Gemfile', 'airbrake')
+      assert_file('README.md', 'AIRBRAKE_PROJECT_ID')
+      assert_file('README.md', 'AIRBRAKE_PROJECT_KEY')
+      assert_file('config/airbrake.rb')
+      assert_file('config/environment.rb', "require_relative 'airbrake'")
+      assert_file('config/environment.rb', 'use Airbrake::Rack::Middleware')
+    end
+  end
+end

data/test/integration/generate_classic_test.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class GenerateClassicTest < IntegrationTestCase
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  def test_generate_classic
+    run_hoboken(:generate) do
+      assert_file '.env'
+      assert_file 'Gemfile'
+      assert_file('Procfile')
+      assert_file 'README.md'
+      assert_file 'Rakefile'
+      assert_file 'app.rb', /require 'sinatra'/
+      assert_file 'app.rb', %r{require 'sinatra/flash'}
+      assert_file 'app.rb', %r{require 'sinatra/asset_pipeline'}
+      assert_file 'app.rb', /require 'erubi'/
+      assert_file 'app.rb', /erb :index/
+      assert_file_does_not_have_content 'app.rb', /json message:/
+      assert_file 'bin/console'
+      assert_file 'bin/server'
+      assert_file 'bin/setup'
+      assert_file 'config.ru', /run Sinatra::Application/
+      assert_file 'config/environment.rb', /set :erb, { escape_html: true }/
+      assert_file 'config/environment.rb', /require 'better_errors'/
+      assert_directory 'assets'
+      assert_directory 'public'
+      assert_directory 'test'
+      assert_file 'views/index.erb'
+      assert_file 'views/layout.erb', /styled_flash/
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+
+  def test_generate_classic_tiny
+    run_hoboken(:generate, tiny: true) do
+      assert_file 'app.rb', /__END__/, /@@layout/, /@@index/
+    end
+  end
+
+  def test_generate_classic_api_only
+    run_hoboken(:generate, api_only: true) do
+      refute_directory('public')
+      refute_directory('views')
+      assert_file 'app.rb', %r{require 'sinatra/json'}
+      assert_file 'app.rb', /json message:/
+      assert_file_does_not_have_content 'app.rb', %r{require 'sinatra/flash'}
+      assert_file_does_not_have_content 'app.rb', /erb :index/
+      assert_file_does_not_have_content(
+        'config/environment.rb',
+        /set :erb, { escape_html: true }/
+      )
+    end
+  end
+
+  def test_generate_api_only_with_tiny
+    run_hoboken(:generate, api_only: true, tiny: true) do
+      assert_file_does_not_have_content 'app.rb', /__END__/, /@@layout/, /@@index/
+    end
+  end
+
+  def test_generate_with_ruby_version
+    run_hoboken(:generate, run_tests: false, rubocop: false, ruby_version: '2.1.0') do
+      assert_file 'Gemfile', /ruby '2\.1\.0'/
+    end
+  end
+
+  def test_generate_with_git
+    run_hoboken(:generate, run_tests: false, rubocop: false, git: true) do
+      assert_directory '.git'
+    end
+  end
+end

data/test/integration/generate_modular_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class GenerateModularTest < IntegrationTestCase
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  def test_generate_modular
+    run_hoboken(:generate, type: :modular) do
+      assert_file '.env'
+      assert_file 'Gemfile'
+      assert_file('Procfile')
+      assert_file 'README.md'
+      assert_file 'Rakefile'
+      assert_file('app.rb', %r{require 'sinatra/base'})
+      assert_file 'app.rb', %r{require 'sinatra/flash'}
+      assert_file('app.rb', /require 'erubi'/)
+      assert_file('app.rb', /module Sample/)
+      assert_file('app.rb', /class App < Sinatra::Base/)
+      assert_file 'bin/console'
+      assert_file 'bin/server'
+      assert_file 'bin/setup'
+      assert_file 'config.ru', /run Sample::App/
+      assert_file 'config/environment.rb', /set :erb, { escape_html: true }/
+      assert_file 'config/environment.rb', /register Sinatra::Flash/
+      assert_file 'config/environment.rb', /require 'better_errors'/
+      assert_directory 'public'
+      assert_file 'test/support/rack_helpers.rb', /Sample::App/
+      assert_file 'views/index.erb'
+      assert_file 'views/layout.erb', /styled_flash/
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
+
+  def test_generate_modular_tiny
+    # FIXME: For some reason modular apps can't find the inline templates even
+    # if `enable :inline_templates is set. This is a bit of an edge case since
+    # most apps with inline templates are of the classic variety.
+    run_hoboken(:generate, run_tests: false, tiny: true, type: :modular) do
+      assert_file 'app.rb', /__END__/, /@@layout/, /@@index/
+    end
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def test_generate_modular_api_only
+    run_hoboken(:generate, type: :modular, api_only: true) do
+      refute_directory('public')
+      refute_directory('views')
+      assert_file 'app.rb', %r{require 'sinatra/json'}
+      assert_file 'app.rb', /json message:/
+      assert_file_does_not_have_content 'app.rb', /erb :index/
+
+      assert_file_does_not_have_content(
+        'config/environment.rb',
+        %r{require 'sinatra/flash'}
+      )
+
+      assert_file_does_not_have_content(
+        'config/environment.rb',
+        /register Sinatra::Flash/
+      )
+
+      assert_file_does_not_have_content(
+        'config/environment.rb',
+        /set :erb, { escape_html: true }/
+      )
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def test_generate_with_ruby_version
+    run_hoboken(:generate, run_tests: false, rubocop: false, ruby_version: '2.1.0') do
+      assert_file 'Gemfile', /ruby '2\.1\.0'/
+    end
+  end
+
+  def test_generate_with_git
+    run_hoboken(:generate, run_tests: false, rubocop: false, git: true) do
+      assert_directory '.git'
+    end
+  end
+end

data/test/integration/github_action_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class GitHubActionTest < IntegrationTestCase
+  def test_github_action_add_on
+    run_hoboken(:generate, run_tests: false, rubocop: false) do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:github_action")
+      assert_file('.github/workflows/ruby.yml')
+    end
+  end
+end

data/test/integration/heroku_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class HerokuTest < IntegrationTestCase
+  def test_heroku_add_on
+    run_hoboken(:generate, run_tests: false) do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:heroku")
+      assert_file('.slugignore')
+      assert_file('config.ru', /\$stdout.sync = true/)
+    end
+  end
+end

data/test/integration/internationalization_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class InternationalizationTest < IntegrationTestCase
+  def test_internationalization_add_on_classic
+    run_hoboken(:generate) do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:i18n")
+      assert_file('Gemfile', 'sinatra-r18n')
+      assert_file('app.rb', "require 'sinatra/r18n'")
+      assert_file('i18n/en.yml')
+    end
+  end
+
+  def test_internationalization_add_on_modular
+    run_hoboken(:generate, type: :modular) do
+      bin_path = File.expand_path('../../bin/hoboken', __dir__)
+      execute("#{bin_path} add:i18n")
+      assert_file('Gemfile', 'sinatra-r18n')
+      assert_file('app.rb', "require 'sinatra/r18n'")
+      assert_file('config/environment.rb', 'register Sinatra::R18n')
+      assert_file('i18n/en.yml')
+    end
+  end
+end