homework_report 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*~
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in homework_report.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Lin
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,53 @@
+# HomeworkReport
+
+HomeworkReport is an utility program, 
+which generates HTML files with given template files.
+
+## Installation
+
+### You are a user
+
+Install it yourself as:
+
+    $ gem install homework_report
+
+### You are a developer
+
+Add this line to your application's Gemfile:
+
+    gem 'homework_report'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Supported Template Formats
+
+    FORMAT       FILE EXTENSIONS             REQUIRED LIBRARIES
+    ------------ --------------------------- ------------------------
+    ERB          .erb, .rhtml                none
+    Haml         .haml                       haml
+    Slim         .slim                       slim
+    Markdown     .markdown, .mkd, .md        redcarpet, maruku, or kramdown
+
+### Tool
+
+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
+
+### Lib
+
+TODO: I'm working on it
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new :spec do |t|
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r homework_report"
+end

data/bin/homework_report

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'homework_report'
+
+tool = HomeworkReport::CommandLineTool.new ARGV
+tool.run
+

data/homework_report.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'homework_report/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "homework_report"
+  gem.version       = HomeworkReport::VERSION
+  gem.authors       = ["David Lin"]
+  gem.email         = ["davll.xc@gmail.com"]
+  gem.description   = %q{The utility program can help create reports in HTML format. It supports ERB, Haml, Slim, and Markdown template engines}
+  gem.summary       = %q{The ruby gem that generates HTML with template engines}
+  gem.homepage      = "https://github.com/davll/homework_report"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.required_ruby_version = ">= 1.9"
+  
+  gem.add_dependency "activesupport", "~> 3.2.8"
+  gem.add_dependency "backports", "~> 2.6.4"
+  gem.add_dependency "tilt", "~> 1.3.3"
+  
+  gem.add_development_dependency "rake", "~> 0.9.2.2"
+  gem.add_development_dependency "minitest", "~> 4.1.0"
+  gem.add_development_dependency "haml", "~> 3.1.7"
+  gem.add_development_dependency "slim", "~> 1.3.3"
+  gem.add_development_dependency "redcarpet", "~> 2.2.1"
+  
+end

data/lib/homework_report/command_line_tool.rb

@@ -0,0 +1,47 @@
+require 'optparse'
+
+module HomeworkReport
+  class CommandLineTool
+    
+    attr_accessor :options, :template_filepath, :scope
+    
+    def initialize(*args)
+      args = args.flatten
+      
+      self.options = { output: :stdout }
+      
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{opts.program_name} [options] TEMPLATE_FILE"
+        opts.separator "Outcome: a HTML file/text is generated"
+        opts.separator "Options:"
+        
+        command_options opts
+      end.parse! args
+      
+      unless self.template_filepath = args.shift
+        raise RuntimeError, "TEMPLATE_FILE is required"
+      end
+      
+      self.scope = Scope.new
+    end
+    
+    def run
+      lambda {|path, &y|
+        case path
+        when :stdout then y.call $stdout
+        when String then File.open path, "w", &y
+        else raise RuntimeError
+        end
+      }.call options.delete(:output) do |output|
+        output << scope.render(template_filepath)
+      end
+    end
+    
+    private
+    
+    def command_options(opts)
+      opts.on("-o", "--output FILE"){|p| options[:output] = p }
+    end
+    
+  end
+end

data/lib/homework_report/scope.rb

@@ -0,0 +1,51 @@
+require "ostruct"
+
+module HomeworkReport
+  class Scope
+    
+    # Constructor
+    def initialize(&block)
+      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
+    
+    # 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/version.rb

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

data/lib/homework_report.rb

@@ -0,0 +1,42 @@
+# require: core extensions
+require "active_support/core_ext"
+require "active_support/concern"
+require "active_support/dependencies"
+require "backports"
+
+# require: template engines
+require "tilt"
+require "erb"
+begin
+  require "slim"
+rescue
+end
+begin
+  require "haml"
+rescue
+end
+begin
+  require "redcarpet"
+rescue
+  begin
+    require "maruku"
+  rescue
+    begin
+      require "kramdown"
+    rescue
+    end
+  end
+end
+
+
+#
+require "homework_report/version"
+
+module HomeworkReport
+  extend ActiveSupport::Autoload
+  
+  autoload :CommandLineTool
+  autoload :Scope
+  
+end
+

