roger 0.12.5 → 0.13.0

data/lib/roger/server.rb

@@ -1,8 +1,6 @@
 require 'rack'
 require File.dirname(__FILE__) + "/template"
-require File.dirname(__FILE__) + "/w3c_validator"
 require File.dirname(__FILE__) + "/rack/roger"
-require File.dirname(__FILE__) + "/rack/html_validator"      
 
 require 'webrick'
 require 'webrick/https'
@@ -73,7 +71,6 @@ module Roger
     def application
       return @app if @app
       
-      @stack.use Rack::HtmlValidator if self.options[:validate]
       @stack.run Rack::Roger.new(self.project)
       
       @app = @stack

data/lib/roger/test.rb

@@ -0,0 +1,134 @@
+require 'thor'
+require File.dirname(__FILE__) + "/helpers/get_callable"
+require File.dirname(__FILE__) + "/helpers/logging"
+
+module Roger
+  class Test
+    class Cli < Thor
+      def self.exit_on_failure?
+        true
+      end
+
+      default_task :test
+
+      class << self
+        attr_accessor :stack_index
+      end
+
+      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
+      end
+    end
+
+    include Roger::Helpers::Logging
+
+    attr_reader :config, :project
+
+    class << self
+      include Roger::Helpers::GetCallable
+
+      # 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
+      end
+
+      # Mapping names to test callers
+      def map
+        @_map ||= {}
+      end
+
+      # Mapping names to CLI handlers (this gives the option to add custom subcommands like 'init')
+      def cli_map
+        @_cli_map ||= {}
+      end
+    end
+
+    def initialize(project, config = {})
+      defaults = {}
+      
+      @config = {}.update(defaults).update(config)
+      @project = project
+      @stack = []
+    end    
+
+    # Use a certain test, this will also register it on the CLI
+    #
+    # @examples
+    #   test.use :jshint, config
+    def use(processor, options = {})
+      test = self.class.get_callable(processor, Roger::Test.map)
+      self.register_in_cli(processor, @stack.size, self.class.cli_map[processor])
+      @stack << [test, options]
+    end
+
+    # Run all tests and return true when succeeded
+    def run!
+      success = true
+      @stack.each do |task|
+        ret = call_test(task) # Don't put this on one line, you will fail... :)
+        success &&= ret
+      end
+
+      success
+    end
+
+    # Run a specific test by stack index.
+    def run_test!(index)
+      test = @stack[index]
+      if test
+        call_test(test) 
+      else
+        false
+      end
+    end
+
+    # Get files from the project path
+    #
+    # @param [Array] globs an array of file path globs that will be globbed against the project path
+    # @param [Array] excludes an array of regexps that will be excluded from the result
+    def get_files(globs, excludes = [])
+      files = globs.map{|g| Dir.glob(self.project.path + g) }.flatten
+      if excludes.any?
+        files.reject{|c| excludes.detect{|e| e.match(c) } }
+      else
+        files
+      end
+    end
+
+    protected
+
+    def call_test(task)
+      if (task.kind_of?(Array))
+        task[0].call(self, task[1])
+      else
+        task.call(self)
+      end
+    end
+
+    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(" ")}"
+        thor_class = klass
+      else
+        usage = "#{name}"
+        thor_class = Class.new(Roger::Test::Cli)
+      end
+
+      if thor_class.respond_to?(:stack_index=)
+        thor_class.stack_index = stack_index
+      end
+
+      Roger::Cli::Test.register thor_class, name, usage, long_desc
+
+    end
+  end
+end

data/roger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "roger"
-  s.version = "0.12.5"
+  s.version = "0.13.0"
   
   s.authors = ["Flurin Egger", "Edwin van der Graaf", "Joran Kapteijns"]
   s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  
@@ -25,13 +25,13 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
-  s.add_dependency("thor", ["~> 0.16.0"])
+  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("redcarpet", [">= 3.1.1"])
 
-  s.add_development_dependency("test-unit", "~> 2.5.5")
+  s.add_development_dependency("test-unit", "~> 3.0.0")
   s.add_development_dependency("mocha", "~> 1.1.0")
 end

data/test/Mockupfile-syntax.rb

@@ -1,18 +1,25 @@
-# Example idea for a Mockupfile, a lot of this has to have a sensible default.
+# Example for a Mockupfile, a lot of this has to have a sensible default.
 
 Sass::Plugin.options[:style] = :expanded
 Sass::Plugin.options[:template_location] = "./html/stylesheets"
 Sass::Plugin.options[:css_location] = "./html/stylesheets"
 
+# Set verbosity to true
+mockup.project.options[:verbose] = true
+
 # These are defaults, but can be set here
-# mockup.project.html_path = mockup.project.path + "html"
-# mockup.project.partial_path = mockup.project.path + "partials"
+mockup.project.html_path = mockup.project.path + "html"
+mockup.project.partial_path = mockup.project.path + "partials"
 
-mockup.serve(config) do |server|
+mockup.serve do |server|
   server.use :sass
 end
 
-mockup.release(config) do |release|
+mockup.test do |t|
+  t.use :jshint
+end
+
+mockup.release do |release|
   
   release.target_path # The target path where releases are put
   release.build_path # The path where the release gets built
@@ -28,16 +35,17 @@ mockup.release(config) do |release|
   release.scm.date # Get the git date
     
   # Create custom banner
-  release.banner do
-    "bla bla bla"
-  end
-  
+  #
   # The default banner looks like this:
   #
   # =======================
   # = Version : v1.0.0    =
   # = Date : 2012-06-20   =
