scorched 0.23 → 0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1007cc5234411333f49d1cacda15b2a384eb0a0c
-  data.tar.gz: 41e412b90cddee3e91c4f8785fecc0b73a394977
+  metadata.gz: 7a269c05d699e75919261edd1b0fa291753e9cb9
+  data.tar.gz: 7b4789f2fd5f3c38e2004fcb1417a53591112326
 SHA512:
-  metadata.gz: 604562e9030f0e52a95a56ff61a43094de84c519daa5ee9f7d40a35734528d8dddcf4f52fc2fd73437a0069661fadab49b3a1ca24d40346ba95fd3eea6dac5e3
-  data.tar.gz: fbc6efbbd4508f04526d3910553a40136f037780d129f48298170eea136deeafb73b6cc7c28f8bef092413a82a44a992cd2643035c7eefdb9267bb8c4ee01d26
+  metadata.gz: 724e1aa350acae90d82c1be43567c251ed04127105996486383e01bf6ffa6154d4bc7385ade5816b8a926319cc8387fa68403f43122014603b9be9ade81091db
+  data.tar.gz: 43d90ab9f5e30d2b35c47aaa871d1794368f517a56f3ea5aa37f4e6ab8f8cfe4e320252867443a9da8ed05730e9db1d343c0039a272e775da4cd7bd658a183f9

data/CHANGES.md

@@ -3,6 +3,12 @@ Changelog
 
 _Note that Scorched is yet to reach a v1.0 release. This means breaking changes may still be made. If upgrading the version of Scorched for your project, review this changelog carefully._
 
+### v0.24
+*  Query string is now preserved when stripping trailing slashes with `config[:strip_trailing_slash] = :redirect`, e.g. `/search/?query=cats` now becomes `/search?query=cats` instead of just `/search`.
+* `absolute` method now returns as-is anything not starting with a forward slash, e.g. `absolute("./view") => "./view"`
+* Improved performance by caching the Rack::Builder instance for each controller.
+* Improved performance by caching data associated with Scorched::Options#to_hash.
+
 ### v0.23
 * Now using _scorched-accept_ for accept header parsing and logic, which fixes issues with the `:media_type` condition.
 * Exceptions caught by Scorched are now assigned to env['rack.exception'].

data/README.md

