jellyfish 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be6525f7f0441a5863cd21be6c1e94ef5e9906b2
-  data.tar.gz: 00a83a35b93defbd52d8d4193f0298cc6009fda4
+SHA256:
+  metadata.gz: 8e0c9e8624941bd890772891cbccf23e550239f1f02789f52090d2835c46fb19
+  data.tar.gz: 586e35d54a86bfe6b9b4215259366eccaca536e5cb953251ead0c96f50010c02
 SHA512:
-  metadata.gz: 9b3020e8a013a1a95057f9c59eb7bc8a9b05dba6a5fed1462838d8edb76b4e1d37c2daa63344b049d658361c1d60c85e603ac6a3609964a7df17f07c83c5cae7
-  data.tar.gz: 6e7e67cd52e5b34c4c9859d2446d42a2c7de2ef5026bdf1bcb8150e0ffa646be740b4f4343a54eb9fe07b1be31e8a5a60a67bc857c50389f74a74b111b0e9f02
+  metadata.gz: 611380d2aedcac5ff8c85ab3ce00ea429d8151334628ef3bd216dd30606e7816178e6b8b3253e99dc8915f479ed9c3f93f0598e9bcc89101ddd15e681a3f1fbb
+  data.tar.gz: d3f4b682cb5913ba369b6e9e1ceb1b6a2bd20c5dc397e5d230c7741ab9c45dbbe0921e866ce1ec9acc4606d7e5253d6ef77146bb77537e6ffa7e3d5ea818d519

data/.travis.yml

@@ -1,15 +1,18 @@
 sudo: false
 language: ruby
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - rbx
-  - jruby-9
 
-before_install:
-  - rvm get head
-  - rvm reload
-  - rvm use --install $TRAVIS_RUBY_VERSION --binary --latest
-install: 'bundle install --retry=3'
+install: 'gem install bundler; bundle install --retry=3'
 script: 'ruby -vr bundler/setup -S rake test'
+
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: ruby-head
+    - rvm: jruby
+      env: JRUBY_OPTS=--debug
+    - rvm: rbx
+
+  allow_failures:
+    - rvm: rbx

data/CHANGES.md

@@ -1,5 +1,26 @@
 # CHANGES
 
