grub 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 306499cfdaa4d796bba7cfcb5104912e73db4601
-  data.tar.gz: a7ba997f3eaba6b7339625e2f8b34fe16fcedc4d
+  metadata.gz: 7c7a1f210bf90d85627851cf147ba42e702ad20b
+  data.tar.gz: a3ba8f5768e9e296da9b2009e2dd6fc4d2ae75fa
 SHA512:
-  metadata.gz: e67ad918f019680c8adf272258be4cf2d6188ca07481192a0d49db465295fe9fcb0ea3c0cb6c3aaf171722dd616e95d0d4b2ce5e4e37f4b41d6c6271fb15b8e8
-  data.tar.gz: 20b025bdd744295afebb01347d92881a72155d340e839a0fb73b99f8e4dd48e4f3048ea11da7e98b1290f5dd33eac94ad2763180de72f54e17a8df9fede16c9a
+  metadata.gz: 007a117427640980f7d9c90bea70ba8bb0ff51edf3302dad429aed87255d75dddae51a1d40f1b4765c1707862539fd7dc4cc500654a75c0d8889244f046bbc40
+  data.tar.gz: 0bd248d1b8a94cc4afe7b49a9e1ad42d841befdff0147359be11bec2d647ea42820f800a50587abf1087bcbedc44de6d53f37a1f88e65b754ebc2bbf8237596f

data/README.md

@@ -1,66 +1 @@
-# Grub
-
-`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
-
-```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 `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.
-
-## Installation
-
-```
-$ gem install grub
-```
-
-## Usage
-
-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/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`)
-5. Create a new Pull Request
+This project has moved to https://github.com/ivantsepp/annotate_gem!

data/bin/grub

@@ -5,4 +5,5 @@ $:.unshift(File.join(File.dirname(__FILE__), "../lib"))
 require "grub/cli"
 require "grub"
 
+warn "This project has been renamed to annotate_gem. Please see https://github.com/ivantsepp/annotate_gem and https://rubygems.org/gems/annotate_gem"
 Grub::CLI.new.run(ARGV)

data/grub.gemspec

@@ -10,12 +10,17 @@ Gem::Specification.new do |spec|
   spec.email         = ["ivan.tse1@gmail.com"]
   spec.summary       = Grub::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.
+                        This project has been renamed to annotate_gem. Please go to https://rubygems.org/gems/annotate_gem.
                        DESCRIPTION
-  spec.homepage      = "https://github.com/ivantsepp/grub"
+  spec.homepage      = "https://github.com/ivantsepp/annotate_gem"
   spec.license       = "MIT"
 
+  spec.post_install_message = <<-MESSAGE
+  !    The 'grub' gem has been deprecated and has been replaced by 'annotate_gem'.
+  !    See: https://rubygems.org/gems/annotate_gem
+  !    And: https://github.com/ivantsepp/annotate_gem
+  MESSAGE
+
   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)/})

data/lib/grub/gem_line.rb

@@ -3,12 +3,13 @@ module Grub
 
     attr_accessor :name, :original_line, :location, :prev_line_comment, :spec, :options
 
-    def initialize(name:, original_line: nil, location: nil, prev_line_comment: nil, options: {})
-      @name = name
-      @original_line = original_line
-      @location = location
-      @prev_line_comment = prev_line_comment
-      @options = 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

data/lib/grub/version.rb

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

data/test/fixtures/Gemfile_grubbed

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-# Full-stack web application framework. (http://www.rubyonrails.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'

data/test/grub/gem_line_test.rb

@@ -72,9 +72,7 @@ class Grub::GemLineTest < Minitest::Test
 
   def create_gem_line(options = {})
     Grub::GemLine.new(
-      name: "grub",
-      original_line: "gem 'grub'",
-      **options
+      { name: "grub", original_line: "gem 'grub'" }.merge(options)
     )
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grub
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Ivan Tse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,8 +66,7 @@ dependencies:
     - - "~>"
       - !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. '
+description: 'This project has been renamed to annotate_gem. Please go to https://rubygems.org/gems/annotate_gem. '
 email:
 - ivan.tse1@gmail.com
 executables:
@@ -96,11 +95,14 @@ files:
 - test/grub/gemfile_test.rb
 - test/grub/spec_finder_test.rb
 - test/test_helper.rb
-homepage: https://github.com/ivantsepp/grub
+homepage: https://github.com/ivantsepp/annotate_gem
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+    !    The 'grub' gem has been deprecated and has been replaced by 'annotate_gem'.
+    !    See: https://rubygems.org/gems/annotate_gem
+    !    And: https://github.com/ivantsepp/annotate_gem
 rdoc_options: []
 require_paths:
 - lib