fact 0.1.1.a → 0.2

data/.gitignore

@@ -1 +1,3 @@
 *~
+.*.swp
+ruby.vim

data/README.md

@@ -2,7 +2,7 @@ Purpose and features
 ====================
 
 FireAphisClearerTool (FACT) is a small project intended to make a life
-with ClearCase a little bit happier. The project tries to achieve the
+with ClearCase UCM a little bit happier. The project tries to achieve the
 goal in two ways:
 
 1. Create an intuitive front end for IBM Rational ClearCase SCM.
@@ -26,6 +26,7 @@ This tool allows to perform the most common tasks in minimal amount of
 clicks and supplies only the necessary information in the most readable
 format, I could think of. Hope you will enjoy it too.
 
+The tool is intended for the UCM version of ClearCase.
 
 CLI
 ---
@@ -37,13 +38,28 @@ key presses and without the need to remember numerous commands.
 Here's the current menus hierarchy of the CLI mode:
 
 ```
-    Undelivered activities
+  |
+  +-- Create and set an activity
+  |  
+  +-- Browse undelivered activities
+  |     |
+  |     +-- Activity change set
+  |           |
+  |           +-- File information
+  |                 |
+  |                 +-- Change set predecessor diff
+  |
+  +-- Browse hijacked files
         |
-        --- Activity change set
-                |
-                --- File information
-                        |
-                        --- Change set predecessor diff
+        +-- List of hijacked files
+        |     |
+        |     +-- VOB version diff
+        |     |
+        |     +-- Undo hijack of a single file
+        |     |
+        |     +-- Check out and keep the changes of a single hijacked file
+        |
+        +-- Check out and keep the changes of all the hijacked files
 ```
 
 Dependencies

data/bin/fact

@@ -1,7 +1,7 @@
 #!/usr/bin/ruby
 
 # FireAphisClearerTool (FACT) is a small project intended to make a life
-# with ClearCase a little bit happier. The project tries to achieve the
+# with ClearCase UCM a little bit happier. The project tries to achieve the
 # goal in two ways:
 #
 # 1. Create an intuitive front end for IBM Rational ClearCase SCM.
@@ -21,26 +21,24 @@ require "fact"
 
 cc = Fact::ClearCase.new
 
-activity = Fact::Cli.choose_undelivered_activity
-
-unless activity.nil?
-  # Come back every time to showing the files in the activity
-  loop do
-    file_version = Fact::Cli.choose_file_from_activity(activity)
-
-    say("Fetching the file description... ")
-    version_info = cc.get_version_info(file_version)
-    say("Done")
-
-    puts ""
-    Fact::Cli.show_version_info(version_info)
- 
-    puts ""
-    if version_info[:checkout] != "" and version_info[:checkout] != cc.get_current_view
-      say("The file is checked out in a different view. Check it in to diff.")
-    elsif agree("Compare with the change set predecessor?")
-      say("Graphical diff is being opened in an external application.")
-      cc.diff_other_version(file_version[:file], file_version[:version], version_info[:changeset_predecessor])
-    end
-  end
+stream_name = cc.get_current_stream
+exit(true) if stream_name.empty?
+
+curr_act = cc.get_current_activity
+
+say("You are viewing ClearCase stream <%= color('#{stream_name}', BOLD) %>")
+
+if curr_act.empty?
+  say("The active activity hasn't been set. Set an activity if you wish to checkout files.")
+else
+  say("Current activity is <%= color('#{curr_act}', BOLD) %>")
+end
+
+puts ""
+choose do |menu|
+  menu.select_by = :index
+  menu.choice("Create and set an activity") { cc.create_activity(ask("Enter activity name: ")) }
+  menu.choice("Browse activities")          { Fact::Cli.browse_actifities  }
+  menu.choice("Browse hijacked files")      { Fact::Cli.browse_hijacked    } 
+  menu.choice("Exit") { exit(true) }
 end

data/lib/fact/activities_cli.rb

@@ -11,6 +11,39 @@ module Fact
 
 class Cli
 
