hoboken 0.0.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d2df9dfc9ecc21aa34c95ac8f7f3b91bd3149fd
-  data.tar.gz: fc960ac11680b88e5b037fb846bd39896a568227
+SHA256:
+  metadata.gz: d42754fed3189d3de171e54745f49f492b0ff0581aafa53493f0d7f15efbb8b0
+  data.tar.gz: 1cd847b097a929db83a36932d959b2b8d0d94273b408231f06f47c6ae6c6e13d
 SHA512:
-  metadata.gz: e53a838ca0fa1a12c87413deaee61100f4bf100bdda43a6f8fc7450b87b5bbdc81ae79cc7c44b8592d0d27c340674ecfbc34ab338223c78b5cc2962f00c3993a
-  data.tar.gz: 33401a4e2df9ae38bfc7618dddd4512a4eab11c9e460adcc87b0014528b8f8e83013f19b947f172f6758cd7ef1bbad29e971011d91d26a4c4c6499d061a1e319
+  metadata.gz: 501df84e547ff6ace6e5b987f8f8723f349767647b9fdb532a949b6c8fe65b72502b349309948f7a8a92d09c9091c89b5f05745d288d363893c6fe5647930f4a
+  data.tar.gz: 168647168f6a62fdc1410d63994de32706710eff8017a91bedd31ce961ac6d2379d9494671d0d6154d1ff7a113140ec21b477eb809215bbed9b90e4b84366177

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/ruby.yml

@@ -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: ['2.6', '2.7', '3.0']
+
+    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/.rubocop.yml

@@ -0,0 +1,33 @@
+require:
+    - rubocop-rake
+    - rubocop-rspec # for generated projects
+
+AllCops:
+    Exclude:
+        - 'test/tmp/*/sample/Gemfile'
+        - 'test/fixtures/**/*'
+        - 'vendor/bundle/**/*'
+    NewCops: enable
+    TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+      IgnoredMethods:
+        - run_hoboken
+
+Layout/SpaceAroundEqualsInParameterDefault:
+    EnforcedStyle: no_space
+
+Metrics/ClassLength:
+    Max: 150
+
+Metrics/MethodLength:
+    Max: 15
+
+Layout/LineLength:
+    Max: 90
+
+Style/BlockDelimiters:
+    EnforcedStyle: braces_for_chaining
+
+Style/YodaCondition:
+    EnforcedStyle: require_for_equality_operators_only

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hoboken.gemspec

data/IDEAS.md

@@ -0,0 +1,57 @@
+# Project Ideas
+
+## New Directory Structure
+
+General idea is similar to Hexagonal or Ports and Adapters architecture. Web
+and DB concerns depend on the application core, not the other way around.
+
+/web -- depends on --> /db
+/web -- depends on --> /lib
+/db  -- depends on --> /lib
+/lib -- depends on --> nothing from from /web or /db
+
+```
+Gemfile
+Gemfile.lock
+README.md
+Rakefile
+config.ru
+app.rb
+db.rb
+/config
+    db.rb
+    environment.rb
+    puma.rb
+/db
+    /mappers
+        some_mapper.rb
+    /migrate
+        migration_001.rb
+    sequel_mapper.rb
+/lib
+    <project_name>.rb
+    /<project_name>
+        ... files
+/helpers
+    some_helper.rb
+/public
+    /css
+        styles.css
+    /img
+        favicon.png
+        hoboken.png
+        sinatra.png
+    /js
+        app.js
+/views
+    index.erb
+    layout.erb
+/test
+    test_helper.rb
+    /<project_name>
+    /db
+        some_mapper_test.rb
+    /support
+        rack_test_assertions.rb
+    app_test.rb
+```

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2014 Bob Nadler
+Copyright (c) 2013-2021 Bob Nadler
 
 MIT License
 

data/README.md

