hobby 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 866906249cfb187bc16dad3e74ddb38aac06fa32
-  data.tar.gz: 7f654e325e34a802370869c4713260df9f169756
+  metadata.gz: c943dce2451a4154082cfe2d8fc823273b28c627
+  data.tar.gz: 78ab9a63570bea6044c18307c8bb2cb7b355b935
 SHA512:
-  metadata.gz: 5aafd05f85c81e0d8af6ce2bbf9cfd9d0da3fd4bf7ff70ea7d1df7bc837eab50824c6a2222ff393974d8fb09b850e9b5fffa25c6c7b91796d6313fe542a7165e
-  data.tar.gz: 5cf2deda1c0d46698af9a9607cd9003ae6c98dffc4abc68c0a3b3799f6eb633b8edb0f02015a715a5e1674a428c8e88a0d24619676bcf946fd807c0651a2bf7b
+  metadata.gz: 12fc9f283cd851d77de6132caa8ac74401854547b2f0f2639726857327dcf01da99fc8a7e962c924a0f1a644645576c94f51544e596eac98bf280f0a6ce11f9c
+  data.tar.gz: 3bb0e84f2b8195a51dbbe61bb37d7caea77cfda4dcf02ccea9812a7c037d0ce2d43ee13bf0e4fc12638cb3e5512f8aa24a0ac330460907da70878107b8ddc339

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'devtools'
+gem 'devtools', github: 'mbj/devtools'
+gem 'mutant', github: 'mbj/mutant'
 gem 'minitest'
 gem 'minitest-power_assert'
 gem 'rack-test'

data/hobby.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'hobby'
-  spec.version       = '0.0.6'
+  spec.version       = '0.0.7'
   spec.authors       = ['Anatoly Chernow']
   spec.email         = ['chertoly@gmail.com']
   spec.summary       = %q{A minimal DSL over rack}

data/lib/hobby.rb

@@ -64,4 +64,8 @@ module Hobby
     def my
       env.fetch :path_params, {}
     end
+
+    def halt
+      throw :halt, response
+    end
 end

data/readme.adoc

@@ -0,0 +1,360 @@
+[[installation]]
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'hobby'
+# or this if you want to use hobby master
+# gem 'hobby', github: 'ch1c0t/hobby'
+----
+
+And then execute:
+
+[source,bash]
+----
+$ bundle
+----
+
+Or install it yourself as:
+
+[source,bash]
+----
+$ gem install hobby
+----
+
+[[introduction]]
+== Introduction
+
+Hobby features a Sinatra-like DSL, but in contrast to Sinatra,
+Hobby applications behave like usual Ruby classes.
+
+To create a Hobby application, you create a class and include `Hobby` in it.
+For example:
+
+[source,ruby]
+----
+require 'hobby'
+
+class C
+  include Hobby
+
+  get("/hello") {
+    "Hello, world."
+  }
+end
+----
+
+Then, you can create an instance of `C` with
+
+[source,ruby]
+----
+C.new
+----
+
+which will return a Rack application(an object which complies to 
+http://rubydoc.info/github/rack/rack/master/file/SPEC[Rack SPEC]).
+
+Because a Hobby application is just a Ruby class,
+you can do with it pretty much anything
+you would expect to be able to do with a Ruby class.
+
+[[using-initialize]]
+=== Using #initialize
+
+You can set some state in `#initialize` and then use it in the route's action:
+
+[source,ruby]
+----
+class C
+  include Hobby
+
+  def initialize name
+    @name = name
+  end
+
+  get("/hello") {
+    "Hello, #{@name}."
+  }
+end
+----
+
+[[using-intance-methods]]
+=== Using instance methods
+[source,ruby]
+----
+class C
+  include Hobby
+
+  def initialize name
+    @name = name
+  end
+
+  def name
+    @name.upcase
+  end
+
+  get("/hello") {
+    "Hello, #{name}."
+  }
+end
+----
+
+[[how-to-run]]
+=== How to run
+To run an application, you can put it into `config.ru`:
+
+[source,ruby]
+----
+run C.new 'Hobby'
+----
+
+and then use `rackup`:
+
+[source,bash]
+----
+$ rackup
+----
+
+Or, if you are using Rails, you can mount it in `config/routes.rb` with:
+[source,ruby]
+----
+mount C.new('Hobby') => '/some_path'
+----
+
+[[features]]
+Features
+~~~~~~~~
+
+* DSL inspired by http://www.sinatrarb.com/[Sinatra].
+* https://github.com/luislavena/bench-micro[Speed].
+* Extensible with standard ruby classes and modules, with no extra
+logic. See https://github.com/ch1c0t/hobby-auth[hobby-auth] and
+https://github.com/ch1c0t/hobby-json[hobby-json].
+* Zero configuration.
+
+[[routes]]
+== Routes
+
+For common HTTP verbs, Hobby provides the route definers(methods named accordingly):
+
+[source,ruby]
+----
+class App
+  include Hobby
+
+  get '/' do
+    # ...
+  end
+
+  post '/' do
+    # ...
+  end
+
+  put '/' do
+    # ...
+  end
+
+  patch '/' do
+    # ...
+  end
+
+  delete '/' do
+    # ...
+  end
+
+  options '/' do
+    # ...
+  end
+end
+----
+
+A definer should be called with a path(optional) and an action(passed as a block).
+
+Calling a definer has a side effect of defining a route in the router.
+When an incoming request matches a route,
+the action is executed and a response is sent back to the client.
+The return value of the action will be the `body` of the response.
+
+If a path was omitted
+[source,ruby]
+----
+get do
+  'The body returned to the HTTP client making the request.'
+end
+----
+
+the action is attached to the root route, like if
+[source,ruby]
+----
+get '/' do
+  'The body returned to the HTTP client making the request.'
+end
+----
+
+were called.
+
+
+[[default-methods]]
+== Default methods
+
+The following methods are predefined:
+
+* `env`: a `Hash`, http://www.rubydoc.info/github/rack/rack/master/file/SPEC#The_Environment[a Rack environment].
+* `request`: a http://www.rubydoc.info/gems/rack/Rack/Request[`Rack::Request`].
+* `response`: a http://www.rubydoc.info/gems/rack/Rack/Response[`Rack::Response`].
+* `my`: a `Hash` which stores route variables. See <<routes-with-variables>> for a usage example.
+* `halt`: returns the `response` immediately. See <<halting>> for a usage example.
+
+[[routes-with-variables]]
+=== Routes with variables
+
+[source,ruby]
+----
+class App
+  include Hobby
+  # matches both /hi/hobbit and /hi/patricio
+  get '/hi/:name' do
+    "Hello #{my[:name]}"
+  end
+end
+----
+
+[[halting]]
+=== Halting
+
+[source,ruby]
+----
+class App
+  include Hobby
+
+  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
+
+  def session
+    env['rack.session']
+  end
+
+  get '/' do
+    response.status = 401
+    halt
+    'This line is never going to be returned.'
+  end
+end
+----
+
+[[extensions]]
+== Extensions
+
+You can extend Hobby with usual modules:
+
+[source,ruby]
+----
+module MyExtension
+  def do_something
+    # do something
+  end
+end
+
+class App
+  include Hobby
+  include MyExtension
+
+  get '/' do
+    do_something
+    'Hello World!'
+  end
+end
+----
+
+[[available-extensions]]
+=== Available extensions
+
+* https://github.com/ch1c0t/hobby-json[hobby-json]: JSON requests and responses.
+* https://github.com/ch1c0t/hobby-auth[hobby-auth]: User authorization.
+
+
+[[using-rack-builder]]
+== Using Rack::Builder
+
+You can use `map` and `use` from http://www.rubydoc.info/gems/rack/Rack/Builder[Rack::Builder].
+
+[[mapping-applications]]
+=== Mapping applications
+
+You can mount any Rack application to a Hobby application with `map`.
+Here is an example of mounting the application from <<using-initialize>>
+to '/anatoly' and '/patricio' routes:
+
+[source,ruby]
+----
+class App
+  include Hobby
+
+  map('/anatoly') { run C.new 'Anatoly' }
+  map('/patricio') { run C.new 'Patricio' }
+
+  get '/' do
+    'Mapping app.'
+  end
+end
+----
+
+[[using-middleware]]
+=== Using middleware
+
+You can use any Rack middleware with `use`:
+
+[source,ruby]
+----
+class App
+  include Hobby
+
+  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
+  use Rack::ShowExceptions
+
+  def session
+    env['rack.session']
+  end
+
+  get '/' do
+    session[:name] = 'username'
+  end
+end
+----
+
+== Custom components
+
+Hobby was designed to be very modular.
+Many components of an application can be customized or replaced.
+
+[source,ruby]
+----
+class App
+  include Hobby
+
+  self.builder  = custom_builder
+  self.router   = custom_router
+  self.request  = custom_request
+  self.response = custom_response
+end
+----
+
+TODO: document the API which is expected from each of these components
+and provide usage examples.
+
+== Development
+
+To run the specs:
+
+[source,bash]
+----
+bundle exec rspec
+----
+
+To perform mutantion analysis:
+
+[source,bash]
+----
+bundle exec mutant --use rspec 'Hobby*'
+----

data/spec/app_spec.rb

@@ -150,7 +150,7 @@ describe Hobby::App do
       end
     end
 
-    describe Throw do
+    describe Halting do
       it do
         get '/'
         assert { last_response.status == 400 }

data/spec/apps/{Throw.rb → Halting.rb}

@@ -1,4 +1,5 @@
 get do
   response.status = 400
-  throw :halt, response
+  halt
+  response.status = 200
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hobby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Anatoly Chernow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,21 +36,21 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.md
 - Rakefile
 - hobby.gemspec
 - lib/hobby.rb
 - lib/hobby/router.rb
 - lib/hobby/router/route.rb
 - lib/hobby/router/routes.rb
+- readme.adoc
 - spec/app_spec.rb
 - spec/apps/Decorator.rb
 - spec/apps/Env.rb
+- spec/apps/Halting.rb
 - spec/apps/Main.rb
 - spec/apps/Map.rb
 - spec/apps/Nested.rb
 - spec/apps/OneRouteRouter.rb
-- spec/apps/Throw.rb
 - spec/apps/Use.rb
 - spec/apps/WithoutPath.rb
 - spec/helper.rb
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A minimal DSL over rack
@@ -84,11 +84,11 @@ test_files:
 - spec/app_spec.rb
 - spec/apps/Decorator.rb
 - spec/apps/Env.rb
+- spec/apps/Halting.rb
 - spec/apps/Main.rb
 - spec/apps/Map.rb
 - spec/apps/Nested.rb
 - spec/apps/OneRouteRouter.rb
-- spec/apps/Throw.rb
 - spec/apps/Use.rb
 - spec/apps/WithoutPath.rb
 - spec/helper.rb

data/README.md

@@ -1,378 +0,0 @@
-# Hobbit [![Build Status](http://img.shields.io/travis/patriciomacadden/hobbit.svg)](https://travis-ci.org/patriciomacadden/hobbit) [![Code Climate](http://img.shields.io/codeclimate/github/patriciomacadden/hobbit.svg)](https://codeclimate.com/github/patriciomacadden/hobbit) [![Code Climate Coverage](http://img.shields.io/codeclimate/coverage/github/patriciomacadden/hobbit.svg)](https://codeclimate.com/github/patriciomacadden/hobbit) [![Dependency Status](http://img.shields.io/gemnasium/patriciomacadden/hobbit.svg)](https://gemnasium.com/patriciomacadden/hobbit) [![Gem Version](http://img.shields.io/gem/v/hobbit.svg)](http://badge.fury.io/rb/hobbit)
-
-A minimalistic microframework built on top of [Rack](http://rack.github.io/).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'hobbit'
-# or this if you want to use hobbit master
-# gem 'hobbit', github: 'patriciomacadden/hobbit'
-```
-
-And then execute:
-
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-
-```bash
-$ gem install hobbit
-```
-
-## Features
-
-* DSL inspired by [Sinatra](http://www.sinatrarb.com/).
-* [Speed](https://github.com/luislavena/bench-micro).
-* Extensible with standard ruby classes and modules, with no extra logic. See
-[hobbit-contrib](https://github.com/patriciomacadden/hobbit-contrib).
-* Zero configuration.
-
-## Philosophy
-
-* [Don't repeat yourself](http://en.wikipedia.org/wiki/Don't_repeat_yourself)
-* Encourages the understanding and use of [Rack](http://rack.github.io/) and
-its extensions instead of providing such functionality.
-
-## Usage
-
-Hobbit applications are just instances of classes that inherits from
-`Hobbit::Base`, which complies the
-[Rack SPEC](http://rubydoc.info/github/rack/rack/master/file/SPEC).
-
-### Hello World example
-
-Create a file called `app.rb`:
-
-```ruby
-require 'hobbit'
-
-class App < Hobbit::Base
-  get '/' do
-    'Hello World!'
-  end
-end
-```
-
-Create a `config.ru` file:
-
-```ruby
-require './app'
-
-run App.new # or just `run App`
-```
-
-Run it with `rackup`:
-
-```bash
-$ rackup
-```
-
-View your app at [http://localhost:9292](http://localhost:9292).
-
-### Routes
-
-Every route is composed of a verb, a path (optional) and a block. When an
-incoming request matches a route, the block is executed and a response is sent
-back to the client. The return value of the block will be the `body` of the
-response. The `headers` and `status code` of the response will be calculated by
-`Hobbit::Response`, but you could modify it anyway you want it.
-
-See an example:
-
-```ruby
-class App < Hobbit::Base
-  get '/' do
-    # ...
-  end
-
-  post '/' do
-    # ...
-  end
-
-  put '/' do
-    # ...
-  end
-
-  patch '/' do
-    # ...
-  end
-
-  delete '/' do
-    # ...
-  end
-
-  options '/' do
-    # ...
-  end
-end
-```
-
-When a route gets called you have this methods available:
-
-* `env`: The Rack environment.
-* `request`: a `Hobbit::Request` instance.
-* `response`: a `Hobbit::Response` instance.
-
-And any other method defined in your application.
-
-#### Available methods
-
-* `delete`
-* `get`
-* `head`
-* `options`
-* `patch`
-* `post`
-* `put`
-
-**Note**: Since most browsers don't support methods other than **GET** and
-**POST** you must use the `Rack::MethodOverride` middleware. (See
-[Rack::MethodOverride](https://github.com/rack/rack/blob/master/lib/rack/methodoverride.rb)).
-
-#### Routes with parameters
-
-Besides the standard `GET` and `POST` parameters, you can have routes with
-parameters:
-
-```ruby
-require 'hobbit'
-
-class App < Hobbit::Base
-  # matches both /hi/hobbit and /hi/patricio
-  get '/hi/:name' do
-    # request.params is filled with the route paramters, like this:
-    "Hello #{request.params[:name]}"
-  end
-end
-```
-
-#### Redirecting
-
-If you look at Hobbit implementation, you may notice that there is no
-`redirect` method (or similar). This is because such functionality is provided
-by [Rack::Response](https://github.com/rack/rack/blob/master/lib/rack/response.rb)
-and for now we [don't wan't to repeat ourselves](http://en.wikipedia.org/wiki/Don't_repeat_yourself)
-(obviously you can create an extension!). So, if you want to redirect to
-another route, do it like this:
-
-```ruby
-require 'hobbit'
-
-class App < Hobbit::Base
-  get '/' do
-    response.redirect '/hi'
-  end
-
-  get '/hi' do
-    'Hello World!'
-  end
-end
-```
-
-#### Halting
-
-To immediately stop a request within route you can use `halt`. 
-
-```ruby
-require 'hobbit'
-
-class App < Hobbit::Base
-  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
-
-  def session
-    env['rack.session']
-  end
-
-  get '/' do
-    response.status = 401
-    halt response.finish
-  end
-end
-```
-
-### Built on top of rack
-
-Each Hobbit application is a Rack stack (See this
-[blog post](http://m.onkey.org/ruby-on-rack-2-the-builder) for more
-information).
-
-#### Mapping applications
-
-You can mount any Rack application to the stack by using the `map` class
-method:
-
-```ruby
-require 'hobbit'
-
-class InnerApp < Hobbit::Base
-  # gets called when path_info = '/inner'
-  get do
-    'Hello InnerApp!'
-  end
-end
-
-class App < Hobbit::Base
-  map('/inner') { run InnerApp.new }
-
-  get '/' do
-    'Hello App!'
-  end
-end
-```
-
-#### Using middleware
-
-You can add any Rack middleware to the stack by using the `use` class method:
-
-```ruby
-require 'hobbit'
-
-class App < Hobbit::Base
-  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
-  use Rack::ShowExceptions
-
-  def session
-    env['rack.session']
-  end
-
-  get '/' do
-    session[:name] = 'hobbit'
-  end
-
-  # more routes...
-end
-
-run App.new
-```
-
-### Security
-
-By default, Hobbit (nor Rack) comes without any protection against web
-attacks. The use of [rack-protection](https://github.com/rkh/rack-protection)
-is highly recommended:
-
-```ruby
-require 'hobbit'
-require 'rack/protection'
-require 'securerandom'
-
-class App < Hobbit::Base
-  use Rack::Session::Cookie, secret: SecureRandom.hex(64)
-  use Rack::Protection
-
-  get '/' do
-    'Hello World!'
-  end
-end
-```
-
-See the [rack-protection](https://github.com/rkh/rack-protection)
-documentation for futher information.
-
-### Testing
-
-[rack-test](https://github.com/brynary/rack-test) is highly recommended. See
-an example:
-
-In `app.rb`:
-
-```ruby
-require 'hobbit'
-
-class App < Hobbit::Base
-  get '/' do
-    'Hello World!'
-  end
-end
-```
-
-In `app_spec.rb`:
-
-```ruby
-require 'minitest/autorun'
-# imagine that app.rb and app_spec.rb are stored in the same directory
-require 'app'
-
-describe App do
-  include Rack::Test::Methods
-
-  def app
-    App.new
-  end
-
-  describe 'GET /' do
-    it 'must be ok' do
-      get '/'
-      last_response.must_be :ok?
-      last_response.body.must_match /Hello World!/
-    end
-  end
-end
-```
-
-See the [rack-test](https://github.com/brynary/rack-test) documentation
-for futher information.
-
-### Extensions
-
-You can extend Hobbit by creating standard ruby modules. See an example:
-
-```ruby
-module MyExtension
-  def do_something
-    # do something
-  end
-end
-
-class App < Hobbit::Base
-  include MyExtension
-
-  get '/' do
-    do_something
-    'Hello World!'
-  end
-end
-```
-
-#### Hobbit::Contrib
-
-[hobbit-contrib](https://github.com/patriciomacadden/hobbit-contrib) is a ruby
-gem that comes with a lot of hobbit extensions, such as:
-
-* `Hobbit::Render`: provides basic template rendering.
-* `Hobbit::Session`: provides helper methods for handling user sessions.
-* `Hobbit::Environment`: provides helper methods for handling application
-environments.
-* `Hobbit::Filter`: provides helper class methods for handling Sinatra-like
-filters.
-* `Hobbit::ErrorHandling`: provides helper class methods for handling
-Sinatra-like error handling.
-
-... And many more!
-
-## Community
-
-* [Wiki](https://github.com/patriciomacadden/hobbit/wiki): Guides, how-tos and recipes
-* IRC: [#hobbitrb](irc://chat.freenode.net/#hobbitrb) on [http://freenode.net](http://freenode.net)
-
-## Presentations
-
-* Building web applications in Ruby, by [Krzysztof Wawer](https://github.com/wafcio)
-([english](https://speakerdeck.com/wafcio/hobbit-english), [polish](https://speakerdeck.com/wafcio/hobbit))
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## License
-
-See the [LICENSE](https://github.com/patriciomacadden/hobbit/blob/master/LICENSE).