roger 1.1.3 → 1.2.1

data/test/unit/cli/cli_test_test.rb

@@ -7,9 +7,8 @@ require File.dirname(__FILE__) + "/../../project/lib/tests/fail/fail"
 require File.dirname(__FILE__) + "/../../project/lib/tests/succeed/succeed"
 require File.dirname(__FILE__) + "/../../project/lib/tests/noop/noop"
 
-# These tests ar for the roger test command
-
 module Roger
+  # These tests ar for the roger test command
   class CliTestTest < ::Test::Unit::TestCase
     include TestCli
 
@@ -36,13 +35,13 @@ module Roger
 
     # roger test all
     def test_subcommand_all_runs_all_tests
-      out, err = run_test_command %w{test all}
+      out, _err = run_test_command %w(test all)
       assert_includes out, "RogerNoopTest::Test"
       assert_includes out, "RogerSucceedTest::Test"
     end
 
     def test_subcommand_all_runs_all_tests_in_order_1
-      out, err = run_test_command %w{test all} do |t|
+      out, _err = run_test_command %w(test all) do |t|
         t.use :succeed
         t.use :noop
       end
@@ -50,7 +49,7 @@ module Roger
     end
 
     def test_subcommand_all_runs_all_tests_in_order_2
-      out, err = run_test_command %w{test all} do |t|
+      out, _err = run_test_command %w(test all) do |t|
         t.use :noop
         t.use :succeed
       end
@@ -59,7 +58,7 @@ module Roger
 
     # roger test
     def test_default_runs_all_tests
-      out, err = run_test_command %w{test}
+      out, _err = run_test_command %w(test)
       assert_includes out, "RogerNoopTest::Test"
       assert_includes out, "RogerSucceedTest::Test"
     end
@@ -68,7 +67,7 @@ module Roger
     def test_has_option_v
       # A somewhat a-typical test,
       # just to make it work
-      cli = ::Roger::Cli::Base.new [], %w{--verbose}
+      cli = ::Roger::Cli::Base.new [], %w(--verbose)
       cli.class.project.mockupfile.test do |t|
         t.use :noop
       end
@@ -82,7 +81,7 @@ module Roger
 
     # roger help test
     def test_help_shows_available_subcommands
-      out, err = run_test_command %w{help test}
+      out, _err = run_test_command %w(help test)
       assert_includes out, "test all"
       assert_includes out, "test succeed"
       assert_includes out, "test noop"
@@ -90,14 +89,14 @@ module Roger
 
     # roger test noop
     def test_subcommand_x_runs_only_test_x
-      out, err = run_test_command %w{test noop}
+      out, _err = run_test_command %w(test noop)
       assert_includes out, "RogerNoopTest::Test"
       assert_not_includes out, "RogerSucceedTest::Test"
     end
 
     def test_subcommand_x_has_exit_code_1_on_failure
       assert_raise(Thor::Error) do
-        out, err = run_test_command %w{test fail} do |t|
+        run_test_command %w(test fail) do |t|
           t.use :noop
           t.use :fail
         end
@@ -106,7 +105,7 @@ module Roger
 
     def test_subcommand_x_has_exit_code_0_on_success
       assert_nothing_raised do
-        out, err = run_test_command %w{test noop} do |t|
+        run_test_command %w(test noop) do |t|
           t.use :noop
           t.use :fail
         end
@@ -115,7 +114,7 @@ module Roger
 
     def test_subcommand_all_has_exit_code_1_on_failure
       assert_raise(Thor::Error) do
-        out, err = run_test_command %w{test} do |t|
+        run_test_command %w(test) do |t|
           t.use :noop
           t.use :fail
         end
@@ -124,12 +123,11 @@ module Roger
 
     def test_subcommand_all_has_exit_code_0_on_success
       assert_nothing_raised do
-        out, err = run_test_command %w{test} do |t|
+        run_test_command %w(test) do |t|
           t.use :noop
           t.use :succeed
         end
       end
     end
-
   end
-end
+end

data/test/unit/cli/cli_version_test.rb

@@ -3,19 +3,19 @@ require "test/unit"
 
 require File.dirname(__FILE__) + "/../../helpers/cli"
 
-
 module Roger
+  # Test `roger --version` command
   class CliVersionTest < ::Test::Unit::TestCase
     include TestCli
 
     def test_minus_minus_verson
-      out,err = run_command(%w{--version})
+      out, _err = run_command(%w(--version))
       assert_includes out, Roger::VERSION
     end
 
     def test_version_command
-      out,err = run_command(%w{version})
+      out, _err = run_command(%w(version))
       assert_includes out, Roger::VERSION
     end
   end
-end
+end

data/test/unit/generators_test.rb

@@ -4,32 +4,31 @@ require "test/unit"
 
 module CustomGens
   module Generators
-
+    # Simple Mock generator
     class MockedGenerator < Roger::Generators::Base
-
       desc "@mocked description"
-      argument :path, :type => :string, :required => false, :desc => "Path to generate mockup into"
-      argument :another_arg, :type => :string, :required => false, :desc => "Mocked or what?!"
+      argument :path, type: :string, required: false, desc: "Path to generate mockup into"
+      argument :another_arg, type: :string, required: false, desc: "Mocked or what?!"
 
       def test
         # Somewhat ugly way of checking
-        raise NotImplementedError
+        fail NotImplementedError
       end
     end
 
+    # Simple Mocku generator that has a project
     class MockedWithProjectGenerator < Roger::Generators::Base
-
       desc "Returns a project"
       def test
         # Somewhat ugly way of checking
-        raise StandardError if @project
+        fail StandardError if @project
       end
     end
-
   end
 end
 
 module Roger
+  # Test Roger Generators
   class GeneratorTest < ::Test::Unit::TestCase
     def setup
       @cli = Cli::Base.new
@@ -61,7 +60,6 @@ module Roger
     end
 
     def test_cli_help_shows_all_available_generators
-
     end
 
     def test_default_generator
@@ -85,4 +83,4 @@ module Roger
       end
     end
   end
-end
+end

data/test/unit/helpers/logging_test.rb

@@ -0,0 +1,64 @@
+require "./lib/roger/helpers/logging"
+require "test/unit"
+require File.dirname(__FILE__) + "/../../helpers/cli"
+
+# Empty logging class
+class MyLogger
+  include Roger::Helpers::Logging
+
+  attr_accessor :project
+end
+
+# Test Logging module
+class LoggingTest < ::Test::Unit::TestCase
+  include Roger::TestCli
+
+  def setup
+    @logger = MyLogger.new
+    @logger.project = stub(
+      options: {},
+      shell: Thor::Shell::Color.new
+    )
+  end
+
+  def test_log
+    out, _err = capture { @logger.log(@logger, "log") }
+    assert out.include?("MyLogger")
+    assert out.include?("log")
+  end
+
+  def test_log_with_string_part
+    out, _err = capture { @logger.log("string_test", "log") }
+    assert out.include?("string_test")
+    assert out.include?("log")
+  end
+
+  def test_log_with_block
+    out, _err = capture do
+      @logger.log(@logger, "log") do
+        @logger.log(@logger, "indent")
+      end
+    end
+
+    assert out.include?("MyLogger")
+    assert out.include?("log")
+    assert out.include?("  MyLogger : indent"), out
+  end
+
+  def test_debug
+    out, _err = capture { @logger.debug(@logger, "debug") }
+    assert_equal out, ""
+
+    @logger.project.options[:verbose] = true
+    out, _err = capture { @logger.debug(@logger, "debug") }
+    assert out.include?("MyLogger")
+    assert out.include?("debug")
+  end
+
+  # TODO: test if color is outputted as well.
+  def test_warn
+    out, _err = capture { @logger.warn(@logger, "warn") }
+    assert out.include?("MyLogger")
+    assert out.include?("warn")
+  end
+end

data/test/unit/rack/roger_test.rb

