giturl 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d133efde0ae946e12d5c166bb0fc3ade2fea82a84a4d00a127866eeeac0c00c9
-  data.tar.gz: 88294d0ada19f1ca642f62668561c26c4b8c08b76a51ed354b3fbd714cfc9b71
+  metadata.gz: c164d5737cc9207b19779245f547671575724f8fef6a4d24efb767d3ca69abe0
+  data.tar.gz: 905b82675e666a7ca6d29dcaa3c261b0b69a45d7123b9503fd52abe82994678d
 SHA512:
-  metadata.gz: d2971849109e12fc832124ad2f4dc37f5bf5d6b3d6e715e47db5cc5e406f86efa2c40acbb2082d90bb55bd314b157ab9c41a5cceda310700b804d35d2807e12b
-  data.tar.gz: 2b6e6f0d2860581e35c51c0aa07b9d249e61e0708d2ecc9889174bdede3306c75bf89406e65ebb189d5cfcff1a8c2d2748233fad51425ef6ecb0ec3eb6e053ea
+  metadata.gz: 0134d3f7591471ee836560fbcd24494f347bb2f447f496b9b3a23046077ccfc048f71cdf1c4f66523fcf00b0b900dccb1d6cf97099cad8a630aac0fe7ccaaad1
+  data.tar.gz: a0bbd2bf6331592d3ae8ea91af67073676d6fc43ae0b7ab296a729babacb18e2d50b8f1a218e3406fe19f892d5a6c63d4193b0b06cff0ebf6f34adf5bebe2b00

data/.gitignore

@@ -1,4 +1,4 @@
-Gemfile.lock
+.DS_Store
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -7,3 +7,4 @@ Gemfile.lock
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [v1.1.4](https://github.com/shinyaohtani/giturl/tree/v1.1.4) (2020-03-16)
+
+[Full Changelog](https://github.com/shinyaohtani/giturl/compare/v1.1.3...v1.1.4)
+
+**Implemented enhancements:**
+
+- Changed method name
+  - url to convert:  low level method. git-managed dir only
+  - safe_url to url: check if git-managed and convert to url
+
 ## [v1.1.3](https://github.com/shinyaohtani/giturl/tree/v1.1.3) (2020-03-16)
 
 [Full Changelog](https://github.com/shinyaohtani/giturl/compare/v1.1.2...v1.1.3)

data/README.md

@@ -64,6 +64,21 @@ Or add `giturl` to your application's Gemfile and run `bundle` command:
 gem 'giturl'
 ```
 
+## Giturl module
+
+`Giturl` is also a module, so you can get urls from your ruby code.
+(*G*iturl is a name of module version of `giturl`)
+
+```ruby
+require 'giturl'
+
+path = './lib'
+url = Giturl::Giturl.url(path)
+p url unless url.nil?
+```
+
+See [code](./lib/giturl.rb)
+
 ## Changelog
 
 Refer to [Changelog.md](./CHANGELOG.md)

data/bin/giturl

@@ -7,9 +7,9 @@ require 'giturl'
 params = {}
 OptionParser.new do |opts|
   opts.version = Giturl::VERSION
-  opts.on('-o', '--[no-]open',    'Open the URL directly in your browser. default: no') { |v| v }
-  opts.on('-v', '--[no-]verbose', 'Verbose mode. default: no') { |v| v }
-  opts.on_tail('-h', '--help',    'Show this message') do
+  opts.on('-o', '--open', 'Open the URL directly in your browser. default: no') { |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
@@ -32,7 +32,7 @@ end
 
 ARGV.each do |arg|
   if Giturl::Giturl.git_managed?(arg)
-    url = Giturl::Giturl.url(arg)
+    url = Giturl::Giturl.convert(arg)
     print "#{url}\n"
     system("open #{url}") if params[:open]
   elsif params[:verbose]

data/giturl.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'irb'
 end

data/lib/giturl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Giturl
-  VERSION = '1.1.3'
+  VERSION = '1.1.4'
 end

data/lib/giturl.rb

@@ -5,6 +5,18 @@ require 'giturl/version'
 
 module Giturl
   class Giturl
+    # Check if path is a git-managed directory and return the URL of the GitHub web page for that path
+    #
+    # @param path [String] path to any directory. Both relative and absolute forms are accepted.
+    # @return [String] GitHub web page URL. This returns nil if the path is NOT a git-managed dir.
+    def self.url(path)
+      convert(path) if git_managed?(path)
+    end
+
+    # Check if the path is in the git-managed directory
+    #
+    # @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('/dev/null')
@@ -14,7 +26,11 @@ module Giturl
       inside == 'true'
     end
 
-    def self.url(path)
+    # Convert path to git-managed directory to GitHub web page URL
+    #
+    # @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 = `git -C #{path} rev-parse --show-prefix`.chomp
       gitdir_branch = `git -C #{path} rev-parse --abbrev-ref HEAD`.chomp
       remote_origin_url = `git -C #{path} config --get remote.origin.url`.chomp
@@ -24,9 +40,5 @@ module Giturl
 
       "#{baseurl}/tree/#{gitdir_branch}/#{gitdir_prefix}"
     end
-
-    def self.safe_url(path)
-      url(path) if git_managed?(path)
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: giturl
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Shinya Ohtani (shinyaohtani@github)
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Show or open GitHub URL for your local directory.
   You can use giturl to display the URL corresponding to the git-managed directory given as an argument, and you can open the URL directly in your browser if needed.