grub 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e937ffd04fdb2cf67a2c9fc765a402e54142df
-  data.tar.gz: 4eba708a3e8b9784a9772db961b9310a302cc692
+  metadata.gz: 2e00e745fa6f31b1d45dd4cec754330d5e8a00eb
+  data.tar.gz: 284f19215ccee5756bc2fec8dee10dd5dad01ac5
 SHA512:
-  metadata.gz: f4043ba1b3ac1b489331bed1325011bcfe68333461b52f1819174781bb43ae68801c3b85ec35e6217fdc320fc3dd6d7b3dd624f0c733daaa6ace66ae9f1bdada
-  data.tar.gz: cca141c3cd9efeab215408db737a827664ada4e456877b7d6a8cd8bc197fd3fec1e2a1752076412900b3383f297d6c6ebdc252755da2159aa6b9c76281a7b4b6
+  metadata.gz: 3d043f4f9d76d84fec7d7a4063fe6fe81095721d0ae4b48aac92ea06ae01df7fb98eeb7757d041384f97a4af9792ce855fbfbd885efe26f93a1db50e2977f55e
+  data.tar.gz: be5d9fa170ef7e7899554fc8ac4f13dc8f4960f3c24091b3980b08094f7de5df47f84c466f7da1395a7297f08bbd4ecb3243a65dd560a655a5a93fdbfb5a5e47

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+vendor

data/grub.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   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.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.

data/lib/grub/cli.rb

@@ -1,13 +1,32 @@
+require "grub/options"
+
 module Grub
   class CLI
-    def run(*args)
+    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
+      gemfile = Gemfile.new(Bundler.default_gemfile, options)
       gemfile.parse
       unless gemfile.gem_lines.empty?
-        SpecFinder.new(gemfile.gem_lines).find_specs
+        SpecFinder.find_specs_for(gemfile.gem_lines)
         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)
+      info = gem_line.info
+      info = "No information to show" if info.strip.empty?
+      puts info
+    end
   end
 end

data/lib/grub/gem_line.rb

@@ -1,34 +1,63 @@
 module Grub
   class GemLine
 
-    attr_accessor :original_line, :location, :prev_line_comment, :name, :spec
+    attr_accessor :name, :original_line, :location, :prev_line_comment, :spec, :options
 
-    def initialize(name:, original_line:, location:, prev_line_comment: nil)
+    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
     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}"
+      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?
-      prev_line_comment.nil? || !prev_line_comment.include?(comment)
+      !info.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
+      "#{spec.summary}" if spec
     end
 
     def website
-      spec.homepage if spec
+      "#{spec.homepage.to_s}" if spec
+    end
+
+    def description_and_website
+      output = "#{description}"
+      output << " (#{website})" unless website.empty?
+      output
     end
 
   end

data/lib/grub/gemfile.rb

@@ -1,26 +1,29 @@
 module Grub
   class Gemfile
 
-    GEM_LINE_REGEX = /\A\s*gem[\s(]+["']([^'"]*)["']/.freeze
+    GEM_LINE_REGEX = /\A\s*gem[\s(]+["'](?<name>[^'"]*)["']/.freeze
 
-    attr_accessor :gemfile_path, :gem_lines, :source
+    attr_accessor :gemfile_path, :gem_lines, :source, :options
 
-    def initialize(gemfile_path = Bundler.default_gemfile)
+    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_comment = source[i - 1].strip.start_with?("#") ? source[i - 1] : nil
+        if match = GEM_LINE_REGEX.match(line)
+          prev_line = source[i - 1]
+          prev_line_comment = prev_line if is_line_a_comment?(prev_line)
           self.gem_lines << GemLine.new(
-            name: match[1],
+            name: match[:name],
             original_line: line,
             location: i,
-            prev_line_comment: prev_line_comment
+            prev_line_comment: prev_line_comment,
+            options: options
           )
         end
       end
@@ -32,5 +35,12 @@ module Grub
       end
       File.write(gemfile_path, source.join)
     end
+
+    private
+
+    def is_line_a_comment?(line)
+      line.strip.start_with?("#")
+    end
+
   end
 end

data/lib/grub/options.rb

@@ -0,0 +1,66 @@
+require "optparse"
+
+module Grub
+  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}/, '')
+        #{Grub::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 Grub::VERSION
+        exit
+      end
+    end
+
+  end
+end

data/lib/grub/spec_finder.rb

@@ -1,32 +1,36 @@
 module Grub
-  class SpecFinder
+  module SpecFinder
+    extend self
 
-    attr_reader :gem_lines
-
-    def initialize(gem_lines)
-      @gem_lines = gem_lines
+    def find_specs_for(gem_lines)
+      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) if gems_to_fetch.any?
     end
 
-    def find_specs
+    def find_matching_specs_for(gem_lines)
       gem_lines.each do |line|
         matching_specs = Gem::Dependency.new(line.name).matching_specs
         line.spec = matching_specs.first if matching_specs.any?
       end
+    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"
+    def fetch_specs_for(gem_lines)
+      print "Fetching gem metadata..."
+      fetcher = Bundler::Fetcher.new(Gem.sources.first.uri)
+      versions, _ = fetcher.send(:fetch_dependency_remote_specs, gem_lines.collect(&:name))
+      gem_lines.each do |gem_line|
+        print "."
+        gem_versions = versions.select { |v| v.first == gem_line.name }
+        version = find_latest_version(gem_versions)
+        gem_line.spec = fetcher.fetch_spec([gem_line.name, version])
       end
+      print "\n"
     end
 
+    def find_latest_version(versions)
+       versions.sort_by { |v| v[1] }.last[1]
+    end
   end
 end

data/lib/grub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grub
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ivan Tse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +58,7 @@ files:
 - lib/grub/cli.rb
 - lib/grub/gem_line.rb
 - lib/grub/gemfile.rb
+- lib/grub/options.rb
 - lib/grub/spec_finder.rb
 - lib/grub/version.rb
 homepage: https://github.com/ivantsepp/grub