hobbit-contrib 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7605fffd9d4c2602f35c6556529d11bafb64883
-  data.tar.gz: 58af370162d53892f0f966e18b0fd8daaf49c1e7
+  metadata.gz: f338c24eef1f1138d3a0156b79bcad360882e454
+  data.tar.gz: dbbe040ee3d61f823fc4867b5baba1dc39d96d76
 SHA512:
-  metadata.gz: 9ccf2711a81fd56a5405cf9989843263261a8436d40e984b23e5b9500a3591f9a73dc25d597cb91507e847bfaeecb3f47b2903181b975a663cb17755f624d684
-  data.tar.gz: 239c9527fbdd4485e311414b319f75d7ba8764e64368dd28f72daafeb8c6449b5348ba0079f3335393cb1cb62aae3820bfb3e271bbe5876a07aacd374874b1ed
+  metadata.gz: 235309c1b90a30a6609fc691eea4b3a5f73f09a51d6883539087a0c5b5b894f94563f651129f24c40f746a23cf6fa82eb2110e6cf897e9f054346688aa2fdf7c
+  data.tar.gz: b2a5b5b597630b52aa930c81c4731c2054c518794cef2287cd8e9d4ab1b09331b422446d9808f0c1838803b37a971e4aa9336194d55dd8965d7723d2f16da0cd

data/README.md

@@ -24,6 +24,11 @@ Or install it yourself as:
 $ gem install hobbit-contrib
 ```
 
+### Optional dependencies
+
+* [mote](https://github.com/soveran/mote) if you want to use `Hobbit::Mote`.
+* [tilt](https://github.com/rtomayko/tilt) if you want to use `Hobbit::Render`.
+
 ## Usage
 
 Each extension may have its own usage. In general, including the module will be

data/Rakefile

@@ -2,8 +2,8 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << 'spec'
-  t.pattern = 'spec/**/*_spec.rb'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
 end
 
-task default: :test
+task default: :test

data/hobbit-contrib.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'codeclimate-test-reporter'
-  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'erubis'
+  spec.add_development_dependency 'mote'
+  spec.add_development_dependency 'oktobertest'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'tilt'
 
-  spec.add_runtime_dependency 'erubis'
   spec.add_runtime_dependency 'hobbit'
-  spec.add_runtime_dependency 'mote'
-  spec.add_runtime_dependency 'tilt'
 end

data/lib/hobbit/contrib.rb

@@ -2,6 +2,12 @@ require 'hobbit/contrib/version'
 require 'hobbit/environment'
 require 'hobbit/error_handling'
 require 'hobbit/filter'
-require 'hobbit/mote'
-require 'hobbit/render'
+begin
+  require 'hobbit/mote'
+rescue LoadError
+end
+begin
+  require 'hobbit/render'
+rescue LoadError
+end
 require 'hobbit/session'

data/lib/hobbit/contrib/version.rb

@@ -1,5 +1,5 @@
 module Hobbit
   module Contrib
-    VERSION = '0.5.2'
+    VERSION = '0.5.3'
   end
 end

data/lib/hobbit/mote.rb

@@ -2,9 +2,7 @@ require 'mote'
 
 module Hobbit
   module Mote
-    def self.included(othermod)
-      othermod.send :include, ::Mote::Helpers
-    end
+    include ::Mote::Helpers
 
     def default_layout
       "#{layouts_path}/application.mote"

data/test/environment_test.rb

@@ -0,0 +1,103 @@
+require 'helper'
+
+scope Hobbit::Environment do
+  setup do
+    mock_app do
+      include Hobbit::Environment
+    end
+  end
+
+  def with_env(environment)
+    env, ENV['RACK_ENV'] = ENV['RACK_ENV'], environment
+    yield
+    ENV['RACK_ENV'] = env
+  end
+
+  scope '::environment' do
+    test 'returns the current environment' do
+      with_env('development') do
+        assert app.to_app.class.environment == :development
+      end
+    end
+  end
+
+  scope '#environment' do
+    test 'returns the current environment' do
+      with_env('development') do
+        assert app.to_app.environment == :development
+      end
+    end
+  end
+
+  scope '::development?' do
+    test "returns true if ENV['RACK_ENV'] = :development" do
+      with_env('development') do
+        assert app.to_app.class.development? == true
+      end
+    end
+
+    test "returns false if ENV['RACK_ENV'] != :development" do
+      assert app.to_app.class.development? == false
+    end
+  end
+
+  scope '#development?' do
+    test "returns true if ENV['RACK_ENV'] = :development" do
+      with_env('development') do
+        assert app.to_app.development? == true
+      end
+    end
+
+    test "returns false if ENV['RACK_ENV'] != :development" do
+      assert app.to_app.development? == false
+    end
+  end
+
+  scope '::production?' do
+    test "returns true if ENV['RACK_ENV'] = :production" do
+      with_env('production') do
+        assert app.to_app.class.production? == true
+      end
+    end
+
+    test "returns false if ENV['RACK_ENV'] != :production" do
+      assert app.to_app.class.production? == false
+    end
+  end
+
+  scope '#production?' do
+    test "returns true if ENV['RACK_ENV'] = :production" do
+      with_env('production') do
+        assert app.to_app.production? == true
+      end
+    end
+
+    test "returns false if ENV['RACK_ENV'] != :production" do
+      assert app.to_app.production? == false
+    end
+  end
+
+  scope '::test?' do
+    test "returns true if ENV['RACK_ENV'] = :test" do
+      assert app.to_app.class.test? == true
+    end
+
+    test "returns false if ENV['RACK_ENV'] != :test" do
+      with_env('development') do
+        assert app.to_app.class.test? == false
+      end
+    end
+  end
+
+  scope '#test?' do
+    test "returns true if ENV['RACK_ENV'] = :test" do
+      assert app.to_app.test? == true
+    end
+
+    test "returns false if ENV['RACK_ENV'] != :test" do
+      with_env('development') do
+        assert app.to_app.test? == false
+      end
+    end
+  end
+end

data/{spec/error_handling_and_filter_spec.rb → test/error_handling_and_filter_test.rb}

@@ -1,11 +1,8 @@
-require 'minitest_helper'
+require 'helper'
 
-describe 'combine Hobbit::ErrorHandling and Hobbit::Filter' do
-  include Hobbit::Contrib::Mock
-  include Rack::Test::Methods
-
-  describe 'when the exception ocurrs in a route' do
-    let :app do
+scope 'combine Hobbit::ErrorHandling and Hobbit::Filter' do
+  scope 'when the exception ocurrs in a route' do
+    setup do
       mock_app do
         include Hobbit::Filter
         include Hobbit::ErrorHandling
@@ -29,17 +26,17 @@ describe 'combine Hobbit::ErrorHandling and Hobbit::Filter' do
       end
     end
 
-    it 'must call the before filter' do
+    test 'calls the before filter' do
       get '/'
-      last_response.must_be :ok?
-      last_response.body.must_equal 'Sorry'
-      last_request.env.must_include 'hobbit.before'
-      last_request.env.wont_include 'hobbit.after'
+      assert last_response.ok?
+      assert last_response.body == 'Sorry'
+      assert last_request.env.include? 'hobbit.before'
+      assert !last_request.env.include?('hobbit.after')
     end
   end
 
-  describe 'when the exception ocurrs in a before filter' do
-    let :app do
+  scope 'when the exception ocurrs in a before filter' do
+    setup do
       mock_app do
         include Hobbit::Filter
         include Hobbit::ErrorHandling
@@ -63,16 +60,16 @@ describe 'combine Hobbit::ErrorHandling and Hobbit::Filter' do
       end
     end
 
-    it 'must call the before filter' do
+    test 'calls the before filter' do
       get '/'
-      last_response.must_be :ok?
-      last_response.body.must_equal 'Sorry'
-      last_request.env.wont_include 'hobbit.after'
+      assert last_response.ok?
+      assert last_response.body == 'Sorry'
+      assert !last_request.env.include?('hobbit.after')
     end
   end
 
-  describe 'when the exception ocurrs in an after filter' do
-    let :app do
+  scope 'when the exception ocurrs in an after filter' do
+    setup do
       mock_app do
         include Hobbit::Filter
         include Hobbit::ErrorHandling
@@ -96,17 +93,17 @@ describe 'combine Hobbit::ErrorHandling and Hobbit::Filter' do
       end
     end
 
-    it 'must call the before filter' do
+    test 'calls the before filter' do
       get '/'
-      last_response.must_be :ok?
-      last_response.body.must_equal 'this is written in the body. Sorry'
-      last_request.env.must_include 'hobbit.before'
+      assert last_response.ok?
+      assert last_response.body == 'this is written in the body. Sorry'
+      assert last_request.env.include? 'hobbit.before'
     end
   end
 
-  describe 'the order of the modules inclusion matters' do
-    describe 'when ErrorHandling is included before Filter' do
-      let :app do
+  scope 'the order of the modules inclusion matters' do
+    scope 'when ErrorHandling is included before Filter' do
+      setup do
         mock_app do
           include Hobbit::ErrorHandling
           include Hobbit::Filter
@@ -130,14 +127,14 @@ describe 'combine Hobbit::ErrorHandling and Hobbit::Filter' do
         end
       end
 
-      it 'wont work as expected' do
+      test 'does not work as expected' do
         get '/'
-        last_response.must_be :ok?
-        last_response.body.must_equal 'Sorry'
-        last_request.env.must_include 'hobbit.before'
+        assert last_response.ok?
+        assert last_response.body == 'Sorry'
+        assert last_request.env.include? 'hobbit.before'
         # this is contrary to a previous test, which is not the desired workflow
         # or is it?
-        last_request.env.must_include 'hobbit.after'
+        assert last_request.env.include? 'hobbit.after'
       end
     end
   end

data/test/error_handling_test.rb

@@ -0,0 +1,136 @@
+require 'helper'
+
+scope Hobbit::ErrorHandling do
+  NotFoundError = Class.new StandardError
+  SpecificNotFoundError = Class.new NotFoundError
+  UnknownError = Class.new ScriptError
+  MustUseResponseError = Class.new StandardError
+
+  setup do
+    mock_app do
+      include Hobbit::ErrorHandling
+
+      error NotFoundError do
+        'Not Found'
+      end
+
+      error MustUseResponseError do
+        response.redirect '/'
+      end
+
+      error StandardError do
+        exception = env['hobbit.error']
+        exception.message
+      end
+
+      get '/' do
+        'hello'
+      end
+
+      get '/raises' do
+        raise RuntimeError, 'StandardError'
+        'not this'
+      end
+
+      get '/other_raises' do
+        raise NotFoundError
+        response.write 'not this'
+      end
+
+      get '/same_other_raises' do
+        raise SpecificNotFoundError
+        response.write 'not this'
+      end
+
+      get '/must_use_response' do
+        raise MustUseResponseError
+        response.write 'not this'
+      end
+    end
+  end
+
+  scope '::error' do
+    test do
+      p = Proc.new { 'error' }
+      app = mock_app do
+        include Hobbit::ErrorHandling
+        error StandardError, &p
+      end
+
+      assert app.to_app.class.errors.include? StandardError
+      assert app.to_app.class.errors[StandardError].call == p.call
+    end
+  end
+
+  scope '::errors' do
+    test 'returns a Hash' do
+      assert app.to_app.class.errors.kind_of? Hash
+    end
+  end
+
+  scope 'when does not raise exception' do
+    test 'works as expected' do
+      get '/'
+      assert last_response.ok?
+      assert last_response.body == 'hello'
+    end
+  end
+
+  scope 'when does raise an unknown exception class' do
+    test 'does not halt default propagation of the unknown class' do
+      mock_app do
+        get '/uncaught_raise' do
+          raise RuntimeError
+        end
+      end
+
+      assert_raises RuntimeError do
+        get '/uncaught_raise'
+      end
+    end
+  end
+
+  scope 'when raises a known exception class' do
+    test 'calls the block set in error' do
+      get '/raises'
+      assert last_response.ok?
+      assert last_response.body == 'StandardError'
+    end
+
+    test 'allows to define more than one exception' do
+      get '/other_raises'
+      assert last_response.ok?
+      assert last_response.body == 'Not Found'
+    end
+
+    test 'allows to define a general exception class to catch' do
+      get '/same_other_raises'
+      assert last_response.ok?
+      assert last_response.body == 'Not Found'
+    end
+
+    test 'sets the returned value of the error block as the body' do
+      get '/other_raises'
+      assert last_response.ok?
+      assert last_response.body == 'Not Found'
+      assert last_response.body != 'not this'
+    end
+
+    test 'overrides a previous block if a new one is passed' do
+      app.to_app.class.error StandardError do
+        'other handler!'
+      end
+
+      get '/raises'
+      assert last_response.ok?
+      assert last_response.body == 'other handler!'
+    end
+
+    test 'uses the response object' do
+      get '/must_use_response'
+      assert last_response.redirection?
+      follow_redirect!
+      assert last_response.body == 'hello'
+    end
+  end
+end

data/test/filter_test.rb

@@ -0,0 +1,273 @@
+require 'helper'
+
+scope Hobbit::Filter do
+  scope 'basic specs' do
+    setup do
+      mock_app do
+        include Hobbit::Filter
+
+        before do
+          env['hobbit.before'] = 'this is before'
+        end
+
+        get '/' do
+          'GET /'
+        end
+
+        after do
+          env['hobbit.after'] = 'this is after'
+        end
+      end
+    end
+
+    %w(after before).each do |kind|
+      str = <<EOS
+    scope '::#{kind}' do
+      test do
+        p = Proc.new { 'do something' }
+        app = mock_app do
+          include Hobbit::Filter
+          #{kind}('', &p)
+        end
+
+        assert app.to_app.class.filters[:#{kind}].size == 1
+        assert app.to_app.class.filters[:#{kind}].first[:block].call == p.call
+      end
+    end
+
+    scope 'when a filter matches' do
+      test "calls the filters' block" do
+        get '/'
+        assert last_response.ok?
+        assert last_request.env.include? 'hobbit.#{kind}'
+        assert last_request.env['hobbit.#{kind}'] == 'this is #{kind}'
+      end
+    end
+EOS
+      instance_eval str
+    end
+
+    scope '::filters' do
+      test 'returns a Hash' do
+        assert app.to_app.class.filters.kind_of? Hash
+      end
+    end
+
+    scope '::compile_filter' do
+      def block
+        Proc.new { |env| [200, {}, []] }
+      end
+
+      test 'compiles /' do
+        path = '/'
+        route = app.to_app.class.send :compile_filter, path, &block
+        assert route[:block].call({}) == block.call({})
+        assert route[:compiled_path].to_s == /^\/$/.to_s
+      end
+
+      test 'compiles with .' do
+        path = '/route.json'
+        route = app.to_app.class.send :compile_filter, path, &block
+        assert route[:block].call({}) == block.call({})
+        assert route[:compiled_path].to_s == /^\/route.json$/.to_s
+      end
+
+      test 'compiles with -' do
+        path = '/hello-world'
+        route = app.to_app.class.send :compile_filter, path, &block
+        assert route[:block].call({}) == block.call({})
+        assert route[:compiled_path].to_s == /^\/hello-world$/.to_s
+      end
+
+      test 'compiles with params' do
+        path = '/hello/:name'
+        route = app.to_app.class.send :compile_filter, path, &block
+        assert route[:block].call({}) == block.call({})
+        assert route[:compiled_path].to_s == /^\/hello\/([^\/?#]+)$/.to_s
+
+        path = '/say/:something/to/:someone'
+        route = app.to_app.class.send :compile_filter, path, &block
+        assert route[:block].call({}) == block.call({})
+        assert route[:compiled_path].to_s == /^\/say\/([^\/?#]+)\/to\/([^\/?#]+)$/.to_s
+      end
+
+      test 'compiles with . and params' do
+        path = '/route/:id.json'
+        route = app.to_app.class.send :compile_filter, path, &block
+        assert route[:block].call({}) == block.call({})
+        assert route[:compiled_path].to_s == /^\/route\/([^\/?#]+).json$/.to_s
+      end
+    end
+
+    test 'calls before and after filters' do
+      get '/'
+      assert last_response.ok?
+      assert last_request.env.include? 'hobbit.before'
+      assert last_request.env['hobbit.before'] == 'this is before'
+      assert last_request.env.include? 'hobbit.after'
+      assert last_request.env['hobbit.after'] == 'this is after'
+    end
+  end
+
+  scope 'filters with parameters' do
+    setup do
+      mock_app do
+        include Hobbit::Filter
+
+        before '/:name' do
+          env['hobbit.before'] = 'this is before'
+        end
+
+        after '/:name' do
+          env['hobbit.after'] = 'this is after'
+        end
+
+        get('/:name') { env['hobbit.before'] }
+      end
+    end
+
+    test 'calls the before and after filters' do
+      get '/hobbit'
+      assert last_response.ok?
+      assert last_request.env.include? 'hobbit.before'
+      assert last_request.env['hobbit.before'] == 'this is before'
+      assert last_request.env.include? 'hobbit.after'
+      assert last_request.env['hobbit.after'] == 'this is after'
+    end
+  end
+
+  scope 'when multiple filters are declared' do
+    setup do
+      mock_app do
+        include Hobbit::Filter
+
+        before do
+          env['hobbit.before'] = 'this will match'
+        end
+
+        before '/' do
+          env['hobbit.before'] = 'this wont match'
+        end
+
+        after do
+          env['hobbit.after'] = 'this will match'
+        end
+
+        after '/' do
+          env['hobbit.after'] = 'this wont match'
+        end
+
+        get('/') { 'GET /' }
+      end
+    end
+
+    test 'calls the first that matches' do
+      get '/'
+      assert last_response.ok?
+      assert last_request.env.include? 'hobbit.before'
+      assert last_request.env['hobbit.before'] == 'this will match'
+      assert last_request.env.include? 'hobbit.after'
+      assert last_request.env['hobbit.after'] == 'this will match'
+    end
+  end
+
+  scope 'when a before filter redirects the response' do
+    setup do
+      mock_app do
+        include Hobbit::Filter
+
+        before do
+          response.redirect '/goodbye' unless request.path_info == '/goodbye'
+        end
+
+        get '/' do
+          'hello world'
+        end
+
+        get '/goodbye' do
+          'goodbye world'
+        end
+      end
+    end
+
+    test 'redirects on before filters' do
+      get '/'
+      assert last_response.redirection?
+      follow_redirect!
+      assert last_response.ok?
+      assert last_response.body =~ /goodbye world/
+    end
+  end
+
+  scope 'when halting in a before filter' do
+    setup do
+      mock_app do
+        include Hobbit::Filter
+
+        before do
+          halt 401
+        end
+
+        get '/' do
+          'hello world'
+        end
+      end
+    end
+
+    test 'does not execute the route' do
+      get '/'
+      assert last_response.status == 401
+      assert last_response.body.empty?
+    end
+  end
+
+  scope 'when halting in a route' do
+    setup do
+      mock_app do
+        include Hobbit::Filter
+
+        before do
+          response.headers['Content-Type'] = 'text/plain'
+        end
+
+        after do
+          response.headers['Content-Type'] = 'application/json'
+        end
+
+        get '/' do
+          halt 401, 'Unauthenticated'
+        end
+      end
+    end
+
+    test 'does not execute the after filter' do
+      get '/'
+      assert last_response.status == 401
+      assert last_response.headers.include? 'Content-Type'
+      assert last_response.headers['Content-Type'] == 'text/plain'
+      assert last_response.body == 'Unauthenticated'
+    end
+  end
+
+  scope 'when halting in an after filter' do
+    setup do
+      mock_app do
+        include Hobbit::Filter
+
+        after do
+          halt 401
+        end
+
+        get '/' do
+          'hello world'
+        end
+      end
+    end
+
+    test 'does not execute the route' do
+      get '/'
+      assert last_response.status == 401
+      assert last_response.body == 'hello world'
+    end
+  end
+end