hoboken 0.9.0 → 0.10.0

data/www/source/documentation.html.erb

@@ -0,0 +1,274 @@
+<section>
+  <h2 id="basic-features">Basic Features</h2>
+  <p>All projects generated with Hoboken have the following common features:</p>
+  <ul class="features">
+    <li>sets up <a href="https://github.com/kalasjocke/sinatra-asset-pipeline">sinatra-asset-pipeline</a> (non-API projects only)</li>
+    <li>a <code>Rakefile</code> with tasks for running tests or specs</li>
+    <li>scripts for common tasks: installing dependencies, starting the development server, and starting a console (with <a href="https://github.com/sickill/racksh">racksh</a> support)</li>
+    <li>uses <a href="https://github.com/puma/puma">Puma</a> as the default web server</li>
+    <li><a href="https://github.com/jeremyevans/erubi">erubi</a> templating; HTML escaping is on by default</li>
+    <li>uses <a href="https://test-unit.github.io/">test-unit</a> by default (<a href="https://rspec.info/">RSpec</a> can also be used, see the <code>--test-framework</code> option under the <a href="#generate">generate command</a>)</li>
+    <li><a href="http://rubygems.org/gems/rack_csrf">Rack::Csrf</a> is turned on by default</li>
+    <li>environment variable support via the <a href="http://rubygems.org/gems/dotenv">dotenv</a> gem</li>
+    <li>Procfile for <a href="https://github.com/ddollar/foreman">foreman</a> support; if foreman is not installed uses rackup instead</li>
+    <li>code reloading via the <a href="https://github.com/alexch/rerun">rerun gem</a> is enabled for the development environment</li>
+    <li><a href="https://github.com/deivid-rodriguez/pry-byebug">pry-byebug</a> for debugging</li>
+    <li>custom Rack::Test <a href="https://github.com/bnadlerjr/hoboken/blob/main/lib/hoboken/templates/support/rack_helpers.rb.tt">helpers</a> and <a href="https://github.com/bnadlerjr/hoboken/blob/main/lib/hoboken/templates/support/rack_test_assertions.rb.tt">assertions</a> (or <a href="https://github.com/bnadlerjr/hoboken/blob/main/lib/hoboken/templates/spec/rack_matchers.rb.tt">matchers</a> for RSpec)</li>
+  </ul>
+
+  <h2 id="project-structure">Project Structure</h2>
+  <p>Projects are generated with the following structure:</p>
+  <table>
+    <tr>
+      <td>Gemfile</td>
+      <th>Your app's dependencies</th>
+    </tr>
+    <tr>
+      <td>Procfile</td>
+      <th>Specifies the commands that are executed by the app on startup (foreman must be installed separately)</th>
+    </tr>
+    <tr>
+      <td>README.md</td>
+      <th>A sample README</th>
+    </tr>
+    <tr>
+      <td>Rakefile</td>
+      <th>Basic app tasks</th>
+    </tr>
+    <tr>
+      <td>app.rb</td>
+      <th>The main application file</th>
+    </tr>
+    <tr>
+      <td>config.ru</td>
+      <th>Rackup file</th>
+    </tr>
+    <tr>
+      <td>/bin</td>
+      <th>Helper scripts for installing dependencies, starting the development server, etc.</th>
+    </tr>
+    <tr>
+      <td>/config</td>
+      <th>Application configuration (Puma, etc.)</th>
+    </tr>
+    <tr>
+      <td>/public</td>
+      <th>Static assets (i.e. css, js, images)</th>
+    </tr>
+    <tr>
+      <td>/tasks</td>
+      <th>Various Rake task definitions</th>
+    </tr>
+    <tr>
+      <td>/test or /spec</td>
+      <th>Basic unit test and test helper support</th>
+    </tr>
+    <tr>
+      <td>/views</td>
+      <th>Your app's views (not present if --tiny option was used)</th>
+    </tr>
+  </table>
+  <p>The <code>app.rb</code> file contains the main Sinatra application. If the <code>--modular</code> option is used, the application will inherit from Sinatra::Base. Refer to the Sinatra documentation on <a href="http://www.sinatrarb.com/intro.html#Modular%20vs.%20Classic%20Style">classic vs. modular</a> applications for more information.</p>
+
+  <h2 id="general-command-reference">General Command Reference</h2>
+
+  <h3 id="generate">generate</h3>
+  <p>Generate a new Sinatra app</p>
+  <p><pre class="command">$ hoboken generate [APP_NAME]</pre></p>
+  <h4>Options</h4>
+  <dl>
+    <dt><pre>[--ruby-version=RUBY_VERSION]</pre></dt>
+    <dd>Specify a Ruby version for the Gemfile. By default it will use the currently installed version.</dd>
+    <dt><pre>[--tiny], [--no-tiny]</pre></dt>
+    <dd>Generate views inline; do not create /public folder.</dd>
+    <dt><pre>[--type=TYPE]</pre></dt>
+    <dd>Architecture type (classic or modular). Default is classic.</dd>
+    <dt><pre>[--git], [--no-git]</pre></dt>
+    <dd>Create a Git repository and make initial commit.</dd>
+    <dt><pre>[--api-only], [--no-api-only]</pre></dt>
+    <dd>API only, no views, public folder, etc.</dd>
+    <dt><pre>[--test-framework]</pre></dt>
+    <dd>Testing framework; can be either test-unit or rspec. Default is test-unit.</dd>
+  </dl>
+
+  <h4>Rake Tasks</h4>
+  <p>By default all newly generated projects will have the following Rake tasks available.</p>
+  <dl>
+    <dt><pre class="command">$ rake ci</pre></dt>
+    <dd>Runs tests (or specs) and any configured linting add-ons</dd>
+    <dt><pre class="command">$ rake test:all</pre></dt>
+    <dd>Run all tests (test-unit only)</dd>
+    <dt><pre class="command">$ rake test:integration</pre></dt>
+    <dd>Run tests for integration (test-unit only)</dd>
+    <dt><pre class="command">$ rake test:unit</pre></dt>
+    <dd>Run tests for unit (test-unit only)</dd>
+    <dt><pre class="command">$ rake spec</pre></dt>
+    <dd>Run all specs (RSpec only)</dd>
+  </dl>
+
+  <hr />
+
+  <h3 id="help">help</h3>
+  <p>Describe available commands. If COMMAND is given, describe the specific COMMAND.</p>
+  <p><pre class="command">$ hoboken help [COMMAND]</pre></p>
+
+  <hr />
+
+  <h3 id="version">version</h3>
+  <p>Print version and quit.</p>
+  <p><pre class="command">$ hoboken version</pre></p>
+
+  <hr />
+
+  <h2 id="add-on-command-reference">Add On Command Reference</h2>
+
+  <h3 id="airbrake">Airbrake</h3>
+  <p>Support for <a href="https://github.com/airbrake/airbrake">Airbrake</a> error reporting.</p>
+  <p><pre class="command">$ hoboken add:airbrake</pre></p>
+  <p>Sets up Airbrake middleware.</p>
+
+  <hr />
+
+  <h3 id="github_action">GitHub Action</h3>
+  <p>Github action that runs CI task</p>
+  <p><pre class="command">$ hoboken add:github_action</pre></p>
+  <p>Adds a <a href="https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby">GitHub Action</a> workflow that runs the <code>ci</code> Rake task.</p>
+
+  <hr />
+
+  <h3 id="heroku">Heroku</h3>
+  <p>Heroku deployment support.</p>
+  <p><pre class="command">$ hoboken add:heroku</pre></p>
+  <p>Createa a <code>.slugignore</code> file and configures <code>$stdout</code> for Heroku logging. All Hoboken projects contain a <code>Procfile</code> by default, which Heroku will use to start the application.</p>
+
+  <hr />
+
+  <h3 id="internationalization">Internationalization</h3>
+  <p>Internationalization support using sinatra-r18n.</p>
+  <p><pre class="command">$ hoboken add:i18n</pre></p>
+  <p>Adds the <a href="http://rubygems.org/gems/sinatra-r18n">sinatra-r18n gem</a> to the project's dependencies and creates an <code>i18n</code> folder with a sample translation file.</p>
+
+  <hr />
+
+  <h3 id="metrics">Metrics</h3>
+  <p>Adds metrics utilities to project (flog, flay, simplecov).</p>
+  <p><pre class="command">$ hoboken add:metrics</pre></p>
+  <p>Adds <a href="http://rubygems.org/gems/flog">flog</a>, <a href="http://rubygems.org/gems/flay">flay</a>, and <a href="http://rubygems.org/gems/simplecov">simplecov</a> to the project dependencies. Adds two rake tasks for running flog and flay. Modifies the test (or spec) rake tasks to run with simplecov. The coverage report is generated in the <code>tmp/coverage</code> folder.</p>
+
+  <hr />
+
+  <h3 id="omniauth">Omniauth</h3>
+  <p>Authentication capability via the <a href="http://rubygems.org/gems/omniauth">Omniauth</a> gem.</p>
+  <p><pre class="command">$ hoboken add:omniauth</pre></p>
+  <p>Running this command will prompt you to select an Omniauth provider and version. It will stub out 3 new handlers for Omniauth in <code>app.rb</code>. In addition, it will create unit tests (or specs) for the stubbed out handlers.</p>
+
+  <hr />
+
+  <h3 id="rubocop">Rubocop</h3>
+  <p>Adds <a href="https://rubocop.org/">Rubocop</a> support.</p>
+  <p><pre class="command">$ hoboken add:rubocop</pre></p>
+  <p><Rubocop support with a basic <code>.rubocop.yml</code> and Rake task. The default <code>ci</code> task is also modified to run Rubocop after tests/specs.</p>
+
+  <hr />
+
+  <h3 id="sequel">Sequel</h3>
+  <p>Provides database support via the <a href="http://rubygems.org/gems/sequel">Sequel</a> gem.</p>
+  <p><pre class="command">$ hoboken add:sequel</pre></p>
+  <p>Adds the Sequel gem as a dependency. Also adds the sqlite3 gem for dev and test environments. You will need to specify your own database provider for production. Access to the database is handled via <code>DATABASE_URL</code> which either needs to be exported as an environment variable or added to the project's <code>.env</code> file. A <code>config/db.rb</code> file is added to set up the database.</p>
+  <p>A <code>db/migrate</code> folder is created for <a href="http://sequel.jeremyevans.net/rdoc/files/doc/migration_rdoc.html">migrations</a>. Two rake tasks for migrations are also created:</p>
+  <dl>
+    <dt><pre class="command">$ rake db:migrate</pre></dt>
+    <dd>Migrate the database to the latest version.</dd>
+    <dt><pre class="command">$ rake db:reset</pre></dt>
+    <dd>Perform migration reset (full erase and migration up).</dd>
+  </dl>
+  <p>The project's <code>test_helper.rb</code> is adjusted to include a helper class for unit tests that touch the database. When a unit test class inherits from this, it will set up a test database and apply any migrations. Each test is run in the context of a transaction that will be rolled back after each test is run.</p>
+  <p>If RSpec is used, the project's <code>spec_helper.rb</code> is adjusted instead. Any spec tagged with <code>database: true</code> will be ran inside a database transaction that will be rolled back when the spec completes. Specs that use the <code>rack: true</code> tag will also have this database rollback functionality.</p>
+
+  <hr />
+
+  <h3 id="sidekiq">Sidekiq</h3>
+  <p>Adds <a href="https://github.com/mperham/sidekiq">Sidekiq</a> support.</p>
+  <p><pre class="command">$ hoboken add:sidekiq</pre></p>
+  <p>Sets up Sidekiq via a <code>config/sidekiq.rb</code> file. Adjusts <code>config.ru</code> to mount the Sidekiq UI. In production, the Sidekiq UI is protected via Basic Auth. Also adds a Sidekiq entry to the <code>Procfile</code>.</p>
+
+  <hr />
+
+  <h3 id="sinatra-activerecord">Sinatra ActiveRecord</h3>
+  <p>Provides database support via the <a href="https://github.com/sinatra-activerecord/sinatra-activerecord">Sinatra ActiveRecord</a> gem.</p>
+  <p><pre class="command">$ hoboken add:active_record</pre></p>
+    <p>Adds the <code>sinatra-activerecord</code> gem as a dependency. Also adds the sqlite3 gem for dev and test environments. You will need to specify your own database provider for production. Access to the database is handled via <code>DATABASE_URL</code> which either needs to be exported as an environment variable or added to the project's <code>.env</code> file.</p>
+  <p>A <code>db/migrate</code> folder is created for migrations. Rake tasks are also provided. Refer to the <a href="https://github.com/sinatra-activerecord/sinatra-activerecord"><code>sinatra-activerecord</code> gem</a> for more information.</p>
+  <p>The project's <code>test_helper.rb</code> is adjusted to include a helper method for unit tests that touch the database. When a unit test class inherits from this, it will set up a test database and apply any migrations. Each test is run in the context of a transaction that will be rolled back after each test is run.</p>
+  <p>If RSpec is used, the project's <code>spec_helper.rb</code> is adjusted instead. An <code>around</code> block is added that handles the roll back for each spec example.</p>
+
+  <hr />
+
+  <h3 id="travis-ci">Travis CI</h3>
+  <p>Basic Travis-CI YAML config.</p>
+  <p><pre class="command">$ hoboken add:travis</pre></p>
+  <p>Sets up a minimal <code>.travis.yml</code> file.</p>
+
+  <hr />
+
+  <h3 id="turnip">Turnip</h3>
+  <p>Support for writing <a href="https://github.com/jnicklas/turnip">Turnip</a> acceptance specs.</p>
+  <p><pre class="command">$ hoboken add:turnip</pre></p>
+  <p>Sets up Turnip specs. Adds a Rake task to run them; also adds the task to the <code>CI</code> task.</p>
+  <p>This add-on requires the use of RSpec.</p>
+
+  <hr />
+
+  <h3 id="twitter-bootstrap">Twitter Bootstrap</h3>
+  <p>Twitter Bootstrap via the <a href="https://github.com/twbs/bootstrap-rubygem">bootstrap gem</a>.</p>
+  <p><pre class="command">$ hoboken add:twbs</pre></p>
+  <p>Twitter Bootstrap support via the <code>bootstrap</code> gem. Adjusts <code>styles.scss</code> and <code>app.js</code> to include bootstrap directives.</p>
+
+  <hr />
+
+  <h3 id="vcr">VCR</h3>
+  <p>Support for the <a href="https://github.com/vcr/vcr">VCR gem</a>.</p>
+  <p><pre class="command">$ hoboken add:vcr</pre></p>
+  <p>Sets up VCR configured with <a href="https://github.com/bblimke/webmock">webmock</a>.</p>
+</section>
+
+<% content_for :docs_menu do %>
+<aside>
+  <h4>On This Page</h4>
+  <ul>
+    <li>
+      <%= link_to 'Basic Features', '/documentation.html#basic-features' %>
+    </li>
+    <li>
+      <%= link_to 'Project Structure', '/documentation.html#project-structure' %>
+    </li>
+    <li>
+      <%= link_to 'General Commands', '/documentation.html#general-command-reference' %>
+      <ul>
+        <li><%= link_to 'generate', '#generate' %></li>
+        <li><%= link_to 'help', '#help' %></li>
+        <li><%= link_to 'version', '#version' %></li>
+      </ul>
+    </li>
+    <li>
+      <%= link_to 'Add On Commands', '/documentation.html#add-on-command-reference' %>
+      <ul>
+        <li><%= link_to 'airbrake', '#airbrake' %></li>
+        <li><%= link_to 'github action', '#github_action' %></li>
+        <li><%= link_to 'heroku', '#heroku' %></li>
+        <li><%= link_to 'internationalization', '#internationalization' %></li>
+        <li><%= link_to 'metrics', '#metrics' %></li>
+        <li><%= link_to 'omniauth', '#omniauth' %></li>
+        <li><%= link_to 'rubocop', '#rubocop' %></li>
+        <li><%= link_to 'sequel', '#sequel' %></li>
+        <li><%= link_to 'sidekiq', '#sidekiq' %></li>
+        <li><%= link_to 'sinatra activerecord', '#sinatra-activerecord' %></li>
+        <li><%= link_to 'travis ci', '#travis-ci' %></li>
+        <li><%= link_to 'turnip', '#turnip' %></li>
+        <li><%= link_to 'twitter bootstrap', '#twitter-bootstrap' %></li>
+        <li><%= link_to 'vcr', '#vcr' %></li>
+      </ul>
+    </li>
+  </ul>
+</aside>
+<% end %>

