capistrano-gitinfos 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08a1bca2f8af168b0eb97964483fde9566cd8d65
+  data.tar.gz: 71a023fbb7194aa1fa6713636ff568120cfd2394
+SHA512:
+  metadata.gz: 6d323524718ff20748cb313f5c66488c07f41bef70bc6c32f0ebb0cb23b9b99f25fc2fe6359b12705284298f993e929fdd35d300258bef8256e135d5b1a1f455
+  data.tar.gz: 80c4fd38ae6dff588a88803d4800a3033e0631ec1d62885bae985913ee5330349454e93b08fa30063ba0f46c18e6a14034df828fd1440951f9851ff5d61dabb4

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kilix
+
+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,48 @@
+# Capistrano-gitinfos
+
+Capistrano 3 plugin to fetch git commit additional informations and store them in an INI/XML/YAML/JSON file when deploying
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-gitinfos'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-gitinfos
+
+## Usage
+
+```ruby
+require 'capistrano/gitinfos'
+```
+
+Set the version file format and filename.
+
+```ruby
+# version file output format and file extension
+# available formats : ini, xml, yml, json
+# default : json
+set :gitinfos_format, "json"
+
+# relative path from release_path without file extension
+# default : version
+# if :gitinfos_format = yml and :gitinfos_file = config/version
+# then the final path is <release_path>/config/version.yml
+set :gitinfos_file, "version"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kilix/capistrano-gitinfos.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-gitinfos.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/gitinfos/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-gitinfos"
+  spec.version       = Capistrano::Gitinfos::VERSION
+  spec.authors       = ["Charles Sanquer"]
+  spec.email         = ["csanquer@kilix.fr"]
+
+  spec.summary       = "Fetch git commit informations when deploying with Capistrano 3."
+  spec.description   = "Fetch extra git commit informations and storing in a INI/JSON/XML/YML file when deploying with Capstrano 3."
+  spec.homepage      = "http://rubygems.org/gems/capistrano-gitinfos"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", ">= 3.1"
+  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 "activesupport", ">= 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/capistrano/gitinfos/defaults.rb

@@ -0,0 +1,13 @@
+# version file output format and file extension
+# available formats : ini, xml, yml, json
+# default : json
+set :gitinfos_format, "json"
+
+# relative path from release_path without file extension
+# default : version
+# if :gitinfos_format = yml and :gitinfos_file = config/version
+# 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"

data/lib/capistrano/gitinfos/gitinfos.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/gitinfos.rake", __FILE__)

data/lib/capistrano/gitinfos/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Gitinfos
+    VERSION = "0.0.2"
+  end
+end

data/lib/capistrano/gitinfos.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'yaml'
+require 'inifile'
+require 'nokogiri'
+require 'active_support/time'
+require "capistrano/gitinfos/version"
+require "capistrano/gitinfos/gitinfos"
+
+load File.expand_path("../tasks/deploy.rake", __FILE__)
+
+namespace :load do
+  task :defaults do
+    load "capistrano/gitinfos/defaults.rb"
+  end
+end

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,5 @@
+namespace :deploy do
+  task :set_current_revision do
+    invoke "gitinfos:set_version_infos"
+  end
+end

data/lib/capistrano/tasks/gitinfos.rake

@@ -0,0 +1,65 @@
+def getGitInfos(commit)
+    rawCommitDate = capture(:git, "log -1 --pretty=tformat:'{%ci}' --no-color --date=local #{commit}").slice(/\{(.+)\}/,1).sub(/\s/, 'T').sub(/\s/, '')
+    abbrevCommit = capture(:git, "rev-list --max-count=1 --abbrev-commit #{commit}")
+    fullCommit = capture(:git, "rev-list --max-count=1 --no-abbrev-commit #{commit}")
+    version = capture(:git, "describe --tag #{commit}")
+
+    if version.empty?
+        version = abbrevCommit
+    end
+
+    deployDate = Time.strptime(release_timestamp, "%Y%m%d%H%M%S").in_time_zone
+    commitDate = Time.strptime(rawCommitDate, "%Y-%m-%dT%H:%M:%S%z").in_time_zone
+
+    return {
+        'version' => version,
+        'abbrev_commit' => abbrevCommit,
+        'full_commit' => fullCommit,
+        'commit_date' => commitDate.strftime('%FT%T%z'),
+        'commit_timestamp' => commitDate.strftime('%s'),
+        'deploy_date' => deployDate.strftime('%FT%T%z'),
+        'deploy_timestamp' => deployDate.strftime('%s'),
+    }
+end
+
+def formatGitInfos(infos, format)
+    case format
+        when "yml"
+            return YAML.dump(infos)
+
+        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)}"
+                end
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-gitinfos
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Charles Sanquer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fetch extra git commit informations and storing in a INI/JSON/XML/YML
+  file when deploying with Capstrano 3.
+email:
+- csanquer@kilix.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-gitinfos.gemspec
+- lib/capistrano-gitinfos.rb
+- lib/capistrano/gitinfos.rb
+- lib/capistrano/gitinfos/defaults.rb
+- lib/capistrano/gitinfos/gitinfos.rb
+- lib/capistrano/gitinfos/version.rb
+- lib/capistrano/tasks/deploy.rake
+- lib/capistrano/tasks/gitinfos.rake
+homepage: http://rubygems.org/gems/capistrano-gitinfos
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Fetch git commit informations when deploying with Capistrano 3.
+test_files: []