hoboken 0.0.1.beta2 → 0.10.0

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+workers_count = Integer(ENV['WEB_CONCURRENCY'] || 1)
+threads_count = Integer(ENV['MAX_THREADS'] || 5)
+threads threads_count, threads_count
+
+port        ENV['PORT']     || 9292
+environment ENV['RACK_ENV'] || 'production'
+
+if workers_count > 1
+  preload_app!
+  workers workers_count
+
+  # rubocop:disable Lint/EmptyBlock
+  before_fork do
+  end
+
+  on_worker_boot do
+  end
+  # rubocop:enable Lint/EmptyBlock
+end

data/lib/hoboken/templates/rspec.rake.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+# rubocop:disable Lint/SuppressedException
+rescue LoadError
+end
+# rubocop:enable Lint/SuppressedException

data/lib/hoboken/templates/rubocop.yml.tt

@@ -0,0 +1,51 @@
+require:
+    - rubocop-performance
+    - rubocop-rake
+<% if rspec? -%>
+    - rubocop-rspec
+<% end -%>
+<% if sequel? -%>
+    - rubocop-sequel
+<% end -%>
+
+AllCops:
+    Exclude:
+        - 'tmp/*'
+        - 'vendor/bundle/**/*'
+    NewCops: enable
+    TargetRubyVersion: <%= RUBY_VERSION %>
+
+Layout/LineLength:
+    Max: 90
+
+Layout/SpaceAroundEqualsInParameterDefault:
+    EnforcedStyle: no_space
+<% if rspec? -%>
+
+Metrics/BlockLength:
+    IgnoredMethods:
+        - describe
+        - context
+        - it
+        - RSpec.configure
+<% end -%>
+
+Metrics/ClassLength:
+    Max: 150
+
+Metrics/MethodLength:
+    Max: 15
+<% if rspec? -%>
+
+RSpec/DescribeClass:
+    Enabled: false
+
+RSpec/MultipleDescribes:
+    Enabled: false
+<% end -%>
+
+Style/BlockDelimiters:
+    EnforcedStyle: braces_for_chaining
+
+Style/YodaCondition:
+    EnforcedStyle: require_for_equality_operators_only

data/lib/hoboken/templates/seeds.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# This file should contain all the record creation needed to seed the database
+# with its default values.
+#
+# The data can then be loaded with the bin/rails db:seed command (or created
+# alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/lib/hoboken/templates/sequel.rake

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+namespace :db do
+  require 'sequel'
+
+  Sequel.extension :migration
+  db = Sequel.connect(ENV['DATABASE_URL'] || 'sqlite://db/development.db')
+
+  desc 'Migrate the database to latest version'
+  task :migrate do
+    Sequel::Migrator.run(db, 'db/migrate')
+    puts '<= db:migrate executed'
+  end
+
+  desc 'Perform migration reset (full erase and migration up)'
+  task :reset do
+    Sequel::Migrator.run(db, 'db/migrate', target: 0)
+    Sequel::Migrator.run(db, 'db/migrate')
+    puts '<= db:reset executed'
+  end
+end

data/lib/hoboken/templates/server

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  puts '== Starting development server =='
+  system! 'rerun --background foreman start'
+end

