hoboken 0.0.1.beta2 → 0.10.0

data/lib/hoboken/templates/Gemfile.erb.tt

@@ -1,15 +1,50 @@
-source "https://rubygems.org"
-ruby "<%= options[:ruby_version] %>"
+# frozen_string_literal: true
 
-gem "rack_csrf", "~> 2.4.0"
-gem "sinatra",   "~> 1.4.3"
-gem "thin",      "~> 1.5.1"
+source 'https://rubygems.org'
+ruby '<%= options[:ruby_version] %>'
+
+<% unless options[:api_only] -%>
+gem 'erubi', '~> 1.10'
+<% end -%>
+gem 'puma', '~> 5.2'
+<% unless options[:api_only] -%>
+gem 'rack_csrf', '~> 2.6'
+<% end -%>
+gem 'rake', '~> 12.3'
+gem 'sinatra', '~> 2.1'
+<% unless options[:api_only] -%>
+gem 'sinatra-asset-pipeline', '~> 2.2'
+<% end -%>
+gem 'sinatra-contrib', '~> 2.1'
+<% unless options[:api_only] -%>
+gem 'sinatra-flash', '~> 0.3'
+<% end -%>
+<% unless options[:api_only] -%>
+
+group :assets do
+  gem 'sassc', '~> 2.4'
+  gem 'uglifier', '~> 4.2'
+end
+<% end -%>
 
 group :development do
-  gem "rake",             "~> 10.1.0"
-  gem "sinatra-reloader", "~> 1.0"
+  gem 'better_errors', '~> 2.9'
+  gem 'binding_of_caller', '~> 1.0'
+  gem 'dotenv', '~> 2.7'
+  gem 'pry-byebug', '~> 3.9'
+  gem 'racksh', '~> 1.0'
 end
 
 group :test do
-  gem "contest", "~> 0.1.3"
+<% if 'test-unit' == options[:test_framework] -%>
+  gem 'contest', '~> 0.1'
+<% end -%>
+  gem 'rack-test', '~> 1.1'
+<% if 'rspec' == options[:test_framework] -%>
+  gem 'rspec', '~> 3.10'
+<% end -%>
+<% if 'test-unit' == options[:test_framework] -%>
+  gem 'test-unit', '~> 3.4'
+<% end -%>
+  gem 'warning', '~> 1.2'
 end

data/lib/hoboken/templates/README.md.tt

@@ -1,50 +1,132 @@
 # <%= titleized_name %>
 
+## Overview
+
 TODO: Project description.
 
