impuri 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40ca40d65673baa8fd1e3e0ce1106e66ab63ca2d9aed70cbab13ace1b8c116db
-  data.tar.gz: 4604c7ea0f54a85b99a17fb9c93d864c911ccc950d3d4f622cf4a8a0edca9b26
+  metadata.gz: 44fb3692e45dc1de42d26f18c4a134fe6337e58333f7c69587e511e26530ecd4
+  data.tar.gz: 83726d475b88fc52c4ab0860639da6a80f363de6c162e71c32993d5dab7eebad
 SHA512:
-  metadata.gz: 6be56f6d68e9d44f190798b7f508e4d86fc4b5f67a15305e20a114c692a4070ef6e79259407e13d468d888dedfa5ccebf63d5ed8a6a4943442fb79e4b924a150
-  data.tar.gz: 0b173b0184b505df469f7183eb1d73cd79b020af261691601b2346e3bc09696d970ee00a6096577fe5d0d78d0c7f1e971ff953e2ea26818f46a344b1bffd948d
+  metadata.gz: 3d4d7434d832be7a361cd53699904cef3c892b9c09a6a76ba853422cf4b18218718afe20167d4c0545c6b66f339fec7007e815e2574a48daa3323e8ef841c6df
+  data.tar.gz: 7a03f5beb223d87fc130aed2fa04f346eabe0236173bc4a6285b8d7206357ce44655644d1810f631cab6a36c3721e786199b83b7500e719983d31f360c7390c8

data/CHANGELOG

@@ -0,0 +1,74 @@
+# CHANGELOG
+
+## 20260805
+
+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.
+3. ~ lib/Hash/x_www_form_urlencode.rb: the 2013 implementation replaced by the shim which requires the namespaced one. The old one called url_encode and then gsub'd spaces to plus signs, which url_encode had already done; the replacement drops that, and encodes identically.
+4. ~ lib/ImpURI.rb: require --> require_relative for the helpers and for VERSION, so that loading no longer depends upon the load path at all. lib/ImpURI.rb keeps its name, so `require 'ImpURI'` is unchanged and nothing which already uses the gem need be touched.
+5. - lib/ImpURI.rb: $LOAD_PATH.unshift, which was there to make the plain requires work and never could, since it added lib/ while the files were under lib/ImpURI/.
+6. - lib/ImpURI.rb: the date, version and description comments, the version now being kept only in lib/ImpURI/VERSION.rb.
+7. ~ ImpURI.gemspec: spec.version now reads ImpURI::VERSION, so that the version is declared in one place.
+8. - ImpURI.gemspec: spec.has_rdoc, which RubyGems has removed, and which aborted `gem build` outright.
+9. - ImpURI.gemspec: spec.date, which was stamped 2020-02-07 and is better left for the build to set.
+10. ~ ImpURI.gemspec: spec.required_ruby_version, 1.8.6 --> 2.7.
+11. ~ ImpURI.gemspec: spec.description shortened, and spec.homepage http --> https.
+12. ~ ImpURI.gemspec: spec.files now lists the gemspec, CHANGELOG, README.md and TODO.txt alongside lib and test, rather than lib alone, and + spec.require_paths, so as this matches the other gems. The tests now ship, and so can be run from the unpacked gem.
+13. + Gemfile, so as the development dependencies declared above are acted upon rather than merely stated. Without one nothing reads them, and a plain ruby lets any of the installed gems answer a require: RubyGems indexes every installed gem by the paths it provides, and activates whichever one answers. Under bundle exec only the resolved bundle is visible, which is how a require this does not declare fails here rather than for whoever installs it. Had this been developed so, the missing String/url_encode would have raised in 2020 instead of being answered by an unrelated gem.
+14. /CHANGES.txt/CHANGELOG/, and the entries reordered so as the most recent comes first.
+15. ~ .gitignore, filled out for Ruby.
+16. ~ README.md: trailing whitespace removed.
+17. + ImpURI.gemspec: development dependencies upon minitest and minitest-global_expectations, and the Gem::Specification#development_dependencies= helper to declare them.
+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
+
+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.
+3. Changes comments moved from lib/ImpURI.rb --> CHANGES.txt. (ie. This file!)
+4. /README/README.md/
+5. + lib/ImpURI/VERSION.rb
+6. + ImpURI.gemspec, so this is now a gem.  Finally!
+
+
+## 20140707
+
+0.7.0: Enable assignment of values to component parts
+
+1. + #scheme=.
+2. + #username=.
+3. + #password=.
+4. + #hostname=.
+5. + #port_number=.
+6. + #path=.
+7. + #parameter_string=.
+8. + #parameters=.
+9. + #request_uri=.
+10. + require 'Hash/x_www_form_urlencode'.
+11. ~ self.has_username?, so that it works more correctly.
+12. ~ #scheme_with_separator, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+13. ~ #userinfo, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+14. ~ #userinfo_with_separator, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+15. ~ #hostname_optionally_with_port_number, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+16. ~ #hostname_and_path, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+17. ~ #hostname_and_port_number, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+18. ~ #all_but_scheme, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+19. ~ #to_s, so that it is defined in terms of it's component parts, rather than making use of the class methods.
+20. ~ #to_h, so that it includes parameter_string.
+21. ~ #to_s, so that it makes use of #all_but_scheme, and includes parameter_string.
+22. + alias_methods for #has_semicolon_parameter_separator?.
+23. + alias #ssh? for #is_ssh?.
+24. ~ #has_scheme?, so that it tests the local component value, rather than using the corresponding class method.
+25. ~ #has_port_number?, so that it tests the local component value, rather than using the corresponding class method.
+26. ~ #has_parameters?, so that it tests the local component value, rather than using the corresponding class method.
+27. + #has_username?.
+28. + #has_password?.
+29. + #has_hostname?.
+30. + #has_path?.
+31. + #has_parameter_string?.
+32. + #hostname_optionally_with_port_number, for use in #all_but_scheme.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/ImpURI.gemspec

