rcurse 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 170b6db184dd6e7179927e347cbd615f7388c494
-  data.tar.gz: 200b0db10151a10214ceb3bc4fab2516e085d1db
+  metadata.gz: be3bc122cddb4add5b5937f1cfd815c021429b61
+  data.tar.gz: d99e9fe4564abdeb690aced53bd66ba682a5231e
 SHA512:
-  metadata.gz: a3730771a339db49d5cba3de902ac72fa0f79fa3cc8715c5b07ac0d26db7f7e45e058cee342a5f1ae87f7a1b3e442082be6a6656f7d0c50e732565d9ae964334
-  data.tar.gz: ed7529da098310db75ed6e03689b10a1dc248960b285e94a2ce9bf5f1af145643cc25928bb51a29a2908d24dea07e4de4b04267d0f2771605ea626b1f2d522f6
+  metadata.gz: 0029c067c75d50fb5a8703b56d0de9855aad1a194b40c43b65573ce217a8d40e3c00facc2c3c7bbe5029a5d76679c6d017db70f66a22efb92776c242c3a2fa38
+  data.tar.gz: a338c47357085a4ffe5129fb6634bada1ad5db9f7f2dff28ba69eb8f2269c6068b13df223a02f5235af19fab8cf189fc6f9a8e6c0bf548c13ee2bcabdfb04e68

data/.gitignore

@@ -1 +1,3 @@
-*.gem
+*.gem
+Gemfile.lock
+spec-data/*.out

data/Gemfile

@@ -1 +1,4 @@
-source 'https://rubygems.org'
+source 'https://rubygems.org'
+
+gem "rake"
+gem "rspec"

data/README.md

@@ -6,37 +6,64 @@ Install it with `gem install rcurse`,
 
 ### Using Bundler
 
-add `gem :rcurse` to your `Gemfile` and run `bundle install`
+add `gem "rcurse"` to your `Gemfile` and run `bundle install`
 
 ## Usage
 
 Require it with `require 'rcurse'`.  
-Call `Rcurse.render "file.rcurse"` to render `file.rcurse` and return the rendered file contents, you can then write it to a file.
+Call `Rcurse::render "file.rcurse"` to render `file.rcurse` and return the rendered file contents, you can then write it to a file.
 
-### Complete example
+### Usage example
 
 Let's assume that we have file names `index.rcurse` and want to render it to `index.html`
 
 ```ruby
 require 'rcurse'
-Rcurse.render_file("index.rcurse", "index.html")
+Rcurse::render_file("index.rcurse", "index.html")
 ```
 
+## Evaluating code
+
+Wrap your Ruby code in `{%` and `%}` to evaluate it. You can use it to set variables or do other stuff. This doesn't output anything to the template, if you want to output the result of your code, use `{%=` instead of `{%`, like `{%= "trololo".upcase %}`.
+
+### Examples
+
+Using variables:  
+
+```html
+{% name = "Hodor" %}
+
+<h1>Hello, {%= name %}!</h1>
+```
+
+Renders as:
+
+```html
+<h1>Hello, Hodor!</h1>
+```
+
+## Context
+
+Context contains a binding for template variables, and a path of current template if Rcurse is rendering a file.  
+Use `context.eval` to evaluate Ruby code.
+
+`context.eval "a = 1"`
+
+See `context.path` for the path of currently rendered template.
+
 ## Helpers
 
-Helpers are the only functionality Rcurse provides yet. Use them by inserting `{{helper-name arguments}}` in source files.   
+Helpers are like functions you can call in your templates. Use them by inserting `{{helper-name arguments}}` in source files.   
 
 ### Builtin helpers
 - `include filename` - include another file, like so: `{{include header.rcurse}}`
 
 ### Adding a helper
 
-Use `Rcurse::Helper.new(name) { block }` to create a helper, your block can accept a single array of arguments.  
-Use `Rcurse.add_helper(helper)` to add your helper to Rcurse. 
+Use `Rcurse::Helper.new(name) { |args, context| do_something }` to create a helper, your block can accept a single array of arguments and a context.  
 
 ```ruby
-my_helper = Rcurse::Helper.new("my_helper") do |arguments|
+my_helper = Rcurse::Helper.new("my_helper") do |arguments, context|
 	# do something with arguments and return a string containing the new content
 end
-Rcurse.add_helper(my_helper)
 ```

data/Rakefile

@@ -0,0 +1,14 @@
+project_root = File.dirname(File.absolute_path(__FILE__))
+rcurse_path = project_root + "/lib/rcurse.rb"
+
+task :spec do
+	system "rspec --color -f d -r #{rcurse_path}"
+end
+
+task :clean do
+	Dir.glob(project_root + "/spec-data/*.out") do |f|
+		File.delete f
+	end
+end
+
+task :default => [:spec, :clean]

data/lib/rcurse.rb

@@ -1,6 +1,7 @@
 project_root = File.dirname(File.absolute_path(__FILE__))
 
-require "rcurse/engine"
-require "rcurse/helper"
+require project_root + "/rcurse/engine.rb"
+require project_root + "/rcurse/helper.rb"
+require project_root + "/rcurse/context.rb"
 
 Dir.glob(project_root + '/rcurse/helpers/*.rb', &method(:require))

data/lib/rcurse/context.rb

@@ -0,0 +1,18 @@
+module Rcurse
+	class Context
+		def initialize path = nil
+			@binding = binding
+			@path = path
+		end
+
+		def get_binding
+			@binding
+		end
+
+		def eval code
+			@binding.eval code
+		end
+
+		attr_accessor :path
+	end
+end

data/lib/rcurse/engine.rb

@@ -1,29 +1,43 @@
 module Rcurse
-    @helpers = Hash.new
+    class Engine
+        def self.render content, context = Context.new
+            content.gsub /{({|%=|%)(.+?)[}|%]}/ do |s|
+                result = s
 
-    def self.add_helper helper
-        @helpers[helper.name] = helper
-    end
+                case $1
+                when "{"
+                    s = $2.chomp.split(" ")
+                    name = s[0]
+                    args = s[1..s.length]
+                    if Rcurse::helpers[name].is_a? Rcurse::Helper then
+                        result = Rcurse::helpers[name].callback.call(args, context)
+                    end
+                when "%"
+                    context.eval($2)
+                    result = ""
+                when "%="
+                    result = context.eval($2)
+                end
 
-    def self.helpers
-        @helpers
-    end
+                result
+            end
+        end
 
-    def self.render content
-        content.gsub /{{([^ ]+) *(.+)?}}/ do |s|
-            name = $1
-            args = $2 ? $2.split(" ") : []
-            if @helpers[name].is_a? Rcurse::Helper then
-                @helpers[name].callback.call(args)
+        def self.render_file filename, out_filename, context = Context.new
+            content = File.read(filename)
+            context.path = File.dirname(filename)
+            rendered_content = self.render(content, context)
+            File.open(out_filename, "w+") do |file|
+                file.write(rendered_content)
             end
         end
     end
 
-    def self.render_file filename, out_filename
-        content = File.read(filename)
-        rendered_content = self.render(content)
-        File.open(out_filename, "w+") do |file|
-            file.write(rendered_content)
-        end
+    def self.render content, context = Context.new
+        Rcurse::Engine.render content, context
+    end
+
+    def self.render_file filename, out_filename, context = Context.new
+        Rcurse::Engine.render_file filename, out_filename, context
     end
 end

data/lib/rcurse/helper.rb

@@ -1,4 +1,14 @@
 module Rcurse
+    @helpers = Hash.new
+
+    def self.add_helper helper
+        @helpers[helper.name] = helper
+    end
+
+    def self.helpers
+        @helpers
+    end
+    
     class Helper
         attr_accessor :name
         attr_accessor :callback

data/lib/rcurse/helpers/include.rb

@@ -1,3 +1,8 @@
-Rcurse.add_helper(Rcurse::Helper.new("include") do |args|
-    Rcurse::render File.read(args[0])
-end)
+Rcurse::Helper.new("include") do |args, context|
+	if context.path then
+		file_path = File.expand_path(args[0], context.path)
+	else 
+		file_path = args[0]
+	end
+  Rcurse::render(File.read(file_path), context)
+end

data/rcurse.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'rcurse'
-  s.version     = '0.4.0'
+  s.version     = '0.5.1'
   s.licenses    = ['MIT']
   s.summary     = "Super simple template engine."
   s.description = "Super simple template engine."

data/spec-data/hello.html

@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<title>Hello World</title>

data/spec-data/included.html

@@ -0,0 +1 @@
+hello world

data/spec-data/includes.html

@@ -0,0 +1 @@
+{{include included.html}}

data/spec/context_spec.rb

@@ -0,0 +1,16 @@
+describe Rcurse::Context do
+	it "initializes" do
+		context = Rcurse::Context.new
+		expect(context).to be_a(Rcurse::Context)
+	end
+
+	it "returns binding" do
+		context = Rcurse::Context.new
+		expect(context.get_binding).to be_a(Binding)
+	end
+
+	it "returns the same binding every time" do
+		context = Rcurse::Context.new
+		expect(context.get_binding).to eq(context.get_binding)
+	end
+end

data/spec/engine_spec.rb

@@ -0,0 +1,35 @@
+describe Rcurse::Engine do
+  it "renders an empty template" do
+  	result = Rcurse::render("")
+    expect(result).to eq("")
+  end
+
+  it "renders a template with text" do
+  	result = Rcurse::render("Hello World")
+    expect(result).to eq("Hello World")
+  end
+
+  it "renders a template with unicode text" do
+  	result = Rcurse::render("გამარჯობა")
+    expect(result).to eq("გამარჯობა")
+  end
+
+  it "renders a hello world file" do
+    file_path = File.expand_path("../../spec-data/hello.html", __FILE__)
+    out_file_path = File.expand_path("../../spec-data/hello.html.out", __FILE__)
+
+    result = Rcurse::render_file(file_path, out_file_path)
+
+    expect(File.new out_file_path).to be_a(File)
+  end
+
+  it "renders {% nil %} as empty"do
+  	result = Rcurse::render("{% nil %}")
+    expect(result).to eq("")
+  end
+
+  it "renders {%= 1 %} as 1"do
+  	result = Rcurse::render("{%=1 %}")
+    expect(result).to eq("1")
+  end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,8 @@
+describe Rcurse::Helper do
+	it "Initializes with dummy name and callback" do
+		helper = Rcurse::Helper.new("dummy") {}
+		expect(helper).to be_a(Rcurse::Helper)
+		expect(helper.name).to eq("dummy")
+		expect(helper.callback).to be_a(Proc)
+	end
+end

data/spec/include_spec.rb

@@ -0,0 +1,10 @@
+describe "include helper" do
+	it "includes another template" do
+		file_path = File.expand_path("../../spec-data/includes.html", __FILE__)
+    out_file_path = File.expand_path("../../spec-data/includes.html.out", __FILE__)
+
+    result = Rcurse::render_file(file_path, out_file_path)
+
+    expect(File.read out_file_path).to eq("hello world")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcurse
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Nick Shvelidze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies: []
 description: Super simple template engine.
 email: captain@pirrate.me
@@ -21,12 +21,21 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/rcurse
 - lib/rcurse.rb
+- lib/rcurse/context.rb
 - lib/rcurse/engine.rb
 - lib/rcurse/helper.rb
 - lib/rcurse/helpers/include.rb
 - rcurse.gemspec
+- spec-data/hello.html
+- spec-data/included.html
+- spec-data/includes.html
+- spec/context_spec.rb
+- spec/engine_spec.rb
+- spec/helper_spec.rb
+- spec/include_spec.rb
 homepage: http://shvelo.github.io/rcurse
 licenses:
 - MIT
@@ -47,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Super simple template engine.