hglib 0.1.pre20180129173049 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afdee42722ca60142d6bb0ebffa22802d2aa881e83a16669f085cd3af24c4cf2
-  data.tar.gz: d1cbac7bd6ac25ef43a3d58ff0097244c108ca22146819a8bf867224e517e81f
+  metadata.gz: c5afd96a3fd5903f1ca7225d46a9db704abbe26faaddf1efb70e24dc6d08f2a6
+  data.tar.gz: 0f1bd5603a579a37dcef56c4e353550c10d0740a557524d515d5664ddd1c75be
 SHA512:
-  metadata.gz: 1a8e70e26c53215b1036b8d7acfc7543f25e5f49c1180d7a6dcfd481c1ea3b376dbe454ce6399a40ffd3f3f4731546bbe6de0b7f9916c69d46b811cb3c311343
-  data.tar.gz: f80807c638195e83f14e4429c6df1aa886bddc9c14979e97713fd8bcfed553c3b5684884f64985179a959cfefe155cd3f2b3cdcf817d1841ecedf4d090f76796
+  metadata.gz: 4f77a7e98c304184d863f4e19ed08eabfd05a13a9e2a87d368cbea07b3d6fccd456b3d50e775cd6c794a56831a9146f8062641f615f256fe8929ae30097eae36
+  data.tar.gz: c5892667e50469d93842abb09fccdc3f3ea328bc3f38ad0f4439b04a1ffd08e0152a2c21e88d86e420cfd797f49a62535247ff4ae84f67c5756b7dfcef4bf83b

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+8Va(���p����}q˯<��.E���*6雍���K�z
+}�%�_\�A�������$Pf,
e�Z��#��M/�2��2�S�B(�T�.v'�:��z�&.���S�Z�% f����أ%�=�^q`�7�Jq�w܊�'p��	
���l1)9~F1��6/���㿇������3":
+z�6�C�8D�Z7�����S��.��f�7�sD�t�&�w����z#p�������i'1�-s郷���=��x>Ǘ+�zEh�'b

data/ChangeLog

@@ -1,13 +1,96 @@
+2019-04-03  Michael Granger  <ged@FaerieMUD.org>
+
+@  	* Rakefile:
+|  	Make the project public
+|  	[847d7345d2eb] [tip]
+|
+o  	* History.md, lib/hglib.rb:
+|  	Bump the minor version and update history.
+|  	[e4dc675f47f3]
+|
+o  	* lib/hglib/repo/log_entry.rb, spec/hglib/repo/log_entry_spec.rb:
+|  	Add a #files attribute to log entries.
+|
+|  	This will be populated if you run #log with `verbose: true`.
+|  	[a66f9ba07f99]
+|
+o  	* lib/hglib/repo.rb:
+|  	Add Repo#status -> #stat alias
+|  	[f8308d34a0e1]
+|
+2019-01-16  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* .hoerc, .ruby-version, lib/hglib/repo.rb, spec/hglib/repo_spec.rb:
+|  	Use Ruby 2.6, add Repo#pull and #pull_update.
+|
+|  	Also fixes the Repo#log spec.
+|  	[b84a356151a3]
+|
+2018-11-28  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* lib/hglib/repo.rb, lib/hglib/repo/log_entry.rb,
+|  	spec/hglib/repo/log_entry_spec.rb:
+|  	Improve repo.log, add repo.commit
+|  	[399d83897663]
+|
+o  	* lib/hglib/server.rb, spec/hglib/server_spec.rb:
+|  	Improve server option-mangling
+|  	[8ffd61bb3183]
+|
+o  	* Rakefile, certs/ged.pem, hglib.gemspec:
+|  	=Update my gem-signing cert
+|  	[05a8abeeec84]
+|
+2018-05-22  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* .assemblies/commit:
+|  	Add Assemblage commit script
+|  	[4a1cbb9f8d56]
+|
+o  	* Manifest.txt, lib/hglib/repo/log_entry.rb, lib/hglib/server.rb,
+|  	spec/hglib/repo/log_entry_spec.rb, spec/spec_helper.rb:
+|  	Finish up log command/log entry class.
+|  	[ac2b07cce0fc]
+|
+2018-05-15  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* .gems, .hgignore, integration/commands/clone_spec.rb,
+|  	integration/spec_helper.rb, lib/hglib.rb, lib/hglib/repo.rb,
+|  	lib/hglib/repo/id.rb, lib/hglib/repo/log_entry.rb,
+|  	lib/hglib/server.rb, spec/hglib/repo/id_spec.rb,
+|  	spec/hglib/repo/log_entry_spec.rb, spec/hglib/repo_spec.rb,
+|  	spec/hglib/server_spec.rb, spec/spec_helper.rb:
+|  	Flesh out the features of Repo objects
+|  	[d4af915821de]
+|
+2018-03-13  Michael Granger  <ged@FaerieMUD.org>
+
+o  	* .hgignore, .pryrc, README.md, Rakefile, examples/clone.rb,
+|  	hglib.gemspec, lib/hglib.rb, lib/hglib/repo.rb,
+|  	lib/hglib/repo/log_entry.rb, lib/hglib/server.rb,
+|  	spec/hglib/server_spec.rb, spec/hglib_spec.rb, spec/spec_helper.rb:
+|  	=Added repo class, fixed a bunch of stuff.
+|  	[a366819bd05b]
+|
 2018-01-24  Michael Granger  <ged@FaerieMUD.org>
 
