lydia 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c5b7ef25cf346d0026ebcb068c101290b20d358
-  data.tar.gz: 7b0f29651e251ec7a231ef5929e57de53322285f
+  metadata.gz: 674c9480a5fc9134caefdc5cdd657a325b774f3c
+  data.tar.gz: b4fac7a13bf1724d54d47dd205cb08fd8b72061c
 SHA512:
-  metadata.gz: b2007f3265c8aa888d328d0a054a524603939a5a463661aaa2d704af650c5b23bfafa9b9e34f83a4a91135cb3282890bfa4567e559fcfb1e3be657748f777f52
-  data.tar.gz: c0a9e836f9e04d48c096656f563c8cde80bede7e61f0b08411085a6d9496a49169aff9b115d4cdf4eb19083a3cf56d9c0d4e6feb5d0dd9cc584a55a171749fa3
+  metadata.gz: 5e0623433d619e658d3b2d7a6e13d029e4661771ad747977b7ce43e24f4904d619dead18d1c48374bcbe2d6e65fb46f8d7050418b71d7893d8ff5e845bce2f8e
+  data.tar.gz: dfddf8e23a78e7ec479f9acc1264d767ade0c22092205994556ac76d578179f40fd8d82ca189cf86145660b69bf149225f0751806f828578581cf8235f35a0a9

data/.rubocop.yml

@@ -0,0 +1,61 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'db/migrate/*'
+    - 'db/schema.rb'
+    - 'config/**/*'
+    - 'bin/*'
+    - lydia.gemspec
+    # Other common or autogenerated ignores
+    - 'lib/tasks/cucumber.rake'
+    # Project specific ignores goes here
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Metrics/LineLength:
+  Max: 100
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+Rails/HttpPositionalArguments:
+  Enabled: false

data/.travis.yml

@@ -1,11 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
+  - 2.2.2
   - 2.3.0
-  - rbx-2
-  - jruby
-before_install: gem install bundler -v 1.10.6
+  - 2.3.1
+before_install: gem install bundler

data/README.md

@@ -13,9 +13,7 @@ Lightweight, fast and easy to use small ruby web framework.
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'lydia'
-```
+    gem 'lydia'
 
 And then execute:
 
@@ -27,7 +25,7 @@ Or install it yourself as:
 
 ## Another ruby web framework? WTF?
 
-This project is not intended to become a top notch framework or the new rails, it's just an experiment. 
+This project is not intended to become a top notch framework or the new rails, it's just an experiment.
 The goals of this project are:
 
 * [Rack](https://github.com/rack/rack/) based.
@@ -44,35 +42,35 @@ The goals of this project are:
 ## Usage
 
 ### First example
-Create a ruby file, fior example hello_world.rb, require 'lydia' and using the routing functions without creating an application object.
+Create a ruby file, for example hello_world.rb, require 'lydia' and using the routing functions without creating an application object.
 
     require 'lydia'
-    
+
     get '/' do
       'Hello world!'
     end
 
 Just run it to start a webrick server that responds hello world to root.
-    
-    $ ruby hello_world.rb 
+
+    $ ruby hello_world.rb
 
 ### Application
 If preferred it's possible to create an application object and run using rackup command, in this case don't require lydia but lydia/application to avoid the server auto start. For example a minimal config.ru file can be:
 
     require 'lydia/application'
-    
+
     class App < Lydia::Application
       get '/' do
         'Hello world!'
       end
     end
-    
+
     run App.new
-    
+
 Start the server using rackup command:
 
     $ rackup
-    
+
 ### Router
 
 #### Stand alone router
@@ -80,10 +78,10 @@ If needed the router can be used stand alone, for example if best performances a
 Stand alone example, note that the return type must be in rack standard format, an array of three that is status, header, body (as array):
 
     require 'lydia/router'
-    
+
     class App < Lydia::Router
       get '/' do
-        body = 'Hellow world!' 
+        body = 'Hello world!'
         [200, { 'Content-Type' => 'text/html', 'Content-Length' => body.length.to_s }, [body]]
       end
     end
@@ -91,26 +89,101 @@ Stand alone example, note that the return type must be in rack standard format,
 #### HTTP verbs
 Supports standard HTTP verbs: HEAD GET PATCH PUT POST DELETE OPTIONS.
 
-### DOCUMENTATION IN PROGRESS...
+#### Query parameters
 
-#### Parameters
+    # matches /querystring&name=mirko
+    get '/querystring' do
+      # do something
+      # request.params[:name] contains 'mirko'
+    end
 
-#### Wildcards
+#### Wildcard
+
+    # matches /wildcard/everything
+    get '/wildcard/* ' do
+      # do something
+    end
 
 #### Named route parameters
 
+    # matches /users/1/comments/3/edit
+    get '/users/:id/comments/:comment_id' do
+      # do something
+      # request.params[:id] contains 1
+      # request.params[:comment_id] contains 3
+    end
+
+Automatically add to response.params every route params.
+
 #### Regular expressions
 
-#### Not found routes and errors
+    # matches /regexp
+    get %r{/regexp$}i do
+      # do something
+    end
 
 #### Skip to next route
+To skip to the next matching route use next_route method.
+
+    get '/next_route' do
+      next_route
+    end
+
+    get '/next_route' do
+      'Hello this is the next route'
+    end
 
 #### Halting
+To halt the execution raising an Halt error use halt method, by default the standard halt page is displayed but it's possible to pass a custom response as halt parameter.
+
+    get '/halt' do
+      halt
+    end
+
+    get '/custom_halt' do
+      halt 'Custom halt'
+    end
 
 ### Return types
+Lydia supports various returns types other that the standard rack response object. The supported type are:
+
+#### Rack::Response or Lydia::Response
+Using the standard rack response the framework does nothing other than pass the response to rack. If response finish method was not called the framework will.
+
+#### String
+Returning a string is intended as the response body, the headers and a 200 status are automatically added.
+
+#### Array of 2 or 3 elements
+Returning an array of 2 elements means that the first is the status and the second the body.
+Returning an array of 3 elements means that the first is the status, the second the headers, and the third the body.
+
+#### Fixnum
+Returning a fixnum is intended as the response code. Useful to return a response code without a body.
+
+#### Hash
+An hash is intended as a json, json content type is automatically added.
+
+#### Object that responds to :each
+Returning a generic object is admitted accorind rack specifications if responds to :each method.
 
 ### Filters
 
+#### Before and after Filters
+Before and after filters are available as in the following example:
+
+    before do
+      # do something
+    end
+
+    after do
+      # do something
+    end
+
+#### Redirects
+To define a redirect use the following syntax:
+
+    redirect '/from_route', to: '/to_route'
+
 ### Templates
 
 Extensive templates support using [tilt](https://github.com/rtomayko/tilt/)
@@ -118,8 +191,7 @@ To render a template simply use the render function:
 
     get '/render_erb' do
       render 'template.erb', nil, message: 'template'
-    end 
-
+    end
 
 ### Helpers
 
@@ -135,7 +207,7 @@ It's possible to read request parameters using params helper:
 
     get '/test' do
       params['my_param']
-    end 
+    end
 
 #### Content type
 It's possible to force the response return type using content_type helper:
@@ -157,4 +229,3 @@ It's possible to force the response return type using content_type helper:
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "lydia/application"
+require 'bundler/setup'
+require 'lydia/application'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "lydia/application"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/examples/{example2.rb → config.ru}

@@ -6,3 +6,5 @@ class App < Lydia::Application
     'Hello world!'
   end
 end
+
+run App.new

data/examples/hello_world.rb

@@ -3,4 +3,4 @@ require 'lydia'
 
 get '/' do
   'Hello world!'
-end
+end

data/lib/lydia.rb

@@ -4,7 +4,7 @@ require 'lydia/delegator'
 require 'lydia/version'
 
 module Lydia
-  at_exit { Rack::Handler.default.run(Application) }
+  at_exit { Rack::Handler.default.run(Application.new) }
 end
 
-extend Lydia::Delegator
+extend Lydia::Delegator

data/lib/lydia/application.rb

@@ -12,7 +12,7 @@ module Lydia
     include Templates
     include Filters
     include Helpers
-    
+
     def process
       result = super
       if result.nil?
@@ -23,31 +23,28 @@ module Lydia
         @response.build(result)
       end
     end
-    
+
     def new_request(env)
       Lydia::Request.new(env)
     end
-    
+
     def new_response(body = [], status = 200, header = {})
       Lydia::Response.new(body, status, header)
     end
-    
+
     class << self
       extend Forwardable
-      
+
       def_delegators :builder, :map, :use, :run
-      
+
       def builder
         @builder ||= Rack::Builder.new
       end
 
-      alias new! new
-      
       def new(*args, &bk)
-        app = new!(*args, &bk)
-        builder.run(app)
+        builder.run(super(*args, &bk))
         builder.to_app
       end
     end
-  end  
+  end
 end

data/lib/lydia/delegator.rb

@@ -4,9 +4,9 @@ require 'forwardable'
 module Lydia
   module Delegator
     extend Forwardable
-    def_delegators  Lydia::Application, 
+    def_delegators  Lydia::Application,
                     :head, :get, :patch, :put, :post, :delete, :options,
                     :namespace, :before, :after,
                     :map, :use, :run
   end
-end
+end

data/lib/lydia/filters.rb

@@ -5,24 +5,24 @@ module Lydia
     def self.included(base)
       base.extend(ClassMethods)
     end
-    
+
     module ClassMethods
       def filters
         @filters ||= Hash.new { |h, k| h[k] = [] }
       end
-      
+
       %w(before after).each do |filter|
         define_method(filter) do |pattern = '/*', options = {}, &block|
           filters[filter.to_sym] << Route.new(filter, @namespace || '', pattern, options, &block)
         end
       end
-      
+
       def redirect(pattern, options = {})
         return ArgumentError.new('Options must contains :to') unless options.include?(:to)
         filters[:redirect] << Route.new('redirect', @namespace || '', pattern, options)
       end
     end
-    
+
     def dispatch(env)
       process_redirects(env)
       process_before_filters(env)
@@ -30,7 +30,7 @@ module Lydia
       process_after_filters(env)
       result
     end
-    
+
     %w(before after).each do |filter_type|
       define_method("process_#{filter_type}_filters") do |env|
         self.class.filters[filter_type.to_sym].each do |filter|
@@ -38,15 +38,14 @@ module Lydia
         end
       end
     end
-    
+
     def process_redirects(env)
       self.class.filters[:redirect].each do |redirect|
-        if redirect.match?(env)
-          env['PATH_INFO'] = redirect.namespace + redirect.options[:to]
-          @request = new_request(env)
-          break
-        end
+        next unless redirect.match?(env)
+        env['PATH_INFO'] = redirect.namespace + redirect.options[:to]
+        @request = new_request(env)
+        break
       end
     end
   end
-end
+end