lydia 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf7ff0ab21d348d83cab7edbf2fc60dc0d2742fa
-  data.tar.gz: 9160af15569f5469cb8f02c30b44cbbe489e196e
+  metadata.gz: 90fa262cf72761e1c2ac13b898504e3216950b23
+  data.tar.gz: 637bc940ba3a7cb2a6fe46594315d63c8c233cd2
 SHA512:
-  metadata.gz: 9a5fcbdeddb34ef8ab94d6408af99f37ddb2bd453196748e578612bb4e5cf821be42d1c074e7a65cc581dec33c8e46315ceeeee00cadb24bf3bf4c638700d9af
-  data.tar.gz: 2415bbd84f8af49363d86877ab5750984594b3581303d32f21a14699ba865e3331fc57bed6690c84db3900f25e991b24a2662ba0e499a5d70ec684523309ab1c
+  metadata.gz: 97f5a3dc0bdcf5baf7d5c3d52ce39b247142bf364d43604f2d0c1c3367aff5f18acd2db943b69b9c916f8a1106c1454bce1afcb2230aa131c2c7d2fdb397860c
+  data.tar.gz: 5b104d388ce7ebd061cd01fbdff890365f8fa39c922955263702b9d930c13be6e13779be281d29c678d49d5428d456c9fecef3e40b642739d7a181d806173086

data/README.md

@@ -1,6 +1,9 @@
 [![Build Status](https://travis-ci.org/MirkoMignini/lydia.svg)](https://travis-ci.org/MirkoMignini/lydia)
 [![Coverage Status](https://coveralls.io/repos/MirkoMignini/lydia/badge.svg?branch=master&service=github)](https://coveralls.io/github/MirkoMignini/lydia?branch=master)
 [![Code Climate](https://codeclimate.com/github/MirkoMignini/lydia/badges/gpa.svg)](https://codeclimate.com/github/MirkoMignini/lydia)
+[![Gem Version](https://badge.fury.io/rb/lydia.svg)](https://badge.fury.io/rb/lydia)
+[![Dependency Status](https://gemnasium.com/MirkoMignini/lydia.svg)](https://gemnasium.com/MirkoMignini/lydia)
+[![security](https://hakiri.io/github/MirkoMignini/lydia/master.svg)](https://hakiri.io/github/MirkoMignini/lydia/master)
 
 # Lydia
 
@@ -40,7 +43,74 @@ The goals of this project are:
 
 ## Usage
 
-Usage instructions soon available!
+### First example
+Create a ruby file, fior 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 
+
+### 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
+If needed the router can be used stand alone, for example if best performances are needed, or used via the application class, slower but with a lot of more features.
+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!' 
+        [200, { 'Content-Type' => 'text/html', 'Content-Length' => body.length.to_s }, [body]]
+      end
+    end
+
+#### HTTP verbs
+
+#### Parameters
+
+#### Wildcards
+
+#### Named route parameters
+
+#### Regular expressions
+
+#### Not found routes and errors
+
+#### Skip to next route
+
+#### Halting
+
+### Return types
+
+### Filters
+
+### Templates
+
+### Helpers
 
 ## Contributing
 

data/examples/example2.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'lydia/application'
+
+class App < Lydia::Application
+  get '/' do
+    'Hello world!'
+  end
+end

data/lib/lydia/filters.rb

@@ -13,13 +13,13 @@ module Lydia
       
       %w(before after).each do |filter|
         define_method(filter) do |pattern = '/*', options = {}, &block|
-          filters[filter.to_sym] << Route.new(@namespace || '', 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(@namespace || '', pattern, options)
+        filters[:redirect] << Route.new('redirect', @namespace || '', pattern, options)
       end
     end
     

data/lib/lydia/helpers.rb

@@ -12,7 +12,7 @@ module Lydia
       @request.params
     end
     
-    def send_file(path, mime_type = nil)
+    def send_file(_path, _mime_type = nil)
       raise NotImplementedError.new
     end
   end

data/lib/lydia/response.rb

@@ -1,4 +1,5 @@
 require 'rack/response'
+require 'json'
 
 module Lydia
   class Response < Rack::Response    

data/lib/lydia/route.rb

@@ -1,11 +1,12 @@
 module Lydia
   class Route    
-    attr_reader :regexp, :params, :namespace, :pattern, :options, :block
+    attr_reader :regexp, :params, :request_method, :namespace, :pattern, :options, :block
     
     WILDCARD_REGEX = /\/\*(.*)/.freeze
     NAMED_SEGMENTS_REGEX = /\/([^\/]*):([^:$\/]+)/.freeze
 
-    def initialize(namespace, pattern, options = {}, &block)
+    def initialize(request_method, namespace, pattern, options = {}, &block)
+      @request_method = request_method
       @namespace = namespace
       @pattern = pattern
       @options = options
@@ -21,7 +22,7 @@ module Lydia
         end
         @regexp = Regexp.new("\\A#{result}\\z")
       elsif pattern.is_a?(Regexp)
-        @regexp = pattern
+        @regexp = Regexp.new((namespace || '') + pattern.to_s)
       else
         raise ArgumentError.new('Pattern must be a string or a regex')
       end

data/lib/lydia/router.rb

@@ -18,20 +18,16 @@ module Lydia
       
       %w(HEAD GET PATCH PUT POST DELETE OPTIONS).each do |request_method|
         define_method(request_method.downcase) do |pattern, options = {}, &block|
-          routes[request_method] << Route.new(@namespace, pattern, options, &block)
+          routes[request_method] << Route.new(request_method, @namespace, pattern, options, &block)
         end
       end
       
-      def namespace(pattern, options = {})
+      def namespace(pattern, _options = {})
         prev_namespace = @namespace ||= ''
         @namespace += pattern
         yield
         @namespace = prev_namespace
       end
-      
-      def call(env)
-        new.call(env)
-      end
     end
     
     def next_route
@@ -71,8 +67,12 @@ module Lydia
         internal_server_error(env, exception)
     end
     
+    def routes
+      self.class.routes
+    end
+    
     def dispatch(env)
-      self.class.routes[env['REQUEST_METHOD']].each do |route|
+      routes[env['REQUEST_METHOD']].each do |route|
         if route.match?(env)
           @request.params.merge!(route.params) if route.params
           catch(:next_route) do

data/lib/lydia/version.rb

@@ -1,3 +1,3 @@
 module Lydia
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lydia.gemspec

@@ -25,7 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'haml'
   
-  spec.add_dependency 'rack'
+  spec.add_dependency 'rack', '~> 1.6.4'
   spec.add_dependency 'tilt'
 end

data/spec/application_spec.rb

@@ -17,7 +17,7 @@ describe "Application" do
     use Rack::Lint
 
     map '/api' do
-      run API
+      run API.new
     end
     
     get '/response' do
@@ -33,7 +33,7 @@ describe "Application" do
   end
   
   def app
-    TestApplication
+    TestApplication.new
   end
   
   context 'Composition' do

data/spec/helpers_spec.rb

@@ -18,6 +18,10 @@ describe "Helpers" do
     get '/params' do
       params['key']
     end
+    
+    get '/file' do
+      send_file('test.png')
+    end
   end
   
   def app
@@ -42,4 +46,10 @@ describe "Helpers" do
     expect(last_response.status).to eq(200)
     expect(last_response.body).to eq('value')
   end
+  
+  it 'sends a file' do
+    expect {
+      get '/file'
+    }.to raise_error(NotImplementedError)
+  end
 end

data/spec/router_spec.rb

@@ -30,6 +30,10 @@ describe "Router" do
       get '/hello' do
         get_response('Hello from namespace')
       end
+
+      get %r{/regular$}i do
+        get_response('Regexp inside namespace')
+      end        
       
       namespace '/nested' do
         get '/hello' do
@@ -180,6 +184,11 @@ describe "Router" do
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('Namespace api version 3')
       end    
+      
+      it 'GET /namespace/regular' do
+        get '/namespace/regular'
+        expect(last_response.status).to eq(200)
+      end
     end        
 
     context 'Wildcards' do
@@ -283,11 +292,7 @@ describe "Router" do
     end    
   end
 
-  context 'Class methods' do    
-    it 'responds to call' do
-      expect(Lydia::Router).to respond_to(:call)
-    end
-    
+  context 'Class methods' do        
     it 'is initialized' do
       get '/'
       expect(last_response.status).to eq(200)

data/spec/templates/template.haml

@@ -0,0 +1 @@
+= message

data/spec/templates_spec.rb

@@ -6,9 +6,13 @@ describe "Templates" do
   include Rack::Test::Methods
 
   class TemplatesHelpers < Lydia::Application
-    get '/render' do
+    get '/render_erb' do
       render 'spec/templates/template.erb', nil, message: 'template'
     end  
+
+    get '/render_haml' do
+      render 'spec/templates/template.haml', Object.new, message: 'template'
+    end
   end
   
   def app
@@ -16,8 +20,14 @@ describe "Templates" do
   end
   
   it 'render an erb template' do
-    get '/render'
+    get '/render_erb'
     expect(last_response.status).to eq(200)
     expect(last_response.body).to include('template')
   end        
-end
+
+  it 'render an haml template' do
+    get '/render_haml'
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to include('template')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lydia
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mirko Mignini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +138,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/example2.rb
 - examples/hello_world.rb
 - lib/lydia.rb
 - lib/lydia/application.rb
@@ -149,6 +164,7 @@ files:
 - spec/router_spec.rb
 - spec/spec_helper.rb
 - spec/templates/template.erb
+- spec/templates/template.haml
 - spec/templates_spec.rb
 homepage: https://github.com/MirkoMignini/lydia
 licenses:
@@ -170,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Lightweight, fast and easy to use small ruby web framework.
@@ -184,4 +200,5 @@ test_files:
 - spec/router_spec.rb
 - spec/spec_helper.rb
 - spec/templates/template.erb
+- spec/templates/template.haml
 - spec/templates_spec.rb