rehab 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4338df2ba361c5df88f5b3ac91945490e0c53fb
+  data.tar.gz: 9d964f493fdf127786326b50a8bc1cb2c011e856
+SHA512:
+  metadata.gz: ef4e821a5cc2068ddbb75450e161b94021c4098d1a6c07000e614a3bd43bebed082de43d36945bbff4af3dec0a07a597df93f3cfd0b7d67b8a93ece57fe21294
+  data.tar.gz: 5de144c4bf03350e74949497ee15e468563e128108d06a8596e712fd1af90ae0d569f971a509049f8cde2691d3b08c0462f9a3a180afcc9cda0621c01f6443cd

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cli: "--color", all_on_start: true, bundler: false do
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^rehab/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{(.+)\.rb$})         { |m| "spec/integration_spec.rb" }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Shane Kuester
+
+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,83 @@
+Rehab
+=====
+
+Simple, Portable Template Language.
+
+
+Installation
+------------
+Add this line to your application's Gemfile:
+
+	gem 'rehab'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install rehab
+
+
+
+Usage
+-----
+You can use Rehab like any tilt-like template.
+
+	Rehab::Template.new(options) { "template_source" }.render(scope)
+
+See `spec/integration_spec.rb` and `sample.html` for more documentation.
+
+### Options
+
+```ruby
+# OPTIONAL
+options[:file_provider] =>
+	# an object with a .call method that returns file content from a path string
+	->(path){  File.read(path) }
+```
+
+
+Syntax Overview
+---------------
+The goal is to have very little syntax, other than plain ruby and a couple conveniences for templating.
+It may be harnessing the full power of ruby, but remember: just because you *can* doesn't mean you *should*.
+
+Interpolation:
+
+	<p>{{ greeting }} World!<p>
+
+Control Flow:
+
+	# if greeting.empty?
+		<p>I have nothing to say<p>
+	# end
+
+Block:
+
+	# 3.times.do |n|
+		<p>{{ n }}. Why didn't I use an ordered list?</p>
+	# end
+
+Optional "Short" Block (without the 'Do'):
+
+	# 3.times
+		<blink>Click Me!<blink>
+	# end
+
+Include partial:
+
+	# include my_partial.html
+
+Include partial for each item in a collection:
+
+	# include awesome-post.html for post in posts
+
+
+------
+
+
+Future Plans
+============
+* It would be awesome to have an implementation not tied to Ruby, but... Ruby is pretty.
+* Implement simple filter syntax, see todo.html

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rehab.rb

@@ -0,0 +1,13 @@
+require 'temple'
+require 'tilt'
+
+require 'rehab/file_provider'
+require 'rehab/filter'
+require 'rehab/interpolation'
+require 'rehab/control'
+require 'rehab/do_filter'
+require 'rehab/parser'
+require 'rehab/missing_partial_error'
+
+require 'rehab/engine'
+require 'rehab/template'

data/lib/rehab/control.rb

@@ -0,0 +1,7 @@
+module Rehab
+	class Control < Filter
+		def on_rehab_control(code)
+			[:code, code]
+		end
+	end
+end

data/lib/rehab/do_filter.rb

@@ -0,0 +1,10 @@
+module Rehab
+	class DoFilter < Filter
+		BLOCK_REGEX = /(\A(if|unless|else|elsif|when|begin|rescue|ensure|case|end)\b)|do\s*(\|[^\|]*\|\s*)?\Z/
+
+		def on_rehab_control(code)
+			code = code + ' do' unless code =~ BLOCK_REGEX
+			[:rehab, :control, code]
+		end
+	end
+end

data/lib/rehab/engine.rb

@@ -0,0 +1,16 @@
+module Rehab
+	class Engine < Temple::Engine
+
+		use Rehab::Parser, :file_provider
+
+		use Rehab::Interpolation
+		use Rehab::DoFilter
+		use Rehab::Control
+
+		filter :MultiFlattener
+		filter :StaticMerger
+		filter :DynamicInliner
+
+		generator :ArrayBuffer
+	end
+end

data/lib/rehab/file_provider.rb

@@ -0,0 +1,9 @@
+module Rehab
+	FileProvider = ->(path) {
+		begin
+			File.read(path) + "\n"
+		rescue Errno::ENOENT
+			raise MissingPartialError.new(path)
+		end
+	}
+end

data/lib/rehab/filter.rb

@@ -0,0 +1,4 @@
+module Rehab
+	class Filter < Temple::HTML::Filter
+	end
+end

data/lib/rehab/interpolation.rb

