gemdiff 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d03ef46afcfc0969830ab752604bd3a67be7423
-  data.tar.gz: b46c1374c91d2da7146f5b5c014d14aee357f04e
+  metadata.gz: 9699f3b4b148ad62a7299fa51afe728287cff993
+  data.tar.gz: 2d5d1998b59ce66ed9f3d7949cb986a712a4b91d
 SHA512:
-  metadata.gz: 97c2d88bd72ab65bf7fe68f5dd8f4a2e16cb6de8706ad12c21f4431abcc48237c745fdf047252b5bbdd0d18c32264987a370b3693d6f82d12c517900d2602cc5
-  data.tar.gz: ec5ba5c1435ba9b5df82d18af889386facc6c4264a81acf99ec632765836e1d30dcc2d074e4603c843a468f94a3d95f586ff42ead9ded559cbf87c9e5d96bd64
+  metadata.gz: efc276dd4d4dee61f50a6ae2f3caff297a732d55e72cf82a0eb937c72d6980b5b8803369840f6c7ee38be1489fec43d1aec5081faf1c964070f04beb377c4a0a
+  data.tar.gz: bad1aef2a79b5070f6745b5a4370dc602903d19bad7795bb58cb871c73d257d8abfb6c824de00e47551295c22c4d0d02ae6f3079657144d2921179fa81341878

data/README.md

@@ -10,16 +10,16 @@ between the current version of a gem in your bundle and the latest version of th
 
 #### Why?
 
-You want to quickly view the source code differences between versions of gems when your dependencies are updated. 
-It is often not that easy, because finding the github repository for a gem often requires The Google since many 
-gems do not have the source repository URL in their gemspec. 
+You want to view the source code differences between versions of gems when your dependencies are updated. 
+`gemdiff` hides the complexity of the source repository lookup, provides commands to open common github
+pages, and provides efficient workflow commands that work with a bundled project (see `outdated`, `update`).
 
 #### How?
 
-`gemdiff` does the repository lookup by inspecting the gemspec, then searching github if needed. It uses bundler to 
-list your outdated gems. For each outdated gem, it determines your currently used version and the version you can 
-update to, and builds a compare view URL with the old and new version tags. It also provides `update` to assist in 
-the `bundle update` and commit workflow.
+`gemdiff` finds a repository by inspecting the local (or remote) gemspec, then searching github if needed. 
+It uses bundler to list your outdated gems. For each outdated gem, it determines your currently used version and 
+the version you can update to, and builds a compare view URL with the old and new version tags. 
+It also provides `update` for a simple `bundle update <gem>` and commit workflow.
 
 ## Install
 
@@ -31,11 +31,11 @@ gem install gemdiff
 
 ### `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.
+Runs `bundle outdated --strict` 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.
 
-This is the default task so you can just run `gemdiff`.
+`outdated` is the default task, so `gemdiff` with no arguments is the same as `gemdiff outdated`.
 
 ```sh
 $ cd /your/ruby/project/using/bundler
@@ -50,22 +50,23 @@ Outdated gems included in the bundle:
   * sprockets (2.11.0 > 2.10.1)
   * webmock (1.17.4 > 1.17.3)
 aws-sdk: 1.35.0 > 1.34.1
-Open? (y to open, else skip)
+Open? (y to open, x to exit, else skip)
 sprockets: 2.11.0 > 2.10.1
-Open? (y to open, else skip) y
+Open? (y to open, x to exit, else skip) y
 webmock: 1.17.4 > 1.17.3
-Open? (y to open, else skip)
+Open? (y to open, x to exit, else skip)
 ```
 
 ### `compare`
 
-You can open a compare view for an individual outdated gem in your bundle:
+Open a compare view for an individual outdated gem in your bundle:
 
 ```sh
 $ gemdiff compare haml
 ```
 
-You can bypass bundler and query a gem by including the old and new version numbers.
+You can bypass bundler and query a gem by including the old and new version numbers. This is faster since
+the `bundle` command to check the versions is skipped.
 
 For example, open the GitHub compare view in browser for difference between `haml` versions 4.0.4 and 4.0.5:
 
@@ -73,7 +74,7 @@ For example, open the GitHub compare view in browser for difference between `ham
 $ gemdiff compare haml 4.0.4 4.0.5
 ```
 
-You can compare an old version with a branch name:
+You can compare a version with a branch name:
 
 ```sh
 $ gemdiff compare arel 4.0.2 master
@@ -81,7 +82,7 @@ $ gemdiff compare arel 4.0.2 master
 
 ### `find`
 
-Lookup the repository URL using the gemspec. If a GitHub URL is not found, hit the GitHub search API.
+Lookup the repository URL using the gemspec. If a GitHub URL is not found, query the GitHub search API.
 
 ```sh
 $ gemdiff find haml
@@ -104,12 +105,12 @@ Open the repository's release history page:
 $ gemdiff releases haml
 ```
 
-### `commits`
+### `master`
 
 Open the repository's master branch commit history page:
 
 ```sh
