librariesio-url-parser 1.0.8 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00d52ef052704194c97850963c18576440d6bede749f172f525b7738a0f5e79c
-  data.tar.gz: 2de0473ca0d0fd03e98ced3c6c2438be1691a4fe8617ea91da4d11783142efdc
+  metadata.gz: 13dcf367366e2bb9727f9e810ad38a9b6cb41eecf1cfb9a3b2d655067acf6e73
+  data.tar.gz: ca7a9fc70d37d58839af903d2905c60dbf38fb3adc502027eef54a6a5f2ffc92
 SHA512:
-  metadata.gz: 17340548393bb17653360e84d467f7488aec88a601cc0e7afae0deefc9ffdcba04829734dc5de2ca48971cc24a42d7063261398b5d38b39253ee27b68fc37eb1
-  data.tar.gz: 00267ffa423156ac519fa4a484210edbb5677eedd57ab0e0a2073ecb978b1dc948a1839df68c50f772b501e9081326df019b6ca1fde1ad462fc18b994971b769
+  metadata.gz: 0f845dfec84e2d285a9f4a07e62df8d2de1b6a8c9ddf389449f964c7e2522fbbfa017553049898a1d4febe4fa457830de5af53808c29b1a9f3805bd80840ea66
+  data.tar.gz: e77275f149adcbe4c7676d494bd124ba1379f262673d21a997aed7788d72c3b86fedd8ae7e000110404ddba8f96d1c4013149e4a8e0a08dcda047383b7f8c55e

data/.circleci/config.yml

@@ -1,19 +1,19 @@
 version: 2.1
 orbs:
-  ruby: circleci/ruby@1.8.0
+  ruby: circleci/ruby@2.1.3
 
 jobs:
   test:
     docker:
-      - image: cimg/ruby:2.6.5
+      - image: cimg/ruby:3.1.5
     executor: ruby/default
     steps:
-    - checkout
-    - run:
-        name: Which bundler?
-        command: bundle -v
-    - ruby/install-deps
-    - ruby/rspec-test
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/install-deps
+      - ruby/rspec-test
 
 workflows:
   version: 2.1

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.1.5

data/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
-ruby "2.6.5"
+ruby "3.1.5"
 
 # Specify your gem's dependencies in librariesio-url-parser.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    librariesio-url-parser (1.0.8)
+    librariesio-url-parser (1.0.10)
 
 GEM
   remote: https://rubygems.org/
@@ -40,7 +40,7 @@ DEPENDENCIES
   rspec_junit_formatter (~> 0.5)
 
 RUBY VERSION
-   ruby 2.6.5p114
+   ruby 3.1.5p252
 
 BUNDLED WITH
    2.1.4

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.10"
 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
@@ -136,7 +162,7 @@ class URLParser
   def extractable_early?
     return false if website_url?
 
-    match = url.match(/([\w\.@\:\-_~]+)\.#{domain_regex}\/([\w\.@\:\-\_\~]+)/i)
+    match = url.match(/([\w\.\@\:\-\~]+)\.#{domain_regex}\/([\w\.\@\:\-\~]+)/i)
     if match && match.length == 4
       return "#{match[1]}/#{match[3]}"
     end

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.10
 platform: ruby
 authors:
 - Matt Pace
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-08-08 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: []
@@ -99,7 +99,7 @@ licenses:
 - AGPL-3.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Parse the URL for various repositories tracked by libraries.io
 test_files: []