hoboken 0.0.1 → 0.9.0

data/lib/hoboken/add_ons/sequel.rb

@@ -1,79 +1,108 @@
+# frozen_string_literal: true
+
 module Hoboken
   module AddOns
+    # Database access via Sequel gem.
+    #
     class Sequel < ::Hoboken::Group
       def add_gems
-        gem "sequel", version: "4.6.0"
-        gem "sqlite3", version: "1.3.8", group: [:development, :test]
+        gem 'sequel', version: '5.43'
+        gem 'sqlite3', version: '1.4', group: %i[development test]
       end
 
       def setup_directories
-        empty_directory("db/migrate")
-        empty_directory("tasks")
+        empty_directory('db/migrate')
+        empty_directory('tasks')
+        empty_directory('tmp')
       end
 
       def copy_rake_task
-        copy_file("hoboken/templates/sequel.rake", "tasks/sequel.rake")
+        copy_file('hoboken/templates/sequel.rake', 'tasks/sequel.rake')
+      end
+
+      def setup_db_config
+        template('hoboken/templates/db.rb.tt', 'config/db.rb')
       end
 
-      def setup_database_connection_in_rackup_file
-        insert_into_file("config.ru", after: /require "bundler\/setup"/) do
-          "\nrequire \"logger\"\nrequire \"sequel\""
+      def require_db_config
+        location = classic? ? 'configure do' : 'module'
+        insert_into_file('app.rb', before: location) do
+          "require_relative 'config/db'\n\n"
         end
+      end
 
-        app_name = File.open("config.ru").grep(/run.+/).first.chomp.gsub("run ", "")
+      def setup_puma_config
+        insert_into_file('config/puma.rb', after: 'before_fork do') do
+          "\n    DB.disconnect if defined?(DB)"
+        end
+      end
 