@@ -37,6 +37,7 @@ $ rackup hello_world.ru
 
 Scorched requires Ruby 2.0 or above. If you've got Ruby 2.0.0-p195 and newer, you're good. Otherwise, you need to ensure that your version of Ruby 2.0 includes [changeset 39919](http://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/39919) in order to avoid suffering from [random segmentation faults](http://bugs.ruby-lang.org/issues/8100).
 
+
 The Errors of Our Past (and Present!)
 ----------------------
 One of the mistakes made by a lot of other Ruby frameworks is to not leverage the power of the class. Consequently, this makes for some awkwardness. Helpers for example, are a classic reinvention of what classes and modules are already made to solve. Scorched implements Controllers as classes, which in addition to having their own DSL, allow you to define and call whatever you need as standard instance methods. The decision to allow developers to implement helpers and other common functionality as standard instance methods not only makes Controllers somewhat more predictable and familiar, but also allows for such helpers to be inheritable via plain old class inheritance.
@@ -63,33 +64,33 @@ First Impressions
 
 ```ruby
 class MyApp < Scorched::Controller
-  
+
   # From the most simple route possible...
   get '/' do
     "Hello World"
   end
-  
+
   # To something that gets the muscle's flexing
   route '/articles/:title/::opts', 2, method: ['GET', 'POST'], content_type: :json do
     # Do what you want in here. Note, the second argument is the optional route priority.
   end
-  
+
   # Anonymous controllers allow for convenient route grouping to which filters and conditions can be applied
   controller conditions: {media_type: 'application/json'} do
     get '/articles/*' do |page|
       {title: 'Scorched Rocks', body: '...', created_at: '27/08/2012', created_by: 'Bob'}
     end
-    
+
     after do
       response.body = response.body.to_json
     end
   end
-  
+
   # The things you get for free by using Classes for Controllers (...that's directed at you Padrino)
   def my_little_helper
     # Do some crazy awesome stuff that no route can resist using.
   end
-  
+
   # You can always avoid the routing helpers and add mappings manually. Anything that responds to #call is a valid
   # target, with the only minor exception being that proc's are instance_exec'd, not call'd.
   self << {pattern: '/admin', priority: 10, target: My3rdPartyAdminApp}
@@ -106,6 +107,9 @@ This API shouldn't look too foreign to anyone familiar with frameworks like Sina
 * Route priorities - Routes (referred to as mappings internally) can be assigned priorities. A priority can be any arbitrary number by which the routes are ordered. The higher the number, the higher the priority.
 * Conditions - Conditions are merely procs defined on the controller which are inherited (and can be overriden) by child controllers. When a request comes in, mappings that match the requested URL, first have their conditions evaluated in the context of the controller instance, before control is handed off to the target associated with that mapping. It's a very simple implementation that comes with a lot of flexibility.
 
+Comparisons with other frameworks
+---------------------------------
+Refer to the [comparisons](https://github.com/Wardrop/Scorched/tree/master/comparisons) directory in the repo to compare a simple example app written in frameworks similar to Scorched.
 
 Links
 -----

data/comparison/common.rb

@@ -0,0 +1,15 @@
+class Artist
+  def self.[](*args)
+    new
+  end
+
+  def method_missing(*args)
+    true
+  end
+end
+
+module Kernel
+  def check_access(bool)
+    bool
+  end
+end

data/comparison/profile.rb

@@ -0,0 +1,33 @@
+require 'ruby-prof'
+require 'rack/mock'
+require 'allocation_stats'
+require 'scorched'
+require 'sinatra/base'
+
+scorched = Class.new(Scorched::Controller) do
+  get '/' do
+    'Hello world'
+  end
+end
+
+sinatra = Class.new(Sinatra::Base) do
+  get '/' do
+    'Hello world'
+  end
+end
+
+
+
+scorched_stats = AllocationStats.new(burn: 5).trace do
+  scorched.call(Rack::MockRequest.env_for('/'))
+end
+
+sinatra_stats = AllocationStats.new(burn: 5).trace do
+  sinatra.call(Rack::MockRequest.env_for('/'))
+end
+
+puts "Scorched Allocations: #{scorched_stats.allocations.all.size}"
+puts "Scorched Memsize: #{scorched_stats.allocations.bytes.to_a.inject(&:+)}"
+
+puts "Sinatra Allocations: #{sinatra_stats.allocations.all.size}"
+puts "Sinatra Memsize: #{sinatra_stats.allocations.bytes.to_a.inject(&:+)}"

data/comparison/roda.ru

@@ -0,0 +1,35 @@
+require 'roda'
+require_relative './common'
+
+class App < Roda
+  plugin :render
+  plugin :all_verbs
+  use Rack::MethodOverride
+
+  route do |r|
+    r.root do
+      render :index
+    end
+
+    r.is 'artist/:id' do |artist_id|
+      @artist = Artist[artist_id]
+      check_access(@artist)
+
+      r.get do
+        render :artist
+      end
+
+      r.post do
+        @artist.update(r['artist'])
+        r.redirect '?POST'
+      end
+
+      r.delete do
+        @artist.destroy
+        r.redirect '?DELETE'
+      end
+    end
+  end
+end
+
+run App

data/comparison/scorched.ru

@@ -0,0 +1,33 @@
+require 'scorched'
+require_relative './common'
+
+class App < Scorched::Controller
+  get '/' do
+    render :index
+  end
+
+  controller '/artist/:id' do
+    before do
+      @artist = Artist[captures[:id]]
+      check_access(@artist)
+    end
+
+    get '/' do
+      render :artist
+    end
+
+    post '/' do
+      @artist.update(request.POST)
+    end
+
+    delete '/' do
+      @artist.destroy
+    end
+
+    after method!: 'GET' do
+      redirect "?#{request.request_method}"
+    end
+  end
+end
+
+run App

data/comparison/sinatra.ru

@@ -0,0 +1,32 @@
+require 'sinatra/base'
+require_relative './common'
+
+class App < Sinatra::Base
+  use Rack::MethodOverride
+
+  get '/' do
+    erb :index
+  end
+
+  get '/artist/:id' do
+    @artist = Artist[params[:id]]
+    check_access(@artist)
+    erb :artist
+  end
+
+  post '/artist/:id' do
+    @artist = Artist[params[:id]]
+    check_access(@artist)
+    @artist.update(params[:artist])
+    redirect(request.path_info + '?POST')
+  end
+
+  delete '/artist/:id' do
+    @artist = Artist[params[:id]]
+    check_access(@artist)
+    @artist.destory
+    redirect(request.path_info + '?DELETE')
+  end
+end
+
+run App

data/comparison/views/artist.erb

@@ -0,0 +1,5 @@
+This is the artist.
+<form method="post">
+  <input type="submit" name="_method" value="Post" />
+  <input type="submit" name="_method" value="Delete" />
+</form>

data/comparison/views/index.erb

@@ -0,0 +1 @@
+This is the index. <a href="/artist/45">Go to artist...</a>

data/lib/scorched/controller.rb

@@ -105,18 +105,18 @@ module Scorched
       end
 
       def call(env)
+        @instance_cache ||= {}
         loaded = env['scorched.middleware'] ||= Set.new
-        app = lambda do |env|
-          self.new(env).process
+        to_load = middleware.reject{ |v| loaded.include? v }
+        key = [loaded, to_load].map { |x| x.map &:object_id }
+        unless @instance_cache[key]
+          builder = Rack::Builder.new
+          to_load.each { |proc| builder.instance_exec(self, &proc) }
+          builder.run(lambda { |env| self.new(env).process })
+          @instance_cache[key] = builder.to_app
         end
-
-        builder = Rack::Builder.new
-        middleware.reject{ |v| loaded.include? v }.each do |proc|
-          builder.instance_exec(self, &proc)
-          loaded << proc
-        end
-        builder.run(app)
-        builder.call(env)
+        loaded.merge(to_load)
+        @instance_cache[key].call(env)
       end
 
       # Generates and assigns mapping hash from the given arguments.
@@ -275,7 +275,8 @@ module Scorched
       begin
         catch(:halt) do
           if config[:strip_trailing_slash] == :redirect && request.path =~ %r{[^/]/+$}
-            redirect(request.path.chomp('/'), 307)
+            query_string = request.query_string.empty? ? '' : '?' << request.query_string
+            redirect(request.path.chomp('/') + query_string, 307)
           end
           eligable_matches = matches.reject { |m| m.failed_condition }
           pass if config[:auto_pass] && eligable_matches.empty?
@@ -519,15 +520,17 @@ module Scorched
     end
 
     # Takes an optional path, relative to the applications root URL, and returns an absolute path.
+    # If relative path given (i.e. anything not starting with `/`), returns it as-is.
     # Example: absolute('/style.css') #=> /myapp/style.css
     def absolute(path = nil)
-      return path if path && URI.parse(path).scheme
-      return_path = if path
+      return path if path && path[0] != '/'
+      abs = if path
         [env['scorched.root_path'], path].join('/').gsub(%r{/+}, '/')
       else
         env['scorched.root_path']
       end
-      return_path[0] == '/' ? return_path : return_path.insert(0, '/')
+      abs.insert(0, '/') unless abs[0] == '/'
+      abs
     end
 
     # We always want this filter to run at the end-point controller, hence we include the conditions within the body of

data/lib/scorched/options.rb

@@ -6,24 +6,38 @@ module Scorched
     delegate 'to_hash', *Hash.instance_methods(false).reject { |m|
       [:[]=, :clear, :delete, :delete_if, :merge!, :replace, :shift, :store].include? m
     }
-    
+
     alias_method :<<, :_merge!
-    
+
     # sets parent Options object and returns self
     def parent!(parent)
       @parent = parent
+      @cache = {}
       self
     end
-    
+
     def to_hash(inherit = true)
-      (inherit && Hash === @parent) ? @parent.to_hash.merge(self) : {}.merge(self)
+      @cache ||= {}
+      unless @cache[:self] == self
+        @cache[:self] = self._to_h
+        @cache[:merged] = nil
+      end
+      if inherit && Hash === @parent
+        unless @cache[:parent] == @parent.to_hash
+          @cache[:parent] = @parent.to_hash
+          @cache[:merged] = nil
+        end
+        @cache[:merged] ||= @cache[:parent].merge(@cache[:self])
+      else
+        @cache[:self]
+      end
     end
-    
+
     def inspect
       "#<#{self.class}: local#{_inspect}, merged#{to_hash.inspect}>"
     end
   end
-  
+
   class << self
     def Options(accessor_name)
       m = Module.new
@@ -51,4 +65,3 @@ module Scorched
     end
   end
 end
-

data/lib/scorched/response.rb

@@ -11,14 +11,14 @@ module Scorched
       self.header.merge!(response[1])
       self
     end
-    
+
     # Automatically wraps the assigned value in an array if it doesn't respond to ``each``.
     # Also filters out non-true values and empty strings.
     def body=(value)
       value = [] if !value || value == ''
       super(value.respond_to?(:each) ? value : [value.to_s])
     end
-    
+
     # Override finish to avoid using BodyProxy
     def finish(*args, &block)
       self['Content-Type'] ||= 'text/html;charset=utf-8'
@@ -32,8 +32,8 @@ module Scorched
         [status.to_i, header, body]
       end
     end
-    
+
     alias :to_a :finish
     alias :to_ary :finish
   end
-end
+end

data/lib/scorched/static.rb

@@ -1,14 +1,18 @@
 module Scorched
   class Static
     def initialize(app, dir = 'public')
-      @app = app
-      @file_server = Rack::File.new(dir)
+      @app, @dir = app, dir
     end
 
     def call(env)
-      @file_server.call(env)
-      response = @file_server.call(env)
-      response[0] >= 400 ? @app.call(env) : response 
+      response = file_server.call(env)
+      response[0] >= 400 ? @app.call(env) : response
+    end
+
+  protected
+
+    def file_server
+      @file_server ||= Rack::File.new(@dir)
     end
   end
 end

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.23'
+  VERSION = '0.24'
 end

data/spec/controller_spec.rb

@@ -810,6 +810,7 @@ module Scorched
           response = rt.get('/test/')
           response.status.should == 307
           response['Location'].should == '/test'
+          rt.get('/test/?hello=world')['Location'].should == '/test?hello=world'
         end
 
         it "can be set to ignore trailing slash while pattern matching" do
@@ -1198,14 +1199,15 @@ module Scorched
         end
 
         it "can append an optional path" do
-          my_app.get('/absolute') { absolute('hello') }
+          my_app.get('/absolute') { absolute('/hello') }
           rt.get('http://scorchedrb.com/myapp/absolute?something=true').body.should == '/myapp/hello'
         end
 
-        it "returns the given URL if scheme detected" do
-          test_url = 'http://google.com/blah'
-          my_app.get('/') { absolute(test_url) }
-          rt.get('/myapp').body.should == test_url
+        it "returns the given path if it doesn't begin with a forward-slash" do
+          my_app.get('/url') { absolute('http://google.com/about') }
+          my_app.get('/relative') { absolute('./about') }
+          rt.get('/myapp/url').body.should == 'http://google.com/about'
+          rt.get('/myapp/relative').body.should == './about'
         end
 
         it "returns an absolute URL path for subcontroller defined with controller helper" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: '0.23'
+  version: '0.24'
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -122,6 +122,13 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- comparison/common.rb
+- comparison/profile.rb
+- comparison/roda.ru
+- comparison/scorched.ru
+- comparison/sinatra.ru
+- comparison/views/artist.erb
+- comparison/views/index.erb
 - docs/01_preface.md
 - docs/02_fundamentals/01_the_controller.md
 - docs/02_fundamentals/02_configuration.md
@@ -184,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Light-weight, DRY as a desert, web framework for Ruby