inline_templates 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1391230187758595f59ccb744dbb3ccb124aef1d
+  data.tar.gz: ade328c124f06942ada52b3f6198f5038ec90a9e
+SHA512:
+  metadata.gz: 19f7c6edded139cd6b9e8fa0534ea9725bbff35f07e5c526ea901469a947183998845a3bc3e1c77592407a8205b39cbc7002fc11d0bb5fc9af6e5a8e7bd1dde1
+  data.tar.gz: b8f383aec61fd96b5a25a121c57f7cf70de16597af31735eaeb9cce2d09ee127e09cf4820fd1a5689dd9a30b5898a723a459787252764bf50afdb533f0b7b7a4

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inline_templates.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Gridasov
+
+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,76 @@
+# Inline Templates
+
+Inline Templates allow you to write HTML markup in your controllers just like arbre, but without its inherent incompatibilities. All helpers - Rails builtin, provided by other gems and yours - are available out of box.
+
+For example:
+```ruby
+@inline_html = rit do
+  ~ form_for(:session) do |f|
+    ~ div(class: "fields") do
+      ~ div(class: "field") do
+        ~ f.label(:email, 'E-Mail')
+        ~ f.text_field(:email)
+      end
+      ~ div(class: "field") do
+        ~ f.label(:password, 'Password')
+        ~ f.password_field(:password)
+      end
+    end
+
+    ~ div(class: "actions") do
+      ~ f.submit
+    end
+  end
+end
+```
+
+Plain strings (i.e. not helpers output or variable values) should be escaped by `t` or `h` helper before passing them to `~` for output. `t` should be used for text and `h` should be used for HTML.
+
+Inline Templates can also be used in views. It handles `.rit` files with same syntax.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'inline_templates'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inline_templates
+
+## Usage
+
+In Rails controllers:
+```ruby
+class TestController < ApplicationController
+  include InlineMarkup::Helpers
+
+  def test
+    @inline_html = rit(:list => [ 'a', 'b', 'c' ]) do
+      ~ ul do
+        list.each do |item|
+          ~ li(item)
+        end
+      end
+    end
+```
+
+Standalone:
+```ruby
+view = ActionView::Base.new context, assigns, controller, formats
+inline_html = InlineTemplates.render view, details, locals do
+  ~ t('foo')
+end
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/inline_views.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inline_templates/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inline_templates"
+  spec.version       = InlineTemplates::VERSION
+  spec.authors       = ["Sergey Gridasov"]
+  spec.email         = ["grindars@gmail.com"]
+  spec.description   = %q{Inline templates for Rails controllers with Arbre-like DSL}
+  spec.summary       = %q{Inline templates for Rails}
+  spec.homepage      = "https://github.com/grindars/inline_templates"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2"
+
+  spec.add_dependency 'actionpack', '>= 3'
+end

data/lib/inline_templates/blank_object.rb

@@ -0,0 +1,27 @@
+module InlineTemplates
+  class BlankObject < BasicObject
+    include ::Kernel
+
+    def self.make_blank(*keep)
+      old_verbose = $VERBOSE
+      begin
+        $VERBOSE = nil
+
+        drop_methods [ :!, :!=, :==, :__id__, :__send__, :equal?, :instance_eval, :instance_exec ], keep
+        drop_methods ::Kernel.instance_methods, keep
+        drop_methods ::Kernel.private_instance_methods, keep
+
+      ensure
+        $VERBOSE = old_verbose
+      end
+    end
+
+    def self.drop_methods(methods, keep)
+      methods.each do |name|
+        next if keep.include? name
+
+        undef_method name
+      end
+    end
+  end
+end

data/lib/inline_templates/buffer_wrapper.rb

@@ -0,0 +1,43 @@
+module InlineTemplates
+  class BufferWrapper < BlankObject
+    make_blank :respond_to?
+
+    def initialize(object, buffer)
+      @object = object
+      @buffer = buffer
+    end
+
+    def __inline_templates_object; @object; end
+ 
+    def ~
+      @buffer.append = @object
+      @object
+    end
+
+    def method_missing(name, *args, &block)
+      args.map! &BufferWrapper.method(:unwrap)
+
+      BufferWrapper.wrap @object.__send__(name, *args, &block), @buffer
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @object.respond_to?(name, include_private)
+    end
+ 
+    def self.wrap(result, buffer)
+      if result.class == ::NilClass || result.class == ::TrueClass || result.class == ::FalseClass
+        result
+      else
+        BufferWrapper.new(self.unwrap(result), buffer)
+      end
+    end
+
+    def self.unwrap(obj)
+      if obj.respond_to? :__inline_templates_object
+        obj.__inline_templates_object
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/inline_templates/builder.rb

@@ -0,0 +1,11 @@
+module InlineTemplates
+  class Builder
+    def build(context, name, *args, &block)
+      context.content_tag name, *args, &block
+    end
+ 
+    def can_build?(name)
+      true
+    end
+  end
+end

data/lib/inline_templates/helpers.rb

@@ -0,0 +1,13 @@
+module InlineTemplates
+  module Helpers
+    extend ActiveSupport::Concern
+    
+    def rit(locals = {}, &block)
+      InlineTemplates.render(view_context, {}, locals, &block)
+    end
+
+    included do
+      protected :rit
+    end
+  end
+end

data/lib/inline_templates/rendering_context.rb

@@ -0,0 +1,43 @@
+module InlineTemplates
+  class RenderingContext < BlankObject
+    make_blank :instance_exec, :instance_variable_set
+
+    def initialize(context, locals, builder)
+      @_inlinetemplates_context = context
+      @_inlinetemplates_locals = locals
+      @_inlinetemplates_evaluating = true
+      @_inlinetemplates_builder = builder
+
+      context.instance_variables.each do |var|
+        instance_variable_set var, context.instance_variable_get(var)
+      end
+    end
+ 
+    def t(obj)
+      BufferWrapper.wrap obj.to_s, @_inlinetemplates_context.output_buffer
+    end
+
+    def h(obj)
+      BufferWrapper.wrap obj.to_s.html_safe, @_inlinetemplates_context.output_buffer
+    end
+ 
+    def method_missing(name, *args, &block)
+      args.map! &BufferWrapper.method(:unwrap)
+
+      if @_inlinetemplates_locals.include?(name) && args.length == 0
+        result = @_inlinetemplates_locals[name]
+ 
+      elsif @_inlinetemplates_context.respond_to?(name, true)
+        result = @_inlinetemplates_context.__send__ name, *args, &block
+ 
+      elsif @_inlinetemplates_builder.can_build?(name)
+        result = @_inlinetemplates_builder.build @_inlinetemplates_context, name, *args, &block
+ 
+      else
+        super
+      end
+ 
+      BufferWrapper.wrap result, @_inlinetemplates_context.output_buffer
+    end
+  end
+end

data/lib/inline_templates/template_handler.rb

@@ -0,0 +1,14 @@
+module InlineTemplates
+  class TemplateHandler
+    def call(source)
+      <<-EOF
+        @output_buffer ||= ActionView::OutputBuffer.new
+        context = ::InlineTemplates::RenderingContext.new(self, local_assigns, ::InlineTemplates::Builder.new)
+        context.instance_exec do
+          #{source.source}
+        end
+        @output_buffer.to_s
+      EOF
+    end
+  end
+end

data/lib/inline_templates/version.rb

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

data/lib/inline_templates.rb

@@ -0,0 +1,39 @@
+require "active_support"
+require "action_view"
+
+require "inline_templates/version"
+require "inline_templates/builder"
+require "inline_templates/blank_object"
+require "inline_templates/buffer_wrapper"
+require "inline_templates/rendering_context"
+require "inline_templates/helpers"
+require "inline_templates/template_handler.rb"
+
+module InlineTemplates
+  def self.render(view, details, locals, &block)
+    identifier = "(inline:#{block.inspect})"
+ 
+    handler = ->(template) do
+      method_name = nil
+      template.instance_exec do
+        method_name = self.method_name
+ 
+        view.singleton_class.send :define_method, "#{method_name}_block" do
+          block 
+        end
+      end
+ 
+      <<-EOF
+        @output_buffer ||= ActionView::OutputBuffer.new
+        context = ::InlineTemplates::RenderingContext.new(self, local_assigns, ::InlineTemplates::Builder.new)
+        context.instance_exec &self.#{method_name}_block
+        @output_buffer.to_s
+      EOF
+    end
+ 
+    template = ActionView::Template.new("", identifier, handler, details)
+    template.render view, locals
+  end
+end
+
+ActionView::Template.register_template_handler :rit, InlineTemplates::TemplateHandler.new

data/spec/inline_templates/helpers_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe InlineTemplates::Helpers do
+  it "defines helper" do
+    invoke_controller(TestController, :test).should == TestController::ReferenceOutput
+  end
+end

data/spec/inline_templates/template_handler_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe InlineTemplates::TemplateHandler do
+  it "renders" do
+    invoke_controller(TestController, :test_file).should == TestController::ReferenceOutput
+  end
+end

data/spec/inline_templates_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe InlineTemplates do
+  describe 'render' do
+    it 'builds elements' do
+      test_rit do
+        ~ span('test')
+      end.should == "<span>test</span>"
+    end
+
+    it 'builds multiple elements' do
+      test_rit do
+        ~ span('test 1')
+        ~ span('test 2')
+      end.should == "<span>test 1</span><span>test 2</span>"
+    end
+
+    it 'captures' do
+      test_rit do
+        ~ div do
+          ~ span('test')
+        end
+      end.should == "<div><span>test</span></div>"
+    end
+
+    it 'handles locals and conditionals' do
+      locals = {
+        :cond => true,
+        :a => 'foo',
+        :b => 'bar'
+      }
+
+      test_block = proc do
+        if cond
+          ~ a
+        else
+          ~ b
+        end
+      end
+
+      test_rit(locals, &test_block).should == "foo"
+      locals[:cond] = false
+      test_rit(locals, &test_block).should == "bar"
+    end
+
+    it 'supports response postprocessing' do
+      test_rit do
+        e1 = div 'foo'
+        e2 = span 'bar'
+
+        ~ (e1 + e2)
+      end.should == "<div>foo</div><span>bar</span>"
+    end
+
+    it 'properly handles nested blocks' do
+      locals = { :list => [ '1', '2', '3', '4' ] }
+      test_rit(locals) do
+        ~ ul do
+          list.each do |item|
+            ~ li(item)
+          end
+        end
+      end.should == '<ul><li>1</li><li>2</li><li>3</li><li>4</li></ul>'
+    end
+
+    it 'implements t helper' do
+      test_rit do
+        ~ t('<br />')
+      end.should == "&lt;br /&gt;"
+    end
+
+    it 'implements h helper' do
+      test_rit do
+        ~ h('<br />')
+      end.should == "<br />"
+    end
+
+    it 'passes instance variables' do
+      test_rit do
+        ~ t(@virtual_path)
+      end.should == "(inline)"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require 'action_controller'
+require 'inline_templates'
+
+def invoke_controller(controller, action)
+  status, headers, content = controller.action(action).call({
+    "rack.input" => StringIO.new,
+    "REQUEST_METHOD" => "GET"
+  })
+
+  content.body
+end
+
+def test_rit(locals = {}, &template)
+  inner_context = nil
+  assigns = {}
+  controller = nil
+  formats = nil
+   
+  view = ActionView::Base.new inner_context, assigns, controller, formats
+
+  InlineTemplates.render view, { virtual_path: "(inline)" }, locals, &template
+end
+
+class TestController < ActionController::Base
+  ReferenceOutput = "<div>test</div>"
+
+  include InlineTemplates::Helpers
+
+  def test
+    self.response_body = rit do
+      ~ div("test")
+    end
+  end
+
+  def test_file
+    render :file => File.expand_path("../support/test.rit", __FILE__)
+  end
+end
+

data/spec/support/test.rit

@@ -0,0 +1 @@
+~ div("test")

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: inline_templates
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Gridasov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Inline templates for Rails controllers with Arbre-like DSL
+email:
+- grindars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- inline_views.gemspec
+- lib/inline_templates.rb
+- lib/inline_templates/blank_object.rb
+- lib/inline_templates/buffer_wrapper.rb
+- lib/inline_templates/builder.rb
+- lib/inline_templates/helpers.rb
+- lib/inline_templates/rendering_context.rb
+- lib/inline_templates/template_handler.rb
+- lib/inline_templates/version.rb
+- spec/inline_templates/helpers_spec.rb
+- spec/inline_templates/template_handler_spec.rb
+- spec/inline_templates_spec.rb
+- spec/spec_helper.rb
+- spec/support/test.rit
+homepage: https://github.com/grindars/inline_templates
+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.3
+signing_key: 
+specification_version: 4
+summary: Inline templates for Rails
+test_files:
+- spec/inline_templates/helpers_spec.rb
+- spec/inline_templates/template_handler_spec.rb
+- spec/inline_templates_spec.rb
+- spec/spec_helper.rb
+- spec/support/test.rit