hglib 0.2.0 → 0.3.0

data/lib/hglib/repo/bookmark.rb

@@ -0,0 +1,74 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'loggability'
+require 'hglib/repo' unless defined?( Hglib::Repo )
+require 'hglib/mixins'
+
+
+class Hglib::Repo::Bookmark
+	extend Loggability,
+		Hglib::MethodUtilities
+
+
+	# Send logs to Hglib's logger
+	log_to :hglib
+
+
+	# {
+	# 	"active"   => true,
+	# 	"bookmark" => "master",
+	# 	"node"     => "720c115412188539039b87baf57931fb5415a0bf",
+	# 	"rev"      => 26
+	# }
+
+	### Create a new Bookmark with the given values.
+	def initialize( repo, bookmark:, node:, rev:, active: false  )
+		@repo   = repo
+		@name   = bookmark
+		@node   = node
+		@rev    = rev
+		@active = active
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The Hglib::Repo the bookmark lives in
+	attr_reader :repo
+
+	##
+	# The name of the bookmark
+	attr_reader :name
+
+	##
+	# The SHA of the commit the bookmark is currently on
+	attr_reader :node
+
+	##
+	# The revision number of the commit the bookmark is currently on
+	attr_reader :rev
+
+	##
+	# Whether or not the bookmark is currently active
+	attr_predicate :active
+
+
+	### Delete the bookmark from its repository.
+	def delete
+		return self.repo.bookmark( self.name, delete: true )
+	end
+
+
+	### Move the bookmark to the specified +revision+.
+	def move_to( revision )
+		return self.repo.bookmark( self.name, rev: revision, force: true )
+	end
+
+
+end # class Hglib::Repo::Bookmark
+
+

data/lib/hglib/repo/id.rb

@@ -2,34 +2,36 @@
 # frozen_string_literal: true
 
 require 'hglib/repo' unless defined?( Hglib::Repo )
+require 'hglib/mixins'
 
 
 # The identification of a particular revision of a repository.
 class Hglib::Repo::Id
+	extend Hglib::MethodUtilities
 
-	### Parse the given +raw_id+ and return a new Id that contains the parsed
-	### information.
-	def self::parse( raw_id )
-		global, tags, bookmarks = raw_id.chomp.split( ' ', 3 )
-		has_plus = global.chomp!( '+' ) ? true : false
 
-		tags ||= ''
-		tags = tags.split( '/' )
+	# The SHA of the zeroth node
+	DEFAULT_ID = '0000000000000000000000000000000000000000'
 
-		bookmarks ||= ''
-		bookmarks = bookmarks.split( '/' )
+	# The default branch name to use
+	DEFAULT_BRANCH = 'default'
 
-		return self.new( global, *tags, uncommitted_changes: has_plus, bookmarks: bookmarks )
-	end
+	# The SHA of the node when the repo is at tip
+	DEFAULT_NODE = 'ffffffffffffffffffffffffffffffffffffffff'
 
 
 	### Create a new repository ID with the given +global+ revision identifier, one
 	### or more +tags+, and other options.
-	def initialize( global, *tags, uncommitted_changes: false, bookmarks: [] )
-		@global = global
-		@tags = tags
+	def initialize( id:, branch: DEFAULT_BRANCH, node: DEFAULT_NODE, dirty: false,
+		parents: [], tags: [], bookmarks: [] )
+
+		@id = id[ /\p{XDigit}{40}/ ]
+		@branch = branch
+		@node = node
+		@dirty = dirty == '+'
+		@tags = Array( tags )
+		@parents = Array( parents )
 		@bookmarks = Array( bookmarks )
-		@uncommitted_changes = uncommitted_changes
 	end
 
 
@@ -38,8 +40,27 @@ class Hglib::Repo::Id
 	######
 
 	##
-	# The repo's global (short-form) revision identifier.
-	attr_reader :global
+	# The long-form revision ID
+	attr_reader :id
+	alias_method :global, :id
+
+	##
+	# The name of the current branch
+	attr_reader :branch
+
+	##
+	# The ID of the current
+	attr_reader :node
+
+	##
+	# The current IDs of the current revision's parent(s).
+	attr_reader :parents
+
+	##
+	# Does the repo have uncommitted changes?
+	attr_predicate :dirty
+	alias_method :uncommitted_changes?, :dirty?
+	alias_method :has_uncommitted_changes?, :dirty?
 
 	##
 	# The tags belonging to the revision of the repo.
@@ -50,13 +71,6 @@ class Hglib::Repo::Id
 	attr_reader :bookmarks
 
 
