clearcase_helper 0.4.9

data/.gitignore

@@ -0,0 +1,6 @@
+.idea/*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.envrc

data/.hgignore

@@ -0,0 +1,8 @@
+syntax: glob
+
+.idea/*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.envrc

data/.hgtags

@@ -0,0 +1 @@
+8366d2e2a96a82def065e71d4f3382087a215105 github/master

data/ChangeLog.md

@@ -0,0 +1,11 @@
+# Change Log
+
+ClearCase Helper is a small command line utility to make some aspects of ClearCase more accessible.
+
+    gem install clearcase_helper
+    cch help
+
+## v0.4.9
+
+* added .ccignore file support to control which files and directories should not be tracked [thx @TyMi]
+* some gem build cleanups

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Thomas Steinhausen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+ClearCase Helper
+================
+
+ClearCase Helper is a small command line utility to make some aspects of ClearCase more accessible.
+
+It originated from the wish to use a distributed version control system (hg, git) as the primary VCS and the need to update the clearcase repository in regular intervals.
+
+Clearcase Helper wraps cleartool and builds upon its command set some new ones.
+These commands especially allow you to add, remove, checkout hijacked and checkin files in a recursive manner.
+Additionally you can view the status of the view files in a familiar way and add labels (tag) a bunch of files in one go.
+
+By default files and directories that match .hg*, .svn* and .git* are ignored by all operations.
+To control this behaviour it is possible to supply a .ccignore file with regexp patterns for files/directories that should be ignored.
+
+Beware that ClearCase Helper is only an addition to the clearcase toolchain and not a substitute.
+
+
+Install
+-------
+
+    gem install clearcase_helper
+
+
+Usage
+-----
+
+    cch help
+
+To recursively ignore some files, it is possible to create a .ccignore file with regexp patterns ([ruby Regexp](http://rubular.com)).
+.ccignore files are only evaluated in the current working directory of cch.
+
+Prerequesites
+------------
+
+  - cleartool
+  - ruby 1.9.2
+  - a snapshot view
+
+Tested with cleartool version 7.1.1.2 on Windows 7 with ruby 1.9.2p0.
+
+
+Build
+-----
+
+    rake build # this creates the gem in pkg/
+    rake install # this task creates and installs the gem
+
+
+Licence
+-------
+
+See LICENSE

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/cch

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+require File.dirname(__FILE__)+'/../lib/clearcase_helper'
+require File.dirname(__FILE__)+'/../lib/clearcase_helper/cli'
+
+ClearcaseHelper::CLI.start

data/clearcase_helper.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "clearcase_helper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "clearcase_helper"
+  s.version     = ClearcaseHelper::VERSION
+  s.authors     = ["Thomas Steinhausen"]
+  s.email       = ["ts@image-addicts.de"]
+  s.homepage    = ""
+  s.summary     = %q{A tool to help on some aspects of clearcase annoyances.}
+  s.description = <<-D
+    Clearcase has no simple to use command line tool
+
+      - to find and add view only files in a recursive manner
+      - to checkout and checkin hijacked files.
+
+    This tool is a simple wrapper to cleartool which allows just that.
+
+    Usage:
+
+      $ cch help
+  D
+
+  files = if File.directory?('.git')
+            `git ls-files`.split($/)
+          elsif File.directory?('.hg')
+            `hg manifest`.split("\n").collect {|f| f.gsub(/^[0-9]+\s+/, '')}
+          else
+            Dir.glob(%w(* bin/* lib/**/*))
+          end
+
+  s.files         = files
+  s.test_files    = []
+  s.executables   = s.files.select {|f| f.match /bin\// }.map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_runtime_dependency "thor", "~>0.17"
+end

data/lib/clearcase_helper.rb

@@ -0,0 +1,11 @@
+$:.push File.expand_path("..", __FILE__)
+
+require 'shellwords'
+
+require "clearcase_helper/version"
+require "clearcase_helper/executables"
+require "clearcase_helper/view"
+require "clearcase_helper/cc_file"
+
+module ClearcaseHelper
+end

data/lib/clearcase_helper/cc_file.rb

@@ -0,0 +1,123 @@
+module ClearcaseHelper
+  class CCFile
+    include Executables
+
+    attr_accessor :file
+    attr_accessor :view
+
+    def initialize(file_name, view)
+      @file = file_name
+      @view = view
+    end
+
+    def is_hijacked?
+      file.match /\[hijacked\]/
+    end
+
+    def is_view_only?
+      !file.match /@@/
+    end
+
+    def is_checkedout?
+      file.match /@@[^\s]+CHECKEDOUT/
+    end
+
+    def is_missing?
+      file.match /\[loaded but missing\]/
+    end
+
+    def is_checkedin?
+      short_status.strip.empty?
+    end
+
+    def short_status
+      return 'HI' if is_hijacked?
+      return 'CO' if is_checkedout?
+      return '~ ' if is_missing?
+      return '? ' if is_view_only?
+      return '  '
+    end
+
+    def file?
+      File.file?(self.to_s)
+    end
+
+    def directory?
+      File.directory?(self.to_s)
+    end
+
+    def parent_dirname
+      File.dirname(self.to_s)
+    end
+
+    # Refreshes state and returns self.
+    #
+    # @return [CCFile]
+    def refresh_status(options={})
+      success, stdout = cleartool("ls #{directory? ? '-directory' : ''} #{self.to_s.shellescape}", options)
+      @file = stdout.strip
+
+      self
+    end
+
+    def add!(options={})
+      parent = view.file_for(parent_dirname, options)
+      if parent.is_view_only?
+        parent.add!(options)
+        parent.refresh_status(options)
+      end
+
+      parent.checkout!(options) unless parent.is_checkedout?
+      success, stdout = cleartool("mkelem -c \"\" -ptime #{file.to_s.shellescape}", options)
+
+      refresh_status(options)
+
+      success
+    end
+
+    def remove!(options={})
+      parent = view.file_for(parent_dirname, options)
+
+      parent.checkout!(options) unless parent.is_checkedout?
+      success, stdout = cleartool("rmname -c \"\" #{self.to_s.shellescape}", options)
+
+      
+      if success
+        # no need to refresh file because this file does not exist anymore,
+        # so just remove it from the identity map
+        view.forget_file(self)
+      else
+        # do refresh status since deletion failed
+        refresh_status(options)
+      end
+
+      success
+    end
+
+    # @param Hash[Symbol => String] - :comment => 'some comment'
+    def checkin!(options={})
+      comment = options[:comment] || ''
+      success, stdout = cleartool("ci -c \"#{comment.shellescape}\" -identical -ptime #{self.to_s.shellescape}", options)
+
+      refresh_status(options)
+
+      success
+    end
+
+    def checkout!(options={})
+      success, stdout = cleartool("co -c \"\" -ptime -nwarn #{is_hijacked? ? '-usehijack' : ''} #{self.to_s.shellescape}", options)
+
+      refresh_status(options)
+
+      success
+    end
+
+    def to_s
+      @file_as_string ||= file.gsub(/@@.*$/, '')
+    end
+
+    def <=>(other)
+      self.to_s <=> other.to_s
+    end
+  end
+end

data/lib/clearcase_helper/cli.rb

@@ -0,0 +1,106 @@
+require 'thor'
+
+module ClearcaseHelper
+  class CLI < Thor
+    class_option :verbose, :default => false, :type => :boolean, :desc => "Show executed cleartool commands and its results on stdout."
+    class_option :noop,    :default => false, :type => :boolean, :desc => "Do nothing to the clearcase view. cleartool is not executed."
+    class_option :nostdout,:default => false, :type => :boolean, :desc => "Do not show the cleartool output when verbose is on."
+
+    desc "status [PATH]", "Shows files in this view prefixed with its short status (CO: checkedout, HI: hijacked, ~: loaded but missing, ?: only in view)."
+    method_option :long, :default => false, :aliases => ['-l'], :desc => 'Show all files, including those that have no special state.'
+    def all_files(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.all_files_with_status(false, options)
+    end
+    map ['st'] => :all_files
+
+    desc "view_only_files [PATH]", "Shows all files that are not added to this view (unversioned files)."
+    def view_only_files(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.view_only_files(false, options)
+    end
+    map 'vof' => :view_only_files
+
+    desc "hijacked_files [PATH]", "Shows all files that are hijacked."
+    def hijacked_files(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.hijacked_files(false, options)
+    end
+    map 'hif' => :hijacked_files
+
+    desc "checkedout_files [PATH]", "Shows all files that are checked out."
+    def checkedout_files(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.checkedout_files(false, options)
+    end
+    map 'cof' => :checkedout_files
+
+    desc "missing_files [PATH]", "Shows all files that are loaded but missing in view."
+    def missing_files(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.missing_files(false, options)
+    end
+    map 'mf' => :missing_files
+
+    desc "checkout_highjacked [PATH]", "Checks out all highjacked files."
+    def checkout_highjacked(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.checkout_highjacked!(options)
+    end
+    map 'cohi' => :checkout_highjacked
+
+    desc "checkin [PATH]", "Checks in all checked out files."
+    method_option :comment, :default => '', :aliases => ['-c', '-m'], :desc => 'use <comment> as commit message'
+    def checkin_checkedout(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.checkin_checkedout!(options)
+    end
+    map ['ci', 'checkin'] => :checkin_checkedout
+
+    desc "checkin_hijacked [PATH]", "Checks hijacked files out and in again."
+    method_option :comment, :default => '', :aliases => ['-c', '-m'], :desc => 'use <comment> as commit message'
+    def checkin_hijacked(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.checkin_hijacked!(options)
+    end
+    map 'cihi' => :checkin_hijacked
+
+    desc "add_view_only_files [PATH]", "Recursively adds and checks in files that are not yet versioned."
+    def add_view_only_files(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.add_view_only_files!(options)
+    end
+    map ['avo', 'add'] => :add_view_only_files
+
+    desc "remove_missing_files [PATH]", "Removes files (rmname) that are loaded but deleted from view."
+    def remove_missing_files(path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.remove_missing_files!(options)
+    end
+
+    desc "create_and_add_label label [PATH]", "Creates a label type and adds it recursively to all files in current view path."
+    method_option :comment, :default => '', :aliases => ['-c', '-m'], :desc => 'use <comment> as commit message'
+    def create_and_add_label(label, path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.make_label_type(label, options)
+      puts view.make_label(label, options)
+    end
+
+    desc "add_label label [PATH]", "Adds an existing label recursively to all files in current view path."
+    method_option :comment, :default => '', :aliases => ['-c', '-m'], :desc => 'use <comment> as commit message'
+    def add_label(label, path='.')
+      view = ClearcaseHelper::View.new(path)
+      puts view.make_label(label, options)
+    end
+
+    desc "heaven", "Show real help."
+    def heaven
+      $stderr.puts 'NO HEAVEN HERE - use a proper VCS!'
+    end
+
+    desc "version", "Show the version"
+    def version
+      puts VERSION
+    end
+  end
+end

data/lib/clearcase_helper/executables.rb

@@ -0,0 +1,22 @@
+module ClearcaseHelper
+  module Executables
+    # @param [String] command for dleartool to execute. including all cleartool options.
+    # @param [Hash] options :noop => boolean, :vebose => boolean, :nostdout => boolean
+    # @return [Array[Boolean, String]] success, stdout
+    def cleartool(command, options={})
+      cmd = "cleartool #{command}"
+
+      stdout  = options[:noop] ? '' : `#{cmd}`
+      success = $? == 0
+
+      puts "# #{cmd} (#{$?}, #{success})=>" if options[:verbose]
+      if options[:verbose] && !options[:nostdout] && !stdout.empty?
+        puts stdout.split("\n").collect {|l| "  #{l}"}.join("\n")
+      end
+
+      $stdout.flush
+
+      return success, stdout
+    end
+  end
+end

data/lib/clearcase_helper/version.rb

@@ -0,0 +1,3 @@
+module ClearcaseHelper
+  VERSION = "0.4.9"
+end

data/lib/clearcase_helper/view.rb

@@ -0,0 +1,137 @@
+module ClearcaseHelper
+  class View
+    include Executables
+
+    attr_reader :view_path
+    attr_reader :identity_map
+
+    def initialize(view_path)
+      @view_path = view_path
+    end
+
+    def files(refresh=false, options={})
+      if @files and !refresh
+        return @files
+      end
+
+      success, stdout = cleartool("ls -recurse #{@view_path.shellescape}", options)
+
+      # load excludes from .ccignore
+      ccignore_file = File.join(@view_path,'.ccignore')
+      ccignore = if File.exist?(ccignore_file)
+                   File.readlines(ccignore_file).map {|ignore| ignore.strip}
+                 else
+                   %w(\.hg|\.git|\.svn)
+                 end
+
+      raw_files = stdout.split(/\n/)
+      raw_files.reject! do |f|
+        ccignore.any? do |ignore|
+          f.match(/#{ignore}/)
+        end
+      end # filter excluded files / folders
+
+      @files = raw_files.map {|f| CCFile.new(f, self)}
+      @identity_map = @files.inject({}) {|memo, file| memo[file.to_s] = file; memo}
+
+      @files
+    end
+
+    def view_only_files(refresh=false, options={})
+      files(refresh, options).select {|f| f.is_view_only?}
+    end
+
+    def hijacked_files(refresh=false, options={})
+      files(refresh, options).select {|f| f.is_hijacked?}
+    end
+
+    def checkedout_files(refresh=false, options={})
+      files(refresh, options).select {|f| f.is_checkedout?}
+    end
+
+    def missing_files(refresh=false, options={})
+      files(refresh, options).select {|f| f.is_missing?}
+    end
+
+    def all_files_with_status(refresh=false, options={})
+      show_short = !options[:long]
+
+      files(refresh, options).reject {|file| show_short and file.is_checkedin?}.collect do |file|
+        "#{file.short_status} #{file}"
+      end
+    end
+
+    # @param [String, CCFile] file to get from the identity map. If the file is missing a new instance is added to the map and returned.
+    # @return [CCFile]
+    def file_for(file, options={})
+      file = file.to_s.strip
+
+      cc_file = @identity_map[file]
+
+      if cc_file.nil? && !file.empty?
+        cc_file = @identity_map[file] = CCFile.new(file, self).refresh_status(options)
+      end
+
+      cc_file
+    end
+
+    # Removes given file from this views identity map.
+    # Used by the remove! file action to cleanup view state on success.
+    #
+    # @param [String, CCFile] file to forget in the identity map.
+    # @return [CCFile] the file that has been removed from the identity map.
+    def forget_file(file)
+      @identity_map.delete(file)
+    end
+
+    # @param Hash[Symbol => String] - :comment => 'some comment', :debug => boolean, :noop => :boolean
+    def checkin_checkedout!(options={})
+      checkedout_files(false, options.merge(:nostdout => true, :noop => false)).each do |file|
+        file.checkin!(options)
+      end
+    end
+
+    # @param Hash[Symbol => String] - :debug => boolean, :noop => :boolean
+    def checkout_highjacked!(options={})
+      hijacked_files(false, options.merge(:nostdout => true, :noop => false)).each do |file|
+        file.checkout!(options)
+      end
+    end
+
+    # @param Hash[Symbol => String] - :debug => boolean, :noop => :boolean
+    def checkin_hijacked!(options={})
+      hijacked_files(false, options.merge(:nostdout => true, :noop => false)).each do |file|
+        file.checkout!(options)
+        file.checkin!(options)
+      end
+    end
+
+    # @param Hash[Symbol => String] - :debug => boolean, :noop => :boolean
+    def add_view_only_files!(options={})
+      view_only_files(false, options.merge(:nostdout => true, :noop => false)).sort.each do |file|
+        file.add!(options)
+      end
+    end
+
+    # @param Hash[Symbol => String] - :debug => boolean, :noop => :boolean
+    def remove_missing_files!(options={})
+      missing_files(false, options.merge(:nostdout => true, :noop => false)).sort.reverse.each do |file|
+        file.remove!(options)
+      end
+    end
+
+    # @param String label - the label type name to create
+    # @param Hash[Symbol => String] - :debug => boolean, :noop => :boolean
+    def make_label_type(label, options={})
+      comment = (options[:comment] || '') + ": #{@view_path}"
+      cleartool("mklbtype -c \"#{comment.shellescape}\" #{label.shellescape}", options)
+    end
+
+    # @param String label - the label name to apply recursively to all files in actual view path
+    # @param Hash[Symbol => String] - :debug => boolean, :noop => :boolean
+    def make_label(label, options={})
+      comment = options[:comment] || ''
+      cleartool("mklabel -c \"#{comment.shellescape}\" -recurse #{label.shellescape} #{@view_path.shellescape}", options)
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: clearcase_helper
+version: !ruby/object:Gem::Version
+  version: 0.4.9
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Steinhausen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: ! "    Clearcase has no simple to use command line tool\n\n      - to
+  find and add view only files in a recursive manner\n      - to checkout and checkin
+  hijacked files.\n\n    This tool is a simple wrapper to cleartool which allows just
+  that.\n\n    Usage:\n\n      $ cch help\n"
+email:
+- ts@image-addicts.de
+executables:
+- cch
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .hgignore
+- .hgtags
+- ChangeLog.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/cch
+- clearcase_helper.gemspec
+- lib/clearcase_helper.rb
+- lib/clearcase_helper/cc_file.rb
+- lib/clearcase_helper/cli.rb
+- lib/clearcase_helper/executables.rb
+- lib/clearcase_helper/version.rb
+- lib/clearcase_helper/view.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4122144388664280151
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4122144388664280151
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A tool to help on some aspects of clearcase annoyances.
+test_files: []