+### Features
+#### Feature A
+TODO: Describe feature.
+
+#### Feature B
+TODO: Describe feature.
+
+### Links
+* [Production](TODO)
+* [QA](TODO)
+* [Issue Tracking](TODO)
+* [Continuous Integration](TODO)
+
+### Table of Contents
+
+* [Overview](#overview)
+* [Getting Started](#getting-started)
+* [Configuration](#configuration)
+<% if 'rspec' == options[:test_framework] -%>
+* [Specs](#specs)
+<% else -%>
+* [Tests](#tests)
+<% end -%>
+* [Rake Tasks](#rake-tasks)
+* [Logging](#logging)
+* [Deploying](#deploying)
+* [Dev Notes](#dev-notes)
+
 ## Getting Started
 
-### Starting the Server
+The following pre-requisites are needed to build this project:
+* Ruby <%= RUBY_VERSION %>
 
-### Project Layout
+After cloning this repository, the project can be setup by running the `./bin/setup` script. This script will install dependencies and perform any other required setup tasks.
 
-## Notes / Use
+Once setup is complete, you can start a local development server by running the `./bin/server` script. Additionally, you can start a development console using the `./bin/console` script. The console uses the [racksh](https://github.com/sickill/racksh) gem which exposes a `$rack` variable that can be used to make simulated HTTP requests.
 
-## Contributing
+## Configuration
+Environment variables are used for project configuration. For local development, the `.env` file is used. A sample file is shown below.
 
-### Issues / Roadmap
+```
+PORT=9292
+RACK_ENV=development
+SESSION_SECRET=secret
+```
 
-Use GitHub issues for reporting bug and feature requests.
+Here is a table containing all available environment variable configuration options and their descriptions.
 
-### Patches / Pull Requests
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don’t break it in a future version
-  unintentionally.
-* Commit, do not mess with Rakefile, version, or history (if you want to have
-  your own version, that is fine but bump version in a commit by itself I can
-  ignore when I pull).
-* Send me a pull request. Bonus points for topic branches.
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Required?</th>
+            <th>Default Value</th>
+            <th>Description</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>MAX_THREADS</td>
+            <td>No</td>
+            <td>5</td>
+            <td>The maximum number of threads that a Puma worker process should use</td>
+        </tr>
+        <tr>
+            <td>PORT</td>
+            <td>No</td>
+            <td>9292</td>
+            <td>Web server port</td>
+        </tr>
+        <tr>
+            <td>RACK_ENV</td>
+            <td>No</td>
+            <td>production</td>
+            <td>Web server environment (i.e. development, test, production, etc.)</td>
+        </tr>
+        <tr>
+            <td>SESSION_SECRET</td>
+            <td>Yes</td>
+            <td>None</td>
+            <td>Key used for signing and/or encrypting cookies set by the application to maintain session state</td>
+        </tr>
+        <tr>
+            <td>WEB_CONCURRENCY</td>
+            <td>No</td>
+            <td>1</td>
+            <td>The number of Puma worker processes</td>
+        </tr>
+    </tbody>
+</table>
 
-## License
-(The MIT License)
+## Development
+This project has the following default behavior:
 
-Copyright (c) <%= Date.today.year %> <%= author %>
+* helpers scripts for common project actions; refer to the `bin` folder
+* uses [Puma](https://github.com/puma/puma) as the default web server
+<% unless options[:api_only] -%>
+* [erubi](https://github.com/jeremyevans/erubi) for templating; escaping is done by default
+* [Rack::Csrf](http://rubygems.org/gems/rack_csrf") is turned on by default
+<% end -%>
+* environment variable support via the [dotenv](http://rubygems.org/gems/dotenv) gem
+* Procfile for [foreman](https://github.com/ddollar/foreman) support
+* code reloading via the [rerun](https://github.com/alexch/rerun) gem is enabled for the development environment
+* [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug") is installed for debugging
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+<% if 'rspec' == options[:test_framework] -%>
+## Specs
+This project uses [RSpec](https://rspec.info/) for testing. Specs can be ran using the rake task `rake spec`.
+<% else -%>
+## Tests
+This project uses [Test Unit](https://test-unit.github.io/) for testing. Tests can be ran using the rake task `rake test:all`.
+<% end -%>
+
+## Rake Tasks
+To see a list of available tasks run the `rake -T` command.
+
+## Logging
+TODO: Describe how logging is setup (i.e. files, STDOUT, services like Papertrail, DataDog, etc.).
+
+## Deploying
+TODO: Describe how to deploy the project (QA, production, CI setup, etc.). Don't forget to describe how project environment variables are set for the various deployment targets.
+
+## Dev Notes
+
+## License
+Copyright (c) <%= Date.today.year %> <%= author %>

data/lib/hoboken/templates/Rakefile.tt

@@ -1,23 +1,27 @@
-require "rake/testtask"
+# frozen_string_literal: true
+<% unless options[:api_only] -%>
 
-task :default => "test:all"
+require 'sinatra/asset_pipeline/task'
+require_relative 'config/environment'
+
+<% if 'modular' == options[:type] -%>
+Sinatra::AssetPipeline::Task.define! <%= camel_name %>::App
+<% else -%>
+Sinatra::AssetPipeline::Task.define! Sinatra::Application
+<% end -%>
+<% end -%>
 
 # Import any external rake tasks
 Dir.glob('tasks/*.rake').each { |r| import r }
 
-desc "Start the development server"
-task :server do
-  port = ENV["PORT"] || 9292
-  rack_env = ENV["RACK_ENV"] || "development"
-  exec("bundle exec thin start -p #{port} -e #{rack_env}")
-end
+<% if 'test-unit' == options[:test_framework] -%>
+task default: 'test:all'
 
-namespace :test do
-  Rake::TestTask.new(:unit) do |t|
-    t.libs << 'test/unit'
-    t.test_files = Dir["test/unit/**/*_test.rb"]
-  end
+desc 'Run CI checks'
+task ci: ['test:all']
+<% else -%>
+task default: 'spec'
 
-  desc "Run all tests"
-  task :all => %w[test:unit]
-end
+desc 'Run CI checks'
+task ci: ['spec']
+<% end -%>

data/lib/hoboken/templates/active_record.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sinatra/activerecord/rake'
+
+namespace :db do
+  # rubocop:disable Rake/Desc
+  task :load_config do
+    require_relative '../config/environment'
+  end
+  # rubocop:enable Rake/Desc
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'airbrake'
+
+Airbrake.configure do |c|
+  c.environment = ENV['RACK_ENV']
+  c.ignore_environments = %w[development test]
+  c.project_id = ENV['AIRBRAKE_PROJECT_ID']
+  c.project_key = ENV['AIRBRAKE_PROJECT_KEY']
+
+  # Set your application's version, or use a Git SHA
+  # c.app_version = '1.0.0' or `git rev-parse --short HEAD`
+end

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

@@ -1,15 +1,29 @@
-require "sinatra"
-require "rack/csrf"
+# frozen_string_literal: true
 
-Dir.glob(File.join("helpers", "**", "*.rb")).each do |helper|
-  require_relative helper
-end
-
-require "sinatra/reloader" if development?
+<% unless options[:api_only] -%>
+require 'erubi'
+require 'rack/csrf'
+<% end -%>
+require 'sinatra'
+<% unless options[:api_only] -%>
+require 'sinatra/asset_pipeline'
+<% end -%>
+<% if options[:api_only] -%>
+require 'sinatra/json'
+<% else -%>
+require 'sinatra/flash'
+<% end -%>
+<% unless options[:api_only] -%>
+require 'sinatra/sprockets-helpers'
+require 'uglifier'
+<% end -%>
 
-use Rack::Session::Cookie, :secret => "TODO: CHANGE ME"
-use Rack::Csrf, :raise => true
-
-get "/" do
+<% if options[:api_only] -%>
+get '/' do
+  json message: 'Smoke test successful!'
+end
+<% else -%>
+get '/' do
   erb :index
 end
+<% end -%>

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+unless 'production' == ENV['RACK_ENV']
+  require 'dotenv'
+  Dotenv.load
+end
+
+require_relative '../app'
+
+configure do
+<% if options[:api_only] -%>
+  # Configuration common to all environments goes here...
+<% else -%>
+  use Rack::Session::Cookie, secret: ENV['SESSION_SECRET']
+  use Rack::Csrf, raise: true, skip_if: proc {
+    'test' == ENV.fetch('RACK_ENV', 'production')
+  }
+
+  set :erb, { escape_html: true }
+
+  set :assets_precompile, %w[
+    javascripts/app.js
+    stylesheets/styles.scss
+    *.png *.jpg *.svg *.eot *.ttf *.woff *.woff2
+  ]
+  set :assets_paths, %w[assets vendor] + Sprockets.paths
+  set :assets_css_compressor, :scss
+  set :assets_js_compressor, Uglifier.new(harmony: true)
+  register Sinatra::AssetPipeline
+<% end -%>
+end
+
+configure :development do
+  require 'better_errors'
+  use BetterErrors::Middleware
+  BetterErrors.application_root = File.expand_path('..', __dir__)
+end
+
+configure :test do
+  set :raise_errors, true
+  set :dump_errors, false
+  set :show_exceptions, false
+end
+
+configure :production do
+  before do
+    redirect request.url.sub('http', 'https') unless request.secure?
+  end
+end

data/lib/hoboken/templates/config.ru.tt

@@ -1,3 +1,5 @@
-require "bundler/setup"
-require File.expand_path("../app", __FILE__)
+# frozen_string_literal: true
+
+require_relative 'config/environment'
+
 run Sinatra::Application

data/lib/hoboken/templates/console

@@ -0,0 +1,19 @@
+#!/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 application console =='
+  puts 'Console supports racksh. A `$rack` global variable is provided for'
+  puts "making simulated requests (i.e. `$rack.get '/'`)."
+  puts "\nSee the racksh gem for more details."
+  puts "https://github.com/sickill/racksh\n\n"
+  system! 'bundle exec racksh'
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+if ENV['DATABASE_URL']
+  require 'logger'
+  require 'sequel'
+
+  args = 'test' == ENV['RACK_ENV'] ? ['tmp/db_test.log', 'daily'] : [$stdout]
+  DB = Sequel.connect(ENV['DATABASE_URL'], loggers: [Logger.new(*args)])
+  Sequel.extension :migration
+
+  unless Dir.glob('db/migrate/*.rb').empty?
+    begin
+      Sequel::Migrator.check_current(DB, 'db/migrate')
+    rescue Sequel::Migrator::NotCurrentError
+      puts 'Pending migrations detected... running migrations'
+      Sequel::Migrator.run(DB, 'db/migrate')
+      puts 'Database migrations completed'
+    end
+  end
+  DB.freeze unless 'development' == ENV['RACK_ENV']
+  puts 'Database connected'
+else
+  puts 'DATABASE_URL not set; skipping database initialization'
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Example Sidekiq worker. Refer to Sidekiq's documentation[1] for
+# more information.
+#
+# [1]: https://github.com/mperham/sidekiq/wiki/Best-Practices
+#
+class ExampleWorker
+  include Sidekiq::Worker
+
+  def perform
+    logger.info 'Doing some work!'
+  end
+end

data/lib/hoboken/templates/github_action.tt

@@ -0,0 +1,28 @@
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 4 * * *"
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [<%= RUBY_VERSION %>]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake ci

data/lib/hoboken/templates/gitignore

@@ -1,4 +1,12 @@
 .DS_Store
 .bundle
+.byebug_history
+.env
+.env.test
+.rspec_status
 /tmp
+coverage
+db/*.db
+public
+spec/examples.txt
 tags

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

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 unless 'production' == ENV['RACK_ENV']
+  require 'bundler/setup'
   require 'flay'
-  desc "Analyze code for structural similarities"
+
+  desc 'Analyze code for structural similarities'
   task :flay do
     flay = Flay.new
-    files = FileList["app.rb", "app/**/*.rb"]
+    files = FileList['app.rb', 'app/**/*.rb']
     flay.process(*files)
     threshold = 200
 
@@ -13,21 +17,20 @@ unless 'production' == ENV['RACK_ENV']
     end
   end
 
-  require "flog"
+  require 'flog'
   desc 'Analyze code complexity'
   task :flog do
     flog = Flog.new
-    flog.flog FileList["app.rb", "app/**/*.rb"]
+    files = FileList['app.rb', 'app/**/*.rb']
+    flog.flog(*files)
     threshold = 50
 
-    bad_methods = flog.totals.select do |name, score|
+    bad_methods = flog.totals.select do |_name, score|
       score > threshold
     end
 
-    bad_methods.sort do |a, b|
-      a[1] <=> b[1]
-    end.each do |name, score|
-      puts "%8.1f: %s" % [score, name]
+    bad_methods.sort_by { |a| a[1] }.each do |name, score|
+      puts format('%<score>8.1f: %<name>s', score: score, name: name)
     end
 
     unless bad_methods.empty?

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

@@ -1,26 +1,39 @@
-require "sinatra/base"
-require "rack/csrf"
+# frozen_string_literal: true
 
-Dir.glob(File.join("helpers", "**", "*.rb")).each do |helper|
+<% unless options[:api_only] -%>
+require 'erubi'
+require 'rack/csrf'
+<% end -%>
+require 'sinatra/base'
+<% unless options[:api_only] -%>
+require 'sinatra/asset_pipeline'
+<% end -%>
+<% if options[:api_only] -%>
+require 'sinatra/json'
+<% else -%>
+require 'sinatra/flash'
+<% end -%>
+<% unless options[:api_only] -%>
+require 'sinatra/sprockets-helpers'
+require 'uglifier'
+<% end -%>
+
+Dir.glob(File.join('helpers', '**', '*.rb')).each do |helper|
   require_relative helper
 end
 
 module <%= camel_name %>
+  # Sinatra web application
+  #
   class App < Sinatra::Base
-    set :root, File.dirname(__FILE__)
-
-    enable :logging
-
-    use Rack::Session::Cookie, :secret => "TODO: CHANGE ME"
-    use Rack::Csrf, :raise => true
-
-    configure :development do
-      require "sinatra/reloader"
-      register Sinatra::Reloader
+<% if options[:api_only] -%>
+    get '/' do
+      json message: 'Smoke test successful!'
     end
-
-    get "/" do
+<% else -%>
+    get '/' do
       erb :index
     end
+<% end -%>
   end
 end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+unless 'production' == ENV['RACK_ENV']
+  require 'dotenv'
+  Dotenv.load
+end
+
+require_relative '../app'
+
+module <%= camel_name %>
+  # Re-opening application to apply configuration.
+  #
+  class App < Sinatra::Base
+    configure do
+      set :root, File.expand_path('..', __dir__)
+<% unless options[:api_only] -%>
+      set :erb, { escape_html: true }
+<% end -%>
+
+      enable :logging
+<% unless options[:api_only] -%>
+
+      use Rack::Session::Cookie, secret: ENV['SESSION_SECRET']
+      use Rack::Csrf, raise: true, skip_if: proc {
+        'test' == ENV.fetch('RACK_ENV', 'production')
+      }
+
+      register Sinatra::Flash
+
+      set :assets_precompile, %w[
+        javascripts/app.js
+        stylesheets/styles.scss
+        *.png *.jpg *.svg *.eot *.ttf *.woff *.woff2
+      ]
+      set :assets_paths, %w[assets vendor] + Sprockets.paths
+      set :assets_css_compressor, :scss
+      set :assets_js_compressor, Uglifier.new(harmony: true)
+      register Sinatra::AssetPipeline
+<% end -%>
+    end
+
+    configure :development do
+      require 'better_errors'
+      use BetterErrors::Middleware
+      BetterErrors.application_root = File.expand_path('..', __dir__)
+    end
+
+    configure :test do
+      set :raise_errors, true
+      set :dump_errors, false
+      set :show_exceptions, false
+    end
+
+    configure :production do
+      before do
+        redirect request.url.sub('http', 'https') unless request.secure?
+      end
+    end
+  end
+end