-	### Returns +true+ if the repo's working directory has uncommitted changes.
-	def uncommitted_changes?
-		return @uncommitted_changes
-	end
-	alias_method :has_uncommitted_changes?, :uncommitted_changes?
-
-
 	### Return the ID as a String in the form used by the command line.
 	def to_s
 		str = self.global.dup

data/lib/hglib/repo/log_entry.rb

@@ -30,18 +30,18 @@ class Hglib::Repo::LogEntry
 
 	### Create a new log entry from the raw +entryhash+.
 	def initialize( entryhash )
-		@bookmarks = entryhash[ "bookmarks" ]
-		@branch    = entryhash[ "branch" ]
-		@date      = entryhash[ "date" ]
-		@desc      = entryhash[ "desc" ]
-		@node      = entryhash[ "node" ]
-		@parents   = entryhash[ "parents" ]
-		@phase     = entryhash[ "phase" ]
-		@rev       = entryhash[ "rev" ]
-		@tags      = entryhash[ "tags" ]
-		@user      = entryhash[ "user" ]
-		@date      = entryhash[ "date" ]
-		@files     = entryhash[ "files" ] || []
+		@bookmarks = entryhash[ :bookmarks ]
+		@branch    = entryhash[ :branch ]
+		@date      = entryhash[ :date ]
+		@desc      = entryhash[ :desc ]
+		@node      = entryhash[ :node ]
+		@parents   = entryhash[ :parents ]
+		@phase     = entryhash[ :phase ]
+		@rev       = entryhash[ :rev ]
+		@tags      = entryhash[ :tags ]
+		@user      = entryhash[ :user ]
+		@date      = entryhash[ :date ]
+		@files     = entryhash[ :files ] || []
 	end
 
 

data/lib/hglib/repo/tag.rb

@@ -0,0 +1,52 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'loggability'
+
+require 'hglib/repo' unless defined?( Hglib::Repo )
+
+
+class Hglib::Repo::Tag
+	extend Loggability
+
+
+	# Send logs to the Hglib logger
+	log_to :hglib
+
+
+	### Create a tag object.
+	def initialize( repo, tag:, node:, rev: 0, type: '' )
+		@repo = repo
+		@name = tag
+		@node = node
+		@rev  = rev
+		@type = type
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The repo the tag belongs to
+	attr_reader :repo
+
+	##
+	# The tag's name
+	attr_reader :name
+
+	##
+	# The SHA of the node the tag points to
+	attr_reader :node
+
+	##
+	# The numeric revision the tag points to
+	attr_reader :rev
+
+	##
+	# The tag type
+	attr_reader :type
+
+end # class Hglib::Repo::Tag
+

data/lib/hglib/server.rb

@@ -1,6 +1,7 @@
 # -*- ruby -*-
 # frozen_string_literal: true
 
+require 'json'
 require 'shellwords'
 require 'loggability'
 require 'hglib' unless defined?( Hglib )
@@ -41,7 +42,7 @@ class Hglib::Server
 				[ optname ]
 			when FalseClass, NilClass
 				[ optname.sub(/\A--/, '--no-') ] if optname.start_with?( '--' )
-			when String
+			when String, Numeric
 				if optname.start_with?( '--' )
 					[ "#{optname}=#{val}" ]
 				else
@@ -136,15 +137,15 @@ class Hglib::Server
 	### #on_byte_input and #on_line_input will be used to read it. If one of these
 	### callbacks is not registered, an IOError will be raised.
 	def run( command, *args, **options )
+		args = args.compact
 		self.log.debug "Running command: %p" % [ Shellwords.join([command.to_s] + args) ]
 		self.start unless self.started?
 
 		done = false
-		output = []
+		output = String.new
+		errors = []
 
-		args.compact!
 		args += self.class.mangle_options( options )
-
 		self.write_command( 'runcommand', command, *args )
 
 		until done
@@ -158,7 +159,7 @@ class Hglib::Server
 				done = true
 			when 'e'
 				self.log.error "Got command error: %p" % [ data ]
-				raise Hglib::CommandError, data
+				errors << data
 			when 'L'
 				self.log.debug "Server requested line input (%d bytes)" % [ data ]
 				input = self.get_line_input( data.to_i )
@@ -174,10 +175,23 @@ class Hglib::Server
 			end
 		end
 
+		raise Hglib::CommandError, [command, *errors] unless errors.empty?
+
 		return output
 	end
 
 
+	### Run the specified +command+ with the given +args+ with the JSON template and
+	### return the result.
+	def run_with_json_template( command, *args, symbolize: true, **options )
+		options[:T] = 'json'
+
+		json = self.run( command, *args, **options )
+
+		return JSON.parse( json, symbolize_names: symbolize )
+	end
+
+
 	### Returns +true+ if the underlying command server has been started.
 	def is_started?
 		return self.pid ? true : false