data/www/source/index.html.erb

@@ -0,0 +1,44 @@
+<section>
+  <p>Hoboken is a Ruby gem that generates Sinatra projects. It keeps the folder structure simple and gets out of your way.</p>
+
+  <h2 id="getting-started">Getting Started</h2>
+
+  <h3>Installation</h3>
+  <p><pre class="command">$ gem install hoboken</pre></p>
+
+  <h3>Generate a new Project</h3>
+  <p><pre class="command">
+$ hoboken generate my_project
+      create  my_project
+      create  my_project/app.rb
+      create  my_project/Gemfile
+      ...
+
+Successfully created my_project. Don't forget to `bundle install`
+  </pre></p>
+
+  <h3>Install Dependencies</h3>
+  <p><pre class="command">
+$ ./bin/setup
+  </pre></p>
+
+  <h3>Start the Server</h3>
+  <p><pre class="command">
+$ ./bin/server
+Foreman detected... starting server with Procfile
+22:16:46 web.1  | started with pid 18585
+22:16:47 web.1  | Puma starting in single mode...
+22:16:47 web.1  | * Puma version: 5.2.2 (ruby 2.5.3-p105) ("Fettisdagsbulle")
+22:16:47 web.1  | *  Min threads: 5
+22:16:47 web.1  | *  Max threads: 5
+22:16:47 web.1  | *  Environment: development
+22:16:47 web.1  | *          PID: 18585
+22:16:47 web.1  | * Listening on http://0.0.0.0:9292
+22:16:47 web.1  | Use Ctrl-C to stop
+  </pre></p>
+  <p>Your app is now running on localhost on port 9292. Check it out in a browser!</p>
+  <img src="./images/hoboken-running.png" width="640px" />
+
+  <h2>Next Steps</h2>
+  <p>Read the <%= link_to 'documentation', '/documentation.html' %> to learn more about generation options, project structure, and add ons.</p>
+</section>

data/www/source/javascripts/all.js

@@ -0,0 +1 @@
+//= require_tree .

data/www/source/layouts/layout.erb

@@ -0,0 +1,38 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
+    <title>Hoboken</title>
+    <%= stylesheet_link_tag 'normalize', 'all' %>
+    <%= javascript_include_tag  'all' %>
+  </head>
+
+  <body>
+    <div class="wrapper">
+      <div class="content">
+        <h1>Hoboken</h1>
+        <img src="images/hoboken.png" />
+        <%= yield %>
+      </div>
+      <div class="sidebar">
+        <aside>
+          <h4>What would you like to do?</h4>
+          <ul>
+            <li><%= link_to 'Get started', '/index.html' %></li>
+            <li><%= link_to 'Report a bug', 'https://github.com/bnadlerjr/hoboken/issues' %></li>
+            <li><%= link_to 'Read documentation', '/documentation.html' %></li>
+            <li><%= link_to 'View source code', 'https://github.com/bnadlerjr/hoboken' %></li>
+          </ul>
+        </aside>
+        <%= yield_content :docs_menu %>
+      </div>
+      <footer>
+        <hr />
+        <small>
+        <a href="https://github.com/bnadlerjr/hoboken">Hoboken<a/>, a project generator for the Ruby <a href="http://www.sinatrarb.com/">Sinatra</a> library, written by <a href="http://bobnadler.com">Bob Nadler</a>.
+        </small>
+      </footer>
+    </div>
+  </body>
+</html>

data/www/source/stylesheets/all.css.scss

@@ -0,0 +1,116 @@
+@charset "utf-8";
+
+$wrapper-width: 960px;
+$content-width: 640px;
+
+$base-color: #262626;
+$accent-color: #324d0e;
+
+$body-fonts: 'lucida console', monaco, 'andale mono', 'bitstream vera sans mono', monospace;
+$headline-fonts: Georgia, 'bitstream vera serif', serif;
+
+@mixin border-radius($radius) {
+  -webkit-border-radius: $radius;
+  -moz-border-radius: $radius;
+  border-radius: $radius;
+}
+
+body {
+  font-family: $body-fonts;
+  font-size: 18px;
+  color: $base-color;
+  margin: 2em;
+}
+
+h1, h2, h3, h4 {
+  font-family: $headline-fonts;
+}
+
+h1 {
+  text-indent: 100%;
+  white-space: nowrap;
+  overflow: hidden;
+  line-height: 0;
+  margin: 0;
+}
+
+h3 {
+    color: $accent-color;
+}
+
+dd {
+    padding-bottom: 1em;
+}
+
+pre.command {
+    background-color: lighten($base-color, 80%);
+    padding: 1em;
+    display: block;
+}
+
+ul {
+  &.features {
+    list-style: square;
+    padding-left: 1.5em;
+  }
+
+  list-style: none;
+  padding: 0;
+  li {
+    padding-top: 0.25em;
+    ul {
+        padding-left: 1.5em;
+    }
+  }
+}
+
+a {
+  font-weight: bold;
+  color: $accent-color;
+}
+
+table {
+    td {
+        padding-right: 1.5em;
+    }
+    th {
+        text-align: left;
+        padding: 0.5em;
+    }
+}
+
+footer {
+  clear: both;
+  margin-top: 2em;
+  text-align: center;
+}
+
+.wrapper {
+    width: $wrapper-width;
+    margin: 0 auto;
+}
+
+.content {
+    float: right;
+    width: $content-width;
+}
+
+.sidebar {
+    float: left;
+}
+
+aside {
+  @include border-radius(10px);
+  background-color: lighten($accent-color, 70%);
+  margin-bottom: 2em;
+  padding: 0.25em 1em;
+}
+
+code {
+    background-color: lighten($base-color, 80%);
+    font-weight: bold;
+}
+
+strong {
+    color: $accent-color;
+}