+## Jellyfish 1.2.0 -- 2018-07-14
+
+### Incompatible changes
+
+* `Jellyfish::NewRelic` is extracted to
+  [jellyfish-contrib](https://github.com/godfat/jellyfish-contrib)
+
+### Bugs fixed
+
+* `Jellyfish::URLMap` would now properly handle nested maps like
+  `Rack::URLMap`.
+
+### Enhancements
+
+* `Jellyfish::URLMap` now supports listening on a specific host like
+  `Rack::URLMap`. Beside prefixing `http://`, it also supports passing
+  `host: host` argument to `map`, and a `listen` directive which takes a
+  block.
+* Instead of using `module_eval`, DSL is now defined via `define_method` to
+  make debugging easier. Performance shouldn't get hit.
+
 ## Jellyfish 1.1.1 -- 2015-12-22
 
 ### Enhancements

data/README.md

@@ -1,4 +1,4 @@
-# Jellyfish [![Build Status](https://secure.travis-ci.org/godfat/jellyfish.png?branch=master)](http://travis-ci.org/godfat/jellyfish) [![Coverage Status](https://coveralls.io/repos/godfat/jellyfish/badge.png)](https://coveralls.io/r/godfat/jellyfish) [![Join the chat at https://gitter.im/godfat/jellyfish](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/godfat/jellyfish)
+# Jellyfish [![Build Status](https://secure.travis-ci.org/godfat/jellyfish.png?branch=master)](http://travis-ci.org/godfat/jellyfish) [![Coverage Status](https://coveralls.io/repos/github/godfat/jellyfish/badge.png)](https://coveralls.io/github/godfat/jellyfish) [![Join the chat at https://gitter.im/godfat/jellyfish](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/godfat/jellyfish)
 
 by Lin Jen-Shin ([godfat](http://godfat.org))
 
@@ -9,6 +9,7 @@ by Lin Jen-Shin ([godfat](http://godfat.org))
 * [github](https://github.com/godfat/jellyfish)
 * [rubygems](https://rubygems.org/gems/jellyfish)
 * [rdoc](http://rdoc.info/github/godfat/jellyfish)
+* [issues](https://github.com/godfat/jellyfish/issues) (feel free to ask for support)
 
 ## DESCRIPTION:
 
@@ -179,13 +180,13 @@ run Tank.new
 ```
 
 <!---
-GET /lookup
+GET /lookup host
 body = File.read("#{File.dirname(
   File.expand_path(__FILE__))}/../lib/jellyfish/public/302.html").
-  gsub('VAR_URL', ':///')
+  gsub('VAR_URL', 'http://host/')
 [302,
  {'Content-Length' => body.bytesize.to_s, 'Content-Type' => 'text/html',
-  'Location' => ':///'},
+  'Location' => 'http://host/'},
  [body]]
 -->
 
@@ -238,7 +239,7 @@ body = case RUBY_ENGINE
        when 'jruby'
          "No one hears you: (eval):9:in `block in Tank'\n"
        when 'rbx'
-         "No one hears you: kernel/delta/kernel.rb:78:in `yell (method_missing)'\n"
+         "No one hears you: core/zed.rb:1370:in `yell (method_missing)'\n"
        else
          "No one hears you: (eval):9:in `block in <class:Tank>'\n"
        end
@@ -463,10 +464,8 @@ The followings are intentional:
 * `Jellyfish::URLMap` does not modify `env`, and it would call the app with
   another instance of Hash. Mutating data is a bad idea.
 
-* `Jellyfish::URLMap` does not try to match on host because I am not sure
-  if there's anyone would need this feature?
-
-* All other tests passed the same test suites for `Rack::Builder`.
+* All other tests passed the same test suites for `Rack::Builder` and
+  `Jellyfish::URLMap`.
 
 ``` ruby
 require 'jellyfish'
@@ -583,6 +582,100 @@ Comparison:
         Rack::URLMap:     1702.0 i/s - 36.66x slower
 ```
 
+#### Extension: Jellyfish::Builder#listen
+
+`listen` is a convenient way to define routing based on the host. We could
+also use `map` inside `listen` block. Here's a quick example that specifically
+listen on a particular host for long-polling and all other hosts would go to
+the default app.
+
+``` ruby
+require 'jellyfish'
+
+long_poll = lambda{ |env| [200, {}, ["long_poll #{env['HTTP_HOST']}\n"]] }
+fast_app  = lambda{ |env| [200, {}, ["fast_app  #{env['HTTP_HOST']}\n"]] }
+
+run Jellyfish::Builder.app{
+  listen 'slow-app' do
+    run long_poll
+  end
+
+  run fast_app
+}
+```
+
+<!---
+GET / slow-app
+[200, {}, ["long_poll slow-app\n"]]
+
+GET / fast-app
+[200, {}, ["fast_app  fast-app\n"]]
+-->
+
+##### Extension: Jellyfish::Builder#listen (`map path, host:`)
+
+Alternatively, we could pass `host` as an argument to `map` so that the
+endpoint would only listen on a specific host.
+
+``` ruby
+require 'jellyfish'
+
+long_poll = lambda{ |env| [200, {}, ["long_poll #{env['HTTP_HOST']}\n"]] }
+fast_app  = lambda{ |env| [200, {}, ["fast_app  #{env['HTTP_HOST']}\n"]] }
+
+run Jellyfish::Builder.app{
+  map '/', host: 'slow-app' do
+    run long_poll
+  end
+
+  run fast_app
+}
+```
+
+<!---
+GET / slow-app
+[200, {}, ["long_poll slow-app\n"]]
+
+GET / fast-app
+[200, {}, ["fast_app  fast-app\n"]]
+-->
+
+<!---
+GET / slow-app
+[200, {}, ["long_poll slow-app\n"]]
+
+GET / fast-app
+[200, {}, ["fast_app  fast-app\n"]]
+-->
+
+##### Extension: Jellyfish::Builder#listen (`map "http://#{path}"`)
+
+Or if you really prefer the `Rack::URLMap` compatible way, then you could
+just add `http://host` to your path prefix. `https` works, too.
+
+``` ruby
+require 'jellyfish'
+
+long_poll = lambda{ |env| [200, {}, ["long_poll #{env['HTTP_HOST']}\n"]] }
+fast_app  = lambda{ |env| [200, {}, ["fast_app  #{env['HTTP_HOST']}\n"]] }
+
+run Jellyfish::Builder.app{
+  map 'http://slow-app' do
+    run long_poll
+  end
+
+  run fast_app
+}
+```
+
+<!---
+GET / slow-app
+[200, {}, ["long_poll slow-app\n"]]
+
+GET / fast-app
+[200, {}, ["fast_app  fast-app\n"]]
+-->
+
 #### Extension: Jellyfish::Rewrite
 
 `Jellyfish::Builder` is mostly compatible with `Rack::Builder`, and
@@ -598,11 +691,11 @@ while leaving the `/users/list` as before. We may have this:
 ``` ruby
 require 'jellyfish'
 
-users_api    = lambda{ |env| [200, {}, ["users\n"]] }
-profiles_api = lambda{ |env| [200, {}, ["profiles\n"]] }
+users_api    = lambda{ |env| [200, {}, ["/users#{env['PATH_INFO']}\n"]] }
+profiles_api = lambda{ |env| [200, {}, ["/profiles#{env['PATH_INFO']}\n"]] }
 
 run Jellyfish::Builder.app{
-  rewrite '/users/me' => '/profiles/me' do
+  rewrite '/users/me' => '/me' do
     run profiles_api
   end
   map '/profiles' do
@@ -616,16 +709,16 @@ run Jellyfish::Builder.app{
 
 <!---
 GET /users/me
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/me\n"]]
 
 GET /users/list
-[200, {}, ["users\n"]]
+[200, {}, ["/users/list\n"]]
 
 GET /profiles/me
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/me\n"]]
 
 GET /profiles/list
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/list\n"]]
 -->
 
 This way, we would rewrite `/users/me` to `/profiles/me` and serve it with
@@ -639,11 +732,11 @@ Note that you could also use `map path, :to` if you prefer this API more:
 ``` ruby
 require 'jellyfish'
 
-users_api    = lambda{ |env| [200, {}, ["users\n"]] }
-profiles_api = lambda{ |env| [200, {}, ["profiles\n"]] }
+users_api    = lambda{ |env| [200, {}, ["/users#{env['PATH_INFO']}\n"]] }
+profiles_api = lambda{ |env| [200, {}, ["/profiles#{env['PATH_INFO']}\n"]] }
 
 run Jellyfish::Builder.app{
-  map '/users/me', to: '/profiles/me' do
+  map '/users/me', to: '/me' do
     run profiles_api
   end
   map '/profiles' do
@@ -657,16 +750,16 @@ run Jellyfish::Builder.app{
 
 <!---
 GET /users/me
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/me\n"]]
 
 GET /users/list
-[200, {}, ["users\n"]]
+[200, {}, ["/users/list\n"]]
 
 GET /profiles/me
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/me\n"]]
 
 GET /profiles/list
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/list\n"]]
 -->
 
 ##### Extension: Jellyfish::Rewrite (`rewrite rules`)
@@ -676,11 +769,11 @@ Note that `rewrite` takes a hash which could contain more than one rule:
 ``` ruby
 require 'jellyfish'
 
-profiles_api = lambda{ |env| [200, {}, ["profiles\n"]] }
+profiles_api = lambda{ |env| [200, {}, ["/profiles#{env['PATH_INFO']}\n"]] }
 
 run Jellyfish::Builder.app{
-  rewrite '/users/me' => '/profiles/me',
-          '/users/fa' => '/profiles/fa' do
+  rewrite '/users/me' => '/me',
+          '/users/fa' => '/fa' do
     run profiles_api
   end
 }
@@ -688,10 +781,10 @@ run Jellyfish::Builder.app{
 
 <!---
 GET /users/me
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/me\n"]]
 
 GET /users/fa
-[200, {}, ["profiles\n"]]
+[200, {}, ["/profiles/fa\n"]]
 -->
 
 ### Extension: NormalizedParams (with force_encoding)
@@ -742,34 +835,6 @@ GET /%E5%9B%A7
  ["/%E5%9B%A7=/\u{56e7}\n"]]
 -->
 
-### Extension: NewRelic
-
-``` ruby
-require 'jellyfish'
-class Tank
-  include Jellyfish
-  controller_include Jellyfish::NewRelic
-
-  get '/' do
-    "OK\n"
-  end
-end
-use Rack::ContentLength
-use Rack::ContentType, 'text/plain'
-require 'cgi' # newrelic dev mode needs this and it won't require it itself
-require 'new_relic/rack/developer_mode'
-use NewRelic::Rack::DeveloperMode # GET /newrelic to read stats
-run Tank.new
-NewRelic::Agent.manual_start(:developer_mode => true)
-```
-
-<!---
-GET /
-[200,
- {'Content-Length' => '3', 'Content-Type' => 'text/plain'},
- ["OK\n"]]
--->
-
 ### Extension: Using multiple extensions with custom controller
 
 Note that the controller should be assigned lastly in order to include
@@ -1158,13 +1223,13 @@ run Tank.new
 
 <!---
 GET /echo
-sock.string.should.eq <<-HTTP.chomp
+sock.string.should.eq <<-HTTP.chomp.force_encoding('ASCII-8BIT')
 HTTP/1.1 101 Switching Protocols\r
 Upgrade: websocket\r
 Connection: Upgrade\r
 Sec-WebSocket-Accept: Kfh9QIsMVZcl6xEPYxPHzW8SZ8w=\r
 \r
-\x81\u0003Hi!
+\x81\x03Hi!
 HTTP
 [200, {}, ['']]
 -->
@@ -1177,9 +1242,9 @@ HTTP
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2012-2015, Lin Jen-Shin (godfat)
+Copyright (c) 2012-2018, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,14 +1,14 @@
 
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
-  sh 'git submodule update --init'
+  sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
-Gemgem.init(dir) do |s|
+Gemgem.init(__dir__) do |s|
   require 'jellyfish/version'
   s.name    = 'jellyfish'
   s.version = Jellyfish::VERSION
-  %w[].each{ |g| s.add_runtime_dependency(g) }
+  s.files.delete('jellyfish.png')
 end

data/TODO.md

@@ -1 +1,3 @@
 # TODO
+
+Warn if the same route was defined again?

data/jellyfish.gemspec

@@ -1,76 +1,76 @@
 # -*- encoding: utf-8 -*-
-# stub: jellyfish 1.1.1 ruby lib
+# stub: jellyfish 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "jellyfish"
-  s.version = "1.1.1"
+  s.name = "jellyfish".freeze
+  s.version = "1.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2015-12-22"
-  s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middleware. Around 250 lines of code.\n\nCheck [jellyfish-contrib][] for extra extensions.\n\n[jellyfish-contrib]: https://github.com/godfat/jellyfish-contrib"
-  s.email = ["godfat (XD) godfat.org"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Lin Jen-Shin (godfat)".freeze]
+  s.date = "2018-07-14"
+  s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middleware. Around 250 lines of code.\n\nCheck [jellyfish-contrib][] for extra extensions.\n\n[jellyfish-contrib]: https://github.com/godfat/jellyfish-contrib".freeze
+  s.email = ["godfat (XD) godfat.org".freeze]
   s.files = [
-  ".gitignore",
-  ".gitmodules",
-  ".travis.yml",
-  "CHANGES.md",
-  "Gemfile",
-  "LICENSE",
-  "README.md",
-  "Rakefile",
-  "TODO.md",
-  "bench/bench_builder.rb",
-  "config.ru",
-  "jellyfish.gemspec",
-  "jellyfish.png",
-  "lib/jellyfish.rb",
-  "lib/jellyfish/builder.rb",
-  "lib/jellyfish/chunked_body.rb",
-  "lib/jellyfish/json.rb",
-  "lib/jellyfish/newrelic.rb",
-  "lib/jellyfish/normalized_params.rb",
-  "lib/jellyfish/normalized_path.rb",
-  "lib/jellyfish/public/302.html",
-  "lib/jellyfish/public/404.html",
-  "lib/jellyfish/public/500.html",
-  "lib/jellyfish/rewrite.rb",
-  "lib/jellyfish/test.rb",
-  "lib/jellyfish/urlmap.rb",
-  "lib/jellyfish/version.rb",
-  "lib/jellyfish/websocket.rb",
-  "task/README.md",
-  "task/gemgem.rb",
-  "test/rack/test_builder.rb",
-  "test/rack/test_urlmap.rb",
-  "test/sinatra/test_base.rb",
-  "test/sinatra/test_chunked_body.rb",
-  "test/sinatra/test_error.rb",
-  "test/sinatra/test_routing.rb",
-  "test/test_from_readme.rb",
-  "test/test_inheritance.rb",
-  "test/test_log.rb",
-  "test/test_misc.rb",
-  "test/test_rewrite.rb",
-  "test/test_threads.rb",
-  "test/test_websocket.rb"]
-  s.homepage = "https://github.com/godfat/jellyfish"
-  s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "Pico web framework for building API-centric web applications."
+  ".gitignore".freeze,
+  ".gitmodules".freeze,
+  ".travis.yml".freeze,
+  "CHANGES.md".freeze,
+  "Gemfile".freeze,
+  "LICENSE".freeze,
+  "README.md".freeze,
+  "Rakefile".freeze,
+  "TODO.md".freeze,
+  "bench/bench_builder.rb".freeze,
+  "config.ru".freeze,
+  "jellyfish.gemspec".freeze,
+  "lib/jellyfish.rb".freeze,
+  "lib/jellyfish/builder.rb".freeze,
+  "lib/jellyfish/chunked_body.rb".freeze,
+  "lib/jellyfish/json.rb".freeze,
+  "lib/jellyfish/normalized_params.rb".freeze,
+  "lib/jellyfish/normalized_path.rb".freeze,
+  "lib/jellyfish/public/302.html".freeze,
+  "lib/jellyfish/public/404.html".freeze,
+  "lib/jellyfish/public/500.html".freeze,
+  "lib/jellyfish/rewrite.rb".freeze,
+  "lib/jellyfish/test.rb".freeze,
+  "lib/jellyfish/urlmap.rb".freeze,
+  "lib/jellyfish/version.rb".freeze,
+  "lib/jellyfish/websocket.rb".freeze,
+  "task/README.md".freeze,
+  "task/gemgem.rb".freeze,
+  "test/rack/test_builder.rb".freeze,
+  "test/rack/test_urlmap.rb".freeze,
+  "test/sinatra/test_base.rb".freeze,
+  "test/sinatra/test_chunked_body.rb".freeze,
+  "test/sinatra/test_error.rb".freeze,
+  "test/sinatra/test_routing.rb".freeze,
+  "test/test_from_readme.rb".freeze,
+  "test/test_inheritance.rb".freeze,
+  "test/test_listen.rb".freeze,
+  "test/test_log.rb".freeze,
+  "test/test_misc.rb".freeze,
+  "test/test_rewrite.rb".freeze,
+  "test/test_threads.rb".freeze,
+  "test/test_websocket.rb".freeze]
+  s.homepage = "https://github.com/godfat/jellyfish".freeze
+  s.licenses = ["Apache-2.0".freeze]
+  s.rubygems_version = "2.7.7".freeze
+  s.summary = "Pico web framework for building API-centric web applications.".freeze
   s.test_files = [
-  "test/rack/test_builder.rb",
-  "test/rack/test_urlmap.rb",
-  "test/sinatra/test_base.rb",
-  "test/sinatra/test_chunked_body.rb",
-  "test/sinatra/test_error.rb",
-  "test/sinatra/test_routing.rb",
-  "test/test_from_readme.rb",
-  "test/test_inheritance.rb",
-  "test/test_log.rb",
-  "test/test_misc.rb",
-  "test/test_rewrite.rb",
-  "test/test_threads.rb",
-  "test/test_websocket.rb"]
+  "test/rack/test_builder.rb".freeze,
+  "test/rack/test_urlmap.rb".freeze,
+  "test/sinatra/test_base.rb".freeze,
+  "test/sinatra/test_chunked_body.rb".freeze,
+  "test/sinatra/test_error.rb".freeze,
+  "test/sinatra/test_routing.rb".freeze,
+  "test/test_from_readme.rb".freeze,
+  "test/test_inheritance.rb".freeze,
+  "test/test_listen.rb".freeze,
+  "test/test_log.rb".freeze,
+  "test/test_misc.rb".freeze,
+  "test/test_rewrite.rb".freeze,
+  "test/test_threads.rb".freeze,
+  "test/test_websocket.rb".freeze]
 end