falkorlib 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 844b9104ffcc2838a8b9176658a6ee5b3db82e77
-  data.tar.gz: 918eab8d5e9945fcbc71beeb80d18c3eb2c3a6ae
+  metadata.gz: be6b7e9b76a06c18709b775c77d17e487e318cbd
+  data.tar.gz: 7ba5fa7986575faea59f5c26d085c5f953f444d1
 SHA512:
-  metadata.gz: 204b9fd452435462ee29119978f0747a65138ee6474b546c7a56b76bcc6c8b00c2c60560b8bc7d6ff817ac56829d314551220c54f18a6fde49852189a217ef45
-  data.tar.gz: 264f60f7e3cc56122815f4e0017cb2b55bf741978710f7c70b61d7f3ec25e541e0e2307e3f7594d085bca9ae639d8c3dc2698890fb04c5814f7ea53ec0651824
+  metadata.gz: 91aeab1807f5b5bbdc057bebe6430d686bbd0471985afa9ef89de425ea8e03530912d0b450fc84092d84ec6e2529c7bebc4a404476ec2a5e36b79fa703e7ac28
+  data.tar.gz: 079ed9bf07a7a96afc217af7e4b66b75e3ada0d595197ed4cede9c043750fbe4b7233016942125d3db1ce5f003ea6f2ec23b066516dced0dfa711bc2d0f90f42

data/.gitignore

@@ -10,3 +10,5 @@ doc/api
 tmp/
 *.noespec
 /.falkorlib.yaml
+/lib/falkorlib/thor.old/
+/.falkor/

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    falkorlib (0.4.0)
+    falkorlib (0.4.1)
       awesome_print (~> 1.2)
       configatron (~> 3.2)
+      deep_merge (~> 1.0.1)
       diffy (>= 3.0)
       git_remote_branch (~> 0)
       json (~> 1.8)
@@ -24,6 +25,7 @@ GEM
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     configatron (3.2.0)
+    deep_merge (1.0.1)
     diff-lcs (1.1.3)
     diffy (3.0.7)
     docile (1.1.5)

data/falkorlib.gemspec

@@ -132,6 +132,7 @@ Gem::Specification.new do |s|
 	s.add_runtime_dependency("awesome_print", "~> 1.2")
 	s.add_runtime_dependency("json", "~> 1.8")
 	s.add_runtime_dependency("license-generator", '~> 0')
+	s.add_runtime_dependency("deep_merge", '~> 1.0.1')
 	s.add_runtime_dependency("diffy", '>= 3.0')
 	s.add_runtime_dependency("logger", '>= 1.2.8')
     s.add_runtime_dependency("thor",      '>= 0.19')

data/lib/falkorlib/bootstrap/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Ven 2015-01-23 00:12 svarrette>
+# Time-stamp: <Dim 2015-02-01 14:43 svarrette>
 ################################################################################
 # Interface for the main Bootstrapping operations
 #
@@ -17,14 +17,27 @@ module FalkorLib  #:nodoc:
         module Bootstrap
             DEFAULTS =
               {
+               :metadata => {
+                             :name         => '',
+                             :version      => '0.0.1',
+                             :author       => "#{ENV['GIT_AUTHOR_NAME']}",
+                             :mail         => "#{ENV['GIT_AUTHOR_EMAIL']}",
+                             :summary      => "rtfm",
+                             :description  => '',
+                             :source       => '',
+                             :project_page => '',
+                             :issues_url   => '',
+                             :tags         => []
+                            },
                :trashdir => '.Trash',
                :types    => [ 'article', 'slides', 'gem', 'octopress', 'puppet_module', 'rvm' ],
-               :rvm => {
-                        :version     => '1.9.3',
-                        :versionfile => '.ruby-version',
-                        :gemsetfile  => '.ruby-gemset'
-                       },
                :puppet   => {},
+               :forge => {
+                          :gforge => { :url => 'http://gforge.uni.lu', :name => 'GForge @ Uni.lu' },
+                          :github => { :url => 'http://github.com',    :name => 'Github', :login => 'ULHPC' },
+                          :gitlab => { :url => 'http://gitlab.uni.lu', :name => 'Gitlab @ Uni.lu' },
+                          :none   => { :url => '', :name => "None"}
+                         },
               }
 
 
@@ -210,7 +223,8 @@ module FalkorLib
         ###### versionfile ######
         # Bootstrap a VERSION file at the root of a project
         # Supported options:
-        # * :file [string] filename
+        # * :file    [string] filename
+        # * :version [string] version to mention in the file
         ##
         def versionfile(dir = Dir.pwd, options = {})
             file    = options[:file]    ? options[:file]    : 'VERSION'
@@ -225,17 +239,74 @@ module FalkorLib
             end
             versionfile = File.join(path, file)
             unless File.exists?( versionfile )
