falkorlib 0.1.0

data/lib/falkorlib/loader.rb

@@ -0,0 +1,3 @@
+
+require "falkorlib/common"
+require "falkorlib/gitflow"

data/lib/falkorlib/version.rb

@@ -0,0 +1,65 @@
+module FalkorLib
+    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
+
+        ##
+        # 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 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
+
+    end
+    VERSION = Version.to_s
+end

data/spec/falkorlib/common_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe FalkorLib do
+
+    include FalkorLib::Common
+
+	#############################################
+    context "Test (common) printing functions" do
+
+        @print_test_conf = {
+            :info => {
+                :color  => :green,
+                :prefix => "[INFO]",
+            },
+            :warning => {
+                :color  => :cyan,
+                :prefix => "/!\\ WARNING:",
+            },
+            :error => {
+                :color  => :red,
+                :prefix => "*** ERROR ***",
+            }
+        }
+
+        # Check the color functions
+        @print_test_conf.values.collect{ |e| e[:color] }.each do |color|
+            it "should check a #{color} text" do
+                STDOUT.should_receive(:puts).with(send("#{color}", "#{color} text"))
+                puts send("#{color}", "#{color} text")
+            end
+        end
+
+        # Check the prining messages
+        @print_test_conf.each do |method,conf|
+            it "should put a #{method} message" do
+                ((method == :error) ? STDERR : STDOUT).should_receive(:puts).with(send("#{conf[:color]}", "#{conf[:prefix]} #{method} text"))
+                if (method == :error)
+                    lambda {
+                        send("#{method}", "#{method} text")
+                    }.should raise_error #(SystemExit)
+                else
+                    send("#{method}", "#{method} text")
+                end
+            end
+        end
+
+        # 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
+                STDIN.should_receive(:gets).and_return('')
+                results = capture(:stdout) {
+                    answer = ask(@query, default_answer)
+                    if default_answer.empty?
+                        answer.should be_empty
+                    else
+                        answer.should == default_answer
+                    end
+                }
+                results.should =~ /#{@query}/;
+                unless default_answer.empty?
+                    results.should =~ /Default: #{default_answer}/;
+                end
+            end
+        end
+
+        # Check the really_continue? function
+        [ '', 'Yes', 'y', 'Y', 'yes' ].each do |answer|
+            it "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
+                STDIN.should_receive(:gets).and_return(answer)
+                results = capture(:stdout) { really_continue?('No') }
+                results.should =~ /=> Do you really want to continue/;
+                results.should =~ /Default: No/;
+            end
+        end
+
+        [ '', 'No', 'n', 'N', 'no' ].each do |answer|
+            it "should not continue (despite default answer 'No') and exit after answer '#{answer}'" do
+                STDIN.should_receive(:gets).and_return(answer)
+                results = capture(:stdout) {
+                    lambda{
+                        really_continue?('No')
+                    }.should raise_error (SystemExit)
+                }
+                results.should =~ /=> Do you really want to continue/;
+                results.should =~ /Default: No/;
+            end
+            next if answer.empty?
+            it "should not continue and exit after answer '#{answer}'" do
+                STDIN.should_receive(:gets).and_return(answer)
+                results = capture(:stdout) {
+                    lambda{
+                        really_continue?
+                    }.should raise_error (SystemExit)
+                }
+                results.should =~ /=> Do you really want to continue/;
+                results.should =~ /Default: Yes/;
+            end
+        end
+
+        # Check the command? function
+        [ 'sqgfyueztruyjf', 'ruby' ].each do |command|
+            it "should check the command '#{command}'" do
+                command?(command).should ((command == 'ruby') ? be_true : be_false)
+            end
+        end
+   end
+	
+	#############################################
+    context "Test (common) YAML functions" do
+
+		it "should 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
+			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

