angelo 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82990928178a891fac3eb49454474d3e5136ab87
-  data.tar.gz: 9fe7dec6dfffd783e3a804f5766b31be2c024491
+  metadata.gz: 6f5dba260998174e061615d20082882201023653
+  data.tar.gz: 95f76832e3a797bc886e93a822ee541640f18df7
 SHA512:
-  metadata.gz: f2da2084362c910fcd9b4766dec667d574409c6fe3f100554ffc1c72679648ffef54d386a340c4b686aa8896205f956baf8b51f0b48d6a465ee4003448ce4d80
-  data.tar.gz: d0d2410e21038dd060f5f384bb033571481a9088ada01f8b838be59558ea436101935991f428f254902c858ac590f00ffa0cb8a651572c5aa57ba46e2fb471c9
+  metadata.gz: 1cda696fa0204160276711d8927393d680b28149af53d564421a227768e57601e30f6d9e70876c1fb805ffc96df534785965ccee4fa9c825db751ee6af390e0d
+  data.tar.gz: 1d062a3d517d8c3a463ca339f8344c6b4b501a89d187a201f6ccb6fd243f8559d236605254ec2baae190b62adef5fb9df069dab71eb7f90988d6d3077146643b

data/.travis.yml

@@ -4,4 +4,5 @@ rvm:
   - "2.0.0"
   - "2.1.2"
   - "2.1.3"
+  - "2.1.5"
 script: rake

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 changelog
 =========
 
