librariesio-url-parser 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bae64bd33bdd5556d8d16472bf9c815813375f60254335b0e39c8e80a669249f
-  data.tar.gz: 06b4b0e89906bcf89d8679e96c48028991a0f77eeb200950b617c02a2b8671ba
+  metadata.gz: aed18904c0a030a5bdab10a3717974e2fe62ef63ec5525cb9aa5944213da540b
+  data.tar.gz: 69c24ecc3ea131c7725a9ab97a433131a53972e2b4e66b5d5cf9854e6ab63a1b
 SHA512:
-  metadata.gz: 19ab606c3ee731d48df907595b9a6ccaf01ded2dd4606928744766f729ea1718d776a1be481f12c9cae34f2e0b4b2109fc12ce895cc016b499c2767661c94cf0
-  data.tar.gz: 3aab091fb8161ea1d928cfd51eddbfc66b9b8a6d8f1c446e247f1c3417a5908a27a07d14057656835a73d98d6e276ad08da1467f2dd394f6a1c5fbe2e6fd991d
+  metadata.gz: 529bd4550e2ec85f30ae870908ffd10931845da891d06ed138fbb0c9abe026e901b35a896b18c2a2b2b40cc1cdfdcd53527e38db1158ab4782e8349be06e092f
+  data.tar.gz: f8627e676157b0cdad2acfc2e5441f1a532bb39a68ef9164a1b6fed285b21fb719d8ec197dbc48dff67616648e8c83d750065713292a370d39bf24b19124cd85

data/.gitignore

@@ -0,0 +1,2 @@
+# rubymine generated files
+.idea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    librariesio-url-parser (1.0.7)
+    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.7"
+  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,8 +91,14 @@ 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
     remove_anchors
     remove_querystring
@@ -99,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
@@ -190,4 +217,8 @@ class URLParser
   def remove_whitespace
     url.gsub!(/\s/, '')
   end
+
+  def remove_quotes
+    url.gsub!(/["']/, '')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librariesio-url-parser
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.9
 platform: ruby
 authors:
 - Matt Pace
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.1
-description:
+description: 
 email:
 - matt.pace@tidelift.com
 executables: []
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".gitignore"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
@@ -98,7 +99,7 @@ licenses:
 - AGPL-3.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Parse the URL for various repositories tracked by libraries.io
 test_files: []