scorched 0.5 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7468f10cbee0373d243fd4d66dd081ea4b1cecc9
-  data.tar.gz: 6225d5221e70a5ba5f3b68d8c6db0144f34d9dfc
+  metadata.gz: dc95df5b8180579cc08c6d839b56dc64ad9105b1
+  data.tar.gz: 0a445e9f72ee7aaf30c7f0aa8a9cc93ec5c919ee
 SHA512:
-  metadata.gz: 91385d8f1501c564b9ba510ab3d4faef763ea4d6cee6d79b2a23c74cf8511352c8b0c7443360031e8b4ae3149c33c216c4b4b7311eac03d3bee9ce348d075b81
-  data.tar.gz: e0d15fc7205e937a8249599833bf9b2a74c9e3abaa3db4decef548eb6292185b53d3da0eede09439efdf5b4deb205b9563d256ed4a93365c3b31270c8db6f5e1
+  metadata.gz: 2a46ef33d42014a33f3d0abc9d0009714f088caeaaba24633e72c1d25ad033838b5a693c53bfdf5dbaf9b1ae6c0dd714d5d8f52c17e0dcceadc9773dad558ac9
+  data.tar.gz: 2446404ea7aa8a28d140921d66142fd292f51b492fabb7029f7a3d632ba97a1707425589b11ecf46b58b1e35563f2f7d6e530d88ae26ca04858d24bba7890033

data/Milestones.md

@@ -3,6 +3,9 @@ Milestones
 
 Changelog
 ---------
+### v0.5.1
+* Added URL helpers, #absolute and #url
+* Render helper now loads files itself as Tilt still has issues with UTF-8 files.
 
 ### v0.5
 * Implemented view rendering using Tilt.

data/README.md

@@ -21,7 +21,14 @@ Design Philosophy
 -----------------
 Scorched has a relatively simple design philosophy. The main objective is to keep Scorched lean and generic. Scorched refrains from expressing too much opinion. The general idea behind Scorched is to give developers all the tools to quickly put together small, medium and perhaps even large websites and applications.
 
-There's little need for a framework to be opinionated if the opinions of the developer can be quickly and easily built into it on a per-application basis. To do this effectively, developers really need to understand Scorched, and the best way to lower facilitate that is to lower the learning curve by keeping the core design, logical, predictable, and concise. 
+There's little need for a framework to be opinionated if the opinions of the developer can be quickly and easily built into it on a per-application basis. To do this effectively, developers really need to understand Scorched, and the best way to lower facilitate that is to lower the learning curve by keeping the core design, logical, predictable, and concise.
+
+
+Magicians Not Welcome
+---------------------
+Scorched aims to be raw and transparent. Magic has no place, or need, in the world of Scorched. A thoughtful and simple design means there's no requirement for magic. Because of that, most developers should be able to master scorched in an evening, if that.
+
+Part of what keeps Scorched lightweight, is that unlike other lightweight web frameworks that attempt to hide Rack in the background, Scorched makes no such attempts, very rarely providing functionality that overlaps with that already provided by Rack. In fact, familiarity is somewhat of a pre-requisite to mastering Scorched.
 
 
 First Impressions

data/lib/scorched.rb

@@ -11,7 +11,6 @@ require_relative 'scorched/static'
 require_relative 'scorched/dynamic_delegate'
 require_relative 'scorched/options'
 require_relative 'scorched/collection'
-require_relative 'scorched/view_helpers'
 require_relative 'scorched/controller'
 require_relative 'scorched/error'
 require_relative 'scorched/request'

data/lib/scorched/controller.rb

@@ -1,6 +1,5 @@
 module Scorched
   class Controller
-    include ViewHelpers
     include Scorched::Options('config')
     include Scorched::Options('view_config')
     include Scorched::Options('conditions')
@@ -52,7 +51,7 @@ module Scorched
       use Rack::Head
       use Rack::MethodOverride
       use Rack::Accept
-      use Scorched::Static, :dir => this.config[:static_dir] if this.config[:static_dir]
+      use Scorched::Static, this.config[:static_dir] if this.config[:static_dir]
       use Rack::Logger, this.config[:logger] if this.config[:logger]
     }
     
