mercurial-ruby 0.3.0

data/lib/mercurial-ruby/commit.rb

@@ -0,0 +1,152 @@
+module Mercurial
+  
+  #
+  # The class represents Mercurial changeset. Obtained by running an +hg log+ command.
+  # Contains a lot of information, including it's hash ID, author name and email, list of changed files, etc.
+  #
+  # The class represents Commit object itself, {Mercurial::CommitFactory CommitFactory} is responsible
+  # for assembling instances of Commit. For the list of all possible commit-related operations please 
+  # look documentation for {Mercurial::CommitFactory CommitFactory}.
+  #
+  # Read more about Mercurial commits:
+  #
+  # http://mercurial.selenic.com/wiki/Commit
+  #
+  class Commit
+    include Mercurial::Helper
+    
+    # Instance of {Mercurial::Repository Repository}.
+    attr_reader :repository
+    
+    # Mercurial changeset ID. 40-chars long SHA1 hash.
+    attr_reader :hash_id
+    
+    # Name of the user committed the change.
+    attr_reader :author
+    
+    # Email of the user committed the change.
+    attr_reader :author_email
+    
+    # Exact date and time of the commit. Contains Ruby Time object.
+    attr_reader :date
+    
+    # Full commit message, with line breaks and other stuff.
+    attr_reader :message
+    
+    # Array of {Mercurial::ChangedFile ChangedFile} objects.
+    attr_reader :changed_files
+    
+    # Array of commit's branches.
+    attr_reader :branches_names
+    
+    # Array of commit's tags.
+    attr_reader :tags_names
+    
+    # Array of commit's parents.
+    attr_reader :parents_ids
+    
+    alias :id :hash_id
+    
+    def initialize(repository, opts={}) #:nodoc:
+      @repository     = repository
+      @hash_id        = opts[:hash_id]
+      @author         = opts[:author]
+      @author_email   = opts[:author_email]
+      @date           = Time.iso8601(opts[:date])
+      @message        = opts[:message]
+      @changed_files  = files_to_array(opts[:changed_files])
+      @branches_names = branches_or_tags_to_array(opts[:branches_names])
+      @tags_names     = branches_or_tags_to_array(opts[:tags_names])
+      @parents_ids    = parents_to_array(opts[:parents])
+    end
+    
+    def merge?
+      parents.size > 1
+    end
+    
+    def blank?
+      hash_id == '0'*40
+    end
+    
+    def diffs
+      repository.diffs.for_commit(self)
+    end
+    
+    def parents
+      repository.commits.by_hash_ids(parents_ids)
+    end
+    
+    def parent_id
+      parents_ids.first
+    end
+    
+    def exist_in_branches
+      repository.branches.for_commit(hash_id)
+    end
+    
+    def to_hash
+      {
+        'id'       => hash_id,
+        'parents'  => parents_ids.map { |p| { 'id' => p.id } },
+        'branches' => branches_names,
+        'tags'     => tags_names,
+        'message'  => message,
+        'date'     => date,
+        'author'   => {
+          'name'  => author,
+          'email' => author_email
+        }
+      }
+    end
+    
+  protected
+  
+    def files_to_array(array)
+      [].tap do |returning|
+        array.each do |files|
+          if files
+            files.split(';').map do |file_with_mode|
+              returning << Mercurial::ChangedFileFactory.new_from_hg(file_with_mode)
+            end
+          end
+        end
+        
+        remove_files_duplicates(returning)
+      end
+    end
+    
+    def remove_files_duplicates(files)
+      Mercurial::ChangedFileFactory.delete_hg_artefacts(files)
+    end
+    
+    def branches_or_tags_to_array(branches_str)
+      string_to_array(branches_str) do |returning|
+        returning << branches_str
+      end
+    end
+    
+    def parents_to_array(string)
+      string_to_array(string) do |returning|
+        string.split(' ').map do |hg_hash|
+          returning << hg_hash_to_hash_id(hg_hash)
+        end
+      end
+    end
+    
+    def string_to_array(string, &block)
+      if string && !string.empty?
+        [].tap do |returning|
+          block.call(returning)
+        end
+      else
+        []
+      end
+    end
+    
+    def hg_hash_to_hash_id(hg_hash)
+      hg_hash.split(':').last
+    end
+    
+  end
+  
+end

data/lib/mercurial-ruby/config_file.rb

@@ -0,0 +1,119 @@
+module Mercurial
+  
+  #
+  # Represents +.hg/hgrc+ configuration file stored in the repository.
+  # Useful for adding/removing various settings.
+  #
+  # You can read more about hgrc here:
+  #
+  # http://www.selenic.com/mercurial/hgrc.5.html
+  #
+  class ConfigFile
+    
+    attr_reader :repository
+    
+    def initialize(repository)
+      @repository = repository
+    end
+    
+    #
+    # Returns absolute path to the config file:
+    #
+    #  config.path # => /home/ilya/repos/fancyrepo/.hg/hgrc
+    #
+    def path
+      File.join(repository.path, '.hg', 'hgrc')
+    end
+    
+    #
+    # Returns true if the config file actually exists on disk.
+    # For new repositories it's missing by default.
+    #
+    def exists?
+      File.exists?(path)
+    end
+    
+    #
+    # Returns contents of the config file as a string.
+    #
+    def contents
+      File.read(path) if exists?
+    end
+    
+    #
+    # Adds specified setting to a specified section of the config:
+    #
+    #  config.add_setting('merge-tools', 'kdiff3.executable', '~/bin/kdiff3')
+    # 
+    # It will write the following content to the +hgrc+:
+    #
+    #  [merge-tools]
+    #  kdiff3.executable = ~/bin/kdiff3
+    #
+    def add_setting(header, name, value)
+      new_setting = %Q{[#{ header }]\n#{ name } = #{ value }\n}
+      write do
+        if contents.nil?
+          new_setting
+        elsif contents.scan(header_regexp(header)).empty?
+          contents << "\n\n#{ new_setting }"
+        else
+          contents.gsub(header_regexp(header), new_setting)
+        end
+      end
+    end
+    
+    #
+    # Removes specified setting from the hgrc:
+    #
+    #  config.delete_setting!('merge-tools', 'kdiff3.executable')
+    #
+    def delete_setting!(header, name)
+      write do 
+        contents.gsub(find_setting(header, name), '')
+      end
+    end
+    
+    #
+    # Returns content of the specified section of hgrc.
+    #
+    def find_header(header)
+      {}.tap do |returning|
+        contents.scan(header_with_content_regexp(header)).flatten.first.split("\n").each do |setting|
+          name, value = *setting.split('=').map(&:strip)
+          returning[name] = value
+        end
+      end
+    end
+    
+    #
+    # Returns content of the specified setting from a section.
+    #
+    def find_setting(header, setting) #:nodoc:
+      contents.scan(setting_regexp(header, setting)).flatten.first
+    end
+    
+  private
+  
+    def write(&block)
+      new_content = block.call
+      File.open(path, 'w') do |f|
+        f << new_content
+      end
+    end
+  
+    def header_regexp(header)
+      /(\[#{ Regexp.escape(header) }\]\s*)/
+    end
+    
+    def header_with_content_regexp(header)
+      /\[#{ Regexp.escape(header) }\]\s*([^\[\]]*)/i
+    end
+    
+    def setting_regexp(header, setting)
+      /\[#{ Regexp.escape(header) }\]\s*[^\[\]]*(^#{ Regexp.escape(setting) }.+\n*)/i
+    end
+    
+  end
+  
+end

data/lib/mercurial-ruby/configuration.rb

@@ -0,0 +1,14 @@
+module Mercurial
+  
+  class Configuration
+    
+    attr_accessor :hg_binary_path, :shell_timeout, :cache_store
+    
+    def initialize
+      @hg_binary_path = '/usr/local/bin/hg'
+      @shell_timeout  = 3000
+    end
+    
+  end
+  
+end

data/lib/mercurial-ruby/diff.rb

@@ -0,0 +1,50 @@
+module Mercurial
+
+  #
+  # The class represents Mercurial diff. Obtained by running an +hg diff+ command.
+  #
+  # The class represents Diff object itself, {Mercurial::DiffFactory DiffFactory} is responsible
+  # for assembling instances of Diff. For the list of all possible diff-related operations please 
+  # look documentation for {Mercurial::DiffFactory DiffFactory}.
+  #
+  class Diff
+    
+    # Instance of {Mercurial::Commit Commit}.
+    attr_reader :commit
+    
+    # SHA1 hash of version a of the file.
+    attr_reader :hash_a
+    
+    # SHA1 hash of version b of the file.
+    attr_reader :hash_b
+    
+    # Version a if the file name.
+    attr_reader :file_a
+    
+    # Version b of the file name.
+    attr_reader :file_b
+    
+    # Diff body.
+    attr_reader :body
+    
+    def initialize(commit, opts={})
+      @commit = commit
+      @hash_a = opts[:hash_a]
+      @hash_b = opts[:hash_b]
+      @file_a = opts[:file_a]
+      @file_b = opts[:file_b]
+      @body   = opts[:body]
+      @binary = opts[:binary]
+    end
+    
+    def file_name
+      file_b || file_a
+    end
+    
+    def binary?
+      !! @binary
+    end
+    
+  end
+  
+end

data/lib/mercurial-ruby/factories/branch_factory.rb

@@ -0,0 +1,91 @@
+module Mercurial
+  
+  #
+  # This class represents a factory for {Mercurial::Branch Branch} instances.
+  #
+  class BranchFactory
+    include Mercurial::Helper
+    
+    # Instance of {Mercurial::Repository Repository}.
+    attr_reader :repository
+    
+    def initialize(repository)
+      @repository = repository
+    end
+    
+    # Return an array of {Mercurial::Branch Branch} instances for all branches in the repository.
+    #
+    # == Example:
+    #  repository.branches.all 
+    #
+    def all
+      hg_to_array "branches -c" do |line|
+        build(line)
+      end
+    end
+    
+    # Return an array of {Mercurial::Branch Branch} instances for all active branches in the repository.
+    #
+    # == Example:
+    #  repository.branches.active
+    #
+    def active
+      all.find_all do |b|
+        b.active?
+      end
+    end
+    
+    # Return an array of {Mercurial::Branch Branch} instances for all closed branches in the repository.
+    #
+    # == Example:
+    #  repository.branches.closed
+    #
+    def closed
+      all.find_all do |b|
+        b.closed?
+      end
+    end
+    
+    # Return a {Mercurial::Branch Branch} instance for a branch with a specified name.
+    #
+    # == Example:
+    #  repository.branches.by_name('branchname')
+    #
+    def by_name(name)
+      all.find do |b|
+        b.name == name
+      end
+    end
+    
+    # Return an array of {Mercurial::Branch Branch} instances where a specified commit exists.
+    # Experimental, doesn't always return a correct list of branches.
+    #
+    # == Example:
+    #  repository.branches.for_commit('291a498f04e9')
+    #
+    def for_commit(hash_id)
+      hg_to_array ["log -r 'descendants(?) and head()' --template '\n{branches}'", hash_id] do |line|
+        build_with_name_only(line)
+      end.compact.uniq
+    end
+    
+  private
+  
+    def build(data)
+      name, last_commit, status = *data.scan(/([\w-]+)\s+\d+:(\w+)\s*\(*(\w*)\)*/).first
+      Mercurial::Branch.new(
+        repository,
+        name,
+        :commit => last_commit,
+        :status => status
+      )
+    end
+    
+    def build_with_name_only(name)
+      name = 'default' if name == ''
+      Mercurial::Branch.new(repository, name)
+    end
+
+  end
+  
+end

data/lib/mercurial-ruby/factories/changed_file_factory.rb

@@ -0,0 +1,50 @@
+module Mercurial
+  
+  class ChangedFileFactory
+    
+    FILE_COPY_SEPARATOR = '->'
+    
+    def self.new_from_hg(str)
+      if str.include?(FILE_COPY_SEPARATOR)
+        copied_file = str.split(FILE_COPY_SEPARATOR)
+        initial_name = copied_file.first[2..-1]
+        name = copied_file[1]
+      else
+        initial_name = nil
+        name = str[2..-1]
+      end
+
+      Mercurial::ChangedFile.new(
+        :initial_name => initial_name,
+        :name         => name,
+        :mode         => str[0..0]
+      )
+    end
+    
+    def self.delete_hg_artefacts(files)
+      #
+      # For unknown reason Mercurial post duplicated 
+      # entries for moved and copied files. First as
+      # a pair of A and D operations, then as C.
+      #
+      files.reverse.each do |file|
+        if file.copied?
+          add = files.find{|f| f.added? && f.name == file.name}
+          delete = files.find{|f| f.deleted? && f.name == file.initial_name}
+
+          if add && delete
+            file.mode_letter = 'R'
+            files.delete_at(files.index(add))
+            files.delete_at(files.index(delete))
+
+          elsif add
+            files.delete_at(files.index(add))
+          end
+        end
+      end
+      files
+    end
+    
+  end
+  
+end