racket-mvc 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa507274155a8638944da1b19957b0423499a3aa
-  data.tar.gz: 54631b41e9a2ec392b7bb41fd23a87c93ea1df02
+  metadata.gz: d06a12ceb8db8f9e2cafd0d649048e03da1e7644
+  data.tar.gz: 7534148f29e1c2c00b65800c4b1fa41ea3705a08
 SHA512:
-  metadata.gz: e1e402abcbadc38764b851c7b014e39493692b71247f0db412d75d063b5c844c9048c2faa2dc695f37cb53ee9809d8386a2cae994d0b76afa10952f0889af03e
-  data.tar.gz: 65c154fb5ecdb60e364500614f7f7eb1346d3054a1923ec092a0cf52c874a16b150cd383d2aca07cd0ad9dd8455a4500bdde53a24e26b87601f80f946d8bfe29
+  metadata.gz: a929335cdea51bbabbc0f0531de67cacf63177ec042f33dfd373454c2284e06603da7ee50b188584d76db7de02572bb99de0cbfdeb57259e903b2feb4d4470c0
+  data.tar.gz: bb0f3f128237c989d4937d612d5c0b6dc9d248f72e7233fc5900672526d9c72760816ba2fa53ed50c784bcb1dbf2e602b00237e9bca07a7a06d0e89afe2cbb18

data/README.md

@@ -29,7 +29,8 @@ Have a look in the `spec` directory. The code base have tests covering 100 per c
 - ruby 2.0
 - ruby 2.1.6
 - ruby 2.2.2