@@ -0,0 +1,38 @@
+require_relative './lib/ImpURI/VERSION'
+
+class Gem::Specification
+  def development_dependencies=(gems)
+    gems.each{|gem| add_development_dependency(*gem)}
+  end
+end
+
+Gem::Specification.new do |spec|
+  spec.name = 'impuri'
+  spec.version = ImpURI::VERSION
+
+  spec.summary = "This is a hand-written non-validating parser for URI's and ssh/scp almost URI resource descriptors."
+  spec.description = "This is a hand-written non-validating parser for URI's and ssh/scp almost URI resource descriptors, which is intended to be cleaner and simpler than Ruby's standard URI."
+
+  spec.author = 'thoran'
+  spec.email = 'code@thoran.com'
+  spec.homepage = 'https://github.com/thoran/ImpURI'
+  spec.license = 'MIT'
+
+  spec.required_ruby_version = '>= 2.7'
+  spec.require_paths = ['lib']
+
+  spec.files = [
+    'ImpURI.gemspec',
+    'CHANGELOG',
+    'Gemfile',
+    'README.md',
+    'TODO.txt',
+    Dir['lib/**/*.rb'],
+    Dir['test/**/*.rb']
+  ].flatten
+
+  spec.development_dependencies = [
+    ['minitest', '~> 6.0'],
+    ['minitest-global_expectations', '~> 1.0']
+  ]
+end

data/README.md

