deklarativna 0.0.1 → 0.0.2

data/README.md

@@ -8,7 +8,7 @@ to write *human readable code* with not much effort.
 
 ##Conception
 This work has been started as a tool for teaching *declarative programming*
-and *DSL creation* to univeritary students.
+and *DSL creation* to universitary students.
 This is a work in progress and *I hope* someday will have integration
 with the most popular web frameworks
 
@@ -19,6 +19,13 @@ Support for *XML* tags with *xml_single_tag* and *xml_double_tag*
 is added. 
 Core module classes and helpers have *full support* for attributes.
 
+##Installation
+You can download this gem from RubyGems.org by running
+
+```bash
+$ gem install deklarativna
+```
+
 ##Usage
 ###Function Based Approach
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/deklarativna.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "deklarativna"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Litvak"]
-  s.date = "2012-01-03"
+  s.date = "2012-01-04"
   s.description = "A Declarative HTML embedded DSL for HTML/XML Templating in Ruby,\n  This gem was intended to be use as teaching material for universitary students."
   s.email = "david.litvakb@gmail.com"
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "deklarativna.gemspec",
     "examples/class_based_example.rb",
     "examples/dinamic_sinatra_example.rb",
+    "examples/more_interesting_sinatra_example/example.rb",
     "examples/simple_example.rb",
     "examples/static_sinatra_example.rb",
     "lib/deklarativna.rb",

data/examples/more_interesting_sinatra_example/example.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'sinatra/base'
+require 'deklarativna'
+
+class DynamicTemplate < BaseTemplate
+  attr_accessor :content
+
+  def initialize
+    @content = {}
+    yield self if block_given?
+  end
+
+
+  def _head
+    [
+      title { @content["title"] }
+    ]
+  end
+
+  def _body
+    begin
+      #Just for showing how would a simple 404 would work
+      raise "404" if @content.count < 1
+      body_content = [
+        h1 { @content["title"] },
+        p { @content["first_line"] }
+      ]
+      if @content["a_list"].respond_to? :each
+        @content["a_list"].each { |elem|
+          body_content.push( p { elem })
+        }
+      end
+      body_content
+    rescue
+      [
+        h1 { "#{$!} - Object not found" },
+        p { puts @content }
+      ]
+    end
+  end
+end
+
+class DeklarativnaSinatraRemixed < Sinatra::Base
+  get '/' do
+    template = DynamicTemplate.new { |instance|
+                 instance.content["title"] = "Deklarativna"
+                 instance.content["first_line"] = "Hey how cool is this?"
+                 instance.content["a_list"] = [
+                   "really cool",
+                   "cool cool",
+                   "more than cool"
+                 ]
+               }
+    template.render
+  end
+
+  get '/404' do
+    DynamicTemplate.new.render
+  end
+end
+
+DeklarativnaSinatraRemixed.run!

data/lib/deklarativna.rb

@@ -1,7 +1,15 @@
 require 'deklarativna_core'
 
+## Module
+# Deklarativna is a module thought for creating embedded HTML/XML
+# templates fully written in ruby
+#
+# It can provide its functionallity to any of your ruby existing code
+# just by adding  `include Deklarativna` inside your classes or modules
 module Deklarativna
 
