mercurial-ruby 0.3.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "mocha", "~>0.9"
+  gem "ruby-debug", "~>0.10"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.4)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    minitest (2.3.1)
+    mocha (0.9.12)
+    rake (0.9.2)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.9)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  minitest
+  mocha (~> 0.9)
+  rcov
+  ruby-debug (~> 0.10)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ilya Sabanin
+
+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.rdoc

@@ -0,0 +1,86 @@
+= mercurial-ruby
+
+Ruby API for Mercurial DVCS. Uses command line interface to communicate with Mercurial repositories.
+
+== Installation
+
+ gem install mercurial-ruby
+ 
+== Compatibility
+
+Tested with Mercurial 1.9 and 1.9.1 and Ruby 1.8.7.
+
+== Configuration
+
+There are several settings you can configure. Do it like this:
+
+ Mercurial.configure do |conf|
+   conf.hg_binary_path = "/usr/bin/hg"
+ end
+ 
+See {Mercurial::Configuration Configuration} class for details.
+ 
+== Usage
+
+All actions are performed through {Mercurial::Repository Repository} object.
+So before you can start doing anything you need to initialize one. Either by creating a new repository:
+
+ repository = Mercurial::Repository.create("/path/to/new_repository")
+
+or opening an existing one:
+
+ repository = Mercurial::Repository.open("/path/to/existing_repository")
+ 
+Now feel free to invoke various methods to get changesets, branches, nodes, etc:
+
+ repository.commits.by_hash_ids('291a498f04e9', '63f70b2314ed')
+ repository.branches.all
+ repository.hooks.by_name('commit')
+ ...
+ 
+See Features section below for a full list of entities and their methods.
+ 
+== Features
+
+=== Mercurial Entities
+
+* {Mercurial::Commit Commits}
+* {Mercurial::Node Nodes} — files and directories
+* {Mercurial::Branch Branches}
+* {Mercurial::Tag Tags}
+* {Mercurial::Diff Diffs}
+* {Mercurial::Manifest Manifest}
+* {Mercurial::FileIndex File Index}
+* {Mercurial::ConfigFile Repository config} — hooks and various settings
+
+=== Built-in Caching
+
+There's a simple caching mechanism built into the gem. If you pass Rails CacheStore compatible
+caching store to the Configuration block, mercurial-ruby will cache output of all hg commands
+it's executing. Then if you execute same method again and it will run the same command,
+the gem will return the output from cache.
+
+Here's how you configure it:
+
+ Mercurial.configure do |conf|
+   conf.cache_store = Rails.cache
+ end
+ 
+The gem is using a single method of the CacheStore called +fetch+.
+Cache expires automatically when repository's mtime changes, and it's your job to update it.
+
+== Contributing to mercurial-ruby
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Ilya Sabanin. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mercurial-ruby"
+  gem.homepage = "http://github.com/iSabanin/mercurial-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby API for Mercurial DVCS.}
+  gem.description = %Q{Ruby API for Mercurial DVCS.}
+  gem.email = "ilya.sabanin@gmail.com"
+  gem.authors = ["Ilya Sabanin"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mercurial-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/mercurial-ruby.rb

@@ -0,0 +1,66 @@
+#
+# Wrapper module. Nothing interesting here except that you can 
+# specify global configs with the +configure+ method.
+#
+module Mercurial
+  
+  VERSION = '0.3.0'
+  
+  class Error < RuntimeError; end
+  
+  class << self
+    attr_accessor :configuration
+    
+    # Access instance of Mercurial::Configuration.
+    #
+    #  config = Mercurial.configuration
+    #  config.hg_binary_path # => "/usr/local/bin/hg"
+    #
+    def configuration
+      @_configuration ||= Mercurial::Configuration.new
+    end
+    
+    # Change gem's global settings.
+    #
+    #  Mercurial.configure do |conf|
+    #    conf.hg_binary_path = "/usr/bin/hg"
+    #  end
+    #
+    def configure      
+      yield(configuration)
+    end
+  end
+
+end
+
+def require_local(suffix)
+  require(File.expand_path(File.join(File.dirname(__FILE__), suffix)))
+end
+
+require_local 'stdlib_exts/string'
+
+require_local 'mercurial-ruby/configuration'
+require_local 'mercurial-ruby/shell'
+require_local 'mercurial-ruby/command'
+require_local 'mercurial-ruby/helper'
+require_local 'mercurial-ruby/style'
+require_local 'mercurial-ruby/repository'
+require_local 'mercurial-ruby/config_file'
+require_local 'mercurial-ruby/hook'
+require_local 'mercurial-ruby/commit'
+require_local 'mercurial-ruby/changed_file'
+require_local 'mercurial-ruby/diff'
+require_local 'mercurial-ruby/branch'
+require_local 'mercurial-ruby/tag'
+require_local 'mercurial-ruby/manifest'
+require_local 'mercurial-ruby/node'
+require_local 'mercurial-ruby/root_node'
+require_local 'mercurial-ruby/file_index'
+
+require_local 'mercurial-ruby/factories/hook_factory'
+require_local 'mercurial-ruby/factories/commit_factory'
+require_local 'mercurial-ruby/factories/changed_file_factory'
+require_local 'mercurial-ruby/factories/diff_factory'
+require_local 'mercurial-ruby/factories/branch_factory'
+require_local 'mercurial-ruby/factories/tag_factory'
+require_local 'mercurial-ruby/factories/node_factory'

data/lib/mercurial-ruby/branch.rb

@@ -0,0 +1,45 @@
+module Mercurial
+  
+  #
+  # The class represents Mercurial branch. Obtained by running an +hg branches+ command.
+  #
+  # The class represents Branch object itself, {Mercurial::BranchFactory BranchFactory} is responsible
+  # for assembling instances of Branch. For the list of all possible branch-related operations please 
+  # look documentation for {Mercurial::BranchFactory BranchFactory}.
+  #
+  # Read more about Mercurial branches:
+  #
+  # http://mercurial.selenic.com/wiki/Branch
+  #
+  class Branch
+   
+    # Instance of {Mercurial::Repository Repository}.
+    attr_reader :repository
+    
+    # Name of the branch.
+    attr_reader :name
+    
+    # State of the branch: closed or active.
+    attr_reader :status
+    
+    # Mercurial changeset ID of the latest commit in the branch. 40-chars long SHA1 hash.
+    attr_reader :latest_commit
+    
+    def initialize(repository, name, options={})
+      @repository    = repository
+      @name          = name
+      @status        = options[:status] == 'closed' ? 'closed' : 'active'
+      @latest_commit = options[:commit]
+    end
+    
+    def active?
+      status == 'active'
+    end
+    
+    def closed?
+      status == 'closed'
+    end
+    
+  end
+  
+end

data/lib/mercurial-ruby/changed_file.rb

@@ -0,0 +1,51 @@
+module Mercurial
+  
+  class ChangedFile
+    
+    attr_reader :name, :initial_name
+    attr_accessor :mode_letter
+    
+    def initialize(opts={})
+      @initial_name = opts[:initial_name]
+      @name         = opts[:name]
+      @mode_letter  = opts[:mode]
+    end
+    
+    def moved?
+      mode == :move
+    end
+    
+    def copied?
+      mode == :copy
+    end
+    
+    def deleted?
+      mode == :delete
+    end
+    
+    def added?
+      mode == :add
+    end
+    
+    def modified?
+      mode == :edit
+    end
+    
+    def mode
+      case mode_letter
+      when 'A'
+        :add
+      when 'D'
+        :delete
+      when 'C'
+        :copy
+      when 'R'
+        :move
+      else
+        :edit
+      end
+    end
+    
+  end
+  
+end

data/lib/mercurial-ruby/command.rb

@@ -0,0 +1,77 @@
+require 'timeout'
+require 'digest/md5'
+
+module Mercurial
+  class CommandError < Error; end
+  
+  class Command
+    attr_accessor :command, :repository, :use_cache
+    
+    def initialize(cmd, options={})
+      @command    = cmd
+      @repository = options[:repository]
+      @use_cache  = options[:cache]
+    end
+
+    def execute
+      if cache_commands?
+        execute_with_caching
+      else
+        execute_without_caching
+      end      
+    end
+    
+  private
+  
+    def cache_commands?
+      repository && use_cache && cache_store
+    end
+    
+    def cache_store
+      Mercurial.configuration.cache_store
+    end
+  
+    def execution_timeout
+      Mercurial.configuration.shell_timeout
+    end
+    
+    def execute_with_caching
+      cache_store.fetch(cache_key, &execution_proc)
+    end
+    
+    def execute_without_caching
+      execution_proc.call
+    end
+    
+    def execution_proc
+      Proc.new do
+        result, error = '', ''
+        Open3.popen3(command) do |_, stdout, stderr|
+          Timeout.timeout(execution_timeout) do
+            while tmp = stdout.read(102400)
+              result += tmp
+            end
+          end
+
+          while tmp = stderr.read(1024)
+            error += tmp
+          end
+        end
+        raise_error_if_needed(error)
+        result
+      end
+    end
+    
+    def raise_error_if_needed(error)
+      if error && error != ''
+        raise CommandError, error
+      end
+    end
+    
+    def cache_key
+      "hg.#{ repository.mtime }." + Digest::MD5.hexdigest(command)
+    end
+    
+  end
+  
+end