-	* .ruby-version:
-	Make ruby-version less specific
-	[81f357f730d9] [tip]
-
-	* .document, .editorconfig, .gems, .hg_archival.txt, .hgignore,
-	.pryrc, .rdoc_options, .ruby-gemset, .ruby-version, .simplecov,
-	Gemfile, History.md, LICENSE.txt, Manifest.txt, README.md, Rakefile,
-	certs/ged.pem, lib/hglib.rb, spec/hglib_spec.rb,
-	spec/spec_helper.rb:
-	Initial commit.
-	[d6c97f99b012]
+o  	* .document, .hgignore, .hoerc, .rdoc_options, Manifest.txt,
+|  	README.md, hglib.gemspec:
+|  	Update project metadata, build files
+|  	[5881275661a7]
+|
+o  	* lib/hglib.rb, spec/hglib_spec.rb:
+|  	Add configurable binpath to the top-level module
+|  	[da8322c8b033]
+|
+o  	* .ruby-version:
+|  	Make ruby-version less specific
+|  	[81f357f730d9]
+|
+o  	* .document, .editorconfig, .gems, .hg_archival.txt, .hgignore,
+   	.pryrc, .rdoc_options, .ruby-gemset, .ruby-version, .simplecov,
+   	Gemfile, History.md, LICENSE.txt, Manifest.txt, README.md, Rakefile,
+   	certs/ged.pem, lib/hglib.rb, spec/hglib_spec.rb,
+   	spec/spec_helper.rb:
+   	Initial commit.
+   	[d6c97f99b012]

data/History.md

@@ -1,4 +1,4 @@
-## v0.0.1 [YYYY-MM-DD] Michael Granger <ged@FaerieMUD.org>
+## v0.1.0 [2019-04-03] Michael Granger <ged@FaerieMUD.org>
 
 Initial release.
 

data/Manifest.txt

@@ -5,6 +5,18 @@ LICENSE.txt
 Manifest.txt
 README.md
 Rakefile
+examples/clone.rb
+integration/commands/clone_spec.rb
+integration/spec_helper.rb
 lib/hglib.rb
+lib/hglib/repo.rb
+lib/hglib/repo/id.rb
+lib/hglib/repo/log_entry.rb
+lib/hglib/server.rb
+spec/.status
+spec/hglib/repo/id_spec.rb
+spec/hglib/repo/log_entry_spec.rb
+spec/hglib/repo_spec.rb
+spec/hglib/server_spec.rb
 spec/hglib_spec.rb
 spec/spec_helper.rb

data/Rakefile

@@ -14,7 +14,6 @@ Hoe.plugin :signing
 Hoe.plugin :deveiate
 
 Hoe.plugins.delete :rubyforge
-Hoe.plugins.delete :gemcutter # Remove for public gems
 
 hoespec = Hoe.spec 'hglib' do |spec|
 	spec.readme_file = 'README.md'
