lipa-web 0.1.1 → 0.2.0

data/NEWS.md

@@ -1,3 +1,27 @@
+2011-11-10 Release 0.2.0
+---------------------------
+- Added serve static files
+    
+  ```Ruby
+    root :srv do
+      static_folder File.dirname(__FILE__) + "/public"
+    end
+  ```
+
+- Added support XML format
+- Added custom html response  
+  
+  ```Ruby
+    node :page_1 do
+      say "Hello"
+      html { <h1>#{say}</h1> }
+    end
+  ```
+
+2011-11-05 Release 0.1.1
+---------------------------
+Resolved problem with dependency json and ruby version (support only >=1.9.2)
+
 2011-11-05 Release 0.1.0
 ----------------------------
 Initial release

data/README.md

@@ -1,65 +1,129 @@
 LipaWeb  [![Build Status](https://secure.travis-ci.org/flipback/lipa-web.png)](http://travis-ci.org/flipback/lipa-web)
 =======================================================
-LipaWeb - micro webframework based on [Lipa](http://lipa.flipbacl.new) for web access to treelike structures
+LipaWeb - micro webframework based on [Lipa](http://lipa.flipback.net) for web access to treelike structures
 
-Features
+Installation
 ----------------------------------------------------
-- Based on Rack and Lipa
-- Support HTML,JSON and text format response
-- Support ERB templates with layouts
+`gem install lipa-web`
 
-Example
+Get started
 ----------------------------------------------------
 
     require 'lipa-web'
-    srv = root :universe do 
-      kind :planet_system do
-        num_planet run{
-          count = 0
-          children.values.each do |planet|
-            count += 1 if planet.kind == :planet
-          end
-          count
-        }
+    app = root :app do 
+      node :group do
+        node :node_1 do
+          msg "Hello World!"
+        end
       end
+    end
 
-      kind :planet do 
-        has_live false
-        has_water false
-        number 0
-      end
+    app.run! #Run server
+    # GET http://127.0.0.1:9292/group/node
 
-      planet_system :sun_system do 
-        planet :mercury do 
-          number 1
-          radius 46_001_210 
-        end
+###Server options
 
-        planet :venus do 
-          number 2
-          radius 107_476_259
-        end
+Server has default options:
 
-        planet :earth do 
-          number 3
-          radius 147_098_074
-          has_live true
-          has_water true
+  1. host '127.0.0.1'
+  2. port 9292
+  3. server :webrik - name of server(see servers  of Rack)
+  4. debug false
+  5. views "./views" - dir for templates
+  6. static_folder "./public" - dir for static files
 
-          node :moon, :radius => 363_104
-        end
-      end
+You can set your options in root of description
+
+    root :app do
+      static_folder "path/to/dir/with/static/files"
+      port 80
+      server :thin
     end
 
-    srv.run! #Run server
-    # GET http://127.0.0.1:9292
+###Formats
 
-Installation
------------------------------------------------------
-`gem install lipa-web`
+You can get representation of data in HTML, JSON or XML formats:
+
+    GET http://127.0.0.1:9292/group/node #=> render default HTML template for node
+    GET http://127.0.0.1:9292/group/node.json 
+    #=> 
+    { 
+      "name":"node", 
+      "full_name":"/group/node",
+      "parent": {
+        "name":"group",
+        "full_name":"/group",
+      }
+      "msg":"Hello World!"
+    }
+
+    GET http://127.0.0.1:9292/group/node.xml
+    #=> 
+    <node>
+      <name>node</node>
+      <full_name>/group/node</full_name>
+      <parent>
+        <name>group</node>
+        <full_name>/group</full_name>
+      </parent>
+      <msg>Hello World!</msg>
+    </node>
+
+### Templates 
+
+Now LipaWeb is supporting only ERB templates for rendering in HTML format and Builder for XML. Use this syntax for linking templates with node:
+
+    node :node_1 do
+      html erb("path/to/file/in/views/dir")     #HTML format
+      xml builder("path/to/file/in/views/dir")  #XML format
+    end
+
+Also you can use layout. For it:
+
+    root :app do
+      layout  "path/to/file/views/dir"
+    end
+
+### Custom responses
+
+LipaWeb provide custom responses in block:
+
+    node :node_1 do
+      msg "Hello"
+
+      html { "<h1>#{msg}</h1" }
+      json { |json| json[:msg] = msg }
+      xml  { |xml| xml.msg msg }
+    end
+
+All template binding with node. For example:
+
+    #*.html.erb:
+    <h1><%= name %></h1>
+    <p><%= parent.name %></h1>
+
+    #*builder
+    xml.node do
+      xml.name name
+      xml.parent parent.name
+    end
+
+### Lipa
+
+LipaWeb is extension of Lipa and inherit its features:
+
+    root :app do
+      kind :greater do
+        html { <h1>Hello, #{name.to_s.capitalize}!</h1> }
+      end
+
+      greater :ann
+      greater :aleksey
+      #....
+    end
 
 Reference
 ----------------------------------
 Home page: https://github.com/flipback/lipa-web
 
-Lipa home page: http://lipa.flipback.net
+Lipa home page: http://lipa.flipback.net 

data/examples/many_objects.rb

@@ -0,0 +1,33 @@
+$:.unshift File.join(File.dirname(__FILE__),'../lib')
+require "lipa/web"
+
+srv = root :srv do 
+  kind :group do
+    count run{
+      c = 0
+      children.values.each do |ch|
+        c += if ch.kind == :group
+               ch.count
+             else
+               1
+             end
+      end
+      c
+    }
+  end
+
+  kind :object do
+    size 0
+    location "somethere"
+    any_attrs "..."
+  end
+
+  group :group_1 do 
+    #make ten object
+    (1...10).each do |i|
+      object "object_#{i}"
+    end
+  end
+end
+
+srv.run!

data/lib/lipa/web.rb

@@ -25,11 +25,12 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require "lipa/web/version"
 require "lipa/web/helpers"
+require "lipa/web/response"
 require "lipa/web/application"
 require "lipa/web/server"
 
 class Lipa::Node
-  include Lipa::Web::NodeHelper
+  include Lipa::Web::Helpers::Node
 end
 
 def root(name, &block)
@@ -40,6 +41,7 @@ def root(name, &block)
     server :webrick
     debug false
     views File.join(File.absolute_path("."), "views")
+    static_folder File.join(File.absolute_path("."), "public")
   end
 
   root.instance_eval &block if block_given?

data/lib/lipa/web/application.rb

@@ -31,7 +31,7 @@ module Lipa
   module Web
     # Rack application
     class Application
-      include ResponseHelper
+      include Response
 
       # Init app
       #
@@ -46,13 +46,18 @@ module Lipa
         if node
           respond(node, format)
         else
-          [ 500,
-            
-            {"Content-Type" => "text/html"}, 
-            [
-              "Node is not existence"
+          static_path = File.join(@root.static_folder, env['PATH_INFO'])
+          if File.exist?(static_path)
+            [ 200, { "Content-Type" => "text/#{format}" }, [File.read(static_path)]]
+          else
+            [ 500,
+              
+              {"Content-Type" => "text/html"}, 
+              [
+                "Node is not existence"
+              ]
             ]
-          ]
+          end
         end
       end
 

data/lib/lipa/web/helpers.rb

@@ -1,3 +1,3 @@
-require "lipa/web/helpers/node_helper"
-require "lipa/web/helpers/html_helper"
-require "lipa/web/helpers/response_helper"
+require "lipa/web/helpers/node"
+require "lipa/web/helpers/html"
+require "lipa/web/helpers/response"

data/lib/lipa/web/helpers/html.rb

@@ -0,0 +1,40 @@
+=begin
+Web access to Lipa
+
+Copyright (c) 2011 Aleksey Timin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+=end
+
+module Lipa
+  module Web
+    module Helpers
+      module HTML
+        # Make link for node
+        #
+        # @param node [Lipa::Node] linking node
+        # @return [String] html <a href='path/to/node'>name_of_node</a>
+        def link_to(node)
+          %(<a href="#{node.full_name}">#{node.name}</a>)
+        end
+      end
+    end
+  end
+end

data/lib/lipa/web/helpers/node.rb

@@ -0,0 +1,120 @@
+=begin
+Web access to Lipa
+
+Copyright (c) 2011 Aleksey Timin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+=end
+
+module Lipa
+  module Web
+    module Helpers
+      module Node
+        
+        # Assignment erb template fot html response
+        # 
+        # @param path [String] path about views directory 
+        #
+        # @example
+        #   node :page_1 do
+        #     html erb("page.html.erb")
+        #   end
+        def erb(path)
+          { :render => :erb, :template => File.join(root.attrs[:views], path) }
+        end
+
+        # Assignment text for html response
+        # 
+        # @param msg [String] text message
+        #
+        # @example
+        #   node :page_1 do
+        #     html text("Hello World!")
+        #   end
+        def text(msg)
+          { :render => :text, :msg => msg }
+        end
+
+        # Definition html response 
+        #
+        # @see NodeHelpers#erb
+        # @see NodeHelpers#text
+        def html(opts=nil,&block)
+          if block_given?
+            @html = {:block => block}
+          else
+            if opts.nil?
+              @html
+            else
+              @html = opts
+            end
+          end
+        end
+
+        # Definition json response
+        #
+        # @example
+        #   node :josn_1 do
+        #     json { |j| j[:name] = name }
+        #   end
+        #   # => { "name":"json_1" }
+        def json(&block)
+          if block_given?
+            @json = {:block => block}
+          else
+            @json 
+          end
+        end
+
+        # Assignment  template fot xml response
+        # 
+        # @param path [String] path about views directory 
+        #
+        # @example
+        #   node :page_1 do
+        #     xml builder("page.builder")
+        #   end
+
+        def builder(path)
+          { :render => :builder, :template => File.join(root.attrs[:views], path) }
+        end
+
+        # Definition xml response
+        #
+        # @example
+        #   node :xml_1 do
+        #     xml { |xml| xml.msg "Hello" }
+        #   end
+        #   # => <msg>Hello</msg>
+        def xml(opts=nil, &block)
+          if block_given?
+            @xml = { :block => block }
+          else
+            if opts.nil?
+              @xml
+            else
+              @xml = opts
+            end
+          end
+        end
+      end
+    end
+  end
+end