RubyGems - ruhl - Versions diffs - 0.6.0 → 0.7.0 - Mend

ruhl 0.6.0 → 0.7.0

Files changed (7) hide show

data/README CHANGED

@@ -1,27 +1,109 @@
-Ruhl (Ruby Hypertext Language)
+RuHL (Ruby Hypertext Language)
-This project is here to flesh out an idea.  What I want is to have developers
-work with HTML and with the simple addition of a 'data-ruhl' attribute, convert it
-to a dynamic page.
-At no time in the dev process would the view be unviewable in a browser.
-The view could actually retain the original template data the designer used
-because this replaces the content.  I think this is a nice plus.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: What? ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+RuHL parses HTML (using Nokogiri) and by using a data-ruhl attribute, makes
+the contents dynamic!
+Let's say you have the following HTML in a file called ('hello_world.ruhl')
+<html>
+  <body>
+    <p data-ruhl="say_hello"/>
+  </body>
+</html>
+And you have the following method available to self:
+def say_hello
+  "Hello World"
+end
+If you call
+RuHL::Engine.new(File.read('hello_world.ruhl')).render(self)
+It will return:
+<html>
+  <body>
+    <p>Hello World</p>
+  </body>
+</html>
+Notice that it removes the data-ruhl attribute.
-Notes (use cases) for me to remember:
+You can pass an options hash to RuHL:
+  RuHL::Engine.new(File.read('hello_world.ruhl'), options).render(self)
+Right now, RuHL knows the following options:
+  :layout         =>  This is the file name of the layout
+  :layout_source  =>  If the framework (like Rails) has already read the file,
+                      pass the contents through so RuHL doesn't have to reread
+                      the file.
+                      If you don't pass :layout_source, RuHL must be able to
+                      find/read :layout
+  :local_object   =>  If you are rendering a show page for @person, pass the
+                      @person object into RuHL.  RuHL will first try to call
+                      the methods against the local_object then try the scope.
+                      For example:
+                        <li data-ruhl="first_name">
+                      RuHL will first try @person.first_name.
+There are some special methods defined by RuHL (examples follow):
+_render_    - This is used in your layout and lets rule know where to inject
+              the rendered sub content.
+_partial    - Path to a partial file.  RuHL must be able to find/read this file.
+_if         - If the method returns nil, the tag will not be included on output.
+_render_if  - If the method returns false, the tag will not be included on output.
+_collection - RuHL expects the method reference to return an array of objects.
+              RuHL will iteratate over the collection and render the contents
+              of the tag agains the collection item. (example below)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:: Rails ::
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In your config/environment.rb :
+  config.gem 'ruhl', :lib => 'ruhl/rails'
+Your filenames should end in .ruhl ('show.html.ruhl')
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-:: Basic Use ::
+:: Sinatra ::
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<h1 data-ruhl="page_header">
+require 'ruhl/sinatra'
+You can then do:
-Method :page_header would know how to represent itself in the context of
-the h1 element.
+get '/' do
+  ruhl(:index, :layout => path_to_layout)
+end
-The Ruby executed would replace the content of the element it was being
-called on.
+*******************************************************************************
+*
+* EXAMPLES
+*
+*******************************************************************************
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 :: Replacing attribute values ::
@@ -96,12 +178,12 @@ Fragment:
 To use:
-Ruhl::Engine.new(File.read(fragment), :layout => path_to_layout).render(self)
+RuHL::Engine.new(File.read(fragment), :layout => path_to_layout).render(self)
 Returns the expected result of parsed Layout w/ parsed Fragment.
 Note the use of the _render_ method.  This is a 'special' method that
-Ruhl uses to inject the results of the parsed fragment into the layout.
+RuHL uses to inject the results of the parsed fragment into the layout.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -143,12 +225,12 @@ Sidebar:
 To use:
-Ruhl::Engine.new(File.read(path_to_main)).render(self)
+RuHL::Engine.new(File.read(path_to_main)).render(self)
 Returns the expected result of parsed Main with sidebar div contents
 replaced with parsed sidebar partial contents.
-Note the use of the _partial key.  This is a 'special' key that Ruhl
+Note the use of the _partial key.  This is a 'special' key that RuHL
 uses to inject the results of the parsed partial into the contents
 of the calling node.

data/Rakefile CHANGED

@@ -19,7 +19,7 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "ruhl"
     gemspec.summary = "Ruby Hypertext Language"
-    gemspec.description = "Make your HTML dynamic with the addition of a ruby attribute."
+    gemspec.description = "Make your HTML dynamic with the addition of a data-ruhl attribute."
     gemspec.email = "andy@stonean.com"
     gemspec.homepage = "http://github.com/stonean/ruhl"
     gemspec.authors = ["Andrew Stone"]

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.6.0
1	+ 0.7.0

data/lib/ruhl.rb CHANGED

@@ -5,10 +5,11 @@ require 'ruhl/errors'
 module Ruhl
   class Engine
-    attr_reader :document, :scope, :layout, :local_object
+    attr_reader :document, :scope, :layout, :layout_source, :local_object
     def initialize(html, options = {})
-      @local_object = options[:local_object]
+      @local_object   = options[:local_object]
+      @layout_source  = options[:layout_source]
       if @layout = options[:layout]
         raise LayoutNotFoundError.new(@layout) unless File.exists?(@layout)
@@ -44,7 +45,7 @@ module Ruhl
     private
     def render_with_layout
-      render_file( File.read(@layout) )
+      render_file( @layout_source || File.read(@layout) )
     end
     def render_partial(tag, code)

data/lib/ruhl/rails.rb CHANGED

@@ -1,3 +1,5 @@
+require 'ruhl'
 module Ruhl
   class Plugin < ActionView::TemplateHandler
@@ -5,12 +7,13 @@ module Ruhl
       @action_view = action_view
     end
-    def render(template, options)
+    def render(template, options = {})
       layout = @action_view.controller.send(:active_layout)
-      puts "==========> @action_view: #{@action_view.controller.response.inspect}"
-      puts "==========> template: #{template.inspect}"
-      puts "==========> options: #{options.inspect}"
+      options[:layout]        = layout.filename
+      options[:layout_source] = layout.source
+      Ruhl::Engine.new(template.source, options).render(@action_view)
     end
   end
 end

data/ruhl.gemspec CHANGED

@@ -5,12 +5,12 @@
 Gem::Specification.new do |s|
   s.name = %q{ruhl}
-  s.version = "0.6.0"
+  s.version = "0.7.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Stone"]
   s.date = %q{2009-10-07}
-  s.description = %q{Make your HTML dynamic with the addition of a ruby attribute.}
+  s.description = %q{Make your HTML dynamic with the addition of a data-ruhl attribute.}
   s.email = %q{andy@stonean.com}
   s.extra_rdoc_files = [
     "README"

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruhl
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrew Stone
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: "0"
     version:
-description: Make your HTML dynamic with the addition of a ruby attribute.
+description: Make your HTML dynamic with the addition of a data-ruhl attribute.
 email: andy@stonean.com
 executables: []