capistrano-template 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9069d7f7aba60eb93dbe6cd252321ae37b76fc0
+  data.tar.gz: e78c5df43dc90a425fe35c65b4a8314ef98a8156
+SHA512:
+  metadata.gz: 70f3144f5b14657ee87859ec9033872329c20ee8f2630090f236082e5e59d10f267cacee5a826fd132a499c34332d82ec4ca147b403b2b932ac74f35990748b5
+  data.tar.gz: 8c9b1a43320b332d7daa5a7071d02954e73b28acedd4abdda0af71c1acd0fc304f079015bb1177029c7ab44172b62da9e72244589b7c0610ad1fd48ed0d67710

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 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,22 @@
+
+inherit_from: .rubocop_todo.yml
+
+
+LineLength:
+  Max: 160
+
+Documentation:
+  Enabled: false
+
+ParameterLists:
+  Max: 15
+
+MethodLength:
+  Max: 50
+
+# @see http://www.rubytapas.com/episodes/24-Incidental-Change
+TrailingComma:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,8 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-05-26 11:14:26 +0200 using RuboCop version 0.22.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0

data/.versions.conf

@@ -0,0 +1,4 @@
+ruby=ruby-2.1.0
+ruby-gemset=capistrano-template
+#ruby-gem-install=bundler rake
+#ruby-bundle-install=true

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-template.gemspec
+gemspec
+
+gem 'simplecov', require:  false, group: :test
+gem 'coveralls', require: false
+gem 'rubocop', require: false
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dieter Späth
+
+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,66 @@
+# Capistrano::Template
+
+A capistrano 3 plugin that aids in rendering erb templates and
+uploads the content to the server if the file does not exists at
+the remote host or the content did change. 
+
+## 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
+
+In your Capfile:
+
+```ruby
+ require 'capistrano/capistrano_plugin_template'
+ 
+ ```
+ 
+ In your task or stage file:
+ 
+ ```ruby
+ 
+   desc 'Upload a rendered erb-template'
+   task :setup do     
+     on roles :all       
+       template 'assets.host.site'
+     end
+     
+     on roles :all       
+       template 'other.template.name', 'execute_some_thing.sh', 0750
+     end
+          
+   end
+ 
+ ```
+
+## Settings
+
+This settings can be changed in your Capfile, deploy.rb or stage file.
+
+| Variable              | Default              | Description                                                           |
+|-----------------------|:--------------------:|-----------------------------------------------------------------------|
+|`templating_digster`   | `templating_digster` | Checksum algorythmous for rendered template to check for remote diffs |
+|`templating_digest_cmd`| `%Q{test "Z$(openssl md5 %<path>s| sed "s/^.*= *//")" = "Z%<digest>s" }` | Remote command to validate a digest. Format placeholders path is replaces by full `path to the remote file and `digest` with the digest calculated in capistrano. |
+|`templating_mode_test_cmd`| `%Q{ [ "Z$(printf "%%.4o" 0$(stat -c "%%a" %<path>s 2>/dev/null ||  stat -f "%%A" %<path>s))" != "Z%<mode>s" ] } | Test command to check the remote file permissions. |
+| `templating_paths`| `["config/deploy/templates/#{fetch(:stage)}/%<host>s","config/deploy/templates/#{fetch(:stage)}", "config/deploy/templates/shared/%<host>s","config/deploy/templates/shared"]`| Folder to look for a template to render. |
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/capistrano-template/fork )
+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,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Rubocop::RakeTask.new
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec
+
+desc 'Run RSpec with code coverage'
+task :coverage do
+  ENV['SIMPLE_COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end

data/capistrano-template.gemspec

@@ -0,0 +1,35 @@
+# coding: 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 |spec|
+  spec.name          = 'capistrano-template'
+  spec.version       = Capistrano::Template::VERSION
+  spec.authors       = ['Dieter Späth']
+  spec.email         = ['d.spaeth@faber.de']
+  spec.summary       = %q(Erb-Template rendering and upload for capistrano 3)
+  spec.description   = %q(A capistrano 3 plugin that aids in rendering erb templates and
+uploads the content to the server if the file does not exists at
+the remote host or the content did change)
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.required_ruby_version = '>= 2.0.0'
+  spec.add_dependency 'capistrano', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'rspec', '2.99.0.rc1'
+  # show nicely how many specs have to be run
+  spec.add_development_dependency 'fuubar'
+  # extended console
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+end

data/lib/capistrano/capistrano_plugin_template.rb

@@ -0,0 +1,5 @@
+require 'capistrano/template'
+
+include Capistrano::Template::Helpers::DSL
+
+import File.join(__dir__, 'template', 'tasks', 'template_defaults.cap')

data/lib/capistrano/template.rb

@@ -0,0 +1,11 @@
+require 'delegate'
+require 'capistrano/template/version'
+
+module Capistrano
+  module Template
+  end
+end
+
+require 'capistrano/template/helpers/uploader'
+require 'capistrano/template/helpers/paths_lookup'
+require 'capistrano/template/helpers/dsl'

data/lib/capistrano/template/helpers/dsl.rb

@@ -0,0 +1,61 @@
+module Capistrano
+  module Template
+    module Helpers
+      module DSL
+        def template(from, to = nil, mode = 0640)
+          fail ::ArgumentError, "template #{from} not found Paths: #{template_paths_lookup.paths_for_file(from).join(':')}" unless template_exists?(from)
+
+          to ||= "#{release_path}/#{File.basename(from, '.erb')}"
+          to = remote_path_for(to, true)
+
+          template = _template_factory.call(template_file(from), self, fetch(:templating_digster))
+
+          _uploader_factory.call(to, self,
+                                 digest: template.digest,
+                                 digest_cmd: fetch(:templating_digest_cmd),
+                                 mode_test_cmd: fetch(:templating_mode_test_cmd),
+                                 mode: mode,
+                                 io: template.as_io
+                                ).call
+        end
+
+        def template_exists?(template)
+          template_paths_lookup.template_exists?(template)
+        end
+
+        def template_file(template)
+          template_paths_lookup.template_file(template)
+        end
+
+        def template_paths_lookup
+          _paths_factory.call(fetch(:templating_paths), self)
+        end
+
+        def _uploader_factory
+          ->(*args) { Uploader.new(*args) }
+        end
+
+        def _paths_factory
+          ->(*args) { PathsLookup.new(*args) }
+        end
+
+        def remote_path_for(path, includes_filename = false)
+          filename = nil
+
+          if includes_filename
+            filename = File.basename(path)
+            path = File.dirname(path)
+          end
+
+          remote_path = capture("(cd  #{path} && pwd -P) || readlink -sf #{path}").chomp
+
+          includes_filename ? File.join(remote_path, filename) : remote_path
+        end
+
+        def _template_factory
+          ->(from, context, digester) {TemplateDigester.new(Renderer.new(from, context), digester) }
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/template/helpers/paths_lookup.rb

@@ -0,0 +1,33 @@
+module Capistrano
+  module Template
+    module Helpers
+      class PathsLookup < SimpleDelegator
+        attr_accessor :paths
+
+        def initialize(paths, context)
+          super context
+          self.paths = paths
+        end
+
+        def template_exists?(filename)
+          !template_file(filename).nil?
+        end
+
+        def template_file(filename)
+          paths_for_file(filename).find { |path| existence_check(path) }
+        end
+
+        def existence_check(path)
+          File.exist?(path)
+        end
+
+        def paths_for_file(filename)
+          paths.map do |path|
+            path = path % { host: host }
+            ["#{path}/#{filename}.erb", "#{path}/#{filename}"]
+          end.flatten
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/template/helpers/renderer.rb

@@ -0,0 +1,30 @@
+module Capistrano
+  module Template
+    module Helpers
+      class Renderer < SimpleDelegator
+        attr_accessor :from, :reader
+
+        def initialize(from, context, reader: File)
+          super context
+
+          self.from = from
+          self.reader = reader
+        end
+
+        def as_str
+          @rendered_template ||= ERB.new(template_content).result(binding)
+        end
+
+        def as_io
+          StringIO.new(as_str)
+        end
+
+        protected
+
+        def template_content
+          reader.read(from)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/template/helpers/template_digester.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  module Template
+    module Helpers
+      class TemplateDigester < SimpleDelegator
+        attr_accessor :digest_algo
+
+        def initialize(renderer, digest_algo)
+          super renderer
+
+          self.digest_algo = digest_algo
+        end
+
+        def digest
+          digest_algo.call(as_str)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/template/helpers/uploader.rb

@@ -0,0 +1,94 @@
+module Capistrano
+  module Template
+    module Helpers
+      require 'capistrano/template/helpers/renderer'
+      require 'capistrano/template/helpers/template_digester'
+
+      class Uploader
+        attr_accessor :io,
+                      :digest,
+                      :full_to_path,
+                      :digest_cmd,
+                      :mode,
+                      :remote_handler,
+                      :mode_test_cmd
+
+        def initialize(full_to_path, remote_handler,
+            mode: 0640,
+            mode_test_cmd: nil,
+            digest: nil,
+            digest_cmd: nil,
+            io: nil
+        )
+          self.remote_handler = remote_handler
+
+          self.full_to_path = full_to_path
+
+          self.digest_cmd = digest_cmd
+          self.mode = mode
+          self.mode_test_cmd = mode_test_cmd
+
+          self.io = io
+          self.digest = digest
+        end
+
+        def call
+          upload_as_file
+          set_mode
+        end
+
+        def upload_as_file
+          if file_changed?
+            remote_handler.info "copying to: #{full_to_path}"
+            remote_handler.upload! io, full_to_path
+          else
+            remote_handler.info "File #{full_to_path} on host #{host} not changed"
+          end
+        end
+
+        def host
+          remote_handler.host
+        end
+
+        def set_mode
+          if permission_changed?
+            remote_handler.info "permission changed for file #{full_to_path} on #{host} set new permissions"
+            remote_handler.execute 'chmod', octal_mode_str, full_to_path
+          else
+            remote_handler.info "permission not changed for file #{full_to_path} on #{host}"
+          end
+        end
+
+        def file_changed?
+          !__check__(digest_cmd)
+        end
+
+        def permission_changed?
+          __check__(mode_test_cmd)
+        end
+
+        protected
+
+        def __check__(*args)
+          remote_handler.test(*args)
+        end
+
+        def octal_mode_str
+          format '%.4o' , mode
+        end
+
+        def digest_cmd
+          @digest_cmd % { digest: digest,
+                          path: full_to_path }
+        end
+
+        def mode_test_cmd
+          @mode_test_cmd % {
+            path: full_to_path,
+            mode: octal_mode_str
+          }
+        end
+      end
+    end
+  end
+end