hoboken 0.9.0 → 0.10.0

data/lib/hoboken/generate.rb

@@ -9,7 +9,7 @@ module Hoboken
   class Generate < Thor::Group
     include Thor::Actions
 
-    NULL = RbConfig::CONFIG['host_os'] =~ /mingw|mswin/ ? 'NUL' : '/dev/null'
+    NULL = RbConfig::CONFIG['host_os'].match?(/mingw|mswin/) ? 'NUL' : '/dev/null'
 
     argument :name
 
@@ -64,7 +64,7 @@ module Hoboken
       empty_directory("#{snake_name}/bin")
       %w[console server setup].each do |f|
         target = "#{snake_name}/bin/#{f}"
-        copy_file("templates/#{f}.sh", target)
+        copy_file("templates/#{f}", target)
         chmod(target, 0o755)
       end
     end
@@ -72,6 +72,7 @@ module Hoboken
     def config_folder
       empty_directory("#{snake_name}/config")
       apply_template('puma.rb.tt', 'config/puma.rb')
+      apply_template('classic_environment.rb.tt', 'config/environment.rb')
     end
 
     def view_folder
@@ -82,19 +83,20 @@ module Hoboken
       apply_template('views/index.erb.tt', 'views/index.erb')
     end
 
-    def public_folder
-      return if options[:tiny] || options[:api_only]
+    def asset_pipeline
+      return if options[:api_only]
 
       inside snake_name do
+        empty_directory('assets')
         empty_directory('public')
-        %w[css img js].each { |f| empty_directory("public/#{f}") }
+        %w[stylesheets images javascripts].each { |f| empty_directory("assets/#{f}") }
       end
 
-      apply_template('styles.css.tt', 'public/css/styles.css')
-      create_file("#{snake_name}/public/js/app.js", '')
+      apply_template('styles.css.tt', 'assets/stylesheets/styles.scss')
+      create_file("#{snake_name}/assets/javascripts/app.js", '')
 
       %w[favicon hoboken sinatra].each do |f|
-        copy_file("templates/#{f}.png", "#{snake_name}/public/img/#{f}.png")
+        copy_file("templates/#{f}.png", "#{snake_name}/assets/images/#{f}.png")
       end
     end
 
@@ -128,7 +130,7 @@ module Hoboken
     def env_file
       inside snake_name do
         create_file('.env') do
-          "RACK_ENV=development\nPORT=9292"
+          "RACK_ENV=development\nPORT=9292\nSESSION_SECRET=secret"
         end
       end
     end
@@ -139,7 +141,9 @@ module Hoboken
 
       empty_directory("#{snake_name}/helpers")
       remove_file("#{snake_name}/app.rb")
+      remove_file("#{snake_name}/config/environment.rb")
       apply_template('modular.rb.tt', 'app.rb')
+      apply_template('modular_environment.rb.tt', 'config/environment.rb')
 
       files = [].tap do |f|
         f << 'config.ru'
@@ -178,7 +182,7 @@ module Hoboken
         end
       else
         say "\nYou asked that a Git repository be created for the " \
-          'project, but no Git executable could be found.'
+            'project, but no Git executable could be found.'
       end
     end
 
@@ -220,6 +224,10 @@ module Hoboken
     def apply_template(src, dest)
       template("templates/#{src}", "#{snake_name}/#{dest}")
     end
+
+    def ruby_three_one_or_greater?
+      Gem::Version.new(RUBY_VERSION).release >= Gem::Version.new('3.1')
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end

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

@@ -7,12 +7,25 @@ ruby '<%= options[:ruby_version] %>'
 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 'better_errors', '~> 2.9'
@@ -20,9 +33,6 @@ group :development do
   gem 'dotenv', '~> 2.7'
   gem 'pry-byebug', '~> 3.9'
   gem 'racksh', '~> 1.0'
-  gem 'rake', '~> 13.0'
-  gem 'rerun', '~> 0.13'
-  gem 'rb-fsevent', '~> 0.10'
 end
 
 group :test do

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

@@ -4,9 +4,12 @@
 
 TODO: Project description.
 
-* TODO: a list of
-* high level features
-* ...
+### Features
+#### Feature A
+TODO: Describe feature.
+
+#### Feature B
+TODO: Describe feature.
 
 ### Links
 * [Production](TODO)
@@ -33,17 +36,18 @@ TODO: Project description.
 
 The following pre-requisites are needed to build this project:
 * Ruby <%= RUBY_VERSION %>
-* [Bundler](https://bundler.io/)
 
 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.
 
 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.
 
 ## Configuration
-Environment variables are used for project configuration. For local development, the `.env` file is used. Below is a sample `.env` file that contains the minimum required configuration.
+Environment variables are used for project configuration. For local development, the `.env` file is used. A sample file is shown below.
 
 ```
+PORT=9292
 RACK_ENV=development
+SESSION_SECRET=secret
 ```
 
 Here is a table containing all available environment variable configuration options and their descriptions.
@@ -76,6 +80,12 @@ Here is a table containing all available environment variable configuration opti
             <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>
@@ -90,10 +100,12 @@ This project has the following default behavior:
 
 * 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; if foreman is not installed uses rackup instead
+* 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
 

data/lib/hoboken/templates/Rakefile.tt

@@ -1,4 +1,15 @@
 # frozen_string_literal: true
+<% unless options[:api_only] -%>
+
+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 }

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,36 +1,22 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
-
 <% unless options[:api_only] -%>
 require 'erubi'
-<% end -%>
 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 -%>
-
-Dir.glob(File.join('helpers', '**', '*.rb')).each do |helper|
-  require_relative helper
-end
-
-configure do
-  use Rack::Session::Cookie, secret: 'TODO: CHANGE ME'
-  use Rack::Csrf, raise: true
 <% unless options[:api_only] -%>
-
-  set :erb, { escape_html: true }
+require 'sinatra/sprockets-helpers'
+require 'uglifier'
 <% end -%>
-end
-
-configure :development do
-  require 'better_errors'
-  use BetterErrors::Middleware
-  BetterErrors.application_root = __dir__
-end
 
 <% if options[:api_only] -%>
 get '/' do

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,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'dotenv'
-Dotenv.load
-require File.expand_path('app', __dir__)
+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/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/metrics.rake.tt

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 unless 'production' == ENV['RACK_ENV']
+  require 'bundler/setup'
   require 'flay'
+
   desc 'Analyze code for structural similarities'
   task :flay do
     flay = Flay.new
@@ -27,7 +29,7 @@ unless 'production' == ENV['RACK_ENV']
       score > threshold
     end
 
-    bad_methods.sort { |a, b| a[1] <=> b[1] }.each do |name, score|
+    bad_methods.sort_by { |a| a[1] }.each do |name, score|
       puts format('%<score>8.1f: %<name>s', score: score, name: name)
     end
 

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

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
-
 <% unless options[:api_only] -%>
 require 'erubi'
-<% end -%>
 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
@@ -21,28 +26,6 @@ module <%= camel_name %>
   # Sinatra web application
   #
   class App < Sinatra::Base
-    configure do
-      set :root, File.dirname(__FILE__)
-<% unless options[:api_only] -%>
-      set :erb, { escape_html: true }
-<% end -%>
-
-      enable :logging
-
-      use Rack::Session::Cookie, secret: 'TODO: CHANGE ME'
-      use Rack::Csrf, raise: true
-<% unless options[:api_only] -%>
-
-      register Sinatra::Flash
-<% end -%>
-    end
-
-    configure :development do
-      require 'better_errors'
-      use BetterErrors::Middleware
-      BetterErrors.application_root = __dir__
-    end
-
 <% if options[:api_only] -%>
     get '/' do
       json message: 'Smoke test successful!'

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

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

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
+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

@@ -1,28 +1,48 @@
 require:
+    - rubocop-performance
     - rubocop-rake
 <% if rspec? -%>
     - rubocop-rspec
 <% end -%>
+<% if sequel? -%>
+    - rubocop-sequel
+<% end -%>
 
 AllCops:
     Exclude:
-        - 'bin/*'
         - '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? -%>
 
-Layout/LineLength:
-    Max: 90
+RSpec/DescribeClass:
+    Enabled: false
+
+RSpec/MultipleDescribes:
+    Enabled: false
+<% end -%>
 
 Style/BlockDelimiters:
     EnforcedStyle: braces_for_chaining

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/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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable RSpec/DescribeClass
 RSpec.describe 'GET /', rack: true do
   before { get '/' }
 
@@ -12,4 +11,3 @@ RSpec.describe 'GET /', rack: true do
 <% end -%>
   it { expect(last_response.body).to include('Smoke test successful!') }
 end
-# rubocop:enable RSpec/DescribeClass