hglib 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d1d2540e89d71dd245cd203f0bfac51901c85ecc2e15ad9813566780accb85
-  data.tar.gz: 921a4beab0aea45f0762a54e010e25d2385534dc10b909a8f0b3d651c1b12e25
+  metadata.gz: 609e12ea2bd06f9e02b74b8f9c44502ebfe9bf8eb3d76cde39229719f25296be
+  data.tar.gz: e2100c0d719f3ae437e8d44120b881bc561f488b81ba84ba77745a2fde8db020
 SHA512:
-  metadata.gz: 0642c4fa43ba0f1dba6962e12ef566c3123079c78db53d3d9ffb4a73e1d9a9504a7f66b3966a622ba205fbb22f41ffbcd25df81044e48f0bf4a8f3b6624f8ec9
-  data.tar.gz: b9838d26c1c4bc7820554463737eb9d3d57f09c934ff0865f21e92597cba2650e4ae791caadad5011e3d6437f7b79074618dc4986469770a401fc98abd512b16
+  metadata.gz: df2e978345babfd706e31e90214042bf79cb4ec0f2a945117e23466f15a56ed6cb2a1fccd3b0cad4e4722a43b6060e15f83cb8e8a2a688855acf9894195ff75d
+  data.tar.gz: 9fc6c4485ec905578ae2928a83f61e6e30a9e9ec80ef1a81e4abd1fbd5067d24471cb69c4493a362ba2aad8a22b69465573e835014e1324c976b7891fe212b76

data/History.md

@@ -1,3 +1,30 @@
+# Release History for hglib
+
+---
+
+## v0.3.0 [2019-10-02] Michael Granger <ged@FaerieMUD.org>
+
+Changes:
+
+- Changed Repo#status to return Repo::StatusEntry objects
+- Change Repo#id -> #identity with alias
+
+Improvements:
+
+- Handle multi-part errors
+- Handle numeric option args
+- Added implementations of:
+  - config
+  - log
+  - tag
+  - bookmark
+  - diff
+  - push
+  - paths
+  - version
+  - sign
+
+
 ## v0.2.0 [2019-04-03] Michael Granger <ged@FaerieMUD.org>
 
 Improvements:

data/README.md

@@ -1,10 +1,10 @@
 # hglib
 
 home
-: http://bitbucket.org/ged/ruby-hglib
+: https://hg.sr.ht/~ged/hglib
 
 code
-: http://bitbucket.org/ged/ruby-hglib
+: https://hg.sr.ht/~ged/hglib
 
 github
 : https://github.com/ged/ruby-hglib
@@ -21,6 +21,10 @@ that uses the [Command Server][cmdserver] for efficiency.
 
 ### Examples
 
+    require 'hglib'
+
+    repo = Hglib.clone( 'https://https://hg.sr.ht/~ged/hglib' )
+    # => #<Hglib::Repo:0x00007fae3880ec90 @path=#<Pathname:/Users/ged/temp/hglib>, @server=nil>
 
 
 ## Prerequisites
@@ -36,20 +40,24 @@ that uses the [Command Server][cmdserver] for efficiency.
 ## Contributing
 
 You can check out the current development source with Mercurial via its
