librariesio-url-parser 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00d52ef052704194c97850963c18576440d6bede749f172f525b7738a0f5e79c
-  data.tar.gz: 2de0473ca0d0fd03e98ced3c6c2438be1691a4fe8617ea91da4d11783142efdc
+  metadata.gz: aed18904c0a030a5bdab10a3717974e2fe62ef63ec5525cb9aa5944213da540b
+  data.tar.gz: 69c24ecc3ea131c7725a9ab97a433131a53972e2b4e66b5d5cf9854e6ab63a1b
 SHA512:
-  metadata.gz: 17340548393bb17653360e84d467f7488aec88a601cc0e7afae0deefc9ffdcba04829734dc5de2ca48971cc24a42d7063261398b5d38b39253ee27b68fc37eb1
-  data.tar.gz: 00267ffa423156ac519fa4a484210edbb5677eedd57ab0e0a2073ecb978b1dc948a1839df68c50f772b501e9081326df019b6ca1fde1ad462fc18b994971b769
+  metadata.gz: 529bd4550e2ec85f30ae870908ffd10931845da891d06ed138fbb0c9abe026e901b35a896b18c2a2b2b40cc1cdfdcd53527e38db1158ab4782e8349be06e092f
+  data.tar.gz: f8627e676157b0cdad2acfc2e5441f1a532bb39a68ef9164a1b6fed285b21fb719d8ec197dbc48dff67616648e8c83d750065713292a370d39bf24b19124cd85

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    librariesio-url-parser (1.0.8)
+    librariesio-url-parser (1.0.9)
 
 GEM
   remote: https://rubygems.org/

data/lib/librariesio-url-parser.rb

@@ -13,5 +13,5 @@ require_relative "android_googlesource_url_parser"
 require_relative "sourceforge_url_parser"
 
 module LibrariesioURLParser
-  VERSION = "1.0.8"
+  VERSION = "1.0.9"
 end

data/lib/url_parser.rb

@@ -11,13 +11,16 @@ class URLParser
     @url = url.to_s.dup
   end
 
+  # Clean the URL and format the path segments after the domain
+  #
+  # @return String Path segments after the domain joined by a "/"
   def parse
     return nil unless parseable?
 
     if url = extractable_early?
       url
     else
-      clean_url
+      clean_url!
       format_url
     end
   end
@@ -39,6 +42,10 @@ class URLParser
     end
   end
 
+  # Clean and parse the URL string returning all path segments following
+  # the domain.
+  #
+  # @return String Domain with URL path segments appended
   def parse_to_full_url
     path = parse
     return nil if path.nil? || path.empty?
@@ -46,13 +53,17 @@ class URLParser
     [full_domain, path].join('/')
   end
 
+  # Clean and parse the URL string returning the first path following the domain.
+  #
+  # @return [String, nil] Domain with the lone user path segment appended. If the path resolved
+  #  to more than one segment nil is returned since it is considered an invalid URL for a user.
   def parse_to_full_user_url
     return nil unless parseable?
 
-    path = clean_url
-    return nil unless path.length == 1
+    clean_url!
+    return nil unless url.length == 1
 
-    [full_domain, path].join('/')
+    [full_domain, url].join('/')
   end
 
   def self.case_sensitive?
@@ -80,7 +91,12 @@ class URLParser
 
   attr_accessor :url
 
-  def clean_url
+  # Clean up the string URL to find the non domain pieces of the URL and pass back
+  # to the specific parser class.
+  ##
+  # @return [Array<String>, nil] Array of URL path segments following the domain or nil if the
+  #   URL string does not contain the valid domain name.
+  def clean_url!
     remove_whitespace
     remove_quotes
     remove_brackets
@@ -100,8 +116,18 @@ class URLParser
     remove_git_scheme
     remove_extra_segments
     remove_git_extension
+
+    # url should have been transformed to an array during the various method calls
+    # The method is transforming the initialized url in place so any callers should
+    # reference url directly instead of expecting a return here.
+    url
   end
 
+  # Join URL path segments for owner and repository name together with a "/" character.
+  #
+  #
+  # @return [String, nil] URL path segments joined by "/" or nil if there are not separate owner and
+  #   repository name segments.
   def format_url
     return nil if url.nil?
     return nil unless url.length == 2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librariesio-url-parser
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Matt Pace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake