giturl 1.3.6 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573b19763ae39da18a0c44e608af15eb32e28ed76a1ec7a40330fdd6279a849a
-  data.tar.gz: c4af8e33c8a67d2c9f5e6459f0da798c5ad3ea315df2a2d1af61fe293d0f4707
+  metadata.gz: 6ff2df69734b9bef7d1cab4aec2988a50ca7a0aab7385c95a9dff717b993f842
+  data.tar.gz: 7357c5095c2ef759766fde7b7f88d0ab03a33fbfc0d1bc8e5f7d576a8e35c1a2
 SHA512:
-  metadata.gz: 210f26eb0a8fa88f37e134bd3d133fc02d8a2a535d2e4fc982fc088f390846046b6ae63598322552cf8f0bfde53e0dd7ae3fe3f7ecd38df0e2ac5fb5d624e0ca
-  data.tar.gz: 66e722c6696b5e9d8ce8e44b889511a372fb501c34067e4d9fe1fa161bd12b3e1fc962c91b375e2e7db0cdb8d3743030c1a14ba6916af8f826b7430fe9607829
+  metadata.gz: 529768719225bc69023f48ff584d051dcc6d962d7e3910173d3448cdc23c12f9b894039677430d8c8abedd5ab2b738823eb786e6c4f67e3f0f90f75604010b4b
+  data.tar.gz: ab9a6c1986efe1d11d548ccbc7e7bb4d4dd7dbb062fc52d6594c3007920f9366b070f7565ffcb92f0ca40d46b0d86d5d5879b121925e0c3f0a0b846bd93135a6

data/.rubocop.yml

@@ -12,7 +12,7 @@ plugins:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 3.2
   NewCops: enable
 
 Layout/EndAlignment:
@@ -41,7 +41,7 @@ Metrics/BlockLength:
 
 Metrics/MethodLength:
   Enabled: true
-  Max: 30
+  Max: 25
 
 Style/ExponentialNotation:
   Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## [v1.4.1](https://github.com/shinyaohtani/giturl/tree/v1.4.1) (2026-09-05)
