rcurse 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5af5099ed61ed119a867af78807019a7d52c7a77
-  data.tar.gz: bc9020f6c1d647b2b4962b795f7996424f0f5466
+  metadata.gz: c26d197807ffb34df4ef372293e0636708865057
+  data.tar.gz: 05e62ada8b1954a4ee5bb326664fdeb199f2f232
 SHA512:
-  metadata.gz: d747006f020d4b609a103918fb079f200494e9fb053ace280a265660a4fc545d1b20834888287d3a7e04781395fa6821273fff0724dd9264b81dfb07985e59ae
-  data.tar.gz: 47be8a207198a419858e9156e5890f302cdf0d47764e525c50a0b84344936de6abce68988fb52443302858a249f1ff7fa7bf92ef67efe3ef1fde6b49443b0491
+  metadata.gz: c88ae712a7d591f8ff212d0296fb4c62a6dc74ddccbe1a0c37da0f4943698dec8f084e7f24edaa54b808d2fef9c574fa6168cecfea33612a42d4c6063e8be444
+  data.tar.gz: 77122d9d2e900d5f4d98f2d0dfeba000d54aa7f0d7eeb7be7642f4ecad191e11616cc987bee345a977f5c5fca988f305c9cd7a794e2fd25d7d3a644eb3ef1e2c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Nick Shvelidze
+
+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

@@ -1,3 +1,42 @@
 # Rcurse <small>- Super simple template engine</small>
 
-Currently WIP
+## Installation
+
+Install it with `gem install rcurse`, 
+
+### Using Bundler
+
+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.
+
+### Complete 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")
+```
+
+## Helpers
+
+Helpers are the only functionality Rcurse provides yet. 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. 
+
+```ruby
+my_helper = Rcurse::Helper.new("my_helper") do |arguments|
+	# do something with arguments and return a string containing the new content
+end
+Rcurse.add_helper(my_helper)
+```

data/lib/rcurse/engine.rb

@@ -9,9 +9,8 @@ module Rcurse
         @helpers
     end
 
-    def self.render filename
-        file_contents = File.read filename
-        file_contents.gsub /{{([^ ]+) *(.+)?}}/ do |s|
+    def self.render content
+        content.gsub /{{([^ ]+) *(.+)?}}/ do |s|
             name = $1
             args = $2 ? $2.split(" ") : []
             if @helpers[name].is_a? Rcurse::Helper then
@@ -19,4 +18,12 @@ module Rcurse
             end
         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
+    end
+end

data/lib/rcurse/helpers/include.rb

@@ -1,3 +1,3 @@
 Rcurse.add_helper(Rcurse::Helper.new("include") do |args|
-    Rcurse::render args[0]
+    Rcurse::render File.read(args[0])
 end)

data/rcurse.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcurse
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Nick Shvelidze
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - lib/rcurse.rb
 - lib/rcurse/engine.rb