data/lib/hoboken/templates/setup

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment
+  # automatically. This script is idempotent, so that you can run it at
+  # anytime and get an expectable outcome. Add necessary setup steps to
+  # this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system! 'bundle config --local cache_all true'
+  system! 'bundle config --local cache_all_platforms true'
+  system! 'bundle config --local ignore_messages.rpush true'
+  system('bundle check') || system!('bundle install')
+
+  system! 'gem list "^foreman$" -v 0.87.2 -i --silent || gem install foreman'
+  system! 'gem list "^rerun$" -v 0.13.1 -i --silent || gem install rerun'
+  system! 'gem list "^rb-fsevent$" -v 0.11.0 -i --silent || gem install rb-fsevent'
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'sidekiq'
+
+Sidekiq.configure_client do |config|
+  config.redis = { size: 1 }
+end
+
+Sidekiq.configure_server do |config|
+  # TODO: Setup an error handling service (i.e. Airbrake, Sentry, etc.)
+  # https://github.com/mperham/sidekiq/wiki/Error-Handling#best-practices
+  # config.error_handlers << ->(ex, ctx_hash) { MyErrorService.notify(ex, ctx_hash) }
+
+  config.death_handlers << lambda do |job, ex|
+    puts "#{job['class']} job #{job['jid']} just died (#{ex.message})"
+  end
+end
+
+Dir.glob(File.join('workers', '**', '*.rb')).each do |worker|
+  require_relative "../#{worker}"
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe 'GET /', rack: true do
+  before { get '/' }
+
+  it { expect(last_response).to have_http_status(:ok) }
+<% if options[:api_only] -%>
+  it { expect(last_response).to have_content_type(:json) }
+<% else -%>
+  it { expect(last_response).to have_content_type(:html) }
+<% end -%>
+  it { expect(last_response.body).to include('Smoke test successful!') }
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_http_status do |expected|
+  match do |response|
+    response.status == response_codes[expected]
+  end
+
+  failure_message do |response|
+    'expected last response status to be ' \
+      "#{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,
+      server_error: 500
+    }.freeze
+  end
+end
+
+RSpec::Matchers.define :have_content_type do |expected|
+  match do |response|
+    response.content_type == content_types[expected]
+  end
+
+  failure_message do |response|
+    'expected last response to have content type ' \
+      "'#{content_types.fetch(expected, 'unknown')}', " \
+      "but was '#{response.content_type}'"
+  end
+
+  def content_types
+    {
+      html: 'text/html;charset=utf-8',
+      json: 'application/json'
+    }.freeze
+  end
+end
+
+RSpec::Matchers.define :redirect_to do |expected|
+  match do |response|
+    path(response) == expected
+  end
+
+  failure_message do |response|
+    "expected last response to redirect to '#{expected}', " \
+      "but it redirected to '#{path(response)}'"
+  end
+
+  def path(response)
+    URI(response.location).path
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+ENV['RACK_ENV'] = 'test'
+
+require_relative '../config/environment'
+
+require 'warning'
+
+# Ignore all warnings in Gem dependencies
+Gem.path.each { |path| Warning.ignore(//, path) }
+
+require 'pry-byebug'
+require 'rack/test'
+require 'support/rack_helpers'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.include RackHelpers, rack: true
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.disable_monkey_patching!
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  config.filter_run_when_matching :focus
+  config.order = :random
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.warnings = true
+
+  Kernel.srand config.seed
+end

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_helpers.rb.tt

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+<% if 'test-unit' == options[:test_framework] -%>
+require_relative 'rack_test_assertions'
+<% end -%>
+<% if 'rspec' == options[:test_framework] -%>
+require_relative 'rack_matchers'
+<% end -%>
+
+# Helpers for running Rack-based tests or specs. Decorates normal Rack methods
+# with an optional `:as` parameter. If present, the `rack.session` will
+# include the value of the given user's ID, effectively signing them in for
+# the request.
+#
+# Example
+# ```
+# # Find or create a user. You can name the class anything you'd like, the
+# # only requirement is that it responds to a `id` method.
+# user = User.new(id: 1) # or User.find, etc.
+# get '/', as: user
+# ```
+#
+# The above will add a `current_user` to the `rack.session` with a value of
+# the user's ID.
+#
+module RackHelpers
+  include Rack::Test::Methods
+<% if 'test-unit' == options[:test_framework] -%>
+  include Rack::Test::Assertions
+<% end -%>
+
+  %w[get post put patch delete options].each do |type|
+    define_method(type) do |uri, params={}, env={}, &block|
+      extract_user!(params, env)
+      super uri, params, env, &block
+    end
+  end
+
+  private
+
+  def extract_user!(params, env)
+    user = params.delete(:as)
+    return unless user
+
+    if env.key?('rack.session')
+      env['rack.session'].merge!(current_user: user.id)
+    else
+      env.merge!({ 'rack.session' => { current_user: user.id } })
+    end
+  end
+
+  def app
+    Sinatra::Application
+  end
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Rack
+  module Test
+    module Assertions
+      RESPONSE_CODES = {
+        ok: 200,
+        no_content: 204,
+        not_authorized: 401,
+        not_found: 404,
+        redirect: 302,
+        server_error: 500
+      }.freeze
+
+      CONTENT_TYPES = {
+        json: 'application/json',
+        html: 'text/html;charset=utf-8'
+      }.freeze
+
+      def assert_body_contains(expected, message=nil)
+        msg = build_message(
+          message,
+          "expected body to contain <?>\n#{last_response.body}",
+          expected
+        )
+
+        assert_block(msg) { last_response.body.include?(expected) }
+      end
+
+      def assert_content_type(content_type)
+        unless CONTENT_TYPES.key?(content_type)
+          raise ArgumentError, "unrecognized content_type (#{content_type})"
+        end
+
+        assert_equal CONTENT_TYPES[content_type], last_response.content_type
+      end
+
+      def assert_flash(type=:notice, message=nil)
+        msg = build_message(
+          message,
+          'expected <?> flash to exist, but was nil',
+          type.to_s
+        )
+
+        assert_block(msg) { last_request.env['rack.session']['flash'] }
+      end
+
+      def assert_flash_message(expected, type=:notice, message=nil)
+        assert_flash(type, message)
+        flash = last_request.env['rack.session']['flash'][type.to_s]
+
+        msg = build_message(
+          message,
+          'expected flash to be <?> but was <?>',
+          expected,
+          flash
+        )
+
+        assert_block(msg) { expected == flash }
+      end
+
+      def assert_has_session(message=nil)
+        msg = build_message(message, 'expected a valid session')
+        assert_block(msg) { last_request.env['rack.session'] }
+      end
+
+      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'].key?(key.to_s) }
+      end
+
+      def assert_session(key, expected, message=nil)
+        assert_session_has_key(key)
+        actual = last_request.env['rack.session'][key.to_s]
+        msg = build_message(
+          message,
+          'expected session key <?> to be <?>, but was <?>',
+          key,
+          expected,
+          actual
+        )
+
+        assert_block(msg) { expected == actual }
+      end
+
+      def assert_response(expected, message=nil)
+        status = last_response.status
+        msg = build_message(
+          message,
+          'expected last response to be <?> but was <?>',
+          "#{RESPONSE_CODES[expected]}:#{expected}",
+          "#{status}:#{RESPONSE_CODES.key(status)}"
+        )
+
+        assert_block(msg) { status == RESPONSE_CODES[expected] }
+      end
+
+      def assert_redirected_to(expected, message=nil)
+        assert_response(:redirect)
+        actual = URI(last_response.location).path
+        msg = build_message(
+          message,
+          'expected to be redirected to <?> but was <?>',
+          expected,
+          actual
+        )
+
+        assert_block(msg) { expected == actual }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+ENV['RACK_ENV'] = 'test'
+
+require_relative '../config/environment'
+
+require 'warning'
+
+# Ignore all warnings in Gem dependencies
+Gem.path.each { |path| Warning.ignore(//, path) }
+
+require 'test/unit'
+require 'contest'
+require 'pry-byebug'
+require 'rack/test'
+
+require_relative 'support/rack_helpers'
+
+module Test
+  module Unit
+    class TestCase
+      # Syntactic sugar for defining a memoized helper method.
+      #
+      def self.let(name, &block)
+        ivar = "@#{name}"
+        class_eval do
+          define_method(name) do
+            if instance_variable_defined?(ivar)
+              instance_variable_get(ivar)
+            else
+              value = instance_eval(&block)
+              instance_variable_set(ivar, value)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+module Rack
+  module Test
+    class TestCase < ::Test::Unit::TestCase
+      include RackHelpers
+    end
+  end
+end

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

@@ -1,8 +1,16 @@
-require_relative "test_helper"
+# frozen_string_literal: true
+
+require_relative '../test_helper'
 
 class AppTest < Rack::Test::TestCase
-  test "GET /" do
-    get "/"
+  test 'GET /' do
+    get '/'
     assert_response :ok
+<% if options[:api_only] -%>
+    assert_content_type(:json)
+<% else -%>
+    assert_content_type(:html)
+<% end -%>
+    assert_body_contains('Smoke test successful!')
   end
 end

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/test_unit.rake.tt

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << 'test/unit'
+    t.test_files = Dir['test/unit/**/*_test.rb']
+  end
+
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << 'test/unit'
+    t.test_files = Dir['test/integration/**/*_test.rb']
+  end
+
+  desc 'Run all tests'
+  task all: %w[test:unit test:integration]
+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>
@@ -51,9 +51,10 @@
     <p>The following Rake tasks are available:</p>
     <table>
       <tr>
-        <td>rake server</td>
-        <th>Start the development server</th>
+        <td>rake ci</td>
+        <th>Run CI checks</th>
       </tr>
+<% if 'test-unit' == options[:test_framework] -%>
       <tr>
         <td>rake test:all</td>
         <th>Run all tests</th>
@@ -62,6 +63,12 @@
         <td>rake test:unit</td>
         <th>Run unit tests</th>
       </tr>
+<% else -%>
+      <tr>
+        <td>rake spec</td>
+        <th>Run RSpec</th>
+      </tr>
+<% end -%>
     </table>
 
     <h3>Add Ons</h3>
@@ -70,7 +77,7 @@
 
   <h3>Links</h3>
   <ul>
-    <li><a href="https://github.com/bnadlerjr/hoboken">Documentation</a></li>
+    <li><a href="http://bobnadler.com/hoboken">Documentation</a></li>
     <li><a href="https://github.com/bnadlerjr/hoboken">Source Code</a></li>
   </ul>