-                run %{  echo "#{version}" > #{versionfile} }
-                if FalkorLib::Git.init?(path)
-                    FalkorLib::Git.add(versionfile, "Initialize #{file} file")
-                    Dir.chdir( path ) do
-                        run %{ git tag #{options[:tag]} } if options[:tag]
-                    end
+                FalkorLib::Versioning.set_version(version, path, {
+                                                                  :type => 'file',
+                                                                  :source => { :filename => file }
+                                                                 })
+                Dir.chdir( path ) do
+                    run %{ git tag #{options[:tag]} } if options[:tag]
                 end
             else
                 puts "  ... not overwriting the #{file} file which already exists"
             end
+
+            # unless File.exists?( versionfile )
+            #     run %{  echo "#{version}" > #{versionfile} }
+            #     if FalkorLib::Git.init?(path)
+            #         FalkorLib::Git.add(versionfile, "Initialize #{file} file")
+            #         Dir.chdir( path ) do
+            #             run %{ git tag #{options[:tag]} } if options[:tag]
+            #         end
+            #     end
+            # else
+            #     puts "  ... not overwriting the #{file} file which already exists"
+            # end
         end # versionfile
 
+
+        ###### readme ######
+        # Bootstrap a README file for various context
+        # Supported options:
+        #  * :force     [boolean] force overwritting
+        #  * :latex     [boolean] describe a LaTeX project
+        #  * :octopress [boolean] octopress site
+        ##
+        def readme(dir = Dir.pwd, type = 'latex', options = {})
+            info "Bootstrap a README file"
+            #if File.exists?(File.join(dir, ))
+            config = FalkorLib::Config::Bootstrap::DEFAULTS[:metadata].clone
+            config[:filename] = options[:filename] ? options[:filename] : 'README.md'
+            config[:name]     = options[:name] ? options[:name] : File.basename(dir)
+            default_forge     = options[:forge] ? options[:forge] : :github
+            forges = FalkorLib::Config::Bootstrap::DEFAULTS[:forge]
+            case select_forge(default_forge)
+            when :gforge
+                config[:project_page] = forges[:url] + "/projects/"
+            end
+
+
+            # config[:project_page] = case forge
+            #                         when :gforge
+                                        
+            #                         end
+        end # readme
+
+        ###
+        # Select the forge (gforge, github, etc.) hosting the project sources
+        ##
+        def select_forge(default = :gforge, options = {})
+            forge = FalkorLib::Config::Bootstrap::DEFAULTS[:forge]
+            ap forge
+            default_idx = forge.keys.index(default)
+            default_idx = 0 if default_idx.nil? 
+            v = select_from(forge.map{ |k,v| v[:name] },
+                            "Select the Forge hosting the project sources",
+                            default_idx+1,
+                            forge.keys)
+            ap v
+        end # select_forge
+
+
+        
     end # module Bootstrap
 end # module FalkorLib

data/lib/falkorlib/cli/new.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Ven 2015-01-23 00:00 svarrette>
+# Time-stamp: <Ven 2015-01-30 15:20 svarrette>
 ################################################################################
 
 require 'thor'
@@ -88,7 +88,13 @@ These files will be committed in Git to ensure a consistent environment for the
           FalkorLib::Bootstrap.versionfile(path, options)
       end # versionfile
 
-      
+
+      ###### readme ######
+      #......................................
+      desc "readme PATH [options]", "Initiate a README file in the PATH directory"
+      def readme(path = '.')
+          FalkorLib::Bootstrap.readme(path, options)
+      end # readme
     end # class Init
   end # module CLI
 end # module FalkorLib

data/lib/falkorlib/common.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mer 2015-01-21 22:36 svarrette>
+# Time-stamp: <Sam 2015-01-31 23:54 svarrette>
 ################################################################################
 
 require "falkorlib"
@@ -244,8 +244,15 @@ module FalkorLib #:nodoc:
         ###############################
 
         # Return the yaml content as a Hash object
-        def load_config(filepath)
-            YAML::load_file(filepath)
+        def load_config(file)
+            unless File.exists?(file)
+                raise FalkorLib::Error, "Unable to find the YAML file '#{file}'"
+            end
+            loaded = YAML::load_file(file)
+            unless loaded.is_a?(Hash)
+                raise FalkorLib::Error, "Corrupted or invalid YAML file '#{file}'"
+            end
+            loaded
         end
 
         # Store the Hash object as a Yaml file
@@ -273,11 +280,11 @@ module FalkorLib #:nodoc:
         #   :erb_exclude [array of strings]: pattern(s) to exclude from erb file
         #                                    interpretation and thus to copy 'as is'
         #   :no_interaction [boolean]: do not interact
-        def init_from_template(templatedir, rootdir, config = {}, 
+        def init_from_template(templatedir, rootdir, config = {},
                                options = {
-	                               :erb_exclude    => [],
-	                               :no_interaction => false
-                               })
+                                          :erb_exclude    => [],
+                                          :no_interaction => false
+                                         })
             error "Unable to find the template directory" unless File.directory?(templatedir)
             warning "about to initialize/update the directory #{rootdir}"
             really_continue?
@@ -307,61 +314,61 @@ module FalkorLib #:nodoc:
             end
         end
 
-        ### 
+        ###
         # ERB generation of the file `outfile` using the source template file `erbfile`
         # Supported options:
         #   :no_interaction [boolean]: do not interact
-        def write_from_erb_template(erbfile, outfile, config = {}, 
+        def write_from_erb_template(erbfile, outfile, config = {},
                                     options = {
-                                        :no_interaction => false
-                                    })
+                                               :no_interaction => false
+                                              })
             error "Unable to find the template file #{erbfile}" unless File.exists? (erbfile )
             template = File.read("#{erbfile}")
             output   = ERB.new(template, nil, '<>')
             content  = output.result(binding)
-	        show_diff_and_write(content, outfile, options)
+            show_diff_and_write(content, outfile, options)
         end
 
         ## Show the difference between a `content` string and an destination file (using Diff algorithm).
-        # Obviosuly, if the outfile does not exists, no difference is proposed. 
+        # Obviosuly, if the outfile does not exists, no difference is proposed.
         # Supported options:
         #   :no_interaction [boolean]: do not interact
         #   :json_pretty_format [boolean]: write a json content, in pretty format
         #
         # return 0 if nothing happened, 1 if a write has been done
         def show_diff_and_write(content, outfile, options = {
-	                                :no_interaction     => false,
-	                                :json_pretty_format => false,
-                                })
-	        if File.exists?( outfile )
-		        ref = File.read( outfile )
-		        if options[:json_pretty_format]
-			        ref = JSON.pretty_generate (JSON.parse( IO.read( outfile ) ))
-		        end 
-		        if ref == content
-			        warn "Nothing to update"
-			        return 0
-		        end 
-		        warn "the file '#{outfile}' already exists and will be overwritten."
-		        warn "Expected difference: \n------"
-		        Diffy::Diff.default_format = :color
-		        puts Diffy::Diff.new(ref, content, :context => 1)
-	        else
-		        watch =  options[:no_interaction] ? 'no' : ask( cyan("  ==> Do you want to see the generated file before commiting the writing (y|N)"), 'No')
-		        puts content if watch =~ /y.*/i
-	        end
-	        proceed = options[:no_interaction] ? 'yes' : ask( cyan("  ==> proceed with the writing (Y|n)"), 'Yes')
+                                                             :no_interaction     => false,
+                                                             :json_pretty_format => false,
+                                                            })
+            if File.exists?( outfile )
+                ref = File.read( outfile )
+                if options[:json_pretty_format]
+                    ref = JSON.pretty_generate (JSON.parse( IO.read( outfile ) ))
+                end
+                if ref == content
+                    warn "Nothing to update"
+                    return 0
+                end
+                warn "the file '#{outfile}' already exists and will be overwritten."
+                warn "Expected difference: \n------"
+                Diffy::Diff.default_format = :color
+                puts Diffy::Diff.new(ref, content, :context => 1)
+            else
+                watch =  options[:no_interaction] ? 'no' : ask( cyan("  ==> Do you want to see the generated file before commiting the writing (y|N)"), 'No')
+                puts content if watch =~ /y.*/i
+            end
+            proceed = options[:no_interaction] ? 'yes' : ask( cyan("  ==> proceed with the writing (Y|n)"), 'Yes')
             return 0 if proceed =~ /n.*/i
             info("=> writing #{outfile}")
             File.open("#{outfile}", "w+") do |f|