@@ -84,6 +83,7 @@ end
 task :gemspec => GEMSPEC
 file GEMSPEC => __FILE__
 task GEMSPEC do |task|
+	Rake.application.trace "Rebuilding gemspec."
 	spec = $hoespec.spec
 	spec.files.delete( '.gemtest' )
 	spec.signing_key = nil

data/examples/clone.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'loggability'
+require 'hglib'
+
+Loggability.level = :debug
+
+Dir.chdir( File.expand_path('~/temp/') ) do
+	repo = Hglib.clone( 'https://bitbucket.org/ged/ruby-hglib' )
+	puts repo.status
+end
+
+

data/integration/commands/clone_spec.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+RSpec.describe "cloning" do
+
+	let( :repo_dir ) do
+		dir = Dir.mktmpdir( ['hglib', 'repodir'] )
+		Pathname( dir )
+	end
+
+
+	after( :each ) do
+		repo_dir.rmtree if repo_dir.exist?
+	end
+
+
+	it "can clone a local repo with no options" do
+		repo = Hglib.clone( '.', repo_dir )
+
+		expect( repo ).to be_a( Hglib::Repo )
+		expect( repo.path ).to eq( repo_dir )
+		expect( repo.status ).to be_empty
+		expect( repo_dir.children(false) ).to include(
+			Pathname( '.hg' ),
+			Pathname( 'Rakefile' )
+		)
+	end
+
+
+	it "can clone without updating" do
+		repo = Hglib.clone( '.', repo_dir, noupdate: true )
+
+		expect( repo ).to be_a( Hglib::Repo )
+		expect( repo.path ).to eq( repo_dir )
+		expect( repo.status ).to be_empty
+		expect( repo.id ).to eq( '000000000000' )
+		expect( repo_dir.children(false) ).to contain_exactly( Pathname('.hg') )
+	end
+
+
+	it "can clone to a specific revision" do
+		repo = Hglib.clone( '.', repo_dir, rev: 'da8322c8b033' )
+
+		expect( repo ).to be_a( Hglib::Repo )
+		expect( repo.path ).to eq( repo_dir )
+		expect( repo.status ).to be_empty
+		expect( repo.id ).to eq( 'da8322c8b033' )
+	end
+
+end
+

data/integration/spec_helper.rb

@@ -0,0 +1,29 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'tmpdir'
+
+require 'rspec'
+require 'hglib'
+
+RSpec.configure do |config|
+	config.expect_with :rspec do |expectations|
+		expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+	end
+
+	config.mock_with :rspec do |mocks|
+		mocks.verify_partial_doubles = true
+	end
+
+	config.shared_context_metadata_behavior = :apply_to_host_groups
+	config.filter_run_when_matching :focus
+	config.example_status_persistence_file_path = "spec/.status"
+	config.disable_monkey_patching!
+	config.warnings = true
+	config.profile_examples = 10
+	config.order = :random
+
+	config.filter_run_excluding( :requires_binary ) unless Hglib.hg_path.executable?
+
+	Kernel.srand( config.seed )
+end

data/lib/hglib.rb

@@ -12,10 +12,10 @@ module Hglib
 	       Exception2MessageMapper
 
 	# Package version
-	VERSION = '0.0.1'
+	VERSION = '0.1.0'
 
 	# Version control revision
-	REVISION = %q$Revision: a366819bd05b $
+	REVISION = %q$Revision$
 
 	# The default path to the `hg` command
 	DEFAULT_HG_PATH = begin
@@ -66,14 +66,14 @@ module Hglib
 	end
 
 
-	### Clone the +remote_repo+ to the specified +local_dir+, which defaults to a
-	### directory with the basename of the +remote_repo+ in the current working
+	### Clone the +source_repo+ to the specified +local_dir+, which defaults to a
+	### directory with the basename of the +source_repo+ in the current working
 	### directory.
-	def self::clone( remote_repo, local_dir=nil )
-		output = self.server( nil ).run( :clone, remote_repo, local_dir )
+	def self::clone( source_repo, local_dir=nil, **options )
+		output = self.server( nil ).run( :clone, source_repo, local_dir, **options )
 		self.log.debug "Clone output: %s" % [ output ]
 
