impuri 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 137b242477de26374948f92a7033db38de59a1b08e5e53eceeca18e3c3c94d12
-  data.tar.gz: c918d32a40519df5d149faa8cc5d2b48cfd0abf5fcb3a1f2d684380cfa4250c4
+  metadata.gz: c72a1dd69d974933264297f60ee3a7c049384798d1ea7a03f93dee06edbc1d2a
+  data.tar.gz: 1f2fb098d5be4b9fa995234f82efe16a68faa0b9d085f96626d6bafef4fa357b
 SHA512:
-  metadata.gz: 54455a74f4486946e2948b1bed205a70af70d00c95dd453bc5a2c64382508be00dd6c2a4387d06355c36ef7bf0bdf83609be9b1211f9a5d5d1061b1ac4ead639
-  data.tar.gz: 350b3ba2ba2a9bf71696ceb903bf5961533f454301910bc0dcbd6c465f066cfa69223dc06ada2ad3ba5d5ea4a9f3791001004e04bca28f4ceb8b17bc623691fa
+  metadata.gz: 1188cc96a712f06445506d575cdb70c5d318a5cd8fe46b378aa96b7fa1a2a35d8d5287781d0be7f24f94b8f02f5d8e5414834daecc10287b276b9e22b0b06f9e
+  data.tar.gz: fef2af493ff7a99a0a4dad6d8abaea054d79c30de505867275f1121a279e2ce676a2d3387b979d13fc20b913d8acdbd112ca2d83303554eb065fd35698065bc8

data/CHANGELOG

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 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/lib/ImpURI/VERSION.rb

@@ -2,5 +2,5 @@
 # ImpURI::VERSION
 
 class ImpURI
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: impuri
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - thoran