+  # Browse all the undelivered activities in the current stream.
+  #
+  def Cli.browse_actifities
+    cc = ClearCase.new
+
+    activity = Cli.choose_undelivered_activity
+
+    unless activity.nil?
+      # Come back every time to showing the files in the activity
+      loop do
+        file_version = Cli.choose_file_from_activity(activity)
+        break if file_version.nil? # The activity doesn't contain any files
+
+        say("Fetching the file description... ")
+        version_info = cc.get_version_info(file_version)
+        say("Done")
+
+        puts ""
+        Cli.show_version_info(version_info)
+     
+        puts ""
+        if version_info[:checkout] != "" and version_info[:checkout] != cc.get_current_view
+          say("The file is checked out in a different view. Check it in to diff.")
+        elsif agree("Compare with the change set predecessor?")
+          say("Graphical diff is being opened in an external application.")
+          cc.diff_versions(file_version[:file], file_version[:version], version_info[:changeset_predecessor])
+        end
+      end
+    end
+
+  end
+
+
   # Ask the user to choose from the list of all the undelivered activities
   # in the current stream.
   # Returns the name of the chosen activity.
@@ -23,7 +56,7 @@ class Cli
     return if stream==""
 
     puts ""
-    say("The current stream is <%= color('#{stream}', BOLD) %>. Fetching the stream activities... ")
+    say("Fetching the stream activities... ")
     activities = cc.get_activities
     say("Done.")
 

data/lib/fact/clearcase.rb

@@ -4,7 +4,7 @@ module Fact
 
 class ClearTool
     def invoke(command_str)
-        return `cleartool #{command_str}`
+      return `cleartool #{command_str}`
     end
 end
 
@@ -32,6 +32,12 @@ class ClearCase
     return @cleartool.invoke("desc -pred -s #{create_cc_version(file,version)}").rstrip
   end
 
+  # Returns the name of the current activity in the current view.
+  #
+  def get_current_activity
+    return @cleartool.invoke("lsact -cact -s").rstrip
+  end
+
   # Get all the non-obsolete activities in the current view.
   # Returns an array of hashes. Each hash represents an activity and contains 
   # two keys: :name and :headline.
@@ -40,6 +46,11 @@ class ClearCase
     return parse_lsact_output(@cleartool.invoke('lsact -fmt "%[name]p,%[headline]p,"'))
   end
 
+  # Creates a new activity and sets it as the active activity.
+  def create_activity(act_name)
+    @cleartool.invoke("mkact -f -headline \"#{act_name}\"")
+  end
+
   # Get version information. The argument must be a hash with keys :file and :version.
   # Returns a version info hash.
   #
@@ -90,6 +101,58 @@ class ClearCase
     return change_set
   end
 
+  # Get a list of the hijacked files in the current directory and all the
+  # subdirectories. Return a list of hashes. Each hash having keys
+  # :file and :version.
+  #
+  def get_hijacked_files
+    # Get recursively all the files in the current and child directories
+    ls_out = @cleartool.invoke("ls -r")
+
+    files = []
+
+    ls_out.each_line do |ls_line|
+      # Find all the hijacks
+      if ls_line =~ /(.*) \[.*hijacked.*\]/
+        files.push(parse_cc_version($1))
+      end
+    end
+
+    return files
+  end
+
+  # Undo the hijack. Return to the VOB version; save the changes in .keep file.
+  # Receives a list of hijacked files as a parameter. If any of the files is not 
+  # hijacked, the behavior is undefined.
+  #
+  def undo_hijack(file_names)
+    @cleartool.invoke("update -rename #{file_names.join(' ')}")
+  end
+
+  # Chekout the hijacked files, but keep the changes. Receives a list of hijacked files
+  # as a parameter. If any of the files is not hijacked, the behavior is undefined.
+  #
+  def checkout_hijacked(file_names)
+
+    # Rename the .keep files for all the files that will be checked out.
+    # Our checkout operation will create new keep files
+    file_names.each { |file| backup_file(file + '.keep') if File.exists?(file + '.keep') }
+
+    @cleartool.invoke("co -nq -nc #{file_names.join(' ')}")
+
+    # The checkout operation reverts the file to the VOB version and copies the
+    # hijacked version to .keep file
+    file_names.each do |file|
+      keep_file = file + '.keep'
+
+      raise "Cannot find file #{file}" unless File.exists?(file)
+      raise "Cannot find file #{keep_file}" unless File.exists?(keep_file)
+
+      File.delete(file)
+      File.rename(keep_file, file)
+    end
+  end
+
   # Launches the default diff tool comparing two versions of a file.
   # The first parameter is the name of an existing file. The second and the third 
   # parameters are strings indicating versions of the same file.
