falkorlib 0.1.0 → 0.2.8

data/lib/falkorlib/git/flow.rb

@@ -0,0 +1,120 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Jeu 2014-06-19 18:14 svarrette>
+################################################################################
+# Management of Git Flow operations
+
+require "falkorlib"
+require "falkorlib/common"
+require "falkorlib/git/base"
+
+include FalkorLib::Common
+
+module FalkorLib
+    module Config
+
+        # Default configuration for Gitflow
+        module GitFlow
+            # git flow defaults
+            DEFAULTS = {
+                :branches => {
+                    :master     => 'production',
+                    :develop    => 'master',
+                },
+                :prefix => {
+                    :feature    => 'feature/',
+                    :release    => 'release/',
+                    :hotfix     => 'hotfix/',
+                    :support    => 'support/',
+                    :versiontag => "v",
+                }
+            }
+        end
+    end
+
+
+    # Management of [git flow](https://github.com/nvie/gitflow) operations I'm
+    # using everywhere
+    module GitFlow
+
+        module_function
+
+        ## Initialize a git-flow repository
+        def init(path = Dir.pwd)
+            exit_status = FalkorLib::Git.init(path)
+            error "you shall install git-flow: see https://github.com/nvie/gitflow/wiki/Installation" unless command?('git-flow')
+            remotes      = FalkorLib::Git.remotes(path)
+            git_root_dir = FalkorLib::Git.rootdir( path )
+            Dir.chdir( git_root_dir ) do
+                unless FalkorLib::Git.has_commits?( git_root_dir)
+	                warn "Not yet any commit detected in this repository."
+	                readme = 'README.md'
+	                answer = ask(cyan("=> Shall one be initiated with a #{readme} file (Y|n)?"), 'Yes')
+	                exit 0 if answer =~ /n.*/i
+	                FileUtils.touch(readme)
+	                FalkorLib::Git.add(readme, "Initiate the repository with a '#{readme}' file")
+                end
+		        branches     = FalkorLib::Git.list_branch(path)
+                if remotes.include?( 'origin' )
+                    info "=> configure remote (tracked) branches"
+                    exit_status = FalkorLib::Git.fetch(path)
+                    FalkorLib.config.gitflow[:branches].each do |type,branch|
+                        if branches.include? "remotes/origin/#{branch}"
+                            exit_status = FalkorLib::Git.grab(branch, path)
+                        else
+                            unless branches.include? branch
+                                info "Creating the branch '#{branch}'"
+                                FalkorLib::Git.create_branch( branch, path )
+                            end
+                            exit_status = FalkorLib::Git.publish(branch, path )
+                        end
+                    end
+                else
+                    FalkorLib.config.gitflow[:branches].each do |type, branch|
+                        unless branches.include? branch
+                            info "creating the branch '#{branch}'"
+                            exit_status = FalkorLib::Git.create_branch( branch, path )
+                        end
+                    end
+                end
+                info "Initialize git flow configs"
+                FalkorLib.config.gitflow[:branches].each do |t,branch|
+                    exit_status = execute "git config gitflow.branch.#{t} #{branch}"
+                end
+                FalkorLib.config.gitflow[:prefix].each do |t,prefix|
+                    exit_status = execute "git config gitflow.prefix.#{t} #{prefix}"
+                end
+            end
+	        exit_status
+        end
+
+
+        ## generic function to run any of the gitflow commands
+        def command(name, type = 'feature', action = 'start', path = Dir.pwd, optional_args = '')
+            error "Invalid git-flow type '#{type}'" unless ['feature', 'release', 'hotfix', 'support'].include?(type)
+            error "Invalid action '#{action}'" unless ['start', 'finish'].include?(action)
+            error "You must provide a name" if name == ''
+            error "The name '#{name}' cannot contain spaces" if name =~ /\s+/
+            exit_status = 1
+            Dir.chdir( FalkorLib::Git.rootdir(path) ) do
+		        exit_status = run %{ 
+                   git flow #{type} #{action} #{optional_args} #{name} 
+                }
+            end
+            exit_status
+        end
+
+        ## git flow {feature, hotfix, release, support} start <name>
+        def start (type, name, path = Dir.pwd, optional_args = '')
+            command(name, type, 'start', path, optional_args)
+        end
+
+        ## git flow {feature, hotfix, release, support} finish <name>
+        def finish (type, name, path = Dir.pwd, optional_args = '')
+            command(name, type, 'finish', path, optional_args)
+        end
+
+
+    end # module FalkorLib::GitFlow
+
+end

data/lib/falkorlib/git_tasks.rb

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Sam 2014-06-14 00:05 svarrette>
+################################################################################
+#
+# FalkorLib rake tasks to pilot Git [flow] operations
+#
+
+require 'rake'
+require 'falkorlib'
+require 'falkorlib/tasks'
+
+module FalkorLib #:nodoc:
+
+    # Rake tasks to pilot Git operations
+    class GitTasks
+        include Rake::DSL if defined? Rake::DSL
+
+        # Install the git[flow] tasks for Rake
+        def install_tasks
+            load 'falkorlib/tasks/git.rake'
+            load 'falkorlib/tasks/gitflow.rake'
+        end
+    end # class FalkorLib::GitTasks
+end # module FalkorLib
+
+
+if FalkorLib::Git.init?
+    # Now install them ;)
+    FalkorLib::GitTasks.new.install_tasks
+else
+    warn "Git is not initialized for this directory."
+    warn "==> consider running 'rake git[:flow]:init' to be able to access the regular git Rake tasks"
+    #.....................
+    namespace :git do
+        ###########  git:init   ###########
+        desc "Initialize Git repository"
+        task :init do
+            FalkorLib::Git.init
+        end
+
+        #.....................
+        namespace :flow do
+            ###########  git:flow:init   ###########
+            desc "Initialize Git-flow repository"
+            task :init do
+                FalkorLib::GitFlow.init
+            end
+        end # namespace git:flow
+
+
+
+    end # namespace git
+
+
+end

data/lib/falkorlib/loader.rb

@@ -1,3 +1,11 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Mer 2014-06-18 17:17 svarrette>
+################################################################################
+# Place the component you wish to see loaded  
 
+require "falkorlib/config"
 require "falkorlib/common"
-require "falkorlib/gitflow"
+require "falkorlib/git"
+require "falkorlib/versioning"
+

data/lib/falkorlib/tasks.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Jeu 2014-06-12 16:36 svarrette>
+################################################################################
+#
+# Default FalkorLib rake tasks
+#
+
+require 'rake'
+require 'yaml'
+
+#Needed for rake/gem '= 0.9.2.2'
+Rake::TaskManager.record_task_metadata = true
+
+FalkorLib.config.debug = ARGV.include?('DEBUG')
+
+#.....................
+namespace :falkorlib do
+	###########  falkorlib:conf   ###########
+	desc "Print the current configuration of FalkorLib"
+	task :conf do
+		puts FalkorLib.config.to_yaml
+	end 
+end # namespace falkorlib<
+
+
+# Empty task debug 
+task :DEBUG do
+end
+

data/lib/falkorlib/tasks/git.rake

@@ -0,0 +1,121 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# git.rake - Special tasks for the management of Git operations
+# Time-stamp: <Jeu 2014-06-19 18:19 svarrette>
+#
+# Copyright (c) 2014 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+#               http://varrette.gforge.uni.lu
+################################################################################
+
+require 'falkorlib'
+require 'falkorlib/tasks'
+require 'falkorlib/git'
+
+#.....................
+namespace :git do
+
+    include FalkorLib::Common
+    git_root_dir = FalkorLib::Git.rootdir
+    remotes = FalkorLib::Git.remotes
+    #ap remotes
+
+    ###########   git:fetch   ###########
+    desc "Fetch the latest changes on remotes"
+    task :fetch do |t|
+        info t.comment
+        FalkorLib::Git.fetch()
+    end # task fetch
+
+    [ 'up', 'push' ].each do |op|
+
+        description = case op
+                      when 'up';   "Update your local copy of the repository from GIT server"
+                      when 'push'; "Push your modifications onto the remote branches"
+                      end
+		###########  git:{up,push}  ###########
+        desc "#{description}"
+        task op.to_sym do |t|
+            info t.comment
+            if remotes.empty? || ! remotes.include?( 'origin' )
+                warn "No git remote configured... Exiting #{t}"
+                next
+            end
+            cmd = ( op == 'up') ? 'pull' : op 
+			branch   = FalkorLib::Git.branch?
+			if FalkorLib::Git.list_branch.include? "remotes/origin/#{branch}"
+				status = run %{ 
+                      git #{cmd} origin
+                }
+				if (status.to_i != 0)
+					warn("The command '#{cmd}' failed with exit status #{status.to_i}")
+					warn("This may be due to the fact that you're not connected to the internet")
+					really_continue?('no')
+				end
+			else 
+				warn "The current branch '#{branch} is not currently tracked on the remote 'origin'."
+				warn "=> exiting"
+				next
+			end 
+        end 
+    end
+
+    unless FalkorLib.config.git[:submodules].empty?
+        #.....................
+        namespace :submodules do
+            ###########   init   ###########
+            desc "Initialize the Git subtrees defined in FalkorLib.config.git.submodules"
+            task :init do |t|
+                info t.full_comment
+                FalkorLib::Git.submodule_init(git_root_dir)
+            end # task submodules:init
+
+
+        end # namespace submodules
+    end
+
+    if File.exists?("#{git_root_dir}/.gitmodules")
+        #.....................
+        namespace :submodules do
+
+            ########### git:submodules:update ###########
+            desc "Update the git submodules from '#{git_root_dir}'"
+            task :update do |t|
+                info t.comment
+                FalkorLib::Git.submodule_update( git_root_dir )
+            end
+
+            ########### git:submodules:upgrade ###########
+            desc "Upgrade the git submodules to the latest HEAD commit -- USE WITH CAUTION"
+            task :upgrade => [ :update] do |t|
+                info t.comment
+                FalkorLib::Git.submodule_upgrade( git_root_dir )
+            end
+        end # namespace git:submodules
+    end
+
+    unless FalkorLib.config.git[:subtrees].empty?
+        #.....................
+        namespace :subtrees do
+            ###########   git:subtrees:init  ###########
+            desc "Initialize the Git subtrees defined in FalkorLib.config.git.subtrees"
+            task :init do
+                FalkorLib::Git.subtree_init(git_root_dir)
+            end # task git:subtree:init
+
+            ###########   git:subtrees:diff   ###########
+            desc "Show difference between local subtree(s) and their remotes"
+            task :diff do
+                FalkorLib::Git.subtree_diff(git_root_dir)
+            end # task git:subtree:diff
+
+            ###########   git:subtrees:up   ###########
+            desc "Pull the latest changes from the remote to the local subtree(s)"
+            task :up do
+                FalkorLib::Git.subtree_up(git_root_dir)
+            end # task git:subtree:diff
+
+
+        end # namespace git:subtrees
+    end
+
+end # namespace git

data/lib/falkorlib/tasks/git.rb

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Sam 2014-06-14 00:05 svarrette>
+################################################################################
+#
+# FalkorLib rake tasks to pilot Git [flow] operations
+#
+
+require 'rake'
+require 'falkorlib'
+require 'falkorlib/tasks'
+
+module FalkorLib #:nodoc:
+
+    # Rake tasks to pilot Git operations
+    class GitTasks
+        include Rake::DSL if defined? Rake::DSL
+
+        # Install the git[flow] tasks for Rake
+        def install_tasks
+            load 'falkorlib/tasks/git.rake'
+            load 'falkorlib/tasks/gitflow.rake'
+        end
+    end # class FalkorLib::GitTasks
+end # module FalkorLib
+
+
+if FalkorLib::Git.init?
+    # Now install them ;)
+    FalkorLib::GitTasks.new.install_tasks
+else
+    warn "Git is not initialized for this directory."
+    warn "==> consider running 'rake git[:flow]:init' to be able to access the regular git Rake tasks"
+    #.....................
+    namespace :git do
+        ###########  git:init   ###########
+        desc "Initialize Git repository"
+        task :init do
+            FalkorLib::Git.init
+        end
+
+        #.....................
+        namespace :flow do
+            ###########  git:flow:init   ###########
+            desc "Initialize Git-flow repository"
+            task :init do
+                FalkorLib::GitFlow.init
+            end
+        end # namespace git:flow
+
+
+
+    end # namespace git
+
+
+end

data/lib/falkorlib/tasks/gitflow.rake

@@ -0,0 +1,139 @@
+################################################################################
+# gitflow.rake - Special tasks for the management of Git [Flow] operations
+# Time-stamp: <Jeu 2014-06-19 18:53 svarrette>
+#
+# Copyright (c) 2014 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+#               http://varrette.gforge.uni.lu
+################################################################################
+
+require 'falkorlib'
+require 'falkorlib/tasks'
+require 'falkorlib/git'
+
+#.....................
+namespace :git do
+
+    include FalkorLib::Common
+    git_root_dir = FalkorLib::Git.rootdir
+
+    #.....................
+    namespace :flow do
+
+        ###########   git:flow:init   ###########
+        desc "Initialize your local clone of the repository for the git-flow management"
+        task :init do |t|
+            FalkorLib::GitFlow.init(git_root_dir)
+        end # task init
+
+    end # namespace git::flow
+
+    #.....................
+    namespace :feature do
+
+        #########   git:feature:start ##########################
+        desc "Start a new feature operation on the repository using the git-flow framework"
+        task :start, [:name] do |t, args|
+            #args.with_default[:name => '']
+            name = args.name == 'name' ? ask("Name of the feature (the git branch will be 'feature/<name>')") : args.name
+            info t.comment + " with name 'feature/#{name}'"
+            really_continue?
+            Rake::Task['git:up'].invoke unless FalkorLib::Git.remotes.empty?
+            info "=> prepare new 'feature' using git flow"
+            o = FalkorLib::GitFlow.start('feature', name)
+			error "Git flow feature operation failed" unless o == 0
+            # Now you should be in the new branch
+        end
+
+        #########   git:feature:finish ##########################
+        desc "Finalize the feature operation"
+        task :finish do |t|
+            branch = FalkorLib::Git.branch?
+            expected_branch_prefix = FalkorLib.config.gitflow[:prefix][:feature]
+            if branch !~ /^#{expected_branch_prefix}/
+                error "You are not in the expected branch (with prefix '#{expected_branch_prefix}')"
+            end
+            name = branch.sub(/^#{expected_branch_prefix}/, '')
+            info t.comment
+            o = FalkorLib::GitFlow.finish('feature', name)
+            error "Git flow feature operation failed" unless o == 0
+			unless FalkorLib::Git.remotes.empty?
+                info "=> about to update remote tracked branches"
+                really_continue?
+                Rake::Task['git:push'].invoke
+            end
+        end
+    end # End namespace 'git:feature'
+
+end # namespace git
+
+
+#.....................
+namespace :version do
+
+    ###########   version:info   ###########
+    desc "Get versioning information"
+    task :info do |t|
+        include FalkorLib::Versioning
+        version = get_version
+        #major, minor, patch =  bump(version, :major), bumpversion, :minor), bump(version, :patch)
+        info t.comment
+        puts "Current version: " + bold(version)
+        FalkorLib.config[:versioning][:levels].reverse.each do |level|
+            puts "- next #{level} version: " + bump(version, level.to_sym)
+        end
+    end # task info
+
+
+    #.....................
+    namespace :bump do
+        [ 'major', 'minor', 'patch' ].each do |level|
+
+            #################   version:bump:{major,minor,patch} ##################################
+            desc "Prepare the #{level} release of the repository"
+            task level.to_sym do |t|
+                version = FalkorLib::Versioning.get_version
+                release_version = FalkorLib::Versioning.bump(version, level.to_sym)
+                info t.comment + " (from version '#{version}' to '#{release_version}')"
+                really_continue?
+                Rake::Task['git:up'].invoke unless FalkorLib::Git.remotes.empty?
+                info "=> prepare release using git flow"
+                o = FalkorLib::GitFlow.start('release', release_version)
+				error "Git flow release process failed" unless o == 0
+                # Now you should be in the new branch
+                current_branch = FalkorLib::Git.branch?
+                expected_branch = FalkorLib.config[:gitflow][:prefix][:release] + release_version
+                if (current_branch == expected_branch)
+                    FalkorLib::Versioning.set_version(release_version)
+                    warning "The version number has already been bumped"
+                    warning "==> run 'rake version:release' to finalize the release and merge the current version of the repository into the '#{FalkorLib.config[:gitflow][:branches][:master]}' branch"
+                else
+                    error "You are in the '#{branch}' branch and not the expected one, i.e. #{expected_branch}"
+                end
+            end
+        end
+    end # namespace version:bump
+
+	###########   release   ###########
+	desc "Finalize the release of a given bumped version"
+	task :release do |t|
+		version = FalkorLib::Versioning.get_version
+		branch  = FalkorLib::Git.branch?
+		expected_branch = FalkorLib.config[:gitflow][:prefix][:release] + version
+		error "You are not in the '#{expected_branch}' branch but in the '#{branch}' one. May be you forgot to run 'rake version:bump:{patch,minor,major}' first" if branch != expected_branch
+		info "=> Finalize the release of the version '#{version}' into the '#{FalkorLib.config[:gitflow][:branches][:master]}' branch/environment"
+		o = FalkorLib::GitFlow.finish('release', version, Dir.pwd, '-s')
+		error "Git flow release process failed" unless o == 0
+		info("=> about to update remote tracked branches")
+		really_continue?
+		FalkorLib.config[:gitflow][:branches].each do |type, branch|
+			run %{ 
+               git checkout #{branch} 
+               git push origin
+            }
+		end
+		#Rake::Task['git:push'].invoke
+	end # task version:release 
+
+
+
+end # namespace version