roger 0.13.0 → 1.0.0

data/lib/roger/server.rb

@@ -7,51 +7,52 @@ require 'webrick/https'
 
 module Roger
   class Server
-    
-    attr_reader :options, :server_options
-    
+
+    attr_reader :server_options
+
     attr_reader :project
-      
-    attr_accessor :port, :handler
-    
+
+    attr_accessor :port, :handler, :host
+
     def initialize(project, options={})
       @stack = initialize_rack_builder
-            
+
       @project = project
-      
+
       @server_options = {}
-      
+
+      # Defaults
+      self.port = 9000
+      self.handler = nil
+      self.host = "0.0.0.0"
+
       set_options(options)
     end
-    
+
     # Sets the options, this is a separate method as we want to override certain
     # things set in the mockupfile from the commandline
     def set_options(options)
-      @options = {
-        :handler => nil, # Autodetect
-        :port => 9000
-      }.update(options)
-            
-      self.port = @options[:port]
-      self.handler = @options[:handler]      
+      self.port = options[:port] if options.has_key?(:port)
+      self.handler = options[:handler] if options.has_key?(:handler)
+      self.host = options[:host] if options.has_key?(:host)
     end
-        
+
     # Use the specified Rack middleware
     #
     # @see ::Rack::Builder#use
     def use(*args, &block)
       @stack.use *args, &block
     end
-    
+
     # Use the map handler to map endpoints to certain urls
     #
-    # @see ::Rack::Builder#map    
+    # @see ::Rack::Builder#map
     def map(*args, &block)
       @stack.map *args, &block
     end
-            
+
     def run!
-      self.get_handler(self.handler).run self.application, self.server_options do |server|
+      self.handler.run self.application, self.server_options do |server|
         trap(:INT) do
           ## Use thins' hard #stop! if available, otherwise just #stop
           server.respond_to?(:stop!) ? server.stop! : server.stop
@@ -60,55 +61,67 @@ module Roger
       end
     end
     alias :run :run!
-    
+
     def port=(p)
-      self.server_options[:Port] = p
+      @port = self.server_options[:Port] = p
+    end
+
+    def host=(h)
+      @host = self.server_options[:Host] = h
     end
-        
+
+    def handler=(h)
+      if h.respond_to?(:run)
+        @handler = h
+      else
+        @handler = self.get_handler(h)
+      end
+    end
+
     protected
-    
+
     # Build the final application that get's run by the Rack Handler
     def application
       return @app if @app
-      
+
       @stack.run Rack::Roger.new(self.project)
-      
+
       @app = @stack
-    end    
-    
+    end
+
     # Initialize the Rack builder instance for this server
     #
     # @return ::Rack::Builder instance
     def initialize_rack_builder
-      builder = ::Rack::Builder.new 
+      builder = ::Rack::Builder.new
       builder.use ::Rack::ShowExceptions
       builder.use ::Rack::Lint
       builder.use ::Rack::ConditionalGet
-      builder.use ::Rack::Head      
-      
-      builder 
+      builder.use ::Rack::Head
+
+      builder
     end
-    
+
     # Get the actual handler for use in the server
     # Will always return a handler, it will try to use the fallbacks
     def get_handler(preferred_handler_name = nil)
       servers = %w[puma mongrel thin webrick]
       servers.unshift(preferred_handler_name) if preferred_handler_name
-      
+
       handler = nil
-      while((server_name = servers.shift) && handler === nil) do 
+      while((server_name = servers.shift) && handler === nil) do
         begin
           handler = ::Rack::Handler.get(server_name)
         rescue LoadError
         rescue NameError
         end
       end
-            
+
       if preferred_handler_name && server_name != preferred_handler_name
-        puts "Handler '#{preferred_handler_name}' not found, using fallback ('#{server_name}')."
+        puts "Handler '#{preferred_handler_name}' not found, using fallback ('#{handler.inspect}')."
       end
       handler
     end
-    
+
   end
 end

data/lib/roger/test.rb

@@ -1,4 +1,4 @@
-require 'thor'
+require "thor"
 require File.dirname(__FILE__) + "/helpers/get_callable"
 require File.dirname(__FILE__) + "/helpers/logging"
 
@@ -91,12 +91,16 @@ module Roger
 
     # 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
+    # @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. N.b. please add an exclamation mark
+    #                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
       if excludes.any?
-        files.reject{|c| excludes.detect{|e| e.match(c) } }
+        files.reject { |c| excludes.detect { |e| c.match(e) } }
       else
         files
       end

data/roger.gemspec

@@ -2,25 +2,25 @@
 
 Gem::Specification.new do |s|
   s.name = "roger"
-  s.version = "0.13.0"
-  
+  s.version = "1.0.0"
+
   s.authors = ["Flurin Egger", "Edwin van der Graaf", "Joran Kapteijns"]
-  s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  
+  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.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.require_paths = ["lib"]  
-  
+  s.require_paths = ["lib"]
+
   s.extra_rdoc_files = [
     "README.md"
   ] + `git ls-files -- {doc}/*`.split("\n")
-  
+
   s.rdoc_options = ["--charset=UTF-8"]
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
@@ -34,4 +34,5 @@ Gem::Specification.new do |s|
 
   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

data/test/helpers/cli.rb

@@ -0,0 +1,47 @@
+require "stringio"
+
+module Roger
+  module TestCli
+    # 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_command(args, &block)
+      out, err = capture do
+        Cli::Base.start(args, :debug => true)
+      end
+      [out,err]
+    end
+
+
+    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
+
+      project.mockupfile = mockupfile
+
+      Cli::Base.project = project
+
+      out, err = capture do
+        Cli::Base.start(args, :debug => true)
+      end
+      [out,err]
+    end
+
+  end
+end

data/test/project/Mockupfile

@@ -3,15 +3,12 @@ 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;
 
 mockup.project.partial_path = [mockup.project.path + "partials", mockup.project.path + "partials2"]
 
 mockup.serve do |s|
 end
 
-
-
 mockup.test do |t|
   t.use :noop
   t.use :fail

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

@@ -3,11 +3,12 @@ module RogerNoopTest
 
     def initialize(options={})
       @options = {}
-      @options.update(options) if options            
+      @options.update(options) if options
     end
 
     def call(test, options={})
       test.log(self, "NOOP")
+      test.debug(self, "NOOP DEBUG")
       true
     end
 

data/test/unit/cli/cli_generate_test.rb

@@ -0,0 +1,48 @@
+require "./lib/roger/cli.rb"
+require "test/unit"
+
+require File.dirname(__FILE__) + "/../../helpers/cli"
+
+# These tests ar for the roger generate command
+
+module CustomGens
+  module Generators
+
+    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?!"
+
+      def test
+        # Somewhat ugly way of checking
+        raise NotImplementedError
+      end
+    end
+
+    Roger::Generators.register :mocked, MockedGenerator
+  end
+end
+
+module Roger
+  class CliGenerateTest < ::Test::Unit::TestCase
+    include TestCli
+
+    def setup
+      @base_path = File.dirname(__FILE__) + "/../../project"
+    end
+
+    # roger generate
+    def test_has_generate_command
+      assert_includes Cli::Base.tasks.keys, "generate"
+    end
+
+    def test_help_shows_available_generators
+      out, err = run_command %w{help generate}
+
+      assert_includes out, "generate new"
+      assert_includes out, "generate mock"
+    end
+
+  end
+end

data/test/unit/cli/cli_serve_test.rb

@@ -0,0 +1,142 @@
+require "./lib/roger/cli.rb"
+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.
+  end
+end
+
+
+module Roger
+  class CliServeTest < ::Test::Unit::TestCase
+    include TestCli
+
+    def setup
+      @base_path = File.dirname(__FILE__) + "/../../project"
+    end
+
+    def teardown
+      Cli::Base.project = nil
+    end
+
+    # roger serve
+    def test_has_serve_command
+      assert_includes Cli::Base.tasks.keys, "serve"
+    end
+
+    # roger server
+    def test_serve_default_options
+      out, err = run_command(%w{serve})
+
+      assert_includes out, "9000"
+      assert_includes out, "0.0.0.0"
+      assert_includes out, "Puma"
+    end
+
+    def test_serve_with_custom_host
+      out, err = run_command(%w{serve --host=localhost})
+
+      assert_includes out, "9000"
+      assert_includes out, "localhost"
+      assert_includes out, "Puma"
+    end
+
+    def test_serve_with_custom_port
+      out, err = run_command(%w{serve --port=8888})
+
+      assert_includes out, "8888"
+      assert_includes out, "0.0.0.0"
+      assert_includes out, "Puma"
+    end
+
+    def test_serve_with_custom_handler
+      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
+
+  class CliServeWithMockupfileTest < ::Test::Unit::TestCase
+    include TestCli
+
+    def test_serve_with_port_in_mockupfile
+      out, err = run_command_with_mockupfile(%w{serve}) do |m|
+        m.serve do |s|
+          s.port = 9001
+        end
+      end
+
+      assert_includes out, "9001"
+      assert_includes out, "0.0.0.0"
+      assert_includes out, "Puma"
+    end
+
+    def test_serve_with_host_in_mockupfile
+      out, err = run_command_with_mockupfile(%w{serve}) do |m|
+        m.serve do |s|
+          s.host = "127.0.0.1"
+        end
+      end
+
+      assert_includes out, "9000"
+      assert_includes out, "127.0.0.1"
+      assert_includes out, "Puma"
+    end
+
+    def test_serve_with_handler_in_mockupfile
+      out, err = run_command_with_mockupfile(%w{serve}) do |m|
+        m.serve do |s|
+          s.handler = "webrick"
+        end
+      end
+
+      assert_includes out, "9000"
+      assert_includes out, "0.0.0.0"
+      assert_includes out, "WEBrick"
+    end
+
+    def test_serve_with_custom_port_should_override_mockupfile
+      out, err = run_command_with_mockupfile(%w{serve --port=9002}) do |m|
+        m.serve do |s|
+          s.port = 9001
+        end
+      end
+
+      assert_includes out, "9002"
+      assert_includes out, "0.0.0.0"
+      assert_includes out, "Puma"
+    end
+
+    def test_serve_with_custom_host_should_override_mockupfile
+      out, err = run_command_with_mockupfile(%w{serve --host=localhost}) do |m|
+        m.serve do |s|
+          s.host = "127.0.0.1"
+        end
+      end
+
+      assert_includes out, "9000"
+      assert_includes out, "localhost"
+      assert_includes out, "Puma"
+    end
+
+    def test_serve_with_custom_handler_should_override_mockupfile
+      out, err = run_command_with_mockupfile(%w{serve --handler=webrick}) do |m|
+        m.serve do |s|
+          s.handler = "puma"
+        end
+      end
+
+      assert_includes out, "9000"
+      assert_includes out, "0.0.0.0"
+      assert_includes out, "WEBrick"
+    end
+  end
+end