-		        f.write content
+                f.write content
+            end
+            if FalkorLib::Git.init?(File.dirname(outfile))
+                do_commit = options[:no_interaction] ? 'yes' : ask( cyan("  ==> commit the changes (Y|n)"), 'Yes')
+                FalkorLib::Git.add(outfile, "update content of '#{File.basename(outfile)}'") if do_commit =~ /y.*/i
             end
-	        if FalkorLib::Git.init?(File.dirname(outfile))
-		        do_commit = options[:no_interaction] ? 'yes' : ask( cyan("  ==> commit the changes (Y|n)"), 'Yes')
-		        FalkorLib::Git.add(outfile, "update content of '#{File.basename(outfile)}'") if do_commit =~ /y.*/i
-	        end
-	        return 1
-        end 
+            return 1
+        end
 
 
         ## Blind copy of a source file `src` into its destination directory `dstdir`
@@ -370,26 +377,26 @@ module FalkorLib #:nodoc:
         #   :srcdir [string]: source directory, make the `src` file relative to that directory
         #   :outfile [string]: alter the outfile name (File.basename(src) by default)
         def write_from_template(src,dstdir,options = {
-	                               :no_interaction => false,
-	                               :srcdir         => '', 
-	                               :outfile        => ''
-                               })
-	        srcfile = options[:srcdir].nil? ? src : File.join(options[:srcdir], src)
-	        error "Unable to find the source file #{srcfile}" unless File.exists? ( srcfile )
-	        error "The destination directory '#{dstdir}' do not exist" unless File.directory?( dstdir )
-	        dstfile = options[:outfile].nil? ? File.basename(srcfile) : options[:outfile]
-	        outfile = File.join(dstdir, dstfile)
-	        content = File.read( srcfile )
-	        show_diff_and_write(content, outfile, options)
+                                                      :no_interaction => false,
+                                                      :srcdir         => '',
+                                                      :outfile        => ''
+                                                     })
+            srcfile = options[:srcdir].nil? ? src : File.join(options[:srcdir], src)
+            error "Unable to find the source file #{srcfile}" unless File.exists? ( srcfile )
+            error "The destination directory '#{dstdir}' do not exist" unless File.directory?( dstdir )
+            dstfile = options[:outfile].nil? ? File.basename(srcfile) : options[:outfile]
+            outfile = File.join(dstdir, dstfile)
+            content = File.read( srcfile )
+            show_diff_and_write(content, outfile, options)
         end # copy_from_template
 
 
         ### RVM init
         def init_rvm(rootdir = Dir.pwd, gemset = '')
             rvm_files = {
-                :version => File.join(rootdir, '.ruby-version'),
-                :gemset  => File.join(rootdir, '.ruby-gemset')
-            }
+                         :version => File.join(rootdir, '.ruby-version'),
+                         :gemset  => File.join(rootdir, '.ruby-gemset')
+                        }
             unless File.exists?( "#{rvm_files[:version]}")
                 v = select_from(FalkorLib.config[:rvm][:rubies],
                                 "Select RVM ruby to configure for this directory",
@@ -414,16 +421,16 @@ module FalkorLib #:nodoc:
         #  * :relative   [boolean] return relative path to the root dir
         ##
         def normalized_path(dir = Dir.pwd, options = {})
-          rootdir = FalkorLib::Git.init?(dir) ? FalkorLib::Git.rootdir(dir) : dir
-          path = dir
-          path = Dir.pwd if dir == '.'
-          path = File.join(Dir.pwd,  dir) unless (dir =~ /^\// or dir == '.')
-          if (options[:relative] or options[:relative_to])
-            root = options[:relative_to] ? options[:relative_to] : rootdir
-            relative_path_to_root = Pathname.new( File.realpath(path) ).relative_path_from Pathname.new(root)
-            path = relative_path_to_root.to_s
-          end
-          return path
+            rootdir = FalkorLib::Git.init?(dir) ? FalkorLib::Git.rootdir(dir) : dir
+            path = dir
+            path = Dir.pwd if dir == '.'
+            path = File.join(Dir.pwd,  dir) unless (dir =~ /^\// or dir == '.')
+            if (options[:relative] or options[:relative_to])
+                root = options[:relative_to] ? options[:relative_to] : rootdir
+                relative_path_to_root = Pathname.new( File.realpath(path) ).relative_path_from Pathname.new(root)
+                path = relative_path_to_root.to_s
+            end
+            return path
         end # normalize_path
 
     end

data/lib/falkorlib/config.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Mer 2015-01-21 09:25 svarrette>
+# Time-stamp: <Jeu 2015-02-12 11:07 svarrette>
 ################################################################################
 # FalkorLib Configuration
 #
@@ -11,6 +11,7 @@ require "falkorlib"
 
 require "configatron"
 require "configatron/store"
+require "deep_merge"
 
 module FalkorLib #:nodoc:
 
@@ -40,74 +41,68 @@ module FalkorLib #:nodoc:
     module Config #:nodoc:
         # Defaults global settings
         DEFAULTS = {
-            :debug      => false,
-            :root       => Dir.pwd,
-		    :custom_cfg => '.falkorlib.yaml',
-		    :rvm => {
-               :rubies => [ '1.9.3', '2.0.0', '2.1.0'],
-               :versionfile => '.ruby-version',
-               :gemsetfile  => '.ruby-gemset'
-		    },
-		    :templates => {
-                     :trashdir => '.Trash',
-                     :puppet   => {}
-		    },
-		    :tokens => {
-			    :code_climate => ''
-		    }
-        }
+                    :debug        => false,
+                    :verbose      => false,
+                    :root         => Dir.pwd,
+                    :config_files => {
+                                      :local   => '.falkor/config',
+                                      :private => '.falkor/private',
+                                      #:project => '.falkor/project',
+                                     },
+                    #:custom_cfg   => '.falkorlib.yaml',
+                    :rvm => {
+                             :rubies      => [ '1.9.3', '2.0.0', '2.1.0'],
+                             :version     => '1.9.3',
+                             :versionfile => '.ruby-version',
+                             :gemsetfile  => '.ruby-gemset'
+                            },
+                    :templates => {
+                                   :trashdir => '.Trash',
+                                   :puppet   => {}
+                                  },
+                    :tokens  => { :code_climate => '' },
+                    :project => {}
+                   }
 
         module_function
 
         ## Build the default configuration hash, to be used to initiate the default.
-        # The hash is built depending on the loaded files. 
+        # The hash is built depending on the loaded files.
         def default
             res = FalkorLib::Config::DEFAULTS
-	        $LOADED_FEATURES.each do |path|
+            $LOADED_FEATURES.each do |path|
                 res[:git]        = FalkorLib::Config::Git::DEFAULTS        if path.include?('lib/falkorlib/git.rb')
                 res[:gitflow]    = FalkorLib::Config::GitFlow::DEFAULTS    if path.include?('lib/falkorlib/git.rb')
-		        res[:versioning] = FalkorLib::Config::Versioning::DEFAULTS if path.include?('lib/falkorlib/versioning.rb')
-		        if path.include?('lib/falkorlib/puppet.rb')
-			        res[:puppet]     = FalkorLib::Config::Puppet::DEFAULTS     
-			        res[:templates][:puppet][:modules] = FalkorLib::Config::Puppet::Modules::DEFAULTS[:metadata]
-		        end 
+                res[:versioning] = FalkorLib::Config::Versioning::DEFAULTS if path.include?('lib/falkorlib/versioning.rb')
+                if path.include?('lib/falkorlib/puppet.rb')
+                    res[:puppet]     = FalkorLib::Config::Puppet::DEFAULTS
+                    res[:templates][:puppet][:modules] = FalkorLib::Config::Puppet::Modules::DEFAULTS[:metadata]
+                end
+            end
+            # Check the potential local customizations
+            [:local, :private].each do |type|
+                custom_cfg = File.join( res[:root], res[:config_files][type.to_sym])
+                if File.exists?( custom_cfg )
+                    res.deep_merge!( load_config( custom_cfg ) )
+                end
             end
-	        # Check the potential local customizations
-	        custom_cfg = File.join( res[:root], res[:custom_cfg])
-	        if File.exists?( custom_cfg )
-		        res.merge!( load_config( custom_cfg ) )
-	        end 
             res
         end
 
-    end
-
-    # config = Thread.current[:config] ||= Configatron::Store.new
+        ###### load_project ######
+        # Return the local project configuration
+        ##
+        def load_project(dir = Dir.pwd, options = {})
+            project_file = options[:file] ? options[:file] : FalkorLib.config[:config_files][:local]
+            path = normalized_path(dir)
+            path = FalkorLib::Git.rootdir(path) if FalkorLib::Git.init?(path)
+            res = {}
+            #if File.exists?( )
+        end # load_project
 
-    # # Singleton configuration class
-    # class Config
-    #     include Singleton
 
-    #     # Give memoized defaults for locked configuration options found in /config/falkorlib.yml file
-    #     #
-    #     # @example Usage
-    #     #   conf = Configuration.instance.defaults
-    #     #   conf.base_url       #=> "http://ambito.com/economia/mercados/monedas/dolar/"
-    #     #   conf.blue.buy.xpath #=> "//*[@id=\"contenido\"]/div[1]/div[2]/div/div/div[2]/big"
-    #     #
-    #     # @return [Configatron::Store] the magic configuration instance with hash and dot '.' indifferent access
-    #     def defaults
-    #       return @config if @config
-
-    #       @config = Configatron::Store.new
-    #       file_path   = File.expand_path('../../../config/falkorlib.yml', __FILE__)
-    #       hash_config = YAML::load_file(file_path)
+    end
 
-    #       @config.configure_from_hash(hash_config)
-    #       @config.lock!
-    #       @config
-    #     end
-    # end
 
 
 end # module FalkorLib

data/lib/falkorlib/error.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Sam 2015-01-31 21:07 svarrette>
+################################################################################
+# Falkorlib errors
+
+module FalkorLib
+
+    # Errors
+    class Error < ::StandardError
+
+        class << self
+            attr_accessor :status_code
+        end
+
+        def status_code
+            self.class.status_code
+        end
+    end
+
+    class Exit             < Error; self.status_code = 0; end
+    class FalkorError      < Error; self.status_code = 1; end
+    class ExecError        < Error; self.status_code = 2; end
+    class InternalError    < Error; self.status_code = 3; end
+    class ArgumentError    < Error; self.status_code = 4; end
+    class AbortError       < Error; self.status_code = 5; end
+    class TemplateNotFound < Error; self.status_code = 6; end
+end

data/lib/falkorlib/git/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Jeu 2015-01-22 17:57 svarrette>
+# Time-stamp: <Sam 2015-01-24 19:33 svarrette>
 ################################################################################
 # Interface for the main Git operations
 #
@@ -155,10 +155,12 @@ module FalkorLib  #:nodoc:
             cg  = MiniGit::Capturing.new(dir)
             res = (cg.config :list => true).split("\n")
             res.select! { |e| e.match(key) } unless key =='*'
-            res = res.map { |e| e.split('=') }.to_h if options[:hash]
+            #res = res.map { |e| e.split('=') }.to_h if options[:hash]
+            res = Hash[ res.map { |e| e.split('=') } ] if options[:hash]
           else
             g = MiniGit.new(dir)
             res = g[key]
+            res = { key => g[key] } if options[:hash]
           end
           #ap res
           res

data/lib/falkorlib/loader.rb

@@ -1,9 +1,11 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Jeu 2015-01-15 17:26 svarrette>
+# Time-stamp: <Ven 2015-01-30 16:19 svarrette>
 ################################################################################
 # Place the component you wish to see loaded  
 
+
+require "falkorlib/error"
 require "falkorlib/config"
 require "falkorlib/common"
 require "falkorlib/git"

data/lib/falkorlib/tasks/rspec.rake

@@ -35,7 +35,8 @@ begin
         #t.pattern = "spec/**/puppet*spec.rb"
         #t.pattern = "spec/**/bootstrap*spec.rb"
         #t.pattern = "spec/**/gitf*spec.rb"
-        
+        #t.pattern = "spec/**/error*spec.rb"
+
         # Whether or not to fail Rake when an error occurs (typically when
         # examples fail).
         t.fail_on_error = true

data/lib/falkorlib/version.rb

@@ -19,7 +19,7 @@ module FalkorLib #:nodoc:
         # MAJOR: Defines the major version
         # MINOR: Defines the minor version
         # PATCH: Defines the patch version
-	    MAJOR, MINOR, PATCH = 0, 4, 0  
+	    MAJOR, MINOR, PATCH = 0, 4, 1  
 	    
 	    module_function
 	    

data/lib/falkorlib/versioning.rb

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ################################################################################
-# Time-stamp: <Dim 2014-08-31 22:00 svarrette>
+# Time-stamp: <Dim 2015-01-25 16:04 svarrette>
 ################################################################################
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
 #
@@ -16,27 +16,27 @@ module FalkorLib #:nodoc:
         module Versioning
             # Versioning Management defaults
             DEFAULTS = {
-                :default => '0.0.1',
-                :levels  => [ 'major', 'minor', 'patch' ],
-                :type    => 'file',
-                :source  => {
-                    'file' => {
-                        :filename => 'VERSION'
-                    },
-                    'gem' => {
-                        :filename  => 'lib/falkorlib/version.rb',
-                        :getmethod => 'FalkorLib::Version.to_s',
-                        #:setmethod => 'FalkorLib::Version.set',
-                        #:pattern   => '^(\s*)MAJOR\s*,\s*MINOR,\s*PATCH\s*=\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)'
-                    },
-			        'puppet_module' => {
-				        :filename => 'metadata.json'
-			        },
-                    'tag' => {
-                        :suffix => 'v'
-                    },
-                }
-            }
+                        :default => '0.0.1',
+                        :levels  => [ 'major', 'minor', 'patch' ],
+                        :type    => 'file',
+                        :source  => {
+                                     'file' => {
+                                                :filename => 'VERSION'
+                                               },
+                                     'gem' => {
+                                               :filename  => 'lib/falkorlib/version.rb',
+                                               :getmethod => 'FalkorLib::Version.to_s',
+                                               #:setmethod => 'FalkorLib::Version.set',
+                                               #:pattern   => '^(\s*)MAJOR\s*,\s*MINOR,\s*PATCH\s*=\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)'
+                                              },
+                                     'puppet_module' => {
+                                                         :filename => 'metadata.json'
+                                                        },
+                                     'tag' => {
+                                               :suffix => 'v'
+                                              },
+                                    }
+                       }
         end
     end
 
@@ -66,13 +66,17 @@ module FalkorLib #:nodoc:
             res
         end
 
-
-        ## get the current version
-        def get_version(rootdir = Dir.pwd)
-            version = FalkorLib.config[:versioning][:default]
-            type    = FalkorLib.config[:versioning][:type]
-            source  = FalkorLib.config[:versioning][:source][ type ]
-	        case type
+        ######
+        # Get the current version
+        # Supported options:
+        # * :default [string] default version
+        # * :type    in ['file','gem','puppet_module'] type of versionning mechanism
+        # * :source  [Hash] information on the way to retrieve the information
+        def get_version(rootdir = Dir.pwd, options = {})
+            version = options[:default] ? options[:default] : FalkorLib.config[:versioning][:default]
+            type    = options[:type]    ? options[:type]    : FalkorLib.config[:versioning][:type]
+            source  = options[:source]  ? options[:source]  : FalkorLib.config[:versioning][:source][ type ]
+            case type
             when 'file'
                 versionfile = File.join( rootdir, source[:filename] )
                 version = File.read( versionfile ).chomp if File.exist? ( versionfile )
@@ -80,71 +84,77 @@ module FalkorLib #:nodoc:
                 getmethod = source[:getmethod ]
                 version = eval( getmethod ) unless (getmethod.nil? || getmethod.empty?)
             when 'puppet_module'
-	            jsonfile = File.join( rootdir, source[:filename] )
-	            metadata = JSON.parse( IO.read( jsonfile ) )
-	            version  = metadata["version"]
+                jsonfile = File.join( rootdir, source[:filename] )
+                metadata = JSON.parse( IO.read( jsonfile ) )
+                version  = metadata["version"]
             end
             version
         end
 
-        ## Set the version
-        def set_version(version, rootdir = Dir.pwd)
+        ######
+        # Set the version
+        # Supported options:
+        # * :type    in ['file','gem','puppet_module'] type of versionning mechanism
+        # * :source  [Hash] information on the way to retrieve the information
+        def set_version(version, rootdir = Dir.pwd, options = {})
             exit_status = 0
-            type    = FalkorLib.config[:versioning][:type]
-            source  = FalkorLib.config[:versioning][:source][ type ]
-	        versionfile = File.join( rootdir, source[:filename] ) unless source[:filename].nil?
-            filelist = FalkorLib::Git.list_files( rootdir )
+            type    = options[:type]    ? options[:type]    : FalkorLib.config[:versioning][:type]
+            source  = options[:source]  ? options[:source]  : FalkorLib.config[:versioning][:source][ type ]
+            versionfile = File.join( rootdir, source[:filename] ) unless source[:filename].nil?
             major, minor, patch =  major(version), minor(version), patch(version)
             #tocommit = ""
             case type
             when 'file'
-	            info "writing version changes in #{source[:filename]}"
-	            File.open(versionfile, 'w') {|f| f.puts version } if File.exist? ( versionfile )
+                info "writing version changes in #{source[:filename]}"
+                File.open(versionfile, 'w') {|f| f.puts version } #if File.exist? ( versionfile )
             when 'gem'
-	            info "=> writing version changes in #{source[:filename]}"
-	            File.open(versionfile, 'r+') do |f|
+                info "=> writing version changes in #{source[:filename]}"
+                File.open(versionfile, 'r+') do |f|
                     text = f.read
-			        text.gsub!(/^(\s*)MAJOR\s*,\s*MINOR,\s*PATCH\s*=\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)(.*)$/, 
-			                   '\1' + "MAJOR, MINOR, PATCH = #{major}, #{minor}, #{patch}" + '\5')
+                    text.gsub!(/^(\s*)MAJOR\s*,\s*MINOR,\s*PATCH\s*=\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)(.*)$/,
+                      '\1' + "MAJOR, MINOR, PATCH = #{major}, #{minor}, #{patch}" + '\5')
                     f.rewind
                     f.write(text)
                 end
             when 'puppet_module'
-	            info "=> writing version changes in #{source[:filename]}"
-	            metadata = JSON.parse( IO.read( versionfile ) )
-	            metadata["version"] = version
-	            File.open(versionfile,"w") do |f|
-			        f.write JSON.pretty_generate( metadata )
+                info "=> writing version changes in #{source[:filename]}"
+                metadata = JSON.parse( IO.read( versionfile ) )
+                metadata["version"] = version
+                File.open(versionfile,"w") do |f|
+                    f.write JSON.pretty_generate( metadata )
                 end
-	            #exit 1
+                #exit 1
             end
-            Dir.chdir( rootdir ) do
-                next if source[:filename].nil?
-                unless filelist.include?(  source[:filename] )
-                    warning "The version file #{source[:filename]} is not part of the Git repository"
-                    answer = ask("Adding the file to the repository? (Y|n)", 'Yes')
+            if FalkorLib::Git.init?(rootdir)
+                filelist = FalkorLib::Git.list_files( rootdir )
+                Dir.chdir( rootdir ) do
+                    next if source[:filename].nil?
+                    unless filelist.include?(  source[:filename] )
+                        warning "The version file #{source[:filename]} is not part of the Git repository"
+                        answer = ask("Adding the file to the repository? (Y|n)", 'Yes')
+                        next if answer =~ /n.*/i
+                        exit_status = FalkorLib::Git.add(versionfile, "Adding the version file '#{source[:filename]}', inialized to the '#{version}' version" )
+                        next
+                    end
+                    run %{
+                   git diff #{source[:filename]}
+                    }
+                    answer = ask(cyan("=> Commit the changes of the version file to the repository? (Y|n)"), 'Yes')
                     next if answer =~ /n.*/i
-                    exit_status = FalkorLib::Git.add(versionfile, "Adding the version file '#{source[:filename]}', inialized to the '#{version}' version" )
-                    next
+                    run %{
+                   git commit -s -m "bump to version '#{version}'" #{source[:filename]}
+                    }
+                    exit_status = $?.to_i
+                    # if (type == 'gem' && File.exists?(File.join(rootdir, 'Gemfile')) )
+                    #     run %{
+                    #        sleep 2
+                    #        bundle update falkorlib
+                    #        git commit -s -m "Update Gemfile.lock accordingly" Gemfile.lock
+                    #     } if command?( 'bundle' )
+                    # end
                 end
-		        run %{ 
-                   git diff #{source[:filename]} 
-                }
-		        answer = ask(cyan("=> Commit the changes of the version file to the repository? (Y|n)"), 'Yes')
-		        next if answer =~ /n.*/i
-		        run %{ 
-                   git commit -s -m "bump to version '#{version}'" #{source[:filename]} 
-                }
-		        exit_status = $?.to_i
-		        # if (type == 'gem' && File.exists?(File.join(rootdir, 'Gemfile')) )
-			    #     run %{
-                #        sleep 2 
-                #        bundle update falkorlib
-                #        git commit -s -m "Update Gemfile.lock accordingly" Gemfile.lock
-                #     } if command?( 'bundle' )
-		        # end 
             end
