capistrano-template 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d43e1e1efca15e4a2269fa8e117ebb32e10af19f
-  data.tar.gz: 691af6de00ab337d111d2b134cdc07c78ecdb59e
+  metadata.gz: 4b7c26cd31e68ace9c983f2690872cf25d451575
+  data.tar.gz: ad40226e2f26582edd73d56ea42006076d70c292
 SHA512:
-  metadata.gz: f3ad30092984bf23823bf4719787e88e75e075338520c62c3658e04878125c900d5724779497884b499c9b8d1764d619b453b7defd808f518e31a4e08a388def
-  data.tar.gz: fc6fff6d4580e2f2a1feda2cd2f6a271182090f19ead695ea2287e0cc0cfdd1a83fe853a85ae0fbe6ed62e3966b80ddf9e091ae8ebd64caa48b5f73413a50b52
+  metadata.gz: bb0f80f4116772a04a4a711e3cb1e65ba14d8029ab651b349036253726f203791a0720f12ce1839ca5d2eb779067b2e85dbd28547c4ceb352f2c6b9bfe3c086c
+  data.tar.gz: f26c7fb86f05eaccb669324573288f504c8f496bc6d7c0271334f13f1c6dfbba565a9a3724da4117994042d53593029907e932d563ead7a0167b4d32436fdd4d

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rubocop.yml

@@ -14,9 +14,5 @@ ParameterLists:
 MethodLength:
   Max: 50
 
-# @see http://www.rubytapas.com/episodes/24-Incidental-Change
-TrailingComma:
-  Enabled: false
-
 RegexpLiteral:
-  Enabled: false
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,8 +1,213 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-05-26 11:14:26 +0200 using RuboCop version 0.22.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-07-27 08:41:15 +0200 using RuboCop version 0.42.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.
 
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 20
 
+# Offense count: 2
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 223
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: with_first_parameter, with_fixed_indentation
+Style/AlignParameters:
+  Exclude:
+    - 'lib/capistrano/template/helpers/uploader.rb'
+
+# Offense count: 11
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: percent_q, bare_percent
+Style/BarePercentLiterals:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+    - 'spec/integration/capistrano/template/helpers/dsl_spec.rb'
+    - 'spec/integration/capistrano/template/helpers/uploader_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/uploader_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/BlockEndNewline:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ClosingParenthesisIndentation:
+  Exclude:
+    - 'lib/capistrano/template/helpers/uploader.rb'
+
+# Offense count: 31
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, no_empty_lines
+Style/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/integration/capistrano/template/helpers/dsl_spec.rb'
+    - 'spec/integration/capistrano/template/helpers/paths_lookup_spec.rb'
+    - 'spec/integration/capistrano/template/helpers/uploader_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/paths_lookup_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/renderer_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/template_digester_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/uploader_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: consistent, special_for_inner_method_call, special_for_inner_method_call_in_parentheses
+Style/FirstParameterIndentation:
+  Exclude:
+    - 'spec/integration/capistrano/template/helpers/uploader_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/uploader_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: line_count_dependent, lambda, literal
+Style/Lambda:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 1
+Style/MethodMissing:
+  Exclude:
+    - 'lib/capistrano/template/helpers/dsl.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MultilineBlockLayout:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: symmetrical, new_line, same_line
+Style/MultilineMethodCallBraceLayout:
+  Exclude:
+    - 'lib/capistrano/template/helpers/dsl.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: symmetrical, new_line, same_line
+Style/MultilineMethodDefinitionBraceLayout:
+  Exclude:
+    - 'lib/capistrano/template/helpers/uploader.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/capistrano/template/version.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedOctalStyle, SupportedOctalStyles.
+# SupportedOctalStyles: zero_with_o, zero_only
+Style/NumericLiteralPrefix:
+  Exclude:
+    - 'lib/capistrano/template/helpers/dsl.rb'
+    - 'lib/capistrano/template/helpers/uploader.rb'
+    - 'spec/integration/capistrano/template/helpers/uploader_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/uploader_spec.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: lower_case_q, upper_case_q
+Style/PercentQLiterals:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+    - 'spec/integration/capistrano/template/helpers/dsl_spec.rb'
+    - 'spec/integration/capistrano/template/helpers/uploader_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/uploader_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantParentheses:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: only_raise, only_fail, semantic
+Style/SignalException:
+  Exclude:
+    - 'lib/capistrano/template/helpers/dsl.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: space, no_space
+Style/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SpaceBeforeComma:
+  Exclude:
+    - 'lib/capistrano/template/helpers/uploader.rb'
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+Style/SpaceInsideBlockBraces:
+  Exclude:
+    - 'lib/capistrano/template/helpers/dsl.rb'
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: final_newline, final_blank_line
+Style/TrailingBlankLines:
+  Exclude:
+    - 'Gemfile'
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+# SupportedStyles: comma, consistent_comma, no_comma
+Style/TrailingCommaInLiteral:
+  Exclude:
+    - 'spec/unit/capistrano/template/helpers/dsl_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/UnneededInterpolation:
+  Exclude:
+    - 'spec/integration/capistrano/template/helpers/paths_lookup_spec.rb'
+
+# Offense count: 11
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'capistrano-template.gemspec'
+    - 'lib/capistrano/template/tasks/template_defaults.rake'
+    - 'spec/integration/capistrano/template/helpers/dsl_spec.rb'
+    - 'spec/integration/capistrano/template/helpers/uploader_spec.rb'
+    - 'spec/unit/capistrano/template/helpers/uploader_spec.rb'

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.0
+  - 2.1.5
+  - 2.2.1
+  - 2.3.1
 script: bundle exec rake spec rubocop
 cache: bundler
+before_install:
+  - gem install bundler # -v 1.7.14 if a specific version is needed

data/.versions.conf

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

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+0.0.6 (Next)
+=============
+
+
+0.0.5 (27/07/2016)
+==================
+
+#### Features
+
+* [#5](https://github.com/faber-lotto/capistrano-template/5): Enable the usage of locals.
+
+#### Fixes
+
+* [#4](https://github.com/faber-lotto/capistrano-template/4): Fix for `Digest::Base cannot be directly inherited in Ruby` race condition within ruby digest - [@slowjack2k](https://github.com/slowjack2k).

data/README.md

@@ -42,7 +42,7 @@ In your Capfile:
        # searchs for template assets.host.site.erb in :templating_paths
        # renders the template and upload it to "#{release_path}/assets.host.site" on all hosts
        # when the new rendered content is changed or the remote file does not exists
-       template 'assets.host.site'
+       template 'assets.host.site', locals: { 'local1' => 'value local 1'}
      end
      
      on roles :all       
@@ -50,7 +50,7 @@ In your Capfile:
        # renders the template and upload it to "~/execute_some_thing.sh" on all hosts
        # when the new rendered content is changed or the remote file does not exists
        # after this the mode is changed to 0750
-       template 'other.template.name', '~/execute_some_thing.sh', 0750
+       template 'other.template.name', '~/execute_some_thing.sh', 0750, locals: { 'local1' => 'value local 1'}
      end
           
    end
@@ -116,7 +116,7 @@ This settings can be changed in your Capfile, deploy.rb or stage file.
 
 | Variable              | Default                               | Description                           |
 |-----------------------|---------------------------------------|---------------------------------------|
-|`templating_digster`   | <code> -&gt;(data){ Digest::MD5.hexdigest(data)} </code> | Checksum algorythmous for rendered template to check for remote diffs |
+|`templating_digster`   | <code> -&gt;(data){ OpenSSL::Digest::MD5.hexdigest(data)} </code> | Checksum algorythmous for rendered template to check for remote diffs |
 |`templating_digest_cmd`| <code>%Q{test "Z$(openssl md5 %&lt;path&gt;s &#124; sed 's/^.*= *//')" = "Z%&lt;digest&gt;s" }</code> | 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` | <code>%Q{ &#91; "Z$(printf "%%.4o" 0$(stat -c "%%a" %&lt;path&gt;s 2&gt;/dev/null &#124;&#124;  stat -f "%%A" %&lt;path&gt;s))" != "Z%&lt;mode&gt;s" &#93; }</code> | Test command to check the remote file permissions. |
 | `templating_paths` | <code>&#91;"config/deploy/templates/#{fetch(:stage)}/%&lt;host&gt;s",</code> <br> <code> "config/deploy/templates/#{fetch(:stage)}",</code> <br> <code> "config/deploy/templates/shared/%&lt;host&gt;s",</code> <br> <code> "config/deploy/templates/shared"&#93;</code>| Folder to look for a template to render. `<host>` is replaced by the actual host. |

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

@@ -2,13 +2,13 @@ module Capistrano
   module Template
     module Helpers
       module DSL
-        def template(from, to = nil, mode = 0640)
+        def template(from, to = nil, mode = 0640, locals: {})
           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))
+          template = _template_factory.call(template_file(from), self, fetch(:templating_digster), locals)
 
           _uploader_factory.call(to, self,
                                  digest: template.digest,
@@ -53,7 +53,7 @@ module Capistrano
         end
 
         def _template_factory
-          ->(from, context, digester) {TemplateDigester.new(Renderer.new(from, context), digester) }
+          ->(from, context, digester, locals) {TemplateDigester.new(Renderer.new(from, context, locals: locals), digester) }
         end
 
         def method_missing(method_name, *args)

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

@@ -2,13 +2,20 @@ module Capistrano
   module Template
     module Helpers
       class Renderer < SimpleDelegator
-        attr_accessor :from, :reader
+        attr_accessor :from, :reader, :locals
 
-        def initialize(from, context, reader: File)
+        def initialize(from, context, reader: File, locals: {})
           super context
 
           self.from = from
           self.reader = reader
+          self.locals = locals
+        end
+
+        def locals=(new_locals)
+          new_locals ||= {}
+          new_locals = new_locals.each_with_object({}) { |(key, value), result| result[key.to_sym] = value }
+          @locals = new_locals
         end
 
         def as_str
@@ -19,6 +26,22 @@ module Capistrano
           StringIO.new(as_str)
         end
 
+        def method_missing(m, *args, &block)
+          if locals.key?(m)
+            locals[m]
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(m, include_private)
+          if locals.key?(m)
+            true
+          else
+            super
+          end
+        end
+
         protected
 
         def template_content

data/lib/capistrano/template/tasks/template_defaults.rake

@@ -1,6 +1,7 @@
 namespace :load do
+  # rubocop:disable LineLength
   task :defaults do
-    set :templating_digster, ->{ ->(data){ Digest::MD5.hexdigest(data)} }
+    set :templating_digster, ->{ ->(data){ OpenSSL::Digest::MD5.hexdigest(data)} }
     set :templating_digest_cmd, %Q{test "Z$(openssl md5 %<path>s| sed 's/^.*= *//')" = "Z%<digest>s" } # alternative %Q{echo "%<digest>s %<path>s" | md5sum -c --status }  should return true when the file content is the same
     set :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" ] } # mac uses different mode formatter
     set :templating_paths , ->{ ["config/deploy/templates/#{fetch(:stage)}/%<host>s",
@@ -8,6 +9,7 @@ namespace :load do
                                  "config/deploy/templates/shared/%<host>s",
                                  "config/deploy/templates/shared"].map {|partial_path| (partial_path)} }
   end
+  # rubocop:enable LineLength
 end
 
 

data/lib/capistrano/template/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Template
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/spec/integration/capistrano/template/helpers/dsl_spec.rb

@@ -74,8 +74,9 @@ module Capistrano
 
         let(:tmp_folder) { File.join(__dir__, '..', '..', '..', 'tmp') }
 
-        let(:template_content) { '<%=var1%> -- <%=var2%>' }
-        let(:expected_content) { 'my -- content' }
+        let(:template_content) { '<%=var1%> -- <%=var2%> -- <%= my_local %>' }
+        let(:expected_content) { 'my -- content -- local content' }
+        let(:locals) { { 'my_local' => 'local content' } }
 
         let(:template_name) { 'my_template.erb' }
         let(:template_fullname) { File.join(tmp_folder, template_name) }
@@ -105,7 +106,7 @@ module Capistrano
         describe '#template' do
 
           it 'create the result file' do
-            subject.template(template_name)
+            subject.template(template_name, locals: locals)
 
             expect(File.read(remote_filename)).to eq(expected_content)
           end

data/spec/unit/capistrano/template/helpers/renderer_spec.rb

@@ -6,18 +6,19 @@ module Capistrano
       describe Renderer do
 
         subject do
-          Renderer.new(template_name, context, reader: reader)
+          Renderer.new(template_name, context, reader: reader, locals: locals)
         end
 
         let(:context) { OpenStruct.new(var1: 'my', var2: 'content') }
+        let(:locals) { { 'my_local' => 'local content' } }
         let(:template_name) { 'my_template' }
         let(:reader) { double(read: template_content) }
-        let(:template_content) { '<%=var1%> -- <%=var2%>' }
+        let(:template_content) { '<%=var1%> -- <%=var2%> -- <%= my_local %>' }
 
         describe '#as_str' do
 
           it 'renders a erb template' do
-            expect(subject.as_str).to eq('my -- content')
+            expect(subject.as_str).to eq('my -- content -- local content')
           end
 
         end
@@ -37,6 +38,16 @@ module Capistrano
 
         end
 
+        describe '.respond_to?' do
+          it 'returns "true" when method name is a key inside the locals hash' do
+            expect(subject.respond_to?(:my_local)).to be_truthy
+          end
+
+          it 'returns "false" when method name is not a key inside the locals hash and context does not respond to this method' do
+            expect(subject.respond_to?(:foo)).to be_falsy
+          end
+        end
+
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-template
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dieter Späth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Erb-Template rendering and upload for capistrano 3