gemdiff 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c039d85a194ef66692935ece9f322aa74312b735
-  data.tar.gz: 83636e6d83f61b0b7e510a95a05a12a6a12110bb
+  metadata.gz: c3898dd723d8d26e925dafa3acb27991770441ec
+  data.tar.gz: b76cc169d3721612d70b8834ecfdc05ae4506b7d
 SHA512:
-  metadata.gz: cc606da75134d7dfb3d48a9d7ce6134300ed3cdcb42db6f501084b699d5353d03da99a866c64335a4901bbce178388aefffbd76c42f7a1980254c2f6a53a991f
-  data.tar.gz: 11b319b29d91a8fa3945c6d3f525d128a515aded241b90a1bf2e6b932e6d08c1bce350de9fc068578f71bdaecd1367a99f21b0ceefa69b5fdb401717ae2cd6c7
+  metadata.gz: c0898a9357e02d3e41fa533b44eca9e0580234fadd332deac029a1b1bd2de84918648554b7f591a40910ef8a2d2a6943731570259dd7e344423043452e9b5309
+  data.tar.gz: 551677b3fa3cae12d917ce310c69ef8530af8063f3224230aa7c47ba5b9be959eec40b64e240a0fae6f8539147393d904c2875629af690d18dd05bf1655b4869

data/README.md

@@ -4,6 +4,12 @@
 associated with ruby gems. It makes it easy to compare source code differences
 between the current version of a gem in your bundle and the latest version of the gem.
 
+## Why?
+
+1. Looking up the github repository for a gem often requires The Google.
+2. Many gems do not have the source repository URL in the gemspec.
+3. You should Always Be Updating. This makes it easier.
+
 ## Install
 
 ```sh
@@ -11,30 +17,75 @@ gem install gemdiff
 ```
 
 ## Commands
-### find
+
+### `outdated`
+
+Runs `bundle outdated --strict` on the project in the current directory.
+For each outdated gem, it prompts you if you would like to open the compare view
+for that gem. Enter 'y' to review or enter to skip.
+
+This is the default task so you can just run `gemdiff`.
+
+```sh
+$ cd /your/ruby/project/using/bundler
+$ gemdiff
+Checking for outdated gems in your bundle...
+aws-sdk: 1.35.0 > 1.34.1
+Open? (y to open, else skip)
+webmock: 1.17.4 > 1.17.3
+Open? (y to open, else skip) y
+sprockets: 2.11.0 > 2.10.1
+Open? (y to open, else skip)
+```
+
+### `compare`
+
+You don't need to use bundler or be in a project. You can query a specific gem by
+entering explicit version numbers.
+
+For example, open the GitHub compare view in browser for difference between versions 4.0.2 and 5.0.0:
+
+```sh
+$ gemdiff compare arel --new=5.0.0 --old=4.0.2
+```
+
+### `find`
+
+Lookup the repository URL using the gemspec. If a GitHub URL is not found, hit the GitHub search API.
 
 ```sh
 $ gemdiff find arel
 http://github.com/rails/arel
 ```
 
-### open
+### `open`
+
+Open the repository URL:
+
 ```sh
 $ gemdiff open arel
-# opens arel project url in browser
 ```
 
-### compare
+### `releases`
+
+Open the repository's release history page:
+
 ```sh
-$ gemdiff compare arel --new=5.0.0 --old=4.0.2
-# opens GitHub compare view in browser for difference between versions 4.0.2 and 5.0.0
+$ gemdiff releases arel
 ```
 
-### outdated
+## It didn't work
 
-The holy grail:
+`gemdiff` operates on a few assumptions:
 
-```sh
-$ cd /your/ruby/project/using/bundler
-$ gemdiff
-```
+1. The gem must have a repository on GitHub. If not, `gemdiff` will find nothing or a similar repository, which
+is not helpful.
+
+2. The GitHub repository must have tagged releases to show compare views.
+
+3. The versions must be tagged using the standard name format of v1.2.3. If you find exceptions that follow
+a non-standard pattern, please submit a pull request. See `lib/gemdiff/outdated_gem.rb`.
+
+4. Encourage gem maintainers to either enter the GitHub repository URL in the `homepage` field of their gemspec,
+or anywhere in the description. `gemdiff` is much faster if so, and if not, it guesses the best match using
+the GitHub search API.

data/lib/gemdiff/cli.rb

@@ -18,10 +18,15 @@ module Gemdiff
     desc 'open gem_name', 'Open the github repository for a gem'
     def open(gem_name)
       gem = find(gem_name)
-      return unless gem.repo?
       gem.open
     end
 
+    desc 'releases gem_name', 'Open the github releases page for a gem'
+    def releases(gem_name)
+      gem = find(gem_name)
+      gem.releases
+    end
+
     desc 'compare gem_name', <<DESC
 Compare gem versions. Opens the compare view between the specified new and old versions.
 If versions are not specified, your bundle is inspected and the latest version of the
@@ -35,7 +40,7 @@ DESC
       gem.set_versions options
       if gem.missing_versions?
         puts "Checking for outdated gems in your bundle..."
-        unless gem.load_from_bundle
+        unless gem.load_bundle_versions
           puts "#{gem_name} is not outdated in your bundle. Specify versions."
           return
         end

data/lib/gemdiff/outdated_gem.rb

@@ -3,7 +3,7 @@ module Gemdiff
 
     # gems that tag releases with tag names like 1.2.3
     # keep it alphabetical
-    LIST_NO_V = %w[atomic haml thread_safe]
+    LIST_NO_V = %w[atomic babosa cancan compass haml thread_safe]
 
     attr_accessor :name, :old_version, :new_version
 
@@ -39,6 +39,10 @@ module Gemdiff
       !!repo
     end
 
+    def releases_url
+      "#{repo}/releases"
+    end
+
     def compare_message
       "#{name}: #{new_version} > #{old_version}"
     end
@@ -47,6 +51,10 @@ module Gemdiff
       "#{repo}/compare/#{compare_part}"
     end
 
+    def releases
+      `open #{releases_url}` if repo?
+    end
+
     def compare
       `open #{compare_url}` if repo?
     end

data/lib/gemdiff/version.rb

@@ -1,3 +1,3 @@
 module Gemdiff
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemdiff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tee Parham