@@ -0,0 +1,69 @@
+# ImpURI
+
+## Description
+
+This is a hand-written non-validating parser for URI's and ssh/scp almost URI resource descriptors which is intended to be cleaner and simpler than Ruby's standard URI.
+
+## Raison d'etre
+
+I wrote it for two reasons...
+
+1. Ruby's standard URI library doesn't handle ssh/scp resource descriptors, which are the near-to, not quite URI, but commonly used, ssh/scp way of describing a network addressable resource: username:password@host:path.  URI's have a scheme at the start, and the path begins with only a forward slash, whereas an ssh/scp resource has no scheme, and the path begins with a colon and a slash.  I wanted to be able to handle both.
+
+2. Ruby's standard URI class does too much.  It is overblown and untidy.  I just want it to break the strings down and that's it.  I don't want any scheme interpolation from the port number, nor from the host name, or any other 'smarts'.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'impuri'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install impuri
+
+## Usage
+
+```ruby
+impuri = ImpURI.parse('scheme://user:pass@hostname.domain.name:20/path/to/resource?q=param')
+# => an object of class ImpURI
+
+impuri.scheme OR impuri.protocol
+# => 'scheme'
+
+impuri.userinfo OR impuri.credentials OR impuri.user_info OR impuri.username_and_password
+# => 'user:pass'
+
+impuri.user OR impuri.username
+# => 'user'
+
+impuri.pass OR impuri.passwd OR impuri.password
+# => 'pass'
+
+impuri.host OR impuri.hostname
+# => 'hostname.domain.name'
+
+impuri.port OR impuri.portnumber OR impuri.port_number
+# => '20'
+
+impuri.path
+# => '/path/to/resource'
+
+impuri.parameter_string
+# => 'q=param'
+
+impuri.parameters
+# => {'q' => 'param'}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/thoran/impuri/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request

data/TODO.txt

@@ -0,0 +1,6 @@
+1. Handle port numbers.  Done as of 0.1.0.
+2. Create strict and non-strict parsing modes, which will either accept or reject non-URI ssh/scp formatted strings if they are supplied.  Done as of 0.2.0.
+3. Doesn't handle some of the funkier URI's like: ssh:// with keys in the userinfo section, mailto: (no ://, but merely :), and ldap://.
+4. Consider encoding everything in the URI before breaking down the strings, so as to avoid the kind of complexity introduced in ImpURI.has_userinfo?().
+5. Be able to change the semicolon parameter separator for an ImpURI instance.
+6. Be able to change the colon path separator for an ImpURI instance, say if converting from ssh-form to the URI-form of an ssh resource for instance.  Any other uses?

data/lib/Hash/x_www_form_urlencode.rb

@@ -0,0 +1,7 @@
+# Hash/x_www_form_urlencode.rb
+# Hash#x_www_form_urlencode
+
+# 20260713
+# 0.2.0
+
+require 'Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode'

data/lib/ImpURI/VERSION.rb

@@ -2,5 +2,5 @@
 # ImpURI::VERSION
 
 class ImpURI
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/lib/ImpURI.rb

@@ -1,21 +1,14 @@
 # ImpURI.rb
 # ImpURI
 
-# 20200207
-# 0.8.0
-
-# Description: A cleaner and simpler URI and ssh/scp resource parser for Ruby.  Though I'm not sure about the simpler bit anymore.  It's now over 500 lines you know!
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
-
-require '_meta/blankQ'
-require 'Array/all_but_first'
-require 'Array/all_but_last'
-require 'Array/extract_optionsX'
-require 'Hash/x_www_form_urlencode'
-require 'Module/alias_methods'
-
-require 'ImpURI/VERSION'
+require_relative './_meta/blankQ'
+require_relative './Array/all_but_first'
+require_relative './Array/all_but_last'
+require_relative './Array/extract_optionsX'
+require_relative './Hash/x_www_form_urlencode'
+require_relative './Module/alias_methods'
+
+require_relative './ImpURI/VERSION'
 
 class ImpURI
 

data/lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb

@@ -0,0 +1,27 @@
+# Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb
+# Thoran::Hash::XWwwFormUrlencode#x_www_form_urlencode
+
+# 20260713
+# 0.3.0
+
+# Changes since 0.2:
+# -/0: (The class name and the snake case name really are consistent now.)
+# 1. /XWwwFormUrlEncode/XWwwFormUrlencode/
+# 2. /url_encode/urlencode/
+
+require 'Thoran/String/Urlencode/urlencode'
+
+module Thoran
+  module Hash
+    module XWwwFormUrlencode
+
+      def x_www_form_urlencode(joiner = '&')
+        inject([]){|a,e| a << "#{e.first.to_s.urlencode}=#{e.last.to_s.urlencode}" unless e.last.nil?; a}.join(joiner)
+      end
+      alias_method :x_www_form_url_encode, :x_www_form_urlencode
+
+    end
+  end
+end
+
+Hash.send(:include, Thoran::Hash::XWwwFormUrlencode)

data/lib/Thoran/String/Urlencode/urlencode.rb

@@ -0,0 +1,29 @@
+# Thoran/String/Urlencode/urlencode.rb
+# Thoran::String::Urlencode#urlencode
+
+# 20260713
+# 0.4.0
+
+# Acknowledgements: I've simply ripped off and refashioned the code from the CGI module!...
+
+# Changes since 0.3:
+# -/0: More consistent naming.
+# 1. /UrlEncode/Urlencode/
+# 2. /url_encode/urlencode/
+
+module Thoran
+  module String
+    module Urlencode
+
+      def urlencode
+        self.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+          '%' + $1.unpack('H2' * $1.size).join('%').upcase
+        end.tr(' ', '+')
+      end
+      alias_method :url_encode, :urlencode
+
+    end
+  end
+end
+
+String.send(:include, Thoran::String::Urlencode)