@@ -0,0 +1,29 @@
+module Rehab
+	# inline like: {{ foo }}
+	class Interpolation < Filter
+
+		def on_rehab_interpolate(string)
+			block = [:multi]
+			begin
+				case string
+				when /\{\{/m
+					block << [:static, $`]
+					exp, string = parse_expression $'
+					block << [:dynamic, exp]
+				else
+					block << [:static, string]
+					string = ""
+				end
+			end until string.empty?
+			block
+		end
+
+		private
+
+
+		def parse_expression(string)
+			/\}\}/m.match(string)
+			[$`, $']
+		end
+	end
+end

data/lib/rehab/missing_partial_error.rb

@@ -0,0 +1,17 @@
+module Rehab
+	class MissingPartialError < StandardError
+
+		attr_reader :path
+
+
+		def initialize(path)
+			@path = path
+		end
+
+
+		def message
+			"Could not find #{path}"
+		end
+
+	end
+end

data/lib/rehab/parser.rb

@@ -0,0 +1,66 @@
+class Rehab::Parser < Temple::Parser
+	attr_reader :source, :out, :line
+
+
+	define_options :file_provider
+
+
+	def call(source)
+		@lines = source.lines
+		@out = [:multi]
+		parse_line while next_line
+		out
+	end
+
+
+protected
+
+
+	def next_line
+		@line = @lines.shift
+	end
+
+
+	INCLUDE = /\A\s*#\s*(include)\s*(\S*)\s?(.*)?/
+	CONTROL = /\A\s*#\s*(.*)$/
+	EXPRESSION = /\{\{/m
+	def parse_line
+		case @line
+		when INCLUDE
+			out << parse_include($2, $3)
+		when CONTROL
+			out << [:rehab, :control, $1]
+		when EXPRESSION
+			out << [:rehab, :interpolate, @line]
+		else
+			out << [:static, @line]
+		end
+	end
+
+
+	def parse_include(path, control = '')
+		if control.empty?
+			parse_file_content(path)
+		else
+			parse_include_with_control(path, control)
+		end
+	end
+
+
+	def parse_file_content(path)
+		included_content = file_provider.call(path)
+		self.class.new.call(included_content)
+	end
+
+	def file_provider
+		options[:file_provider] || Rehab::FileProvider
+	end
+
+
+	def parse_include_with_control(path, control)
+		section = [:multi]
+		section << [:code, control]
+		section << parse_file_content(path)
+		section << [:code, 'end']
+	end
+end

data/lib/rehab/template.rb

@@ -0,0 +1,15 @@
+# usage: Rehab::Template.new(options) { source }.render(scope)
+module Rehab
+	class Template
+		attr_reader :tilt, :source
+
+		def initialize(opts = {})
+			@source = yield
+			@tilt = Temple::Templates::Tilt(Rehab::Engine, opts).new { source }
+		end
+
+		def render(scope)
+			tilt.render(scope)
+		end
+	end
+end

data/lib/rehab/version.rb

@@ -0,0 +1,3 @@
+module Rehab
+	VERSION = '0.1.2'
+end

data/rehab.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rehab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rehab"
+  spec.version       = Rehab::VERSION
+  spec.license       = "MIT"
+  spec.authors       = ["Shane Kuester"]
+  spec.email         = ["shout@shanekuester.com"]
+  spec.homepage      = "https://github.com/skuester/rehab"
+  spec.summary       = %q{Simple, portable template language}
+  # spec.description   = %q{Simple, portable template language}
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'tilt'
+  spec.add_dependency 'temple'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+end

data/sample.html

@@ -0,0 +1,29 @@
+<html>
+<body>
+	# include header.html
+
+
+	# if posts.empty?
+		<p>No posts yet</p>
+	# end
+
+
+	# for post in posts <!-- ignore section if posts missing or null -->
+		<h1>{{ post.title }}</h1>
+		<!-- alternative -->
+		<p>{{ post.author_email || 'No Email' }}</p>
+		<p>{{ post.content }}</p>
+	# end
+
+	<!-- ruby blocks -->
+	# 3.times do |n|
+		<h1>Hello World {{ n }}</h1>
+	# end
+
+	<!-- include partial for collection -->
+	# include partial.html for post in posts
+
+
+	# include footer.html
+</body>
+</html>

data/spec/integration_spec.rb

@@ -0,0 +1,235 @@
+require 'ostruct'
+require_relative "../lib/rehab"
+
+describe Rehab do
+	def template(src, opts = {})
+		Rehab::Template.new(opts) { src }.render(scope)
+	end
+
+	describe "interpolation" do
+		let(:scope) do
+			OpenStruct.new(
+				item: OpenStruct.new(greet: 'World'),
+				awesome: false
+				)
+		end
+
+
+		it "puts a variable from scope" do
+			src = 'Hello {{ item.greet }} and {{ item.greet }}'
+			out = 'Hello World and World'
+			expect(template src).to eq out
+		end
+
+
+		it "renders multiple lines" do
+			src = <<-EOF
+			Hello {{ item.greet }}
+			Hello {{ item.greet }}
+			EOF
+
+			out = <<-EOF
+			Hello World
+			Hello World
+			EOF
+			expect(template src).to eq out
+		end
+
+
+		it "doesn't care about white space" do
+			src = 'Hello {{item.greet         }}'
+			out = 'Hello World'
+			expect(template src).to eq out
+		end
+
+
+		it "is a plain ruby expression" do
+			src = "You are so {{ awesome ? 'Awesome' : 'Meh' }}"
+			out = "You are so Meh"
+			expect(template src).to eq out
+		end
+	end
+
+
+
+
+	describe "control flow" do
+		let(:scope) do
+			OpenStruct.new(
+				item: OpenStruct.new(greet: 'World'),
+				true_condition: true,
+				false_condition: false
+			)
+		end
+
+
+		it "renders a plain ruby block without 'do'" do
+			src = <<-EOF
+			<ul>
+			# 3.times
+				<li>Hello</li>
+			#end
+			</ul>
+			EOF
+
+			out = <<-EOF
+			<ul>
+				<li>Hello</li>
+				<li>Hello</li>
+				<li>Hello</li>
+			</ul>
+			EOF
+			expect(template src).to eq out
+		end
+
+
+		it "renders a plain ruby block WITH 'do' and block" do
+			src = <<-EOF
+			<ul>
+			# 3.times do |n|
+				<li>Hello {{ n }}</li>
+			# end
+			</ul>
+			EOF
+
+			out = <<-EOF
+			<ul>
+				<li>Hello 0</li>
+				<li>Hello 1</li>
+				<li>Hello 2</li>
+			</ul>
+			EOF
+			expect(template src).to eq out
+		end
+
+
+		it "renders if else" do
+			src = <<-EOF
+			first line
+			# if true_condition
+				A main
+			# else
+				A else
+			# end
+			# if false_condition
+				B main
+			# else
+				B else
+			# end
+			EOF
+
+			out = <<-EOF
+			first line
+				A main
+				B else
+			EOF
+			expect(template src).to eq out
+		end
+
+	end
+
+
+
+
+	describe "special controls" do
+		let(:scope) do
+			OpenStruct.new({
+				people: [
+					OpenStruct.new(name: 'Bill'),
+					OpenStruct.new(name: 'Fred')
+				]
+			})
+		end
+
+
+		it "renders for ... in" do
+			src = <<-EOF
+			# for person in people
+				<p>{{ person.name }}</p>
+			# end
+			EOF
+
+			out = <<-EOF
+				<p>Bill</p>
+				<p>Fred</p>
+			EOF
+			expect(template src).to eq out
+		end
+	end
+
+	describe "include" do
+		let(:scope) do
+			OpenStruct.new(
+				message: 'Hello World!',
+				people: [
+					OpenStruct.new(name: 'Bill'),
+					OpenStruct.new(name: 'Fred')
+				]
+			)
+		end
+
+		# an file_provider is anything that responds to "call"
+		# it should return the contents of the file
+		it "renders partials using a file provider" do
+			src = <<-EOF
+			# include my_partial.html
+			<p>content</p>
+			EOF
+
+			file = double("File Provider", call: <<-EOF
+			<p>{{ message }}</p>
+			EOF
+			)
+
+			out = <<-EOF
+			<p>Hello World!</p>
+			<p>content</p>
+			EOF
+			expect( file ).to receive(:call).with('my_partial.html')
+			expect(template(src, {file_provider: file})).to eq out
+		end
+
+		it "renders partials using a default file provider" do
+			File.open('tmp/my_partial.html', 'w') { |f| f.write "<p>{{ message }}</p>" }
+			src = <<-EOF
+			# include tmp/my_partial.html
+			<p>content</p>
+			EOF
+
+			out = <<-EOF
+<p>Hello World!</p>
+			<p>content</p>
+			EOF
+			expect(template(src)).to eq out
+			File.delete('tmp/my_partial.html')
+		end
+
+
+		it "provides a meaningful error when template is missing" do
+			src = <<-EOF
+			# include missing.html
+			<p>content</p>
+			EOF
+
+			expect{ template(src) }.to raise_error Rehab::MissingPartialError, "Could not find missing.html"
+		end
+
+		it "works with for .. in comprehension" do
+			src = <<-EOF
+			# include my_partial.html for person in people
+			EOF
+
+			file = ->(ignore) {
+			<<-EOF
+			<p>{{ person.name }}</p>
+			EOF
+			}
+
+			out = <<-EOF
+			<p>Bill</p>
+			<p>Fred</p>
+			EOF
+			expect(template(src, {file_provider: file})).to eq out
+		end
+	end
+end

data/todo.html

@@ -0,0 +1,9 @@
+<!-- samples of future features -->
+<p>{{ post.content | markdown }}</p>
+
+<!-- custom control flow -->
+# for post in posts
+	<p>... </p>
+# else
+	<p>empty!</p>
+# end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: rehab
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Shane Kuester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: temple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- shout@shanekuester.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rehab.rb
+- lib/rehab/control.rb
+- lib/rehab/do_filter.rb
+- lib/rehab/engine.rb
+- lib/rehab/file_provider.rb
+- lib/rehab/filter.rb
+- lib/rehab/interpolation.rb
+- lib/rehab/missing_partial_error.rb
+- lib/rehab/parser.rb
+- lib/rehab/template.rb
+- lib/rehab/version.rb
+- rehab.gemspec
+- sample.html
+- spec/.DS_Store
+- spec/integration_spec.rb
+- todo.html
+homepage: https://github.com/skuester/rehab
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Simple, portable template language
+test_files:
+- spec/.DS_Store
+- spec/integration_spec.rb