dolphy 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fbd167c947e2d4bbd1a1b10a985c9c467cd0b0f
-  data.tar.gz: 0a3f510552e4e3a79e5cab2d81831f9aa6098fb1
+  metadata.gz: 1c96763e76f5fb25eed8c6b47adee4e5d3177a89
+  data.tar.gz: 2da58ef0dc58f3de39b0db392cbde6f4a913c9ec
 SHA512:
-  metadata.gz: 08ab403c88a8e3c710bc72dbe0816813c4a0b70d759acb80d4e9c8e3c0bd2430ff6ab78dcfa379f5d0086e8d27cef8c34c6db7fcecbd816dd3d06343439bfa44
-  data.tar.gz: f0e12935f25aa99a629a1d9fb61774445747717bebc84cd2e3972878e34f9a7fb508ea02a068dc6568746d519f8db66080024c9f93cf2cc68cffa306e3d10aba
+  metadata.gz: 56e384596a888a55b481a6fd0bdaa51cffcd38b0205ea271875d8eb1f727fed0fb039e21e8830658ecc8cf54a1b8a81a6608d1602b32a6363223fd8b1c1aa424
+  data.tar.gz: e062e34a7e2e782db698c5a2dc9ea2c74d47e1ca851761573e3476e0cf38e0e1d3bce21ec144fd977f63ee35c870147d5a43b92ad8f1dd707bbfeb9e60bc2c22

data/README.md

@@ -1,5 +1,5 @@
 # Dolphy
-[![Build Status](https://magnum.travis-ci.com/majjoha/dolphy.svg?token=G5jfvsY2S8tSb5P53rGq)](https://magnum.travis-ci.com/majjoha/dolphy)
+[![Build Status](https://magnum.travis-ci.com/majjoha/dolphy.svg?token=G5jfvsY2S8tSb5P53rGq&branch=master)](https://magnum.travis-ci.com/majjoha/dolphy)
 [![Code Climate](https://codeclimate.com/repos/53cb2ea469568031fe01ad3f/badges/a7a6a867bc5744c524d7/gpa.png)](https://codeclimate.com/repos/53cb2ea469568031fe01ad3f/feed)
 
 Dolphy is an incredibly small (~200 LOC) web framework written in Ruby and based
@@ -13,7 +13,7 @@ used in production.
 There are a lot of things I want to do to improve the code and functionality of
 this project. I try to list these things in the
 [issues](https://github.com/majjoha/dolphy/issues). Feel free to fork this
-repository and contribute if you want to help me implement features or fixing
+repository and contribute if you want to help me implement features or fix
 bugs.
 
 ## Requirements
@@ -38,47 +38,139 @@ Or simply install it yourself as:
 gem install dolphy
 ```
 
+Create a file `app.rb`:
+
+```ruby
+require 'dolphy'
+
+Dolphy.app do
+  Dolphy.router do
+    get '/' do
+      "Hello, world!"
+    end
+  end
+end.serve!
+```
+
+Run the file:
+
+```
+ruby app.rb
+```
+
+Open the browser at [http://localhost:8080](http://localhost:8080).
+
 ## Usage
+* [Setup blocks](#setup-blocks)
+* [Template engines](#template-engines)
+* [Routes](#routes)
+
+## Setup blocks
+A Dolphy application has a couple of default configurations that you can change
+based on your needs through the `setup` block.
+
+It uses the `Dolphy::TemplateEngines::ErbEngine` by default, and it uses
+`./views/` to find the view files it needs. These can be configured in this way:
+
 ```ruby
 require 'dolphy'
 
 Dolphy.app do
   setup do |app|
-    # It is possible to specify the template engine in the config block. If no
-    # template engine is specified, it will simply default to ERB.
     app.settings[:template_engine] = Dolphy::TemplateEngines::HamlEngine
-
-    # You can also specify a view path where Dolphy will look for views. It is
-    # by default set to `./views/`.
     app.settings[:view_path] = "./somewhere/else/views/"
+  end
 
-    # Configurations are available to the rest of the application defined in the
-    # router block, so we could for instance define a title. Basically, you can
-    # give the settings hash any key value pair that you might find useful to
-    # store for later use.
+  Dolphy.router do
+    get '/' do
+      "Hello, world!"
+    end
+  end
+end.serve!
+```
+
+Since the `Dolphy::Settings` is basically just a hash, we can read from and
+write to, we can also define our own settings to use in the views. We could for
+instance define a title for a page by adding `app.settings[:title] = "Building
+things with Dolphy"` in the `setup` block, which we can access in this way:
+
+```ruby
+Dolphy.app do
+  setup do |app|
     app.settings[:title] = "Building things with Dolphy"
   end
 
   Dolphy.router do
     get '/' do
-      render :index, { title: settings[:title], body: "Hello!" }
+      render :index, title: settings[:title]
     end
+  end
+end.serve!
+```
 
-    get '/login' do
-      render :login
-    end
+## Template engines
+Dolphy supports Haml and ERB by default through the
+`Dolphy::TemplateEngines::HamlEngine` and `Dolphy::TemplateEngine::ErbEngine`
+(which relies on Tilt under the hood), but we can effortlessly build our own
+template engines and use these in our application.
+
+A template engine should have a `.render` method with three arguments: a
+`template_name`, a hash with `locals` and finally a `view_path`.
+
+Imagine we want our views to use [Liquid](http://liquidmarkup.org/), then we
+just need to define a new `LiquidEngine` and make it our template engine in the
+`setup` block:
 
-    post '/post' do
-      render :post, body: "hello #{params["message"]["name"]}"
+```ruby
+class LiquidEngine
+  def self.render(template_name, locals = {}, view_path = "./views/")
+    path = File.expand_path("#{view_path}#{template_name.to_s}.html", Dir.pwd)
+    template = Tilt::LiquidTemplate.new(path)
+    template.render(Object.new, locals)
+  end
+end
+```
+
+```ruby
+Dolphy.app do
+  setup do |app|
+    app.settings[:template_engine] = LiquidEngine
+  end
+
+  Dolphy.router do
+    get '/' do
+      render :new_page
     end
+  end
+end.serve!
+```
 
+## Routes
+The routing layer should look familiar if you've already worked with other Ruby
+frameworks. We can override routes with variables by adding a new route, and we
+use `:name` to access variables in the routes:
+
+```ruby
+require 'dolphy'
+
+Dolphy.app do
+  Dolphy.router do
     get '/hello/:name' do |name|
       render :hello, name: name
     end
+
+    get '/hello/you'
+      render :hello_you
+    end
   end
 end.serve!
 ```
 
+In this case, any request to `/hello/bob` will render the `hello` template with
+the `name` variable set to `"bob"`, while any request to `/hello/you` will
+simply just render the `hello_you` template. The opposite order will not work,
+so the ordering is quite important.
+
 ## Inspiration
 I've been looking in my directions for inspiration. I probably owe some credit
 to [Camping](http://camping.io), [Cuba](http://cuba.is),

data/lib/dolphy/core.rb

@@ -30,9 +30,7 @@ module Dolphy
     end
 
     def render(template_name, locals = {})
-      Dolphy::TemplateEngine.new(settings[:template_engine],
-                                 settings[:view_path]).
-        render(template_name, locals)
+      template_engine.render(template_name, locals)
     end
 
     def redirect_to(path, status = 302)
@@ -54,7 +52,7 @@ module Dolphy
 
       router.find_route_for(request).each do |matcher, block|
         if match = router.find_match_data_for(request, with: matcher)
-          response.body << block.call(*match.captures)
+          response.body = [block.call(*match.captures)]
         end
       end
 
@@ -65,6 +63,13 @@ module Dolphy
 
     private
 
+    def template_engine
+      @template_engine ||= Dolphy::TemplateEngine.new(
+        settings[:template_engine],
+        settings[:view_path]
+      )
+    end
+
     attr_accessor :response, :router, :request
   end
 end

data/lib/dolphy/version.rb

@@ -1,3 +1,3 @@
 module Dolphy
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/dolphy_spec.rb

@@ -19,6 +19,12 @@ describe Dolphy do
       expect(page).to have_content "hello world!"
     end
 
+    it "returns the content of the last defined route" do
+      visit '/hello/login'
+      expect(page).to have_content "this is a login"
+      expect(page).to_not have_content "hello login"
+    end
+
     it "returns a page using the input from the matcher" do
       visit '/hello/davis'
       expect(page).to have_content "hello davis"

data/spec/spec_helper.rb

@@ -32,6 +32,10 @@ app = Dolphy.app do
     get '/hello/:name' do |name|
       "hello #{name}"
     end
+
+    get '/hello/login' do
+      get "this is a login"
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dolphy
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mathias Jean Johansen