grub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40e937ffd04fdb2cf67a2c9fc765a402e54142df
+  data.tar.gz: 4eba708a3e8b9784a9772db961b9310a302cc692
+SHA512:
+  metadata.gz: f4043ba1b3ac1b489331bed1325011bcfe68333461b52f1819174781bb43ae68801c3b85ec35e6217fdc320fc3dd6d7b3dd624f0c733daaa6ace66ae9f1bdada
+  data.tar.gz: cca141c3cd9efeab215408db737a827664ada4e456877b7d6a8cd8bc197fd3fec1e2a1752076412900b3383f297d6c6ebdc252755da2159aa6b9c76281a7b4b6

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grub.gemspec
+gemspec

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,31 @@
+# Grub
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grub'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grub
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/grub

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

data/grub.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grub"
+  spec.version       = Grub::VERSION
+  spec.authors       = ["Ivan Tse"]
+  spec.email         = ["ivan.tse1@gmail.com"]
+  spec.summary       = %q{Add comments to your Gemfile with each dependency's 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/grub"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/grub.rb

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

data/lib/grub/cli.rb

@@ -0,0 +1,13 @@
+module Grub
+  class CLI
+    def run(*args)
+      Bundler.configure
+      gemfile = Gemfile.new
+      gemfile.parse
+      unless gemfile.gem_lines.empty?
+        SpecFinder.new(gemfile.gem_lines).find_specs
+        gemfile.write_comments
+      end
+    end
+  end
+end

data/lib/grub/gem_line.rb

@@ -0,0 +1,35 @@
+module Grub
+  class GemLine
+
+    attr_accessor :original_line, :location, :prev_line_comment, :name, :spec
+
+    def initialize(name:, original_line:, location:, prev_line_comment: nil)
+      @name = name
+      @original_line = original_line
+      @location = location
+      @prev_line_comment = prev_line_comment
+    end
+
+    def comment
+      leading_spaces_count = original_line.length - original_line.lstrip.length
+      leading_spaces = original_line[0..leading_spaces_count - 1] if leading_spaces_count > 0
+      comment = "# #{description}"
+      comment << " (#{website})" unless website.nil? || website.empty?
+      comment << "\n"
+      "#{leading_spaces}#{comment}"
+    end
+
+    def should_insert?
+      prev_line_comment.nil? || !prev_line_comment.include?(comment)
+    end
+
+    def description
+      spec.summary if spec
+    end
+
+    def website
+      spec.homepage if spec
+    end
+
+  end
+end

data/lib/grub/gemfile.rb

@@ -0,0 +1,36 @@
+module Grub
+  class Gemfile
+
+    GEM_LINE_REGEX = /\A\s*gem[\s(]+["']([^'"]*)["']/.freeze
+
+    attr_accessor :gemfile_path, :gem_lines, :source
+
+    def initialize(gemfile_path = Bundler.default_gemfile)
+      @gemfile_path = gemfile_path
+      @source = []
+      @gem_lines = []
+    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_comment = source[i - 1].strip.start_with?("#") ? source[i - 1] : nil
+          self.gem_lines << GemLine.new(
+            name: match[1],
+            original_line: line,
+            location: i,
+            prev_line_comment: prev_line_comment
+          )
+        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
+  end
+end

data/lib/grub/spec_finder.rb

@@ -0,0 +1,32 @@
+module Grub
+  class SpecFinder
+
+    attr_reader :gem_lines
+
+    def initialize(gem_lines)
+      @gem_lines = gem_lines
+    end
+
+    def find_specs
+      gem_lines.each do |line|
+        matching_specs = Gem::Dependency.new(line.name).matching_specs
+        line.spec = matching_specs.first if matching_specs.any?
+      end
+
+      gems_to_fetch = gem_lines.select { |gem_line| gem_line.spec.nil? }
+
+      if gems_to_fetch.any?
+        fetcher = Bundler::Fetcher.new(Gem.sources.first.uri)
+        versions, _ = fetcher.send(:fetch_dependency_remote_specs, gems_to_fetch.collect(&:name))
+        gems_to_fetch.each do |gem_line|
+          print "."
+          version = versions.find{ |v| v.first == gem_line.name }[1]
+          spec = fetcher.fetch_spec([gem_line.name, version])
+          gem_line.spec = spec
+        end
+        print "\n"
+      end
+    end
+
+  end
+end

data/lib/grub/version.rb

@@ -0,0 +1,3 @@
+module Grub
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: grub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivan Tse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+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:
+- grub
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/grub
+- grub.gemspec
+- lib/grub.rb
+- lib/grub/cli.rb
+- lib/grub/gem_line.rb
+- lib/grub/gemfile.rb
+- lib/grub/spec_finder.rb
+- lib/grub/version.rb
+homepage: https://github.com/ivantsepp/grub
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Add comments to your Gemfile with each dependency's description.
+test_files: []