-- jruby (latest version, 1.9 mode only)
+- jruby 1.7 (1.9 mode only)
+- jruby 9.0.0.0
 - rbx-2 (latest version)
 
 I am using [bacon](https://github.com/chneukirchen/bacon) and [rack-test](https://github.com/brynary/rack-test) for testing. Run the tests by typing `rake test`in the root directory. Code coverage reports are provided by [simplecov](https://rubygems.org/gems/simplecov). After the tests have run the an HTML report can be found in the `coverage` directory.

data/lib/racket/application.rb

@@ -100,7 +100,7 @@ module Racket
     # @param [Symbol] action
     # @param [Array] params
     # @return [String]
-    def self.get_route(controller, action, params)
+    def self.get_route(controller, action = nil, *params)
       @router.get_route(controller, action, params)
     end
 

data/lib/racket/helpers/file.rb

@@ -0,0 +1,55 @@
+# Racket - The noisy Rack MVC framework
+# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+#
+# This file is part of Racket.
+#
+# Racket is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Racket is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Racket.  If not, see <http://www.gnu.org/licenses/>.
+
+module Racket
+  # Helpers module
+  module Helpers
+    # Helper module that handles files
+    module File
+      # Sends the contents of a file to the client.
+      #
+      # @param [String] file
+      # @param [Hash] options
+      # @return [Array]
+      def send_file(file, options = {})
+        file = Utils.build_path(file)
+        # Respond with a 404 Not Found if the file cannot be read.
+        respond!(
+          404,
+          { 'Content-Type' => 'text/plain' },
+          Rack::Utils::HTTP_STATUS_CODES[404]
+        ) unless Utils.file_readable? (file)
+        headers = {}
+        mime_type = options.fetch(:mime_type, nil)
+        # Calculate MIME type if it was not already specified.
+        mime_type = Rack::Mime.mime_type(::File.extname(file)) unless mime_type
+        headers['Content-Type'] = mime_type
+        # Set Content-Disposition (and a file name) if the file should be downloaded
+        # instead of displayed inline.
+        if options.fetch(:download, false)
+          filename = options.fetch(:filename, nil).to_s
+          headers['Content-Disposition'] = 'attachment'
+          headers['Content-Disposition'] << sprintf('; filename="%s"', filename) unless
+            filename.empty?
+        end
+        # Send response
+        respond!(200, headers, ::File.read(file))
+      end
+    end
+  end
+end

data/lib/racket/helpers/routing.rb

@@ -27,7 +27,7 @@ module Racket
       # @param [Symbol] action
       # @param [Array] params
       # @return [String]
-      def route(controller, action, *params)
+      def route(controller, action = nil, *params)
         Application.get_route(controller, action, params)
       end
 
@@ -38,7 +38,7 @@ module Racket
       # @param [Symbol] action
       # @param [Array] params
       # @return [String]
-      def route_self(action, *params)
+      def route_self(action = nil, *params)
         Application.get_route(self.class, action, params)
       end
 

data/lib/racket/request.rb

@@ -17,14 +17,39 @@
 # along with Racket.  If not, see <http://www.gnu.org/licenses/>.
 
 module Racket
-  # Represents an incoming request. Mostly matches Rack::Request but removes some methods that
-  # don't fit with racket.
+  # Represents an incoming request. Mostly matches Rack::Request but removes/redefines
+  # methods relating to GET/POST parameters and sessions.
   class Request < Rack::Request
-    # Force explicit use of request.GET and request.POST
-    # For racket params, use racket.params
-    undef_method :params
+    # Remove methods that use merged GET and POST data.
+    undef_method :[], :[]=, :delete_param, :params, :update_param, :values_at
 
-    # Unless sessions are loaded explicitly, session methods should not be available
+    # Remove session methods.
     undef_method :session, :session_options
+
+    # Redefine methods for handling GET parameters
+    alias_method(:get_params, :GET)
+    undef_method :GET
+
+    # Returns a value from the GET parameter hash.
+    #
+    # @param [Object] key
+    # @param [Object] default
+    # @return [Object]
+    def get(key, default = nil)
+      get_params.fetch(key.to_s, default)
+    end
+
+    # Redefine methods for handling POST parameters
+    alias_method(:post_params, :POST)
+    undef_method :POST
+
+    # Returns a value from the POST parameter hash.
+    #
+    # @param [Object] key
+    # @param [Object] default
+    # @return [Object]
+    def post(key, default = nil)
+      post_params.fetch(key.to_s, default)
+    end
   end
 end

data/lib/racket/router.rb

@@ -51,10 +51,11 @@ module Racket
     # @param [Array] params
     # @return [String]
     def get_route(controller, action, params)
+      fail "Cannot find controller #{controller}" unless @routes_by_controller.key?(controller)
+      params.flatten!
       route = ''
-      route << @routes_by_controller[controller] if @routes_by_controller.key?(controller)
-      action = action.to_s
-      route << "/#{action}" unless action.empty?
+      route << @routes_by_controller[controller]
+      route << "/#{action}" unless action.nil?
       route << "/#{params.join('/')}" unless params.empty?
       route = route[1..-1] if route.start_with?('//') # Special case for root path
       route

data/lib/racket/version.rb

@@ -23,10 +23,10 @@ module Racket
     # Major version
     MAJOR = 0
     # Minor version
-    MINOR = 1
+    MINOR = 2
     # Teeny version
-    TEENY = 1
-    # Prerelease ?
+    TEENY = 0
+    # Is it a prerelease?
     PRERELEASE = false
 
     # Returns the current version of Racket as a string.

data/lib/racket/view_cache.rb

@@ -34,12 +34,14 @@ module Racket
     # @param [Controller] controller
     # @return [Hash]
     def render(controller)
+      template_path = [Application.get_route(controller.class), controller.racket.action].join('/')
+      template_path = template_path[1..-1] if template_path.start_with?('//')
       template =
-        find_template(controller.request.path, controller.controller_option(:default_view))
+        find_template(template_path, controller.controller_option(:default_view))
       if template
         output = Tilt.new(template).render(controller)
         layout =
-          find_layout(controller.request.path, controller.controller_option(:default_layout))
+          find_layout(template_path, controller.controller_option(:default_layout))
         output = Tilt.new(layout).render(controller) { output } if layout
       else
         output = controller.racket.action_result

data/spec/_custom.rb

@@ -66,4 +66,44 @@ describe 'A custom Racket test Application' do
     last_response.headers['Content-Type'].should.equal('text/html')
     last_response.body.should.equal("The secret is 42!\n")
   end
+
+  it 'should be able to send files with auto mime type' do
+    get '/sub1/send_existing_file_auto_mime'
+    last_response.status.should.equal(200)
+    last_response.headers['Content-Type'].should.equal('text/plain')
+    last_response.headers.key?('Content-Disposition').should.equal(false)
+    last_response.body.should.equal("This is plain text.\n")
+  end
+
+  it 'should be able to send files with custom mime type' do
+    get '/sub1/send_existing_file_custom_mime'
+    last_response.status.should.equal(200)
+    last_response.headers['Content-Type'].should.equal('text/skv')
+    last_response.headers.key?('Content-Disposition').should.equal(false)
+    last_response.body.should.equal("This is plain text.\n")
+  end
+
+  it 'should be able to send unnamed files with Content-Disposition' do
+    get '/sub1/send_existing_file_unnamed_attachment'
+    last_response.status.should.equal(200)
+    last_response.headers['Content-Type'].should.equal('text/plain')
+    last_response.headers['Content-Disposition'].should.equal('attachment')
+    last_response.body.should.equal("This is plain text.\n")
+  end
+
+  it 'should be able to send named files with Content-Disposition' do
+    get '/sub1/send_existing_file_named_attachment'
+    last_response.status.should.equal(200)
+    last_response.headers['Content-Type'].should.equal('text/plain')
+    last_response.headers['Content-Disposition'].should.equal('attachment; filename="bazinga!.txt"')
+    last_response.body.should.equal("This is plain text.\n")
+  end
+
+  it 'should respond with 404 when trying to send non-existing files' do
+    get '/sub1/send_nonexisting_file'
+    last_response.status.should.equal(404)
+    last_response.headers['Content-Type'].should.equal('text/plain')
+    last_response.headers.key?('Content-Disposition').should.equal(false)
+    last_response.body.should.equal("Not Found")
+  end
 end

data/spec/_default.rb

@@ -31,7 +31,7 @@ describe 'A default Racket test Application' do
     actions_by_controller[DefaultSubController1].length.should.equal(4)
     actions_by_controller[DefaultSubController1].include?(:route_to_root).should.equal(true)
     actions_by_controller[DefaultSubController1].include?(:route_to_nonexisting).should.equal(true)
-    actions_by_controller[DefaultSubController2].length.should.equal(3)
+    actions_by_controller[DefaultSubController2].length.should.equal(5)
     actions_by_controller[DefaultSubController2].include?(:index).should.equal(true)
     actions_by_controller[DefaultSubController2].include?(:current_action).should.equal(true)
     actions_by_controller[DefaultSubController2].include?(:current_params).should.equal(true)
@@ -172,6 +172,28 @@ describe 'A default Racket test Application' do
     )
   end
 
