marcosgz-cap-template 0.0.3

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

@@ -0,0 +1 @@
+rvm use ruby-1.8.7-p249@capistrano-template --create

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+notifications:
+  email: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tony Pitluga
+
+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,64 @@
+# Capistrano::Template
+
+A [capistrano](http://capistranorb.com/) plugin that aids in rendering templates.
+
+
+## NOTE
+Forked from [capistrano-template](https://github.com/pitluga/capistrano-template)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-template'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-template
+
+## Usage
+
+Best explained with an example deploy.rb file.
+
+```ruby
+require 'capistrano/template'
+
+set :application, "example"
+# ...
+
+task :configure_apache, :roles => :web do
+  put(template.render('vhost.conf'), "/etc/apache2/sites-available/#{application}.conf")
+end
+```
+
+## Supported Functions
+
+All supported functions live under the ```template``` namespace.
+
+### render(template_name)
+
+ERBs the given template and returns the result.
+
+## Configuration Variables
+
+### template_path
+
+The location to search for templates. Relative to the current working directory of the cap command. Defaults to ```config/deploy/templates```.
+
+
+### template_bindings
+
+An array of bindings that represent the search path for variables when rendering templates. An extension point to allow external sources for data. Defaults to ```[Bindings::CapistranoBinding.new(self)]```
+
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/examples/templates/goodbye_world.erb

@@ -0,0 +1 @@
+Goodbye <%= name %>

data/examples/templates/hello_world.erb

@@ -0,0 +1 @@
+Hello <%= name %>

data/examples/vanilla.rb

@@ -0,0 +1,13 @@
+# run with cap -f vanilla.rb
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'capistrano'
+require 'capistrano/template'
+
+set :template_path, 'templates'
+set :name, 'world'
+
+
+desc "place a rendered template in /tmp/hello_world"
+task :test_render, :roles => :app do
+  puts template.render('hello_world.erb')
+end

data/lib/capistrano/template/bindings/capistrano_binding.rb

@@ -0,0 +1,20 @@
+module Capistrano
+  module Template
+    module Bindings
+      class CapistranoBinding
+        def initialize(capistrano)
+          @capistrano = capistrano
+        end
+
+        def exists?(variable)
+          @capistrano.exists?(variable)
+        end
+
+        def fetch(variable)
+          @capistrano.fetch(variable)
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/template/bindings/chain.rb

@@ -0,0 +1,21 @@
+module Capistrano
+  module Template
+    module Bindings
+      class Chain
+
+        instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$|^binding$|^instance_eval$)/ }
+
+        def initialize(*bindings)
+          @bindings = bindings
+        end
+
+        def method_missing(name, *args, &block)
+          found_binding = @bindings.detect { |b| b.exists?(name) }
+          super if found_binding.nil?
+          found_binding.fetch(name)
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/template/bindings/hash_binding.rb

@@ -0,0 +1,21 @@
+module Capistrano
+  module Template
+    module Bindings
+      class HashBinding
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        def exists?(variable)
+          @hash.has_key?(variable)
+        end
+
+        def fetch(variable)
+          @hash.fetch(variable)
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/template/plugin.rb

@@ -0,0 +1,25 @@
+module Capistrano
+  module Template
+    module Plugin
+      def render(template)
+        content = File.read(File.join(template_path, template))
+        ERB.new(content).result(chain.instance_eval { binding })
+      end
+
+      def template_bindings
+        case self[:template_bindings].class.name
+        when 'Hash'
+          [Bindings::HashBinding.new(fetch(:template_bindings))]
+        else
+          [Bindings::CapistranoBinding.new(self)]
+        end
+      end
+
+      private
+
+      def chain
+        @__template_chain ||= Bindings::Chain.new(*template_bindings)
+      end
+    end
+  end
+end

data/lib/capistrano/template/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Template
+    VERSION = "0.0.3"
+  end
+end

data/lib/capistrano/template.rb

@@ -0,0 +1,9 @@
+require 'erb'
+require 'capistrano'
+require 'capistrano/template/plugin'
+require 'capistrano/template/version'
+require 'capistrano/template/bindings/capistrano_binding'
+require 'capistrano/template/bindings/chain'
+require 'capistrano/template/bindings/hash_binding'
+
+Capistrano.plugin(:template, Capistrano::Template::Plugin)

data/marcosgz-cap-template.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/template/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "marcosgz-cap-template"
+  gem.version       = Capistrano::Template::VERSION
+  gem.authors       = ["Marcos G. Zimmermann", "Tony Pitluga"]
+  gem.email         = ["mgzmaster@gmail.com", "tony.pitluga@gmail.com"]
+  gem.summary       = %q{Capistrano Templates}
+  gem.homepage      = "https://github.com/marcosgz/capistrano-template"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "capistrano", "> 2.0.0"
+
+  gem.add_development_dependency "rake"
+end

data/test/capistrano/template/bindings/capistrano_binding_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+module Capistrano
+  module Template
+    module Bindings
+      class CapistranoBindingTest < Test::Unit::TestCase
+
+        def setup
+          @config = Capistrano::Configuration.new
+        end
+
+        def test_defined_returns_false_when_variable_is_not_available
+          script_binding = CapistranoBinding.new(@config)
+          assert_equal(false, script_binding.exists?(:var))
+        end
+
+        def test_defined_returns_true_when_variable_is_available
+          @config.set(:var, 'foo')
+          script_binding = CapistranoBinding.new(@config)
+          assert_equal(true, script_binding.exists?(:var))
+        end
+
+        def test_fetch_returns_the_value_of_the_variable
+          @config.set(:var, 'foo')
+          script_binding = CapistranoBinding.new(@config)
+          assert_equal('foo', script_binding.fetch(:var))
+        end
+
+      end
+    end
+  end
+end

data/test/capistrano/template/bindings/chain_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+module Capistrano
+  module Template
+    module Bindings
+      class ChainTest < Test::Unit::TestCase
+
+        def test_method_missing_searches_bindings
+          chain = Chain.new(HashBinding.new(:foo => 'bar'))
+          assert_equal('bar', chain.foo)
+        end
+
+        def test_method_missing_raises_not_found_exception
+          chain = Chain.new(HashBinding.new(:foo => 'bar'))
+          exception = assert_raise(NoMethodError) { chain.baz }
+          assert_match /baz/, exception.message
+        end
+
+        def test_chains_public_methods_are_undefined
+          chain = Chain.new(HashBinding.new(:foo => 'bar'))
+          assert_raises(NoMethodError) { chain.clone }
+          assert_raises(NoMethodError) { chain.to_s }
+          assert_raises(NoMethodError) { chain.inspect }
+        end
+      end
+    end
+  end
+end

data/test/capistrano/template/bindings/hash_binding_test.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+module Capistrano
+  module Template
+    module Bindings
+      class HashBindingTest < Test::Unit::TestCase
+
+        def test_defined_returns_false_when_variable_is_not_available
+          hash_binding = HashBinding.new({})
+          assert_equal(false, hash_binding.exists?(:var))
+        end
+
+        def test_defined_returns_true_when_variable_is_available
+          hash_binding = HashBinding.new(:var => 'foo')
+          assert_equal(true, hash_binding.exists?(:var))
+        end
+
+        def test_fetch_returns_the_value_of_the_variable
+          hash_binding = HashBinding.new(:var => 'foo')
+          assert_equal('foo', hash_binding.fetch(:var))
+        end
+
+      end
+    end
+  end
+end

data/test/capistrano/template/operations/stage_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+module Capistrano
+  module Template
+    module Operations
+      class StageTest < Test::Unit::TestCase
+        def setup
+          @capistrano = MockCapistrano.new
+          @capistrano.set(:template_path, TEST_TEMPLATES)
+        end
+
+        def test_execute_creates_staging_directory
+          @capistrano.template.stage
+          assert_equal 'mkdir -p /tmp/cap-templates', @capistrano.invocations.first[:command]
+        end
+
+        def test_execute_uploads_files_to_the_staging_directory
+          @capistrano.server 'example.com', :app
+          @capistrano.template.publish 'hello.erb', '/usr/local/bin/hello'
+          @capistrano.template.stage
+          assert_equal :up, @capistrano.transfers.first[:direction]
+          assert_match /Hello from/, @capistrano.transfers.first[:from].read
+          assert_equal '/tmp/cap-templates/usr__local__bin__hello', @capistrano.transfers.first[:to]
+        end
+
+        def test_execute_uploads_files_only_to_the_given_roles
+          @capistrano.server 'example.com', :app
+          @capistrano.template.publish 'hello.erb', '/usr/local/bin/hello', :roles => :app
+          @capistrano.template.stage
+          assert_equal :up, @capistrano.transfers.first[:direction]
+          assert_match /Hello from/, @capistrano.transfers.first[:from].read
+          assert_equal '/tmp/cap-templates/usr__local__bin__hello', @capistrano.transfers.first[:to]
+          assert_equal :app, @capistrano.transfers.first[:options][:roles]
+        end
+
+        def test_execute_ignores_roles_that_are_not_defined
+          @capistrano.template.publish 'hello.erb', '/usr/local/bin/hello', :roles => :app
+          @capistrano.template.stage
+          assert_equal [], @capistrano.transfers
+        end
+      end
+    end
+  end
+end

data/test/capistrano/template/plugin_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+class PluginTest < Test::Unit::TestCase
+  def setup
+    @config = Capistrano::Configuration.new
+  end
+
+  def test_template_plugin_is_available
+    assert_nothing_raised do
+      @config.template
+    end
+  end
+
+  def test_render_erbs_the_given_template
+    @config.set(:template_path, TEST_TEMPLATES)
+    result = @config.template.render("hello.erb")
+    assert_equal(result, "Hello from #{TEST_TEMPLATES}\n")
+  end
+
+  def test_publish_stores_where_templates_should_be_placed
+    @config.template.publish('hello.erb', '/tmp/hello')
+    assert_equal('hello.erb', @config.__template_published_files.first[:template])
+    assert_equal('/tmp/hello', @config.__template_published_files.first[:location])
+  end
+
+  def test_publish_fills_in_the_options_hash_for_put
+    @config.template.publish('hello.erb', '/tmp/hello', :mode => '0640', :roles => :app)
+    assert_equal(:app, @config.__template_published_files.first[:options][:roles])
+    assert_equal('0640', @config.__template_published_files.first[:options][:mode])
+  end
+
+  def test_publish_raises_an_argument_error_if_location_is_not_an_absolute_path
+    assert_raises(ArgumentError) do
+      @config.template.publish('hello.erb', 'hello', :mode => '0640', :roles => :app)
+    end
+  end
+
+  def test_without_current_task_removes_any_existing_task_call_frames
+    Thread.current[:task_call_frames] = :original
+    called = false
+    @config.template.without_current_task do
+      called = true
+      assert_equal [], Thread.current[:task_call_frames]
+    end
+    assert_equal true, called
+    assert_equal :original, Thread.current[:task_call_frames]
+  end
+end

data/test/capistrano/template/version_test.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+class VersionTest < Test::Unit::TestCase
+  def test_version_is_set
+    assert_not_nil Capistrano::Template::VERSION
+  end
+end

data/test/mocks/mock_capistrano.rb

@@ -0,0 +1,18 @@
+class MockCapistrano < Capistrano::Configuration
+
+  def transfer(direction, from, to, options={})
+    transfers.push(:direction => direction, :from => from, :to => to, :options => options)
+  end
+
+  def run(command, options={})
+    invocations.push(:command => command, :options => options)
+  end
+
+  def transfers
+    @transfers ||= []
+  end
+
+  def invocations
+    @invocations ||= []
+  end
+end

data/test/templates/hello.erb

@@ -0,0 +1 @@
+Hello from <%= template_path %>

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'capistrano/template'
+require 'test/unit'
+require 'mocks/mock_capistrano'
+
+TEST_TEMPLATES = File.expand_path('../templates', __FILE__)

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: marcosgz-cap-template
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+- Tony Pitluga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mgzmaster@gmail.com
+- tony.pitluga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/templates/goodbye_world.erb
+- examples/templates/hello_world.erb
+- examples/vanilla.rb
+- lib/capistrano/template.rb
+- lib/capistrano/template/bindings/capistrano_binding.rb
+- lib/capistrano/template/bindings/chain.rb
+- lib/capistrano/template/bindings/hash_binding.rb
+- lib/capistrano/template/plugin.rb
+- lib/capistrano/template/version.rb
+- marcosgz-cap-template.gemspec
+- test/capistrano/template/bindings/capistrano_binding_test.rb
+- test/capistrano/template/bindings/chain_test.rb
+- test/capistrano/template/bindings/hash_binding_test.rb
+- test/capistrano/template/operations/stage_test.rb
+- test/capistrano/template/plugin_test.rb
+- test/capistrano/template/version_test.rb
+- test/mocks/mock_capistrano.rb
+- test/templates/hello.erb
+- test/test_helper.rb
+homepage: https://github.com/marcosgz/capistrano-template
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Capistrano Templates
+test_files:
+- test/capistrano/template/bindings/capistrano_binding_test.rb
+- test/capistrano/template/bindings/chain_test.rb
+- test/capistrano/template/bindings/hash_binding_test.rb
+- test/capistrano/template/operations/stage_test.rb
+- test/capistrano/template/plugin_test.rb
+- test/capistrano/template/version_test.rb
+- test/mocks/mock_capistrano.rb
+- test/templates/hello.erb
+- test/test_helper.rb
+has_rdoc: