rendering_engine 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmUyYzQxMDAzNDJhNmRhYjQ5YTllM2E1YTZjZmUwMzdjNTA3ZjBmOQ==
+    YzhkNmMzOWYzMmU3MmFhMDI5NjA0N2FmMGVhMTA5ZWQ4MjVmMGNmYQ==
   data.tar.gz: !binary |-
-    ZDBjZTcxM2UyNWFiYjI4OWQ2YzhlNTM1YzE3NmZlYTkzNzM0MmVmOQ==
+    NTRkZDIxYTA5MWU1MTA5NDk4NGQwMThmNmM1NDU3N2VhNTE4NDVlNg==
 SHA512:
   metadata.gz: !binary |-
-    YjcwYTc1ZTY5YjBlNDdkYWQ3YTViNzhmYjM4ZDQ5MDk2MDM2MWUwYTBlZjIx
-    NzY1NTYyOGE1YzE0YzRmMTM0YTkzYTc4ZDdkYWRkOWU3OTZiYTdlZjZjNzE3
-    ODlhNzJmMjZjM2ZjNjNiNjUzYWJiNmI3MzMzYTAwZWRhYmQxY2Q=
+    OWNkNzRhNmNhOGNmYzczMTcxMzIwN2Q5YzY2MTQ1NWRlNmYzYjQ5ZTM3NTEw
+    NDMyYmI5N2U1MTNjMTA0ZGVkZTdlOGU5OTNmMGQzZmRkODUxZTRkYzQ4NTdl
+    NjYwNDQ5OGQ2N2QwMjBkYjk5MDc4ZjA3MDUwNWM4ZTY1YmJmNmI=
   data.tar.gz: !binary |-
-    YjUxNjA4YjY4OTgzODhhODBlZjdmY2U3MTM3ZDk0NmE0NDQ1YWZlNDc5Mjgz
-    MDVkNDM1ZDBjYmE4ZDFjYjlkNjEwOTlmNDZlYjYxZTFjNTMyMzAxM2FhYTZk
-    NTEwNmRkYTU1MWUxMWFkZWZmMjMzYTM5NWY3ZTJlMDIxZWE4YzI=
+    ZTlkNDM0ZmYxNzYwYzkyMGE0YzdkMmJlMWQyM2M2Njk1MzJlZDc3NGVjY2Nh
+    ZjljNjI2MzI1NjNhYTM5YmJjOGNhYjAwMjM2ZWI5ZDQyZTAyOGJiYTg2Zjg3
+    NzkwODdmMDY1NTI4MTgyZDFjNWI1YmFjNmZjMDI5M2FhODhjZDg=

data/README.md

@@ -1,7 +1,5 @@
 # RenderingEngine
 
-TODO: Write a gem description
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +16,77 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ content_provider = RenderingEngine::Provider.new(base_path)
+    $ content = content_provider.get(relative_file_path)
+    $ content.source #gets source of file (rendered or not :D)
+    $ content.kind return (:orginal, :template, :unknown)
+
+    In controller can looks like this:
+
+    ---
+    def show
+      path = "#{params[:client]}/#{params[:path]}"
+      data = params[:data]
+
+      content = content_provider.get(path, data)
+      return not_found if content.unknown?
+
+      render text: content.source
+    end
+
+    def content_provider
+      @content_provider ||= RenderingEngine::Provider.new(Rails.root.join('app/content'))
+    end
+    ---
+
+## Own Helper class
+
+```
+
+class ContentCustomHelpers
+  def initialize(opts={})
+    @base_path = opts.fetch(:base_path)
+    @data      = opts[:data]
+  end
+
+  def make_some_stuff
+    "best line ever!"
+  end
+
+  def render(file_relative_path)
+    file_path = File.join(base_path, file_relative_path)
+
+    RenderingEngine::Content.new(file_path, data: data, custom_helper: self.class).source
+  end
+
+  attr_reader :data
+
+  private
+
+  attr_reader :base_path
+end
+
+
+```
+
+### Usage own custom class
+
+```
+
+provider = RenderingEngine::Provider.new(Rails.root.join('app/content'), custom_helper: ContentCustomHelpers)
+provider.get(path).source
+
+```
+
+or
+
+```
+
+provider = RenderingEngine::Provider.new(Rails.root.join('app/content'))
+provider.get(path, custom_helper: ContentCustomHelpers).source
+
+
+```
 
 ## Contributing
 

data/lib/rendering_engine/content.rb

@@ -2,18 +2,23 @@ require 'erb'
 
 module RenderingEngine
   class Content
-    attr_reader :file_path
+    attr_reader :file_path, :data
 
-    def initialize(file_path, base_folder_path=nil)
+    def initialize(file_path, opts={})
       @file_path        = file_path
-      @base_folder_path = base_folder_path
+      @base_folder_path = opts[:base_folder_path]
+      @data             = opts[:data]
+      @custom_helper    = opts[:custom_helper]
     end
 
     def source
       @source ||= (
         case kind
         when :orginal  then File.read(file_path)
-        when :template then ERB.new(File.read(file_path_as_erb)).result(helpers(base_folder_path).instance_eval { binding })
+        when :template
+          ERB.new(File.read(file_path_as_erb)).result(
+            helper(base_folder_path, data).instance_eval { binding }
+          )
         else ''
         end
       )
@@ -49,8 +54,10 @@ module RenderingEngine
 
     private
 
-    def helpers(path)
-      ContentHelpers.new(base_path: path)
+    attr_reader :custom_helper
+
+    def helper(path, content_data)
+      (custom_helper || ContentHelpers).new(base_path: path, data: content_data)
     end
 
     def orginal_file_present?

data/lib/rendering_engine/content_helpers.rb

@@ -2,14 +2,17 @@ module RenderingEngine
   class ContentHelpers
     def initialize(opts={})
       @base_path = opts.fetch(:base_path)
+      @data      = opts[:data]
     end
 
     def render(file_relative_path)
       file_path = File.join(base_path, file_relative_path)
 
-      RenderingEngine::Content.new(file_path).source
+      RenderingEngine::Content.new(file_path, data: data).source
     end
 
+    attr_reader :data
+
     private
 
     attr_reader :base_path

data/lib/rendering_engine/provider.rb

@@ -1,16 +1,18 @@
 module RenderingEngine
   class Provider
-    def initialize(base_path)
+    def initialize(base_path, base_opts={})
       @base_path = base_path
+      @base_opts = base_opts
     end
 
-    def get(relative_path)
-      file_path = File.join(base_path, relative_path)
-      Content.new(file_path)
+    def get(relative_path, opts={})
+      file_path    = File.join(base_path, relative_path)
+      content_opts = base_opts.merge(opts)
+      Content.new(file_path, content_opts)
     end
 
     private
 
-    attr_reader :base_path
+    attr_reader :base_path, :base_opts
   end
 end

data/lib/rendering_engine/version.rb

@@ -1,3 +1,3 @@
 module RenderingEngine
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/rendering_engine.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["pniemczyk@o2.pl"]
   spec.description   = %q{ Rendering engine based on ERB }
   spec.summary       = %q{ Rendering engine based on ERB }
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/pniemczyk/rendering_engine"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/rendering_engine/content_helpers_spec.rb

@@ -6,11 +6,12 @@ describe RenderingEngine::ContentHelpers do
   let(:file_path)          { File.join(base_path, file_relative_path) }
   let(:content)            { double('content_object', source: source) }
   let(:source)             { 'file_source' }
-  subject { described_class.new(base_path: base_path) }
+  let(:content_data)       {{ name: 'pawel' }}
+  subject { described_class.new(base_path: base_path, data: content_data) }
 
   it '#render' do
     RenderingEngine::Content.should_receive(:new)
-      .with(file_path)
+      .with(file_path, data: content_data)
       .and_return(content)
 
     subject.render(file_relative_path).should eq source

data/spec/rendering_engine/content_spec.rb

@@ -6,9 +6,17 @@ describe RenderingEngine::Content do
   let(:relative_path) { 'login/form.html' }
   let(:file_path)     { File.join(base_path, relative_path) }
   let(:content)       { double('ContentObject') }
+  let(:content_data)  { nil }
+  let(:custom_helper) { nil }
+  let(:opts) do
+    {
+      base_folder_path: test_base_path,
+      data: content_data,
+      custom_helper: custom_helper
+    }
+  end
 
-
-  subject { described_class.new(file_path, test_base_path) }
+  subject { described_class.new(file_path, opts) }
 
   context '#source' do
 
@@ -48,7 +56,7 @@ describe RenderingEngine::Content do
         let(:base_folder_path) { 'root/contract/files/login' }
         before do
           ERB.should_receive(:new).with(source).and_return(erb_instance)
-          subject.should_receive(:helpers).with(base_folder_path)
+          subject.should_receive(:helper).with(base_folder_path, content_data)
             .and_return(double)
           erb_instance.should_receive(:result).with(an_instance_of(Binding))
             .and_return(rendered_source)

data/spec/rendering_engine/provider_spec.rb

@@ -5,12 +5,15 @@ describe RenderingEngine::Provider do
   let(:relative_path) { 'login/form.html' }
   let(:file_path)     { File.join(base_path, relative_path) }
   let(:content)       { double('ContentObject') }
+  let(:data)          { double('data') }
+  let(:custom_helper) { double('custom_helper') }
+  let(:opts)          {{ data: data, custom_helper: custom_helper }}
   subject { described_class.new(base_path) }
 
   it '#get' do
     RenderingEngine::Content.should_receive(:new)
-      .with(file_path)
+      .with(file_path, opts)
       .and_return(content)
-    subject.get(relative_path).should be content
+    subject.get(relative_path, opts).should be content
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rendering_engine
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Paweł Niemczyk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ files:
 - spec/rendering_engine/content_spec.rb
 - spec/rendering_engine/provider_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/pniemczyk/rendering_engine
 licenses:
 - MIT
 metadata: {}