-  # =======================  
+  # =======================    
+  release.banner do
+    "bla bla bla"
+  end
+  
   
   # Sassify CSS (this are the defaults too), all options except form :match and :skip are passed to Sass.compile_file
   # release.use :sass, :match => ["stylesheets/**/*.scss"], :skip => [/_.*\.scss\Z/], :style => :expanded

data/test/project/Mockupfile

@@ -1,4 +1,7 @@
 require File.dirname(__FILE__) + "/lib/generators/test"
+require File.dirname(__FILE__) + "/lib/tests/noop/noop"
+require File.dirname(__FILE__) + "/lib/tests/fail/fail"
+require File.dirname(__FILE__) + "/lib/tests/succeed/succeed"
 
 mockup.project.options[:verbose] = true;
 
@@ -7,10 +10,12 @@ mockup.project.partial_path = [mockup.project.path + "partials", mockup.project.
 mockup.serve do |s|
 end
 
-mockup.test do |t|
 
-  t.use :jshint
 
+mockup.test do |t|
+  t.use :noop
+  t.use :fail
+  t.use :succeed
 end
 
 mockup.release do |r|

data/test/project/html/formats/index.html

@@ -1 +1,10 @@
-Just an index.html
+<!doctype html>
+<html>
+  <head>
+    <title>Title</title>
+    <meta charset="utf-8">
+  </head>
+  <body>
+    Just an index.html
+  </body>
+</html>

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

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

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

@@ -0,0 +1,8 @@
+module RogerNoopTest
+  class Cli < Roger::Test::Cli
+    desc "init", "init noop tests"
+    def init
+      puts "initialized"
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module RogerNoopTest
+  class Test
+
+    def initialize(options={})
+      @options = {}
+      @options.update(options) if options            
+    end
+
+    def call(test, options={})
+      test.log(self, "NOOP")
+      true
+    end
+
+  end
+end

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

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

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

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

data/test/unit/cli/cli_base_test.rb

@@ -0,0 +1,24 @@
+require "./lib/roger/cli.rb"
+require "test/unit"
+
+module Roger
+  class CliBaseTest < ::Test::Unit::TestCase
+
+    def test_has_test_command
+      assert_includes Cli::Base.tasks.keys, "test"
+    end
+
+    def test_has_serve_command
+      assert_includes Cli::Base.tasks.keys, "serve"
+    end
+
+    def test_has_release_command
+      assert_includes Cli::Base.tasks.keys, "release"
+    end
+
+    def test_has_generate_command
+      assert_includes Cli::Base.tasks.keys, "generate"
+    end
+
+  end
+end

data/test/unit/cli/cli_test_test.rb

@@ -0,0 +1,142 @@
+require "./lib/roger/cli.rb"
+require "test/unit"
+require "stringio"
+
+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
+  class CliTestTest < ::Test::Unit::TestCase
+
+    def setup
+      @base_path = File.dirname(__FILE__) + "/../../project"
+    end
+
+
+    # Capture stdout/stderr output
+    def capture
+      @_orig_stdout, @_orig_stderr = $stdout, $stderr
+      
+      $stdout = StringIO.new
+      $stderr = StringIO.new
+
+      yield
+
+      return [$stdout.string, $stderr.string]
+    ensure
+      $stdout, $stderr = @_orig_stdout, @_orig_stderr
+    end
+
+    def run_test_command(args, &block)
+      project = Project.new(@base_path, :mockupfile_path => false)
+
+      mockupfile = Roger::Mockupfile.new(project)
+
+      if block_given?
+        mockupfile.test(&block)
+      else
+        mockupfile.test do |t|
+          t.use :succeed
+          t.use :noop
+        end
+      end
+
+      project.mockupfile = mockupfile
+
+      Cli::Base.project = project
+
+      capture do
+        Cli::Base.start(args, :debug => true)
+      end
+    end
+
+    def test_has_subcommand_all
+      assert_includes Cli::Base.tasks.keys, "test"
+    end
+
+    # roger test all
+    def test_subcommand_all_runs_all_tests
+      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|
+        t.use :succeed
+        t.use :noop
+      end
+      assert out.index("RogerNoopTest::Test") > out.index("RogerSucceedTest::Test") 
+    end    
+
+    def test_subcommand_all_runs_all_tests_in_order_2
+      out, err = run_test_command %w{test all} do |t|
+        t.use :noop
+        t.use :succeed        
+      end
+      assert out.index("RogerSucceedTest::Test") > out.index("RogerNoopTest::Test") 
+    end
+
+    # roger test
+    def test_default_runs_all_tests
+      out, err = run_test_command %w{test}
+      assert_includes out, "RogerNoopTest::Test"
+      assert_includes out, "RogerSucceedTest::Test"
+    end
+
+    # roger help test
+    def test_help_shows_available_subcommands
+      out, err = run_test_command %w{help test}
+      assert_includes out, "test all"
+      assert_includes out, "test succeed"
+      assert_includes out, "test noop"
+    end
+
+    # roger test noop
+    def test_subcommand_x_runs_only_test_x
+      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|
+          t.use :noop
+          t.use :fail
+        end
+      end
+    end
+
+    def test_subcommand_x_has_exit_code_0_on_success
+      assert_nothing_raised do
+        out, err = run_test_command %w{test noop} do |t|
+          t.use :noop
+          t.use :fail
+        end
+      end      
+    end
+
+    def test_subcommand_all_has_exit_code_1_on_failure
+      assert_raise(Thor::Error) do
+        out, err = run_test_command %w{test} do |t|
+          t.use :noop
+          t.use :fail
+        end
+      end
+    end
+
+    def test_subcommand_all_has_exit_code_0_on_success
+      assert_nothing_raised do
+        out, err = run_test_command %w{test} do |t|
+          t.use :noop
+          t.use :succeed
+        end
+      end         
+    end
+
+  end
+end