grub 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe48faae713a6ecd2906e70df215eab1d9922bc0
-  data.tar.gz: 732436f1d266fc95011ce8eab373c2a6646f305c
+  metadata.gz: 306499cfdaa4d796bba7cfcb5104912e73db4601
+  data.tar.gz: a7ba997f3eaba6b7339625e2f8b34fe16fcedc4d
 SHA512:
-  metadata.gz: 915a377049972ea359ada3eea8622cdbb3cc646ae075e029c95148c7b398a8f9d22a623eba56c8dd53b2ec28625434a7c0d28206df433188bfd5ccf03e151c3b
-  data.tar.gz: 331556522d02d6e7ec4c12c6ea7f5a2fbb4d41ff30fa0b1a5d3bf657ee2249cccc73124b958ffe45e7b4da7e467606b2fd4d9539184f9bcda88386518ee1bdbe
+  metadata.gz: e67ad918f019680c8adf272258be4cf2d6188ca07481192a0d49db465295fe9fcb0ea3c0cb6c3aaf171722dd616e95d0d4b2ce5e4e37f4b41d6c6271fb15b8e8
+  data.tar.gz: 20b025bdd744295afebb01347d92881a72155d340e839a0fb73b99f8e4dd48e4f3048ea11da7e98b1290f5dd33eac94ad2763180de72f54e17a8df9fede16c9a

data/Gemfile

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in grub.gemspec
 gemspec
 
+# An IRB alternative and runtime developer console (http://pryrepl.org)
 gem "pry"

data/README.md

@@ -1,30 +1,65 @@
 # Grub
 
-TODO: Write a gem description
+`grub` is command line tool that will add useful comments to your Gemfile. For each gem, `grub` will create a comment with the gem's description and the gem's website. For example, a Gemfile containing the following
 
-## Installation
+```ruby
+gem "rails"
+gem "nokogiri"
+gem "brakeman"
+```
 
-Add this line to your application's Gemfile:
+will be converted into something that is more descriptive and is self-documenting:
 
 ```ruby
-gem 'grub'
+# Full-stack web application framework. (http://www.rubyonrails.org)
+gem "rails"
+# Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser (http://nokogiri.org)
+gem "nokogiri"
+# Security vulnerability scanner for Ruby on Rails. (http://brakemanscanner.org)
+gem "brakeman"
 ```
 
-And then execute:
+The motivation for `grub` is that developers often open a Gemfile and not know what many of the listed gems are actually for. It's hard to track down which gem is providing which functionality. This is a common problem since many gem names do not reflect the actual feature.
 
-    $ bundle
-
-Or install it yourself as:
+## Installation
 