+  ## Private Method
+  # It metaprograms most of the module's methods
   def self.included(base)
     nesting_renderables = ["html", "head", "body", "p", "div", "span",
                            "table", "tr", "td", "ul", "ol", "li",
@@ -43,32 +51,48 @@ module Deklarativna
     end
   end
 
+  ## Public Method
+  # Helper for adding your javascript to the template
   def javascript attributes={}, &script_text_block
     attributes["type"] = "text/javascript"
     script attributes, &script_text_block
   end
 
+  ## Public Method
+  # Helper for adding your css to the template
   def css attributes={}, &style_text_block
     attributes["type"] = "text/css"
     style attributes, &style_text_block
   end
 
+  ## Public Method
+  # Helper for adding your comments to the template
   def comment &comment_block
     comment_renderable_string comment_block
   end
 
+  ## Public Method
+  # Helper for adding XML tags with the format '<tagname />'
   def xml_single_tag tag_name, attributes={}
     single_tag_renderable_string tag_name.downcase, attributes
   end
 
+  ## Public Method
+  # Helper for adding XML tags with the format '<tagname></tagname>'
   def xml_double_tag tag_name, attributes={}, &html_block
     nesting_renderable_string tag_name.downcase, html_block, attributes
   end
 end
 
+## Public Class
+# Base Class for Template Creation using Deklarativna Class Based Model
+# If you need any special implementation, you can create your own using
+# this one as example, or just extend this one
 class BaseTemplate
   include Deklarativna
 
+  ## Public Method
+  # Creates the rendered html
   def render
     html {[
       head {
@@ -80,9 +104,13 @@ class BaseTemplate
     ]}
   end
 
+  ## Template Method
+  # Should be redefined in your own classes
   def _head
   end
 
+  ## Template Method
+  # Should be redefined in your own classes
   def _body
   end
 end

data/lib/deklarativna_core.rb

@@ -1,5 +1,7 @@
 module Deklarativna
 
+  ## Abstract Class
+  # Base Class for all renderables
   class Renderable
     attr_accessor :tag_name,:attributes
 
@@ -7,6 +9,8 @@ module Deklarativna
       initialization_block.call self
     end
 
+    ## Private Method
+    # This method renders the attributes for any Renderable class
     def render_attributes
       rendering_tags = []
       attribute_list = @attributes.sort if @attributes.respond_to? :sort
@@ -19,6 +23,9 @@ module Deklarativna
     end
   end
 
+  ## Public Class
+  # This class is intended to render tags
+  # following the '<tagname></tagname>' pattern
   class NestingRenderable < Renderable
     attr_accessor :content
 
@@ -41,18 +48,25 @@ module Deklarativna
     end
   end
 
+  ## Public Class
+  # This class is intended to render comments
   class CommentRenderable < NestingRenderable
     def to_s
       "<!--#{proc_call}-->"
     end
   end
 
+  ## Public Class
+  # This class is intended to render tags
+  # following the '<tagname />' pattern
   class SingleTagRenderable < Renderable
     def to_s
       "<#{@tag_name}#{render_attributes} />"
     end
   end
 
+  ## Private Method
+  # This is a helper for factory methods
   def renderable_string renderable_class, block, attributes={}, tag_name=""
     (renderable_class.new { |instance|
       instance.tag_name = tag_name
@@ -63,14 +77,20 @@ module Deklarativna
     }).to_s
   end
 
+  ## Private Method
+  # Factory Method for creating single tag renderables
   def single_tag_renderable_string tag_name, attributes={}
     renderable_string SingleTagRenderable, nil, attributes, tag_name
   end
 
+  ## Private Method
+  # Factory Method for creating nesting renderables
   def nesting_renderable_string tag_name, block, attributes={}
     renderable_string NestingRenderable, block, attributes, tag_name
   end
 
+  ## Private Method
+  # Factory Method for creating comment renderables
   def comment_renderable_string comment_block
     renderable_string CommentRenderable, comment_block
   end

data/run_test.sh

@@ -1,7 +1 @@
-#rvm use ruby-1.9.2
-#rvm -S _deklarativna_test.rb
-#rvm -S _deklarativna_core_test.rb
-
-#back to default ruby until i get to move to ruby-1.9.2 as my default ruby
-ruby _deklarativna_test.rb
-ruby _deklarativna_core_test.rb
+rake test

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deklarativna
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Litvak
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-03 00:00:00 Z
+date: 2012-01-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -115,6 +115,7 @@ files:
 - deklarativna.gemspec
 - examples/class_based_example.rb
 - examples/dinamic_sinatra_example.rb
+- examples/more_interesting_sinatra_example/example.rb
 - examples/simple_example.rb
 - examples/static_sinatra_example.rb
 - lib/deklarativna.rb