-	        exit_status
+            exit_status
         end
 
         ## Return a new version number based on

data/spec/falkorlib/bootstrap_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # bootstrap_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Jeu 2015-01-22 10:47 svarrette>
+# Time-stamp: <Sam 2015-01-24 19:05 svarrette>
 #
 # @description Check the Bootstrapping operations
 #
@@ -12,7 +12,7 @@
 
 require 'spec_helper'
 require 'tmpdir'
-require 'FileUtils'
+require 'fileutils'
 
 describe FalkorLib::Bootstrap do
 

data/spec/falkorlib/common_spec.rb

@@ -12,7 +12,7 @@ describe FalkorLib::Common do
 		FileUtils.touch File.join(dir, 'file2.txt')
 		FileUtils.mkdir File.join(dir, 'dir1')
 		FileUtils.mkdir File.join(dir, 'dir2')
-	end 
+	end
 
     after :all do
         FileUtils.remove_entry_secure dir
@@ -137,7 +137,7 @@ describe FalkorLib::Common do
 	it "#nice_execute -- check stderr output" do
 		b = capture(:stderr) {
 			nice_execute("echo 'toto' 1>&2")
-		}		
+		}
 		b.should == red("** [err] toto\n")
 	end
 
@@ -150,7 +150,7 @@ describe FalkorLib::Common do
 		b = capture(:stderr) {
 			expect { not_implemented }.to raise_error (SystemExit)
 		}
-		b.should =~ /NOT YET IMPLEMENTED/ 
+		b.should =~ /NOT YET IMPLEMENTED/
 	end
 
 	it "#exec_or_exit - should exit" do
@@ -179,25 +179,25 @@ describe FalkorLib::Common do
     context "Test (common) YAML functions" do
 
 		it "#load_config - load the correct hash from YAML" do
-			file_config = {:domain => "foo.com", :nested => { 'a1' => 2 }}                              
-			YAML.stub(:load_file).and_return(file_config)  
-			loaded = load_config('toto')
+			file_config = {:domain => "foo.com", :nested => { 'a1' => 2 }}
+			YAML.stub(:load_file).and_return(file_config)
+			loaded = load_config('/tmp')  # /tmp to ensure existing target
 			loaded.should == file_config
-		end 
+		end
 
 		it "#store_config - should store the correct hash to YAML" do
-			file_config = {:domain => "foo.com", :nested => { 'a1' => 2 }}    
+			file_config = {:domain => "foo.com", :nested => { 'a1' => 2 }}
 			f = Tempfile.new('toto')
 			store_config(f.path, file_config)
 			copy_file_config = YAML::load_file(f.path)
 			copy_file_config.should == file_config
-		end 
+		end
 
-	end 
+	end
 
 	############################################
 	context 'Test list selection functions' do
-		
+
 		it "#list_items - Exit on 0" do
 			STDIN.should_receive(:gets).and_return('0')
 			expect { list_items("#{dir}/*") }.to raise_error (SystemExit)

data/spec/falkorlib/error_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require "falkorlib/error"
+
+
+describe FalkorLib::Error do
+
+    #############################################
+    context "Test Falkorlib errors" do
+
+        exceptions = [
+                      FalkorLib::Exit,
+                      FalkorLib::FalkorError,
+                      FalkorLib::ExecError,
+                      FalkorLib::InternalError,
+                      FalkorLib::ArgumentError,
+                      FalkorLib::AbortError,
+                      FalkorLib::TemplateNotFound
+                     ]
+        exceptions.each do |e|
+            it "##{e} -- exit code #{exceptions.index(e)}" do
+                expect { raise e }.to raise_error
+                begin
+                    raise e
+                rescue StandardError => s
+                    i = s.status_code
+                    i.should == exceptions.index(e)
+                end
+            end
+        end
+    end
+
+
+end

data/spec/falkorlib/git_spec.rb

@@ -2,7 +2,7 @@
 #########################################
 # git_spec.rb
 # @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
-# Time-stamp: <Jeu 2015-01-22 15:38 svarrette>
+# Time-stamp: <Dim 2015-01-25 00:00 svarrette>
 #
 # @description Check the Git operations
 #
@@ -172,6 +172,12 @@ describe FalkorLib::Git do
             c.keys.length.should == 2
         end
 
+        it "#config -- check hash correctness" do
+            key = 'user.name'
+            c = FalkorLib::Git.config('user*', dir, :hash => true)
+            n = FalkorLib::Git.config('user.name', dir)
+            n.should == c[ key ]
+        end
 
         # ---------- Submodules ---------------
         it "#submodules_init" do

data/templates/README/footer_readme.erb

@@ -0,0 +1,67 @@
+
+## Resources / Complementary information
+
+### Git 
+
+You should become familiar (if not yet) with Git. Consider these resources: 
+
+* [Simple Git Guide](http://rogerdudler.github.io/git-guide/)
+* [Git book](http://book.git-scm.com/index.html)
+* [Github:help](http://help.github.com/mac-set-up-git/)
+* [Git reference](http://gitref.org/)
+
+At least, you shall configure the following variables
+
+    $> git config --global user.name "Your Name Comes Here"
+    $> git config --global user.email you@yourdomain.example.com
+    # configure colors
+    $> git config --global color.diff auto
+    $> git config --global color.status auto
+    $> git config --global color.branch auto
+
+You might want also to configure various aliases to Git command.
+Consider my personal [`.gitconfig`](https://github.com/Falkor/dotfiles/blob/master/git/.gitconfig) as an example -- if you decide to use it, simply copy it in your home directory and adapt the `[user]` section. 
+
+### [git-flow](https://github.com/nvie/gitflow)
+
+The Git branching model for this repository follows the guidelines of
+[gitflow](http://nvie.com/posts/a-successful-git-branching-model/).
+In particular, the central repository holds two main branches with an infinite lifetime:
+
+* `<%= config[:gitflow][:branches][:master] %>`: the *production-ready* branch
+* `<%= config[:gitflow][:branches][:develop] %>`: the main branch where the latest developments interviene. This is the *default* branch you get when you clone the repository.
+
+### Releasing mechanism
+
+The operation consisting of releasing a new version of this repository is automated by a set of tasks within the root `<%= config[:rake] ? 'R' : 'M' %>akefile`.
+
+In this context, a version number have the following format:
+
+      <major>.<minor>.<patch>[-b<build>]
+
+where:
+
+* `< major >` corresponds to the major version number
+* `< minor >` corresponds to the minor version number
+* `< patch >` corresponds to the patching version number
+* (eventually) `< build >` states the build number _i.e._ the total number of commits within the `<%= config[:gitflow][:branches][:develop] %>` branch.
+
+Example: \`1.0.0-b28\`
+
+The current version number is stored in the root file `VERSION`. __/!\ NEVER MAKE ANY MANUAL CHANGES TO THIS FILE__
+
+For more information on the version, run:
+
+     $> <%= config[:make] ? 'make versioninfo' : 'rake version:info' %>
+
+If a new version number such be bumped, you simply have to run:
+
+      $> <%= config[:make] ? 'make start_bump_{major,minor,patch}' : 'rake version:{major,minor,patch}' %>
+
+This will start the release process for you using `git-flow`.
+Once you have finished to commit your last changes, make the release effective by running:
+
+      $> <%= config[:make] ? 'make release' : 'rake version:release' %>
+
+it will finish the release using `git-flow`, create the appropriate tag in the `<%= config[:gitflow][:branches][:master] %>` branch and merge all things the way they should be.
+

data/templates/README/header_readme.erb

@@ -0,0 +1,17 @@
+-*- mode: markdown; mode: visual-line; fill-column: 80 -*-
+`<%= config[:filename] %>`
+
+      Time-stamp: <Lun 2015-01-26 10:39 svarrette>
+
+------------------
+
+# <%= config[:shortname].capitalize %>
+
+<%= config[:summary] %>
+
+    Copyright (c) <%= Time.now.year %> <%= config[:author] %> <<%= config[:mail] %>>
+
+## Synopsis
+
+<%= config[:description] %>
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falkorlib
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Sebastien Varrette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -325,6 +339,7 @@ files:
 - lib/falkorlib/cli/new.rb
 - lib/falkorlib/common.rb
 - lib/falkorlib/config.rb
+- lib/falkorlib/error.rb
 - lib/falkorlib/gem_tasks.rb
 - lib/falkorlib/git.rb
 - lib/falkorlib/git/base.rb
@@ -349,6 +364,7 @@ files:
 - lib/falkorlib/versioning.rb
 - spec/falkorlib/bootstrap_spec.rb
 - spec/falkorlib/common_spec.rb
+- spec/falkorlib/error_spec.rb
 - spec/falkorlib/git_spec.rb
 - spec/falkorlib/gitflow_spec.rb
 - spec/falkorlib/puppet_modules_spec.rb
@@ -357,6 +373,8 @@ files:
 - spec/falkorlib/versioning_spec.rb
 - spec/falkorlib_spec.rb
 - spec/spec_helper.rb
+- templates/README/footer_readme.erb
+- templates/README/header_readme.erb
 - templates/puppet/modules/.gitignore
 - templates/puppet/modules/.vagrant_init.rb
 - templates/puppet/modules/Gemfile
@@ -402,6 +420,7 @@ summary: Sebastien Varrette aka Falkor's Common library to share Ruby code and {
 test_files:
 - spec/falkorlib/bootstrap_spec.rb
 - spec/falkorlib/common_spec.rb
+- spec/falkorlib/error_spec.rb
 - spec/falkorlib/git_spec.rb
 - spec/falkorlib/gitflow_spec.rb
 - spec/falkorlib/puppet_modules_spec.rb