@@ -1,14 +1,14 @@
 # Hoboken
 
 [![Gem Version](https://badge.fury.io/rb/hoboken.png)](http://badge.fury.io/rb/hoboken)
-[![Dependency Status](https://gemnasium.com/bnadlerjr/hoboken.png)](https://gemnasium.com/bnadlerjr/hoboken)
-[![Build Status](https://travis-ci.org/bnadlerjr/hoboken.png)](https://travis-ci.org/bnadlerjr/hoboken)
+![Build Status](https://github.com/bnadlerjr/hoboken/actions/workflows/ruby.yml/badge.svg)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=bnadlerjr/hoboken)](https://dependabot.com)
 
-Generate Sinatra project templates.
+Sinatra project generator and templates.
 
 ## Installation
 
-    $ gem install hoboken --pre
+    $ gem install hoboken
 
 ## Usage
 
@@ -27,12 +27,14 @@ To see a list of options for the generate command:
       hoboken generate [APP_NAME]
 
     Options:
-      [--ruby-version=RUBY_VERSION]  # Ruby version for Gemfile
-                                     # Default: 2.0.0
-      [--tiny]                       # Generate views inline; do not create /public folder
-      [--type=TYPE]                  # Architecture type (classic or modular)
-                                     # Default: classic
-      [--git]                        # Create a Git repository and make initial commit
+      [--ruby-version=RUBY_VERSION]      # Ruby version for Gemfile
+      [--tiny], [--no-tiny]              # Generate views inline; do not create /public folder
+      [--type=TYPE]                      # Architecture type (classic or modular)
+                                         # Default: classic
+      [--git], [--no-git]                # Create a Git repository and make initial commit
+      [--api-only], [--no-api-only]      # API only, no views, public folder, etc.
+      [--test-framework=TEST_FRAMEWORK]  # Testing framework; can be either test-unit or rspec
+                                         # Default: test-unit
 
     Generate a new Sinatra app
 
@@ -40,13 +42,20 @@ To see a list of options for the generate command:
 
 Additional generators are available for existing projects generated using Hoboken:
 
+    $ hoboken add:github_action    # Github action that runs CI task
     $ hoboken add:heroku           # Heroku deployment support
     $ hoboken add:i18n             # Internationalization support using sinatra-r18n
     $ hoboken add:metrics          # Add metrics (flog, flay, simplecov)
     $ hoboken add:omniauth         # OmniAuth authentication (allows you to select a provider)
+    $ hoboken add:rubocop          # Basic Rubocop configuration and Rake task.
     $ hoboken add:sequel           # Database access via Sequel gem
     $ hoboken add:sprockets        # Rack-based asset packaging system
     $ hoboken add:travis           # Basic Travis-CI YAML config
+    $ hoboken add:twbs             # Twitter Bootstrap (requires Sprockets add-on)
+
+### Documentation
+
+Visit the project [website](http://bobnadler.com/hoboken).
 
 ## Contributing
 
@@ -55,3 +64,5 @@ Additional generators are available for existing projects generated using Hoboke
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+If your contribution requires a change to the documentation, please also make a pull request to the [documentation project](https://github.com/bnadlerjr/hoboken-docs).

data/Rakefile

@@ -1,10 +1,18 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
 
-task :default => "test:all"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: 'test:all'
+
+desc 'Run CI checks'
+task ci: ['test:all', 'rubocop']
 
 namespace :test do
-  types = %w(unit integration)
+  types = %w[unit integration]
 
   types.each do |type|
     Rake::TestTask.new(type.to_sym) do |t|
@@ -13,6 +21,6 @@ namespace :test do
     end
   end
 
-  desc "Run all tests"
-  task :all => types.map { |s| "test:#{s}" }
+  desc 'Run all tests'
+  task all: types.map { |s| "test:#{s}" }
 end

data/bin/hoboken

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require File.join(File.dirname(__FILE__), "../lib/hoboken")
+require File.join(File.dirname(__FILE__), '../lib/hoboken')
 Hoboken::CLI.start(ARGV)

data/hoboken.gemspec

@@ -1,25 +1,62 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hoboken/version'
+# frozen_string_literal: true
+
+require 'English'
+require_relative 'lib/hoboken/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "hoboken"
+  spec.name          = 'hoboken'
   spec.version       = Hoboken::VERSION
-  spec.authors       = ["Bob Nadler"]
-  spec.email         = ["bnadlerjr@gmail.com"]
-  spec.description   = %q{Sinatra project generator.}
-  spec.summary       = %q{Sinatra project generator.}
-  spec.homepage      = "https://github.com/bnadlerjr/hoboken"
-  spec.license       = "MIT"
+  spec.authors       = ['Bob Nadler']
+  spec.email         = ['bnadlerjr@gmail.com']
+  spec.description   = 'Sinatra project generator.'
+  spec.summary       = 'Sinatra project generator.'
+  spec.homepage      = 'https://github.com/bnadlerjr/hoboken'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+  spec.add_development_dependency 'test-unit', '~> 3.4'
+  spec.add_development_dependency 'warning', '~> 1.2'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.3.1"
+  # These dependencies are installed by the generated projects. Including them
+  # here so that:
+  #
+  # a) We can get Dependabot notifications for them
+  # b) We can run tests for generated projects
+  spec.add_development_dependency 'better_errors', '~> 2.9'
+  spec.add_development_dependency 'binding_of_caller', '~> 1.0'
+  spec.add_development_dependency 'bootstrap', '~> 5.0.0.beta3'
+  spec.add_development_dependency 'contest', '~> 0.1'
+  spec.add_development_dependency 'dotenv', '~> 2.7'
+  spec.add_development_dependency 'erubi', '~> 1.10'
+  spec.add_development_dependency 'omniauth-twitter', '~> 1.4'
+  spec.add_development_dependency 'puma', '~> 5.2'
+  spec.add_development_dependency 'rack_csrf', '~> 2.6'
+  spec.add_development_dependency 'racksh', '~> 1.0'
+  spec.add_development_dependency 'rack-test', '~> 1.1'
+  spec.add_development_dependency 'rb-fsevent', '~> 0.10'
+  spec.add_development_dependency 'rerun', '~> 0.13'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
+  spec.add_development_dependency 'sassc', '~> 2.4'
+  spec.add_development_dependency 'sequel', '~> 5.43'
+  spec.add_development_dependency 'sinatra', '~> 2.1'
+  spec.add_development_dependency 'sinatra-contrib', '~> 2.1'
+  spec.add_development_dependency 'sinatra-flash', '~> 0.3'
+  spec.add_development_dependency 'sprockets', '~> 4.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'uglifier', '~> 4.2'
+  spec.add_development_dependency 'yui-compressor', '~> 0.12'
 
-  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency 'thor', '~> 1.1'
 end

data/lib/hoboken.rb

@@ -1,11 +1,19 @@
-require "thor"
-require "thor/util"
-require "fileutils"
-require_relative "hoboken/version"
-require_relative "hoboken/generate"
-require_relative "hoboken/actions"
+# frozen_string_literal: true
 
+require 'date'
+require 'thor'
+require 'thor/util'
+require 'fileutils'
+require_relative 'hoboken/version'
+require_relative 'hoboken/generate'
+require_relative 'hoboken/actions'
+
+# Generate Sinatra project templates.
+#
 module Hoboken
+  # Custom `Thor::Group` that mixes in `Hoboken::Actions` so that they're
+  # available everywhere.
+  #
   class Group < Thor::Group
     include Thor::Actions
     include Hoboken::Actions
@@ -13,31 +21,110 @@ module Hoboken
     def self.source_root
       File.dirname(__FILE__)
     end
+
+    def classic?
+      File.read('app.rb').include?("require 'sinatra'")
+    end
+
+    def rspec?
+      Dir.exist?('spec')
+    end
   end
 
-  require_relative "hoboken/add_ons/metrics"
-  require_relative "hoboken/add_ons/internationalization"
-  require_relative "hoboken/add_ons/heroku"
-  require_relative "hoboken/add_ons/omniauth"
-  require_relative "hoboken/add_ons/sequel"
-  require_relative "hoboken/add_ons/sprockets"
-  require_relative "hoboken/add_ons/travis"
+  require_relative 'hoboken/add_ons/github_action'
+  require_relative 'hoboken/add_ons/heroku'
+  require_relative 'hoboken/add_ons/internationalization'
+  require_relative 'hoboken/add_ons/metrics'
+  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/travis'
+  require_relative 'hoboken/add_ons/twbs'
 
+  # Hoboken's command-line interface.
+  #
   class CLI < Thor
-    desc "version", "Print version and quit"
+    desc 'version', 'Print version and quit'
     def version
       puts "Hoboken v#{Hoboken::VERSION}"
     end
 
-    register(Generate, "generate", "generate [APP_NAME]", "Generate a new Sinatra app")
-    tasks["generate"].options = Hoboken::Generate.class_options
+    register(Generate, 'generate', 'generate [APP_NAME]', 'Generate a new Sinatra app')
+    tasks['generate'].options = Hoboken::Generate.class_options
+
+    register(
+      AddOns::Heroku,
+      'add:heroku',
+      'add:heroku',
+      'Heroku deployment support'
+    )
+
+    register(
+      AddOns::GithubAction,
+      'add:github_action',
+      'add:github_action',
+      'Github action that runs CI task'
+    )
+
+    register(
+      AddOns::Internationalization,
+      'add:i18n',
+      'add:i18n',
+      'Internationalization support using sinatra-r18n'
+    )
 
-    register(AddOns::Metrics, "add:metrics", "add:metrics", "Add metrics (flog, flay, simplecov)")
-    register(AddOns::Internationalization, "add:i18n", "add:i18n", "Internationalization support using sinatra-r18n")
-    register(AddOns::Heroku, "add:heroku", "add:heroku", "Heroku deployment support")
-    register(AddOns::OmniAuth, "add:omniauth", "add:omniauth", "OmniAuth authentication (allows you to select a provider)")
-    register(AddOns::Sprockets, "add:sprockets", "add:sprockets", "Rack-based asset packaging system")
-    register(AddOns::Sequel, "add:sequel", "add:sequel", "Database access via Sequel gem")
-    register(AddOns::Travis, "add:travis", "add:travis", "Basic Travis-CI YAML config")
+    register(
+      AddOns::Metrics,
+      'add:metrics',
+      'add:metrics',
+      'Add metrics (flog, flay, simplecov)'
+    )
+
+    register(
+      AddOns::OmniAuth,
+      'add:omniauth',
+      'add:omniauth',
+      'OmniAuth authentication (allows you to select a provider)'
+    )
+
+    register(
+      AddOns::Rubocop,
+      'add:rubocop',
+      'add:rubocop',
+      'Basic Rubocop configuration and Rake task.'
+    )
+
+    register(
+      AddOns::Sequel,
+      'add:sequel',
+      'add:sequel',
+      'Database access via Sequel gem'
+    )
+
+    register(
+      AddOns::Sprockets,
+      'add:sprockets',
+      'add:sprockets',
+      'Rack-based asset packaging system'
+    )
+
+    register(
+      AddOns::Travis,
+      'add:travis',
+      'add:travis',
+      'Basic Travis-CI YAML config'
+    )
+
+    register(
+      AddOns::TwitterBootstrap,
+      'add:twbs',
+      'add:twbs',
+      'Twitter Bootstrap (requires Sprockets add-on)'
+    )
+
+    def self.exit_on_failure?
+      true
+    end
   end
 end