+
+[Full Changelog](https://github.com/shinyaohtani/giturl/compare/v1.4.0...v1.4.1)
+
+- The first release on RubyGems to require Ruby 3.2, since v1.4.0 was
+  tagged but never pushed there. Everything v1.4.0 describes applies
+  here too, so read its entry below as part of this release.
+- Directories whose name contains a space or a shell metacharacter now
+  work, and remotes written as a URL (`https://`, `ssh://`, `git://`)
+  now convert correctly.
+
+**Fixed bugs:**
+
+- https:// remotes produce a malformed URL \(https///github.com/...\) [\#41](https://github.com/shinyaohtani/giturl/issues/41)
+- Paths containing spaces or shell metacharacters are not escaped [\#40](https://github.com/shinyaohtani/giturl/issues/40)
+
+**Merged pull requests:**
+
+- Run git without a shell, and parse remotes properly [\#44](https://github.com/shinyaohtani/giturl/pull/44) ([shinyaohtani](https://github.com/shinyaohtani))
+
+## [v1.4.0](https://github.com/shinyaohtani/giturl/tree/v1.4.0) (2026-09-04)
+
+[Full Changelog](https://github.com/shinyaohtani/giturl/compare/v1.3.6...v1.4.0)
+
+- Tagged but never published to RubyGems: two bugs were found before it
+  was pushed, so v1.4.1 went out in its place with the same changes plus
+  those fixes. `gem install giturl` never sees this version.
+- **Ruby 3.2 or later is now required.**
+  - On Ruby 2.x, install the last release that supported it: `gem install giturl -v 1.3.6`
+- No changes in behavior
+  - `Giturl::Giturl.url` / `.convert` / `.git_managed?` keep their signatures and results.
+  - The code behind them was reorganized into classes that each hold one responsibility.
+
+**Closed issues:**
+
+- Refactor into noun classes: behavior lives in class methods, responsibilities are mixed [\#43](https://github.com/shinyaohtani/giturl/issues/43)
+
+**Merged pull requests:**
+
+- Refactor into noun classes per the Ruby refactoring standard [\#42](https://github.com/shinyaohtani/giturl/pull/42) ([shinyaohtani](https://github.com/shinyaohtani))
+
 ## [v1.3.6](https://github.com/shinyaohtani/giturl/tree/v1.3.6) (2026-09-03)
 
 [Full Changelog](https://github.com/shinyaohtani/giturl/compare/v1.3.5...v1.3.6)

data/README.md

@@ -96,6 +96,13 @@ Or add `giturl` to your application's Gemfile and run `bundle` command:
 gem 'giturl'
 ```
 
+### Ruby version
+
+`giturl` requires **Ruby 3.2 or later**. On an older Ruby, install the last
+release that supported Ruby 2.x:
+
+    $ gem install giturl -v 1.3.6
+
 ## Giturl module
 
 `Giturl` is also a module, so you can get urls from your ruby code.

data/giturl.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = Giturl::DESCRIPTION
   spec.homepage      = "#{Giturl::REPOSITORY_URL}/blob/master/README.md"
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 

data/lib/command_giturl.rb

@@ -1,71 +1,56 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'launchy'
+require 'giturl'
+require 'giturl/options'
+
 # converter module from path to url
 module Giturl
-  require 'optparse'
-  require 'giturl'
-  require 'launchy'
-
-  # command line wrapper
+  # The giturl command: the directories named on the command line, and what the
+  # user asked to have done with them.
   class CommandGiturl
     attr_accessor :params
 
-    def parse_options
+    def initialize
+      @options = Options.new
       @params = {}
-      OptionParser.new do |opts|
-        opts = define_options(opts)
-        opts.parse!(ARGV, into: @params)
-        @params[:open] = true if @params.key?(:app)
-      end
     end
 
+    # @return [Hash] the options given on the command line
+    def parse_options
+      @params = @options.parse!(ARGV)
+    end
+
+    # Prints a URL per target directory, and opens each in a browser when asked.
+    # With no target given, the current directory is the target.
     def run
       ARGV << '.' if ARGV.empty?
-      ARGV.each do |arg|
-        if Giturl.git_managed?(arg)
-          url = Giturl.convert(arg)
-          print "#{url}\n"
-          browser_open(url) if @params[:open]
-        elsif @params[:verbose]
-          print "Not git-managed-dir:  #{arg}\n"
-        end
-      end
+      ARGV.each { |target| show(target) }
     end
 
     private
 
-    def define_options(opts)
-      opts.version = VERSION
-      opts.on('-o', '--open', 'Open the URL in your browser. default: no') { |v| v }
-      opts.on('-a [APPNAME]', '--app [APPNAME]', 'Specify a browser. i.e. "Safari.app"') { |v| v }
-      opts.on('-v', '--verbose', 'Verbose mode. default: no') { |v| v }
-      opts.on_tail('-h', '--help', 'Show this message') do
-        puts opts
-        exit
+    # @param target [String] a directory named on the command line
+    def show(target)
+      directory = GitDirectory.new(target)
+      unless directory.managed?
+        print "Not git-managed-dir:  #{target}\n" if @params[:verbose]
+        return
       end
-      opts.on_tail('-V', '--version', 'Show version') do
-        puts opts.ver
-        exit
-      end
-      opts.banner = <<~BANNER
-
-        #{opts.ver}
-        #{DESCRIPTION}
-        Usage: #{opts.program_name} [options] [dirs]
-         [dirs]:
-           Target directories. Omit this when you only specify "."
 
-         [options]:
-      BANNER
-      opts
+      url = directory.url
+      print "#{url}\n"
+      browser_open(url) if @params[:open]
     end
 
+    # Launchy cannot pick a specific application, so a named browser goes
+    # through macOS `open` instead, where that is what the user is running.
+    #
+    # @param url [String] the URL to show
     def browser_open(url)
       if @params[:app] && Launchy::Detect::HostOsFamily.detect.darwin?
-        comm = +"open #{url}"
-        comm << " -a #{@params[:app]}" if @params[:app]
-        system(comm)
+        system("open #{url} -a #{@params[:app]}")
       else
         Launchy.open(url)
       end

data/lib/giturl/git_directory.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'giturl/location'
+require 'giturl/remote_url'
+
+module Giturl
+  # A directory on disk, asked about through git: whether git manages it, and
+  # what GitHub page shows it. Every git invocation in giturl happens here.
+  class GitDirectory
+    FAILURE = 'Git commands failed. Please check if the directory is a git repository.'
+
+    def initialize(path)
+      @path = path
+    end
+
+    # git prints to stderr when the path is not a repository, which is noise for
+    # a question that is allowed to answer "no", so stderr is silenced around it.
+    #
+    # @return [Boolean] whether the directory is inside a git work tree
+    def managed?
+      stderr_old = $stderr.dup
+      $stderr.reopen(File::NULL)
+      inside, = capture('rev-parse', '--is-inside-work-tree')
+      $stderr.flush
+      $stderr.reopen stderr_old
+      inside == 'true'
+    end
+
+    # @return [String] the GitHub page URL for this directory, or '' (after a
+    #   warning) when git could not answer
+    def url
+      here = location
+      unless here
+        warn FAILURE
+        return ''
+      end
+
+      "#{RemoteUrl.new(here.remote).https}/tree/#{here.encoded_branch}/#{here.prefix}"
+    end
+
+    private
+
+    # All three commands run before the result is judged, so git reports every
+    # problem it has with the directory rather than only the first.
+    #
+    # @return [Location, nil] nil when any command failed or answered empty
+    def location
+      prefix, prefix_ok = capture('rev-parse', '--show-prefix')
+      branch, branch_ok = capture('rev-parse', '--abbrev-ref', 'HEAD')
+      remote, remote_ok = capture('config', '--get', 'remote.origin.url')
+      return nil unless prefix_ok && branch_ok && remote_ok
+
+      here = Location.new(prefix: prefix, branch: branch, remote: remote)
+      here.complete? ? here : nil
+    end
+
+    # git is run without a shell, so a directory name is never split on its
+    # spaces nor read for metacharacters.
+    #
+    # @return [Array(String, Boolean)] the command's output and whether it succeeded
+    def capture(*args)
+      output = IO.popen(['git', '-C', @path, *args], &:read).chomp
+      [output, Process.last_status.success?]
+    end
+  end
+end

data/lib/giturl/location.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Giturl
+  # Where a directory sits inside its repository: the path from the repository
+  # root down to it, the branch checked out, and the URL of the remote it came
+  # from. Immutable; built by GitDirectory from what git reports.
+  Location = Data.define(:prefix, :branch, :remote) do
+    # @return [Boolean] whether git answered with everything a URL needs.
+    #   prefix is legitimately empty at the repository root, so it is not required.
+    def complete?
+      !branch.empty? && !remote.empty?
+    end
+
+    # @return [String] the branch in the form a URL path can carry, each segment
+    #   percent-encoded but the separating slashes left intact
+    def encoded_branch
+      branch.split('/').map { |segment| ERB::Util.url_encode(segment) }.join('/')
+    end
+  end
+end

data/lib/giturl/options.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'giturl/version'
+
+module Giturl
+  # The options giturl accepts on the command line, and the values a given
+  # command line puts in them.
+  class Options
+    def initialize
+      @values = {}
+    end
+
+    # Consumes the options from argv, leaving the target directories behind.
+    # `--app` names a browser, which only makes sense together with `--open`,
+    # so it turns `--open` on by itself.
+    #
+    # @param argv [Array<String>] the command line, modified in place
+    # @return [Hash] the values given, keyed by long option name
+    def parse!(argv)
+      OptionParser.new do |opts|
+        definitions(opts).parse!(argv, into: @values)
+        @values[:open] = true if @values.key?(:app)
+      end
+      @values
+    end
+
+    private
+
+    # @return [OptionParser] opts, with every giturl option declared on it
+    def definitions(opts)
+      opts.version = VERSION
+      opts.on('-o', '--open', 'Open the URL in your browser. default: no') { |v| v }
+      opts.on('-a [APPNAME]', '--app [APPNAME]', 'Specify a browser. i.e. "Safari.app"') { |v| v }
+      opts.on('-v', '--verbose', 'Verbose mode. default: no') { |v| v }
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+      opts.on_tail('-V', '--version', 'Show version') do
+        puts opts.ver
+        exit
+      end
+      opts.banner = banner(opts)
+      opts
+    end
+
+    # @return [String] the description and usage shown above the option list
+    def banner(opts)
+      <<~BANNER
+
+        #{opts.ver}
+        #{DESCRIPTION}
+        Usage: #{opts.program_name} [options] [dirs]
+         [dirs]:
+           Target directories. Omit this when you only specify "."
+
+         [options]:
+      BANNER
+    end
+  end
+end

data/lib/giturl/remote_url.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Giturl
+  # The URL of a git remote, as `remote.origin.url` reports it, and the https
+  # page that serves the same repository.
+  #
+  # A remote is written either as an scp-style address
+  # (git@github.com:owner/repo.git) or as a URL carrying a scheme
+  # (https://, ssh://, git://). Only the scp-style form can name a Host alias
+  # from ~/.ssh/config (git@github.com-work:owner/repo.git) in place of a real
+  # hostname, so that is the only form ssh is asked about.
+  class RemoteUrl
+    SCHEMED = %r{\A[a-z][a-z0-9+.-]*://(?:[^@/]*@)?(?<host>[^/:]+)(?::\d+)?/(?<path>.*)\z}i
+    SCP = %r{\A(?:[^@/]+@)?(?<host>[^/:]+):(?<path>.*)\z}
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    # Anything neither form recognizes is handed back untouched: it names no
+    # host, so there is no page to point at.
+    #
+    # @return [String] the https URL of the page this remote is served from
+    def https
+      schemed = SCHEMED.match(@raw)
+      return page(schemed[:host], schemed[:path]) if schemed
+
+      scp = SCP.match(@raw)
+      return @raw unless scp
+
+      page(hostname(scp[:host]) || scp[:host], scp[:path])
+    end
+
+    private
+
+    # @return [String] https://<host>/<path>, without the .git git clones carry
+    def page(host, path)
+      "https://#{host}/#{path.delete_suffix('.git')}"
+    end
+
+    # @param host_alias [String] a Host entry from ~/.ssh/config
+    # @return [String, nil] the HostName ssh resolves it to, nil if ssh says nothing
+    def hostname(host_alias)
+      output = IO.popen(['ssh', '-G', host_alias], err: File::NULL, &:read)
+      line = output.lines.find { |candidate| candidate =~ /^hostname / }
+      return nil unless line
+
+      line.split[1]
+    end
+  end
+end

data/lib/giturl/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Giturl
-  VERSION = '1.3.6'
+  VERSION = '1.4.1'
   DESCRIPTION = <<~DESC
     giturl: A simple navigation tool for GitHub pages from local git-cloned directories.
 

data/lib/giturl.rb

@@ -2,13 +2,16 @@
 # frozen_string_literal: true
 
 require 'giturl/version'
+require 'giturl/git_directory'
 
 # converter module from path to url
 module Giturl
-  require 'erb'
-  # Main class of `Giturl` module.
+  # Published entry point of the `Giturl` module, kept as class methods because
+  # that is the interface released gems call:
   #
-  # `self.url` is recommended to get URL like: Giturl.url('./lib')
+  #   url = Giturl::Giturl.url('./lib')
+  #
+  # Nothing is decided here; every answer comes from a GitDirectory.
   class Giturl
     # Check if path is a git-managed directory and return the URL of the GitHub web page for that path
     #
@@ -23,12 +26,7 @@ module Giturl
     # @param path [String] path to check. Both relative and absolute forms are accepted.
     # @return [Boolean] git-managed directory or not.
     def self.git_managed?(path)
-      stderr_old = $stderr.dup
-      $stderr.reopen(File::NULL)
-      inside = `git -C #{path} rev-parse --is-inside-work-tree`.chomp
-      $stderr.flush
-      $stderr.reopen stderr_old
-      inside == 'true'
+      GitDirectory.new(path).managed?
     end
 
     # Convert path to git-managed directory to GitHub web page URL
@@ -36,53 +34,7 @@ module Giturl
     # @param path [String] path for a git-managed directory. Both relative and absolute forms are accepted.
     # @return [String] GitHub web page URL for the given git-managed directory
     def self.convert(path)
-      gitdir_prefix, gitdir_branch, remote_origin_url, ok = git_location_info(path)
-      unless ok
-        warn 'Git commands failed. Please check if the directory is a git repository.'
-        return ''
-      end
-      baseurl = construct_base_url(remote_origin_url)
-      encoded_branch = gitdir_branch.split('/').map { |e| ERB::Util.url_encode(e) }.join('/')
-      "#{baseurl}/tree/#{encoded_branch}/#{gitdir_prefix}"
-    end
-
-    # Run the git commands needed to build the URL, and report whether they succeeded.
-    #
-    # @param path [String] path for a git-managed directory
-    # @return [Array(String, String, String, Boolean)] prefix, branch, remote origin URL, and
-    #   whether the info is usable. gitdir_prefix may legitimately be empty (path is the
-    #   repository root), so only command success and non-empty branch/remote are required.
-    def self.git_location_info(path)
-      prefix, prefix_ok = run_git(path, 'rev-parse', '--show-prefix')
-      branch, branch_ok = run_git(path, 'rev-parse', '--abbrev-ref', 'HEAD')
-      remote, remote_ok = run_git(path, 'config', '--get', 'remote.origin.url')
-      ok = prefix_ok && branch_ok && remote_ok && !branch.empty? && !remote.empty?
-      [prefix, branch, remote, ok]
-    end
-    private_class_method :git_location_info
-
-    def self.run_git(path, *args)
-      output = `git -C #{path} #{args.join(' ')}`.chomp
-      [output, $?.success?] # rubocop:disable Style/SpecialGlobalVars
-    end
-    private_class_method :run_git
-
-    def self.construct_base_url(remote_origin_url)
-      baseurl = remote_origin_url
-      if remote_origin_url =~ /@(.*?):/
-        host_alias = ::Regexp.last_match(1)
-        real_hostname = get_real_hostname(host_alias)
-        baseurl = remote_origin_url.sub(host_alias, real_hostname) if real_hostname && real_hostname != host_alias
-      end
-      baseurl.tr(':', '/').gsub(/^.*@/, 'https://').gsub(/\.git$/, '')
-    end
-
-    def self.get_real_hostname(host_alias)
-      ssh_output = `ssh -G #{host_alias} 2>#{File::NULL}`
-      real_hostname_line = ssh_output.lines.find { |line| line =~ /^hostname / }
-      return nil unless real_hostname_line
-
-      real_hostname_line.split[1]
+      GitDirectory.new(path).url
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: giturl
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.4.1
 platform: ruby
 authors:
 - Shinya Ohtani (shinyaohtani@github)
@@ -55,6 +55,10 @@ files:
 - giturl.gemspec
 - lib/command_giturl.rb
 - lib/giturl.rb
+- lib/giturl/git_directory.rb
+- lib/giturl/location.rb
+- lib/giturl/options.rb
+- lib/giturl/remote_url.rb
 - lib/giturl/version.rb
 homepage: https://github.com/shinyaohtani/giturl/blob/master/README.md
 licenses:
@@ -72,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="