@@ -97,12 +160,19 @@ class ClearCase
   # currently on the disc. Beware that if the file is checked out from a different
   # view, the diff will compare wrong files.
   #
-  def diff_other_version(file, version1, version2)
+  def diff_versions(file, version1, version2)
     ver1 = checkout_version?(version1) ? file : create_cc_version(file,version1)
     ver2 = checkout_version?(version2) ? file : create_cc_version(file,version2)
-    #diff_process = fork { exec "cleartool diff -gra #{ver1} #{ver2}" }
-    #Process.detach(diff_process)
-    `cleartool diff -gra #{ver1} #{ver2}`
+    @cleartool.invoke("diff -gra #{ver1} #{ver2}")
+  end
+
+  # Launches the default diff tool comparing the local, on-disk version of a file
+  # with the specified vob version. The version must be a qualified vob version;
+  # it won't work with checked out versions.
+  #
+  def diff_vob_version(file, version)
+    full_version = create_cc_version(file, version)
+    @cleartool.invoke("diff -gra #{full_version} #{file}")
   end
 
   # Parses a string representing ClearCase element version and converts it into a hash
@@ -154,10 +224,35 @@ class ClearCase
     return activities
   end
 
+  MAX_BACKUP_VERSIONS = 100
+
+  # Renames the specified file to <file_name>.N where N is the lowest natural number 0<N<=MAX_BACKUP_VERSION
+  # for which the file <file_name>.N doesn't yet exist. If there are already files for all the numbers or if
+  # the original file was not found, an exception will be thrown.
+  #
+  def backup_file(file_name)
+    if File.exists?(file_name)
+      # Find a new name for the file by addining a numerical suffix
+      for i in 1..MAX_BACKUP_VERSIONS+1
+        break if !File.exists?(file_name + ".#{i}")
+      end
+      if i==MAX_BACKUP_VERSIONS+1 then raise "Apparently you have at least one hundred backups for #{file_name}. Erase some and try again." end
+
+      File.rename(file_name, file_name + ".#{i}")
+    else
+      raise "Cannot find the backed up file #{file_name}"
+    end
+  end
+
+  # Returns true if the specified version string denotes a checked out version.
+  #
   def checkout_version?(version)
     return version =~ /CHECKEDOUT/
   end
 
+  # Defines how the object will access ClearTool.
+  # Used for dependency injection during unit testing.
+  #
   def cleartool=(new_ct)
     @cleartool = new_ct
   end

data/lib/fact/files_cli.rb

@@ -10,7 +10,67 @@ module Fact
 
 class Cli
 
-  # Format and print to stdout the specified information.
+  # Shows a list of all the hijacked files and allows to perform various actions
+  # on the files.
+  #
+  def Cli.browse_hijacked
+    cc = Fact::ClearCase.new
+
+    puts ""
+    say("Scanning for hijacked files in <%= color('#{File.absolute_path('.')}', BOLD) %>... ")
+    files = cc.get_hijacked_files
+    say("Done")
+
+    if files.empty?
+      say("No hijacked files.")
+    else
+      say("The hijacked files in the directory and its subdirectories are:")
+
+      # Show the hijacked files list in a menu
+      chosen_hijack = choose do |menu|
+        menu.prompt    = "Choose a file: "
+        menu.select_by = :index
+
+        files.each do |file|
+          menu.choice(file[:file]) { file  }
+        end
+
+        # Undo hijack for all the files in one command
+        file_names = files.collect {|f| f[:file]}
+        menu.choice("Keep the changes and checkout all the files") { cc.checkout_hijacked(file_names); exit(true) }
+
+        # The last entry allows graceful exit
+        menu.choice("Exit") { exit(true) }
+      end
+
+      Cli.operate_hijacked_file(chosen_hijack[:file], chosen_hijack[:version])
+
+    end
+  end
+
+  # Presents a list of operations that can be performed on a single hijacked file.
+  #
+  def Cli.operate_hijacked_file(file_name, original_version)
+    cc = Fact::ClearCase.new
+
+    puts ""
+    say("Hijacked file <%= color('#{file_name}', BOLD) %>")
+    choose do |menu|
+        menu.prompt    = "Enter command number: "
+        menu.select_by = :index
+
+        menu.choice("Compare with the latest version") do
+          puts ""
+          say("Graphical diff is being opened in an external application.")
+          cc.diff_vob_version(file_name, original_version)
+        end
+
+        menu.choice("Drop the changes and renounce the hijack") { cc.undo_hijack([file_name])       }
+        menu.choice("Keep the changes and checkout")            { cc.checkout_hijacked([file_name]) }
+        menu.choice("Exit") { exit(true) }
+      end
+  end
+
   # The parameter must be a hash with the following keys:
   #
   #     :version, :name, :activity, :date, :user,
@@ -26,7 +86,7 @@ class Cli
       last_ver_text = "#{info[:version]}"
     end
 
-    # Spliting the path and the name so the name can be shown in bold
+    # Splitting the path and the name so the name can be shown in bold
     path      = info[:name].scan(/.*\//)[0]
     file_name = info[:name].scan(/\/[^\/]+$/)[0]
     file_name.slice!(0) # Removing the leading slash

data/lib/fact/version.rb

@@ -1,3 +1,3 @@
 module Fact
-  VERSION = "0.1.1.a"
+  VERSION = "0.2"
 end

data/test/tests.rb

@@ -102,4 +102,120 @@ class ClearCaseWrapperTests < Test::Unit::TestCase
     assert_equal(expected, change_set)
   end
 
+  def test_get_hijacked_files
+    # Define the expected calls
+    ct = MockClearTool.new
+    ct.add_invocation('ls -r', 
+      [ "Connect",
+        "a1.cpp.obsolete@@/main/fact_1.0_Integ/4        Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "a2.h.obsolete@@/main/fact_1.0_Integ/5          Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "a3.cpp.obsolete@@/main/fact_1.0_Integ/fireaphis_1.0_2/1             Rule: .../fireaphis_1.0_2/LATEST",
+        "a4.h.obsolete@@/main/fact_1.0_Integ/fireaphis_1.0_2/2               Rule: .../fireaphis_1.0_2/LATEST",
+        "a5.h.obsolete@@/main/fact_1.0_Integ/2        Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "a6.cpp.obsolete@@/main/fact_1.0_Integ/fireaphis_1.0_2/4                Rule: .../fireaphis_1.0_2/LATEST",
+        "a7.h.obsolete@@/main/fact_1.0_Integ/fireaphis_1.0_2/3  Rule: .../fireaphis_1.0_2/LATEST",
+        "a8.h.obsolete@@/main/fact_1.0_Integ/3         Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "a9.cpp.keep",
+        "a10.cpp.keep.1",
+        "a11.cpp.keep.2",
+        "a12.h@@/main/fireaphis_1.0_2/4   Rule: .../fireaphis_1.0_2/LATEST",
+        "a13.h@@/main/fact_1.0_Integ/2  Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "a14.h@@/main/fact_1.0_Integ/1            Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "a15.cpp@@/main/fact_1.0_Integ/4  Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "a16.h@@/main/fact_1.0_Integ/fireaphis_1.0_2/2 [hijacked]             Rule: .../fireaphis_1.0_2/LATEST",
+        "a17.h@@/main/fact_1.0_Integ/1               Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "test@@/main/fact_1.0_Integ/fireaphis_1.0_2/3    Rule: .../fireaphis_1.0_2/LATEST",
+        "./test/a18.h.obsolete@@/main/fact_1.0_Integ/3 [hijacked] Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "./test/a19.cpp.obsolete@@/main/fact_1.0_Integ/9  Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "./test/a20.cpp@@/main/fact_1.0_Integ/3 [hijacked]            Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "./test/a21.h@@/main/fact_1.0_Integ/fireaphis_1.0_2/2     Rule: .../fireaphis_1.0_2/LATEST",
+        "./test/a22.cpp.obsolete@@/main/fact_1.0_Integ/3              Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2",
+        "./test/a23.h.obsolete@@/main/fact_1.0_Integ/2                Rule: fact_1.0_1.0.0.0-663_31-MAY-2011_02.22.291 -mkbranch fireaphis_1.0_2"
+      ].join("\n"))
+
+    cc = Fact::ClearCase.new
+    cc.cleartool = ct
+
+    hijacked = []
+
+    err = catch(:wrongInvocation) { hijacked = cc.get_hijacked_files }
+    assert(ct.succeeded, err)
+
+    expected = [{:file=>"a16.h",                 :version=>"/main/fact_1.0_Integ/fireaphis_1.0_2/2"},
+                {:file=>"./test/a18.h.obsolete", :version=>"/main/fact_1.0_Integ/3"                },
+                {:file=>"./test/a20.cpp",        :version=>"/main/fact_1.0_Integ/3"                }] 
+    assert_equal(expected, hijacked)
+  end
+
+end
+
+
+class FileBackupTests < Test::Unit::TestCase
+
+  def setup
+    @dir  = "test_backup_file" 
+    @file = "#{@dir}/test.cpp.keep"
+    Dir.mkdir(@dir)
+  end
+
+  def teardown
+    system("rm -r #{@dir}")
+  end
+
+  def test_no_file
+    # Create existing backup files
+    (1 .. Fact::ClearCase::MAX_BACKUP_VERSIONS).each do |ver| 
+      File.open("#{@file}.#{ver}", "w") { |f| f.write("booga") }
+    end
+    # Ensure that the correct number of files was created
+    assert_equal(Fact::ClearCase::MAX_BACKUP_VERSIONS+2, Dir.entries(@dir).size)
+
+    cc = Fact::ClearCase.new
+    # The method should raise because the backed up file doesn't exist
+    assert_raise(RuntimeError) { cc.backup_file(@file) }
+    # Ensure that no new files were added
+    assert_equal(Fact::ClearCase::MAX_BACKUP_VERSIONS+2, Dir.entries(@dir).size)
+  end
+
+  def test_99_files
+    # Create the file that will be backed up
+    File.open(@file, "w") {|f| f.write("booga")}
+
+    # Create existing backup files
+    (1 .. Fact::ClearCase::MAX_BACKUP_VERSIONS-1).each do |ver| 
+      File.open("#{@file}.#{ver}", "w") { |f| f.write("booga") }
+    end
+    # Ensure that the correct number of files was created
+    assert_equal(Fact::ClearCase::MAX_BACKUP_VERSIONS+2, Dir.entries(@dir).size)
+    # Ensure that the back-up file that will be created doesn't exist yet
+    assert(!File.exists?("#{@file}.#{Fact::ClearCase::MAX_BACKUP_VERSIONS}"))
+
+    cc = Fact::ClearCase.new
+    assert_nothing_raised { cc.backup_file(@file) }
+    # Ensure that the backup was created
+    assert(File.exists?("#{@file}.#{Fact::ClearCase::MAX_BACKUP_VERSIONS}"))
+    # The orginal file should not exist now
+    assert(!File.exists?(@file))
+  end
+
+  def test_100_files
+    # Create the file that will be backed up
+    File.open(@file, "w") {|f| f.write("booga")}
+
+    # Create existing backup files
+    (1 .. Fact::ClearCase::MAX_BACKUP_VERSIONS).each do |ver| 
+      File.open("#{@file}.#{ver}", "w") { |f| f.write("booga") }
+    end
+    # Ensure that the correct number of files was created
+    assert_equal(Fact::ClearCase::MAX_BACKUP_VERSIONS+3, Dir.entries(@dir).size)
+
+    cc = Fact::ClearCase.new
+    # The method should raise because there are too many back up files 
+    assert_raise(RuntimeError) { cc.backup_file(@file) }
+    # Ensure that no new files were added
+    assert_equal(Fact::ClearCase::MAX_BACKUP_VERSIONS+3, Dir.entries(@dir).size)
+    # The orginal file should still exist
+    assert(File.exists?(@file))
+  end
+
 end

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: fact
 version: !ruby/object:Gem::Version
-  version: 0.1.1.a
-  prerelease: 6
+  version: '0.2'
+  prerelease: 
 platform: ruby
 authors:
 - FireAphis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-31 00:00:00.000000000 +03:00
+date: 2011-07-22 00:00:00.000000000 +03:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &83707590 !ruby/object:Gem::Requirement
+  requirement: &77118360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: 1.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *83707590
+  version_requirements: *77118360
 description: A small project intended to make a life with ClearCase a little bit happier.
   It supplies an intuitive and interactive ClearCase CLI and ClearCase wrapper API.
 email:
@@ -66,9 +66,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - ClearCase ClearTool
 rubyforge_project: fact