@@ -302,8 +316,11 @@ class Hglib::Server
 
 	### Return the command-line command for starting the command server.
 	def server_start_command
+		hg = Hglib.hg_path
+		raise "couldn't find an `hg' executable in your PATH!" unless hg.executable?
+
 		cmd = [
-			Hglib.hg_path.to_s,
+			hg.to_s,
 			'--config',
 			'ui.interactive=True',
 			'serve',

data/spec/hglib/config_spec.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'hglib/config'
+
+
+RSpec.describe Hglib::Config do
+
+	let( :entries ) do
+		return [
+			{:name=>"progress.delay", :source=>"/Users/ged/.hgrc:96", :value=>"0.1"},
+			{:name=>"progress.refresh", :source=>"/Users/ged/.hgrc:97", :value=>"0.1"},
+			{:name=>"progress.format", :source=>"/Users/ged/.hgrc:98", :value=>"topic bar number"},
+			{:name=>"progress.clear-complete", :source=>"/Users/ged/.hgrc:99", :value=>"True"},
+			{:name=>"server.bundle1", :source=>"", :value=>"False"},
+			{:name=>"ui.editor", :source=>"$VISUAL", :value=>"emacs"},
+			{:name=>"ui.ssh", :source=>"/Users/ged/.hgrc:3", :value=>"ssh -C"},
+			{:name=>"ui.ignore", :source=>"/Users/ged/.hgrc:4", :value=>"~/.hgignore_global"},
+			{:name=>"ui.merge", :source=>"/Users/ged/.hgrc:5", :value=>"Kaleidoscope"},
+			{:name=>"ui.interactive", :source=>"--config", :value=>"True"},
+			{:name=>"ui.nontty", :source=>"commandserver", :value=>"true"},
+			{:name=>"web.cacerts", :source=>"/Users/ged/.hgrc:122", :value=>""},
+		]
+	end
+
+
+	it "expands config items" do
+		instance = described_class.new( entries )
+
+		expect( instance['ui.editor'] ).to eq( 'emacs' )
+		expect( instance['progress.refresh'] ).to eq( '0.1' )
+	end
+
+end
+

data/spec/hglib/mixins_spec.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'hglib/mixins'
+
+
+RSpec.describe Hglib, "mixins" do
+
+	describe Hglib::MethodUtilities, 'used to extend a class' do
+
+		let( :extended_class ) do
+			klass = Class.new
+			klass.extend( Hglib::MethodUtilities )
+			klass
+		end
+
+
+		it "can declare a class-level attribute reader" do
+			extended_class.singleton_attr_reader :foo
+			expect( extended_class ).to respond_to( :foo )
+			expect( extended_class ).to_not respond_to( :foo= )
+			expect( extended_class ).to_not respond_to( :foo? )
+		end
+
+		it "can declare a class-level attribute writer" do
+			extended_class.singleton_attr_writer :foo
+			expect( extended_class ).to_not respond_to( :foo )
+			expect( extended_class ).to respond_to( :foo= )
+			expect( extended_class ).to_not respond_to( :foo? )
+		end
+
+		it "can declare a class-level attribute reader and writer" do
+			extended_class.singleton_attr_accessor :foo
+			expect( extended_class ).to respond_to( :foo )
+			expect( extended_class ).to respond_to( :foo= )
+			expect( extended_class ).to_not respond_to( :foo? )
+		end
+
+		it "can declare a class-level alias" do
+			def extended_class.foo
+				return "foo"
+			end
+			extended_class.singleton_method_alias( :bar, :foo )
+
+			expect( extended_class.bar ).to eq( 'foo' )
+		end
+
+		it "can declare an instance attribute predicate method" do
+			extended_class.attr_predicate :foo
+			instance = extended_class.new
+
+			expect( instance ).to_not respond_to( :foo )
+			expect( instance ).to_not respond_to( :foo= )
+			expect( instance ).to respond_to( :foo? )
+
+			expect( instance.foo? ).to eq( false )
+
+			instance.instance_variable_set( :@foo, 1 )
+			expect( instance.foo? ).to eq( true )
+		end
+
+		it "can declare an instance attribute predicate and writer" do
+			extended_class.attr_predicate_accessor :foo
+			instance = extended_class.new
+
+			expect( instance ).to_not respond_to( :foo )
+			expect( instance ).to respond_to( :foo= )
+			expect( instance ).to respond_to( :foo? )
+
+			expect( instance.foo? ).to eq( false )
+
+			instance.foo = 1
+			expect( instance.foo? ).to eq( true )
+		end
+
+	end
+
+end
+