impuri 0.11.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 137b242477de26374948f92a7033db38de59a1b08e5e53eceeca18e3c3c94d12
-  data.tar.gz: c918d32a40519df5d149faa8cc5d2b48cfd0abf5fcb3a1f2d684380cfa4250c4
+  metadata.gz: 7d2f3a83faa4992ce901d71360356ef7d7be186b6eed4c31c2c8a506c902d587
+  data.tar.gz: 90e51afb1721b37d287d8ff28e57aed1101b173b8ba9be3d683a8189d052966b
 SHA512:
-  metadata.gz: 54455a74f4486946e2948b1bed205a70af70d00c95dd453bc5a2c64382508be00dd6c2a4387d06355c36ef7bf0bdf83609be9b1211f9a5d5d1061b1ac4ead639
-  data.tar.gz: 350b3ba2ba2a9bf71696ceb903bf5961533f454301910bc0dcbd6c465f066cfa69223dc06ada2ad3ba5d5ea4a9f3791001004e04bca28f4ceb8b17bc623691fa
+  metadata.gz: 06fcf13867417ffdd2fb9d43176065dba97397053f41ae503094c096b44f18b324b2b18c666a30708efeaca1501aeeed3a1e270be010f42a82a85f9d055d686b
+  data.tar.gz: 564e3c7c97652c1aaeac254467a78252ba25edd63ccd06635f3a49d436e1f0c32f7483ab796cf9b65601d93bcb84362f2ff754c0f3f20bebfb4221125981d6bb

data/CHANGELOG

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## 20260819
+
+0.12.1: Tidy the gemspec, fill in its metadata, and guard both with a test.
+
+1. ~ impuri.gemspec: + a header comment naming the file, as every other file here carries, and + trailing commas to the last element of spec.files and spec.development_dependencies, so that adding to either touches one line rather than two. ~ spec.files reordered, the globs first and the loose files alphabetically after them, as moby and measurand have it. The globs are what the gem is and the rest is paperwork, so adding paperwork now never disturbs them. This repo had followed namo and http, which pin the gemspec first and put the globs last.
+2. ~ impuri.gemspec: + spec.metadata, being bug_tracker_uri, changelog_uri, source_code_uri and documentation_uri, as moby carries. These are the links rubygems shows beside the gem, and with none declared the page offers the homepage alone. The blob URLs name master, this repository's default branch, where moby's name main.
+3. + test/gemspec_test.rb: that the specification validates, that it pins no date, that its version is ImpURI::VERSION rather than a literal, that the four metadata keys are declared and that no blob link names a branch other than master, that it declares no runtime dependencies, and which development dependencies it declares. A link to a branch which does not exist is worse than no link, reading as a broken page rather than an absent one, and nothing else here would catch a rename. Modelled on moby's, which is where this pair of tests was settled.
+4. ~ test/ImpURI.rb: + require 'gemspec_test', the loader naming each test file by hand.
+5. ~ ImpURI::VERSION: /0.12.0/0.12.1/
+
+
+## 20260808
+
+0.12.0: + ImpURI#to_ssh, for going the other way.
+
+1. + ImpURI#to_ssh: the same resource as an ssh/scp descriptor, being [username@]hostname:path. Parsing both forms was the point of this from the start, and there was a renderer for neither of them beyond to_s giving back what it was handed.
+2. + The two paths are not the same kind of path, which is the whole of what makes this worth a method rather than a string interpolation. After a colon, a leading slash is the difference between a path from the root and one from the login directory, so a descriptor which arrived that way is returned exactly as it came. After a slash, that slash stood between the hostname and the path rather than anchoring it, so it is not carried into a form where it would say the other thing: github.com/thoran/lineage gives github.com:thoran/lineage and not github.com:/thoran/lineage.
+3. + has_colon_path_separator? is what tells the two apart, and it was already here.
+4. + ImpURI#username_with_separator, alongside the userinfo_with_separator and credentials_with_separator which were already here. to_ssh renders the username alone: ssh has no use for a password in this position, and a port number has nowhere to go in this form either, so both are dropped along with the scheme.
+5. + Nine tests over both directions, the password, the port number, and a descriptor with no path at all, which gives hostname and a colon, that being the login directory.
+6. Written for git-boot, which had been interpolating "#{username}@#{hostname}:#{path}" and getting git@github.com:/thoran/lineage for its trouble: a URI path spliced into a position where the leading slash means something else. That is a fault in the caller and not here, but a library which parses both forms may as well render both.
+
 ## 20260805
 
 0.11.0: Name the entry point and the gemspec for the gem.

data/README.md

