homework_report 0.0.1 → 0.0.2

data/README.md

@@ -11,6 +11,8 @@ Install it yourself as:
 
     $ gem install homework_report
 
+Note that extra libraries are required if you want to use Haml, Slim, or Markdown instead of ERB
+
 ### You are a developer
 
 Add this line to your application's Gemfile:
@@ -38,7 +40,66 @@ It generates HTML text to the standard output or file
 
     $ homework_report [options] FILE
 
-You can type --help in options to see the available options
+You can execute `$ homework_report --help` to see the available options
+
+### Simple Example
+
+homework.slim
+
+    - @topic = "Uncharted"
+    - @name = "Nathan Drake"
+    doctype html
+    html
+      head
+        title= @topic
+      body
+        p
+          | Name: #{@name}
+
+Execute the command to generate HTML
+
+    $ homework_report -o homework.html homework.slim
+
+### More Complex Example
+
+homework.slim
+
+    - @course = "Digital Image Synthesis"
+    - @topic = "Assignment #1 - Height Field"
+    - @name = "David Lin"
+    - @submission_date = Date.today
+    = render 'template.slim'
+
+template.slim
+
+    doctype html
+    html
+      head
+        title #{@course} - #{@topic}
+      body
+        div
+          h1= @topic
+          h3 Name: #{@name}
+          h3 Submission Date: #{@submission_date}
+        div
+          = render "description.md"
+        div
+          = render "final_images.slim"
+
+description.md
+
+    ## Description of implementation approach and comments
+    blahblahblah
+
+final_images.slim
+
+    h2 Final Images Rendered with my implementation of Heightfield2
+    p
+      img src="http://www.csie.ntu.edu.tw/~cyy/courses/rendering/12fall/assignments/proj1/smooth.jpg"
+
+Finally, execute the command to generate homework.html
+
+    $ homework_report -o homework.html homework.slim
 
 ### Lib
 

data/lib/homework_report.rb

@@ -9,26 +9,28 @@ require "tilt"
 require "erb"
 begin
   require "slim"
-rescue
+rescue LoadError => e
+  warn "Warning: Slim is not enabled"
 end
 begin
   require "haml"
-rescue
+rescue LoadError => e
+  warn "Warning: Haml is not enabled"
 end
 begin
   require "redcarpet"
-rescue
+rescue LoadError => e
   begin
     require "maruku"
-  rescue
+  rescue LoadError => e
     begin
       require "kramdown"
-    rescue
+    rescue LoadError => e
+      warn "Warning: Markdown is not enabled"
     end
   end
 end
 
-
 #
 require "homework_report/version"
 
@@ -37,6 +39,6 @@ module HomeworkReport
   
   autoload :CommandLineTool
   autoload :Scope
-  
+  autoload :Renderer
 end
 

data/lib/homework_report/command_line_tool.rb

@@ -34,6 +34,7 @@ module HomeworkReport
         end
       }.call options.delete(:output) do |output|
         output << scope.render(template_filepath)
+        output << "\n"
       end
     end
     

data/lib/homework_report/renderer.rb

@@ -0,0 +1,74 @@
+module HomeworkReport
+  class Renderer
+    
+    # Attributes
+    attr_accessor :scope
+    
+    # Constructor
+    def initialize(scope)
+      self.scope = scope
+    end
+    
+    # Render the template
+    #
+    # Usage #1: s.render FILE [OPTIONS] { BLOCK }
+    #
+    def render(*args, &block)
+      args = args.flatten
+      options = args.extract_options!
+      path = args.first
+      
+      inside_template(path) {|template|
+        # clone scope object to prevent from overriding instance variables
+        template.render(self.scope.clone, options, &block)
+      }
+    end
+    
+    private
+    
+    # Load template object according to the file path
+    def load_template(path)
+      path = if in_template?
+        File.expand_path path, File.dirname(template_stack.last.file)
+      else
+        File.expand_path path # in current working directory
+      end
+      
+      unless File.file? path
+        raise ArgumentError, "#{path} is expected to be a existing file"
+      end
+      
+      Tilt[path].new(path)
+    end
+    
+    # Inside the template
+    def inside_template(template, &block)
+      # load template object if 
+      template = case template
+      when String then load_template(template)
+      when Tilt::Template then template
+      else raise RuntimeError
+      end
+      
+      # push the template to the stack as the current template
+      template_stack.push template
+      # do something with the template
+      result = block.call(template)
+      # remove the template from the stack
+      template_stack.pop
+      # return the result and prevent from HTML escaping
+      return result.html_safe
+    end
+    
+    # Stack of Tilt templates
+    def template_stack
+      @template_stack ||= []
+    end
+    
+    # Check if the scope is in a template file
+    def in_template?
+      not template_stack.empty?
+    end
+    
+  end
+end

data/lib/homework_report/scope.rb

@@ -1,5 +1,3 @@
-require "ostruct"
-
 module HomeworkReport
   class Scope
     
@@ -8,44 +6,11 @@ module HomeworkReport
       self.instance_eval &block if block
     end
     
-    # Render the template
-    #
-    # Usage #1: s.render FILE [OPTIONS] { BLOCK }
-    #
-    def render(*args, &block)
-      args = args.flatten
-      options = args.extract_options!
-      path = args.first
-      
-      # resolve template path
-      path = if in_template?
-        File.expand_path path, File.dirname(template_stack.last.file)
-      else
-        File.expand_path path # in current working directory
-      end
-      
-      unless File.file? path
-        raise ArgumentError, "#{path} is expected to be a existing file"
-      end
-      
-      template = Tilt[path].new(path)
-      template_stack.push template
-      result = template.render(self, options, &block)
-      template_stack.pop
-      return result.html_safe # prevent from HTML escaping
-    end
-    
-    private
+    # Render the template (Renderer#render)
+    delegate :render, to: :renderer
     
-    # Stack of Tilt templates
-    def template_stack
-      @template_stack ||= []
-    end
-    
-    # Check if the scope is in a template file
-    def in_template?
-      not template_stack.empty?
-    end
+    # Renderer Object
+    def renderer; (@renderer ||= Renderer.new(self)); end
     
   end
 end

data/lib/homework_report/version.rb

@@ -1,3 +1,3 @@
 module HomeworkReport
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: homework_report
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -157,6 +157,7 @@ files:
 - homework_report.gemspec
 - lib/homework_report.rb
 - lib/homework_report/command_line_tool.rb
+- lib/homework_report/renderer.rb
 - lib/homework_report/scope.rb
 - lib/homework_report/version.rb
 - spec/scope_spec.rb