hobby 0.0.11 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: efd7204b29860fd75f5957d387a7e3471f29dc4f
-  data.tar.gz: 39171775abf2b781a075ca41dff0269ec2604b91
+SHA256:
+  metadata.gz: b95d5ad065324e903deb97971e990916ec1011e2353f50d0ab4c30f69607cecc
+  data.tar.gz: 0e2a747860c4d153fc418fbd1b1ed599847e419f80db6c31690c02b2097ea146
 SHA512:
-  metadata.gz: 27bd4fe6035a627fd69303caf363ada2a5a295a02358a0d6375a26d7aa8326a0072c49af4e6c93cb4ef4fddc19d93a929ee3091a61409b95a5b508d03ef95669
-  data.tar.gz: 246e802642e5e7ad4c29c71bf92f826e5553f5ec2c163dec42e8f14bbcd6f6f2dd7d459c8721b6e08fae38c36f0bc4f76c3588a29841b07a5acef362571cac03
+  metadata.gz: dbff581d827ea9eadd548378730262c9f4e0b9941cc25954c62455e90032698e6364e82dfc2e25ab7ab79efb919a3b2f2bfa34580cd9f853376b993821e5eedf
+  data.tar.gz: c030f1a411b5db33c080eb0b68c722ac9c362d5212fc3f60b88f61df007f47baa53a73e0e3b5d2e4e920331415095cec74f69cf5225fe3f4a73b80bc3496cdc3

data/.travis.yml

@@ -1,6 +1,7 @@
 ---
 language: ruby
 rvm:
+  - 2.5
   - 2.4
   - 2.3
 script: bundle exec rspec

data/Gemfile

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

data/hobby.gemspec

@@ -4,10 +4,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'hobby'
-  spec.version       = '0.0.11'
+  spec.version       = '0.1.3'
   spec.authors       = ['Anatoly Chernow']
   spec.email         = ['chertoly@gmail.com']
-  spec.summary       = %q{A minimal DSL over rack}
+  spec.summary       = %q{A professional way to create Rack applications.}
   spec.homepage      = 'https://github.com/ch1c0t/hobby'
   spec.license       = 'MIT'
 

data/lib/hobby.rb

@@ -2,6 +2,7 @@ require 'rack'
 require 'forwardable'
 
 require 'hobby/router'
+require 'hobby/helpers'
 
 module Hobby
   App = Hobby # to stay compatible with old code
@@ -9,20 +10,19 @@ module Hobby
 
   def self.included app
     app.extend Singleton
-    app.builder, app.router = Rack::Builder.new, Router.new
+    app.router = Router.new
     app.request, app.response = Rack::Request, Rack::Response
   end
 
   module Singleton
-    attr_accessor :builder, :router, :request, :response
+    attr_accessor :router, :request, :response
 
     def new (*)
-      builder.run super
-      builder.to_app
+      super.router.to_rack_app
     end
 
     extend Forwardable
-    delegate [:map, :use] => :builder
+    delegate [:map, :use] => :router
 
     VERBS.each do |verb|
       define_method verb.downcase do |path = '/', &action|
@@ -31,6 +31,8 @@ module Hobby
     end
   end
 
+  include Helpers
+
   def call env
     dup.handle env
   end
@@ -38,40 +40,15 @@ module Hobby
   protected
     def handle env
       catch :halt do
-        @route = self.class.router.route_for (@env = env)
-
-        body = route ? (instance_exec &route) : not_found
-        response.write body
-
-        response
+        @route = router.route_for (@env = env)
+        fill_body
+        response.to_a
       end
     end
 
   private
-    attr_reader :env, :route
-
-    def request
-      @request ||= self.class.request.new env
-    end
-
-    def response
-      @response ||= self.class.response.new
-    end
-
-    def my
-      route.params
-    end
-
-    def halt
-      throw :halt, response
-    end
-
-    def not_found
-      response.status = 404
-    end
-
-    def content_type type
-      mime_type = Rack::Mime::MIME_TYPES.fetch ".#{type}"
-      response.add_header 'Content-Type', mime_type
+    def fill_body
+      body = route ? (instance_exec &route) : not_found
+      response.write body
     end
 end

data/lib/hobby/helpers.rb

@@ -0,0 +1,50 @@
+module Hobby
+  module Helpers
+    extend Forwardable
+
+    attr_reader :env, :route
+
+    def router
+      @router ||= begin
+                    router = self.class.router.clone
+                    router.app = self
+                    router
+                  end
+    end
+
+    delegate [:map, :use] => :router
+
+    def request
+      @request ||= self.class.request.new env
+    end
+
+    def response
+      @response ||= self.class.response.new
+    end
+
+    def my
+      route.params
+    end
+
+    def halt
+      throw :halt, response.to_a
+    end
+
+    def not_found
+      response.status = 404
+    end
+
+    def content_type type
+      mime_type = Rack::Mime::MIME_TYPES.fetch ".#{type}"
+      response.add_header 'Content-Type', mime_type
+    end
+
+    def status status
+      response.status = status
+    end
+
+    def script_name
+      env.fetch 'SCRIPT_NAME'
+    end
+  end
+end

data/lib/hobby/router.rb

@@ -2,6 +2,11 @@ module Hobby
   class Router
     def initialize
       @routes = Routes.new
+      @uses, @maps = [], []
+    end
+
+    def initialize_copy _router
+      @uses, @maps = @uses.dup, @maps.dup
     end
 
     def add_route verb, path, &action
@@ -17,8 +22,33 @@ module Hobby
       route, params = @routes["#{env['REQUEST_METHOD']}#{env['PATH_INFO']}"]
       params ? route.with_params(params) : route
     end
+
+    def use *all
+      @uses << all
+    end
+
+    def map path, app = nil, &block
+      @maps << Builder::Map.new(path, app, &block)
+    end
+
+    attr_accessor :app
+
+    def to_rack_app
+      builder = create_builder
+      builder.run app
+      builder.to_app
+    end
+
+    private
+      def create_builder
+        builder = Builder.new
+        @uses.each { |all| builder.add_use *all }
+        @maps.each { |map| builder.add_map map }
+        builder
+      end
   end
 end
 
+require 'hobby/router/builder'
 require 'hobby/router/routes'
 require 'hobby/router/route'

data/lib/hobby/router/builder.rb

@@ -0,0 +1,25 @@
+module Hobby
+  class Router
+    class Builder < Rack::Builder
+      # To work around
+      # https://github.com/mbj/mutant#the-crash--stuck-problem-mri
+      alias add_use use
+      alias add_map2 map
+
+      def add_map map
+        if map.app
+          add_map2 map.path do run map.app end
+        else
+          add_map2 map.path, &map.block
+        end
+      end
+
+      class Map
+        attr_reader :path, :app, :block
+        def initialize path, app, &block
+          @path, @app, @block = path, app, block
+        end
+      end
+    end
+  end
+end

data/readme.adoc

@@ -27,8 +27,16 @@ $ gem install hobby
 [[introduction]]
 == Introduction
 
-Hobby features a Sinatra-like DSL, but in contrast to Sinatra,
-Hobby applications behave like usual Ruby classes.
+Hobby provides a Ruby DSL to create web applications. It is well suited both for standalone and inside-Rails use.
+
+The DSL looks a lot like Sinatra, but Hobby applications are
+
+* more reusable
+* more reliable
++
+The API and the codebase are much smaller and fully covered with specs. 100% mutation coverage is constantly maintained.
+* https://github.com/luislavena/bench-micro#requestssec[more performant]
+* https://github.com/luislavena/bench-micro#memory-allocationrequest[consume less resources]
 
 To create a Hobby application, you create a class and include `Hobby` in it.
 For example:
@@ -40,9 +48,9 @@ require 'hobby'
 class C
   include Hobby
 
-  get("/hello") {
+  get "/hello" do
     "Hello, world."
-  }
+  end
 end
 ----
 
@@ -74,9 +82,9 @@ class C
     @name = name
   end
 
-  get("/hello") {
+  get "/hello" do
     "Hello, #{@name}."
-  }
+  end
 end
 ----
 
@@ -95,9 +103,9 @@ class C
     @name.upcase
   end
 
-  get("/hello") {
+  get "/hello" do
     "Hello, #{name}."
-  }
+  end
 end
 ----
 
@@ -133,29 +141,12 @@ For common HTTP verbs, Hobby provides the route definers(methods named according
 class App
   include Hobby
 
-  get '/' do
-    # ...
-  end
-
-  post '/' do
-    # ...
-  end
-
-  put '/' do
-    # ...
-  end
-
-  patch '/' do
-    # ...
-  end
-
-  delete '/' do
-    # ...
-  end
-
-  options '/' do
-    # ...
-  end
+  get { 'Some string.' }
+  post { 'Some string.' }
+  put { 'Some string.' }
+  patch { 'Some string.' }
+  delete { 'Some string.' }
+  # TODO: find a good example for `options`
 end
 ----
 
@@ -285,8 +276,8 @@ to '/anatoly' and '/patricio' routes:
 class App
   include Hobby
 
-  map('/anatoly') { run C.new 'Anatoly' }
-  map('/patricio') { run C.new 'Patricio' }
+  map '/anatoly', C.new('Anatoly')
+  map '/patricio', C.new('Patricio')
 
   get '/' do
     'Mapping app.'
@@ -327,7 +318,6 @@ Many components of an application can be customized or replaced.
 class App
   include Hobby
 
-  self.builder  = custom_builder
   self.router   = custom_router
   self.request  = custom_request
   self.response = custom_response
@@ -346,9 +336,9 @@ To run the specs:
 bundle exec rspec
 ----
 
-To perform mutantion analysis:
+To perform mutation analysis:
 
 [source,bash]
 ----
-bundle exec mutant --use rspec 'Hobby*'
+bundle exec mutant --use rspec 'Hobby*' --include lib --require hobby
 ----

data/spec/app_spec.rb

@@ -75,6 +75,17 @@ describe Hobby::App do
     end
   end
 
+  describe '#router' do
+    it 'gives a distinct router to each app' do
+      app = Class.new { include Hobby }
+
+      first_instance = app.new
+      second_instance = app.new
+
+      assert { not first_instance.router.equal? second_instance.router }
+    end
+  end
+
   describe :integration do
     before do
       described_class.app = build_app described_class
@@ -89,6 +100,51 @@ describe Hobby::App do
         get '/map'
         assert { last_response.body == 'from map' }
       end
+
+      it 'mounts an application to the rack stack with old deprecated syntax' do
+        get '/deprecated_map'
+        assert { last_response.body == 'from deprecated map' }
+      end
+    end
+
+    describe MapInsideInitialize do
+      describe 'without any passed arguments' do
+        def app
+          described_class.app.new
+        end
+
+        it do
+          get '/'
+          assert { last_response.body == 'hello world' }
+          get '/first_map'
+          assert { last_response.body == 'first mapapp' }
+          get '/second_map'
+          assert { last_response.body == 'second mapapp' }
+        end
+      end
+
+      describe 'with passed routes' do
+        def app
+          some_app = Class.new {
+            include Hobby
+            get { 'Some string.' }
+          }
+          routes = { '/third_map' => some_app.new }
+          described_class.app.new routes
+        end
+
+        it do
+          get '/'
+          assert { last_response.body == 'hello world' }
+          get '/first_map'
+          assert { last_response.body == 'first mapapp' }
+          get '/second_map'
+          assert { last_response.body == 'second mapapp' }
+
+          get '/third_map'
+          assert { last_response.body == 'Some string.' }
+        end
+      end
     end
 
     describe Use do
@@ -98,6 +154,13 @@ describe Hobby::App do
       end
     end
 
+    describe UseInsideInitialize do
+      it do
+        get '/'
+        assert { last_response.content_type == 'application/json' }
+      end
+    end
+
     describe WithoutPath do
       it 'is accessible as /' do
         get '/'
@@ -163,5 +226,61 @@ describe Hobby::App do
         assert { last_response.headers['Content-Type'] == 'application/javascript' }
       end
     end
+
+    describe Status do
+      it do
+        get '/'
+        assert { last_response.status == 201 }
+        assert { last_response.body == 'Created.' }
+      end
+    end
+
+    describe UnshareableRouterMaps do
+      it do
+        get '/1/first'
+        assert { last_response.body == 'The name is A.' }
+        get '/1/second'
+        assert { last_response.body == 'The name is B.' }
+        get '/1/third'
+        assert { last_response.body == '404' }
+
+        get '/2/first'
+        assert { last_response.body == 'The name is A.' }
+        get '/2/second'
+        assert { last_response.body == 'The name is B.' }
+        get '/2/third'
+        assert { last_response.body == 'The name is C.' }
+
+        get '/3/first'
+        assert { last_response.body == 'The name is A.' }
+        get '/3/second'
+        assert { last_response.body == 'The name is B.' }
+        get '/3/third'
+        assert { last_response.body == '404' }
+      end
+    end
+
+    describe UnshareableRouterUses do
+      it do
+        get '/1'
+        assert { last_response.content_type == 'application/html' }
+        
+        get '/2'
+        assert { last_response.content_type == 'application/json' }
+
+        get '/3'
+        assert { last_response.content_type == 'application/html' }
+      end
+    end
+
+    describe ScriptName do
+      it do
+        get '/'
+        assert { last_response.body == '' }
+
+        get '/some/path'
+        assert { last_response.body == '/some/path' }
+      end
+    end
   end
 end

data/spec/apps/Map.rb

@@ -1,5 +1,5 @@
-map '/map' do
-  run Proc.new { |env| [200, {}, ['from map']] }
+map '/map', Proc.new { |env| [200, {}, ['from map']] }
+map '/deprecated_map' do
+  run Proc.new { |env| [200, {}, ['from deprecated map']] }
 end
-
 get('/') { 'hello world' }

data/spec/apps/MapInsideInitialize.rb

@@ -0,0 +1,13 @@
+first_app = Proc.new { |env| [200, {}, ['first mapapp']] }
+second_app = Proc.new { |env| [200, {}, ['second mapapp']] }
+
+map '/first_map', first_app
+map '/second_map', second_app
+
+get('/') { 'hello world' }
+
+def initialize hash = {}
+  hash.each do |route, app|
+    map route, app
+  end
+end

data/spec/apps/Nested.rb

@@ -1,17 +1,15 @@
-map('/nested') do
-  nested_app = Class.new do
-    include Hobby::App
+nested_app = Class.new do
+  include Hobby::App
 
-    def initialize first, second
-      @a = first
-      @b = second
-      @c = yield
-    end
-
-    get do
-      "#{@a}:#{@b}:#{@c}"
-    end
+  def initialize first, second
+    @a = first
+    @b = second
+    @c = yield
   end
 
-  run nested_app.new(:a, :b) { :c }
+  get do
+    "#{@a}:#{@b}:#{@c}"
+  end
 end
+
+map '/nested', nested_app.new(:a, :b) { :c }

data/spec/apps/OneRouteRouter.rb

@@ -5,4 +5,12 @@ self.router = Class.new {
   def route_for _request
     -> { 'for any route' }
   end
+
+  attr_accessor :app
+
+  def to_rack_app
+    builder = Rack::Builder.new
+    builder.run app
+    builder.to_app
+  end
 }.new

data/spec/apps/ScriptName.rb

@@ -0,0 +1,12 @@
+get do
+  script_name
+end
+
+app = Class.new do
+  include Hobby
+  get do
+    script_name
+  end
+end
+
+map '/some/path', app.new

data/spec/apps/Status.rb

@@ -0,0 +1,4 @@
+get do
+  status 201
+  'Created.'
+end

data/spec/apps/UnshareableRouterMaps.rb

@@ -0,0 +1,29 @@
+mapped_app = Class.new do
+  include Hobby
+
+  def initialize name
+    @name = name
+  end
+  
+  get { "The name is #{@name}." }
+end
+
+mapping_app = Class.new do
+  include Hobby
+
+  map '/first', mapped_app.new('A')
+  map '/second', mapped_app.new('B')
+
+  def initialize routes = {}
+    routes.each do |route, app|
+      map route, app
+    end
+  end
+end
+
+map '/1', mapping_app.new
+
+routes = { '/third' => mapped_app.new('C') }
+map '/2', mapping_app.new(routes)
+
+map '/3', mapping_app.new

data/spec/apps/UnshareableRouterUses.rb

@@ -0,0 +1,16 @@
+require 'json'
+
+app = Class.new do
+  include Hobby
+  get { 'hello world'.to_json }
+
+  use Rack::ContentType, 'application/html'
+
+  def initialize middleware_with_arguments = nil
+    use *middleware_with_arguments if middleware_with_arguments
+  end
+end
+
+map '/1', app.new
+map '/2', app.new([Rack::ContentType, 'application/json'])
+map '/3', app.new

data/spec/apps/UseInsideInitialize.rb

@@ -0,0 +1,7 @@
+require 'json'
+
+get { 'hello world'.to_json }
+
+def initialize
+  use Rack::ContentType, 'application/json'
+end

data/spec/helper.rb

@@ -1,19 +1,19 @@
 require 'devtools/spec_helper'
 
 require 'hobby'
+require_relative 'mutant_patches' if defined? Mutant
 
 require 'minitest'
 require 'minitest-power_assert'
 Minitest::Assertions.prepend Minitest::PowerAssert::Assertions
 
-if defined? Mutant
-  class Mutant::Selector::Expression
-    def call _subject
-      integration.all_tests
-    end
+module EnvFor
+  def env_for path, verb = 'GET'
+    {'REQUEST_METHOD' => verb, 'PATH_INFO' => path }
   end
 end
 
 RSpec.configure do |config|
   config.expect_with :rspec, :minitest
+  config.include EnvFor
 end

data/spec/mutant_patches.rb

@@ -0,0 +1,27 @@
+# Run all the specs for any subject.
+class Mutant::Selector::Expression
+  def call _subject
+    integration.all_tests
+  end
+end
+
+# Do not silence stdout and stderr of the running mutation.
+class Mutant::Isolation::Fork
+  def result
+    yield
+  end
+end
+
+# Print the source of the current mutation.
+class Mutant::Loader
+  def call
+    source = Unparser.unparse node
+
+    puts <<~S
+      Current mutation:
+      #{source}
+    S
+
+    kernel.eval source, binding, subject.source_path.to_s, subject.source_line
+  end
+end

data/spec/router_matchers.rb

@@ -2,10 +2,6 @@ module RouterMatchers
   extend self
   SOME_ROUTE = ->{:some_route}
 
-  def env_for path, verb = 'GET'
-    {'REQUEST_METHOD' => verb, 'PATH_INFO' => path }
-  end
-
   def add_routes *routes
     routes.each { |route| subject.add_route 'GET', route, &SOME_ROUTE }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hobby
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.3
 platform: ruby
 authors:
 - Anatoly Chernow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-01 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -33,13 +33,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG.md
 - Gemfile
 - LICENSE
-- Rakefile
 - hobby.gemspec
 - lib/hobby.rb
+- lib/hobby/helpers.rb
 - lib/hobby/router.rb
+- lib/hobby/router/builder.rb
 - lib/hobby/router/route.rb
 - lib/hobby/router/routes.rb
 - readme.adoc
@@ -50,11 +50,18 @@ files:
 - spec/apps/Halting.rb
 - spec/apps/Main.rb
 - spec/apps/Map.rb
+- spec/apps/MapInsideInitialize.rb
 - spec/apps/Nested.rb
 - spec/apps/OneRouteRouter.rb
+- spec/apps/ScriptName.rb
+- spec/apps/Status.rb
+- spec/apps/UnshareableRouterMaps.rb
+- spec/apps/UnshareableRouterUses.rb
 - spec/apps/Use.rb
+- spec/apps/UseInsideInitialize.rb
 - spec/apps/WithoutPath.rb
 - spec/helper.rb
+- spec/mutant_patches.rb
 - spec/router_matchers.rb
 - spec/router_spec.rb
 homepage: https://github.com/ch1c0t/hobby
@@ -76,11 +83,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A minimal DSL over rack
+summary: A professional way to create Rack applications.
 test_files:
 - spec/app_spec.rb
 - spec/apps/ContentType.rb
@@ -89,10 +95,17 @@ test_files:
 - spec/apps/Halting.rb
 - spec/apps/Main.rb
 - spec/apps/Map.rb
+- spec/apps/MapInsideInitialize.rb
 - spec/apps/Nested.rb
 - spec/apps/OneRouteRouter.rb
+- spec/apps/ScriptName.rb
+- spec/apps/Status.rb
+- spec/apps/UnshareableRouterMaps.rb
+- spec/apps/UnshareableRouterUses.rb
 - spec/apps/Use.rb
+- spec/apps/UseInsideInitialize.rb
 - spec/apps/WithoutPath.rb
 - spec/helper.rb
+- spec/mutant_patches.rb
 - spec/router_matchers.rb
 - spec/router_spec.rb

data/CHANGELOG.md

@@ -1,53 +0,0 @@
-# 0.6.0
-
-* Change the implementation of `Hobbit::Base#halt`. This new implementation is
-more rack compliant.
-* Test hobbit with [oktobertest](https://github.com/patriciomacadden/oktobertest)
-instead of minitest (Because reasons!).
-
-# 0.5.1 (Unreleased)
-
-* A class is an object too, so allow to `run` classes.
-* Add `Hobbit::Request`, which sets the path info to `/` if its empty (instead
-of doing that on the call method).
-
-# 0.5.0
-
-* Refactor `Hobbit::Base#halt`. It now sets the status, merges the headers and
-writes the body (using `Hobbit::Response#write`) when given a fixnum, a hash or
-a string.
-* `Hobbit::Response` headers and body are not accessors anymore. This is
-because when you set the body directly, the `Content-Length` is not calculated
-(it's calculated on `#write`).
-
-# 0.4.4
-
-* Refactor `Hobbit::Response`.
-
-# 0.4.3
-
-* Calculate the `Content-Length` of a `Hobbit::Response` using `#bytesize`
-instead of `#size`.
-
-# 0.4.2
-
-* Add `Hobbit::Response#redirect`, that was missing since `Hobbit::Response`
-isn't a `Rack::Response` subclass.
-
-# 0.4.1
-
-* `Hobbit::Response` now returns the `Content-Length` header as a string.
-
-# 0.4.0
-
-* Add halt method.
-
-# 0.3.1
-
-* Remove unused `attr_accessor` (`:length`) from `Hobbit::Response`.
-
-# 0.3.0
-
-* `Hobbit::Response` is no longer a subclass of `Rack::Response`.
-* Forward `#map` and `#use` methods to `Rack::Builder` instead of define these
-methods.

data/Rakefile

@@ -1,4 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new