@@ -328,6 +327,68 @@ module Scorched
       end
     end
     
+    # Renders the given string or file path using the Tilt templating library.
+    # Options hash is merged with the controllers _view_config_. Tilt template options are passed through. 
+    # The template engine is derived from file name, or otherwise as specified by the _:engine_ option. If String is
+    # given, _:engine_ option must be set.
+    #
+    # Refer to Tilt documentation for a list of valid template engines.
+    def render(string_or_file, options = {}, &block)
+      options = view_config.merge(explicit_options = options)
+      engine = (derived_engine = Tilt[string_or_file.to_s]) || Tilt[options[:engine]]
+      raise Error, "Invalid or undefined template engine: #{options[:engine].inspect}" unless engine
+      if Symbol === string_or_file
+        file = string_or_file.to_s
+        file = file << ".#{options[:engine]}" unless derived_engine
+        file = File.join(options[:dir], file) if options[:dir]
+        # Tilt still has unresolved file encoding issues. Until that's fixed, we read the file manually.
+        template = engine.new(nil, nil, options) { File.read(file) }
+      else
+        template = engine.new(nil, nil, options) { string_or_file }
+      end
+      
+      # The following chunk of code is responsible for preventing the rendering of layouts within views.
+      options[:layout] = false if @_no_default_layout && !explicit_options[:layout]
+      begin
+        @_no_default_layout = true
+        output = template.render(self, options[:locals], &block)
+      ensure
+        @_no_default_layout = false
+      end
+      output = render(options[:layout], options.merge(layout: false)) { output } if options[:layout]
+      output
+    end
+    
+    # Takes an optional URL, relative to the applications root, and returns a fully qualified URL.
+    # Example: url('/example?show=30') #=> https://localhost:9292/myapp/example?show=30
+    def url(path = nil)
+      return path if path && URI.parse(path).scheme
+      uri = URI::Generic.build(
+        scheme: env['rack.url_scheme'],
+        host: env['SERVER_NAME'],
+        port: env['SERVER_PORT'].to_i,
+        path: env['SCRIPT_NAME']
+      )
+      if path
+        path[0,0] = '/' unless path[0] == '/'
+        uri.to_s.chomp('/') << path
+      else
+        uri.to_s
+      end
+      
+    end
+    
+    # Takes an optional path, relative to the applications root URL, and returns an absolute path.
+    # Example: absolute('/style.css') #=> /myapp/style.css
+    def absolute(path = nil)
+      return path if path && URI.parse(path).scheme
+      if path
+        [request.script_name, path].join('/').gsub(%r{/+}, '/')
+      else
+        request.script_name
+      end
+    end
+    
   private
   
     def run_filters(type)

data/lib/scorched/static.rb

@@ -1,14 +1,12 @@
 module Scorched
   class Static
-    def initialize(app, options={})
+    def initialize(app, dir = 'public')
       @app = app
-      @options = options
-      dir = options.delete(:dir) || 'public'
-      options[:cache_control] ||= 'no-cache'
-      @file_server = Rack::File.new(dir, options)
+      @file_server = Rack::File.new(dir)
     end
 
     def call(env)
+      @file_server.call(env)
       response = @file_server.call(env)
       response[0] >= 400 ? @app.call(env) : response 
     end

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.5'
+  VERSION = '0.5.1'
 end

data/scorched.gemspec

@@ -1,5 +1,5 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-require 'scorched/version' # Load scorched to inspect it for information, such as version.
+require 'scorched/version'
 
 Gem::Specification.new 'scorched', Scorched::VERSION do |s|
   s.summary           = "Light-weight, DRY as a desert, web framework for Ruby"

data/spec/controller_spec.rb

@@ -560,6 +560,135 @@ module Scorched
         end
       end
       
