annotate_gem 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e0ee9922534ca6c7e763fd617f8e81a461ff4e1
+  data.tar.gz: d60f74fff3ca5131bd5beacbc7729435a973ab01
+SHA512:
+  metadata.gz: 3323eb1ba24e40ca46fb3f75c4ccb72ead72c4c9279fcebe841ee24b7de4eb51af7aa0fd3dd162d2367da6f6e3ea74aabb5c2748bf41cecff5e8d3a92b2c166c
+  data.tar.gz: cbb7b96c3789ff8123299bc315742c727521b1f9eee40abf53c9f3078a4b1033b3ca19e9ae16e9820093cb8fc901c3694448bea26207293df302dc830c9a40ad

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor

data/Gemfile

@@ -0,0 +1,7 @@
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Ivan Tse
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# AnnotateGem
+
+`annotate_gem` is command line tool that will add useful comments to your Gemfile. For each gem, `annotate_gem` will create a comment with the gem's description and the gem's website. For example, a Gemfile containing the following
+
+```ruby
+gem "rails"
+gem "nokogiri"
+gem "brakeman"
+```
+
+will be converted into something that is more descriptive and is self-documenting:
+
+```ruby
+# 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"
+```
+
+The motivation for `annotate_gem` 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.
+
+If you do _not_ want to install the gem, you can also visit <https://annotate_gem.herokuapp.com/> which is a web interface for `annotate_gem`.
+
+## Installation
+
+```
+$ gem install annotate_gem
+```
+
+## Usage
+
+Running `annotate_gem` itself will add comments to the current directory's `Gemfile`.
+
+```
+$ cat Gemfile
+source 'https://rubygems.org'
+gem "pry"
+$ annotate_gem
+$ cat Gemfile
+source 'https://rubygems.org'
+# An IRB alternative and runtime developer console (http://pryrepl.org)
+gem "pry"
+```
+
+`annotate_gem` has several options and you can see them via `annotate_gem -h`. `annotate_gem` also works with specifying a single gem name:
+
+```
+$ annotate_gem aasm
+State machine mixin for Ruby objects (https://github.com/aasm/aasm)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ivantsepp/annotate_gem/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*test.rb']
+  t.verbose = true
+end

data/annotate_gem.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'annotate_gem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "annotate_gem"
+  spec.version       = AnnotateGem::VERSION
+  spec.authors       = ["Ivan Tse"]
+  spec.email         = ["ivan.tse1@gmail.com"]
+  spec.summary       = AnnotateGem::DESCRIPTION
+  spec.description   = <<-DESCRIPTION.gsub(/^\s+/, "").gsub(/\n/, " ")
+                        Clarify your dependencies by adding a detailed comment to each line in Gemfile specifying the
+                        gem's summary and its website if any.
+                       DESCRIPTION
+  spec.homepage      = "https://github.com/ivantsepp/annotate_gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "bundler", "~> 1.11.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.1"
+end

data/bin/annotate_gem

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+
+require "annotate_gem/cli"
+require "annotate_gem"
+
+AnnotateGem::CLI.new.run(ARGV)

data/lib/annotate_gem.rb

@@ -0,0 +1,8 @@
+require "annotate_gem/version"
+require "bundler"
+require "annotate_gem/gem_line"
+require "annotate_gem/gemfile"
+require "annotate_gem/spec_finder"
+
+module AnnotateGem
+end

data/lib/annotate_gem/cli.rb

@@ -0,0 +1,41 @@
+require "annotate_gem/options"
+
+module AnnotateGem
+  class CLI
+    def run(args)
+      options = Options.new.parse!(args)
+      if args.empty?
+        run_for_gemfile(options)
+      else
+        run_for_gem(args.pop, options)
+      end
+    end
+
+    def run_for_gemfile(options = {})
+      Bundler.configure
+      gemfile = Gemfile.new(Bundler.default_gemfile, options)
+      gemfile.parse
+      unless gemfile.gem_lines.empty?
+        SpecFinder.find_specs_for(gemfile.gem_lines, &self.method(:print_progress))
+        gemfile.write_comments
+      end
+    end
+
+    def run_for_gem(gem_name, options = {})
+      gem_line = GemLine.new(name: gem_name, options: options)
+      SpecFinder.find_specs_for(gem_line, &self.method(:print_progress))
+
+      info = gem_line.info
+      info = "No information to show" if info.strip.empty?
+      puts info
+    end
+
+    private
+
+    def print_progress(processing, total)
+      print "Fetching gem metadata..." if processing.zero?
+      print "."
+      print "\n" if processing == total
+    end
+  end
+end

data/lib/annotate_gem/gem_line.rb

@@ -0,0 +1,65 @@
+module AnnotateGem
+  class GemLine
+
+    attr_accessor :name, :original_line, :location, :prev_line_comment, :spec, :options
+
+    def initialize(*args)
+      named_params = args.last.respond_to?(:[]) && args.last
+      @name = (named_params && named_params[:name]) || args[0]
+      @original_line = (named_params && named_params[:original_line]) || args[1]
+      @location = (named_params && named_params[:location]) || args[2]
+      @prev_line_comment = (named_params && named_params[:prev_line_comment]) || args[3]
+      @options = (named_params && named_params[:options]) || named_params
+    end
+
+    def comment
+      leading_spaces = original_line[0..leading_spaces_count - 1] if leading_spaces_count > 0
+      comment = "#{leading_spaces}# #{info}"
+    end
+
+    def info
+      output = if options[:website_only]
+        website
+      elsif options[:description_only]
+        description
+      else
+        description_and_website
+      end
+      output << "\n"
+    end
+
+    def should_insert?
+      !info.strip.empty? && !already_added_comment && !existing_comment_option
+    end
+
+    private
+
+    def already_added_comment
+      prev_line_comment && prev_line_comment.include?(comment)
+    end
+
+    # if there exists a prev_line_comment and the user has specified new_comments_only
+    def existing_comment_option
+      prev_line_comment && options[:new_comments_only]
+    end
+
+    def leading_spaces_count
+      original_line.length - original_line.lstrip.length
+    end
+
+    def description
+      "#{spec.summary}" if spec
+    end
+
+    def website
+      "#{spec.homepage.to_s}" if spec
+    end
+
+    def description_and_website
+      output = "#{description}"
+      output << " (#{website})" unless website.nil? || website.empty?
+      output
+    end
+
+  end
+end

data/lib/annotate_gem/gemfile.rb

@@ -0,0 +1,46 @@
+module AnnotateGem
+  class Gemfile
+
+    GEM_LINE_REGEX = /\A\s*gem[\s(]+["'](?<name>[^'"]*)["']/.freeze
+
+    attr_accessor :gemfile_path, :gem_lines, :source, :options
+
+    def initialize(gemfile_path, options = {})
+      @gemfile_path = gemfile_path
+      @source = []
+      @gem_lines = []
+      @options = options
+    end
+
+    def parse
+      self.source = File.readlines(gemfile_path)
+      source.each_with_index do |line, i|
+        if match = GEM_LINE_REGEX.match(line)
+          prev_line = source[i - 1] if i > 0
+          prev_line_comment = prev_line if is_line_a_comment?(prev_line)
+          self.gem_lines << GemLine.new(
+            name: match[:name],
+            original_line: line,
+            location: i,
+            prev_line_comment: prev_line_comment,
+            options: options
+          )
+        end
+      end
+    end
+
+    def write_comments
+      gem_lines.reverse.each do |gem_line|
+        source.insert(gem_line.location, gem_line.comment) if gem_line.should_insert?
+      end
+      File.write(gemfile_path, source.join)
+    end
+
+    private
+
+    def is_line_a_comment?(line)
+      line && line.strip.start_with?("#")
+    end
+
+  end
+end

data/lib/annotate_gem/options.rb

@@ -0,0 +1,66 @@
+require "optparse"
+
+module AnnotateGem
+  class Options
+
+    attr_accessor :options, :options_parser
+
+    def initialize
+      @options = {}
+      @options_parser = OptionParser.new do |opts|
+        add_banner(opts)
+        add_tail_options(opts)
+        add_info_options(opts)
+        add_gemfile_comment_options(opts)
+      end
+    end
+
+    def parse!(args)
+      options_parser.parse!(args)
+      validate_options
+      options
+    end
+
+    private
+
+    def validate_options
+      info_flags = options[:website_only] && options[:description_only]
+      raise ArgumentError, "Cannot set both --website-only and --description-only flags" if info_flags
+    end
+
+    def add_info_options(opts)
+      opts.on("--website-only", "Only output the website") do
+        options[:website_only] = true
+      end
+      opts.on("--description-only", "Only output the description") do
+        options[:description_only] = true
+      end
+    end
+
+    def add_gemfile_comment_options(opts)
+      opts.on("--new-comments-only", "Only add a comment to gemfile if there isn't a comment already") do
+        options[:new_comments_only] = true
+      end
+    end
+
+    def add_banner(opts)
+      opts.banner = <<-BANNER.gsub(/\A\s{8}/, '')
+        #{AnnotateGem::DESCRIPTION}
+        Usage: #{opts.program_name} [options]
+               #{opts.program_name} [gem name]
+      BANNER
+    end
+
+    def add_tail_options(opts)
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+      opts.on_tail("-v", "--version", "Show version") do
+        puts AnnotateGem::VERSION
+        exit
+      end
+    end
+
+  end
+end

data/lib/annotate_gem/spec_finder.rb

@@ -0,0 +1,43 @@
+module AnnotateGem
+  module SpecFinder
+    extend self
+
+    def find_specs_for(gem_lines, &block)
+      gem_lines = Array(gem_lines)
+      find_matching_specs_for(gem_lines)
+      gems_to_fetch = gem_lines.select { |gem_line| gem_line.spec.nil? }
+      fetch_specs_for(gems_to_fetch, &block) if gems_to_fetch.any?
+    end
+
+    def find_matching_specs_for(gem_lines)
+      gem_lines.each do |line|
+        matching_specs = Gem::Dependency.new(line.name).matching_specs
+        # 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
+      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])
+      end
+    end
+
+    def find_latest_version(versions)
+       versions.sort_by { |v| v[1] }.last[1]
+    end
+  end
+end

data/lib/annotate_gem/version.rb

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

data/test/annotate_gem/cli_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+require "annotate_gem/cli"
+
+# Acts as integration test since it will actually fetch data from API
+class AnnotateGem::CLITest < Minitest::Test
+
+  def test_run_for_gemfile
+    with_gemfile(File.read(gemfile_path)) do |path|
+      Bundler.expects(:default_gemfile).returns(path)
+      out, _ = capture_io do
+        AnnotateGem::CLI.new.run_for_gemfile
+      end
+      assert_equal File.read(annotated_gemfile_path), File.read(path)
+    end
+  end
+
+  def test_run_for_gem
+    out, _ = capture_io do
+      AnnotateGem::CLI.new.run_for_gem("annotate_gem")
+    end
+    assert_equal "Add comments to your Gemfile with each dependency's description. (https://github.com/ivantsepp/annotate_gem)\n", out
+  end
+end

data/test/annotate_gem/gem_line_test.rb

@@ -0,0 +1,79 @@
+require "test_helper"
+
+class AnnotateGem::GemLineTest < Minitest::Test
+
+  def test_info
+    gem_line = create_gem_line
+    spec = stub(summary: "Hello world", homepage: "http://example.com")
+    gem_line.spec = spec
+    assert_equal "Hello world (http://example.com)\n", gem_line.info
+  end
+
+  def test_info_with_website_only
+    gem_line =  create_gem_line(options: { website_only: true })
+    spec = stub(summary: "Hello world", homepage: "http://example.com")
+    gem_line.spec = spec
+    assert_equal "http://example.com\n", gem_line.info
+  end
+
+  def test_info_with_description_only
+    gem_line = create_gem_line(options: { description_only: true })
+    spec = stub(summary: "Hello world", homepage: "http://example.com")
+    gem_line.spec = spec
+    assert_equal "Hello world\n", gem_line.info
+  end
+
+  def test_should_insert_with_no_info
+    gem_line = create_gem_line
+    gem_line.expects(:info).returns("")
+    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")
+    gem_line.spec = spec
+    refute gem_line.should_insert?
+  end
+
+  def test_should_insert_with_new_comments_only
+    gem_line = create_gem_line(
+      prev_line_comment: "# This is an existing comment\n",
+      options: { new_comments_only: true }
+    )
+    spec = stub(summary: "Hello world", homepage: "http://example.com")
+    gem_line.spec = spec
+    refute gem_line.should_insert?
+  end
+
+  def test_comment
+    gem_line = create_gem_line
+    spec = stub(summary: "Hello world", homepage: "http://example.com")
+    gem_line.spec = spec
+    assert_equal "# Hello world (http://example.com)\n", gem_line.comment
+  end
+
+  def test_comment_with_indentation_in_original_line
+    gem_line = AnnotateGem::GemLine.new(
+      name: "annotate_gem",
+      original_line: "  \tgem 'annotate_gem'"
+    )
+    spec = stub(summary: "Hello world", homepage: "http://example.com")
+    gem_line.spec = spec
+    assert_equal "  \t# Hello world (http://example.com)\n", gem_line.comment
+  end
+
+  private
+
+  def create_gem_line(options = {})
+    AnnotateGem::GemLine.new(
+      { name: "annotate_gem", original_line: "gem 'annotate_gem'" }.merge(options)
+    )
+  end
+
+end

data/test/annotate_gem/gemfile_test.rb

@@ -0,0 +1,71 @@
+require "test_helper"
+
+class AnnotateGem::GemfileTest < Minitest::Test
+
+  def test_parses_source
+    gemfile = gemfile_for(unindent(<<-GEMFILE))
+      hello
+      world!
+    GEMFILE
+    assert 2, gemfile.source.length
+    assert_equal "hello\n", gemfile.source.first
+    assert_equal "world!\n", gemfile.source.last
+  end
+
+  def test_parses_gem_lines
+    AnnotateGem::GemLine.expects(:new).with(
+      name: "rails",
+      original_line: "gem \"rails\"\n",
+      location: 0,
+      prev_line_comment: nil,
+      options: {}
+    ).once
+    AnnotateGem::GemLine.expects(:new).with(
+      name: "annotate_gem",
+      original_line: "gem \"annotate_gem\"\n",
+      location: 2,
+      prev_line_comment: "# this gem has a comment\n",
+      options: {}
+    ).once
+    gemfile = gemfile_for(unindent(<<-GEMFILE))
+      gem "rails"
+      # this gem has a comment
+      gem "annotate_gem"
+      # gem "commented_out"
+    GEMFILE
+    assert_equal 2, gemfile.gem_lines.length
+  end
+
+  def test_write_comments
+    with_gemfile("gem 'rails'") do |path|
+      gemfile = AnnotateGem::Gemfile.new(path)
+      gemfile.gem_lines = [mock(location: 0, comment: "Rails description!\n", should_insert?: true)]
+      gemfile.source = ["gem 'rails'"]
+      gemfile.write_comments
+      assert_equal "Rails description!\ngem 'rails'", File.read(path)
+    end
+  end
+
+  def test_that_options_are_passed_through
+    AnnotateGem::GemLine.expects(:new).with(
+      name: "rails",
+      original_line: "gem 'rails'",
+      location: 0,
+      prev_line_comment: nil,
+      options: { description_only: true }
+    ).once
+    gemfile = gemfile_for("gem 'rails'", description_only: true)
+  end
+
+  private
+
+  def gemfile_for(content, options = {})
+    gemfile = nil
+    with_gemfile(content) do |path|
+      gemfile = AnnotateGem::Gemfile.new(path, options)
+      gemfile.parse
+    end
+    gemfile
+  end
+
+end

data/test/annotate_gem/spec_finder_test.rb

@@ -0,0 +1,79 @@
+require "test_helper"
+
+class AnnotateGem::SpecFinderTest < Minitest::Test
+  def test_find_specs_for
+    gem_line_1 = mock(spec: nil)
+    gem_line_2 = mock(spec: "spec")
+    AnnotateGem::SpecFinder.expects(:find_matching_specs_for).with([gem_line_1, gem_line_2])
+    AnnotateGem::SpecFinder.expects(:fetch_specs_for).with([gem_line_1])
+    AnnotateGem::SpecFinder.find_specs_for([gem_line_1, gem_line_2])
+  end
+
+  def test_find_matching_specs_for
+    spec_1 = mock
+    gem_line_1 = mock(name: "1")
+    gem_line_1.expects(:spec=).with(spec_1)
+    spec_2 = mock
+    gem_line_2 = mock(name: "2")
+    gem_line_2.expects(:spec=).with(spec_2)
+    gem_lines = [gem_line_1, gem_line_2]
+    Gem::Dependency.expects(:new).with("1").returns(mock(matching_specs: [spec_1]))
+    Gem::Dependency.expects(:new).with("2").returns(mock(matching_specs: [spec_2]))
+    AnnotateGem::SpecFinder.find_matching_specs_for(gem_lines)
+  end
+
+  def test_fetch_specs_for
+    original_stdout = $stdout
+    $stdout = StringIO.new
+
+    spec_1 = mock
+    gem_line_1 = mock
+    gem_line_1.stubs(name: "1")
+    gem_line_1.expects(:spec=).with(spec_1)
+    spec_2 = mock
+    gem_line_2 = mock
+    gem_line_2.stubs(name: "2")
+    gem_line_2.expects(:spec=).with(spec_2)
+
+    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", "2"]).returns([[
+      ["1", Gem::Version.new("1")],
+      ["2", Gem::Version.new("1")],
+    ], "dependencies here"])
+    AnnotateGem::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)
+    yielded_values = []
+    AnnotateGem::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
+    AnnotateGem::SpecFinder.fetch_specs_for([gem_line_1])
+
+    $stdout = original_stdout
+  end
+
+  def test_find_latest_version
+    versions = [
+      ["rails", Gem::Version.new("2.3.5")],
+      ["rails", Gem::Version.new("4")]
+    ]
+    assert_equal Gem::Version.new("4"), AnnotateGem::SpecFinder.find_latest_version(versions)
+  end
+end

data/test/fixtures/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+
+gem 'rails', '4.2.1'
+gem 'sqlite3'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.1.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+gem 'jquery-rails'
+gem 'turbolinks'
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  gem 'byebug'
+  gem 'web-console', '~> 2.0'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+end

data/test/fixtures/Gemfile_annotated

@@ -0,0 +1,43 @@
+source "https://rubygems.org"
+
+# Full-stack web application framework. (http://rubyonrails.org)
+gem 'rails', '4.2.1'
+# This module allows Ruby programs to interface with the SQLite3 database engine (http://www.sqlite.org) (https://github.com/sparklemotion/sqlite3-ruby)
+gem 'sqlite3'
+# Sass adapter for the Rails asset pipeline. (https://github.com/rails/sass-rails)
+gem 'sass-rails', '~> 5.0'
+# Ruby wrapper for UglifyJS JavaScript compressor (http://github.com/lautis/uglifier)
+gem 'uglifier', '>= 1.3.0'
+# CoffeeScript adapter for the Rails asset pipeline. (https://github.com/rails/coffee-rails)
+gem 'coffee-rails', '~> 4.1.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jQuery with Rails 4+ (http://rubygems.org/gems/jquery-rails)
+gem 'jquery-rails'
+# Turbolinks makes navigating your web application faster (https://github.com/turbolinks/turbolinks-rails)
+gem 'turbolinks'
+# Create JSON structures via a Builder-style DSL (https://github.com/rails/jbuilder)
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+# rdoc html with javascript search index. (http://github.com/voloko/sdoc)
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Ruby 2.0 fast debugger - base + CLI (http://github.com/deivid-rodriguez/byebug)
+  gem 'byebug'
+  # A debugging tool for your Ruby on Rails applications. (https://github.com/rails/web-console)
+  gem 'web-console', '~> 2.0'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  # Rails application preloader (https://github.com/rails/spring)
+  gem 'spring'
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require "minitest/autorun"
+require "mocha/mini_test"
+require "annotate_gem"
+
+module TestHelpers
+
+  def gemfile_path
+    File.join(File.dirname(__FILE__), "fixtures", "Gemfile")
+  end
+
+  def annotated_gemfile_path
+    File.join(File.dirname(__FILE__), "fixtures", "Gemfile_annotated")
+  end
+
+  def with_gemfile(content)
+    file = Tempfile.new('gemfile')
+    file.write(content)
+    file.close
+    yield(file.path)
+    file.unlink
+  end
+
+  def unindent(str)
+    str.gsub(/^#{str.scan(/^[ ]+(?=\S)/).min}/, "")
+  end
+
+end
+
+class Minitest::Test
+  include TestHelpers
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: annotate_gem
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Ivan Tse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 'Clarify your dependencies by adding a detailed comment to each line
+  in Gemfile specifying the gem''s summary and its website if any. '
+email:
+- ivan.tse1@gmail.com
+executables:
+- annotate_gem
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- annotate_gem.gemspec
+- bin/annotate_gem
+- lib/annotate_gem.rb
+- lib/annotate_gem/cli.rb
+- lib/annotate_gem/gem_line.rb
+- lib/annotate_gem/gemfile.rb
+- lib/annotate_gem/options.rb
+- lib/annotate_gem/spec_finder.rb
+- lib/annotate_gem/version.rb
+- test/annotate_gem/cli_test.rb
+- test/annotate_gem/gem_line_test.rb
+- test/annotate_gem/gemfile_test.rb
+- test/annotate_gem/spec_finder_test.rb
+- test/fixtures/Gemfile
+- test/fixtures/Gemfile_annotated
+- test/test_helper.rb
+homepage: https://github.com/ivantsepp/annotate_gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Add comments to your Gemfile with each dependency's description.
+test_files:
+- test/annotate_gem/cli_test.rb
+- test/annotate_gem/gem_line_test.rb
+- test/annotate_gem/gemfile_test.rb
+- test/annotate_gem/spec_finder_test.rb
+- test/fixtures/Gemfile
+- test/fixtures/Gemfile_annotated
+- test/test_helper.rb