rendering_engine 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmUyYzQxMDAzNDJhNmRhYjQ5YTllM2E1YTZjZmUwMzdjNTA3ZjBmOQ==
+  data.tar.gz: !binary |-
+    ZDBjZTcxM2UyNWFiYjI4OWQ2YzhlNTM1YzE3NmZlYTkzNzM0MmVmOQ==
+SHA512:
+  metadata.gz: !binary |-
+    YjcwYTc1ZTY5YjBlNDdkYWQ3YTViNzhmYjM4ZDQ5MDk2MDM2MWUwYTBlZjIx
+    NzY1NTYyOGE1YzE0YzRmMTM0YTkzYTc4ZDdkYWRkOWU3OTZiYTdlZjZjNzE3
+    ODlhNzJmMjZjM2ZjNjNiNjUzYWJiNmI3MzMzYTAwZWRhYmQxY2Q=
+  data.tar.gz: !binary |-
+    YjUxNjA4YjY4OTgzODhhODBlZjdmY2U3MTM3ZDk0NmE0NDQ1YWZlNDc5Mjgz
+    MDVkNDM1ZDBjYmE4ZDFjYjlkNjEwOTlmNDZlYjYxZTFjNTMyMzAxM2FhYTZk
+    NTEwNmRkYTU1MWUxMWFkZWZmMjMzYTM5NWY3ZTJlMDIxZWE4YzI=

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Paweł Niemczyk
+
+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,29 @@
+# RenderingEngine
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rendering_engine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rendering_engine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/rendering_engine.rb

@@ -0,0 +1,8 @@
+require "rendering_engine/version"
+require "rendering_engine/content_helpers"
+require "rendering_engine/content"
+require "rendering_engine/provider"
+
+module RenderingEngine
+
+end

data/lib/rendering_engine/content.rb

@@ -0,0 +1,68 @@
+require 'erb'
+
+module RenderingEngine
+  class Content
+    attr_reader :file_path
+
+    def initialize(file_path, base_folder_path=nil)
+      @file_path        = file_path
+      @base_folder_path = base_folder_path
+    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 })
+        else ''
+        end
+      )
+    end
+
+    def kind
+      @kind ||= (
+        if orginal_file_present?
+          :orginal
+        elsif file_as_erb_present?
+          :template
+        else
+          :unknown
+        end
+      )
+    end
+
+    def template?
+      kind == :template
+    end
+
+    def orginal?
+      kind == :orginal
+    end
+
+    def unknown?
+      kind == :unknown
+    end
+
+    def base_folder_path
+      @base_folder_path ||= File.dirname(file_path)
+    end
+
+    private
+
+    def helpers(path)
+      ContentHelpers.new(base_path: path)
+    end
+
+    def orginal_file_present?
+      File.exist?(file_path)
+    end
+
+    def file_as_erb_present?
+      File.exist?(file_path_as_erb)
+    end
+
+    def file_path_as_erb
+      @file_as_erb ||= "#{file_path}.erb"
+    end
+  end
+end

data/lib/rendering_engine/content_helpers.rb

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

data/lib/rendering_engine/provider.rb

@@ -0,0 +1,16 @@
+module RenderingEngine
+  class Provider
+    def initialize(base_path)
+      @base_path = base_path
+    end
+
+    def get(relative_path)
+      file_path = File.join(base_path, relative_path)
+      Content.new(file_path)
+    end
+
+    private
+
+    attr_reader :base_path
+  end
+end

data/lib/rendering_engine/version.rb

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

data/rendering_engine.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rendering_engine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rendering_engine"
+  spec.version       = RenderingEngine::VERSION
+  spec.authors       = ["Paweł Niemczyk"]
+  spec.email         = ["pniemczyk@o2.pl"]
+  spec.description   = %q{ Rendering engine based on ERB }
+  spec.summary       = %q{ Rendering engine based on ERB }
+  spec.homepage      = ""
+  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"
+end

data/spec/rendering_engine/content_helpers_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe RenderingEngine::ContentHelpers do
+  let(:base_path)          { 'root/path' }
+  let(:file_relative_path) { 'login.haml' }
+  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) }
+
+  it '#render' do
+    RenderingEngine::Content.should_receive(:new)
+      .with(file_path)
+      .and_return(content)
+
+    subject.render(file_relative_path).should eq source
+  end
+end

data/spec/rendering_engine/content_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+describe RenderingEngine::Content do
+  let(:test_base_path){ nil }
+  let(:base_path)     { 'root/contract/files' }
+  let(:relative_path) { 'login/form.html' }
+  let(:file_path)     { File.join(base_path, relative_path) }
+  let(:content)       { double('ContentObject') }
+
+
+  subject { described_class.new(file_path, test_base_path) }
+
+  context '#source' do
+
+    before(:each) { subject.should_receive(:kind).and_return(kind) }
+
+    context 'when file is not found' do
+      let(:kind) { :unknown }
+
+      it 'returns empty string' do
+        subject.source.should eq ''
+      end
+    end
+
+    context 'when orginal file is found' do
+      let(:kind)   { :orginal }
+      let(:source) { 'file_source' }
+      before { File.should_receive(:read).with(file_path).and_return(source) }
+
+      it 'returns source of file' do
+        subject.source.should eq source
+      end
+    end
+
+    context 'when orginal file is not found but template file is found' do
+      let(:kind)            { :template }
+      let(:source)          { 'calc 1+1=<%= 1+1 %>' }
+      let(:rendered_source) { 'calc 1+1=2' }
+      let(:erb_file_path)   { "#{file_path}.erb" }
+      before { File.should_receive(:read).with(erb_file_path).and_return(source) }
+
+      it 'returns rendered source' do
+        subject.source.should eq rendered_source
+      end
+
+      context 'erb result' do
+        let(:erb_instance)     { double('erb_instance') }
+        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)
+            .and_return(double)
+          erb_instance.should_receive(:result).with(an_instance_of(Binding))
+            .and_return(rendered_source)
+        end
+        it 'receives helper' do
+          subject.source.should eq rendered_source
+        end
+      end
+    end
+  end
+
+  context '#kind' do
+    context 'when orginal_file_present' do
+      before { subject.should_receive(:orginal_file_present?).and_return(true) }
+      it 'returns :orginal' do
+        subject.kind.should eq :orginal
+      end
+    end
+
+    context 'when orginal_file_present is missing but template file is present' do
+
+      before do
+        subject.should_receive(:orginal_file_present?).and_return(false)
+        subject.should_receive(:file_as_erb_present?).and_return(true)
+      end
+
+      it 'returns :template' do
+        subject.kind.should eq :template
+      end
+    end
+
+    context 'when orginal and template file is missing' do
+
+      before do
+        subject.should_receive(:orginal_file_present?).and_return(false)
+        subject.should_receive(:file_as_erb_present?).and_return(false)
+      end
+
+      it 'returns :unknown' do
+        subject.kind.should eq :unknown
+      end
+    end
+  end
+
+  %w{template orginal unknown}.each do |method_name|
+    it "##{method_name}? returns true when content kind is :#{method_name}" do
+      subject.should_receive(:kind).and_return(method_name.to_sym)
+      subject.public_send("#{method_name}?").should be_true
+    end
+
+    it "##{method_name}? returns false when content kind is not :#{method_name}" do
+      subject.should_receive(:kind).and_return(:bad)
+      subject.public_send("#{method_name}?").should be_false
+    end
+  end
+
+  it '#base_folder_path' do
+    subject.should_receive(:file_path).and_return(relative_path)
+    subject.base_folder_path.should eq 'login'
+  end
+end
+
+

data/spec/rendering_engine/provider_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe RenderingEngine::Provider do
+  let(:base_path)     { 'root/contract/files' }
+  let(:relative_path) { 'login/form.html' }
+  let(:file_path)     { File.join(base_path, relative_path) }
+  let(:content)       { double('ContentObject') }
+  subject { described_class.new(base_path) }
+
+  it '#get' do
+    RenderingEngine::Content.should_receive(:new)
+      .with(file_path)
+      .and_return(content)
+    subject.get(relative_path).should be content
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/rendering_engine')
+require 'rspec'
+require 'ostruct'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rendering_engine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paweł Niemczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Rendering engine based on ERB '
+email:
+- pniemczyk@o2.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rendering_engine.rb
+- lib/rendering_engine/content.rb
+- lib/rendering_engine/content_helpers.rb
+- lib/rendering_engine/provider.rb
+- lib/rendering_engine/version.rb
+- rendering_engine.gemspec
+- spec/rendering_engine/content_helpers_spec.rb
+- spec/rendering_engine/content_spec.rb
+- spec/rendering_engine/provider_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Rendering engine based on ERB
+test_files:
+- spec/rendering_engine/content_helpers_spec.rb
+- spec/rendering_engine/content_spec.rb
+- spec/rendering_engine/provider_spec.rb
+- spec/spec_helper.rb