tree_renderer 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc6785fc4ea7811924ce0977258b93cc628f69e3
-  data.tar.gz: 994f9a510e223d12485179181d53c65882171d1e
+  metadata.gz: e34039c1c00ce4efc838289475304d270b0f0cd0
+  data.tar.gz: 63de550492c09c8e55f1407970e831283ecb55a3
 SHA512:
-  metadata.gz: 63d5e9c8e3a7bad6258b62d6eabc58ec58511882f780f03ba78495864b97417470da88a3dc5cfdd235a8cc70a4e454c79008ad6557ee0b1669251a8b23e8949a
-  data.tar.gz: 34a649320d4111f3901528ac6dc355048cdf788401432b539cb3a6156a7895fe4768d87bce5fb041dbe271bf9d7f53ec8266f89dcc7c4b84d571eb7c2f71f921
+  metadata.gz: fb4be0010ee08383f2ff8ad20a329d740e08fd355b20d06a96d2b9dc273fd1b2d009dcc6a0217afe3694b158210d3d4f6310bff867e0449757d5a211a050bc85
+  data.tar.gz: 10835489bc2d9ed4216660a8f2859aa60208b80c6162540b2de5c71acfd7b0862a1f8e90e69f3306b3888c61a81badfbdc1736b45b4667d1455666bf1e12f351

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+coverage
+*.gem

data/.travis.yml

@@ -0,0 +1,16 @@
+bundler_args: ""
+before_install:
+  - "gpg --keyserver hkp://keys.gnupg.net --recv-keys D39DC0E3"
+language: ruby
+rvm:
+  - jruby
+  - ruby-1.8.7
+  - ruby-1.9.3
+  - ruby-2.0.0
+  - ruby-2.1
+  - ruby-2.2
+  - ruby-2.3
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: jruby

data/Gemfile

