hglib 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b06b5596517c82d300b477d86fc8acdc74cd7fec17b3dfa24ce1a198af395311
-  data.tar.gz: dd399c53f5d3084a06b1488df451c2778c974a8bcbdd23dc609d872d7377f2f5
+  metadata.gz: 56dd5ffa23837596f0d3248677aceb3cf20e836fdb915cd58fb32d74afbee746
+  data.tar.gz: 9a45cc618c6a9925f8aa54dbb89aae95bef02755fd9eee64285e134080015b17
 SHA512:
-  metadata.gz: fdee69a8fb7ac2447c445df0606e23f1a7fe4e15478fa9e3725cefb065ff5bd889e1411a129c87f6bacdd38e6c01f6676938ccd816f60b751b1e238d0b901b78
-  data.tar.gz: f425f8b11a999e7b866d7b7ad31574b6d0a0a128858174df6ff0f272360d58deb9b663fe66783612a49577c1123d0746728ee1ee1e5dbf7819e5585bfd2d1c79
+  metadata.gz: 7162090406ec2fcb10bb6ff5450dc7a7b5a2a315cf405309519edb7c86d41ad9d4c8ed1aa8ec2f351e6d31c06d6bc7dc62f396acb537b3e198ad1319244a3aa1
+  data.tar.gz: fe4e915b74ecd0ae0e430e4db7a103deb424db4fc472aa059efe364b3e8b56ccefa781804613c6f0920bfa263f37339949f3a572afa7ddd5c08a233af430fbcb

data/History.md

@@ -1,6 +1,15 @@
 # Release History for hglib
 
 ---
+
+## v0.8.0 [2020-01-21] Michael Granger <ged@FaerieMUD.org>
+
+Improvements:
+
+- Fixes for 2.7 and 2.5.
+- Including the mistakenly-omitted `topic` extension
+
+
 ## v0.7.0 [2020-01-08] Michael Granger <ged@FaerieMUD.org>
 
 Changes:

data/README.md

@@ -18,6 +18,7 @@ docs
 This is a client library for the Mercurial distributed revision control tool
 that uses the [Command Server][cmdserver] for efficiency.
 
