tree_renderer 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e34039c1c00ce4efc838289475304d270b0f0cd0
-  data.tar.gz: 63de550492c09c8e55f1407970e831283ecb55a3
+  metadata.gz: 6ea7e5b91a3de304e661c781218454b4ff0236d1
+  data.tar.gz: 5ba67680fe3eba6feedaf932216de714e8ac9c26
 SHA512:
-  metadata.gz: fb4be0010ee08383f2ff8ad20a329d740e08fd355b20d06a96d2b9dc273fd1b2d009dcc6a0217afe3694b158210d3d4f6310bff867e0449757d5a211a050bc85
-  data.tar.gz: 10835489bc2d9ed4216660a8f2859aa60208b80c6162540b2de5c71acfd7b0862a1f8e90e69f3306b3888c61a81badfbdc1736b45b4667d1455666bf1e12f351
+  metadata.gz: 79eea88a815f4a75692009375ea89bdae49f1fb741e3af82f86c14fad188479ad2f2da1da477c715b4b7da7739613bb8209a96f33257f78db7c34d5daf1a988c
+  data.tar.gz: a9d97c0e7600c7d89d61e2f0ecb0133cc692f43f6fce32bad8405fa8ed1bebc36fe5687356301eef5180d9ed920dac613e11d60aa4d80fca7207885f247ca03c

data/.gitignore

@@ -1,3 +1,5 @@
 Gemfile.lock
 coverage
 *.gem
+.yardoc
+doc

data/.travis.yml

@@ -9,7 +9,7 @@ rvm:
   - ruby-2.0.0
   - ruby-2.1
   - ruby-2.2
-  - ruby-2.3
+  - ruby-2.3.0
 matrix:
   fast_finish: true
   allow_failures:

data/Gemfile

@@ -8,9 +8,22 @@ 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"
+  # statistics only on MRI 2.3 - avoid problems on older rubies
+  if RUBY_VERSION == "2.3.0"
+    gem "redcarpet"
+  end
+
+  # lower required versions for old ruby
+  if RUBY_VERSION == "1.8.7"
+    gem "mime-types",  "<2.0.0"
+    gem "rest-client", "<1.7.0"
+    #gem "listen",      "<2.0.0"
+  end
+
+  # do not install guard in CI (save time and avoid endless gem resolution)
+  if ENV["CI"] != "true" && RUBY_VERSION != "1.8.7"
+    gem "guard",              "~> 2.0"
+    gem "guard-minitest",     "~> 2.0"
+  end
+end

data/Rakefile

@@ -0,0 +1,29 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+default_tasks = []
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ["lib/**/*.rb"]
+    t.stats_options = ["--list-undoc", "--compact"]
+  end
+
+  task :docs    => [:yard]
+  default_tasks << :yard
+rescue LoadError
+end
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.libs.push("test")
+  t.pattern = "test/**/*_test.rb"
+end
+default_tasks << :test
+
+task :default => default_tasks

data/lib/tree_renderer.rb

@@ -8,21 +8,44 @@ require "date"
 require "erb"
 require "fileutils"
 
+# Render a tree of files using ERB
+#
+# example:
+#
+#     TreeRenderer.new("/template/path", "/target/path", variables).save
+#
 class TreeRenderer
-  attr_reader :template_path, :target_path, :var_binding
+  # @return [String] the path to the template directory to be rendered
+  attr_reader :template_path
+  # @return [String] the target path where to render the template
+  attr_reader :target_path
+  # @return [Binding] binding for the variables to use for rendering
+  attr_reader :var_binding
 
+  # Initialize the paths and variables for rendering
+  #
+  # @param template_path [String] the path to the template directory to be rendered
+  # @param target_path   [String] the target path where to render the template
+  # @param variables     [Hash, Object, Binding] the variables to use for rendering
+  #
   def initialize(template_path, target_path, variables = {})
     @template_path = template_path
     @target_path   = target_path
     @var_binding   = calculate_binding(variables)
   end
 
+  # Run the rendering process
   def save
     all_files.each{ |file| parse_and_save(file) }
   end
 
 private
 
+  # Take the initialize variables thing and transforms it to Binding
+  #
+  # @param variables [Hash, Object, Binding] the variables to use for rendering
+  # @return          [Binding]               binding for the input variables
+  #
   def calculate_binding(variables)
     case variables
     when Hash
@@ -35,30 +58,61 @@ private
     end
   end
 
+  # get list of files in the `template_path`
+  #
+  # @return [Array<String>] list of files in the `template_path` dir
+  #
   def all_files
     Dir.glob("#{template_path}/**/*", File::FNM_DOTMATCH).reject{|path| File.directory?(path) }.sort
   end
 
