hoboken 0.0.1.beta2 → 0.10.0

data/lib/hoboken/add_ons/sidekiq.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Background processing via the Sidekiq gem.
+    #
+    class Sidekiq < ::Hoboken::Group
+      def add_gems
+        gem 'sidekiq', version: '6.2'
+      end
+
+      def adjust_rackup_config
+        gsub_file('config.ru', /run .*::App.*\n/) do |match|
+          <<~CODE
+            require 'sidekiq/web'
+
+            if 'production' == ENV.fetch('RACK_ENV', 'production')
+              Sidekiq::Web.use Rack::Auth::Basic do |username, password|
+                [username, password] == [ENV['SIDEKIQ_USERNAME'], ENV['SIDEKIQ_PASSWORD']]
+              end
+            end
+
+            Sidekiq::Web.use Rack::Session::Cookie, secret: ENV['SESSION_SECRET']
+            run Rack::URLMap.new('/' => #{match[4...-1].chomp}, '/sidekiq' => Sidekiq::Web)
+          CODE
+        end
+      end
+
+      def setup_config
+        template('hoboken/templates/sidekiq.rb.tt', 'config/sidekiq.rb')
+        location = "require_relative '../app'"
+        insert_into_file('config/environment.rb', before: location) do
+          "require_relative 'sidekiq'\n\n"
+        end
+      end
+
+      def example_worker
+        empty_directory('workers')
+        template('hoboken/templates/example_worker.rb.tt', 'workers/example_worker.rb')
+      end
+
+      def worker_test_and_helper
+        return if rspec?
+
+        insert_into_file('test/test_helper.rb', after: "require 'rack/test'") do
+          "\nrequire 'sidekiq/testing'"
+        end
+
+        template(
+          'hoboken/templates/test/unit/example_worker_test.rb.tt',
+          'test/unit/example_worker_test.rb'
+        )
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def worker_spec_and_helper
+        return unless rspec?
+
+        insert_into_file('spec/spec_helper.rb', after: "require 'rack/test'") do
+          "\nrequire 'sidekiq/testing'"
+        end
+
+        snippet = <<~CODE
+          config.before(:each, sidekiq: true) do
+            Sidekiq::Worker.clear_all
+          end
+        CODE
+
+        location = /RSpec\.configure do \|config\|\n/
+        insert_into_file('spec/spec_helper.rb', after: location) do
+          "#{indent(snippet, 2)}\n"
+        end
+
+        template(
+          'hoboken/templates/spec/example_worker_spec.rb.tt',
+          'spec/example_worker_spec.rb'
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def add_worker_to_procfile
+        append_file('Procfile') do
+          "\nworker: bundle exec sidekiq " \
+            '-r ./config/sidekiq.rb ' \
+            '-e $RACK_ENV ' \
+            '-c ${MAX_THREADS:-5} ' \
+            "-v\n"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def update_readme
+        snippet = <<~CODE
+          <tr>
+              <td>REDIS_URL</td>
+              <td>Yes</td>
+              <td>localhost:6379</td>
+              <td>Redis connection URL</td>
+          </tr>
+          <tr>
+              <td>SIDEKIQ_PASSWORD</td>
+              <td>Production Only</td>
+              <td>None</td>
+              <td>Password for SidekiqUI Basic Auth</td>
+          </tr>
+          <tr>
+              <td>SIDEKIQ_USERNAME</td>
+              <td>Production Only</td>
+              <td>None</td>
+              <td>Username for SidekiqUI Basic Auth</td>
+          </tr>
+        CODE
+
+        insert_into_file('README.md', after: /<tbody>\n/) do
+          indent(snippet, 8)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def reminders
+        text = <<~TEXT
+
+          Gemfile updated... don't forget to 'bundle install'
+
+          You can configure a Sidekiq error handing service in `config/sidekiq.rb`.
+
+          Sidekiq UI is available at '/sidekiq'. In production environments
+          the UI is protected with HTTP Basic Auth. Don't forget to set
+          `SIDEKIQ_USERNAME` and `SIDEKIQ_PASSWORD` in your production
+          environment or you won't be able to access the Sidekiq UI.
+        TEXT
+
+        say text, :green
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/travis.rb

@@ -0,0 +1,15 @@
+# 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'
+        end
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/turnip.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Gherkin extension for RSpec
+    #
+    class Turnip < ::Hoboken::Group
+      def add_gems
+        return unless rspec?
+
+        gem 'turnip', version: '4.3', group: :test
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def add_sample_files
+        return unless rspec?
+
+        empty_directory('spec/features')
+        empty_directory('spec/support/steps')
+        create_file('spec/features/example.feature') do
+          <<~TEXT
+            @feature
+            Feature: An Example
+                This is an example feature spec that can be deleted.
+
+                Scenario: Name of some scenario
+                    Given nothing
+                    When I do nothing
+                    Then nothing should happen
+          TEXT
+        end
+
+        create_file('spec/support/steps/example_steps.rb') do
+          <<~CODE
+            # frozen_string_literal: true
+
+            # Steps for the example feature that can be deleted.
+
+            step 'nothing' do
+              # ...
+            end
+
+            step 'I do nothing' do
+              # ...
+            end
+
+            step 'nothing should happen' do
+              # ...
+            end
+          CODE
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def add_helper
+        return unless rspec?
+
+        template(
+          'hoboken/templates/spec/turnip_helper.rb.tt',
+          'spec/turnip_helper.rb'
+        )
+      end
+
+      def rake_task
+        return unless rspec?
+
+        create_file('tasks/turnip.rake') do
+          <<~TEXT
+            # frozen_string_literal: true
+
+            require 'rspec/core/rake_task'
+
+            desc 'Run turnip acceptance tests'
+            RSpec::Core::RakeTask.new(:turnip) do |t|
+              t.pattern = './spec{,/*/**}/*.feature'
+              t.rspec_opts = ['-r turnip/rspec']
+            end
+          TEXT
+        end
+      end
+
+      def default_rake_task
+        return unless rspec?
+
+        gsub_file('Rakefile', /task default:.*/, 'task default: %w[spec turnip]')
+      end
+
+      def ci_task
+        return unless rspec?
+
+        gsub_file('Rakefile', /task ci:.*/) do |match|
+          if match.include?('rubocop')
+            'task ci: %w[spec turnip rubocop]'
+          else
+            'task ci: %w[spec turnip]'
+          end
+        end
+      end
+
+      def reminders
+        if rspec?
+          say "Gemfile updated... don't forget to 'bundle install'", :green
+        else
+          say 'Turnip requires RSpec to be setup', :red
+        end
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/twbs.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Twitter Bootstrap support.
+    #
+    class TwitterBootstrap < ::Hoboken::Group
+      def add_gem
+        gem 'bootstrap', version: '5.0.0.beta3', group: :assets
+      end
+
+      def update_app
+        indentation = classic? ? 2 : 6
+        location = /configure do\n/
+        insert_into_file('config/environment.rb', after: location) do
+          indent("require 'bootstrap'\n", indentation)
+        end
+      end
+
+      def update_asset_files
+        prepend_file('assets/stylesheets/styles.scss') do
+          <<~CODE
+            @import "bootstrap";
+
+          CODE
+        end
+
+        prepend_file('assets/javascripts/app.js') do
+          <<~CODE
+            //= require popper
+            //= require bootstrap-sprockets
+          CODE
+        end
+      end
+
+      def remove_normalize_css
+        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
+        say "\nGemfile updated... don't forget to 'bundle install'"
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/vcr.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Record your test suite's HTTP interactions and replay them during
+    # future test runs.
+    #
+    class Vcr < ::Hoboken::Group
+      def add_gems
+        gem 'vcr', version: '6.0', group: :test
+        gem 'webmock', version: '3.13', group: :test
+      end
+
+      def add_directories
+        empty_directory(File.join(location, 'fixtures', 'vcr_cassettes'))
+      end
+
+      def add_setup_file
+        template(
+          'hoboken/templates/vcr_setup.rb.tt',
+          File.join(location, 'support/vcr_setup.rb')
+        )
+      end
+
+      def require_vcr_in_test_helper
+        return if rspec?
+
+        snippet_location = "require_relative 'support/rack_helpers'"
+        insert_into_file('test/test_helper.rb', after: snippet_location) do
+          "\nrequire_relative 'support/vcr_setup'"
+        end
+      end
+
+      def require_vcr_in_spec_helper
+        return unless rspec?
+
+        snippet_location = "require 'support/rack_helpers'"
+        insert_into_file('spec/spec_helper.rb', after: snippet_location) do
+          "\nrequire 'support/vcr_setup'"
+        end
+      end
+
+      def reminders
+        say "Gemfile updated... don't forget to 'bundle install'", :green
+      end
+
+      private
+
+      def location
+        rspec? ? 'spec' : 'test'
+      end
+    end
+  end
+end

data/lib/hoboken/generate.rb

@@ -1,111 +1,197 @@
-require "rbconfig"
+# frozen_string_literal: true
+
+require 'rbconfig'
 
 module Hoboken
+  # Main project generator.
+  #
+  # rubocop:disable Metrics/ClassLength
   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
 
     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 view_folder
-      empty_directory("#{snake_name}/views")
-      apply_template("views/layout.erb.tt", "views/layout.erb")
-      apply_template("views/index.erb.tt", "views/index.erb")
+    def bin_folder
+      empty_directory("#{snake_name}/bin")
+      %w[console server setup].each do |f|
+        target = "#{snake_name}/bin/#{f}"
+        copy_file("templates/#{f}", target)
+        chmod(target, 0o755)
+      end
     end
 
-    def inline_views
-      return unless options[:tiny]
-      combined_views = %w(layout index).map do |f|
-        "@@#{f}\n" + File.read("#{snake_name}/views/#{f}.erb")
-      end.join("\n")
+    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
 
-      append_to_file("#{snake_name}/app.rb", "\n__END__\n\n#{combined_views}")
-      remove_dir("#{snake_name}/views")
+    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')
     end
 
-    def public_folder
-      return if options[:tiny]
+    def asset_pipeline
+      return if options[:api_only]
+
       inside snake_name do
-        empty_directory("public")
-        %w(css img js).each { |f| empty_directory("public/#{f}") }
+        empty_directory('assets')
+        empty_directory('public')
+        %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", "")
 
-      %w(favicon hoboken sinatra).each do |f|
-        copy_file("templates/#{f}.png", "#{snake_name}/public/img/#{f}.png")
+      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}/assets/images/#{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/unit/test_helper.rb.tt", "test/unit/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
+          "RACK_ENV=development\nPORT=9292\nSESSION_SECRET=secret"
+        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/unit/test_helper.rb"].each do |f|
+      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'
+        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]
+      return if options[:api_only]
+
+      combined_views = %w[layout index].map { |f|
+        "@@#{f}\n" + File.read("#{snake_name}/views/#{f}.erb")
+      }.join("\n")
+
+      append_to_file("#{snake_name}/app.rb", "\n__END__\n\n#{combined_views}")
+      remove_dir("#{snake_name}/views")
+    end
 
     def create_git_repository
       return unless options[:git]
-      if system("git --version >#{NULL} 2>&1")
-        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
@@ -115,19 +201,33 @@ module Hoboken
     end
 
     def camel_name
-      Thor::Util.camel_case(name)
+      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
-      `git config user.name`.chomp
+      if git?
+        `git config user.name`.chomp
+      else
+        say "\nNo Git executable found. Using result of `whoami` as author name."
+        `whoami`.chomp
+      end
+    end
+
+    def git?
+      system("git --version >#{NULL} 2>&1")
     end
 
     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