-		local_dir ||= Pathname.pwd + File.basename( remote_repo )
+		local_dir ||= Pathname.pwd + File.basename( source_repo )
 		return self.repo( local_dir )
 	end
 

data/lib/hglib/repo.rb

@@ -0,0 +1,129 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'json'
+require 'loggability'
+require 'hglib' unless defined?( Hglib )
+
+
+class Hglib::Repo
+	extend Loggability
+
+	# Loggability API -- log to the hglib logger
+	log_to :hglib
+
+
+	autoload :Id, 'hglib/repo/id'
+	autoload :LogEntry, 'hglib/repo/log_entry'
+
+
+	### Create a new Repo object that will operate on the Mercurial repo at the
+	### specified +path+.
+	def initialize( path )
+		@path = Pathname( path )
+		@server = nil
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The path to the repository
+	attr_reader :path
+
+
+	### Return the Hglib::Server started for this Repo, creating it if necessary.
+	def server
+		return @server ||= self.create_server
+	end
+
+
+	### Return a Hash of the status of the files in the repo, keyed by Pathname of
+	### 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 )
+		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
+	end
+	alias_method :stat, :status
+
+
+	### 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 )
+		self.logger.debug "Got ID response: %p" % [ response ]
+
+		return Hglib::Repo::Id.parse( response.first )
+	end
+
+
+	### 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 )
+
+		return entries.map {|entry| Hglib::Repo::LogEntry.new(entry) }
+	end
+
+
+	### Commit the specified +files+ with the given +options+.
+	def commit( *files, **options )
+		response = self.server.run( :commit, *files, **options )
+		self.logger.debug "Got COMMIT response: %p" % [ response ]
+
+		return true
+	end
+
+
+	### Pull changes from the specified +source+ (which defaults to the +default+
+	### path) into the local repository.
+	def pull( source=nil, **options )
+		response = self.server.run( :pull, source, **options )
+		self.logger.debug "Got PULL response: %p" % [ response ]
+
+		return true
+	end
+
+
+	### Pull changes from the specified +source+ into the local repository and update
+	### to the new branch head if new descendents were pulled.
+	def pull_update( source=nil, **options )
+		options[:update] = true
+		return self.pull( source, **options )
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Create an Hglib::Server for this Repo.
+	def create_server
+		return Hglib::Server.new( self.path.to_s )
+	end
+
+
+	### Return the logger for this object; aliased to avoid the conflict with `hg log`.
+	def logger
+		return Loggability[ self ]
+	end
+
+end # class Hglib::Repo

data/lib/hglib/repo/id.rb

@@ -0,0 +1,81 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'hglib/repo' unless defined?( Hglib::Repo )
+
+
+# The identification of a particular revision of a repository.
+class Hglib::Repo::Id
+
+	### 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( '/' )
+
+		bookmarks ||= ''
+		bookmarks = bookmarks.split( '/' )
+
+		return self.new( global, *tags, uncommitted_changes: has_plus, bookmarks: bookmarks )
+	end
+
+
+	### 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
+		@bookmarks = Array( bookmarks )
+		@uncommitted_changes = uncommitted_changes
+	end
+
+
+	######
+	public
+	######
+
+	##
+	# The repo's global (short-form) revision identifier.
+	attr_reader :global
+
+	##
+	# The tags belonging to the revision of the repo.
+	attr_reader :tags
+
+	##
+	# The bookmarks set on the revision of the repo.
+	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
+
+		str << '+' if self.uncommitted_changes?
+		str << ' ' << self.tags.join( '/' ) unless self.tags.empty?
+		str << ' ' << self.bookmarks.join( '/' ) unless self.bookmarks.empty?
+
+		return str
+	end
+
+
+	### Comparison operator -- returns +true+ if the +other+ object is another
+	### Hglib::Repo::Id with the same values, or a String containing the #global
+	### revision identifier.
+	def ==( other )
+		return (other.is_a?( self.class ) && self.to_s == other.to_s) ||
+			self.global == other
+	end
+
+end # class Hglib::Repo::Id
+