+### 0.3.2 27 nov 2014 ¡gracias!
+
+thanks: @mighe, @artworx
+
+* send_file now accepts both full paths and paths relative to app file's dir (#20)
+* erb templates now sorted by type, finer control of response template type (#19)
+
 ### 0.3.1 10 nov 2014 yep, same day - jeez
 
 * refactor views dir and public dir setting into top level DSLish methods

data/Gemfile

@@ -5,8 +5,8 @@ gem 'tilt', '~>2.0'
 gem 'mime-types', '~>2.4'
 gem 'websocket-driver', '~>0.3'
 
-platform :ruby_20, :ruby_21 do
-  gem 'mustermann', '~>0.3'
+platform :ruby_21 do
+  gem 'mustermann', '~>0.4'
 end
 
 group :development do

data/README.md

@@ -433,6 +433,19 @@ class Foo < Angelo::Base
 end
 ```
 
+The Angleo::Tilt::ERB module and the `erb` method do some extra work for you:
+
+* templates are pre-compiled, sorted by type.
+* template type is determined by word between name and .erb (ex: `index.html.erb`
+  is `:index` name and `:html` type)
+* the template chosen to render is determined based on:
+    * `:type` option passed to `erb` helper
+    * `Accept` request header value
+    * `Content-Type` response header value
+    * default to `:html`
+
+See [views](https://github.com/kenichi/angelo/tree/master/test/test_app_root/views) for examples.
+
 ### [Mustermann](https://github.com/rkh/mustermann)
 
 To make routes blocks match path with Mustermann patterns

data/lib/angelo/base.rb

@@ -258,7 +258,7 @@ module Angelo
         block[socket]
       rescue Reel::SocketError, IOError, SystemCallError => e
         # probably closed on client
-        warn e.message if report_errors
+        warn e.message if report_errors?
         socket.close unless socket.closed?
       rescue => e
         error e.inspect
@@ -271,7 +271,8 @@ module Angelo
     end
 
     def send_file local_file, opts = {}
-      lp = self.class.local_path local_file
+      lp = local_file[0] == File::SEPARATOR ? local_file : File.expand_path(File.join(self.class.root, local_file))
+      halt 404 unless File.exist? lp
 
       # Content-Type
       #

data/lib/angelo/responder.rb

@@ -7,6 +7,7 @@ module Angelo
 
       attr_writer :default_headers
 
+      # top-level setter
       def content_type type
         dhs = self.default_headers
         case type
@@ -102,6 +103,7 @@ module Angelo
       @headers
     end
 
+    # route handler helper
     def content_type type
       case type
       when :json
@@ -110,6 +112,8 @@ module Angelo
         headers CONTENT_TYPE_HEADER_KEY => HTML_TYPE
       when :js
         headers CONTENT_TYPE_HEADER_KEY => JS_TYPE
+      when :xml
+        headers CONTENT_TYPE_HEADER_KEY => XML_TYPE
       else
         raise ArgumentError.new "invalid content_type: #{type}"
       end

data/lib/angelo/tilt/erb.rb

@@ -5,6 +5,11 @@ module Angelo
   module Tilt
     module ERB
 
+      DEFAULT_LAYOUT = 'layout.%s.erb'
+      DEFAULT_TYPE = :html
+      LAYOUTS_DIR = 'layouts'
+      ACCEPT_ALL = '*/*'
+
       # hrm, sneaky
       #
       def self.included base
@@ -13,67 +18,83 @@ module Angelo
 
       module ClassMethods
 
-        DEFAULT_LAYOUT = 'layout.html.erb'
-
         def view_glob *glob
           File.join views_dir, *glob
         end
 
         def templatify *glob
           Dir[view_glob *glob].reduce({}) do |h,v|
-            sym = v.gsub views_dir + '/', ''
+            sym = v.gsub views_dir + File::SEPARATOR, ''
             return h if (block_given? && yield(v))
-            sym.gsub! '/', '_'
-            sym.gsub! /\.\w+?\.erb$/, ''
+            sym.gsub! File::SEPARATOR, UNDERSCORE
+            sym.gsub! /\.\w+?\.erb$/, EMPTY_STRING
             h[sym.to_sym] = ::Tilt::ERBTemplate.new v
             h
           end
         end
 
-        def templates
-          @templates ||= templatify('**', '*.erb'){|v| v =~ /^layouts\//}
+        def templates type = DEFAULT_TYPE
+          @templates ||= {}
+          @templates[type] ||= templatify('**', "*.#{type}.erb") do |v|
+            v =~ /^#{LAYOUTS_DIR}#{File::SEPARATOR}/
+          end
         end
 
-        def layout_templates
-          @layout_templates ||= templatify 'layouts', '*.erb'
+        def layout_templates type = DEFAULT_TYPE
+          @layout_templates ||= templatify LAYOUTS_DIR, "*.#{type}.erb"
         end
 
-        def default_layout
-          if @default_layout.nil?
-            l = view_glob(DEFAULT_LAYOUT)
-            @default_layout = ::Tilt::ERBTemplate.new l if File.exist? l
+        def default_layout type = DEFAULT_TYPE
+          @default_layout ||= {}
+          if @default_layout[type].nil?
+            l = view_glob(DEFAULT_LAYOUT % type)
+            @default_layout[type] = ::Tilt::ERBTemplate.new l if File.exist? l
           end
-          @default_layout
+          @default_layout[type]
         end
 
       end
 
       def erb view, opts = {locals: {}}
+        type = opts[:type] || template_type
+        content_type type
         locals = Hash === opts[:locals] ? opts[:locals] : {}
         render = case view
                  when String
                    ->{ view }
                  when Symbol
-                   ->{self.class.templates[view].render self, locals}
+                   ->{self.class.templates(type)[view].render self, locals}
                  end
         case opts[:layout]
         when false
           render[]
         when Symbol
-          if lt = self.class.layout_templates[opts[:layout]]
+          if lt = self.class.layout_templates(type)[opts[:layout]]
             lt.render self, locals, &render
           else
             raise ArgumentError.new "unknown layout - :#{opts[:layout]}"
           end
         else
-          if self.class.default_layout
-            self.class.default_layout.render self, locals, &render
+          if self.class.default_layout(type)
+            self.class.default_layout(type).render self, locals, &render
           else
             render[]
           end
         end
       end
 
+      def template_type
+        accept = request.headers[ACCEPT_REQUEST_HEADER_KEY]
+        mt = if accept.nil? or accept == ACCEPT_ALL
+               MIME::Types[headers[CONTENT_TYPE_HEADER_KEY]]
+             else
+               MIME::Types[request.headers[ACCEPT_REQUEST_HEADER_KEY]]
+             end
+        mt.first.extensions.first.to_sym
+      rescue
+        DEFAULT_TYPE
+      end
+
     end
   end
 end

data/lib/angelo/version.rb

@@ -1,3 +1,3 @@
 module Angelo
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/angelo.rb

@@ -18,6 +18,8 @@ module Angelo
   HTTPABLE = [:get, :post, :put, :delete, :options]
   STATICABLE = [:get, :head]
 
+  ACCEPT_REQUEST_HEADER_KEY = 'Accept'
+
   CONTENT_TYPE_HEADER_KEY = 'Content-Type'
   CONTENT_DISPOSITION_HEADER_KEY = 'Content-Disposition'
   CONTENT_LENGTH_HEADER_KEY = 'Content-Length'
@@ -31,7 +33,8 @@ module Angelo
   JSON_TYPE = 'application/json'
   FORM_TYPE = 'application/x-www-form-urlencoded'
   FILE_TYPE = 'application/octet-stream'
-  JS_TYPE =   'text/javascript'
+  JS_TYPE =   'application/javascript'
+  XML_TYPE =  'application/xml'
 
   DEFAULT_ADDR = '127.0.0.1'
   DEFAULT_PORT = 4567

data/test/angelo/erb_spec.rb

@@ -4,6 +4,54 @@ require 'angelo/tilt/erb'
 describe Angelo::Base do
   describe Angelo::Tilt::ERB do
 
+    expected_html = <<HTML
+<!doctype html>
+<html>
+  <head>
+    <title>test</title>
+  </head>
+  <body>
+    foo - asdf
+locals :bar - bat
+
+  </body>
+</html>
+HTML
+
+    expected_xml = <<XML
+<foo bar="bat">asdf</foo>
+XML
+
+    expected_json = <<JSON
+{"foo": "asdf", "bar": ["bat"]}
+JSON
+
+    expected_javascript = <<JS
+(function() {
+  var foo = "asdf";
+var bar = "bat";
+
+})();
+JS
+
+    expected_html_nl = <<HTML
+foo - asdf
+locals :bar - bat
+HTML
+
+    expected_xml_nl = <<XML
+<foo bar="bat">asdf</foo>
+XML
+
+    expected_json_nl = <<JSON
+{"foo": "asdf", "bar": ["bat"]}
+JSON
+
+    expected_javascript_nl = <<JS
+var foo = "asdf";
+var bar = "bat";
+JS
+
     define_app do
 
       include Angelo::Tilt::ERB
@@ -25,24 +73,40 @@ describe Angelo::Base do
         erb :index, layout: false, locals: {bar: 'bat'}
       end
 
+      get '/index.html' do
+        set_vars
+        content_type :html
+        erb :index, locals: {bar: 'bat'}, layout: !!params[:layout]
+      end
+
+      get '/index.json' do
+        set_vars
+        content_type :json
+        erb :index, locals: {bar: 'bat'}, layout: !!params[:layout]
+      end
+
+      get '/index.js' do
+        set_vars
+        content_type :js
+        erb :index, locals: {bar: 'bat'}, layout: !!params[:layout]
+      end
+
+      get '/index.xml' do
+        set_vars
+        content_type :xml
+        erb :index, locals: {bar: 'bat'}, layout: !!params[:layout]
+      end
+
+      get '/by_type' do
+        set_vars
+        erb :index, locals: {bar: 'bat'}, type: params[:type].to_sym
+      end
+
     end
 
     it 'renders templates with layout' do
       get '/', foo: 'asdf'
-      expected = <<HTML
-<!doctype html>
-<html>
-  <head>
-    <title>test</title>
-  </head>
-  <body>
-    foo - asdf
-locals :bar - bat
-
-  </body>
-</html>
-HTML
-      last_response_must_be_html expected
+      last_response_must_be_html expected_html
     end
 
     it 'renders templates without layout' do
@@ -54,5 +118,106 @@ HTML
       last_response_must_be_html expected
     end
 
+    it 'renders templates by Accept header html' do
+      get '/', {foo: 'asdf'}, {'Accept' => 'text/html'}
+      last_response_must_be_html expected_html
+    end
+
+    it 'renders templates by Accept header xml' do
+      get '/', {foo: 'asdf'}, {'Accept' => 'application/xml'}
+      last_response.body.must_equal expected_xml
+      last_response.headers['Content-Type'].must_equal 'application/xml'
+    end
+
+    it 'renders templates by Accept header javascript' do
+      get '/', {foo: 'asdf'}, {'Accept' => 'application/javascript'}
+      last_response.body.must_equal expected_javascript
+      last_response.headers['Content-Type'].must_equal 'application/javascript'
+    end
+
+    it 'renders templates by Accept header json' do
+      get '/', {foo: 'asdf'}, {'Accept' => 'application/json'}
+      last_response.body.must_equal expected_json
+      last_response.headers['Content-Type'].must_equal 'application/json'
+    end
+
+    it 'renders html template when unknown Accept header type' do
+      get '/', {foo: 'asdf'}, {'Accept' => 'forget/about/it'}
+      last_response_must_be_html expected_html
+    end
+
+    # content_type
+
+    it 'renders templates by content_type :html' do
+      get '/index.html', foo: 'asdf', layout: true
+      last_response_must_be_html expected_html
+    end
+
+    it 'renders templates by content_type :xml' do
+      get '/index.xml', foo: 'asdf', layout: true
+      last_response.body.must_equal expected_xml
+      last_response.headers['Content-Type'].must_equal 'application/xml'
+    end
+
+    it 'renders templates by content_type :javascript' do
+      get '/index.js', foo: 'asdf', layout: true
+      last_response.body.must_equal expected_javascript
+      last_response.headers['Content-Type'].must_equal 'application/javascript'
+    end
+
+    it 'renders templates by content_type :json' do
+      get '/index.json', foo: 'asdf', layout: true
+      last_response.body.must_equal expected_json
+      last_response.headers['Content-Type'].must_equal 'application/json'
+    end
+
+    it 'renders templates by content_type :html' do
+      get '/index.html', foo: 'asdf'
+      last_response_must_be_html expected_html_nl
+    end
+
+    it 'renders templates by content_type :xml' do
+      get '/index.xml', foo: 'asdf'
+      last_response.body.must_equal expected_xml_nl
+      last_response.headers['Content-Type'].must_equal 'application/xml'
+    end
+
+    it 'renders templates by content_type :javascript' do
+      get '/index.js', foo: 'asdf'
+      last_response.body.must_equal expected_javascript_nl
+      last_response.headers['Content-Type'].must_equal 'application/javascript'
+    end
+
+    it 'renders templates by content_type :json' do
+      get '/index.json', foo: 'asdf'
+      last_response.body.must_equal expected_json_nl
+      last_response.headers['Content-Type'].must_equal 'application/json'
+    end
+
+    # opts[:type]
+
+    it 'renders templates by opts[:type] :html' do
+      get '/by_type', foo: 'asdf', type: 'html'
+      last_response_must_be_html expected_html
+    end
+
+    it 'renders templates by opts[:type] :xml' do
+      get '/by_type', foo: 'asdf', type: 'xml'
+      last_response.body.must_equal expected_xml
+      last_response.headers['Content-Type'].must_equal 'application/xml'
+    end
+
+    it 'renders templates by opts[:type] :javascript' do
+      get '/by_type', foo: 'asdf', type: 'js'
+      last_response.body.must_equal expected_javascript
+      last_response.headers['Content-Type'].must_equal 'application/javascript'
+    end
+
+    it 'renders templates by opts[:type] :json' do
+      get '/by_type', foo: 'asdf', type: 'json'
+      last_response.body.must_equal expected_json
+      last_response.headers['Content-Type'].must_equal 'application/json'
+    end
+
   end
 end

data/test/angelo/mustermann_spec.rb

@@ -1,4 +1,4 @@
-if RUBY_VERSION =~ /^2\./ and RUBY_PLATFORM != 'java'
+if RUBY_VERSION =~ /^2\.(\d)/ and $1.to_i > 0 and RUBY_PLATFORM != 'java'
 
   require_relative '../spec_helper'
   require 'angelo/mustermann'

data/test/angelo/static_spec.rb

@@ -19,15 +19,23 @@ describe Angelo::Server do
       end
 
       get '/img' do
-        send_file 'what.png'
+        send_file 'public/what.png'
       end
 
       get '/what' do
-        send_file 'what.png', disposition: :attachment
+        send_file 'public/what.png', disposition: :attachment
       end
 
       get '/attachment.png' do
-        send_file 'what.png', filename: 'attachment.png'
+        send_file 'public/what.png', filename: 'attachment.png'
+      end
+
+      get '/does_not_exist' do
+        send_file 'does_not_exist'
+      end
+
+      get '/etc/passwd' do
+        send_file '/etc/passwd'
       end
 
     end
@@ -100,5 +108,22 @@ describe Angelo::Server do
       last_response.headers['Content-Disposition'].must_equal 'attachment; filename="attachment.png"'
     end
 
+    it '404s when send_file is called with a non-existent file' do
+      get '/does_not_exist'
+      last_response.status.must_equal 404
+    end
+
+    it 'sends fully pathed fileds' do
+      get '/etc/passwd'
+      if File.exist?('/etc/passwd')
+        last_response.status.must_equal 200
+        last_response.headers['Content-Type'].must_equal 'text/html'
+        last_response.headers['Content-Disposition'].must_be_nil
+        last_response.body.must_equal File.read('/etc/passwd')
+      else
+        last_response.status.must_equal 404
+      end
+    end
+
   end
 end

data/test/test_app_root/views/index.js.erb

@@ -0,0 +1,2 @@
+var foo = "<%= @foo %>";
+var bar = "<%= bar %>";

data/test/test_app_root/views/index.json.erb

@@ -0,0 +1 @@
+{"foo": "<%= @foo %>", "bar": ["<%= bar %>"]}

data/test/test_app_root/views/index.xml.erb

@@ -0,0 +1 @@
+<foo bar="<%= bar %>"><%= @foo %></foo>

data/test/test_app_root/views/layout.js.erb

@@ -0,0 +1,3 @@
+(function() {
+  <%= yield %>
+})();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angelo
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-11 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reel
@@ -82,7 +82,11 @@ files:
 - test/test_app_root/public/test.js
 - test/test_app_root/public/what.png
 - test/test_app_root/views/index.html.erb
+- test/test_app_root/views/index.js.erb
+- test/test_app_root/views/index.json.erb
+- test/test_app_root/views/index.xml.erb
 - test/test_app_root/views/layout.html.erb
+- test/test_app_root/views/layout.js.erb
 homepage: https://github.com/kenichi/angelo
 licenses:
 - apache
@@ -103,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: A Sinatra-esque DSL for Reel