falkorlib 0.1.0

data/Rakefile

@@ -0,0 +1,45 @@
+##############################################################################
+# Rakefile - Configuration file for rake (http://rake.rubyforge.org/)
+# Time-stamp: <Lun 2014-06-02 14:58 svarrette>
+#
+# Copyright (c) 2012 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+# .             http://varrette.gforge.uni.lu
+#                       ____       _         __ _ _
+#                      |  _ \ __ _| | _____ / _(_) | ___
+#                      | |_) / _` | |/ / _ \ |_| | |/ _ \
+#                      |  _ < (_| |   <  __/  _| | |  __/
+#                      |_| \_\__,_|_|\_\___|_| |_|_|\___|
+#
+# Use 'rake -T' to list the available actions
+#
+# Resources:
+# * http://www.stuartellis.eu/articles/rake/
+##############################################################################
+require "bundler/gem_tasks"
+
+
+# We run tests by default
+task :default => :test
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+RAKE_TASKS_TO_LOAD = [
+                      #'debug_mail.rake',
+                      'gem.rake',
+                      'spec_test.rake',
+                      #'unit_test.rake',
+                      'yard.rake'
+                     ] 
+
+Dir["tasks/*.rake"].each do |taskfile|
+	next unless RAKE_TASKS_TO_LOAD.include?(taskfile.gsub(/.*tasks\//, ''))
+	load taskfile
+end
+
+desc "clean the directory"
+task :clean => :clobber_package do
+	sh "rm -rf doc" if File.directory?("doc")
+end

data/falkorlib.gemspec

@@ -0,0 +1,207 @@
+# -*- coding: utf-8 -*-
+# We require your library, mainly to have access to the VERSION number.
+# Feel free to set $version manually.
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require "falkorlib/version"
+$version = FalkorLib::Version.to_s
+
+#
+# This is your Gem specification. Default values are provided so that your library
+# should be correctly packaged given what you have described in the .noespec file.
+#
+Gem::Specification.new do |s|
+
+    ################################################################### ABOUT YOUR GEM
+
+    # Gem name (required)
+    s.name = "falkorlib"
+
+    # Gem version (required)
+    s.version = $version
+
+    # A short summary of this gem
+    #
+    # This is displayed in `gem list -d`.
+    s.summary = "Sebastien Varrette aka Falkor's Common library to share Ruby code and {rake,cap} tasks"
+
+    # A long description of this gem (required)
+    #
+    # The description should be more detailed than the summary.  For example,
+    # you might wish to copy the entire README into the description.
+    s.description = "This is my personal library I use to share the Ruby tidbits, Rake and Capistrano tasks I made for my various projects. \nThis is also my first gem so any comments on the code/organization are welcome, I'm a newbie in this domain. \nNote that I used [Noe](https://github.com/blambeau/noe) to bootstrap this project and get a fully documented environment."
+
+    # The URL of this gem home page (optional)
+    s.homepage = "https://github.com/Falkor/falkorlib"
+
+    # Gem publication date (required but auto)
+    #
+    # Today is automatically used by default, uncomment only if
+    # you know what you do!
+    #
+    # s.date = Time.now.strftime('%Y-%m-%d')
+
+    # The license(s) for the library.  Each license must be a short name, no
+    # more than 64 characters.
+    #
+	s.licenses    = ['MIT']
+
+    # The rubyforge project this gem lives under (optional)
+    #
+    # s.rubyforge_project = nil
+
+    ################################################################### ABOUT THE AUTHORS
+
+    # The list of author names who wrote this gem.
+    #
+    # If you are providing multiple authors and multiple emails they should be
+    # in the same order.
+    #
+    s.authors = ["Sebastien Varrette"]
+
+    # Contact emails for this gem
+    #
+    # If you are providing multiple authors and multiple emails they should be
+    # in the same order.
+    #
+    # NOTE: Somewhat strangly this attribute is always singular!
+    #       Don't replace by s.emails = ...
+    s.email  = ["Sebastien.Varrette@uni.lu"]
+
+    ################################################################### PATHS, FILES, BINARIES
+
+    # Paths in the gem to add to $LOAD_PATH when this gem is
+    # activated (required).
+    #
+    # The default 'lib' is typically sufficient.
+    s.require_paths = ["lib"]
+
+    # Files included in this gem.
+    #
+    # By default, we take all files included in the .Manifest.txt file on root
+    # of the project. Entries of the manifest are interpreted as Dir[...]
+    # patterns so that lazy people may use wilcards like lib/**/*
+    #
+    here = File.expand_path(File.dirname(__FILE__))
+    s.files = File.readlines(File.join(here, '.Manifest.txt')).
+        inject([]){|files, pattern| files + Dir[File.join(here, pattern.strip)]}.
+        collect{|x| x[(1+here.size)..-1]}
+
+    # Test files included in this gem.
+    #
+    s.test_files = Dir["test/**/*"] + Dir["spec/**/*"]
+
+	# Alternative: 
+	#s.files         = `git ls-files`.split("\n")
+	#s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+	#s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  
+
+
+
+    # The path in the gem for executable scripts (optional)
+    #
+    #s.bindir = "bin"
+
+    # Executables included in the gem.
+    #
+    #s.executables = (Dir["bin/*"]).collect{|f| File.basename(f)}
+
+    ################################################################### REQUIREMENTS & INSTALL
+    # Remember the gem version requirements operators and schemes:
+    #   =  Equals version
+    #   != Not equal to version
+    #   >  Greater than version
+    #   <  Less than version
+    #   >= Greater than or equal to
+    #   <= Less than or equal to
+    #   ~> Approximately greater than
+    #
+    # Don't forget to have a look at http://lmgtfy.com/?q=Ruby+Versioning+Policies
+    # for setting your gem version.
+    #
+    # For your requirements to other gems, remember that
+    #   ">= 2.2.0"              (optimistic:  specify minimal version)
+    #   ">= 2.2.0", "< 3.0"     (pessimistic: not greater than the next major)
+    #   "~> 2.2"                (shortcut for ">= 2.2.0", "< 3.0")
+    #   "~> 2.2.0"              (shortcut for ">= 2.2.0", "< 2.3.0")
+    #
+	#s.add_dependency("rake", ">= 10.1.0")
+	s.add_runtime_dependency 'rake', '~> 10.1', '>= 10.1.0'
+	s.add_runtime_dependency 'git_remote_branch', '~> 0'
+	#s.add_dependency("git_remote_branch")
+	s.add_runtime_dependency 'git', '~> 1.2', '>= 1.2.5'
+	s.add_dependency("term-ansicolor", "~> 1.3")
+
+    #
+    # One call to add_dependency('gem_name', 'gem version requirement') for each
+    # runtime dependency. These gems will be installed with your gem.
+    # One call to add_development_dependency('gem_name', 'gem version requirement')
+    # for each development dependency. These gems are required for developers
+    #
+    #s.add_development_dependency("rake",           ">= 10.1.0") #"~> 0.9.2")
+    s.add_development_dependency("bundler",        "~> 1.0")
+	s.add_development_dependency 'rspec', '~> 2.7', '>= 2.7.0'
+	s.add_development_dependency("pry",    "~> 0.9")
+    s.add_development_dependency("yard",   "~> 0.8")
+	s.add_development_dependency("awesome_print", "~> 1.2")
+    #s.add_development_dependency("bluecloth",      "~> 2.2.0")
+    #s.add_development_dependency("wlang",          "~> 0.10.2")
+
+
+    # The version of ruby required by this gem
+    #
+    # Uncomment and set this if your gem requires specific ruby versions.
+    #
+    # s.required_ruby_version = ">= 0"
+
+    # The RubyGems version required by this gem
+    #
+    # s.required_rubygems_version = ">= 0"
+
+    # The platform this gem runs on.  See Gem::Platform for details.
+    #
+    # s.platform = nil
+
+    # Extensions to build when installing the gem.
+    #
+    # Valid types of extensions are extconf.rb files, configure scripts
+    # and rakefiles or mkrf_conf files.
+    #
+    s.extensions = []
+
+    # External (to RubyGems) requirements that must be met for this gem to work.
+    # It’s simply information for the user.
+    #
+    s.requirements = nil
+
+    # A message that gets displayed after the gem is installed
+    #
+    # Uncomment and set this if you want to say something to the user
+    # after gem installation
+    #
+    s.post_install_message = "Thanks for installing FalkorLib.\n"
+
+    ################################################################### SECURITY
+
+    # The key used to sign this gem.  See Gem::Security for details.
+    #
+    #s.signing_key = "0xDD01D5C0"
+
+    # The certificate chain used to sign this gem.  See Gem::Security for
+    # details.
+    #
+    # s.cert_chain = []
+
+    ################################################################### RDOC
+
+    # An ARGV style array of options to RDoc
+    #
+    # See 'rdoc --help' about this
+    #
+    s.rdoc_options = []
+
+    # Extra files to add to RDoc such as README
+    #
+    s.extra_rdoc_files = Dir["README.md"] + Dir["CHANGELOG.md"] + Dir["LICENCE.md"]
+
+end

data/lib/falkorlib.rb

@@ -0,0 +1,10 @@
+#
+# Sebastien Varrette aka Falkor's Common library to share Ruby code and `{rake,cap}` tasks
+#
+module FalkorLib
+
+end # module FalkorLib
+
+require "falkorlib/version"
+require "falkorlib/loader"
+require "falkorlib/common"

data/lib/falkorlib/common.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/ruby
+
+### Configure colors ###
+begin
+    require 'term/ansicolor'
+    COLOR = true
+rescue Exception => e
+    puts "/!\\ cannot find the 'term/ansicolor' library"
+    puts "    Consider installing it by 'gem install term-ansicolor'"
+    COLOR = false
+end
+
+require 'yaml'
+
+module FalkorLib
+    module Common
+	    module_function
+        ##################################
+        ### Default printing functions ###
+        ##################################
+
+        # Print a text in green
+        def green(str)
+            COLOR == true ? Term::ANSIColor.green(str) : str
+        end
+
+        # Print a text in red
+        def red(str)
+            COLOR == true ? Term::ANSIColor.red(str) : str
+        end
+
+        # Print a text in cyan
+        def cyan(str)
+            COLOR == true ? Term::ANSIColor.cyan(str) : str
+        end
+
+        # Print an info message
+        def info(str)
+            puts green("[INFO] " + str)
+        end
+
+        # Print an warning message
+        def warning(str)
+            puts cyan("/!\\ WARNING: " + str)
+        end
+        def warn(str)
+            warning(str)
+        end
+        ## Print an error message and abort
+        def error(str)
+            #abort red("*** ERROR *** " + str)
+	        $stderr.puts red("*** ERROR *** " + str)
+	        exit 1
+        end
+        def not_implemented()
+            error("NOT YET IMPLEMENTED")
+        end
+
+        ##############################
+        ### Interaction functions  ###
+        ##############################
+
+        ## Ask a question
+        def ask(question, default_answer='')
+            print "#{question} "
+            print "[Default: #{default_answer}]" unless default_answer == ''
+            print ": "
+            STDOUT.flush
+            answer = STDIN.gets.chomp
+            return answer.empty?() ? default_answer : answer
+        end
+
+        ## Ask whether or not to really continue
+        def really_continue?(default_answer = 'Yes')
+            pattern = (default_answer =~ /yes/i) ? '(Y|n)' : '(y|N)'
+            answer = ask( cyan("=> Do you really want to continue #{pattern}?"), default_answer)
+            exit 0 if answer =~ /n.*/i
+        end
+
+        ############################
+        ### Execution  functions ###
+        ############################
+
+        ## Check for the presence of a given command
+        def command?(name)
+	        `which #{name}`
+	        $?.success?
+        end
+
+        ## Execute a given command - exit if status != 0
+        def execute(cmd)
+	        sh %{#{cmd}} do |ok, res|
+		        if ! ok
+			        error("The command '#{cmd}' failed with exit status #{res.exitstatus}")
+		        end
+	        end
+        end
+
+        ## "Nice" way to present run commands
+        ## Ex: run %{ hostname -f }
+        def run(cmds)
+	        puts bold("[Running]\n#{cmds.gsub(/^\s*/, '   ')}")
+	        #puts cmds.split(/\n */).inspect
+	        cmds.split(/\n */).each do |cmd|
+		        next if cmd.empty?
+		        system("#{cmd}") unless DEBUG
+	        end
+        end
+
+        ###############################
+        ### YAML File loading/store ###
+        ###############################
+
+        # Return the yaml content as a Hash object
+        def load_config(filepath)
+	        YAML::load_file(filepath)
+        end
+
+        # Store the Hash object as a Yaml file
+        def store_config(filepath, hash)
+	        File.open( filepath, 'w') do |f|
+		        f.print "# ", File.basename(filepath), "\n"
+		        f.puts "# /!\\ DO NOT EDIT THIS FILE: it has been automatically generated"
+		        f.puts hash.to_yaml
+	        end
+        end
+
+
+    end
+end

data/lib/falkorlib/gitflow.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby
+
+require 'falkorlib/common'
+require 'git'
+
+module FalkorLib
+
+    class GitFlow < Git::Base
+
+        @@config = {
+            :master     => 'production',
+            :develop    => 'master',
+            :feature    => 'feature/',
+            :release    => 'release/',
+            :hotfix     => 'hotfix/',
+            :support    => 'support/',
+            :versiontag => "v",
+        }
+
+
+        def initialize(base = nil, options = {})
+            # @logger = options[:logger] || Logger.new(STDOUT)
+            options.each do |k,v|
+                self.config_set(k, v) if @@config.has_key?(k.to_sym)
+            end
+            #puts @@config.inspect
+        end
+
+        # def self.method_missing(sym, *args, &block)
+        #     @@config[sym.to_s]
+        # end
+
+        def self.global_config(opt)
+            @@config[opt.to_sym]
+        end
+
+        def self.config_set(opt, value)
+            @@config[opt.to_sym] = value
+        end
+
+        # initializes a git flow repository
+        # options:
+        #  :repository
+        #  :index_file
+        #
+        def self.init(working_dir, opts = {})
+	        super
+	        g = Git.open(working_dir)
+
+	        config = @@config
+	        @@config.keys.each do |k| 
+		        config[k.to_sym] = opts[k.to_sym] if opts.has_key?(k.to_sym)
+	        end
+
+            # Now update the local config for gitflow
+            g.config('gitflow.branch.master',     config[:master])
+            g.config('gitflow.branch.develop',    config[:develop])
+            g.config('gitflow.prefix.feature',    config[:feature])
+            g.config('gitflow.prefix.release',    config[:release])
+            g.config('gitflow.prefix.hotfix',     config[:hotfix])
+            g.config('gitflow.prefix.support',    config[:support])
+            g.config('gitflow.prefix.versiontag', config[:versiontag])
+
+	        g.lib.send('command', 'flow init -d')
+        end
+
+
+
+
+    end # End Falkorlib::GitFlow
+end