scm 0.1.0.pre1

data/lib/scm/hg.rb

@@ -0,0 +1,469 @@
+require 'scm/repository'
+require 'scm/commits/hg'
+
+require 'uri'
+
+module SCM
+  #
+  # Interacts with Mercurial (Hg) repositories.
+  #
+  class Hg < Repository
+
+    # Hg status codes
+    STATUSES = {
+      'M' => :modified,
+      'A' => :added,
+      'R' => :removed,
+      'C' => :clean,
+      '!' => :missing,
+      '?' => :untracked,
+      'I' => :ignored,
+      ' ' => :origin
+    }
+
+    #
+    # Creates a Hg repository.
+    #
+    # @param [String] path
+    #   The path to the repository.
+    #
+    # @return [Hg, URI::Generic]
+    #   The initialized local Hg repository or the URI to the remote
+    #   repository.
+    #
+    # @raise [RuntimeError]
+    #   Could not initialize the Hg repository.
+    #
+    def self.create(path,options={})
+      unless path.start_with?('ssh://')
+        FileUtils.mkdir_p(path)
+      end
+
+      unless (result = system('hg','init',path))
+        raise("unable to initialize Hg repository #{path.dump}")
+      end
+
+      if path.start_with?('ssh://')
+        return URI(path)
+      else
+        return new(path)
+      end
+    end
+
+    #
+    # Clones a remote Hg repository.
+    #
+    # @param [URI, String] uri
+    #   The URI of the remote repository.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String, Integer] :commits
+    #   The commits to include.
+    #
+    # @option options [String, Symbol] :branch
+    #   The branch to specifically clone.
+    #
+    # @option options [String] :dest
+    #   The destination directory to clone into.
+    #
+    # @return [Boolean]
+    #   Specifies whether the clone was successful.
+    #
+    def self.clone(uri,options={})
+      arguments = []
+
+      if options[:commits]
+        arguments << '--rev' << options[:commits]
+      end
+
+      if options[:branch]
+        arguments << '--branch' << options[:branch]
+      end
+
+      arguments << uri
+      arguments << options[:dest] if options[:dest]
+
+      system('hg','clone',*arguments)
+    end
+
+    #
+    # Queries the status of the repository.
+    #
+    # @param [Array] paths
+    #   Optional paths to query the statuses of.
+    #
+    # @return [Hash{String => Symbol}]
+    #   The paths and their repsective statuses.
+    #
+    def status(*paths)
+      statuses = {}
+
+      popen('hg status',*paths) do |line|
+        status, path = line.split(' ',2)
+
+        statuses[path] = STATUSES[status]
+      end
+
+      return statuses
+    end
+
+    #
+    # Adds paths to the repository.
+    #
+    # @param [Array] paths
+    #   The paths to add to the repository.
+    #
+    def add(*paths)
+      hg(:add,*paths)
+    end
+
+    #
+    # Moves a file or directory.
+    #
+    # @param [String] source
+    #   The path of the source file/directory.
+    #
+    # @param [String] dest
+    #   The new destination path.
+    #
+    # @param [Boolean] force
+    #   Specifies whether to force the move.
+    #
+    def move(source,dest,force=false)
+      arguments = []
+
+      arguments << '--force' if force
+      arguments << source << dest
+
+      svn(:mv,*arguments)
+    end
+
+    #
+    # Removes files or directories.
+    #
+    # @param [String, Array] paths
+    #   The path(s) to remove.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Boolean] :force (false)
+    #   Specifies whether to forcibly remove the files/directories.
+    #
+    # @note
+    #   {#remove} does not respond to the `:recursive` option.
+    #   Hg removes directories recursively by default.
+    #
+    def remove(paths,options={})
+      arguments = []
+
+      arguments << '--force' if options[:force]
+      arguments += ['--', *paths]
+
+      hg(:rm,*arguments)
+    end
+
+    #
+    # Makes a Hg commit.
+    #
+    # @param [String] message
+    #   The message for the commit.
+    #
+    # @param [Hash] options
+    #   Commit options.
+    #
+    # @option options [String] :paths
+    #   The path of the file to commit.
+    #
+    # @return [Boolean]
+    #   Specifies whether the commit was successfully made.
+    #
+    def commit(message=nil,options={})
+      arguments = []
+      
+      if message
+        arguments << '-m' << message
+      end
+
+      if options[:paths]
+        arguments += [*options[:paths]]
+      end
+
+      hg(:commit,*arguments)
+    end
+
+    #
+    # Lists branches in the SVN repository.
+    #
+    # @return [Array<String>]
+    #   The branch names.
+    #
+    def branches
+      branches = []
+
+      popen('hg branches') do |line|
+        branches << line[2..-1]
+      end
+
+      return branches
+    end
+
+    #
+    # The current branch.
+    #
+    # @return [String]
+    #   The name of the current branch.
+    #
+    def branch
+      popen('hg branch').chomp
+    end
+
+    #
+    # Swtiches to another Hg branch.
+    #
+    # @param [String, Symbol] name
+    #   The name of the branch to switch to.
+    #
+    # @return [Boolean]
+    #   Specifies whether the branch was successfully switched.
+    #
+    def switch_branch(name)
+      hg(:update,name)
+    end
+
+    #
+    # Deletes a branch.
+    #
+    # @param [String] name
+    #   The name of the branch to delete.
+    #
+    # @return [Boolean]
+    #   Specifies whether the branch was successfully deleted.
+    #
+    def delete_branch(name)
+      hg(:commit,'--close-branch','-m',"Closing #{name}")
+    end
+
+    #
+    # Lists Hg tags.
+    #
+    # @return [Array<String>]
+    #   The tag names.
+    #
+    def tags
+      tags = []
+
+      popen('hg tags') do |line|
+        tags << line[2..-1]
+      end
+
+      return tags
+    end
+
+    #
+    # Creates a Hg tag.
+    #
+    # @param [String] name
+    #   The name for the tag.
+    #
+    # @param [String] commit
+    #   The commit to create the tag at.
+    #
+    # @return [Boolean]
+    #   Specifies whether the tag was successfully created.
+    #
+    def tag(name,commit=nil)
+      arguments = []
+
+      if commit
+        arguments << '-r' << commit
+      end
+
+      hg(:tag,name,*arguments)
+    end
+
+    #
+    # Deletes a Hg tag.
+    #
+    # @param [String] name
+    #   The name of the tag.
+    #
+    # @return [Boolean]
+    #   Specifies whether the tag was successfully deleted.
+    #
+    def delete_tag(name)
+      hg(:tag,'--remove',name)
+    end
+
+    #
+    # Prints the Hg log.
+    #
+    # @param [String] :commit
+    #   Commit to begin the log at.
+    #
+    # @param [String] :paths
+    #   File to list commits for.
+    #
+    def log(options={})
+      arguments = []
+
+      if options[:commit]
+        arguments << '-r' << options[:commit]
+      end
+      
+      if options[:paths]
+        arguments += [*options[:paths]]
+      end
+
+      hg(:log,*arguments)
+    end
+
+    #
+    # Pushes changes to the remote Hg repository.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Boolean] :force
+    #   Specifies whether to force pushing the changes.
+    #
+    # @option options [String, Symbol] :repository
+    #   The remote repository to push to.
+    #
+    # @return [Boolean]
+    #   Specifies whether the changes were successfully pushed.
+    #
+    def push(options={})
+      arguments = []
+
+      arguments << '-f' if options[:force]
+      arguments << options[:repository] if options[:repository]
+
+      hg(:push,*arguments)
+    end
+
+    #
+    # Pulls changes from the remote Hg repository.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Boolean] :force
+    #   Specifies whether to force pushing the changes.
+    #
+    # @option options [String, Symbol] :repository
+    #   The remote repository to push to.
+    #
+    # @return [Boolean]
+    #   Specifies whether the changes were successfully pulled.
+    #
+    def pull(options={})
+      arguments = []
+
+      arguments << '-f' if options[:force]
+      arguments << options[:repository] if options[:repository]
+
+      hg(:pull,*arguments)
+    end
+
+    #
+    # Lists the commits in the Hg repository.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :commit
+    #   Commit to start at.
+    #
+    # @option options [Symbol, String] :branch
+    #   The branch to list commits within.
+    #
+    # @option options [Integer] :limit
+    #   The number of commits to list.
+    #
+    # @option options [String, Array<String>] :paths
+    #   The path(s) to list commits for.
+    #
+    # @yield [commit]
+    #   The given block will be passed each commit.
+    #
+    # @yieldparam [Commits::Hg] commit
+    #   A commit from the repository.
+    #
+    # @return [Enumerator<Commits::Hg>]
+    #   The commits in the repository.
+    #
+    def commits(options={})
+      return enum_for(:commits,options) unless block_given?
+
+      arguments = []
+
+      if options[:commit]
+        arguments << '--rev' << options[:commit]
+      end
+
+      if options[:branch]
+        arguments << '--branch' << options[:branch]
+      end
+
+      if options[:limit]
+        arguments << '--limit' << options[:limit]
+      end
+
+      if options[:paths]
+        arguments.push(*options[:paths])
+      end
+      
+      revision = nil
+      hash     = nil
+      branch   = nil
+      user     = nil
+      date     = nil
+      summary  = nil
+
+      popen('hg log',*arguments) do |line|
+        if line.empty?
+          yield Commits::Hg.new(revision,hash,branch,user,date,summary)
+
+          revision = hash = branch = user = date = summary = nil
+        else
+          key, value = line.split(' ',2)
+
+          case key
+          when 'changeset:'
+            revision, hash = value.split(':',2)
+          when 'branch:'
+            branch = value
+          when 'user:'
+            user = value
+          when 'date:'
+            date = Time.parse(value)
+          when 'summary:'
+            summary = value
+          end
+        end
+      end
+    end
+
+    protected
+
+    #
+    # Runs a Hg command.
+    #
+    # @param [Symbol] command
+    #   The Hg command to run.
+    #
+    # @param [Array] arguments
+    #   Additional arguments to pass to the Hg command.
+    #
+    # @return [Boolean]
+    #   Specifies whether the Hg command exited successfully.
+    #
+    def hg(command,*arguments)
+      run(:hg,command,*arguments)
+    end
+
+  end
+end