@@ -60,6 +60,28 @@ impuri.parameters
 # => {'q' => 'param'}
 ```
 
+### Rendering
+
+```ruby
+impuri.to_s
+# => the string it was given back again
+
+ImpURI.new('github.com/thoran/lineage').to_ssh
+# => 'github.com:thoran/lineage'
+
+ImpURI.new('git@github.com:thoran/lineage.git').to_ssh
+# => 'git@github.com:thoran/lineage.git'
+
+ImpURI.new('user@host.com:/srv/git/thing.git').to_ssh
+# => 'user@host.com:/srv/git/thing.git'
+```
+
+`#to_ssh` renders the same resource as an ssh/scp descriptor, `[username@]hostname:path`.
+
+Where the path arrived after a colon it is left as it stands, since a leading slash there is the difference between a path from the root and one from the login directory, and an ssh descriptor is returned unchanged.  Where the path arrived after a slash, that slash separated it from the hostname rather than anchoring it, and so is not carried into a form where it would say the other thing.
+
+A scheme, a port number and a password are all dropped, this form having no place for any of them.
+
 ## Contributing
 
 1. Fork it ( https://github.com/thoran/impuri/fork )

data/impuri.gemspec

@@ -1,3 +1,5 @@
+# impuri.gemspec
+
 require_relative './lib/ImpURI/VERSION'
 
 class Gem::Specification
@@ -18,20 +20,27 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/thoran/ImpURI'
   spec.license = 'MIT'
 
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/thoran/ImpURI/issues',
+    'changelog_uri' => 'https://github.com/thoran/ImpURI/blob/master/CHANGELOG',
+    'source_code_uri' => 'https://github.com/thoran/ImpURI',
+    'documentation_uri' => 'https://github.com/thoran/ImpURI/blob/master/README.md',
+  }
+
   spec.required_ruby_version = '>= 2.7'
   spec.require_paths = ['lib']
 
   spec.files = [
-    'impuri.gemspec',
+    Dir['lib/**/*.rb'],
+    Dir['test/**/*.rb'],
     'CHANGELOG',
     'Gemfile',
+    'impuri.gemspec',
     'README.md',
     'TODO.txt',
-    Dir['lib/**/*.rb'],
-    Dir['test/**/*.rb']
   ].flatten
 
   spec.development_dependencies = [
-    ['minitest', '~> 6.0']
+    ['minitest', '~> 6.0'],
   ]
 end

data/lib/ImpURI/VERSION.rb

@@ -2,5 +2,5 @@
 # ImpURI::VERSION
 
 class ImpURI
-  VERSION = '0.11.0'
+  VERSION = '0.12.1'
 end

data/lib/impuri.rb

@@ -432,6 +432,20 @@ class ImpURI
     end
   end
 
+  def username_with_separator
+    has_username? ? "#{username}@" : ''
+  end
+
+  # A path which arrived after a colon is left as it stands, a leading slash there being the difference between a path from the root and one from the login directory.  A path which arrived after a slash was separated from the hostname by it rather than anchored by it, and so it is not carried into a form where it would mean the other thing.
+  def ssh_path
+    has_colon_path_separator? ? path : path.to_s.sub(%r{\A/}, '')
+  end
+
+  # The same resource as an ssh/scp descriptor, being [username@]hostname:path.  A port number has no place in this form and is dropped, as is a password, ssh having no use for one here.
+  def to_ssh
+    "#{username_with_separator}#{hostname}:#{ssh_path}"
+  end
+
   def to_h
     {scheme: scheme, username: username, password: password, hostname: hostname, port_number: port_number, path: path, parameter_string: parameter_string}
   end

data/test/ImpURI/instance_methods.rb

@@ -8,11 +8,8 @@ require 'impuri'
 require 'minitest/autorun'
 
 describe ImpURI do
-
   describe 'attribute readers' do
-
     describe 'a very simple http URI' do
-
       let(:impuri){ImpURI.new('http://example.com')}
 
       it 'must parse out the scheme' do
@@ -795,11 +792,9 @@ describe ImpURI do
         _(impuri.path).must_equal 'thoran/ImpURI.git'
       end
     end # describe 'an ssh identifier as per Github'
-
   end # describe 'attribute readers'
 
   describe 'attribute writers' do
-
     describe 'a very simple http URI' do
       let(:impuri){ImpURI.new('http://example.com')}
 
@@ -873,7 +868,75 @@ describe ImpURI do
         _(impuri.to_s).must_equal 'ftp://user:pass@example2.com:8080/path/to/here?a=1&b=2'
       end
     end # describe 'a very simple http URI'
-
   end # describe 'attribute writers'
 
+  describe '#to_ssh' do
+    describe 'a URI-style identifier' do
+      let(:impuri){ImpURI.new('github.com/thoran/lineage')}
+
+      # The slash stood between the hostname and the path rather than anchoring
+      # the path, and after a colon it would say the path began at the root.
+      it 'must not carry the separating slash into the path' do
+        _(impuri.to_ssh).must_equal 'github.com:thoran/lineage'
+      end
+    end # describe 'a URI-style identifier'
+
+    describe 'a URI-style identifier with a scheme' do
+      let(:impuri){ImpURI.new('https://github.com/thoran/lineage')}
+
+      it 'must leave the scheme out, there being no place for one' do
+        _(impuri.to_ssh).must_equal 'github.com:thoran/lineage'
+      end
+    end # describe 'a URI-style identifier with a scheme'
+
+    describe 'an ssh identifier with a path from the login directory' do
+      let(:impuri){ImpURI.new('git@github.com:thoran/lineage.git')}
+
+      it 'must return what it was given' do
+        _(impuri.to_ssh).must_equal 'git@github.com:thoran/lineage.git'
+      end
+    end # describe 'an ssh identifier with a path from the login directory'
+
+    describe 'an ssh identifier with a path from the root' do
+      let(:impuri){ImpURI.new('user@host.com:/srv/git/thing.git')}
+
+      it 'must keep the leading slash, that being the whole of the difference' do
+        _(impuri.to_ssh).must_equal 'user@host.com:/srv/git/thing.git'
+      end
+    end # describe 'an ssh identifier with a path from the root'
+
+    describe 'an identifier with a password' do
+      let(:impuri){ImpURI.new('user:pass@host.com:/srv/git/thing.git')}
+
+      it 'must render the username alone, ssh having no use for a password here' do
+        _(impuri.to_ssh).must_equal 'user@host.com:/srv/git/thing.git'
+      end
+    end # describe 'an identifier with a password'
+
+    describe 'an identifier with a port number' do
+      let(:impuri){ImpURI.new('http://example.com:8080/a/b')}
+
+      it 'must drop the port number, this form having nowhere to put one' do
+        _(impuri.to_ssh).must_equal 'example.com:a/b'
+      end
+    end # describe 'an identifier with a port number'
+
+    describe 'an identifier with no path' do
+      let(:impuri){ImpURI.new('example.com')}
+
+      it 'must return the hostname and a colon, being the login directory' do
+        _(impuri.to_ssh).must_equal 'example.com:'
+      end
+    end # describe 'an identifier with no path'
+  end # describe '#to_ssh'
+
+  describe '#username_with_separator' do
+    it 'must return the username and an at sign where there is one' do
+      _(ImpURI.new('git@github.com:thoran/lineage.git').username_with_separator).must_equal 'git@'
+    end
+
+    it 'must return an empty string where there is none' do
+      _(ImpURI.new('github.com/thoran/lineage').username_with_separator).must_equal ''
+    end
+  end # describe '#username_with_separator'
 end

data/test/ImpURI.rb

@@ -7,3 +7,4 @@ $LOAD_PATH.unshift(test_dir) unless $LOAD_PATH.include?(test_dir)
 
 require 'ImpURI/class_methods'
 require 'ImpURI/instance_methods'
+require 'gemspec_test'

data/test/gemspec_test.rb

@@ -0,0 +1,42 @@
+# test/gemspec_test.rb
+
+gem 'minitest'
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'impuri'
+require 'minitest/autorun'
+
+describe 'impuri.gemspec' do
+  let(:spec){Gem::Specification.load(File.expand_path('../impuri.gemspec', __dir__))}
+
+  it "is a valid specification" do
+    _(spec.validate).must_equal(true)
+  end
+
+  it "does not pin a date" do
+    _(spec.date).must_equal(Gem::Specification.new.date)
+  end
+
+  it "takes its version from ImpURI::VERSION" do
+    _(spec.version.to_s).must_equal(ImpURI::VERSION)
+  end
+
+  it "declares the metadata links rubygems shows beside the gem" do
+    _(spec.metadata.keys.sort) \
+      .must_equal(%w{bug_tracker_uri changelog_uri documentation_uri source_code_uri})
+  end
+
+  it "points its metadata at the branch which exists" do
+    _(spec.metadata.values.grep(%r{/blob/})).wont_be_empty
+    _(spec.metadata.values.grep(%r{/blob/(?!master/)})).must_equal([])
+  end
+
+  it "declares no runtime dependencies, the library standing alone" do
+    _(spec.runtime_dependencies).must_equal([])
+  end
+
+  it "declares its development dependencies" do
+    _(spec.development_dependencies.map(&:name).sort).must_equal(%w{minitest})
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: impuri
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.1
 platform: ruby
 authors:
 - thoran
@@ -59,10 +59,15 @@ files:
 - test/ImpURI.rb
 - test/ImpURI/class_methods.rb
 - test/ImpURI/instance_methods.rb
+- test/gemspec_test.rb
 homepage: https://github.com/thoran/ImpURI
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/thoran/ImpURI/issues
+  changelog_uri: https://github.com/thoran/ImpURI/blob/master/CHANGELOG
+  source_code_uri: https://github.com/thoran/ImpURI
+  documentation_uri: https://github.com/thoran/ImpURI/blob/master/README.md
 rdoc_options: []
 require_paths:
 - lib
@@ -77,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.18
 specification_version: 4
 summary: This is a hand-written non-validating parser for URI's and ssh/scp almost
   URI resource descriptors.