+[![builds.sr.ht status](https://builds.sr.ht/~ged/hglib.svg)](https://builds.sr.ht/~ged/hglib?)
 
 ### Examples
 

data/lib/hglib/extension/topic.rb

@@ -0,0 +1,215 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'hglib/extension' unless defined?( Hglib::Extension )
+require 'hglib/mixins'
+
+
+# Extension module for the Mercurial `topic` extension
+module Hglib::Extension::Topic
+	extend Hglib::Extension
+
+
+	# A topic in an Hglib::Repo.
+	class Entry
+		extend Hglib::MethodUtilities
+		include Hglib::Inspection
+
+		### Create a new Entry for the specified +repo+ given an +entryhash+ like that
+		### returned by the JSON template for the `topics` command.
+		def initialize( repo, entryhash )
+			@repo = repo
+
+			@name            = entryhash[:topic]
+			@active          = entryhash[:active]
+			@changeset_count = entryhash[:changesetcount]
+			@branch          = entryhash[:"branches+"]
+			@last_touched    = entryhash[:lasttouched]
+			@user_touched    = entryhash[:usertouched]
+		end
+
+
+		######
+		public
+		######
+
+		##
+		# The Hglib::Repo of the repository the topic belongs to
+		attr_reader :repo
+
+		##
+		# The name of the topic
+		attr_reader :name
+
+		##
+		# The name of the branch the topic is on
+		attr_reader :branch
+
+		##
+		# Whether or not the entry is current active
+		attr_predicate :active
+
+		##
+		# The number of changesets belonging to the topic
+		attr_reader :changeset_count
+		alias_method :changesetcount, :changeset_count
+
+		##
+		# The human description of when the topic last had changesets added to it
+		# (if it was fetched)
+		attr_reader :last_touched
+		alias_method :lasttouched, :last_touched
+
+		##
+		# The name of the last user to add changesets to the topic (if it was fetched)
+		attr_reader :user_touched
+		alias_method :usertouched, :user_touched
+		alias_method :touched_by, :user_touched
+
+
+		### Return the entry as a String (in a similar form to the regular `hg topics` output)
+		def to_s
+			rval = String.new( encoding: 'utf-8' )
+			rval << "%s (" % [ self.name ]
+			rval << "%s" % [ self.last_touched ] if self.last_touched
+			rval << " by %s" % [ self.user_touched ] if self.user_touched
+			rval << ', ' if self.last_touched || self.user_touched
+			rval << "%d changesets)" % [ self.changeset_count ]
+			rval << " [active]" if self.active?
+			rval.freeze
+
+			return rval
+		end
+		alias_method :inspect_details, :to_s
+
+
+		### Return the changesets that belong to this topic as
+		### Hglib::Extension::Topic::StackEntry objects.
+		def stack
+			return self.repo.stack( self.name )
+		end
+
+	end # class Entry
+
+
+	# A changeset in a topic
+	class StackEntry
+		extend Hglib::MethodUtilities
+		include Hglib::Inspection
+
+
+		### Create a new StackEntry for the specified +repo+ given an +entryhash+ like that
+		### returned by the JSON template for the `topics` command.
+		def initialize( repo, entryhash )
+			@repo = repo
+
+			@description = entryhash[:desc]
+			@is_entry    = entryhash[:isentry]
+			@node        = entryhash[:node]
+			@stack_index = entryhash[:stack_index]
+			@state       = entryhash[:state]
+			@symbol      = entryhash[:symbol]
+		end
+
+
+		######
+		public
+		######
+
+		##
+		# The Hglib::Repo of the repository the changeset belongs to
+		attr_reader :repo
+
+		##
+		# The changeset description
+		attr_reader :description
+		alias_method :desc, :description
+
+		##
+		# True if the changeset is an entry(?)
+		# :TODO: Figure out what this means
+		attr_predicate :is_entry
+		alias_method :entry?, :is_entry?
+
+		##
+		# The node identifier of the changeset
+		attr_reader :node
+
+		##
+		# The index of the changeset in the topic it is currently in
+		attr_reader :stack_index
+
+		##
+		# An array of states that apply to this changeset(?)
+		# :TODO: Figure out what these mean
+		attr_reader :state
+
+		##
+		# A character that represents the changeset's (state?)
+		# :TODO: Figure out what this means
+		attr_reader :symbol
+
+
+		### Return the entry as a String (in a similar form to the regular `hg topics` output)
+		def to_s
+			displayed_states = self.state - ['clean']
+
+			rval = String.new( encoding: 'utf-8' )
+			rval << %{s%d%s "%s"} % [ self.stack_index, self.symbol, self.description ]
+			rval << " (%s)" % [ displayed_states.join(', ') ] unless displayed_states.empty?
+			rval.freeze
+
+			return rval
+		end
+		alias_method :inspect_details, :to_s
+
+	end # class StackEntry
+
+
+
+	repo_commands do
+
+		### Return an Hglib::Extension::Topic::Entry object for each topic in the
+		### repo.
+		def topics( **options )
+			raise ArgumentError, ":list option is implemented with the #stack method" if
+				options[:list]
+
+			options[:age] = true
+			options[:verbose] = true
+			response = self.server.run_with_json_template( :topics, nil, **options )
+
+			return response.map do |entryhash|
+				Hglib::Extension::Topic::Entry.new( self, entryhash )
+			end
+		end
+
+
+		### Operate on a topic, either the one with the given +name+ or the current one
+		### if +name+ is not given.
+		def topic( name=nil, **options )
+			options[:current] = true unless name || options[:clear]
+			result = self.server.run( :topics, name, **options )
+			return result.chomp
+		rescue Hglib::CommandError => err
+			# Running `topic --current` with no active topic is an error apparently, so
+			# if that's the reason for it being raised just return nil instead.
+			raise( err ) unless err.message.match?( /no active topic/i )
+			return nil
+		end
+
+
+		### Return an Array of all changesets in a topic as
+		### Hglib::Extension::Topic::StackEntry objects.
+		def stack( topic=nil, **options )
+			response = self.server.run_with_json_template( :stack, topic, **options )
+
+			return response.map do |entryhash|
+				Hglib::Extension::Topic::StackEntry.new( self, entryhash )
+			end
+		end
+
+	end
+
+end # module Hglib::Extension::Topic
+

data/lib/hglib/repo.rb

@@ -1,6 +1,7 @@
 # -*- ruby -*-
 # frozen_string_literal: true
 
+require 'uri'
 require 'json'
 require 'loggability'
 
@@ -303,7 +304,7 @@ class Hglib::Repo
 
 		return string[0 .. (maxlength / 2) - 3 ] +
 			' ... ' +
-			string[ -((maxlength / 2) -3) .. ]
+			string[ -((maxlength / 2) -3) .. -1 ]
 	end
 
 end # class Hglib::Repo

data/lib/hglib/server.rb

@@ -162,7 +162,7 @@ class Hglib::Server
 		output = String.new
 		errors = []
 
-		args += self.class.mangle_options( options )
+		args += self.class.mangle_options( **options )
 		self.write_command( 'runcommand', command, *args )
 
 		until done

data/lib/hglib.rb

@@ -11,7 +11,7 @@ module Hglib
 
 
 	# Package version
-	VERSION = '0.7.0'
+	VERSION = '0.8.0'
 
 	# Version control revision
 	REVISION = %q$Revision$

data/spec/hglib/extension/gpg_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe Hglib::Extension::GPG do
 
 	it "can sign a revision" do
 		expect( server ).to receive( :run ).
-			with( :sign, nil, {} ).
+			with( :sign, nil, any_args ).
 			and_return( "signing 2:2b937981802a\n" )
 
 		expect( repo.sign ).to eq( "signing 2:2b937981802a" )

data/spec/hglib/repo/id_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Hglib::Repo::Id, :requires_binary do
 		Pathname( Dir.mktmpdir(['hglib', 'repodir']) )
 	end
 	let( :repo ) { Hglib.init(repo_dir) }
-	let( :fake_sha ) { Random.bytes(20).unpack1('h*') }
+	let( :fake_sha ) { SecureRandom.bytes(20).unpack1('h*') }
 
 
 	it "can be created for an empty repo" do

data/spec/hglib/repo_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe Hglib::Repo do
 		repo = described_class.new( repo_dir )
 
 		expect( server ).to receive( :run_with_json_template ).
-			with( :status, {} ).
+			with( :status, any_args ).
 			and_return( [] )
 
 		result = repo.status
@@ -36,7 +36,7 @@ RSpec.describe Hglib::Repo do
 		repo = described_class.new( repo_dir )
 
 		expect( server ).to receive( :run_with_json_template ).
-			with( :status, {} ).
+			with( :status, any_args ).
 			and_return([
 				{
 					path: "lib/hglib/repo.rb",
@@ -73,7 +73,7 @@ RSpec.describe Hglib::Repo do
 		repo = described_class.new( repo_dir )
 
 		expect( server ).to receive( :run_with_json_template ).
-			with( :identify, nil, {} ).
+			with( :identify, nil, any_args ).
 			and_return( [{
 				bookmarks: ["v1.1", "live", "master"],
 				branch: "default",
@@ -96,7 +96,7 @@ RSpec.describe Hglib::Repo do
 		repo = described_class.new( repo_dir )
 
 		expect( server ).to receive( :run_with_json_template ).
-			with( :identify, nil, {} ).
+			with( :identify, nil, any_args ).
 			and_return( [{
 				bookmarks: ["v1.1", "live", "master"],
 				branch: "default",
@@ -116,7 +116,7 @@ RSpec.describe Hglib::Repo do
 		repo = described_class.new( repo_dir )
 
 		expect( server ).to receive( :run_with_json_template ).
-			with( :identify, nil, {} ).
+			with( :identify, nil, any_args ).
 			and_return( [{
 				bookmarks: ["v1.1", "live", "master"],
 				branch: "default",
@@ -173,7 +173,7 @@ RSpec.describe Hglib::Repo do
 	it "can fetch a diff of the current working copy of the repository" do
 		repo = described_class.new( repo_dir )
 
-		expect( server ).to receive( :run ).with( :diff, {} ).
+		expect( server ).to receive( :run ).with( :diff, any_args ).
 			and_return( "the diff" )
 
 		result = repo.diff
@@ -185,7 +185,7 @@ RSpec.describe Hglib::Repo do
 	it "can fetch a diff of particular files" do
 		repo = described_class.new( repo_dir )
 
-		expect( server ).to receive( :run ).with( :diff, 'README.md', 'Rakefile', {} ).
+		expect( server ).to receive( :run ).with( :diff, 'README.md', 'Rakefile', any_args ).
 			and_return( "two files diff" )
 
 		result = repo.diff( 'README.md', 'Rakefile' )
@@ -197,7 +197,7 @@ RSpec.describe Hglib::Repo do
 	it "can add all new files to the repository" do
 		repo = described_class.new( repo_dir )
 
-		expect( server ).to receive( :run ).with( :add, {} )
+		expect( server ).to receive( :run ).with( :add, any_args )
 
 		result = repo.add
 		expect( result ).to be_truthy
@@ -266,7 +266,7 @@ RSpec.describe Hglib::Repo do
 		repo = described_class.new( repo_dir )
 
 		expect( server ).to receive( :run ).
-			with( :sign, nil, {} ).
+			with( :sign, nil, any_args ).
 			and_return( "signing 47:66d4e21b7018\n" )
 
 		result = repo.sign
@@ -281,7 +281,7 @@ RSpec.describe Hglib::Repo do
 			repo = described_class.new( repo_dir )
 
 			expect( server ).to receive( :run ).
-				with( :phase, nil, {} ).
+				with( :phase, nil, any_args ).
 				and_return( "18: draft\n" )
 
 			result = repo.phase
@@ -294,7 +294,7 @@ RSpec.describe Hglib::Repo do
 			repo = described_class.new( repo_dir )
 
 			expect( server ).to receive( :run ).
-				with( :phase, '41c796d06fa398573ecec464238b827bfe75c7cd', {} ).
+				with( :phase, '41c796d06fa398573ecec464238b827bfe75c7cd', any_args ).
 				and_return( "12: draft\n" )
 
 			result = repo.phase( '41c796d06fa398573ecec464238b827bfe75c7cd' )
@@ -320,7 +320,7 @@ RSpec.describe Hglib::Repo do
 			repo = described_class.new( repo_dir )
 
 			expect( server ).to receive( :run ).
-				with( :phase, '13:10', {} ).
+				with( :phase, '13:10', any_args ).
 				and_return( "13: secret\n12: draft\n11: public\n10: public\n" )
 
 			result = repo.phase( '13:10' )
@@ -398,7 +398,7 @@ RSpec.describe Hglib::Repo do
 			repo = described_class.new( repo_dir )
 
 			expect( server ).to receive( :run ).
-				with( :phase, nil, {} ).
+				with( :phase, nil, any_args ).
 				and_return( "18: draft\n" ).
 				at_least( :once )
 

data/spec/spec_helper.rb

@@ -35,5 +35,7 @@ RSpec.configure do |config|
 	end
 	config.filter_run_excluding( :requires_binary ) unless Hglib.hg_path.executable?
 
+	ENV['HGUSER'] = 'RSpec Unit Tests <rspec@example.test>'
+
 	config.include( Loggability::SpecHelpers )
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hglib
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   jBZSA+N+xUTgUWpXjjwsLZjzJkhWATJWq+krNXcqpwXo6HsjmdUxoFMt63RBb+sI
   XrxOxp8o0uOkU7FdLSGsyqJ2LzsR4obN
   -----END CERTIFICATE-----
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loggability
@@ -50,20 +50,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: e2mmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake-deveiate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,7 @@ files:
 - lib/hglib/config.rb
 - lib/hglib/extension.rb
 - lib/hglib/extension/gpg.rb
+- lib/hglib/extension/topic.rb
 - lib/hglib/mixins.rb
 - lib/hglib/repo.rb
 - lib/hglib/repo/bookmark.rb
@@ -139,16 +154,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: This is a client library for the Mercurial distributed revision control tool