+  it 'should handle GET parameters correctly' do
+    get '/sub2/get_some_data/?data1=foo&data3=bar'
+    last_response.status.should.equal(200)
+    response = JSON.parse(last_response.body, symbolize_names: true)
+    response.class.should.equal(Hash)
+    response.keys.sort.should.equal([:data1, :data2, :data3])
+    response[:data1].should.equal('foo')
+    response[:data2].should.equal(nil)
+    response[:data3].should.equal('bar')
+  end
+
+  it 'should handle POST parameters correctly' do
+    post '/sub2/post_some_data', { data1: 'foo', data3: 'bar' }
+    last_response.status.should.equal(200)
+    response = JSON.parse(last_response.body, symbolize_names: true)
+    response.class.should.equal(Hash)
+    response.keys.sort.should.equal([:data1, :data2, :data3])
+    response[:data1].should.equal('foo')
+    response[:data2].should.equal(nil)
+    response[:data3].should.equal('bar')
+  end
+
   it 'should be able to serve static files' do
     get '/hello.txt'
     last_response.status.should.equal(200)

data/spec/_request.rb

@@ -0,0 +1,49 @@
+describe 'Racket::Request should override Rack::Request correctly' do
+
+  r = Racket::Request.new({}).freeze
+
+  describe 'Racket::Request should inherit some methods from Rack::Request' do
+    [
+      :accept_encoding, :accept_language, :base_url, :body, :content_charset, :content_length,
+      :content_type, :cookies, :delete?, :env, :form_data?, :fullpath, :get?, :head?, :host,
+      :host_with_port, :ip, :link?, :logger, :media_type, :media_type_params, :options?,
+      :parseable_data?, :patch?, :path, :path_info, :path_info=, :port, :post?, :put?,
+      :query_string, :referer, :referrer, :request_method, :scheme, :script_name, :script_name=,
+      :ssl?, :trace?, :trusted_proxy?, :unlink?, :url, :user_agent, :xhr?
+    ].each do |meth|
+      it "should inherit #{meth} from Rack::Request" do
+        r.respond_to?(meth).should.equal(true)
+      end
+    end
+  end
+
+  describe 'Racket::Request should not inherit methods that use merged GET and POST data' do
+    [:[], :[]=, :delete_param, :params, :update_param, :values_at].each do |meth|
+      it "should not inherit #{meth} from Rack::Request" do
+        r.respond_to?(meth).should.equal(false)
+      end
+    end
+  end
+
+  describe 'Racket::Request should not inherit session methods' do
+    [:session, :session_options].each do |meth|
+      it "should not inherit #{meth} from Rack::Request" do
+        r.respond_to?(meth).should.equal(false)
+      end
+    end
+  end
+
+  describe 'Racket::Request should redefine methods for handling GET/POST data' do
+    [:get, :get_params, :post, :post_params].each do |meth|
+      it "should define #{meth}" do
+        r.respond_to?(meth).should.equal(true)
+      end
+    end
+    [:GET, :POST].each do |meth|
+      it "should not define #{meth}" do
+        r.respond_to?(meth).should.equal(false)
+      end
+    end
+  end
+
+end

data/spec/racket.rb

@@ -15,9 +15,15 @@ TEST_DEFAULT_APP_DIR = File.absolute_path(File.join(File.dirname(__FILE__), 'tes
 TEST_CUSTOM_APP_DIR = File.absolute_path(File.join(File.dirname(__FILE__), 'test_custom_app'))
 
 require 'racket'
+
+# Make sure some files that are loaded dynamically get coverage as well.
+require 'racket/helpers/file.rb'
+
 require 'rack/test'
 require 'bacon'
 
+require_relative '_request.rb'
+
 Dir.chdir(TEST_DEFAULT_APP_DIR) { require_relative '_default.rb' }
 Dir.chdir(TEST_CUSTOM_APP_DIR) { require_relative '_custom.rb' }
 

data/spec/test_custom_app/controllers/sub1/custom_sub_controller_1.rb

@@ -1,5 +1,7 @@
 class CustomSubController1 < Racket::Controller
 
+  helper :file
+
   def index
     "#{self.class}::#{__method__}"
   end
@@ -11,9 +13,29 @@ class CustomSubController1 < Racket::Controller
   def route_to_nonexisting
     r(CustomInheritedController, :nonono, :with, :params)
   end
-  
+
   def epic_fail
     fail 'Epic fail!'
   end
 
+  def send_existing_file_auto_mime
+    send_file('files/plain_text.txt')
+  end
+
+  def send_existing_file_custom_mime
+    send_file('files/plain_text.txt', mime_type: 'text/skv')
+  end
+
+  def send_existing_file_unnamed_attachment
+    send_file('files/plain_text.txt', download: true)
+  end
+
+  def send_existing_file_named_attachment
+    send_file('files/plain_text.txt', download: true, filename: 'bazinga!.txt')
+  end
+
+  def send_nonexisting_file
+    send_file('files/no_such_thing.jpg')
+  end
+
 end

data/spec/test_custom_app/files/plain_text.txt

@@ -0,0 +1 @@
+This is plain text.

data/spec/test_default_app/controllers/default_root_controller.rb

@@ -15,7 +15,7 @@ class DefaultRootController < Racket::Controller
   end
 
   def session_as_json
-    request.GET.each_pair do |key, value|
+    request.get_params.each_pair do |key, value|
       if key == 'drop_session'
         session.clear
       else

data/spec/test_default_app/controllers/sub2/default_sub_controller_2.rb

@@ -12,4 +12,20 @@ class DefaultSubController2 < Racket::Controller
     racket.params.to_json
   end
 
+  def get_some_data
+    data = {}
+    [:data1, :data2, :data3].each do |d|
+      data[d] = request.get(d)
+    end
+    data.to_json
+  end
+
+  def post_some_data
+    data = {}
+    [:data1, :data2, :data3].each do |d|
+      data[d] = request.post(d)
+    end
+    data.to_json
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: racket-mvc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Lars Olsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-26 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_router
@@ -98,16 +98,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +126,14 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Racket is a small MVC framework built on top of rack.
@@ -149,6 +149,7 @@ files:
 - lib/racket/application.rb
 - lib/racket/controller.rb
 - lib/racket/current.rb
+- lib/racket/helpers/file.rb
 - lib/racket/helpers/routing.rb
 - lib/racket/helpers/view.rb
 - lib/racket/request.rb
@@ -161,6 +162,7 @@ files:
 - spec/_custom.rb
 - spec/_default.rb
 - spec/_invalid.rb
+- spec/_request.rb
 - spec/racket.rb
 - spec/test_custom_app/controllers/sub1/custom_sub_controller_1.rb
 - spec/test_custom_app/controllers/sub2/custom_sub_controller_2.rb
@@ -168,6 +170,7 @@ files:
 - spec/test_custom_app/controllers/sub3/inherited/custom_inherited_controller.rb
 - spec/test_custom_app/extra/blob.rb
 - spec/test_custom_app/extra/blob/inner_blob.rb
+- spec/test_custom_app/files/plain_text.txt
 - spec/test_custom_app/files/secret.erb
 - spec/test_custom_app/layouts/sub2/zebra.erb
 - spec/test_custom_app/templates/sub2/template.erb