+      describe "rendering" do
+        before(:each) do
+          app.view_config.each { |k,v| app.view_config[k] = nil }
+        end
+
+        it "can render a file, relative to the application root" do
+          app.get('/') do
+            render(:'views/main.erb').should == "3 for me"
+          end
+          rt.get('/')
+        end
+
+        it "can render a string" do
+          app.get('/') do
+            render('<%= 1 + 1  %> for you', engine: :erb).should == "2 for you"
+          end
+          rt.get('/')
+        end
+
+        it "takes an optional view directory, relative to the application root" do
+          app.get('/') do
+            render(:'main.erb', dir: 'views').should == "3 for me"
+          end
+          rt.get('/')
+        end
+
+        it "takes an optional block to be yielded by the view" do
+          app.get('/') do
+            render(:'views/layout.erb'){ "in the middle" }.should == "(in the middle)"
+          end
+          rt.get('/')
+        end
+
+        it "renders the given layout" do
+          app.get('/') do
+            render(:'views/main.erb', layout: :'views/layout.erb').should == "(3 for me)"
+          end
+          rt.get('/')
+        end
+
+        it "merges options with view config" do
+          app.get('/') do
+            render(:'main.erb').should == "3 for me"
+          end
+          app.get('/full_path') do
+            render(:'views/main.erb', {layout: :'views/layout.erb', dir: nil}).should == "(3 for me)"
+          end
+          app.view_config[:dir] = 'views'
+          rt.get('/')
+          rt.get('/full_path')
+        end
+
+        it "derived template engine overrides specified engine" do
+          app.view_config[:dir] = 'views'
+          app.view_config[:engine] = :erb
+          app.get('/str') do
+            render(:'other.str').should == "hello hello"
+          end
+          app.get('/erb_file') do
+            render(:main).should == "3 for me"
+          end
+          app.get('/erb_string') do
+            render('<%= 1 + 1  %> for you').should == "2 for you"
+          end
+          rt.get('/str')
+          rt.get('/erb_file')
+          rt.get('/erb_string')
+        end
+
+        it "ignores default layout when called within a view" do
+          app.view_config << {:dir => 'views', :layout => :layout, :engine => :erb}
+          app.get('/') do
+            render :composer
+          end
+          rt.get('/').body.should == '({1 for none})'
+        end
+      end
+      
+      describe "url helpers" do
+        let(:myapp) do
+          Class.new(Scorched::Controller)
+        end
+        
+        let(:app) do
+          the_app = myapp
+          builder = Rack::Builder.new
+          builder.map('/myapp') { run the_app }
+          builder.to_app
+        end
+        
+        describe "url" do
+          it "returns the fully qualified URL" do
+            myapp.get('/') { url }
+            rt.get('https://scorchedrb.com:73/myapp?something=true').body.should ==
+              'https://scorchedrb.com:73/myapp'
+          end
+          
+          it "can append an optional path" do
+            myapp.get('/') { url('hello') }
+            rt.get('https://scorchedrb.com:73/myapp?something=true').body.should ==
+              'https://scorchedrb.com:73/myapp/hello'
+          end
+          
+          it "returns the given URL if scheme detected" do
+            test_url = 'http://google.com/blah'
+            myapp.get('/') { url(test_url) }
+            rt.get('/myapp').body.should == test_url
+          end
+        end
+        
+        describe "absolute" do
+          it "returns an absolute URL path" do
+            myapp.get('/absolute') { absolute }
+            rt.get('http://scorchedrb.com/myapp/absolute?something=true').body.should == '/myapp'
+          end
+          
+          it "can append an optional path" do
+            myapp.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'
+            myapp.get('/') { absolute(test_url) }
+            rt.get('/myapp').body.should == test_url
+          end
+        end
+      end
+      
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 0.5.1
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -107,7 +107,6 @@ files:
 - lib/scorched/response.rb
 - lib/scorched/static.rb
 - lib/scorched/version.rb
-- lib/scorched/view_helpers.rb
 - scorched.gemspec
 - spec/collection_spec.rb
 - spec/controller_spec.rb
@@ -115,7 +114,6 @@ files:
 - spec/options_spec.rb
 - spec/public/static.txt
 - spec/request_spec.rb
-- spec/view_helpers_spec.rb
 - spec/views/composer.erb
 - spec/views/layout.erb
 - spec/views/main.erb
@@ -154,4 +152,3 @@ test_files:
 - spec/controller_spec.rb
 - spec/options_spec.rb
 - spec/request_spec.rb
-- spec/view_helpers_spec.rb

data/lib/scorched/view_helpers.rb

@@ -1,39 +0,0 @@
-# In its own file for no other reason than to keep all the extra non-essential bells and whistles in their own file,
-# which can be easily excluded if needed.
-
-module Scorched
-  module ViewHelpers
-    
-    # Renders the given string or file path using the Tilt templating library.
-    # Options hash is merged with the controllers _view_config_. Tilt template options are passed through. 
-    # The template engine is derived from file name, or otherwise as specified by the _:engine_ option. If String is
-    # given, _:engine_ option must be set.
-    #
-    # Refer to Tilt documentation for a list of valid template engines.
-    def render(string_or_file, options = {}, &block)
-      options = view_config.merge(explicit_options = options)
-      engine = (derived_engine = Tilt[string_or_file.to_s]) || Tilt[options[:engine]]
-      raise Error, "Invalid or undefined template engine: #{options[:engine].inspect}" unless engine
-      if Symbol === string_or_file
-        file = string_or_file.to_s
-        file = file << ".#{options[:engine]}" unless derived_engine
-        file = File.join(options[:dir], file) if options[:dir]
-        template = engine.new(file, nil, options)
-      else
-        template = engine.new(nil, nil, options) { string_or_file }
-      end
-      
-      # The following chunk of code is responsible for preventing the rendering of layouts within views.
-      options[:layout] = false if @_no_default_layout && !explicit_options[:layout]
-      begin
-        @_no_default_layout = true
-        output = template.render(self, options[:locals], &block)
-      ensure
-        @_no_default_layout = false
-      end
-      output = render(options[:layout], options.merge(layout: false)) { output } if options[:layout]
-      output
-    end
-    
-  end
-end

data/spec/view_helpers_spec.rb

@@ -1,84 +0,0 @@
-require_relative './helper.rb'
-
-module Scorched
-  describe ViewHelpers do
-    describe "rendering" do
-      before(:each) do
-        app.view_config.each { |k,v| app.view_config[k] = nil }
-      end
-      
-      it "can render a file, relative to the application root" do
-        app.get('/') do
-          render(:'views/main.erb').should == "3 for me"
-        end
-        rt.get('/')
-      end
-
-      it "can render a string" do
-        app.get('/') do
-          render('<%= 1 + 1  %> for you', engine: :erb).should == "2 for you"
-        end
-        rt.get('/')
-      end
-
-      it "takes an optional view directory, relative to the application root" do
-        app.get('/') do
-          render(:'main.erb', dir: 'views').should == "3 for me"
-        end
-        rt.get('/')
-      end
-
-      it "takes an optional block to be yielded by the view" do
-        app.get('/') do
-          render(:'views/layout.erb'){ "in the middle" }.should == "(in the middle)"
-        end
-        rt.get('/')
-      end
-      
-      it "renders the given layout" do
-        app.get('/') do
-          render(:'views/main.erb', layout: :'views/layout.erb').should == "(3 for me)"
-        end
-        rt.get('/')
-      end
-  
-      it "merges options with view config" do
-        app.get('/') do
-          render(:'main.erb').should == "3 for me"
-        end
-        app.get('/full_path') do
-          render(:'views/main.erb', {layout: :'views/layout.erb', dir: nil}).should == "(3 for me)"
-        end
-        app.view_config[:dir] = 'views'
-        rt.get('/')
-        rt.get('/full_path')
-      end
-      
-      it "derived template engine overrides specified engine" do
-        app.view_config[:dir] = 'views'
-        app.view_config[:engine] = :erb
-        app.get('/str') do
-          render(:'other.str').should == "hello hello"
-        end
-        app.get('/erb_file') do
-          render(:main).should == "3 for me"
-        end
-        app.get('/erb_string') do
-          render('<%= 1 + 1  %> for you').should == "2 for you"
-        end
-        rt.get('/str')
-        rt.get('/erb_file')
-        rt.get('/erb_string')
-      end
-
-      it "ignores default layout when called within a view" do
-        app.view_config << {:dir => 'views', :layout => :layout, :engine => :erb}
-        app.get('/') do
-          render :composer
-        end
-        rt.get('/').body.should == '({1 for none})'
-      end
-      
-    end
-  end
-end