+  # read `file` from `template_path`, render it, amd save it in `target_path`
+  #
+  # @param file [String] path to file to render
+  #
   def parse_and_save(file)
     save_file(
       transform_path(file),
-      parse_template(file),
+      parse_template(file)
     )
   end
 
+  # write `content` to the given `path`, it will create required directories
+  #
+  # @param path    [String] the path of file to save to
+  # @param content [String] the content to save
+  #
   def save_file(path, content)
     FileUtils.mkdir_p(File.expand_path("..", path))
-    File.write(path, content, 0, mode: "w")
+    File.open(path, "w") do |f|
+      f.write(content)
+    end
   end
 
+  # translates path to `file` from `template_path` to `target_path`
+  # it will also render it to replace file names if needed
+  #
+  # @param file [String] the file name to transform from  `template_path`
+  # @return     [String] translated file in `target_path`
+  #
   def transform_path(file)
     render(file.sub(template_path, target_path))
   end
 
+  # read and render template from `path`
+  #
+  # @param path [String] path to file to read
+  # @return     [String] rendered content of the file
+  #
   def parse_template(path)
     render(File.read(path))
   end
 
+  # render given content
+  #
+  # @param content [String] the content to render
+  # @return        [String] the rendered content
+  #
   def render(content)
     ERB.new(content).result(var_binding)
   end

data/lib/tree_renderer/version.rb

@@ -1,3 +1,4 @@
 class TreeRenderer
-  VERSION = "1.0.1"
+  # Version of the gem
+  VERSION = "1.1.0"
 end

data/test/minitest_helper.rb

@@ -23,7 +23,7 @@ then
 end
 
 require "minitest/autorun"
-require "minitest/reporters"
+require "minitest/reporters" if RUBY_VERSION != "1.8.7"
 require "tmpdir"
 require "pathname"
 require "fileutils"
@@ -32,4 +32,4 @@ 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!
+Minitest::Reporters.use!  if RUBY_VERSION != "1.8.7"

data/test/tree_renderer_test.rb

@@ -14,17 +14,17 @@ describe TreeRenderer do
 
   describe "#new" do
     it "sets binding directly" do
-      example = OpenStruct.new(a: 1).instance_eval { binding }
+      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)
+      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}
+      example = {:a => 1}
       subject.new("path1", "path2", example).var_binding.must_be_instance_of(Binding)
     end
   end
@@ -34,7 +34,7 @@ describe TreeRenderer 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
+      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
@@ -83,7 +83,7 @@ CONTENT
   describe "#transform_path" do
     it "transforms paths with erb" do
       subject.new(
-        "/path1/bin", "/path2/lib", name: "file"
+        "/path1/bin", "/path2/lib", :name => "file"
       ).send(
         :transform_path, "/path1/bin/some/path/<%= name %>.txt"
       ).must_equal(
@@ -95,11 +95,12 @@ CONTENT
   describe "#parse_template" do
     it "loads a file" do
       subject.new(
-        "/path1/bin", "/path2/lib", name: "file"
+        "/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 of the gem
   VERSION = "#{TreeRenderer::VERSION}"
 end
 VERSION_FILE
@@ -119,7 +120,7 @@ VERSION_FILE
 
     it "render text with erb" do
       subject.new(
-        "/path1/bin", "/path2/lib", name: "dolor"
+        "/path1/bin", "/path2/lib", :name => "dolor"
       ).send(
         :render, "Lorem ipsum <%= name %>"
       ).must_equal(

data/tree_renderer.gemspec

@@ -10,17 +10,18 @@ Gem::Specification.new do |s|
   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.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"
+  if RUBY_VERSION == "2.3.0"
+    s.add_development_dependency "simplecov",          "~> 0.11"
+    s.add_development_dependency "coveralls",          "~> 0.8"
+  end
+  s.add_development_dependency "yard",               "~> 0.8"
   # s.add_development_dependency("smf-gem")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tree_renderer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Michal Papis
@@ -24,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -81,21 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: coveralls
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -120,6 +78,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - example_template/README.md
 - example_template/lib/<%= name %>.rb
 - lib/tree_renderer.rb
@@ -129,7 +88,7 @@ files:
 - tree_renderer.gemspec
 homepage: https://github.com/mpapis/tree_renderer
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -147,10 +106,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Render tree of ERB templates
 test_files:
 - test/minitest_helper.rb
 - test/tree_renderer_test.rb
+has_rdoc: