Rakefile.rb

# Creative Commons BY-SA :  Regis d'Aubarede <regis.aubarede@gmail.com>
# LGPL
#################################################################
#  Rakefile : git commit/add ; git push, test/spec & gem push
#################################################################
#
# Usage:
# > rake commit  # commit in local directory and push to repository
# > rake gem     # make gem,and test it, and push it to gemcutter
# > rake travis  # travis CI run commands
#
#################################################################
#  Requirements :
#   version : X.Y.Z  
#           X : to be hand-modified 
#           Y : incremented at each 'rake gem'
#           Z : increment on each file 'rake commit'
#   auto commit all changed file, sking comment for each
#   log all commment in CHANGELOG?Txt file
#   increment VERSION content with version numbering rule
#     so CHANGELOG.txt is updated with each comment/version change
#     so VERSION is updated in each commit (Z part) and each gem build (Y part) 
#   
# commit:
#   Use 'git status' output for each new/modified file,
#   with asking some comment
#   (no add/commit of comment is empty)
#
# gem:
#   execute rspec if specs exists,
#   make a gem, install it, execute samples/test.rb in it, if exist
#   ask to operator if execution is ok and : 
#      increment version
#      update change log/version
#      do a 'gem push' and a 'gem yanked'
#    make a coffe
#
#################################################################

FIGNORES=%w{VERSION CHANGELOG.txt .gitignore}
NAME= Dir.glob("*.gemspec").first.split(".").first

Rake.application.options.trace = false

def push_changelog(line)
  b=File.read('CHANGELOG.txt').split(/\r?\n/) 
  b.unshift(line)
  File.open('CHANGELOG.txt','w') {|f| f.write(b[0..500].join("\n")) }
end
def changelog_push_currrent_versions()
  version=File.read('VERSION').strip
  b=File.read('CHANGELOG.txt').split(/\r?\n/) 
  b.unshift(version)  
  File.open('CHANGELOG.txt','w') {|f| f.write(b.join("\n")) }
  yield rescue p $!.to_s
  b.shift  
  File.open('CHANGELOG.txt','w') {|f| f.write(b.join("\n")) }
end

def change_version()
  a=File.read('VERSION').strip.split('.')[0..2]
  yield(a)
  version=a.join('.') 
  File.open('VERSION','w') {|f| f.write(version) }
  version
end
def verification_file(fn)
  return unless File.extname(fn)==".rb"
  content=File.read(fn)[0..600]
  unless content =~ /BY-SA/ && content =~ /LGPL/
    puts "\nFile #{fn} seem not contain licenses data (LGPL/BY-SA)\n"   
    exit(0)
  end
end
#############################################################
#               Comment each file add/modified             ##
#############################################################


desc "commit file changed and created"
task :commit_status do
  `git status -s`.split(/\r?\n/).each do |line|
  words=line.split(/\s+/)
  case line
    when /^ M /
      filename=words[2]
      next if FIGNORES.include?(filename)
      system("git","diff",filename)
      print("Comment for change in #{filename} : ")
      comment=$stdin.gets
      if comment && comment.chomp.size>0
          comment.chomp!
          (puts "Abort!";exit!)   if comment=~/^a(b(o(r(t)?)?)?)?$/
          verification_file(filename)
          sh "git commit #{filename} -m \"#{comment.strip}\"" rescue 1
          push_changelog("    #{File.basename(filename)} : #{comment}")
          $changed=true
      end
    when /^\?\?/
      filename=words[1]
      print("Comment for new file in #{filename} : ")
      comment=$stdin.gets.chomp
        (puts "Abort!";exit!)   if comment=~/^a(b(o(r(t)?)?)?)?$/
      if comment =~ /^y|o/i
        verification_file(filename)
        sh "git add #{filename}"
        sh "git commit #{filename} -m \"creation\"" rescue 1
        $changed=true
      end
  end
  end
end


#############################################################
#  before commit
#############################################################

desc "job before commit"
task :pre_commit do
  sh "cls" if RUBY_PLATFORM =~ /(win32)|(mingw)/i 
  puts <<EEND2


--------------------------------------------------------------------
                 Commmit and push #{NAME}
--------------------------------------------------------------------
EEND2
  
  sh "giti" if RUBY_PLATFORM =~ /(win32)|(mingw)/i
  $changed=false
end

#############################################################
#  after commit
#############################################################
desc "job after local commit done: push to git repo"
task :post_commit do
  if $changed
    $version=change_version { |a| a[-1]=(a.last.to_i+1) }  
    sh "git commit VERSION -m update"
    changelog_push_currrent_versions {
      sh "git commit CHANGELOG.txt -m update"
      sh "git push"
      puts "\n\nNew version is #{$version}\n"
    } 
  else
    puts "no change!"
  end
end

#############################################################
#   commit
#############################################################
desc "commit local and then distant repo"
task :commit => [:pre_commit,"commit_status",:post_commit]


#############################################################
#  gem build & push
#############################################################
desc "make a gem and push it to gemcutter"
task :gem  do
  puts <<EEND


--------------------------------------------------------------------
       make gem, test it localy, and push gem #{NAME} to gemcutter
--------------------------------------------------------------------
EEND
  ruby "samples/make_doc.rb","1"
  sh "git commit doc.html -m update"
  #sh "git push"
  $version=change_version { |a| 
      a[-2]=(a[-2].to_i+1) 
      a[-1]=0 
  }   
  puts "New version ==>> #{$version}"
  l=FileList['*.gem']
  l.each { |fn| rm fn }
  gem_name="#{NAME}-#{$version}.gem"
  push_changelog  "#{$version} : #{Time.now}"
  sh "gem build #{NAME}.gemspec"
  Rake::Task["test"].execute    if File.exists?("samples/test.rb")
  sh "gem push #{gem_name}"
  l.each { |fn|
      ov=fn.split('-')[1].gsub('.gem',"")
    sh "gem yank -v #{ov} #{NAME}"
  }
end
#############################################################
#  execute tests 
#############################################################

desc "test the current version of the framework by installing the gem and run a test programme"
task :test do
 if File.exists?("spec/test_all.rb")
  system("rspec spec/test_all.rb")
 end
 if File.exists?("samples/test.rb")
   origin=Dir.pwd
   cd ".."
   mkdir "#{NAME}Test" unless File.exists?("#{NAME}Test")
   nname="#{NAME}Test/test.rb"
   content=File.read("#{origin}/samples/test.rb").gsub(/require_relative/," require").gsub('../lib/','')
   File.open(nname,"w") { |f| f.write(content) }
   sh "gem install #{Dir.glob("#{origin}/#{NAME}*.gem").last}"
   ruby nname rescue nil
   cd origin
   print "\n\nOk for diffusion ? "
   rep=$stdin.gets
   raise("aborted!") unless rep && rep =~ /^y|o|d/
 end
end

#############################################################
#  travis command 
#############################################################

task :travis do
 puts "Starting travis test..."
 cmd="bundle exec rspec spec/test_all.rb"
 cmd="rspec spec/test_all.rb"
 system("export DISPLAY=:99.0 && #{cmd}")
 system(cmd)
 raise "rspec failed!" unless $?.exitstatus == 0
end