giturl 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ed16d5abfbf14f4c3f29d965513249de8997b9a027770550a077efcb0cf56a
-  data.tar.gz: a4eb298300d9e321c959fe6d818fc30cf916bc364852be47e7de9671134be6a9
+  metadata.gz: d133efde0ae946e12d5c166bb0fc3ade2fea82a84a4d00a127866eeeac0c00c9
+  data.tar.gz: 88294d0ada19f1ca642f62668561c26c4b8c08b76a51ed354b3fbd714cfc9b71
 SHA512:
-  metadata.gz: 33c2e13e16b84c23431cdfb64466fc607d2da0463cb95dcd727ba540c799e0e72326eed8acf5d6be7516217f2ab9ecf31f0a1afcb2623a9ffd93ef8b25ffa615
-  data.tar.gz: 9299a8a80d8e70a02e7f2955c2fe519dc4b5e121265751241cd2d90229083ea8ebe3dad476978a4b3498f16eff4c20ea38a61578d7cf1b1db3f2a91e03d41f34
+  metadata.gz: d2971849109e12fc832124ad2f4dc37f5bf5d6b3d6e715e47db5cc5e406f86efa2c40acbb2082d90bb55bd314b157ab9c41a5cceda310700b804d35d2807e12b
+  data.tar.gz: 2b6e6f0d2860581e35c51c0aa07b9d249e61e0708d2ecc9889174bdede3306c75bf89406e65ebb189d5cfcff1a8c2d2748233fad51425ef6ecb0ec3eb6e053ea

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [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)
+
+**Implemented enhancements:**
+
+- Improved README.md so that you can understand what `giturl` is immediately
+- Improved description for `--help` and `--version` options
+
 ## [v1.1.2](https://github.com/shinyaohtani/giturl/tree/v1.1.2) (2020-03-13)
 
 [Full Changelog](https://github.com/shinyaohtani/giturl/compare/v1.1.1...v1.1.2)

data/README.md

@@ -1,30 +1,41 @@
-# giturl
+# Welcome to giturl !
 
-Welcome to giturl!  Do you often want to access the GitHub web page from the terminal you are working on? You can use `giturl` to display the URL corresponding to the git-managed directory given as an argument, and open the URL directly in your browser if needed. `giturl` is a simple command. you can easily use from now on.
+## What is giturl?
 
-## Installation
+`giturl` is a helper for accessing GitHub web pages. Do you often want to access the GitHub web page from the terminal you are working on? You can use `giturl` to display the URL corresponding to the git-managed directory given as an argument. If you want to open the URL in a browser immediately, you can specify the `girurl` option to open the URL in the browser without operating the browser. `giturl` is a simple command. you can easily use from now on.
 
-Install `giturl` as:
+You can use `giturl` like:
 
-    $ gem install giturl
+```sh
+$ giturl .
+https://github.com/shinyaohtani/giturl/tree/master/lib/giturl/
+```
 
-Or add `giturl` to your application's Gemfile and run `bundle` command:
+and `--open`, or simply `-o` option is given, your browser opens the URLs
 
-```ruby
-gem 'giturl'
+```sh
+$ giturl -o .
+https://github.com/shinyaohtani/giturl/tree/master/lib/giturl/
+# == your default browser automatically opens the URL ==
 ```
 
 ## Usage
 
-You can use `giturl` as follows:
-
-    giturl [-o or --open] dir1 [dir2, dir3, ...]
+    giturl [-o or --open] [-v or --verbose]  dir1 [dir2, dir3, ...]
 
 Then you will get a list of URLs:
 
     URL1 [URL2, URL3, ...] (one URL for each line)
 
-and if `--open` is given, open the URLs on your browser.
+If `--verbose` is specified, print warnings for non-git-managed dirs:
+
+```sh
+$ giturl -v ~
+Not git-managed-dir:  /Users/myhome
+```
+
+## Usecase
+
 Here is a example to open GitHub web page for current directory:
 
 ```sh
@@ -40,6 +51,19 @@ https://github.com/shinyaohtani/giturl/tree/master/lib/giturl/
 
 # == your default browser automatically opens the URL ==
 ```
+
+## Installation
+
+Install `giturl` as:
+
+    $ gem install giturl
+
+Or add `giturl` to your application's Gemfile and run `bundle` command:
+
+```ruby
+gem 'giturl'
+```
+
 ## Changelog
 
 Refer to [Changelog.md](./CHANGELOG.md)
@@ -51,3 +75,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/shinya
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Refer to [LICENSE file](./LICENSE)
+
+## RubyGems
+
+https://rubygems.org/gems/giturl

data/bin/giturl

@@ -1,21 +1,34 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-#
-# usage
-#  giturl.rb [-o or --open] dir1 [dir2, dir3, ...]
-# output
-#  <url of dir1> [<url of dir2>, <url of dir3>, ...]
-#  and if -o is given, open urls in your browser.
-#
-
 require 'optparse'
 require 'giturl'
-opt = OptionParser.new
-opt.on('-o', '--open', 'Open the URL directly in your browser.') { |v| v }
-opt.on('-v', '--verbose', 'Turn on verbose mode.') { |v| v }
+
 params = {}
-opt.parse!(ARGV, into: 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
+    puts opts
+    exit
+  end
+  opts.on_tail('--version', 'Show version') do
+    puts opts.ver
+    exit
+  end
+  opts.banner = <<~BANNER
+
+    #{opts.ver}
+    A tiny utility that displays and opens GitHub URLs for your local directory.
+      visit: https://github.com/shinyaohtani/giturl
+
+    Usage: #{opts.program_name} [options] [dirs]
+     [options] are:
+  BANNER
+
+  opts.parse!(ARGV, into: params)
+end
 
 ARGV.each do |arg|
   if Giturl::Giturl.git_managed?(arg)

data/lib/giturl/version.rb

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

data/lib/giturl.rb

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'giturl/version'
+
 module Giturl
   class Giturl
     def self.git_managed?(path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giturl
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Shinya Ohtani (shinyaohtani@github)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler