roger 1.1.3 → 1.2.1

data/lib/roger/test.rb

@@ -3,7 +3,9 @@ require File.dirname(__FILE__) + "/helpers/get_callable"
 require File.dirname(__FILE__) + "/helpers/logging"
 
 module Roger
+  # The test class itself
   class Test
+    # The Test CLI Thor command
     class Cli < Thor
       def self.exit_on_failure?
         true
@@ -17,9 +19,8 @@ module Roger
 
       desc "test", "Run the test"
       def test
-        unless Roger::Cli::Base.project.test.run_test!(self.class.stack_index)
-          raise Thor::Error, "The test failed"
-        end
+        ok = Roger::Cli::Base.project.test.run_test!(self.class.stack_index)
+        fail(Thor::Error, "The test failed") unless ok
       end
     end
 
@@ -33,10 +34,13 @@ module Roger
       # Register a test method to Roger::Test so it can be used in the Mockupfile
 
       def register(name, test, cli = nil)
-        raise ArgumentError, "Another test has already claimed the name #{name.inspect}" if self.map.has_key?(name)
-        raise ArgumentError, "Name must be a symbol" unless name.kind_of?(Symbol)
-        self.map[name] = test
-        self.cli_map[name] = cli if cli
+        if map.key?(name)
+          fail ArgumentError, "Another test has already claimed the name #{name.inspect}"
+        end
+
+        fail ArgumentError, "Name must be a symbol" unless name.is_a?(Symbol)
+        map[name] = test
+        cli_map[name] = cli if cli
       end
 
       # Mapping names to test callers
@@ -65,7 +69,7 @@ module Roger
     def use(processor, options = {})
       test = self.class.get_callable(processor, Roger::Test.map)
       if processor.is_a?(Symbol)
-        self.register_in_cli(processor, @stack.size, self.class.cli_map[processor])
+        register_in_cli(processor, @stack.size, self.class.cli_map[processor])
       end
       @stack << [test, options]
     end
@@ -104,7 +108,7 @@ module Roger
     #                if you wasted more then an hour of your life because the
     #                shell glob didn't 'work'.
     def get_files(globs, excludes = [])
-      files = globs.map{|g| Dir.glob(self.project.path + g) }.flatten
+      files = globs.map { |g| Dir.glob(project.path + g) }.flatten
       if excludes.any?
         files.reject { |c| excludes.detect { |e| c.match(e) } }
       else
@@ -115,7 +119,7 @@ module Roger
     protected
 
     def call_test(task)
-      if (task.kind_of?(Array))
+      if task.is_a?(Array)
         task[0].call(self, task[1])
       else
         task.call(self)
@@ -125,8 +129,8 @@ module Roger
     def register_in_cli(name, stack_index, klass)
       long_desc = "Run #{name} tests"
 
-      if klass && klass.kind_of?(Class) && klass <= Roger::Test::Cli
-        usage = "#{name} #{klass.arguments.map{ |arg| arg.banner }.join(" ")}"
+      if klass && klass.is_a?(Class) && klass <= Roger::Test::Cli
+        usage = "#{name} #{klass.arguments.map(&:banner).join(' ')}"
         thor_class = klass
       else
         usage = "#{name}"
@@ -138,7 +142,6 @@ module Roger
       end
 
       Roger::Cli::Test.register thor_class, name, usage, long_desc
-
     end
   end
 end

data/lib/roger/version.rb

@@ -1,3 +1,4 @@
+# Roger main namespace
 module Roger
-  VERSION = "1.1.3"
-end
+  VERSION = "1.2.1"
+end

data/roger.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 
-require_relative "lib/roger/version"
+require File.dirname(__FILE__) + "/lib/roger/version"
 
 Gem::Specification.new do |s|
   s.name = "roger"
@@ -10,13 +10,14 @@ Gem::Specification.new do |s|
   s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]
   s.homepage = "http://github.com/digitpaint/roger"
   s.summary = "Roger is a set of tools to create self-containing HTML mockups."
+  s.description = "See homepage for more information."
   s.licenses = ["MIT"]
 
   s.date = Time.now.strftime("%Y-%m-%d")
 
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.extra_rdoc_files = [
@@ -25,16 +26,19 @@ Gem::Specification.new do |s|
 
   s.rdoc_options = ["--charset=UTF-8"]
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new(">= 0")
+  end
 
   s.add_dependency("thor", ["~> 0.19.0"])
   s.add_dependency("rack", [">= 1.0.0"])
   s.add_dependency("tilt", ["~> 2.0.1"])
   s.add_dependency("mime-types", ["~> 2.2"])
-  s.add_dependency("hpricot", [">= 0.6.4"])
+  s.add_dependency("hpricot", ["= 0.8.4"])
   s.add_dependency("redcarpet", [">= 3.1.1"])
 
   s.add_development_dependency("test-unit", "~> 3.0.0")
   s.add_development_dependency("mocha", "~> 1.1.0")
   s.add_development_dependency("puma", "~> 2.10.0")
-end
+  s.add_development_dependency "rubocop", "~> 0.31.0"
+end

data/test/helpers/cli.rb

@@ -1,10 +1,12 @@
 require "stringio"
 
 module Roger
+  # Module with some helper functions for testing Roger CLI commands
   module TestCli
     # Capture stdout/stderr output
     def capture
-      @_orig_stdout, @_orig_stderr = $stdout, $stderr
+      @_orig_stdout = $stdout
+      @_orig_stderr = $stderr
 
       $stdout = StringIO.new
       $stderr = StringIO.new
@@ -13,35 +15,35 @@ module Roger
 
       return [$stdout.string, $stderr.string]
     ensure
-      $stdout, $stderr = @_orig_stdout, @_orig_stderr
+      $stdout = @_orig_stdout
+      $stderr = @_orig_stderr
     end
 
-    def run_command(args, &block)
+    def run_command(args, &_block)
       out, err = capture do
-        Cli::Base.start(args, :debug => true)
+        Cli::Base.start(args, debug: true)
       end
-      [out,err]
+      [out, err]
     end
 
-
-    def run_command_with_mockupfile(args, &block)
-      project = Project.new(@base_path || File.dirname(__FILE__) + "/../../project", :mockupfile_path => false)
+    def run_command_with_mockupfile(args, &_block)
+      project = Project.new(
+        @base_path || File.dirname(__FILE__) + "/../../project",
+        mockupfile_path: false
+      )
 
       mockupfile = Roger::Mockupfile.new(project)
 
-      if block_given?
-        yield(mockupfile)
-      end
+      yield(mockupfile) if block_given?
 
       project.mockupfile = mockupfile
 
       Cli::Base.project = project
 
       out, err = capture do
-        Cli::Base.start(args, :debug => true)
+        Cli::Base.start(args, debug: true)
       end
-      [out,err]
+      [out, err]
     end
-
   end
-end
+end

data/test/project/Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
-gem "roger", :path => File.dirname(__FILE__) + "/../../"
+gem "roger", path: File.dirname(__FILE__) + "/../../"
 gem "sass"
 gem "yui-compressor"
 gem "redcarpet"
-gem "pry"
+gem "pry"

data/test/project/lib/generators/test.rb

@@ -1,9 +1,8 @@
+# A Generator for testing purposes; doesn't do much
 class TestGenerator < Roger::Generators::Base
-
   def do
     puts "Done!"
   end
-
 end
 
-Roger::Generators.register TestGenerator
+Roger::Generators.register TestGenerator

data/test/project/lib/tests/fail/fail.rb

@@ -1,17 +1,16 @@
 module RogerFailTest
+  # A test that always fails
   class Test
-
-    def initialize(options={})
+    def initialize(options = {})
       @options = {}
-      @options.update(options) if options            
+      @options.update(options) if options
     end
 
-    def call(test, options={})
+    def call(test, _options = {})
       test.log(self, "Going to fail")
       false
     end
-
   end
 end
 
-Roger::Test.register :fail, RogerFailTest::Test
+Roger::Test.register :fail, RogerFailTest::Test

data/test/project/lib/tests/noop/lib/cli.rb

@@ -1,8 +1,9 @@
 module RogerNoopTest
+  # A CLI command for the Noop test. Doesn't do anything, just output "initialized"
   class Cli < Roger::Test::Cli
     desc "init", "init noop tests"
     def init
       puts "initialized"
     end
   end
-end
+end

data/test/project/lib/tests/noop/lib/test.rb

@@ -1,16 +1,16 @@
 module RogerNoopTest
+  # Noop test. Doesn't do anything except log a normal line and log a debug line
+  # Will always pass
   class Test
-
-    def initialize(options={})
+    def initialize(options = {})
       @options = {}
       @options.update(options) if options
     end
 
-    def call(test, options={})
+    def call(test, _options = {})
       test.log(self, "NOOP")
       test.debug(self, "NOOP DEBUG")
       true
     end
-
   end
-end
+end

data/test/project/lib/tests/noop/noop.rb

@@ -1,7 +1,8 @@
 require File.dirname(__FILE__) + "/lib/test"
 require File.dirname(__FILE__) + "/lib/cli"
 
+# RogerNoopTest namespace
 module RogerNoopTest
 end
 
-Roger::Test.register :noop, RogerNoopTest::Test, RogerNoopTest::Cli
+Roger::Test.register :noop, RogerNoopTest::Test, RogerNoopTest::Cli

data/test/project/lib/tests/succeed/succeed.rb

@@ -1,17 +1,16 @@
 module RogerSucceedTest
+  # A simple Roger test that will succeed
   class Test
-
-    def initialize(options={})
+    def initialize(options = {})
       @options = {}
-      @options.update(options) if options            
+      @options.update(options) if options
     end
 
-    def call(test, options={})
+    def call(test, _options = {})
       test.log(self, "Going to succeed")
       true
     end
-
   end
 end
 
-Roger::Test.register :succeed, RogerSucceedTest::Test
+Roger::Test.register :succeed, RogerSucceedTest::Test

data/test/unit/cli/cli_base_test.rb

@@ -2,8 +2,8 @@ require "./lib/roger/cli.rb"
 require "test/unit"
 
 module Roger
+  # Test for roger base commands
   class CliBaseTest < ::Test::Unit::TestCase
-
     def test_has_test_command
       assert_includes Cli::Base.tasks.keys, "test"
     end
@@ -23,6 +23,5 @@ module Roger
     def test_has_version_command
       assert_includes Cli::Base.tasks.keys, "version"
     end
-
   end
-end
+end

data/test/unit/cli/cli_generate_test.rb

@@ -3,20 +3,19 @@ require "test/unit"
 
 require File.dirname(__FILE__) + "/../../helpers/cli"
 
-# These tests ar for the roger generate command
-
+# CustomGenerators namespace
 module CustomGens
+  # The Generators namespace
   module Generators
-
+    # 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
 
@@ -25,6 +24,7 @@ module CustomGens
 end
 
 module Roger
+  # These tests ar for the roger generate command
   class CliGenerateTest < ::Test::Unit::TestCase
     include TestCli
 
@@ -38,11 +38,10 @@ module Roger
     end
 
     def test_help_shows_available_generators
-      out, err = run_command %w{help generate}
+      out, _err = run_command %w(help generate)
 
       assert_includes out, "generate new"
       assert_includes out, "generate mock"
     end
-
   end
-end
+end

data/test/unit/cli/cli_serve_test.rb

@@ -3,16 +3,20 @@ require "test/unit"
 
 require File.dirname(__FILE__) + "/../../helpers/cli"
 
-# These tests ar for the roger serve command
-
-class Roger::Cli::Serve
-  def start
-    # Let's not start it.
+module Roger
+  module Cli
+    # Overwrite Roger::Cli::Serve#start method as we don't want
+    # to actually start the server
+    class Serve
+      def start
+        # Let's not start it.
+      end
+    end
   end
 end
 
-
 module Roger
+  # These tests ar for the roger serve command
   class CliServeTest < ::Test::Unit::TestCase
     include TestCli
 
@@ -31,7 +35,7 @@ module Roger
 
     # roger server
     def test_serve_default_options
-      out, err = run_command(%w{serve})
+      out, _err = run_command(%w(serve))
 
       assert_includes out, "9000"
       assert_includes out, "0.0.0.0"
@@ -39,7 +43,7 @@ module Roger
     end
 
     def test_serve_with_custom_host
-      out, err = run_command(%w{serve --host=localhost})
+      out, _err = run_command(%w(serve --host=localhost))
 
       assert_includes out, "9000"
       assert_includes out, "localhost"
@@ -47,7 +51,7 @@ module Roger
     end
 
     def test_serve_with_custom_port
-      out, err = run_command(%w{serve --port=8888})
+      out, _err = run_command(%w(serve --port=8888))
 
       assert_includes out, "8888"
       assert_includes out, "0.0.0.0"
@@ -55,20 +59,20 @@ module Roger
     end
 
     def test_serve_with_custom_handler
-      out, err = run_command(%w{serve --handler=webrick})
+      out, _err = run_command(%w(serve --handler=webrick))
 
       assert_includes out, "9000"
       assert_includes out, "0.0.0.0"
       assert_includes out, "WEBrick"
     end
-
   end
 
+  # These tests ar for the roger serve command with a mockupfile config
   class CliServeWithMockupfileTest < ::Test::Unit::TestCase
     include TestCli
 
     def test_serve_with_port_in_mockupfile
-      out, err = run_command_with_mockupfile(%w{serve}) do |m|
+      out, _err = run_command_with_mockupfile(%w(serve)) do |m|
         m.serve do |s|
           s.port = 9001
         end
@@ -80,7 +84,7 @@ module Roger
     end
 
     def test_serve_with_host_in_mockupfile
-      out, err = run_command_with_mockupfile(%w{serve}) do |m|
+      out, _err = run_command_with_mockupfile(%w(serve)) do |m|
         m.serve do |s|
           s.host = "127.0.0.1"
         end
@@ -92,7 +96,7 @@ module Roger
     end
 
     def test_serve_with_handler_in_mockupfile
-      out, err = run_command_with_mockupfile(%w{serve}) do |m|
+      out, _err = run_command_with_mockupfile(%w(serve)) do |m|
         m.serve do |s|
           s.handler = "webrick"
         end
@@ -104,7 +108,7 @@ module Roger
     end
 
     def test_serve_with_custom_port_should_override_mockupfile
-      out, err = run_command_with_mockupfile(%w{serve --port=9002}) do |m|
+      out, _err = run_command_with_mockupfile(%w(serve --port=9002)) do |m|
         m.serve do |s|
           s.port = 9001
         end
@@ -116,7 +120,7 @@ module Roger
     end
 
     def test_serve_with_custom_host_should_override_mockupfile
-      out, err = run_command_with_mockupfile(%w{serve --host=localhost}) do |m|
+      out, _err = run_command_with_mockupfile(%w(serve --host=localhost)) do |m|
         m.serve do |s|
           s.host = "127.0.0.1"
         end
@@ -128,7 +132,7 @@ module Roger
     end
 
     def test_serve_with_custom_handler_should_override_mockupfile
-      out, err = run_command_with_mockupfile(%w{serve --handler=webrick}) do |m|
+      out, _err = run_command_with_mockupfile(%w(serve --handler=webrick)) do |m|
         m.serve do |s|
           s.handler = "puma"
         end
@@ -139,4 +143,4 @@ module Roger
       assert_includes out, "WEBrick"
     end
   end
-end
+end