-$ gemdiff commits haml
+$ gemdiff master haml
 ```
 
 ### `update`
@@ -171,11 +172,13 @@ 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`.
+3. The versions must be tagged using the standard name format of v1.2.3. If you find gems that follow
+a non-standard format (such as 1.2.3), please open an issue or submit a pull request. 
+See [`lib/gemdiff/outdated_gem.rb`](https://github.com/teeparham/gemdiff/blob/master/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.
+the GitHub search API. If you find exceptions, open an issue or submit a pull request.
+See [`lib/gemdiff/repo_finder.rb`](https://github.com/teeparham/gemdiff/blob/master/lib/gemdiff/repo_finder.rb).
 
-5. Some gems' source code is not on github (gasp!). `gemdiff` could support other source hosts. Submit a PR!
+5. Some gems' source code is not on GitHub (gasp!). `gemdiff` could support other source hosts. Submit a pull request!

data/gemdiff.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Gemdiff::VERSION
   spec.authors       = ["Tee Parham"]
   spec.email         = ["tee@neighborland.com"]
-  spec.summary       = %q{Compare gem versions}
-  spec.description   = %q{Command-line utility to find source repository URLs related to ruby gems and compare gem versions}
+  spec.summary       = %q{Find source repositories for ruby gems. Open, compare, and update outdated gem versions}
+  spec.description   = %q{Command-line utility to find source repositories for ruby gems, open common github pages, compare gem versions, and simplify gem update workflow in git}
   spec.homepage      = "https://github.com/teeparham/gemdiff"
   spec.license       = "MIT"
 

data/lib/gemdiff/cli.rb

@@ -34,13 +34,13 @@ module Gemdiff
       gem.releases
     end
 
-    desc 'commits <gem>', 'Open the github master branch commits page for a gem'
-    def commits(gem_name)
+    desc 'master <gem>', 'Open the github master branch commits page for a gem'
+    def master(gem_name)
       gem = find(gem_name)
-      gem.commits
+      gem.master
     end
 
-    desc 'compare <gem> [<old_version> <new_version>]', <<DESC
+    desc 'compare <gem> [<old> <new>]', <<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
 gem is compared with the current version in your bundle.
@@ -67,8 +67,9 @@ DESC
       puts inspector.outdated
       inspector.list.each do |gem|
         puts gem.compare_message
-        response = ask("Open? (y to open, else skip)")
+        response = ask("Open? (y to open, x to exit, else skip)")
         gem.compare if response == 'y'
+        return if response == 'x'
       end
     end
 

data/lib/gemdiff/outdated_gem.rb

@@ -56,7 +56,7 @@ module Gemdiff
       "#{repo}/compare/#{compare_part}"
     end
 
-    def commits
+    def master
       open_url(commits_url) if repo?
     end
 

data/lib/gemdiff/version.rb

@@ -1,3 +1,3 @@
 module Gemdiff
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

data/test/cli_test.rb

@@ -38,12 +38,12 @@ module Gemdiff
       end
     end
 
-    describe "#commits" do
+    describe "#master" do
       it "opens commits page" do
         gem = mock_gem("haml")
         @cli.expects(:puts).with("http://github.com/haml/haml")
-        gem.expects :commits
-        @cli.commits "haml"
+        gem.expects :master
+        @cli.master "haml"
       end
     end
 

data/test/outdated_gem_test.rb

@@ -96,5 +96,41 @@ module Gemdiff
         assert_equal "2.34.56", gem.new_version
       end
     end
+
+    describe "#master" do
+      it "opens master commits url" do
+        gem = OutdatedGem.new("x")
+        gem.stubs repo: "http://github.com/x/x"
+        gem.expects(:open_url).with("http://github.com/x/x/commits/master")
+        gem.master
+      end
+    end
+
+    describe "#releases" do
+      it "opens releases url" do
+        gem = OutdatedGem.new("x")
+        gem.stubs repo: "http://github.com/x/x"
+        gem.expects(:open_url).with("http://github.com/x/x/releases")
+        gem.releases
+      end
+    end
+
+    describe "#compare" do
+      it "opens compare url" do
+        gem = OutdatedGem.new("x", "1.2.3", "2.3.4")
+        gem.stubs repo: "http://github.com/x/x"
+        gem.expects(:open_url).with("http://github.com/x/x/compare/v1.2.3...v2.3.4")
+        gem.compare
+      end
+    end
+
+    describe "#open" do
+      it "opens repo url" do
+        gem = OutdatedGem.new("x")
+        gem.stubs repo: "http://github.com/x/x"
+        gem.expects(:open_url).with("http://github.com/x/x")
+        gem.open
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemdiff
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,8 +108,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
-description: Command-line utility to find source repository URLs related to ruby gems
-  and compare gem versions
+description: Command-line utility to find source repositories for ruby gems, open
+  common github pages, compare gem versions, and simplify gem update workflow in git
 email:
 - tee@neighborland.com
 executables:
@@ -163,7 +163,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Compare gem versions
+summary: Find source repositories for ruby gems. Open, compare, and update outdated
+  gem versions
 test_files:
 - test/bundle_inspector_test.rb
 - test/cli_test.rb