@@ -0,0 +1,16 @@
+=begin
+Copyright 2016 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+source "https://rubygems.org"
+
+gemspec
+
+# statistics only on MRI 2.3 - avoid problems on older rubies
+group :development do
+  gem "redcarpet"
+  gem "simplecov"
+  gem "coveralls"
+end if RUBY_VERSION == "2.3.0"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2016 Michal Papis
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,28 @@
+[![Gem Version](https://badge.fury.io/rb/tree_renderer.png)](https://rubygems.org/gems/tree_renderer)
+[![Build Status](https://secure.travis-ci.org/mpapis/tree_renderer.png?branch=master)](https://travis-ci.org/mpapis/tree_renderer)
+[![Dependency Status](https://gemnasium.com/mpapis/tree_renderer.png)](https://gemnasium.com/mpapis/tree_renderer)
+[![Code Climate](https://codeclimate.com/github/mpapis/tree_renderer.png)](https://codeclimate.com/github/mpapis/tree_renderer)
+[![Coverage Status](https://img.shields.io/coveralls/mpapis/tree_renderer.svg)](https://coveralls.io/r/mpapis/tree_renderer?branch=master)
+[![Inline docs](http://inch-ci.org/github/mpapis/tree_renderer.png)](http://inch-ci.org/github/mpapis/tree_renderer)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/mpapis/tree_renderer/master/frames)
+[![Github Code](http://img.shields.io/badge/github-code-blue.svg)](https://github.com/mpapis/tree_renderer)
+
+# Tree Renderer
+
+Render set of templates, also renders the path names.
+
+### Installation
+
+    gem install tree_renderer
+
+or add to `Gemfile`:
+
+    gem "tree_renderer"
+
+and `gem install --file`
+
+### Usage
+
+    TreeRenderer.new("/template/path", "/target/path", variables).save
+
+`variables` can be either a hash, object or a binding.

data/example_template/README.md

@@ -0,0 +1,3 @@
+# <%= name %>
+
+<%= description %>

data/example_template/lib/<%= name %>.rb

@@ -0,0 +1,3 @@
+# <%= description %>
+class <%= name.capitalize %>
+end

data/lib/tree_renderer/version.rb

@@ -0,0 +1,3 @@
+class TreeRenderer
+  VERSION = "1.0.1"
+end

data/lib/tree_renderer.rb

@@ -0,0 +1,65 @@
+=begin
+Copyright 2016 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require "date"
+require "erb"
+require "fileutils"
+
+class TreeRenderer
+  attr_reader :template_path, :target_path, :var_binding
+
+  def initialize(template_path, target_path, variables = {})
+    @template_path = template_path
+    @target_path   = target_path
+    @var_binding   = calculate_binding(variables)
+  end
+
+  def save
+    all_files.each{ |file| parse_and_save(file) }
+  end
+
+private
+
+  def calculate_binding(variables)
+    case variables
+    when Hash
+      require "ostruct"
+      OpenStruct.new(variables).instance_eval { binding }
+    when Binding
+      variables
+    else
+      variables.instance_eval { binding }
+    end
+  end
+
+  def all_files
+    Dir.glob("#{template_path}/**/*", File::FNM_DOTMATCH).reject{|path| File.directory?(path) }.sort
+  end
+
+  def parse_and_save(file)
+    save_file(
+      transform_path(file),
+      parse_template(file),
+    )
+  end
+
+  def save_file(path, content)
+    FileUtils.mkdir_p(File.expand_path("..", path))
+    File.write(path, content, 0, mode: "w")
+  end
+
+  def transform_path(file)
+    render(file.sub(template_path, target_path))
+  end
+
+  def parse_template(path)
+    render(File.read(path))
+  end
+
+  def render(content)
+    ERB.new(content).result(var_binding)
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,35 @@
+=begin
+Copyright 2016 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+if
+  RUBY_VERSION == "2.3.0" # check Gemfile
+then
+  require "coveralls"
+  require "simplecov"
+
+  SimpleCov.start do
+    formatter SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter,
+    ]
+    command_name "Spesc Tests"
+    add_filter "/test/"
+  end
+
+  Coveralls.noisy = true unless ENV['CI']
+end
+
+require "minitest/autorun"
+require "minitest/reporters"
+require "tmpdir"
+require "pathname"
+require "fileutils"
+
+TREE_RENDERER_TMP_DIR = Pathname(Dir.tmpdir).join("tree_renderer")
+
+Dir['lib/**/*.rb'].each { |file| require "./#{file}" } # coverals trick for all files
+
+Minitest::Reporters.use!

data/test/tree_renderer_test.rb

@@ -0,0 +1,140 @@
+=begin
+Copyright 2016 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+require "minitest_helper"
+require "tree_renderer"
+require "tree_renderer/version"
+require "ostruct"
+
+describe TreeRenderer do
+  subject { TreeRenderer }
+
+  describe "#new" do
+    it "sets binding directly" do
+      example = OpenStruct.new(a: 1).instance_eval { binding }
+      subject.new("path1", "path2", example).var_binding.must_equal(example)
+    end
+
+    it "sets binding from object" do
+      example = OpenStruct.new(a: 1)
+      subject.new("path1", "path2", example).var_binding.must_be_instance_of(Binding)
+    end
+
+    it "sets binding from hash" do
+      example = {a: 1}
+      subject.new("path1", "path2", example).var_binding.must_be_instance_of(Binding)
+    end
+  end
+
+  describe "#save" do
+    after do
+      FileUtils.rm_rf(TREE_RENDERER_TMP_DIR)
+    end
+    it "saves a file" do
+      subject.new(File.expand_path("../../example_template", __FILE__), TREE_RENDERER_TMP_DIR.to_s, name: "example", description: "Example project template").save
+      Dir.chdir TREE_RENDERER_TMP_DIR do
+        Dir.glob("**/*").must_equal(%w[
+         README.md
+         lib
+         lib/example.rb
+        ])
+        File.read("README.md").must_equal(<<-CONTENT)
+# example
+
+Example project template
+CONTENT
+        File.read("lib/example.rb").must_equal(<<-CONTENT)
+# Example project template
+class Example
+end
+CONTENT
+      end
+    end
+  end
+
+  describe "#all_files" do
+    it "lists all files in lib" do
+      lib = File.expand_path("../../lib", __FILE__)
+      subject.new(lib, "path2").send(:all_files).must_equal([
+        "#{lib}/tree_renderer.rb",
+        "#{lib}/tree_renderer/version.rb",
+      ])
+    end
+  end
+
+  describe "#save_file" do
+    before do
+      FileUtils.mkdir_p(TREE_RENDERER_TMP_DIR)
+    end
+    after do
+      FileUtils.rm_rf(TREE_RENDERER_TMP_DIR)
+    end
+    it "saves a file" do
+      test_path = TREE_RENDERER_TMP_DIR.join("save_file.txt")
+      content   = "test\nme\n"
+      subject.new("path1", "path2").send(:save_file, test_path, content)
+      File.read(test_path).must_equal(content)
+    end
+  end
+
+  describe "#transform_path" do
+    it "transforms paths with erb" do
+      subject.new(
+        "/path1/bin", "/path2/lib", name: "file"
+      ).send(
+        :transform_path, "/path1/bin/some/path/<%= name %>.txt"
+      ).must_equal(
+        "/path2/lib/some/path/file.txt"
+      )
+    end
+  end
+
+  describe "#parse_template" do
+    it "loads a file" do
+      subject.new(
+        "/path1/bin", "/path2/lib", name: "file"
+      ).send(
+        :parse_template, File.expand_path("../../lib/tree_renderer/version.rb", __FILE__)
+      ).must_equal(<<-VERSION_FILE)
+class TreeRenderer
+  VERSION = "#{TreeRenderer::VERSION}"
+end
+VERSION_FILE
+    end
+  end
+
+  describe "#render" do
+    it "render plain text" do
+      subject.new(
+        "/path1/bin", "/path2/lib"
+      ).send(
+        :render, "Lorem ipsum"
+      ).must_equal(
+        "Lorem ipsum"
+      )
+    end
+
+    it "render text with erb" do
+      subject.new(
+        "/path1/bin", "/path2/lib", name: "dolor"
+      ).send(
+        :render, "Lorem ipsum <%= name %>"
+      ).must_equal(
+        "Lorem ipsum dolor"
+      )
+    end
+
+    it "raises exceptions on missing variables" do
+      proc {
+        subject.new(
+          "/path1/bin", "/path2/lib", nil
+        ).send(
+          :render, "Lorem ipsum <%= name %>"
+        )
+      }.must_raise NameError
+    end
+  end
+end

data/tree_renderer.gemspec

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/tree_renderer/version.rb", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "tree_renderer"
+  s.version = TreeRenderer::VERSION
+  s.authors = ["Michal Papis"]
+  s.email = ["mpapis@gmail.com"]
+  s.homepage = "https://github.com/mpapis/tree_renderer"
+  s.summary = "Render tree of ERB templates"
+  s.license = "Apache 2.0"
+  s.files = `git ls-files -z`.split("\0")
+  s.test_files = `git ls-files -z -- {test,spec,features}/*`.split("\0")
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.add_development_dependency "rake",               "~> 10.0"
+  s.add_development_dependency "guard",              "~> 2.0"
+  s.add_development_dependency "guard-minitest",     "~> 2.0"
+  s.add_development_dependency "minitest",           "~> 4.0"
+  s.add_development_dependency "minitest-reporters", "~> 0"
+  s.add_development_dependency "simplecov",          "~> 0.11"
+  s.add_development_dependency "coveralls",          "~> 0.8"
+  # s.add_development_dependency("smf-gem")
+end

metadata

@@ -1,106 +1,132 @@
 --- !ruby/object:Gem::Specification
 name: tree_renderer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: minitest-reporters
   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: guard-minitest
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: 
 email:
 - mpapis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- example_template/README.md
+- example_template/lib/<%= name %>.rb
+- lib/tree_renderer.rb
+- lib/tree_renderer/version.rb
+- test/minitest_helper.rb
+- test/tree_renderer_test.rb
+- tree_renderer.gemspec
 homepage: https://github.com/mpapis/tree_renderer
 licenses:
 - Apache 2.0
@@ -121,9 +147,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Render tree of ERB templates
-test_files: []
-has_rdoc: 
+test_files:
+- test/minitest_helper.rb
+- test/tree_renderer_test.rb