@@ -0,0 +1,21 @@
+require "test/unit"
+require File.dirname(__FILE__) + "../../../../lib/roger/rack/roger"
+
+module Roger
+  module Rack
+    # Test Roger Rack
+    class ServerTest < ::Test::Unit::TestCase
+      def setup
+        @project = Project.new(File.dirname(__FILE__) + "/../../project", mockupfile_path: false)
+        @app = ::Roger::Rack::Roger.new(@project)
+      end
+
+      def test_middleware_renders_template
+        request = ::Rack::MockRequest.new(@app)
+        response = request.get("/formats/erb")
+
+        assert response.body.include?("ERB format")
+      end
+    end
+  end
+end

data/test/unit/release/cleaner_test.rb

@@ -2,23 +2,19 @@ require "./lib/roger/release.rb"
 require "./lib/roger/release/cleaner.rb"
 require "test/unit"
 
+# Test Roger Cleaner
 class CleanerTest < ::Test::Unit::TestCase
-
   def setup
     @base = File.dirname(__FILE__) + "/../../project"
   end
 
   def test_use_array_as_pattern
-    dirs = ["dir1", "dir2"]
+    dirs = %w(dir1 dir2)
 
-    dirs.each do |dir|
-      path = @base + "/" +dir
-      mkdir path unless File.directory?(path)
-      assert(File.directory?(path))
-    end
+    create_and_assert_directories(dirs)
 
     project = Roger::Project.new(@base)
-    release = Roger::Release.new(project, :build_path => Pathname.new(@base))
+    release = Roger::Release.new(project, build_path: Pathname.new(@base))
 
     cleaner = Roger::Release::Cleaner.new(dirs)
     cleaner.call(release)
@@ -30,39 +26,47 @@ class CleanerTest < ::Test::Unit::TestCase
   end
 
   def test_only_clean_inside_build_path_relative
-  
     cleaner = Roger::Release::Cleaner.new(@base)
-    inside_build_path = cleaner.send :is_inside_build_path, @base, @base + "/html/formats"
+    inside_build_path = cleaner.send :inside_build_path?, @base, @base + "/html/formats"
 
     assert(inside_build_path, "Only delete content inside build_path")
-  end  
+  end
 
   def test_only_clean_inside_build_path_absolute
     path = Pathname.new(@base).realpath.to_s
     cleaner = Roger::Release::Cleaner.new(path)
 
-    inside_build_path = cleaner.send :is_inside_build_path, path, @base + "/html/formats"
+    inside_build_path = cleaner.send :inside_build_path?, path, @base + "/html/formats"
 
     assert(inside_build_path, "Only delete content inside build_path")
-  end  
+  end
 
-  
   def test_dont_clean_outside_build_path
     path = File.dirname(__FILE__)
     cleaner = Roger::Release::Cleaner.new(path)
 
     assert_raise RuntimeError do
-      inside_build_path = cleaner.send :is_inside_build_path, path, @base + "/html/formats"
+      cleaner.send :inside_build_path?, path, @base + "/html/formats"
     end
-
   end
-  
+
   def test_dont_fail_on_nonexistent_files
     path = "bla"
     cleaner = Roger::Release::Cleaner.new(path)
 
-    assert !cleaner.send(:is_inside_build_path, @base + "/html/formats", path), "Failed on nonexistent directories/files"
+    assert(
+      !cleaner.send(:inside_build_path?, @base + "/html/formats", path),
+      "Failed on nonexistent directories/files"
+    )
+  end
 
-  end  
+  protected
 
+  def create_and_assert_directories(dirs)
+    dirs.each do |dir|
+      path = @base + "/" + dir
+      mkdir path unless File.directory?(path)
+      assert(File.directory?(path))
+    end
+  end
 end

data/test/unit/release/finalizers/git_branch_test.rb

@@ -3,6 +3,7 @@ require "test/unit"
 require "mocha/test_unit"
 require "tmpdir"
 
+# Test for Roger GitBranchFinalizer
 class GitBranchTest < Test::Unit::TestCase
   def setup
     # Mock git repo