-        gsub_file("config.ru", /run #{app_name}/) do
-<<CODE
+      # rubocop:disable Metrics/MethodLength
+      def add_database_test_helper_class
+        return if rspec?
 
-db = Sequel.connect(ENV["DATABASE_URL"], loggers: [Logger.new($stdout)])
-Sequel.extension :migration
-Sequel::Migrator.check_current(db, "db/migrate") if Dir.glob("db/migrate/*.rb").size > 0
+        insert_into_file('test/test_helper.rb', before: /ENV\['RACK_ENV'\] = 'test'/) do
+          "ENV['DATABASE_URL'] = 'sqlite://db/test.db'\n"
+        end
 
-app = #{app_name}
-app.set :database, db
-run app
-CODE
+        insert_into_file('test/test_helper.rb', after: %r{require 'test/unit'}) do
+          "\nrequire 'sequel'"
         end
-      end
 
-      def add_database_test_helper_class
-        insert_into_file("test/test_helper.rb", after: /require "test\/unit"/) do
-          "\nrequire \"sequel\""
+        append_file('test/test_helper.rb') do
+          <<~CODE
+
+            module Test
+              module Database
+                class TestCase < Test::Unit::TestCase
+                  def run(*args, &block)
+                    result = nil
+                    DB.transaction(rollback: :always) { result = super }
+                    result
+                  end
+                end
+              end
+            end
+          CODE
         end
+      end
+      # rubocop:enable Metrics/MethodLength
 
-        append_file("test/test_helper.rb") do
-<<CODE
+      # rubocop:disable Metrics/MethodLength
+      def add_database_spec_helper
+        return unless rspec?
 
-module Test::Database
-  class TestCase < Test::Unit::TestCase
-    def run(*args, &block)
-      result = nil
-      database.transaction(rollback: :always) { result = super }
-      result
-    end
+        insert_into_file('spec/spec_helper.rb', before: /ENV\['RACK_ENV'\] = 'test'/) do
+          "ENV['DATABASE_URL'] = 'sqlite://db/test.db'\n"
+        end
 
-    private
+        snippet_rack = <<~CODE
+          config.around(:example, rack: true) do |example|
+            DB.transaction(rollback: :always) { example.run }
+          end
+        CODE
 
-    def database
-      @database ||= Sequel.sqlite.tap do |db|
-        Sequel.extension :migration
-        Sequel::Migrator.run(db, 'db/migrate') if Dir.glob("db/migrate/*.rb").size > 0
-      end
-    end
-  end
-end
-CODE
+        snippet_database = <<~CODE
+          config.around(:example, database: true) do |example|
+            DB.transaction(rollback: :always) { example.run }
+          end
+        CODE
+
+        location = /RSpec\.configure do \|config\|\n/
+        insert_into_file('spec/spec_helper.rb', after: location) do
+          "#{indent(snippet_rack, 2)}\n#{indent(snippet_database, 2)}\n"
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def reminders
         say "\nGemfile updated... don't forget to 'bundle install'"
-        say <<TEXT
-
-Notes:
-* The sqlite3 gem has been installed for dev and test environments only. You will need to specify a gem to use for production.
-* You will need to specify an environment variable 'DATABASE_URL' (either add it to .env or export it)
-TEXT
+        say <<~TEXT
+          #{'          '}
+          Notes:
+            * The sqlite3 gem has been installed for dev and test environments only. You will need to specify a gem to use for production.
+            * You will need to specify an environment variable 'DATABASE_URL' (either add it to .env or export it)
+        TEXT
       end
     end
   end

data/lib/hoboken/add_ons/sprockets.rb

@@ -1,97 +1,99 @@
+# frozen_string_literal: true
+
 module Hoboken
   module AddOns
+    # Rack-based asset packaging system.
+    #
     class Sprockets < ::Hoboken::Group
       def create_assets_folder
-        empty_directory("assets")
-        FileUtils.cp("public/css/styles.css", "assets/styles.css")
-        FileUtils.cp("public/js/app.js", "assets/app.js")
+        empty_directory('assets')
+        FileUtils.cp('public/css/styles.css', 'assets/styles.scss')
+        FileUtils.cp('public/js/app.js', 'assets/app.js')
       end
 
       def add_gems
-        gem "sprockets", version: "2.10.0", group: :assets
-        gem "uglifier", version: "2.1.1", group: :assets
-        gem "yui-compressor", version: "0.9.6", group: :assets
+        gem 'sassc', version: '2.4', group: :assets
+        gem 'sprockets', version: '4.0', group: :assets
+        gem 'uglifier', version: '4.2', group: :assets
+        gem 'yui-compressor', version: '0.12', group: :assets
       end
 
       def copy_sprockets_helpers
-        copy_file("hoboken/templates/sprockets.rake", "tasks/sprockets.rake")
-        copy_file("hoboken/templates/sprockets_chain.rb", "middleware/sprockets_chain.rb")
-        copy_file("hoboken/templates/sprockets_helper.rb", "helpers/sprockets.rb")
+        copy_file('hoboken/templates/sprockets.rake', 'tasks/sprockets.rake')
+        copy_file('hoboken/templates/sprockets_chain.rb', 'middleware/sprockets_chain.rb')
+        copy_file('hoboken/templates/sprockets_helper.rb', 'helpers/sprockets.rb')
       end
 
       def update_app
-        insert_into_file("app.rb", after: /configure :development do\n/) do
-<<CODE
-      require File.expand_path('middleware/sprockets_chain', settings.root)
-      use Middleware::SprocketsChain, %r{/assets} do |env|
-        %w(assets vendor).each do |f|
-          env.append_path File.expand_path("../\#{f}", __FILE__)
-        end
-      end
-
-CODE
+        snippet = <<~CODE
+          require File.expand_path('middleware/sprockets_chain', settings.root)
+          use Middleware::SprocketsChain, %r{/assets} do |env|
+            %w[assets vendor].each do |f|
+              env.append_path File.expand_path("../\#{f}", __FILE__)
+            end
+          end
+        CODE
+
+        indentation = classic? ? 2 : 6
+        insert_into_file('app.rb', after: /configure :development do\n/) do
+          "#{indent(snippet, indentation)}\n"
         end
 
-        insert_into_file("app.rb", after: /set :root, File.dirname\(__FILE__\)\n/) do
-          "    helpers Helpers::Sprockets"
-        end
-
-        gsub_file("app.rb", /require "sinatra\/reloader" if development\?/) do
-<<CODE
-if development?
-  require "sinatra/reloader"
-
-  require File.expand_path('middleware/sprockets_chain', settings.root)
-  use Middleware::SprocketsChain, %r{/assets} do |env|
-    %w(assets vendor).each do |f|
-      env.append_path File.expand_path("../\#{f}", __FILE__)
-    end
-  end
-end
-
-helpers Helpers::Sprockets
-CODE
+        insert_into_file('app.rb', after: /configure do\n/) do
+          "#{indent("helpers Helpers::Sprockets\n", indentation)}\n"
         end
       end
 
+      # rubocop:disable Metrics/MethodLength
       def adjust_link_tags
-        insert_into_file("views/layout.erb", before: /<\/head>/) do
-<<HTML
-  <%= stylesheet_tag :styles %>
-
-  <%= javascript_tag :app %>
+        insert_into_file('views/layout.erb', before: %r{</head>}) do
+          <<HTML
+  <%== stylesheet_tag :styles %>
+  <%== javascript_tag :app %>
 HTML
         end
 
-        gsub_file("views/layout.erb", /<link rel="stylesheet" type="text\/css" href="css\/styles.css">/, "")
-        gsub_file("views/layout.erb", /<script type="text\/javascript" src="js\/app.js"><\/script>/, "")
+        gsub_file(
+          'views/layout.erb',
+          %r{<link rel="stylesheet" type="text/css" href="css/styles.css">},
+          ''
+        )
+
+        gsub_file(
+          'views/layout.erb',
+          %r{<script type="text/javascript" src="js/app.js"></script>},
+          ''
+        )
       end
+      # rubocop:enable Metrics/MethodLength
 
+      # rubocop:disable Metrics/MethodLength
       def directions
-        text = <<TEXT
-
-Run `bundle install` to get the sprockets gem and its
-dependencies.
-
-Running the server in development mode will serve css
-and js files from /assets. In order to serve assets in
-production, you must run `rake assets:precompile`. Read
-the important note below before running this rake task.
-TEXT
-
-        important = <<TEXT
-
-Important Note:
-Any css or js files from the /public folder have been copied
-to /assets, the original files remain intact in /public, but
-will be replaced the first time you run `rake assets:precompile`.
-You may want to backup those files if they are not under source
-control before running the Rake command.
-TEXT
+        text = <<~TEXT
+          #{'          '}
+                    Run `bundle install` to get the sprockets gem and its
+                    dependencies.
+          #{'          '}
+                    Running the server in development mode will serve css
+                    and js files from /assets. In order to serve assets in
+                    production, you must run `rake assets:precompile`. Read
+                    the important note below before running this rake task.
+        TEXT
+
+        important = <<~TEXT
+          #{'          '}
+                    Important Note:
+                    Any css or js files from the /public folder have been copied
+                    to /assets, the original files remain intact in /public, but
+                    will be replaced the first time you run `rake assets:precompile`.
+                    You may want to backup those files if they are not under source
+                    control before running the Rake command.
+        TEXT
 
         say text
         say important, :red
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/hoboken/add_ons/travis.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module Hoboken
   module AddOns
+    # Basic Travis-CI YAML config.
+    #
     class Travis < ::Hoboken::Group
       def travis_yml
-        create_file(".travis.yml") do
-          "language: ruby"
+        create_file('.travis.yml') do
+          'language: ruby'
         end
       end
     end

data/lib/hoboken/add_ons/twbs.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Twitter Bootstrap support.
+    #
+    class TwitterBootstrap < ::Hoboken::Group
+      def add_gem
+        return unless sprockets?
+
+        gem 'bootstrap', version: '5.0.0.beta3', group: :assets
+      end
+
+      def update_app
+        return unless sprockets?
+
+        indentation = classic? ? 2 : 6
+        insert_into_file('app.rb', after: /require.*sprockets_chain.*\n/) do
+          indent("require 'bootstrap'\n", indentation)
+        end
+      end
+
+      def update_asset_files
+        return unless sprockets?
+
+        prepend_file('assets/styles.scss') do
+          <<~CODE
+            @import "bootstrap";
+
+          CODE
+        end
+
+        prepend_file('assets/app.js') do
+          <<~CODE
+            //= require popper
+            //= require bootstrap-sprockets
+          CODE
+        end
+      end
+
+      def update_sprockets_rake_tasks
+        return unless sprockets?
+
+        insert_into_file('tasks/sprockets.rake', after: /require 'sprockets'\n/) do
+          "  require 'bootstrap'\n"
+        end
+      end
+
+      def remove_normalize_css
+        return unless sprockets?
+
+        gsub_file(
+          'views/layout.erb',
+          '<link rel="stylesheet" type="text/css" ' \
+          'href="//cdnjs.cloudflare.com/ajax/libs/normalize/2.1.3/normalize.min.css">',
+          ''
+        )
+      end
+
+      def reminders
+        if sprockets?
+          say "\nGemfile updated... don't forget to 'bundle install'"
+        else
+          text = <<~TEXT
+            Sprockets is required. Please install the Sprockets add-on
+            first (hoboken add:sprockets).
+          TEXT
+
+          say text, :red
+        end
+      end
+
+      private
+
+      def sprockets?
+        Dir.exist?('assets')
+      end
+    end
+  end
+end

data/lib/hoboken/generate.rb

@@ -1,6 +1,11 @@
-require "rbconfig"
+# frozen_string_literal: true
+
+require 'rbconfig'
 
 module Hoboken
+  # Main project generator.
+  #
+  # rubocop:disable Metrics/ClassLength
   class Generate < Thor::Group
     include Thor::Actions
 
@@ -10,90 +15,152 @@ module Hoboken
 
     class_option :ruby_version,
                  type: :string,
-                 desc: "Ruby version for Gemfile",
+                 desc: 'Ruby version for Gemfile',
                  default: RUBY_VERSION
 
     class_option :tiny,
                  type: :boolean,
-                 desc: "Generate views inline; do not create /public folder",
+                 desc: 'Generate views inline; do not create /public folder',
                  default: false
 
     class_option :type,
                  type: :string,
-                 desc: "Architecture type (classic or modular)",
+                 desc: 'Architecture type (classic or modular)',
                  default: :classic
 
     class_option :git,
                  type: :boolean,
-                 desc: "Create a Git repository and make initial commit",
+                 desc: 'Create a Git repository and make initial commit',
+                 default: false
+
+    class_option :api_only,
+                 type: :boolean,
+                 desc: 'API only, no views, public folder, etc.',
                  default: false
 
+    class_option :test_framework,
+                 type: :string,
+                 desc: 'Testing framework; can be either test-unit or rspec',
+                 default: 'test-unit'
+
     def self.source_root
       File.dirname(__FILE__)
     end
 
     def app_folder
       empty_directory(snake_name)
-      apply_template("classic.rb.tt",  "app.rb")
-      apply_template("Gemfile.erb.tt", "Gemfile")
-      apply_template("config.ru.tt",   "config.ru")
-      apply_template("README.md.tt",   "README.md")
-      apply_template("Rakefile.tt",    "Rakefile")
+      apply_template('classic.rb.tt', 'app.rb')
+      apply_template('Gemfile.erb.tt', 'Gemfile')
+      apply_template('config.ru.tt', 'config.ru')
+      apply_template('README.md.tt', 'README.md')
+      apply_template('Rakefile.tt', 'Rakefile')
+
+      create_file("#{snake_name}/Procfile") do
+        'web: bundle exec puma -C config/puma.rb'
+      end
+    end
+
+    def bin_folder
+      empty_directory("#{snake_name}/bin")
+      %w[console server setup].each do |f|
+        target = "#{snake_name}/bin/#{f}"
+        copy_file("templates/#{f}.sh", target)
+        chmod(target, 0o755)
+      end
+    end
+
+    def config_folder
+      empty_directory("#{snake_name}/config")
+      apply_template('puma.rb.tt', 'config/puma.rb')
     end
 
     def view_folder
+      return if options[:api_only]
+
       empty_directory("#{snake_name}/views")
-      apply_template("views/layout.erb.tt", "views/layout.erb")
-      apply_template("views/index.erb.tt", "views/index.erb")
+      apply_template('views/layout.erb.tt', 'views/layout.erb')
+      apply_template('views/index.erb.tt', 'views/index.erb')
     end
 
     def public_folder
-      return if options[:tiny]
+      return if options[:tiny] || options[:api_only]
+
       inside snake_name do
-        empty_directory("public")
-        %w(css img js).each { |f| empty_directory("public/#{f}") }
+        empty_directory('public')
+        %w[css img js].each { |f| empty_directory("public/#{f}") }
       end
-      apply_template("styles.css.tt", "public/css/styles.css")
-      create_file("#{snake_name}/public/js/app.js", "")
 
-      %w(favicon hoboken sinatra).each do |f|
+      apply_template('styles.css.tt', 'public/css/styles.css')
+      create_file("#{snake_name}/public/js/app.js", '')
+
+      %w[favicon hoboken sinatra].each do |f|
         copy_file("templates/#{f}.png", "#{snake_name}/public/img/#{f}.png")
       end
     end
 
     def test_folder
+      return unless 'test-unit' == options[:test_framework]
+
       empty_directory("#{snake_name}/test/unit")
       empty_directory("#{snake_name}/test/integration")
       empty_directory("#{snake_name}/test/support")
-      apply_template("test/test_helper.rb.tt", "test/test_helper.rb")
-      apply_template("test/unit/app_test.rb.tt", "test/unit/app_test.rb")
-      apply_template("test/support/rack_test_assertions.rb.tt", "test/support/rack_test_assertions.rb")
+      apply_template('test_unit.rake.tt', 'tasks/test_unit.rake')
+      apply_template('test/test_helper.rb.tt', 'test/test_helper.rb')
+      apply_template('test/unit/app_test.rb.tt', 'test/unit/app_test.rb')
+      apply_template('support/rack_helpers.rb.tt', 'test/support/rack_helpers.rb')
+      apply_template('support/rack_test_assertions.rb.tt',
+                     'test/support/rack_test_assertions.rb')
+    end
+
+    def rspec_setup
+      return unless 'rspec' == options[:test_framework]
+
+      empty_directory("#{snake_name}/spec")
+      empty_directory("#{snake_name}/spec/support")
+      create_file("#{snake_name}/.rspec") { '--require spec_helper' }
+      apply_template('rspec.rake.tt', 'tasks/rspec.rake')
+      apply_template('spec/app_spec.rb.tt', 'spec/app_spec.rb')
+      apply_template('spec/spec_helper.rb.tt', 'spec/spec_helper.rb')
+      apply_template('support/rack_helpers.rb.tt', 'spec/support/rack_helpers.rb')
+      apply_template('spec/rack_matchers.rb.tt', 'spec/support/rack_matchers.rb')
     end
 
     def env_file
       inside snake_name do
-        create_file(".env") do
+        create_file('.env') do
           "RACK_ENV=development\nPORT=9292"
         end
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def make_modular
-      return unless "modular" == options[:type]
+      return unless 'modular' == options[:type]
+
       empty_directory("#{snake_name}/helpers")
       remove_file("#{snake_name}/app.rb")
-      apply_template("modular.rb.tt", "app.rb")
-      ["config.ru", "test/test_helper.rb"].each do |f|
+      apply_template('modular.rb.tt', 'app.rb')
+
+      files = [].tap do |f|
+        f << 'config.ru'
+        f << 'test/support/rack_helpers.rb' if 'test-unit' == options[:test_framework]
+        f << 'spec/support/rack_helpers.rb' if 'rspec' == options[:test_framework]
+      end
+
+      files.each do |f|
         path = File.join(snake_name, f)
         gsub_file(path, /Sinatra::Application/, "#{camel_name}::App")
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def inline_views
       return unless options[:tiny]
-      combined_views = %w(layout index).map do |f|
+      return if options[:api_only]
+
+      combined_views = %w[layout index].map { |f|
         "@@#{f}\n" + File.read("#{snake_name}/views/#{f}.erb")
-      end.join("\n")
+      }.join("\n")
 
       append_to_file("#{snake_name}/app.rb", "\n__END__\n\n#{combined_views}")
       remove_dir("#{snake_name}/views")
@@ -101,20 +168,26 @@ module Hoboken
 
     def create_git_repository
       return unless options[:git]
-      if has_git?
-        copy_file("templates/gitignore", "#{snake_name}/.gitignore")
+
+      if git?
+        copy_file('templates/gitignore', "#{snake_name}/.gitignore")
         inside snake_name do
-          run("git init .")
-          run("git add .")
-          run("git commit -m \"Initial commit.\"")
+          run('git init .')
+          run('git add .')
+          run('git commit -m "Initial commit."')
         end
       else
-        say "\nYou asked that a Git repository be created for the project, but no Git executable could be found."
+        say "\nYou asked that a Git repository be created for the " \
+          'project, but no Git executable could be found.'
       end
     end
 
     def directions
-      say "\nSuccessfully created #{name}. Don't forget to `bundle install`"
+      say "\nSuccessfully created #{name}."
+    end
+
+    def self.exit_on_failure?
+      true
     end
 
     private
@@ -124,15 +197,15 @@ module Hoboken
     end
 
     def camel_name
-      Thor::Util.camel_case(name.split("/").last)
+      Thor::Util.camel_case(name.split('/').last)
     end
 
     def titleized_name
-      snake_name.split("_").map(&:capitalize).join(" ")
+      snake_name.split('_').map(&:capitalize).join(' ')
     end
 
     def author
-      if has_git?
+      if git?
         `git config user.name`.chomp
       else
         say "\nNo Git executable found. Using result of `whoami` as author name."
@@ -140,7 +213,7 @@ module Hoboken
       end
     end
 
-    def has_git?
+    def git?
       system("git --version >#{NULL} 2>&1")
     end
 
@@ -148,4 +221,5 @@ module Hoboken
       template("templates/#{src}", "#{snake_name}/#{dest}")
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end