data/spec/falkorlib/gitflow_spec.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby
+#########################################
+# gitflow_spec.rb
+# @author Sebastien Varrette <Sebastien.Varrette@uni.lu>
+# Time-stamp: <Jeu 2013-01-31 23:22 svarrette>
+#
+# @description Check the
+#
+# Copyright (c) 2013 Sebastien Varrette <Sebastien.Varrette@uni.lu>
+# .             http://varrette.gforge.uni.lu
+##############################################################################
+
+require 'spec_helper'
+require 'tmpdir'
+
+describe FalkorLib do
+
+    include FalkorLib::Common
+
+    # it "test default initialization of a git-flow dir" do
+    #     tempdir = Dir.tmpdir
+    #     #puts "tempdir = #{tempdir}"
+
+    #     FalkorLib::GitFlow::init(tempdir)
+
+    #     File.directory?(File.join(tempdir, '.git')).should be_true
+
+    #     g = Git.open(tempdir)
+    #     g.config['gitflow.branch.master'].should  == FalkorLib::GitFlow::global_config(:master)
+    #     g.config['gitflow.branch.develop'].should == FalkorLib::GitFlow::global_config(:develop)
+    #     [ :feature, :release, :hotfix, :support, :versiontag ].each do |e|
+    #         g.config["gitflow.prefix.#{e}"].should == FalkorLib::GitFlow::global_config(e.to_sym)
+    #     end
+    #     FileUtils.rm_rf(tempdir)
+    # end
+
+    # [ :master, :develop, :feature, :release, :hotfix, :support, :versiontag ].each do |elem|
+	# 	specialvalue = 'uncommonvalue'
+
+	# 	it "test specialized initialization of a git-flow dir (alter '#{elem}' option with special value #{specialvalue})" do
+    #         tempdir = Dir.tmpdir
+    #         #puts "tempdir = #{tempdir}"
+
+	# 		FalkorLib::GitFlow::init(tempdir, { elem.to_sym => "#{specialvalue}"})
+			
+    #         File.directory?(File.join(tempdir, '.git')).should be_true
+
+    #         g = Git.open(tempdir)
+	# 		[ :master, :develop].each do |e|
+	# 			#puts "elem = #{elem}, e = #{e}, ", g.config["gitflow.branch.#{e}"]
+	# 			g.config["gitflow.branch.#{e}"].should == ((elem == e) ? specialvalue : FalkorLib::GitFlow::global_config(e.to_sym))
+	# 		end
+    #         [ :feature, :release, :hotfix, :support, :versiontag ].each do |e|
+    #             g.config["gitflow.prefix.#{e}"].should == ((elem == e) ? specialvalue : FalkorLib::GitFlow::global_config(e.to_sym))
+    #         end
+    #         FileUtils.rm_rf(tempdir)
+    #     end
+    # end
+
+
+
+
+
+end

data/spec/falkorlib_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+describe FalkorLib do
+
+    it "should have a version number" do
+        FalkorLib.const_defined?(:VERSION).should be_true
+    end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'falkorlib'
+require 'falkorlib/common'
+require 'falkorlib/gitflow'
+
+def capture(stream)
+  begin
+    stream = stream.to_s
+    eval "$#{stream} = StringIO.new"
+    yield
+    result = eval("$#{stream}").string
+  ensure
+    eval("$#{stream} = #{stream.upcase}")
+  end
+  result
+end

data/tasks/debug_mail.rake

@@ -0,0 +1,75 @@
+# Installs a rake task for debuging the announcement mail.
+#
+# This file installs the 'rake debug_mail' that flushes an announcement mail
+# for your library on the standard output. It is automatically generated
+# by Noe from your .noespec file, and should therefore be configured there,
+# under the variables/rake_tasks/debug_mail entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     debug_mail:
+#       rx_changelog_sections: /^#/
+#       nb_changelog_sections: 1
+#       ...
+#
+# 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/debug_mail.rake:
+#       safe-override: false
+#
+# The mail template used can be found in debug_mail.txt. That file may be
+# changed to tune the mail you want to send. If you do so, don't forget to
+# add a manifest entry in your .noespec file to avoid overriding you
+# changes. The mail template uses wlang, with parentheses for block
+# delimiters.
+#
+# template-info:
+#   manifest:
+#     tasks/debug_mail.txt:
+#       safe-override: false
+#
+desc "Debug the release announcement mail"
+task :debug_mail do
+  begin
+    require 'wlang'
+  rescue LoadError
+    abort "wlang is not available. Try 'gem install wlang'"
+  end
+  require 'yaml'
+
+  # Check that a .noespec file exists
+  noespec_file = File.expand_path('../../.falkorlib.noespec', __FILE__)
+  unless File.exists?(noespec_file)
+    raise "Unable to find .noespec project file, sorry."
+  end
+
+  # Load it as well as variables and options
+  noespec = YAML::load(File.read(noespec_file))
+  vars = noespec['variables'] || {}
+
+  # Changes are taken from CHANGELOG
+  logs = Dir[File.expand_path("../../CHANGELOG.*", __FILE__)]
+  unless logs.size == 1
+    abort "Unable to find a changelog file"
+  end
+
+  # Load interesting changesets
+  changes, end_found = [], 0
+  File.readlines(logs.first).select{|line|
+    if line =~ /^# /
+      break if end_found >= 1
+      end_found += 1
+    end
+    changes << line
+  }
+  vars['changes'] = changes.join
+
+  # WLang template
+  template = File.expand_path('../debug_mail.txt', __FILE__)
+
+  # Let's go!
+  $stdout << WLang::file_instantiate(template, vars, "wlang/active-text")
+end

data/tasks/debug_mail.txt

@@ -0,0 +1,13 @@
+Subject: [ANN] !{lower} !{version} Released
+
+!{lower} version !{version} has been released!
+
+!{summary}
+
+*{links as l}{* <!{l}>}{!{"\n"}}
+
+!{description}
+
+Changes:
+
+!{changes}

data/tasks/gem.rake

@@ -0,0 +1,73 @@
+# Installs rake tasks for gemming and packaging
+#
+# This file installs the 'rake package', 'rake gem' tasks and associates
+# (clobber_package, repackage, ...). It is automatically generated by Noe
+# from your .noespec file, and should therefore be configured there, under
+# the variables/rake_tasks/gem entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     gem:
+#       package_dir: pkg
+#       need_tar: false
+#       need_tar_gz: false
+#       need_tar_bz2: false
+#       need_zip: false
+#       ...
+#
+# 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/gem.rake:
+#       safe-override: false
+#
+begin
+  require 'rubygems/package_task'
+
+  # Dynamically load the gem spec
+  gemspec_file = File.expand_path('../../falkorlib.gemspec', __FILE__)
+  gemspec      = Kernel.eval(File.read(gemspec_file))
+
+  Gem::PackageTask.new(gemspec) do |t|
+
+    # Name of the package
+    t.name = gemspec.name
+
+    # Version of the package
+    t.version = gemspec.version
+
+    # Directory used to store the package files
+    t.package_dir = "pkg"
+
+    # True if a gzipped tar file (tgz) should be produced
+    t.need_tar = false
+
+    # True if a gzipped tar file (tar.gz) should be produced
+    t.need_tar_gz = false
+
+    # True if a bzip2'd tar file (tar.bz2) should be produced
+    t.need_tar_bz2 = false
+
+    # True if a zip file should be produced (default is false)
+    t.need_zip = false
+
+    # List of files to be included in the package.
+    t.package_files = gemspec.files
+
+    # Tar command for gzipped or bzip2ed archives.
+    t.tar_command = "tar"
+
+    # Zip command for zipped archives.
+    t.zip_command = "zip"
+
+  end
+rescue LoadError
+  task :gem do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+  task :package do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+end