data/spec/scope_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module HomeworkReport
+  describe Scope do
+    include Spec::Helpers
+    
+    before do
+      @scope = Scope.new do
+        @title = "HomeworkReport"
+        @article = "Hello World"
+      end
+    end
+    
+    %w(
+      sample1.erb sample1.haml sample1.slim
+      sample2.erb
+    ).each do |sample|
+      it "should work with the file #{sample}" do
+        output = @scope.render(template_path sample)
+        output.must_be_kind_of String
+        output.wont_be_empty
+        output.must_match /\A\s*<html>(\s|.)*<\/html>\s*\z/
+        output.must_match /.*<title>\s*HomeworkReport\s*<\/title>.*/
+        output.must_match /.*<p>\s*Hello World\s*<\/p>.*/
+      end
+    end
+    
+    %w(sample1.markdown).each do |sample|
+      it "should work with the file #{sample}" do
+        output = @scope.render(template_path sample)
+        output.must_be_kind_of String
+        output.wont_be_empty
+      end
+      it 'the markdown engine does not support ruby scripting'
+    end
+    
+    %w(sample3.erb).each do |sample|
+      it "should be able to pass local variables with #{sample}" do
+        options = { title: "Uncharted", article: "Nathan Drake" }
+        output = @scope.render (template_path sample), options
+        output.must_be_kind_of String
+        output.wont_be_empty
+        output.must_match /\A\s*<html>(\s|.)*<\/html>\s*\z/
+        output.must_match /.*<title>\s*Uncharted\s*<\/title>.*/
+        output.must_match /.*<p>\s*Nathan Drake\s*<\/p>.*/
+      end
+    end
+    
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# Bundler
+require "rubygems"
+require "bundler/setup"
+
+# Test Framework
+require "minitest/autorun"
+
+#
+require 'homework_report'
+
+#
+SPEC_ROOT = File.expand_path("..", __FILE__)
+
+# load factories
+Dir[File.join(SPEC_ROOT, "factories/**/*.rb")].each {|f| require f }
+
+# helpers
+module HomeworkReport::Spec
+  module Helpers
+    
+    def template_path(name)
+      File.join SPEC_ROOT, "templates", name
+    end
+    
+  end
+end
+

data/spec/templates/sample1.erb

@@ -0,0 +1,12 @@
+<html>
+  <head>
+    <title>
+      <%= @title %>
+    </title>
+  </head>
+  <body>
+    <p>
+      <%= @article %>
+    </p>
+  </body>
+</html>

data/spec/templates/sample1.haml

@@ -0,0 +1,5 @@
+%html
+  %head
+    %title= @title
+  %body
+    %p= @article

data/spec/templates/sample1.markdown

@@ -0,0 +1,4 @@
+#  {{ @title }}
+
+{{ @article }}
+

data/spec/templates/sample1.slim

@@ -0,0 +1,5 @@
+html
+  head
+    title= @title
+  body
+    p= @article

data/spec/templates/sample2-1.erb

@@ -0,0 +1,3 @@
+<title>
+  <%= @title %>
+</title>

data/spec/templates/sample2-2.erb

@@ -0,0 +1,3 @@
+<p>
+  <%= @article %>
+</p>

data/spec/templates/sample2.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <%= render 'sample2-1.erb' %>
+  </head>
+  <body>
+    <%= render 'sample2-2.erb' %>
+  </body>
+</html>

data/spec/templates/sample3.erb

@@ -0,0 +1,12 @@
+<html>
+  <head>
+    <title>
+      <%= title %>
+    </title>
+  </head>
+  <body>
+    <p>
+      <%= article %>
+    </p>
+  </body>
+</html>

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: homework_report
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Lin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.4
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+description: The utility program can help create reports in HTML format. It supports
+  ERB, Haml, Slim, and Markdown template engines
+email:
+- davll.xc@gmail.com
+executables:
+- homework_report
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/homework_report
+- homework_report.gemspec
+- lib/homework_report.rb
+- lib/homework_report/command_line_tool.rb
+- lib/homework_report/scope.rb
+- lib/homework_report/version.rb
+- spec/scope_spec.rb
+- spec/spec_helper.rb
+- spec/templates/sample1.erb
+- spec/templates/sample1.haml
+- spec/templates/sample1.markdown
+- spec/templates/sample1.slim
+- spec/templates/sample2-1.erb
+- spec/templates/sample2-2.erb
+- spec/templates/sample2.erb
+- spec/templates/sample3.erb
+homepage: https://github.com/davll/homework_report
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: The ruby gem that generates HTML with template engines
+test_files:
+- spec/scope_spec.rb
+- spec/spec_helper.rb
+- spec/templates/sample1.erb
+- spec/templates/sample1.haml
+- spec/templates/sample1.markdown
+- spec/templates/sample1.slim
+- spec/templates/sample2-1.erb
+- spec/templates/sample2-2.erb
+- spec/templates/sample2.erb
+- spec/templates/sample3.erb