impuri 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6611f3db5d9b8b599247bbe6141a10bf166dfc9470ae71e9b345d11ccbb7a6ec
-  data.tar.gz: 9745a6127cd818bace3a0ed8d9fdff86242ae01385d5f7f90dbcf655c35ebb12
+  metadata.gz: c72a1dd69d974933264297f60ee3a7c049384798d1ea7a03f93dee06edbc1d2a
+  data.tar.gz: 1f2fb098d5be4b9fa995234f82efe16a68faa0b9d085f96626d6bafef4fa357b
 SHA512:
-  metadata.gz: 27a5b988acd092e0e9ea0b6b676a52c95678249e8e085f8a74f677c7b72bc61b846bfad343492a852ae06a67afada6c16368be9961b7d65927a70b008c881ad5
-  data.tar.gz: 9b3eacd4a16d8d794cdbb287862a169200ea43f64637f896f2765c6ef5a98637ee749b0d19148a6a05e7db9efb1989a05b2da03134a07da79520c6b1709e2d8b
+  metadata.gz: 1188cc96a712f06445506d575cdb70c5d318a5cd8fe46b378aa96b7fa1a2a35d8d5287781d0be7f24f94b8f02f5d8e5414834daecc10287b276b9e22b0b06f9e
+  data.tar.gz: fef2af493ff7a99a0a4dad6d8abaea054d79c30de505867275f1121a279e2ce676a2d3387b979d13fc20b913d8acdbd112ca2d83303554eb065fd35698065bc8

data/CHANGELOG

@@ -1,16 +1,39 @@
 # 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.
+
+1. lib/: /ImpURI.rb/impuri.rb/, so the require becomes require 'impuri' rather than require 'ImpURI'. This is the breaking change: anything using the gem must be altered. It resolves either way here, the volume being case insensitive, but not on Linux. namo, webdav and statistics.rb all name the entry point for the gem and keep the namespace directory in CamelCase, so lib/ImpURI/ is left as it is.
+2. /ImpURI.gemspec/impuri.gemspec/, and the spec.files entry with it. Invisible to anyone installing the gem, since nothing requires a gemspec.
+3. ~ tests: require 'ImpURI' --> require 'impuri'.
+
+0.10.1: Use let rather than instance variables set in a before block.
+
+1. ~ tests: before do @impuri = ... end --> let(:impuri){...}, for 25 blocks and 847 references across the two files. Nothing in lib changes, so this is a patch.
+2. Only the three names actually used were substituted, since the string literals hold http://user@example.com/ and git@github.com:thoran/ImpURI.git, and a general @word replacement would have rewritten those too.
+
 0.10.0: Move the tests onto the expectation form Minitest supports
 
 1. ~ tests: x.must_equal y --> _(x).must_equal y, across all 801 assertions in the two test files. The global form was Minitest reopening Object so that every object answered must_equal, which it has since removed. Minitest's own documentation prefers the wrapped form, because it carries the test context rather than reaching for a thread-local to find it.
 2. - ImpURI.gemspec: the development dependency upon minitest-global_expectations, which was added in 0.9.0 only to keep the tests running while they were in the old form.
 3. ~ tests: require 'minitest/global_expectations/autorun' --> require 'minitest/autorun'.
 
+
 ## 20260805
 
-0.9.0: Make the gem loadable on its own, rather than only where the helper files were already on the load path
+0.9.0: Make the gem loadable on its own, rather than only where the helper files were already on the load path.
 
 1. Moved the vendored helpers from lib/ImpURI/ up into lib/, so that they sit where they are required from. 0.8.0 shipped all seventeen of them, but one directory too deep: only lib/ goes onto the load path, so require '_meta/blankQ' looked for lib/_meta/blankQ.rb while the file sat at lib/ImpURI/_meta/blankQ.rb. The gem could therefore only be loaded on a machine which already had those helpers elsewhere on the load path, which is to say mine.
 2. + lib/Thoran/String/Urlencode/urlencode.rb and lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb, which had never been vendored at all. 0.8.0 required String/url_encode by way of Hash/x_www_form_urlencode.rb and shipped no such file, so that require was answered by whatever the machine happened to have: my own library, or any installed gem which vendored a file at that path. Both taken from http.rb 1.3.1, which carries the current implementation.
@@ -32,9 +55,10 @@
 18. ~ tests: require 'minitest/autorun' --> require 'minitest/global_expectations/autorun'. The tests are written in the global expectations style, as in `ImpURI.username(x).must_equal 'git'`, which Minitest has since removed, so every one of the 271 of them errored and not one of the 801 assertions ran. The shim restores that style without touching the tests; rewriting them to the `_(x).must_equal` form, and dropping the dependency again, is for 0.10.0.
 19. ~ ImpURI::VERSION: /0.8.0/0.9.0/
 
+
 ## 20200207
 
-0.8.0: Preparation for release as a gem
+0.8.0: Preparation for release as a gem.
 
 1. Moved the contents of lib/ImpURI.rbd/ImpURI.rb into lib/ImpURI.rb and changed the directory name from lib/ImpURI.rbd to lib/ImpURI, so that it has a more conventional structure and while the .rbd stuff doesn't work!
 2. /must_equal nil/must_be_nil/ in tests, due to Mintest 6 deprecation messages.
@@ -46,7 +70,7 @@
 
 ## 20140707
 
-0.7.0: Enable assignment of values to component parts
+0.7.0: Enable assignment of values to component parts.
 
 1. + #scheme=.
 2. + #username=.

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 → impuri.gemspec}

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.files = [
-    'ImpURI.gemspec',
+    'impuri.gemspec',
     'CHANGELOG',
     'Gemfile',
     'README.md',

data/lib/ImpURI/VERSION.rb

@@ -2,5 +2,5 @@
 # ImpURI::VERSION
 
 class ImpURI
-  VERSION = '0.10.0'
+  VERSION = '0.12.0'
 end

data/lib/{ImpURI.rb → impuri.rb}

@@ -1,4 +1,4 @@
-# ImpURI.rb
+# impuri.rb
 # ImpURI
 
 require_relative './_meta/blankQ'
@@ -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