grub 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e00e745fa6f31b1d45dd4cec754330d5e8a00eb
-  data.tar.gz: 284f19215ccee5756bc2fec8dee10dd5dad01ac5
+  metadata.gz: 2b6fc103ca951a638cd8cdd8b2b2c72c72b11fc0
+  data.tar.gz: fc330005a4d6a3377745cc12797adc412e5c9a18
 SHA512:
-  metadata.gz: 3d043f4f9d76d84fec7d7a4063fe6fe81095721d0ae4b48aac92ea06ae01df7fb98eeb7757d041384f97a4af9792ce855fbfbd885efe26f93a1db50e2977f55e
-  data.tar.gz: be5d9fa170ef7e7899554fc8ac4f13dc8f4960f3c24091b3980b08094f7de5df47f84c466f7da1395a7297f08bbd4ecb3243a65dd560a655a5a93fdbfb5a5e47
+  metadata.gz: 74e8ff61ac7addb78f4ee5a7a7bd9eacbc6363c68a52acd1cb22e4fdf88b298e7c344e5d0e83522a288c704c1122cc4895c685fbab625cf59c5e85bb3719647a
+  data.tar.gz: 8e71525d5e2655aafda9264bcbdd77dc23f3333f39de35dd274f501d23dc94bbbe40873405030dd88d8a76f88331e24e77c21513f8703dc919f23f06e4482c53

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in grub.gemspec
 gemspec
+
+gem "pry"

data/Rakefile

@@ -1,2 +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/grub.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "bundler", "~> 1.7"
+  spec.add_runtime_dependency "bundler", "~> 1.7.4"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.1"
 end

data/lib/grub/gemfile.rb

@@ -16,7 +16,7 @@ module Grub
       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]
+          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],
@@ -31,7 +31,7 @@ module Grub
 
     def write_comments
       gem_lines.reverse.each do |gem_line|
-        source.insert(gem_line.location , gem_line.comment) if gem_line.should_insert?
+        source.insert(gem_line.location, gem_line.comment) if gem_line.should_insert?
       end
       File.write(gemfile_path, source.join)
     end
@@ -39,7 +39,7 @@ module Grub
     private
 
     def is_line_a_comment?(line)
-      line.strip.start_with?("#")
+      line && line.strip.start_with?("#")
     end
 
   end

data/lib/grub/spec_finder.rb

@@ -12,6 +12,7 @@ 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
         line.spec = matching_specs.first if matching_specs.any?
       end
     end

data/lib/grub/version.rb

@@ -1,4 +1,4 @@
 module Grub
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
   DESCRIPTION = "Add comments to your Gemfile with each dependency's description.".freeze
 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_grubbed

@@ -0,0 +1,43 @@
+source "https://rubygems.org"
+
+# Full-stack web application framework. (http://www.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/grub/cli_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+require "grub/cli"
+
+# Acts as integration test since it will actually fetch data from API
+class Grub::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
+        Grub::CLI.new.run_for_gemfile
+      end
+      assert_equal File.read(grubbed_gemfile_path), File.read(path)
+    end
+  end
+
+  def test_run_for_gem
+    out, _ = capture_io do
+      Grub::CLI.new.run_for_gem("grub")
+    end
+    assert_equal "Add comments to your Gemfile with each dependency's description. (https://github.com/ivantsepp/grub)\n", out
+  end
+end

data/test/grub/gem_line_test.rb

@@ -0,0 +1,76 @@
+require "test_helper"
+
+class Grub::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_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 = Grub::GemLine.new(
+      name: "grub",
+      original_line: "  \tgem 'grub'"
+    )
+    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 = {})
+    Grub::GemLine.new(
+      name: "grub",
+      original_line: "gem 'grub'",
+      **options
+    )
+  end
+
+end

data/test/grub/gemfile_test.rb

@@ -0,0 +1,71 @@
+require "test_helper"
+
+class Grub::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
+    Grub::GemLine.expects(:new).with(
+      name: "rails",
+      original_line: "gem \"rails\"\n",
+      location: 0,
+      prev_line_comment: nil,
+      options: {}
+    ).once
+    Grub::GemLine.expects(:new).with(
+      name: "grub",
+      original_line: "gem \"grub\"\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 "grub"
+      # gem "commented_out"
+    GEMFILE
+    assert_equal 2, gemfile.gem_lines.length
+  end
+
+  def test_write_comments
+    with_gemfile("gem 'rails'") do |path|
+      gemfile = Grub::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
+    Grub::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 = Grub::Gemfile.new(path, options)
+      gemfile.parse
+    end
+    gemfile
+  end
+
+end

data/test/grub/spec_finder_test.rb

@@ -0,0 +1,57 @@
+require "test_helper"
+
+class Grub::SpecFinderTest < Minitest::Test
+  def test_find_specs_for
+    gem_line_1 = mock(spec: nil)
+    gem_line_2 = mock(spec: "spec")
+    Grub::SpecFinder.expects(:find_matching_specs_for).with([gem_line_1, gem_line_2])
+    Grub::SpecFinder.expects(:fetch_specs_for).with([gem_line_1])
+    Grub::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]))
+    Grub::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)
+
+    Bundler::Fetcher.any_instance.expects(:fetch_dependency_remote_specs).with(["1", "2"]).returns([[
+      ["1", Gem::Version.new("1")],
+      ["2", Gem::Version.new("1")],
+    ], "dependencies here"])
+    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])
+
+    $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"), Grub::SpecFinder.find_latest_version(versions)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require "minitest/autorun"
+require "mocha/mini_test"
+require "grub"
+
+module TestHelpers
+
+  def gemfile_path
+    File.join(File.dirname(__FILE__), "fixtures", "Gemfile")
+  end
+
+  def grubbed_gemfile_path
+    File.join(File.dirname(__FILE__), "fixtures", "Gemfile_grubbed")
+  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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ivan Tse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.7.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.7.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !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:
@@ -61,6 +89,13 @@ files:
 - lib/grub/options.rb
 - lib/grub/spec_finder.rb
 - lib/grub/version.rb
+- test/fixtures/Gemfile
+- test/fixtures/Gemfile_grubbed
+- test/grub/cli_test.rb
+- test/grub/gem_line_test.rb
+- test/grub/gemfile_test.rb
+- test/grub/spec_finder_test.rb
+- test/test_helper.rb
 homepage: https://github.com/ivantsepp/grub
 licenses:
 - MIT
@@ -85,4 +120,11 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Add comments to your Gemfile with each dependency's description.
-test_files: []
+test_files:
+- test/fixtures/Gemfile
+- test/fixtures/Gemfile_grubbed
+- test/grub/cli_test.rb
+- test/grub/gem_line_test.rb
+- test/grub/gemfile_test.rb
+- test/grub/spec_finder_test.rb
+- test/test_helper.rb