hoboken 0.0.1 → 0.9.0

data/test/integration/generate_test.rb

@@ -1,71 +1,203 @@
-require_relative "../test_helper"
+# frozen_string_literal: true
 
+require_relative '../test_helper'
+
+# rubocop:disable Metrics/ClassLength
 class GenerateTest < IntegrationTestCase
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def test_generate_classic
     run_hoboken(:generate) do
-      assert_file ".env"
-      assert_file "Gemfile"
-      assert_file "README.md"
-      assert_file "Rakefile"
-      assert_file "app.rb", /require "sinatra"/
-      assert_file "config.ru", /run Sinatra::Application/
-      assert_directory "public"
-      assert_directory "test"
-      assert_file "views/index.erb"
-      assert_file "views/layout.erb"
+      assert_file '.env'
+      assert_file 'Gemfile'
+      assert_file('Procfile')
+      assert_file 'README.md'
+      assert_file 'Rakefile'
+      assert_file 'app.rb', /require 'sinatra'/
+      assert_file 'app.rb', %r{require 'sinatra/flash'}
+      assert_file 'app.rb', /require 'erubi'/
+      assert_file 'app.rb', /erb :index/
+      assert_file 'app.rb', /set :erb, { escape_html: true }/
+      assert_file 'app.rb', /require 'better_errors'/
+      assert_file_does_not_have_content 'app.rb', /json message:/
+      assert_file 'bin/console'
+      assert_file 'bin/server'
+      assert_file 'bin/setup'
+      assert_file 'config.ru', /run Sinatra::Application/
+      assert_directory 'public'
+      assert_directory 'test'
+      assert_file 'views/index.erb'
+      assert_file 'views/layout.erb', /styled_flash/
     end
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   def test_generate_classic_tiny
     run_hoboken(:generate, tiny: true) do
-      refute_directory("public")
-      assert_file "app.rb", /__END__/, /@@layout/, /@@index/
+      refute_directory('public')
+      assert_file 'app.rb', /__END__/, /@@layout/, /@@index/
+    end
+  end
+
+  def test_generate_classic_api_only
+    run_hoboken(:generate, api_only: true) do
+      refute_directory('public')
+      refute_directory('views')
+      assert_file 'app.rb', %r{require 'sinatra/json'}
+      assert_file 'app.rb', /json message:/
+      assert_file_does_not_have_content 'app.rb', %r{require 'sinatra/flash'}
+      assert_file_does_not_have_content 'app.rb', /erb :index/
+      assert_file_does_not_have_content 'app.rb', /set :erb, { escape_html: true }/
+    end
+  end
+
+  def test_generate_api_only_with_tiny
+    run_hoboken(:generate, api_only: true, tiny: true) do
+      assert_file_does_not_have_content 'app.rb', /__END__/, /@@layout/, /@@index/
+    end
+  end
+
+  def test_generate_classic_can_run_tests
+    run_hoboken(:generate) do
+      result = execute('rake test:all')
+      assert_match(/1 tests, 3 assertions, 0 failures, 0 errors/, result)
+    end
+  end
+
+  def test_generate_classic_can_run_specs
+    run_hoboken(:generate, test_framework: 'rspec') do
+      result = execute('rake spec')
+      assert_match(/3 examples, 0 failures/, result)
+    end
+  end
+
+  def test_generate_classic_api_only_can_run_tests
+    run_hoboken(:generate, api_only: true) do
+      result = execute('rake test:all')
+      assert_match(/1 tests, 3 assertions, 0 failures, 0 errors/, result)
+    end
+  end
+
+  def test_generate_classic_api_only_can_run_specs
+    run_hoboken(:generate, api_only: true, test_framework: 'rspec') do
+      result = execute('rake spec')
+      assert_match(/3 examples, 0 failures/, result)
+    end
+  end
+
+  def test_generate_classic_passes_rubocop_inspection
+    run_hoboken(:generate) do
+      assert_match(/no offenses detected/, execute('rubocop'))
     end
   end
 
-  #def test_generate_classic_can_run_tests
-    #run_hoboken(:generate) do
-      #assert_match /1 tests, 1 assertions, 0 failures, 0 errors, 0 skips/, execute("rake test:all")
-    #end
-  #end
+  def test_generate_classic_api_only_passes_rubocop_inspection
+    run_hoboken(:generate, api_only: true) do
+      assert_match(/no offenses detected/, execute('rubocop'))
+    end
+  end
 
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def test_generate_modular
     run_hoboken(:generate, type: :modular) do
-      assert_file ".env"
-      assert_file "Gemfile"
-      assert_file "README.md"
-      assert_file "Rakefile"
-      assert_file "app.rb", /require "sinatra\/base"/, /module Sample/, /class App < Sinatra::Base/
-      assert_file "config.ru", /run Sample::App/
-      assert_directory "public"
-      assert_file "test/test_helper.rb", /Sample::App/
-      assert_file "views/index.erb"
-      assert_file "views/layout.erb"
+      assert_file '.env'
+      assert_file 'Gemfile'
+      assert_file('Procfile')
+      assert_file 'README.md'
+      assert_file 'Rakefile'
+      assert_file('app.rb', %r{require 'sinatra/base'})
+      assert_file 'app.rb', %r{require 'sinatra/flash'}
+      assert_file('app.rb', /require 'erubi'/)
+      assert_file('app.rb', /module Sample/)
+      assert_file('app.rb', /class App < Sinatra::Base/)
+      assert_file 'app.rb', /set :erb, { escape_html: true }/
+      assert_file 'app.rb', /register Sinatra::Flash/
+      assert_file 'app.rb', /require 'better_errors'/
+      assert_file 'bin/console'
+      assert_file 'bin/server'
+      assert_file 'bin/setup'
+      assert_file 'config.ru', /run Sample::App/
+      assert_directory 'public'
+      assert_file 'test/support/rack_helpers.rb', /Sample::App/
+      assert_file 'views/index.erb'
+      assert_file 'views/layout.erb', /styled_flash/
     end
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   def test_generate_modular_tiny
     run_hoboken(:generate, tiny: true, type: :modular) do
-      refute_directory("public")
-      assert_file "app.rb", /__END__/, /@@layout/, /@@index/
+      refute_directory('public')
+      assert_file 'app.rb', /__END__/, /@@layout/, /@@index/
+    end
+  end
+
+  def test_generate_modular_api_only
+    run_hoboken(:generate, type: :modular, api_only: true) do
+      refute_directory('public')
+      refute_directory('views')
+      assert_file 'app.rb', %r{require 'sinatra/json'}
+      assert_file 'app.rb', /json message:/
+      assert_file_does_not_have_content 'app.rb', %r{require 'sinatra/flash'}
+      assert_file_does_not_have_content 'app.rb', /register Sinatra::Flash/
+      assert_file_does_not_have_content 'app.rb', /erb :index/
+      assert_file_does_not_have_content 'app.rb', /set :erb, { escape_html: true }/
+    end
+  end
+
+  def test_generate_modular_can_run_tests
+    run_hoboken(:generate, type: :modular) do
+      result = execute('rake test:all')
+      assert_match(/1 tests, 3 assertions, 0 failures, 0 errors/, result)
+    end
+  end
+
+  def test_generate_modular_can_run_specs
+    run_hoboken(:generate, test_framework: 'rspec', type: :modular) do
+      result = execute('rake spec')
+      assert_match(/3 examples, 0 failures/, result)
     end
   end
 
-  #def test_generate_modular_can_run_tests
-    #run_hoboken(:generate, type: :modular) do
-      #assert_match /1 tests, 1 assertions, 0 failures, 0 errors, 0 skips/, execute("rake test:all")
-    #end
-  #end
+  def test_generate_modular_api_only_can_run_tests
+    run_hoboken(:generate, api_only: true, type: :modular) do
+      result = execute('rake test:all')
+      assert_match(/1 tests, 3 assertions, 0 failures, 0 errors/, result)
+    end
+  end
+
+  def test_generate_modular_api_only_can_run_specs
+    run_hoboken(:generate, test_framework: 'rspec', api_only: true, type: :modular) do
+      result = execute('rake spec')
+      assert_match(/3 examples, 0 failures/, result)
+    end
+  end
+
+  def test_generate_modular_passes_rubocop_inspection
+    run_hoboken(:generate, type: :modular) do
+      assert_match(/no offenses detected/, execute('rubocop'))
+    end
+  end
+
+  def test_generate_modular_api_only_passes_rubocop_inspection
+    run_hoboken(:generate, api_only: true, type: :modular) do
+      assert_match(/no offenses detected/, execute('rubocop'))
+    end
+  end
 
   def test_generate_with_ruby_version
-    run_hoboken(:generate, ruby_version: "2.1.0") do
-      assert_file "Gemfile", /ruby "2\.1\.0"/
+    run_hoboken(:generate, ruby_version: '2.1.0') do
+      assert_file 'Gemfile', /ruby '2\.1\.0'/
     end
   end
 
   def test_generate_with_git
     run_hoboken(:generate, git: true) do
-      assert_directory ".git"
+      assert_directory '.git'
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/test/test_helper.rb

@@ -1,67 +1,98 @@
-require "test/unit"
-require "fileutils"
+# frozen_string_literal: true
 
+require 'bundler/setup'
+
+require 'warning'
+
+# Ignore all warnings in Gem dependencies
+Gem.path.each { |path| Warning.ignore(//, path) }
+
+require 'test/unit'
+require 'fileutils'
+
+# rubocop:disable Style/GlobalVars
 $hoboken_counter = 0
-DESTINATION = File.expand_path("../tmp", __FILE__)
+DESTINATION = File.expand_path('tmp', __dir__)
 FileUtils.rm_rf(DESTINATION)
 
 class IntegrationTestCase < Test::Unit::TestCase
   def teardown
-    if self.passed?
+    if passed?
       FileUtils.rm_rf("#{DESTINATION}/#{$hoboken_counter}")
     else
       puts "Left #{DESTINATION}/#{$hoboken_counter}/sample in place since test failed."
     end
   end
 
+  # rubocop:disable Metrics/AbcSize
   def run_hoboken(command, **opts)
-    options = Array.new.tap do |o|
-      o << "--git" if opts.fetch(:git) { false }
-      o << "--tiny" if opts.fetch(:tiny) { false }
-      o << "--type=#{opts[:type]}" if opts.has_key?(:type)
-      o << "--ruby-version=#{opts[:ruby_version]}" if opts.has_key?(:ruby_version)
+    options = [].tap do |o|
+      o << '--git' if opts.fetch(:git, false)
+      o << '--tiny' if opts.fetch(:tiny, false)
+      o << '--api-only' if opts.fetch(:api_only, false)
+      o << "--test_framework=#{opts[:test_framework]}" if opts.key?(:test_framework)
+      o << "--type=#{opts[:type]}" if opts.key?(:type)
+      o << "--ruby-version=#{opts[:ruby_version]}" if opts.key?(:ruby_version)
     end
 
     $hoboken_counter += 1
-    bin_path = File.expand_path("../../bin/hoboken", __FILE__)
+    bin_path = File.expand_path('../bin/hoboken', __dir__)
 
-    `#{bin_path} #{command} #{DESTINATION}/#{$hoboken_counter}/sample #{options.join(" ")}`
+    # rubocop:disable Layout/LineLength
+    `#{bin_path} #{command} #{DESTINATION}/#{$hoboken_counter}/sample #{options.join(' ')}`
+    # rubocop:enable Layout/LineLength
     yield
   end
+  # rubocop:enable Metrics/AbcSize
 
   def execute(command)
     FileUtils.cd("#{DESTINATION}/#{$hoboken_counter}/sample") do
-      `bundle install` unless File.exists?("Gemfile.lock")
       `#{command}`
     end
   end
 
   def assert_file(filename, *contents)
-    full_path = File.join(DESTINATION, $hoboken_counter.to_s, "sample", filename)
+    full_path = File.join(DESTINATION, $hoboken_counter.to_s, 'sample', filename)
+    assert_block("expected #{filename.inspect} to exist") do
+      File.exist?(full_path)
+    end
+
+    return if contents.empty?
+
+    read = File.read(full_path)
+    contents.each do |content|
+      assert_block("expected #{filename.inspect} to contain #{content}:\n#{read}") do
+        pattern = content.is_a?(Regexp) ? content : Regexp.new(Regexp.quote(content))
+        read =~ pattern
+      end
+    end
+  end
+
+  def assert_file_does_not_have_content(filename, *contents)
+    full_path = File.join(DESTINATION, $hoboken_counter.to_s, 'sample', filename)
     assert_block("expected #{filename.inspect} to exist") do
-      File.exists?(full_path)
+      File.exist?(full_path)
     end
 
-    unless contents.empty?
-      read = File.read(full_path)
-      contents.each do |content|
-        assert_block("expected #{filename.inspect} to contain #{content}:\n#{read}") do
-          pattern = content.is_a?(Regexp) ? content : Regexp.new(Regexp.quote(content))
-          read =~ pattern
-        end
+    read = File.read(full_path)
+    contents.each do |content|
+      assert_block("expected #{filename.inspect} to not contain #{content}:\n#{read}") do
+        pattern = content.is_a?(Regexp) ? content : Regexp.new(Regexp.quote(content))
+        read !~ pattern
       end
     end
   end
 
   def assert_directory(name)
     assert_block("expected #{name} directory to exist") do
-      File.directory?(File.join(DESTINATION, $hoboken_counter.to_s, "sample", name))
+      File.directory?(File.join(DESTINATION, $hoboken_counter.to_s, 'sample', name))
     end
   end
 
   def refute_directory(name)
     assert_block("did not expect directory #{name} to exist") do
-      !File.directory?(File.join(DESTINATION, $hoboken_counter.to_s, "sample", name))
+      !File.directory?(File.join(DESTINATION, $hoboken_counter.to_s, 'sample', name))
     end
   end
 end
+# rubocop:enable Style/GlobalVars

data/test/unit/hoboken_actions_test.rb

@@ -1,8 +1,10 @@
-require_relative "../test_helper"
-require_relative "../../lib/hoboken/actions.rb"
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require_relative '../../lib/hoboken/actions'
 
 module Hoboken
-  require "thor"
+  require 'thor'
   class Target < Thor::Group
     include Thor::Actions
     include Hoboken::Actions
@@ -12,100 +14,107 @@ module Hoboken
     attr_reader :gemfile_path, :gemfile, :target
 
     def setup
-      @gemfile_path = File.join("test", "fixtures")
-      @gemfile = File.join(gemfile_path, "Gemfile")
+      @gemfile_path = File.join('test', 'fixtures')
+      @gemfile = File.join(gemfile_path, 'Gemfile')
       @target = Target.new([], {}, destination_root: gemfile_path)
-      FileUtils.copy(File.join(gemfile_path, "Gemfile.pristine"), gemfile)
+      FileUtils.copy(File.join(gemfile_path, 'Gemfile.pristine'), gemfile)
     end
 
     def test_gem_appends_to_gemfile
-      target.gem "sinatra", verbose: false
+      target.gem 'sinatra', verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\""
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra'\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_gem_with_version
-      target.gem "sinatra", version: "1.4.4", verbose: false
+      target.gem 'sinatra', version: '1.4.4', verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\", \"~> 1.4.4\""
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra', '~> 1.4.4'\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_get_with_blank_version
-      target.gem "sinatra", version: "", verbose: false
+      target.gem 'sinatra', version: '', verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\""
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra'\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_gem_with_group
-      target.gem "sinatra", version: "1.4.4", group: :test, verbose: false
+      target.gem 'sinatra', version: '1.4.4', group: :test, verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\", \"~> 1.4.4\", group: :test"
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra', '~> 1.4.4', group: :test\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_gem_with_multiple_groups
-      target.gem "sinatra", version: "1.4.4", group: [:test, :development], verbose: false
+      target.gem 'sinatra', version: '1.4.4', group: %i[test development], verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\", \"~> 1.4.4\", group: [:test, :development]"
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra', '~> 1.4.4', group: [:test, :development]\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_gem_with_require
-      target.gem "sinatra", version: "1.4.4", require: false, verbose: false
+      target.gem 'sinatra', version: '1.4.4', require: false, verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\", \"~> 1.4.4\", require: false"
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra', '~> 1.4.4', require: false\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_gem_with_require_and_group
-      target.gem "sinatra", version: "1.4.4", require: false, group: :test, verbose: false
+      target.gem 'sinatra', version: '1.4.4', require: false, group: :test, verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\", \"~> 1.4.4\", require: false, group: :test"
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra', '~> 1.4.4', require: false, group: :test\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_gem_with_require_and_multiple_groups
-      target.gem "sinatra", version: "1.4.4", require: false, group: [:test, :development], verbose: false
+      target.gem(
+        'sinatra',
+        version: '1.4.4',
+        require: false,
+        group: %i[test development],
+        verbose: false
+      )
+
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\", \"~> 1.4.4\", require: false, group: [:test, :development]"
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra', '~> 1.4.4', require: false, group: [:test, :development]\n"
 
       assert_equal(expected, File.read(gemfile))
     end
 
     def test_gem_multiple
-      target.gem "sinatra", version: "1.4.4", verbose: false
-      target.gem "thin", version: "1.4.4", verbose: false
+      target.gem 'sinatra', version: '1.4.4', verbose: false
+      target.gem 'thin', version: '1.4.4', verbose: false
       expected =
-        "source \"https://rubygems.org\"\n" +
-        "ruby \"2.0.0\"\n\n" +
-        "gem \"sinatra\", \"~> 1.4.4\"\n" +
-        "gem \"thin\", \"~> 1.4.4\""
+        "source 'https://rubygems.org'\n" \
+        "ruby '2.0.0'\n\n" \
+        "gem 'sinatra', '~> 1.4.4'\n" \
+        "gem 'thin', '~> 1.4.4'\n"
 
       assert_equal(expected, File.read(gemfile))
     end
@@ -116,32 +125,32 @@ module Hoboken
 
     def setup
       @target = Target.new
-      @text = <<-TEXT
+      @text = <<~TEXT
 
-This is some
-text that needs
-to be indented.
-TEXT
+        This is some
+        text that needs
+        to be indented.
+      TEXT
     end
 
     def test_indent_with_one_space
-      expected = <<-TEXT
- 
- This is some
- text that needs
- to be indented.
-TEXT
+      expected = <<~TEXT
+        #{' '}
+         This is some
+         text that needs
+         to be indented.
+      TEXT
 
       assert_equal(expected, target.indent(text, 1))
     end
 
     def test_indent_with_two_spaces
-      expected = <<-TEXT
-  
-  This is some
-  text that needs
-  to be indented.
-TEXT
+      expected = <<~TEXT
+        #{'  '}
+          This is some
+          text that needs
+          to be indented.
+      TEXT
 
       assert_equal(expected, target.indent(text, 2))
     end