-    $ gem install grub
+```
+$ gem install grub
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Running `grub` itself will add comments to the current directory's `Gemfile`.
+
+```
+$ cat Gemfile
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grub.gemspec
+gemspec
+
+gem "pry"
+$ grub
+$ cat Gemfile
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grub.gemspec
+gemspec
+
+# An IRB alternative and runtime developer console (http://pryrepl.org)
+gem "pry"
+```
+
+`grub` has several options and you can see them via `grub -h`. `grub` also works with specifying a single gem name:
+
+```
+$ grub aasm
+State machine mixin for Ruby objects (https://github.com/aasm/aasm)
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/grub/fork )
+1. Fork it ( https://github.com/ivantsepp/grub/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/grub/cli.rb

@@ -32,10 +32,10 @@ module Grub
 
     private
 
-    def print_progress(completed, total)
-      print "Fetching gem metadata..." if completed.zero?
+    def print_progress(processing, total)
+      print "Fetching gem metadata..." if processing.zero?
       print "."
-      print "\n" if completed == total
+      print "\n" if processing == total
     end
   end
 end

data/lib/grub/gem_line.rb

@@ -28,7 +28,7 @@ module Grub
     end
 
     def should_insert?
-      !info.empty? && !already_added_comment && !existing_comment_option
+      !info.strip.empty? && !already_added_comment && !existing_comment_option
     end
 
     private

data/lib/grub/spec_finder.rb

@@ -12,26 +12,27 @@ module Grub
     def find_matching_specs_for(gem_lines)
       gem_lines.each do |line|
         matching_specs = Gem::Dependency.new(line.name).matching_specs
-        # need to find latest
+        # TODO: need to find latest
         line.spec = matching_specs.first if matching_specs.any?
       end
     end
 
     def fetch_specs_for(gem_lines)
       total = gem_lines.length
-      completed = 0
-      yield completed, total if block_given?
+      processing = 0
+      yield processing, total if block_given?
+      # TODO: Support private sources
       remote = Bundler::Source::Rubygems::Remote.new(Gem.sources.first.uri)
       fetcher = Bundler::Fetcher.new(remote)
       dependency_fetcher = fetcher.fetchers.find {|f| Bundler::Fetcher::Dependency === f }
       versions, _ = dependency_fetcher.dependency_specs(gem_lines.collect(&:name))
       gem_lines.each do |gem_line|
+        processing += 1
+        yield processing, total if block_given?
         gem_versions = versions.select { |v| v.first == gem_line.name }
         next if gem_versions.empty? # couldn't find version on RubyGems so go to next one
         version = find_latest_version(gem_versions)
         gem_line.spec = fetcher.fetch_spec([gem_line.name, version])
-        completed += 1
-        yield completed, total if block_given?
       end
     end
 

data/lib/grub/version.rb

@@ -1,4 +1,4 @@
 module Grub
-  VERSION = "0.0.6".freeze
+  VERSION = "0.0.7".freeze
   DESCRIPTION = "Add comments to your Gemfile with each dependency's description.".freeze
 end

data/test/grub/gem_line_test.rb

@@ -29,6 +29,11 @@ class Grub::GemLineTest < Minitest::Test
     refute gem_line.should_insert?
   end
 
+  def test_should_insert_with_no_spec
+    gem_line = create_gem_line
+    refute gem_line.should_insert?
+  end
+
   def test_should_insert_with_already_added_comment
     gem_line = create_gem_line(prev_line_comment: "# Hello world (http://example.com)\n")
     spec = stub(summary: "Hello world", homepage: "http://example.com")

data/test/grub/spec_finder_test.rb

@@ -44,7 +44,27 @@ class Grub::SpecFinderTest < Minitest::Test
     Grub::SpecFinder.expects(:find_latest_version).returns(Gem::Version.new("1")).twice
     Bundler::Fetcher.any_instance.expects(:fetch_spec).with(["1", Gem::Version.new("1")]).returns(spec_1)
     Bundler::Fetcher.any_instance.expects(:fetch_spec).with(["2", Gem::Version.new("1")]).returns(spec_2)
-    Grub::SpecFinder.fetch_specs_for([gem_line_1, gem_line_2])
+    yielded_values = []
+    Grub::SpecFinder.fetch_specs_for([gem_line_1, gem_line_2]) do |*args|
+      yielded_values << args
+    end
+    assert_equal [[0, 2], [1, 2], [2, 2]], yielded_values
+    $stdout = original_stdout
+  end
+
+  def test_fetch_unknown_specs
+    original_stdout = $stdout
+    $stdout = StringIO.new
+
+    gem_line_1 = mock
+    gem_line_1.stubs(name: "1")
+    gem_line_1.expects(:spec=).never
+
+    dependency_fetcher_mock = Bundler::Fetcher::Dependency.new(nil, nil, nil)
+    Bundler::Fetcher.any_instance.expects(:fetchers).returns([dependency_fetcher_mock])
+    dependency_fetcher_mock.expects(:dependency_specs).with(["1"]).returns([[], "dependencies here"])
+    Bundler::Fetcher.any_instance.expects(:fetch_spec).never
+    Grub::SpecFinder.fetch_specs_for([gem_line_1])
 
     $stdout = original_stdout
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grub
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ivan Tse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler