capistrano-gitinfos 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c1b07a606674a26fe3b3826122f8442881689f9
-  data.tar.gz: 7f3d38b58f1935035de7564ae5658cff850ec1ca
+  metadata.gz: 545e60e2a1003cecfef90e3603209be54b0fafbc
+  data.tar.gz: 2682b030448987273e7a6b315e5d4c50cb9f58d3
 SHA512:
-  metadata.gz: 36f5aafbe5caeca5e2072a9745b9993f84ebedb7e0c96d328431e6caaa947b24399c5d7f314771840f787e51ef9bc2526381a54d73b97a0dc7c90b2668afdaca
-  data.tar.gz: 64f91a1d1d6b9ff9cb32dc5eba50ecfea36bd7f84d12f8ae5f9bbc546be7aedd55aca29a57a147ec72ea49899423ed39bbf60cb83c8d897102f13f1a92f19678
+  metadata.gz: 58f2523fdd240d695a953cad68064514e5430597fb017aac0c5fd6b2aad997e3577fbf08759bb50f762fcc23673d23c3a6f9b2d60602cc5240f2af30348b78ce
+  data.tar.gz: 25a5c5ae7dca5012c64ae27b31ad9d73fa4714f8cb1b3eaaa7cddb44b613a4b1d11ff3e202fc328aa6e323e9112bca24a40846f1a9eb7c86a57845d133cbd8d1

data/.gitignore

@@ -1,20 +1,19 @@
 *.gem
 *.rbc
-.bundle
+/.bundle/
 .config
-.yardoc
-Gemfile.lock
+/.yardoc
+/Gemfile.lock
 InstalledFiles
-_yardoc
-coverage
-bin/
-doc/
+/_yardoc/
+/coverage/
+/doc/
 lib/bundler/man
-pkg
+/pkg/
 rdoc
-spec/reports
+/spec/reports/
 test/tmp
 test/version_tmp
-tmp
+/tmp/
 /vendor/ruby
 .idea

data/README.md

@@ -37,6 +37,10 @@ set :gitinfos_format, "json"
 # if :gitinfos_format = yml and :gitinfos_file = config/version
 # then the final path is <release_path>/config/version.yml
 set :gitinfos_file, "version"
+
+# section name : "namespace" in the config file which will contains git commit informations
+# if the namespace contains dots, it will be translated as nested path in JSON, YML and XML
+set :gitinfos_section, ''
 ```
 
 After deploying, you will get a file with the following informations:
@@ -55,13 +59,31 @@ e.g. :
 
 ```json
 {
-    "commit_date": "2015-11-25T16:25:50+0000",
-    "full_commit": "576e27c6ebcef6987f143e1468a815eaf2eb8bc1",
-    "version": "v0.8.0-268-g576e27c",
-    "commit_timestamp": "1448468750",
-    "deploy_date": "2015-11-25T16:45:39+0000",
-    "deploy_timestamp": "1448469939",
-    "abbrev_commit": "576e27c"
+  "commit_date": "2015-11-25T16:25:50+0000",
+  "full_commit": "576e27c6ebcef6987f143e1468a815eaf2eb8bc1",
+  "version": "v0.8.0-268-g576e27c",
+  "commit_timestamp": "1448468750",
+  "deploy_date": "2015-11-25T16:45:39+0000",
+  "deploy_timestamp": "1448469939",
+  "abbrev_commit": "576e27c"
+}
+```
+
+with `:gitinfos_section` = 'parameters.git'
+
+```json
+{
+  "parameters": {
+    "git": {
+      "commit_date": "2015-11-25T16:25:50+0000",
+      "full_commit": "576e27c6ebcef6987f143e1468a815eaf2eb8bc1",
+      "version": "v0.8.0-268-g576e27c",
+      "commit_timestamp": "1448468750",
+      "deploy_date": "2015-11-25T16:45:39+0000",
+      "deploy_timestamp": "1448469939",
+      "abbrev_commit": "576e27c"
+    }
+  }
 }
 ```
 
@@ -78,6 +100,19 @@ deploy_timestamp = 1448469943
 abbrev_commit = 576e27c
 ```
 
+with `:gitinfos_section` = 'parameters.git'
+
+```ini
+[parameters.git]
+commit_date = 2015-11-25T16:25:50+0000
+full_commit = 576e27c6ebcef6987f143e1468a815eaf2eb8bc1
+version = v0.8.0-268-g576e27c
+commit_timestamp = 1448468750
+deploy_date = 2015-11-25T16:45:43+0000
+deploy_timestamp = 1448469943
+abbrev_commit = 576e27c
+```
+
 * version.yml
 
 ```yml
@@ -90,6 +125,20 @@ full_commit: 576e27c6ebcef6987f143e1468a815eaf2eb8bc1
 version: v0.8.0-268-g576e27c
 ```
 
+with `:gitinfos_section` = 'parameters.git'
+
+```yml
+parameters:
+  git:
+    abbrev_commit: '576e27c'
+    commit_date: '2015-11-25T16:25:50+0000'
+    commit_timestamp: '1448468750'
+    deploy_date: '2015-11-25T16:45:41+0000'
+    deploy_timestamp: '1448469941'
+    full_commit: '576e27c6ebcef6987f143e1468a815eaf2eb8bc1'
+    version: 'v0.8.0-268-g576e27c'
+```
+
 * version.xml
 
 ```xml
@@ -105,6 +154,23 @@ version: v0.8.0-268-g576e27c
 </app_version>
 ```
 
+with `:gitinfos_section` = 'parameters.git'
+
+```xml
+<?xml version='1.0' encoding='UTF-8'?>
+<parameters>
+  <git>
+    <commit_date>2015-11-25T16:25:50+0000</commit_date>
+    <full_commit>576e27c6ebcef6987f143e1468a815eaf2eb8bc1</full_commit>
+    <version>v0.8.0-268-g576e27c</version>
+    <commit_timestamp>1448468750</commit_timestamp>
+    <deploy_date>2015-11-25T16:45:48+0000</deploy_date>
+    <deploy_timestamp>1448469948</deploy_timestamp>
+    <abbrev_commit>576e27c</abbrev_commit>
+  </git>
+</parameters>
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kilix/capistrano-gitinfos.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/gitinfos"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-gitinfos.gemspec

@@ -31,10 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sshkit", ">= 1.2.0"
   spec.add_dependency "inifile", ">= 3.0.0"
   spec.add_dependency "json", ">= 1.8.0"
-  spec.add_dependency "nokogiri", ">= 1.6.0"
+  spec.add_dependency "xml-simple", ">= 1.1.0"
   spec.add_dependency "activesupport", ">= 4.2.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/capistrano/gitinfos.rb

@@ -1,10 +1,7 @@
-require 'json'
-require 'yaml'
-require 'inifile'
-require 'nokogiri'
 require 'active_support/time'
 require "capistrano/gitinfos/version"
 require "capistrano/gitinfos/gitinfos"
+require "capistrano/gitinfos/format"
 
 load File.expand_path("../tasks/deploy.rake", __FILE__)
 

data/lib/capistrano/gitinfos/defaults.rb

@@ -9,5 +9,6 @@ set :gitinfos_format, "json"
 # then the final path is <release_path>/config/version.yml
 set :gitinfos_file, "version"
 
-# XML root tag or INI section (only for XML or INI format)
-set :gitinfos_section, "app_version"
+# section name : "namespace" in the config file which will contains git commit informations
+# if the namespace contains dots, it will be translated as nested path in JSON, YML and XML
+set :gitinfos_section, ''

data/lib/capistrano/gitinfos/format.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'yaml'
+require 'inifile'
+require 'xmlsimple'
+
+module Capistrano
+    module Gitinfos
+        def self.format(infos, extension = 'json', section = nil)
+            case extension.downcase
+                when "yml"
+                    return dumpForceQuotedYaml(createInfosToDump(infos, section))
+
+                when "xml"
+                    section = section.nil? || section == '' ? 'app_version' : section
+
+                    return XmlSimple.xml_out(createInfosToDump(infos, section), {
+                        'KeepRoot' => true,
+                        'XmlDeclaration' => '<?xml version="1.0"?>',
+                        'NoAttr' => true
+                    })
+
+                when "ini"
+                    section = section.nil? || section == '' ? 'app_version' : section
+
+                    ini = IniFile.new
+                    ini[section] = infos
+
+                    return ini.to_s
+
+                else
+                    return JSON.pretty_generate(createInfosToDump(infos, section))+"\n"
+            end
+        end
+
+        def self.createInfosToDump(infos, section = nil)
+            toDump = infos
+            if !section.nil? && section != ''
+                sections = section.split('.')
+                sections.reverse_each do |sec|
+                    toDump = { sec => toDump.dup }
+                end
+            end
+
+            return toDump
+        end
+
+        # Hack to force string quoting and prevent abbrev_commit to be read as float in YAML
+        def self.dumpForceQuotedYaml(data)
+            raw = data.dup
+            pattern = "__ensure_quotes__ "
+            yml = YAML.dump(ensure_quotes(raw, pattern))
+
+            return yml.gsub(/#{Regexp.escape(pattern)}/, '')
+        end
+
+        def self.ensure_quotes(h, pattern = "__ensure_quotes__")
+            h.each do |k, v|
+                if v.is_a?(Hash)
+                    ensure_quotes(v, pattern)
+                    next
+                end
+
+                if v.is_a?(String)
+                    h[k] = v + pattern
+                end
+            end
+        end
+
+    end
+end

data/lib/capistrano/gitinfos/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Gitinfos
-    VERSION = "0.0.6"
+    VERSION = "0.1.0"
   end
 end

data/lib/capistrano/tasks/gitinfos.rake

@@ -21,53 +21,20 @@ def getGitInfos(commit)
     }
 end
 
-def formatGitInfos(infos, format)
-    case format
-        when "yml"
-            # TODO find option to force quoting to prevent abbrev_commit to be read as float in YAML
-            # return YAML.dump(infos)
-            return <<-YAML
----
-version: '#{infos['version']}'
-abbrev_commit: '#{infos['abbrev_commit']}'
-full_commit: '#{infos['full_commit']}'
-commit_date: '#{infos['commit_date']}'
-commit_timestamp: '#{infos['commit_timestamp']}'
-deploy_date: '#{infos['deploy_date']}'
-deploy_timestamp: '#{infos['deploy_timestamp']}'
-YAML
-
-        when "xml"
-            builder = Nokogiri::XML::Builder.new do |xml|
-
-                xml.send("#{fetch(:gitinfos_section)}") do
-                    infos.each do |key, value|
-                        xml.send(key, value)
-                    end
-                end
-            end
-
-            return builder.to_xml
-
-        when "ini"
-            ini = IniFile.new
-            ini["#{fetch(:gitinfos_section)}"] = infos
-
-            return ini.to_s
-
-        else
-            set :gitinfos_format, "json"
-            return JSON.pretty_generate(infos)+"\n"
-    end
-end
-
 namespace :gitinfos do
     task :set_version_infos do
         on release_roles :all do
             within repo_path do
                 with fetch(:git_environmental_variables) do
-                    infos = formatGitInfos(getGitInfos(fetch(:branch)), fetch(:gitinfos_format))
-                    upload! StringIO.new(infos),  "#{release_path}/#{fetch(:gitinfos_file)}.#{fetch(:gitinfos_format)}"
+
+                    extension = fetch(:gitinfos_format)
+                    if !['yml','ini','xml','json'].include?(extension)
+                        set :gitinfos_format, 'json'
+                        extension = 'json'
+                    end
+
+                    infos = Capistrano::Gitinfos.format(getGitInfos(fetch(:branch)), extension, fetch(:gitinfos_section))
+                    upload! StringIO.new(infos),  "#{release_path}/#{fetch(:gitinfos_file)}.#{extension}"
                 end
             end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-gitinfos
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Charles Sanquer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Fetch extra git commit informations and storing in a INI/JSON/XML/YML
   file when deploying with Capstrano 3.
 email:
@@ -149,10 +149,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - capistrano-gitinfos.gemspec
 - lib/capistrano-gitinfos.rb
 - lib/capistrano/gitinfos.rb
 - lib/capistrano/gitinfos/defaults.rb
+- lib/capistrano/gitinfos/format.rb
 - lib/capistrano/gitinfos/gitinfos.rb
 - lib/capistrano/gitinfos/version.rb
 - lib/capistrano/tasks/deploy.rake
@@ -177,7 +180,7 @@ 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: Fetch git commit informations when deploying with Capistrano 3.