-[project page](http://bitbucket.org/ged/ruby-hglib). Or if you prefer Git, via
+[project page](https://hg.sr.ht/~ged/hglib). Or if you prefer Git, via
 [its Github mirror](https://github.com/ged/ruby-hglib).
 
 After checking out the source, run:
 
-    $ rake newb
+    $ gem install -Ng
+
+This will install any missing dependencies.
+
+
+## Authors
 
-This task will install any missing dependencies, run the tests/specs,
-and generate the API documentation.
+- Michael Granger <ged@FaerieMUD.org>
 
 
 ## License
 
-Copyright (c) 2018, Michael Granger
+Copyright (c) 2018-2019, Michael Granger
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/lib/hglib.rb

@@ -12,7 +12,7 @@ module Hglib
 	       Exception2MessageMapper
 
 	# Package version
-	VERSION = '0.2.0'
+	VERSION = '0.3.0'
 
 	# Version control revision
 	REVISION = %q$Revision$
@@ -29,7 +29,51 @@ module Hglib
 
 	# Base exception class for errors raised by this library
 	def_exception :Error, "hglib error"
-	def_exception :CommandError, "error in hg command", Hglib::Error
+
+
+	class CommandError < Hglib::Error
+
+		def initialize( args )
+			@command = args.shift
+			@messages = args.flatten.map( &:chomp )
+			@messages << "error in hg command" if @messages.empty?
+		end
+
+		##
+		# The command that resulted in an error
+		attr_reader :command
+
+		##
+		# The Array of error messages generated by the command
+		attr_reader :messages
+
+
+		### Returns +true+ if the command resulted in more than one error message.
+		def multiple?
+			return self.messages.length > 1
+		end
+
+
+		### Overridden to for multi-message errors.
+		def message
+			msg = String.new( encoding: 'utf-8' )
+
+			msg << "`%s`: " % [ self.command ]
+
+			if self.multiple?
+				self.messages.each do |errmsg|
+					msg << "\n" << '  - ' << errmsg
+				end
+				msg << "\n"
+			else
+				msg << self.messages.first
+			end
+
+			return msg
+		end
+
+	end # class CommandError
+
 
 	# Loggability API -- set up a Logger for Hglib objects
 	log_as :hglib
@@ -48,6 +92,7 @@ module Hglib
 
 
 	# Set up automatic loading of submodules
+	autoload :Config, 'hglib/config'
 	autoload :Server, 'hglib/server'
 	autoload :Repo, 'hglib/repo'
 

data/lib/hglib/config.rb

@@ -0,0 +1,60 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'loggability'
+require 'hglib' unless defined?( Hglib )
+
+
+class Hglib::Config
+	extend Loggability
+	include Enumerable
+
+
+	# Config item type
+	Item = Struct.new( :value, :source )
+
+
+	# Log to the Hglib logger
+	log_to :hglib
+
+
+	### Create a new Config object from the given +config_items+.
+	def initialize( *config_items )
+		@items = self.expand_config_items( config_items )
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The Hash of Hglib::Config::Items from the config, keyed by name.
+	attr_reader :items
+
+
+	### Fetch the value of the config item +key+.
+	def []( key )
+		return self.items[ key ]&.value
+	end
+
+
+	### Call the block once for each config item, yielding the key and the Item.
+	def each( &block )
+		return self.items.each( &block )
+	end
+
+
+	### Expand the Array of configuration +items+ such as that returned by the JSON
+	### template of `hg showconfig` and return a hierarchical Hash.
+	def expand_config_items( items )
+		return items.flatten.each_with_object( {} ) do |item, hash|
+			self.log.debug "Expanding %p" % [ item ]
+			hash[ item[:name] ] = Item.new( item[:value], item[:source] )
+		end
+	end
+
+
+end # class Hglib::Config
+
+

data/lib/hglib/mixins.rb

@@ -0,0 +1,77 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'hglib' unless defined?( Hglib )
+
+
+module Hglib
+
+	# A collection of methods for declaring other methods.
+	#
+	#   class MyClass
+	#       extend Hglib::MethodUtilities
+	#
+	#       singleton_attr_accessor :types
+	#       singleton_method_alias :kinds, :types
+	#   end
+	#
+	#   MyClass.types = [ :pheno, :proto, :stereo ]
+	#   MyClass.kinds # => [:pheno, :proto, :stereo]
+	#
+	module MethodUtilities
+
+		### Creates instance variables and corresponding methods that return their
+		### values for each of the specified +symbols+ in the singleton of the
+		### declaring object (e.g., class instance variables and methods if declared
+		### in a Class).
+		def singleton_attr_reader( *symbols )
+			symbols.each do |sym|
+				singleton_class.__send__( :attr_reader, sym )
+			end
+		end
+
+		### Creates methods that allow assignment to the attributes of the singleton
+		### of the declaring object that correspond to the specified +symbols+.
+		def singleton_attr_writer( *symbols )
+			symbols.each do |sym|
+				singleton_class.__send__( :attr_writer, sym )
+			end
+		end
+
+		### Creates readers and writers that allow assignment to the attributes of
+		### the singleton of the declaring object that correspond to the specified
+		### +symbols+.
+		def singleton_attr_accessor( *symbols )
+			symbols.each do |sym|
+				singleton_class.__send__( :attr_accessor, sym )
+			end
+		end
+
+		### Creates an alias for the +original+ method named +newname+.
+		def singleton_method_alias( newname, original )
+			singleton_class.__send__( :alias_method, newname, original )
+		end
+
+
+		### Create a reader in the form of a predicate for the given +attrname+.
+		def attr_predicate( attrname )
+			attrname = attrname.to_s.chomp( '?' )
+			define_method( "#{attrname}?" ) do
+				instance_variable_get( "@#{attrname}" ) ? true : false
+			end
+		end
+
+
+		### Create a reader in the form of a predicate for the given +attrname+
+		### as well as a regular writer method.
+		def attr_predicate_accessor( attrname )
+			attrname = attrname.to_s.chomp( '?' )
+			attr_writer( attrname )
+			attr_predicate( attrname )
+		end
+
+	end # module MethodUtilities
+
+
+end # module Hglib
+

data/lib/hglib/repo.rb

@@ -13,8 +13,11 @@ class Hglib::Repo
 	log_to :hglib
 
 
+	autoload :Bookmark, 'hglib/repo/bookmark'
 	autoload :Id, 'hglib/repo/id'
 	autoload :LogEntry, 'hglib/repo/log_entry'
+	autoload :StatusEntry, 'hglib/repo/status_entry'
+	autoload :Tag, 'hglib/repo/tag'
 
 
 	### Create a new Repo object that will operate on the Mercurial repo at the
@@ -44,15 +47,10 @@ class Hglib::Repo
 	### the file. An empty Hash is returned if there are no files with one of the
 	### requested statuses.
 	def status( *args, **options )
-		response = self.server.run( :status, *args, **options )
+		response = self.server.run_with_json_template( :status, *args, **options )
 		self.logger.debug "Parsing status response: %p" % [ response ]
 
-		return {} if response.length == 1 && response.first.empty?
-		return response.each_slice( 2 ).inject({}) do |hash, (raw_status, path)|
-			path = Pathname( path.chomp )
-			hash[ path ] = raw_status.strip
-			hash
-		end
+		return response.map {|entry| Hglib::Repo::StatusEntry.new(entry) }
 	end
 	alias_method :stat, :status
 
@@ -60,30 +58,78 @@ class Hglib::Repo
 	### Return a Hglib::Repo::Id that identifies the repository state at the
 	### specified +revision+, or the current revision if unspecified. A +revision+
 	### of `.` identifies the working directory parent without uncommitted changes.
-	def id( revision=nil )
-		options = {}
-		options[:rev] = revision if revision
-
-		response = self.server.run( :id, **options )
+	def identify( source=nil, **options )
+		response = self.server.run_with_json_template( :identify, source, **options )
 		self.logger.debug "Got ID response: %p" % [ response ]
 
-		return Hglib::Repo::Id.parse( response.first )
+		data = response.first
+		return Hglib::Repo::Id.new( **data )
 	end
+	alias_method :id, :identify
 
 
 	### Return an Array of Hglib::Repo::LogEntry objects that describes the revision
 	### history of the specified +files+ or the entire project.
 	def log( *files, **options )
 		options[:graph] = false
-		options[:T] = 'json'
 
-		jsonlog = self.server.run( :log, *files, **options )
-		entries = JSON.parse( jsonlog.join )
+		entries = self.server.run_with_json_template( :log, *files, **options )
+		self.logger.debug "Got log response: %p" % [ entries ]
 
 		return entries.map {|entry| Hglib::Repo::LogEntry.new(entry) }
 	end
 
 
+	### Return a String showing differences between revisions for the specified
+	### +files+ in the unified diff format.
+	def diff( *files, **options )
+		response = self.server.run( :diff, *files, **options )
+		self.logger.debug "Got diff response: %p" % [ truncate(response) ]
+		return response
+	end
+
+
+	### Schedule the given +files+ to be version controlled and added to the
+	### repository on the next commit. To undo an add before that, see #forget.
+	###
+	### If no +files+ are given, add all files to the repository (except files
+	### matching ".hgignore").
+	###
+	### Returns <code>true</code> if all files are successfully added.
+	def add( *files, **options )
+		response = self.server.run( :add, *files, **options )
+		self.logger.debug "Got ADD response: %p" % [ response ]
+
+		return true
+	end
+
+
+	### Add all new files and remove all missing files from the repository.
+	###
+	### Unless +files+ are given, new files are ignored if they match any of the
+	### patterns in ".hgignore". As with #add, these changes take effect at the
+	### next commit.
+	###
+	### Use the :similarity option to detect renamed files. This option takes a
+	### percentage between 0 (disabled) and 100 (files must be identical) as its
+	### value. With a value greater than 0, this compares every removed file with
+	### every added file and records those similar enough as renames. Detecting
+	### renamed files this way can be expensive. After using this option, you can
+	### call #status with the <code>:copies</code> options to check which files
+	### were identified as moved or renamed. If not specified, :similarity defaults
+	### to 100 and only renames of identical files are detected.
+	###
+	### Returns <code>true</code> if all files are successfully added.
+	def addremove( *files, **options )
+		response = self.server.run( :addremove, *files, **options )
+		self.logger.debug "Got ADD response: %p" % [ response ]
+
+		return true
+	end
+	alias_method :add_remove, :addremove
+	alias_method :addr, :addremove
+
+
 	### Commit the specified +files+ with the given +options+.
 	def commit( *files, **options )
 		response = self.server.run( :commit, *files, **options )
@@ -111,6 +157,119 @@ class Hglib::Repo
 	end
 
 
+	### Update the working directory or switch revisions.
+	def update( rev=nil, **options )
+		response = self.server.run( :update, rev, **options )
+		self.logger.debug "Got UPDATE response: %p" % [ response ]
+
+		return true
+	end
+
+
+	### Push changes to the specified +destination+.
+	def push( destination=nil, **options )
+		response = self.server.run( :push, destination, **options )
+		self.logger.debug "Got PUSH response: %p" % [ response ]
+
+		return true
+	end
+
+
+	### Name a revision using +names+.
+	def tag( *names, **options )
+		raise "expected at least one tag name" if names.empty?
+
+		response = self.server.run( :tag, *names, **options )
+		self.logger.debug "Got TAGS response: %p" % [ response ]
+
+		return true
+	end
+
+
+	### Return a Hglib::Repo::Tag object for each tag in the repo.
+	def tags
+		response = self.server.run_with_json_template( :tags )
+		self.logger.debug "Got a TAGS response: %p" % [ response ]
+
+		return response.flatten.map {|tag| Hglib::Repo::Tag.new(self, **tag) }
+	end
+
+
+	### Create new bookmarks with the specified +names+.
+	def bookmark( *names, **options )
+		raise "expected at least one bookmark name" if names.empty?
+
+		response = self.server.run( :bookmark, *names, **options )
+		self.logger.debug "Got BOOKMARK response: %p" % [ response ]
+
+		return true
+	end
+
+
+	### Return a Hglib::Repo::Bookmark object for each bookmark in the repo.
+	def bookmarks
+		options = { list: true }
+		response = self.server.run_with_json_template( :bookmarks, **options )
+		self.logger.debug "Got a BOOKMARKS response: %p" % [ response ]
+
+		return response.map {|bk| Hglib::Repo::Bookmark.new(self, **bk) }
+	end
+
+
+	### Fetch the current global Mercurial config and return it as an Hglib::Config
+	### object.
+	def config( untrusted: false )
+		options = { untrusted: untrusted }
+
+		config = self.server.run_with_json_template( :showconfig, **options )
+		return Hglib::Config.new( config )
+	end
+
+
+	### Fetch a Hash of aliases for remote repositories.
+	def paths
+		response = self.server.run_with_json_template( :paths )
+		self.logger.debug "Got a PATHS response: %p" % [ response ]
+
+		return response.each_with_object({}) do |entry, hash|
+			hash[ entry[:name].to_sym ] = URI( entry[:url] )
+		end
+	end
+
+
+	### Sign the given +rev+ (or the current one if not specified).
+	def sign( rev=nil, **options )
+		response = self.server.run( :sign, rev, **options )
+		self.logger.debug "Got a SIGN response: %p" % [ response ]
+
+		return response.chomp
+	end
+
+
+	### Fetch a Hash of version information about the Mercurial that is being used.
+	def versions
+		response = self.server.run_with_json_template( :version )
+		self.logger.debug "Got a VERSION response: %p" % [ response ]
+
+		return response.first
+	end
+
+
+	### Fetch the version of Mercurial that's being used as a String.
+	def version
+		return self.versions[ :ver ]
+	end
+
+
+	### Fetch the version of the Mercurial extensions that're being used as a Hash.
+	def extension_versions
+		ext_info = self.versions[ :extensions ]
+		return ext_info.each_with_object({}) do |ext, hash|
+			hash[ ext.delete(:name).to_sym ] = ext
+		end
+	end
+
+
 	#########
 	protected
 	#########
@@ -126,4 +285,16 @@ class Hglib::Repo
 		return Loggability[ self ]
 	end
 
+
+	### Return the given +string+ with the middle truncated so that it's +maxlength+
+	### characters long if it exceeds that length.
+	def truncate( string, maxlength=80 )
+		return string if maxlength < 8
+		return string if string.length - maxlength - 5 <= 0
+
+		return string[0 .. (maxlength / 2) - 3 ] +
+			' ... ' +
+			string[ -((maxlength / 2) -3) .. ]
+	end
+
 end # class Hglib::Repo