falkorlib 0.1.0 → 0.2.8

data/{tasks/spec_test.rake → lib/falkorlib/tasks/rspec.rake}

@@ -1,6 +1,6 @@
 # Installs a rake task for for running examples written using rspec.
 #
-# This file installs the 'rake spec_test' (aliased as 'rake spec') as well as
+# This file installs the 'rake rspec' (aliased as 'rake spec') as well as
 # extends 'rake test' to run spec tests, if any. It is automatically generated
 # by Noe from your .noespec file, and should therefore be configured there,
 # under the variables/rake_tasks/spec_test entry, as illustrated below:
@@ -27,11 +27,12 @@
 #
 begin
   require "rspec/core/rake_task"
-  desc "Run RSpec code examples"
-  RSpec::Core::RakeTask.new(:spec_test) do |t|
+  desc "Run RSpec code examples '*_spec.rb' from the spec/ directory"
+  RSpec::Core::RakeTask.new(:rspec) do |t|
     # Glob pattern to match files.
     #t.pattern = "spec/**/test_*.rb"
 	t.pattern = "spec/**/*_spec.rb"
+		#t.pattern = "spec/**/versioning_spec.rb"
 
     # Whether or not to fail Rake when an error occurs (typically when
     # examples fail).

data/lib/falkorlib/tasks/yard.rake

@@ -0,0 +1,78 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Ven 2014-06-06 15:54 svarrette>
+################################################################################
+# Installs a rake task to generate API documentation using yard.
+#
+# This file installs the 'rake yard' task. It is automatically generated by Noe from
+# your .noespec file, and should therefore be configured there, under the
+# variables/rake_tasks/yard entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     yard:
+#       files: lib/**/*.rb
+#       options: []
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/yard.rake:
+#       safe-override: false
+#
+# This file has been written to conform to yard v0.6.4. More information about
+# yard and the rake task installed below can be found on http://yardoc.org/
+#
+
+require "falkorlib"
+
+#.....................
+namespace :yard do
+	begin
+		require "yard"
+
+		###########  yard:doc   ###########
+		desc "Generate yard documentation"
+		YARD::Rake::YardocTask.new(:doc) do |t|
+			# Array of options passed to yardoc commandline. See 'yardoc --help' about this
+			t.options = ["--output-dir", "doc/api", "-", "README.md", "CHANGELOG.md", "LICENCE.md"]
+
+			# Array of ruby source files (and any extra documentation files
+			# separated by '-')
+			t.files = ["lib/**/*.rb"]
+
+			# A proc to call before running the task
+			# t.before = proc{ }
+
+			# A proc to call after running the task
+			t.after = proc{
+				puts "\nFull documentation is now generated -- you probably want now to\n\t open doc/api/index.html"
+			}
+
+			# An optional lambda to run against all objects being generated.
+			# Any object that the lambda returns false for will be excluded
+			# from documentation.
+			# t.verifier = lambda{|obj| true}
+
+		end
+
+	rescue LoadError
+		task :yard do
+			abort 'yard is not available. In order to run yard, you must: gem install yard'
+		end
+	end
+
+	###########  yard:stats   ###########
+	desc "Collect statistics as regards yard documentation"
+	task :stats do |t|
+		Dir.chdir(FalkorLib.config.root) do
+			FalkorLib::Common.run %{yard stats --list-undoc}
+		end
+	end
+
+end 
+
+

data/lib/falkorlib/version.rb

@@ -1,65 +1,73 @@
-module FalkorLib
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Mer 2014-06-18 17:45 svarrette>
+################################################################################
+# @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
+#
+# FalkorLib Version management
+#
+
+module FalkorLib #:nodoc:
+
+    # Management of the current version of the library
+    # @see falkorlib/tasks/versioning.rake
     module Version
 
-        ##
         # Change the MAJOR, MINOR and PATCH constants below
         # to adjust the version of the FalkorLib gem
         #
-        # MAJOR:
-        #  Defines the major version
-        # MINOR:
-        #  Defines the minor version
-        # PATCH:
-        #  Defines the patch version
-        MAJOR, MINOR, PATCH = 0, 1, 0
-
-        ##
-        # Returns the major version ( big release based off of multiple minor releases )
-        def self.major
-            MAJOR
-        end
+        # MAJOR: Defines the major version
+        # MINOR: Defines the minor version
+        # PATCH: Defines the patch version
+	    MAJOR, MINOR, PATCH = 0, 2, 8  
+	    
+	    module_function
+	    
+	    ## Returns the major version ( big release based off of multiple minor releases )
+	    def major
+		    MAJOR
+	    end
+	    
+	    ## Returns the minor version ( small release based off of multiple patches )
+	    def minor
+		    MINOR		    
+	    end
 
-        ##
-        # Returns the minor version ( small release based off of multiple patches )
-        def self.minor
-            MINOR
-        end
+        ## Returns the patch version ( updates, features and (crucial) bug fixes )
+	    def patch
+		    PATCH
+	    end
 
-        ##
-        # Returns the patch version ( updates, features and (crucial) bug fixes )
-        def self.patch
-            PATCH
-        end
-
-        ##
-        # Returns the full version
-        def self.to_s
-            [ MAJOR, MINOR, PATCH ].join('.')
-        end
-
-        ## Return a new version number based on
-        # - the old version (format: x.y.z)
-        # - the level of bumping (either :major, :minor, :patch)
-        def bump_version(oldversion, level)
-            if oldversion =~ /^(\d+)\.(\d+)\.(\d+)$/
-                major = $1.to_i
-                minor = $2.to_i
-                patch = $3.to_i
-            end
-            case level
-            when ':major'
-                major += 1
-                minor = 0
-                patch = 0
-            when ':minor'
-                minor += 1
-                patch = 0
-            when ':patch'
-                patch += 1
-            end
-            version = [major, minor, patch].compact.join('.')
-        end
+        ## @return the full version string
+	    def to_s
+		    [ MAJOR, MINOR, PATCH ].join('.')
+	    end
 
+        # ## Return a new version number based on
+        # # @param oldversion the old version (format: x.y.z)
+        # # @param level      the level of bumping (either :major, :minor, :patch)
+	    # def bump_version(oldversion, level)
+        #     major = minor = patch = 0
+        #     if oldversion =~ /^(\d+)\.(\d+)\.(\d+)$/
+        #         major = $1.to_i
+        #         minor = $2.to_i
+        #         patch = $3.to_i
+        #     end
+        #     case level
+        #     when ':major'
+        #         major += 1
+        #         minor = 0
+        #         patch = 0
+        #     when ':minor'
+        #         minor += 1
+        #         patch = 0
+        #     when ':patch'
+        #         patch += 1
+        #     end
+        #     version = [major, minor, patch].compact.join('.')
+        # end
     end
+
+    # Shorter version of the Gem's VERSION
     VERSION = Version.to_s
 end

data/lib/falkorlib/versioning.rb

@@ -0,0 +1,162 @@
+# -*- encoding: utf-8 -*-
+################################################################################
+# Time-stamp: <Jeu 2014-06-19 18:41 svarrette>
+################################################################################
+# @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
+#
+# FalkorLib Version management
+#
+
+module FalkorLib #:nodoc:
+
+    module Config
+
+        # Default configuration for Versioning Management
+        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+)'
+                    },
+                    'tag' => {
+                        :suffix => 'v'
+                    },
+                }
+            }
+        end
+    end
+
+    # Semantic Versioning Management
+    # @see falkorlib/tasks/versioning.rake
+    module Versioning
+        module_function
+
+        ## extract the major part of the version
+        def major(version)
+            res = 0
+            res = $1 if version =~ /^\s*(\d+)\.\d+\.\d+/
+            res
+        end
+
+        ## extract the minor part of the version
+        def minor(version)
+            res = 0
+            res = $1 if version =~ /^\s*\d+\.(\d+)\.\d+/
+            res
+        end
+
+        ## extract the patch part of the version
+        def patch(version)
+            res = 0
+            res = $1 if version =~ /^\s*\d+\.\d+\.(\d+)/
+            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
+            when 'file'
+                versionfile = File.join( rootdir, source[:filename] )
+                version = File.read( versionfile ).chomp if File.exist? ( versionfile )
+            when 'gem'
+                getmethod = source[:getmethod ]
+                version = eval( getmethod ) unless (getmethod.nil? || getmethod.empty?)
+            end
+            version
+        end
+
+        ## Set the version
+        def set_version(version, rootdir = Dir.pwd)
+            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 )
+            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 )
+            when 'gem'
+	            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')
+                    f.rewind
+                    f.write(text)
+                end
+	            #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')
+                    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
+		        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 %{ 
+                       bundle 
+                       git commit -s -m "Update Gemfile.lock accordingly" Gemfile.lock
+                    } if command?( 'bundle' )
+		        end 
+            end
+	        exit_status
+        end
+
+
+
+
+        ## Return a new version number based on
+        # @param oldversion the old version (format: x.y.z)
+        # @param level      the level of bumping (either :major, :minor, :patch)
+        def bump(oldversion, level)
+            major = minor = patch = 0
+            if oldversion =~ /^(\d+)\.(\d+)\.(\d+)$/
+                major = $1.to_i
+                minor = $2.to_i
+                patch = $3.to_i
+            end
+            case level.to_sym
+            when :major
+                major += 1
+                minor = 0
+                patch = 0
+            when :minor
+                minor += 1
+                patch = 0
+            when :patch
+                patch += 1
+            end
+            version = [major, minor, patch].compact.join('.')
+        end
+    end
+
+end

data/spec/falkorlib/common_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'tempfile'
 
-describe FalkorLib do
+describe FalkorLib::Common do
 
     include FalkorLib::Common
 
@@ -11,7 +11,7 @@ describe FalkorLib do
         @print_test_conf = {
             :info => {
                 :color  => :green,
-                :prefix => "[INFO]",
+				:prefix => "[INFO]",
             },
             :warning => {
                 :color  => :cyan,
@@ -25,7 +25,7 @@ describe FalkorLib do
 
         # Check the color functions
         @print_test_conf.values.collect{ |e| e[:color] }.each do |color|
-            it "should check a #{color} text" do
+			it "##{color} - check #{color} text" do
                 STDOUT.should_receive(:puts).with(send("#{color}", "#{color} text"))
                 puts send("#{color}", "#{color} text")
             end
@@ -33,7 +33,7 @@ describe FalkorLib do
 
         # Check the prining messages
         @print_test_conf.each do |method,conf|
-            it "should put a #{method} message" do
+			it "##{method} - put a #{method} message" do
                 ((method == :error) ? STDERR : STDOUT).should_receive(:puts).with(send("#{conf[:color]}", "#{conf[:prefix]} #{method} text"))
                 if (method == :error)
                     lambda {
@@ -48,7 +48,7 @@ describe FalkorLib do
         # Check the ask function
         ['', 'default'].each do |default_answer|
             @query = "Am I a query"
-            it "should ask '#{@query}' with default answer '#{default_answer}' and no answer" do
+            it "#ask - ask '#{@query}' with default answer '#{default_answer}' and no answer" do
                 STDIN.should_receive(:gets).and_return('')
                 results = capture(:stdout) {
                     answer = ask(@query, default_answer)
@@ -67,14 +67,14 @@ describe FalkorLib do
 
         # Check the really_continue? function
         [ '', 'Yes', 'y', 'Y', 'yes' ].each do |answer|
-            it "should really continue after answer '#{answer}'" do
+            it "#really_continue? - should really continue after answer '#{answer}'" do
                 STDIN.should_receive(:gets).and_return(answer)
                 results = capture(:stdout) { really_continue? }
                 results.should =~ /=> Do you really want to continue/;
                 results.should =~ /Default: Yes/;
             end
             next if answer.empty?
-            it "should really continue (despite default answer 'No') after answer '#{answer}'" do
+            it "#really_continue? - should really continue (despite default answer 'No') after answer '#{answer}'" do
                 STDIN.should_receive(:gets).and_return(answer)
                 results = capture(:stdout) { really_continue?('No') }
                 results.should =~ /=> Do you really want to continue/;
@@ -83,7 +83,7 @@ describe FalkorLib do
         end
 
         [ '', 'No', 'n', 'N', 'no' ].each do |answer|
-            it "should not continue (despite default answer 'No') and exit after answer '#{answer}'" do
+            it "#really_continue? - should not continue (despite default answer 'No') and exit after answer '#{answer}'" do
                 STDIN.should_receive(:gets).and_return(answer)
                 results = capture(:stdout) {
                     lambda{
@@ -94,7 +94,7 @@ describe FalkorLib do
                 results.should =~ /Default: No/;
             end
             next if answer.empty?
-            it "should not continue and exit after answer '#{answer}'" do
+            it "#really_continue? - should not continue and exit after answer '#{answer}'" do
                 STDIN.should_receive(:gets).and_return(answer)
                 results = capture(:stdout) {
                     lambda{
@@ -108,7 +108,7 @@ describe FalkorLib do
 
         # Check the command? function
         [ 'sqgfyueztruyjf', 'ruby' ].each do |command|
-            it "should check the command '#{command}'" do
+            it "#command? - check the command '#{command}'" do
                 command?(command).should ((command == 'ruby') ? be_true : be_false)
             end
         end
@@ -117,14 +117,14 @@ describe FalkorLib do
 	#############################################
     context "Test (common) YAML functions" do
 
-		it "should load the correct hash from YAML" 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')
 			loaded.should == file_config
 		end 
 
-		it "should store the correct hash to YAML" do
+		it "#store_config - should store the correct hash to YAML" do
 			file_config = {:domain => "foo.com", :nested => { 'a1' => 2 }}    
 			f = Tempfile.new('toto')
 			store_config(f.path, file_config)