syro 3.0.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 26150785e6dd591e63f5e670b6dcc2a27dd01c08
-  data.tar.gz: ea5d9a93323838ee03e3ca140946cee52a8cf339
+SHA256:
+  metadata.gz: 91ee832b6435348393681438b2e8a167c1d5c56a3ebaaf494b4f3840b716adde
+  data.tar.gz: 3ba242a11056f3fd32da0b2198b9c10fa35e5c4f4db7217ec044fadf047f01b3
 SHA512:
-  metadata.gz: e07343b0890bf4820471ebe54a7947713956e506465b0b5eff37c42fbeb50b0bf0957f57693d34118b0dcbe40ccd669689d11d4f3263330f712bdb2a0eaf2739
-  data.tar.gz: 50a533a7933292c1b29fbcfd0bd8f8347128e7b6110ba97ce063939086cd86ffd52b2e4023e8800efee0aed43fa8f24a1a713a99317064140abbbdfc231acce6
+  metadata.gz: a4b4c73c4b4d731914a119a81b5bfc1154872f47343744532a0334525e0a2f978878015d1df11324376551c6617818193c0b6d462b9fbd54c3cd535b0a5ea78e
+  data.tar.gz: '0825e4cd946e7fba9d84907cce3442b53c158baaf2c0678864df1f0648b3834feb1976c1b62facdeb82e6fb172863958b432ba5ab7d067e26ce52bb3133ffea9'

data/.gems

@@ -1,4 +1,4 @@
 cutest -v 1.2.3
-rack -v 2.0.1
-seg -v 1.1.0
-rack-test -v 0.6.3
+seg -v 1.2.0
+rack -v 2.2.3
+rack-test -v 1.1.0

data/README.md

@@ -48,10 +48,10 @@ end
 
 The block is evaluated in a sandbox where the following methods are
 available: `env`, `req`, `res`, `path`, `inbox`, `call`, `run`,
-`halt`, `consume`, `capture`, `root?` `match`, `default`, `on`,
-`root`,`get`, `put`, `head`, `post`, `patch`, `delete` and `options`.
-Three other methods are available for customizations: `default_headers`,
-`request_class` and `response_class`.
+`halt`, `handle`, `finish!`, `consume`, `capture`, `root?` `match`,
+`default`, `on`, `root`,`get`, `put`, `head`, `post`, `patch`,
+`delete` and `options`. Three other methods are available for
+customizations: `default_headers`, `request_class` and `response_class`.
 
 As a recommendation, user created variables should be instance
 variables. That way they won't mix with the API methods defined in
@@ -83,6 +83,12 @@ argument.
 `halt`: Terminates the request. It receives an array with the
 response as per Rack's specification.
 
+`handle`: Installs a handler for a given status code. It receives
+a status code and a block that will be executed from `finish!`.
+
+`finish!`: Terminates the request by executing any installed handlers
+and then halting with the current value of `res.finish`.
+
 `consume`: Match and consume a path segment.
 
 `capture`: Match and capture a path segment. The value is stored in
@@ -93,7 +99,7 @@ the inbox.
 `match`: Receives a String, a Symbol or a boolean, and returns true
 if it matches the request.
 
-`default`: Receives a block that will be executed inconditionally.
+`default`: Receives a block that will be executed unconditionally.
 
 `on`: Receives a value to be matched, and a block that will be
 executed only if the request is matched.
@@ -254,6 +260,78 @@ post do
 end
 ```
 
+Handlers
+--------
+
+Status code handlers can be installed with the `handle` command,
+which receives a status code and a block to be executed just before
+finishing the request.
+
+By default, if there are no matches in a Syro application the
+response is a `404` with an empty body. If we decide to handle the
+`404` requests and return a string, we can do as follows:
+
+```ruby
+App = Syro.new do
+  handle 404 do
+    res.text "Not found!"
+  end
+
+  get do
+    res.text "Found!
+  end
+end
+```
+
+In this example, a `GET` request to `"/"` will return a status `200`
+with the body `"Found!"`. Any other request will return a `404`
+with the body `"Not found!"`.
+
+If a new handler is installed for the same status code, the previous
+handler is overwritten. A handler is valid in the current scope and
+in all its nested branches. Blocks that end before the handler is
+installed are not affected.
+
+This is a contrived example that shows some edge cases when using handlers:
+
+```ruby
+App = Syro.new do
+  on "foo" do
+    # 404, empty body
+  end
+
+  handle 404 do
+    res.text "Not found!"
+  end
+
+  on "bar" do
+    # 404, body is "Not found!"
+  end
+
+  on "baz" do
+    # 404, body is "Couldn't find baz"
+
+    handle 404 do
+      res.text "Couldn't find baz"
+    end
+  end
+end
+```
+
+A request to `"/foo"` will return a `404`, because the request
+method was not matched. But as the `on "foo"` block ends before the
+handler is installed, the result will be a blank screen. On the
+other hand, a request to `"/bar"` will return a `404` with the plain
+text `"Not found!"`.
+
+Finally, a request to `"/baz"` will return a `404` with the plain text
+`"Couldn't find baz"`, because by the time the `on "baz"` block ends
+a new handler is installed, and thus the previous one is overwritten.
+
+Any status code can be handled this way, even status `200`. In that
+case the handler will behave as a filter to be run after each
+successful request.
+
 Content type
 ------------
 
@@ -317,11 +395,11 @@ just use `Rack::Builder`:
 App = Rack::Builder.new do
   use Rack::Session::Cookie, secret: "..."
 
-  run Syro.new do
+  run Syro.new {
     get do
       res.write("Hello, world")
     end
-  end
+  }
 end
 ```
 

data/lib/syro.rb

@@ -209,11 +209,23 @@ class Syro
   end
 
   class Deck
-    module API
-      def initialize(code)
-        @syro_code = code
+
+    # Attaches the supplied block to a subclass of Deck as #dispatch!
+    # Returns the subclassed Deck.
+    def self.implement(&code)
+      Class.new(self) do
+        define_method(:dispatch!, code)
+        private :dispatch!
+
+        # Instead of calling inspect on this anonymous class,
+        # defer to the superclass which is likely Syro::Deck.
+        define_method(:inspect) do
+          self.class.superclass.inspect
+        end
       end
+    end
 
+    module API
       def env
         @syro_env
       end
@@ -268,9 +280,8 @@ class Syro
         @syro_inbox = inbox
 
         catch(:halt) do
-          instance_eval(&@syro_code)
-
-          @syro_res.finish
+          dispatch!
+          finish!
         end
       end
 
@@ -278,7 +289,7 @@ class Syro
         path, script = env[Rack::PATH_INFO], env[Rack::SCRIPT_NAME]
 
         env[Rack::PATH_INFO] = @syro_path.curr
-        env[Rack::SCRIPT_NAME] = @syro_path.prev
+        env[Rack::SCRIPT_NAME] = script.to_s + @syro_path.prev
         env[Syro::INBOX] = inbox
 
         halt(app.call(env))
@@ -297,6 +308,64 @@ class Syro
         throw(:halt, response)
       end
 
+      # Install a handler for a given status code. Once a handler is
+      # installed, it will be called by Syro before halting the
+      # request.
+      #
+      #     handle 404 do
+      #       res.text "Not found!"
+      #     end
+      #
+      # If a new handler is installed for the same status code, the
+      # previous handler is overwritten. A handler is valid in the
+      # current scope and in all its nested branches. Blocks that end
+      # before the handler is installed are not affected.
+      #
+      # For example:
+      #
+      #     on "foo" do
+      #       # Not found
+      #     end
+      #
+      #     handle 404 do
+      #       res.text "Not found!"
+      #     end
+      #
+      #     on "bar" do
+      #       # Not found
+      #     end
+      #
+      #     on "baz" do
+      #       # Not found
+      #
+      #       handle 404 do
+      #         res.text "Couldn't find baz"
+      #       end
+      #     end
+      #
+      # A request to "/foo" will return a 404, because the request
+      # method was not matched. But as the `on "foo"` block ends
+      # before the handler is installed, the result will be a blank
+      # screen. On the other hand, a request to "/bar" will return a
+      # 404 with the plain text "Not found!".
+      #
+      # Finally, a request to "/baz" will return a 404 with the plain text
+      # "Couldn't find baz", because by the time the `on "baz"` block ends
+      # a new handler is installed, and thus the previous one is overwritten.
+      #
+      # Any status code can be handled this way, even status `200`.
+      # In that case the handler will behave as a filter to be run
+      # after each successful request.
+      #
+      def handle(status, &block)
+        inbox[status] = block
+      end
+
+      def finish!
+        inbox[res.status]&.call
+        halt(res.finish)
+      end
+
       def consume(arg)
         @syro_path.consume(arg)
       end
@@ -319,7 +388,7 @@ class Syro
       end
 
       def default
-        yield; halt(res.finish)
+        yield; finish!
       end
 
       def on(arg)
@@ -363,11 +432,10 @@ class Syro
   end
 
   def initialize(deck = Deck, &code)
-    @deck = deck
-    @code = code
+    @deck = deck.implement(&code)
   end
 
   def call(env, inbox = env.fetch(Syro::INBOX, {}))
-    @deck.new(@code).call(env, inbox)
+    @deck.new.call(env, inbox)
   end
 end

data/syro.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "syro"
-  s.version           = "3.0.0"
+  s.version           = "3.2.1"
   s.summary           = "Simple router"
   s.description       = "Simple router for web applications"
   s.authors           = ["Michel Martens"]
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
 
   s.add_dependency "seg"
-  s.add_dependency "rack", "~> 2"
+  s.add_dependency "rack", ">= 1.6.0"
   s.add_development_dependency "cutest"
   s.add_development_dependency "rack-test"
 end

data/test/all.rb

@@ -79,6 +79,48 @@ comments = Syro.new do
   end
 end
 
+handlers = Syro.new do
+  on "without_handler" do
+    # Not found
+  end
+
+  handle(404) do
+    res.text "Not found!"
+  end
+
+  on "with_handler" do
+    # Not found
+  end
+
+  on "with_local_handler" do
+    handle(404) do
+      res.text "Also not found!"
+    end
+  end
+end
+
+path_info = Syro.new do
+  on "foo" do
+    get do
+      res.text req.path
+    end
+  end
+
+  get do
+    res.text req.path
+  end
+end
+
+script_name = Syro.new do
+  on "path" do
+    run(path_info)
+  end
+end
+
+exception = Syro.new do
+  get { res.text(this_method_does_not_exist) }
+end
+
 app = Syro.new do
   get do
     res.write "GET /"
@@ -194,6 +236,10 @@ app = Syro.new do
     run(json)
   end
 
+  on "handlers" do
+    run(handlers)
+  end
+
   on "private" do
     res.status = 401
     res.write("Unauthorized")
@@ -214,6 +260,14 @@ app = Syro.new do
   on "json" do
     res.json "json!"
   end
+
+  on "script" do
+    run(script_name)
+  end
+
+  on "exception" do
+    run(exception)
+  end
 end
 
 setup do
@@ -369,3 +423,38 @@ test "content type" do |f|
   f.get("/json")
   assert_equal "application/json", f.last_response.headers["Content-Type"]
 end
+
+test "status code handling" do |f|
+  f.get("/handlers")
+  assert_equal 404, f.last_response.status
+  assert_equal "text/plain", f.last_response.headers["Content-Type"]
+  assert_equal "Not found!", f.last_response.body
+
+  f.get("/handlers/without_handler")
+  assert_equal 404, f.last_response.status
+  assert_equal nil, f.last_response.headers["Content-Type"]
+  assert_equal "", f.last_response.body
+
+  f.get("/handlers/with_handler")
+  assert_equal 404, f.last_response.status
+  assert_equal "text/plain", f.last_response.headers["Content-Type"]
+  assert_equal "Not found!", f.last_response.body
+
+  f.get("/handlers/with_local_handler")
+  assert_equal 404, f.last_response.status
+  assert_equal "text/plain", f.last_response.headers["Content-Type"]
+  assert_equal "Also not found!", f.last_response.body
+end
+
+test "script name and path info" do |f|
+  f.get("/script/path")
+  assert_equal 200, f.last_response.status
+  assert_equal "/script/path", f.last_response.body
+end
+
+test "deck exceptions reference a named class" do |f|
+  f.get("/exception")
+rescue NameError => exception
+ensure
+  assert exception.to_s.include?("Syro::Deck")
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syro
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: seg
@@ -28,16 +28,16 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: cutest
   requirement: !ruby/object:Gem::Requirement
@@ -102,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Simple router