tiny_template 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5ede3dedd284a99cf689b33fd15498ba93343b3
+  data.tar.gz: 0193eb19023980520cad7bd2e0c817ee5217c3d6
+SHA512:
+  metadata.gz: 9909cd0fd8bb5ca4c44ae0db9d39405d467eeb18fa1f3c94c48c8bb7d5678b1488a947df4ffd925ed52bb79b6d0bfe70bd08d4e0f45f966ecb2b9c943a256fd3
+  data.tar.gz: d2d80338256cc5a0b041b5d4c69210c4fb040739c5bc7c6c02c8168aa1bf61a210d2b6b5f27b84027b2395980e1ea8cb9e37fa44593467586f489548ee499607

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+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,63 @@
+# TinyTemplate
+
+This is a very simple template engine that allows you to interpolate method chains without passing it any data. TinyTemplate will use the `self` of the caller when no context is passed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tiny_template'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tiny_template
+
+## Usage
+
+You just have to prepend your strings with the ~ operator to parse them with the methods of the current self :
+
+```ruby
+class Greeting
+  def hello
+    ~"Hello {{client.name.upcase}} and welcome to {{configuration.title.capitalize}}.
+      Your email is {{client.email.downcase.strip}}."
+  end
+
+  def client
+    OpenStruct.new(name: 'John Doe', email: 'John@doe.com')
+  end
+
+  def configuration
+    OpenStruct.new(title: 'my fancy website')
+  end
+end
+
+Greeting.new.hello
+
+# => "Hello JOHN DOE and welcome to My fancy website. Your email is john@doe.com."
+```
+
+
+
+If you don't like the binding magic used here, you can use TinyTemplate with the classic syntax :
+
+```ruby
+template = "Hello {{client.name.upcase}} and welcome to {{configuration.title.capitalize}}.
+            Your email is {{client.email.downcase.strip}}."
+
+TinyTemplate.parse(template, self)
+````
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tiny_template/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/tiny_template/core_ext.rb

@@ -0,0 +1,13 @@
+class String
+  def parse(context = nil)
+    unless context
+      RubyVM::DebugInspector.open do |inspector|
+        context = eval('self', inspector.frame_binding(2))
+      end
+    end
+
+    TinyTemplate(self, context)
+  end
+
+  alias_method :~, :parse
+end

data/lib/tiny_template/version.rb

@@ -0,0 +1,3 @@
+class TinyTemplate
+  VERSION = "0.0.1"
+end

data/lib/tiny_template.rb

@@ -0,0 +1,53 @@
+require "tiny_template/version"
+require 'debug_inspector'
+require "tiny_template/core_ext"
+
+class TinyTemplate
+  # You can construct by your sulf this class, but you wont benefict from the magic
+  # of the context being automaticaly calculated with debug_inspector
+  def initialize(str)
+    self.str = str
+  end
+
+  # Context can be any object that you expect it will respond to methods on the template passed
+  # to the constructor
+  def parse(context)
+    str.gsub(/\{\{\w+(\.\w+)*\}\}/) do |match|
+      interpolate(match, context)
+    end
+  end
+
+  # This is a facility class method aimed to simplify the construction
+  def self.parse(str, context)
+    new(str).parse(context)
+  end
+
+  private
+    attr_accessor :str
+
+    # Private method used to interpolate one single expression at a time
+    def interpolate(match, context)
+      match.gsub(/\{|\}/, '')
+           .split('.')
+           .inject(context){ |result, e| result.public_send(e) }
+
+    rescue
+      match
+    end
+
+  module Utils
+    # Call this method with or without context. If no context is passed, the context of the caller
+    # will be computed and passed to a new instance of the class TinyTemplate
+    def TinyTemplate(str, context = nil)
+      unless context
+        RubyVM::DebugInspector.open do |inspector|
+          context = eval('self', inspector.frame_binding(2))
+        end
+      end
+
+      TinyTemplate.parse(str, context)
+    end
+  end
+end
+
+include TinyTemplate::Utils

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'active_record'
+require 'tiny_template'
+
+RSpec.configure do |config|
+end

data/spec/tiny_template_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'ostruct'
+
+RSpec.describe TinyTemplate do
+  before(:each) do
+    @klass = Class.new do
+      def hello
+        TinyTemplate.parse(template, self)
+      end
+
+      def template
+        "Hello {{client.name.upcase}} and welcome to {{configuration.title.capitalize}}. Your email is {{client.email.downcase.strip}}."
+      end
+
+      def client
+        OpenStruct.new(name: 'John Doe', email: '  John@doe.com   ')
+      end
+
+      def configuration
+        OpenStruct.new(title: 'my Fancy website')
+      end
+    end
+  end
+
+  it "should interpolate strings correctly" do
+    result = @klass.new.hello
+
+    expect(result).to match(/JOHN DOE/)
+    expect(result).to match(/My fancy website/)
+    expect(result).to match(/john@doe.com/)
+  end
+
+  it "should ignore non existing methods" do
+    @klass.class_eval do
+      def template
+        "Hello {{client.name.inexisting_method}}"
+      end
+    end
+
+    result = @klass.new.hello
+
+    expect(result).to match(/\{\{client\.name\.inexisting_method\}\}/)
+  end
+
+  it "should find the context of caller when no context is passed" do
+    @klass.class_eval do
+      def hello
+        TinyTemplate(template)
+      end
+    end
+
+    result = @klass.new.hello
+
+    expect(result).to match(/JOHN DOE/)
+  end
+end
+

data/tiny_template.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tiny_template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiny_template"
+  spec.version       = TinyTemplate::VERSION
+  spec.authors       = ["Ihcène Medjber (ihcene)"]
+  spec.email         = ["i@aritylabs.com"]
+  spec.summary       = %q{Magical and secure string interpolation.}
+  spec.description   = %q{A very simple template engine that allows you to interpolate method chains without passing it any data}
+  spec.homepage      = "http://github.com/ihcene/tiny_template"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "debug_inspector", '~> 0.0', '>= 0.0.2'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: tiny_template
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ihcène Medjber (ihcene)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug_inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: A very simple template engine that allows you to interpolate method chains
+  without passing it any data
+email:
+- i@aritylabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tiny_template.rb
+- lib/tiny_template/core_ext.rb
+- lib/tiny_template/version.rb
+- spec/spec_helper.rb
+- spec/tiny_template_spec.rb
+- tiny_template.gemspec
+homepage: http://github.com/ihcene/tiny_template
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Magical and secure string interpolation.
+test_files:
+- spec/spec_helper.rb
+- spec/tiny_template_spec.rb