@@ -43,7 +44,7 @@ class GitBranchTest < Test::Unit::TestCase
 
     Dir.chdir(output_dir + "clone") do
       commit_msg = `git log --pretty=oneline --abbrev-commit`
-      assert_match /Release 0.1.999/, commit_msg
+      assert_match(/Release 0.1.999/, commit_msg)
     end
 
     FileUtils.rm_rf(output_dir)

data/test/unit/release/finalizers/zip_test.rb

@@ -0,0 +1,48 @@
+require "./lib/roger/release/finalizers/zip"
+require "test/unit"
+require "mocha/test_unit"
+require "tmpdir"
+
+# Test for Roger Zip finalizer
+class ZipTest < Test::Unit::TestCase
+  def setup
+    # Mock git repo
+    @tmp_dir = Pathname.new(Dir.mktmpdir)
+
+    project_path = @tmp_dir + "project"
+    FileUtils.mkdir(project_path)
+
+    @release_path = @tmp_dir + "releases"
+    FileUtils.mkdir(@release_path)
+
+    Dir.chdir(project_path) do
+      `git init`
+      `mkdir html`
+      `touch html/index.html`
+    end
+
+    # Mock release object
+    @release_mock = stub(project: stub(path: project_path))
+
+    @release_mock.stubs(
+      scm: stub(version: "1.0.0"),
+      log: true,
+      target_path: @release_path,
+      build_path: project_path + "html"
+    )
+  end
+
+  # called after every single test
+  def teardown
+    FileUtils.rm_rf(@tmp_dir)
+    @release_mock = nil
+  end
+
+  def test_basic_functionality
+    finalizer = Roger::Release::Finalizers::Zip.new
+
+    finalizer.call(@release_mock)
+
+    assert File.exist?(@release_path + "html-1.0.0.zip")
+  end
+end

data/test/unit/release/mockup_test.rb

@@ -0,0 +1,48 @@
+require "./lib/roger/release.rb"
+require "test/unit"
+
+# Test Roger Mockup
+class MockupTest < ::Test::Unit::TestCase
+  def setup
+    @base = File.dirname(__FILE__) + "/../../project"
+  end
+end
+
+# Test the target_path function of Mockup
+class MockupTargetPathTest < ::Test::Unit::TestCase
+  def setup
+    @base = File.dirname(__FILE__) + "/../../project"
+    @template = Roger::Template.open(@base + "/html/formats/erb.html.erb")
+    @processor = Roger::Release::Processors::Mockup.new
+  end
+
+  def test_with_html_extension
+    assert_equal "bla/test.html", @processor.target_path("bla/test.html", @template).to_s
+    assert_equal "test.html", @processor.target_path("test.html", @template).to_s
+  end
+
+  def test_with_double_extension
+    assert_equal "bla/test.html", @processor.target_path("bla/test.html.erb", @template).to_s
+    assert_equal "test.html", @processor.target_path("test.html.erb", @template).to_s
+    assert_equal "test.html", @processor.target_path("test.html.test", @template).to_s
+  end
+
+  def test_with_unknown_template_mime
+    assert_equal "bla/test.rhtml", @processor.target_path("bla/test.rhtml", @template).to_s
+    assert_equal "test.rhtml", @processor.target_path("test.rhtml", @template).to_s
+  end
+
+  def test_with_template_mime_with_existing_extension
+    template = Roger::Template.open(@base + "/html/formats/csv.rcsv")
+
+    assert_equal "bla/test.csv", @processor.target_path("bla/test.rcsv", template).to_s
+    assert_equal "test.csv", @processor.target_path("test.erb", template).to_s
+  end
+
+  def test_with_template_mime_without_existing_extension
+    template = Roger::Template.open(@base + "/html/formats/csv.rcsv")
+
+    assert_equal "bla/test.csv", @processor.target_path("bla/test", template).to_s
+    assert_equal "test.csv", @processor.target_path("test", template).to_s
+  end
+end