label 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7dea93831bc0aa3c9e53a98ff01ae217134a2b6
-  data.tar.gz: 82c142f19d4ee49c83b1a0128f684a463a02ea6f
+  metadata.gz: 69b062d913786723a28cb0fcf27ba5e2a614a4ea
+  data.tar.gz: 5c4e954723b928ac583a463bc956b05c28d7ea88
 SHA512:
-  metadata.gz: dbf0abed36706032026ac70492566eefddafae32a4a08b9317a242932c109af5def2c61c6e54648f2baa25176baaed7140771cf1605fe015515000a7997a26b8
-  data.tar.gz: 2218bd9f7bb681ee4a887839d7943ab1a9ac30df8cd7c3a79817ea74d0eb64a89009ccdcd7fb4eea75ab66437073d72d3e5aa6f63d97cc6516e82a8a33ca2603
+  metadata.gz: 05fb43e1d46f8bb542eea2059efc4f3a3cadbeaee5c5a989bfd2c170048758b5816bd661540359dd17c711c3f6d0a3118843d6e6e975d8934f9cc47318b905b8
+  data.tar.gz: 798b20fc30a6211c587c8b13a824952686259ce6c8f0881a6fbc1df678958c56c1722647f344bb11f4d82cf8de0458b163dded6e36b45e7b40ce4129d877f44c

data/label.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "gems", "~> 0.8"
-
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/label.rb

@@ -1,16 +1,18 @@
 require "label/version"
-require "label/gemspec_info"
 require "label/description_formatter"
+
+require "bundler"
 require "optparse"
 require "ostruct"
-require "gems"
 
 module Label
 
   class << self
 
+    GEM_REGEXP = /^(?<whitespace> *)gem ['"](?<name>.+?)['"](:?, ['"](?<version>.+?)['"])?/
+
     def label gemfile = "Gemfile"
-      describing = lambda { |gem| STDOUT.write "#{gem}: " }
+      describing = lambda { |name| STDOUT.write "#{name}: " }
       described  = lambda { |description| STDOUT.puts description }
 
       output = process gemfile, describing, described
@@ -33,21 +35,21 @@ module Label
       processed_lines = []
 
       lines.each_with_index do |line, i|
-        matches = line.match /^( *)gem ['"](.+?)['"]/
+        match = line.match GEM_REGEXP
 
-        if matches
+        if match
           previous_line = lines[i - 1]
 
-          whitespace = matches[1]
-          gem        = matches[2]
-          source     = extract_source_and_options line
+          whitespace = match[:whitespace]
+          name       = match[:name]
+          version    = match[:version]
 
           unless previous_line =~ /^ *#/
-            describing.call gem if describing
+            describing.call(name) if describing
 
-            description = describe gem, source
+            description = describe(name, version)
 
-            described.call description if described
+            described.call(description) if described
 
             processed_lines << format(description, "#{whitespace}#")
           end
@@ -78,43 +80,31 @@ module Label
 
     # Describe the given gem.
     #
-    # gem    - A String describing the name of a gem.
-    # source - A hash with the gem source options, posible values:
-    #           - rubygems
-    #           - github
-    #           - path
-    #           - git
+    # name    - A String with the name of a gem.
+    # version - A String describing the version of a gem.
     #
     # Returns a String.
-    def describe gem, source = { rubygems: true }
-      if source[:rubygems]
-        Gems.info(gem).fetch "info"
-      else
-        info = GemspecInfo.new gem, source
-        info.summary
+    def describe name, version = nil
+      requirement = Gem::Requirement.new(version)
+
+      or_raise = -> do
+        raise Gem::LoadError.new("Could not find '#{name}' (#{requirement})")
       end
+
+      specs.find or_raise do |spec|
+        spec.name == name &&
+        requirement.satisfied_by?(spec.version)
+      end.summary
     end
 
     private
 
-    def format description, prepend_string
-      DescriptionFormatter.format description, prepend_string
+    def specs
+      @specs ||= Bundler.load.specs
     end
 
-    # Exctract the source options form a Gemfile gem declaration
-    # as :github, :path and/or :branch and return a Hash with those options
-    # :rubygems is the default
-    def extract_source_and_options line
-      source = {}
-      options = line.split ","
-      options[1, options.length - 1].each do |option|
-        if option.match(/:/)
-          args = option.split(":").map {|arg| arg.strip.gsub(/('|\")/, '') }
-          source[args.first.to_sym] = args.last
-        end
-      end
-      source[:rubygems] = true if source.empty?
-      source
+    def format description, prepend_string
+      DescriptionFormatter.format description, prepend_string
     end
 
   end

data/lib/label/version.rb

@@ -1,3 +1,3 @@
 module Label
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/spec/label/description_formatter_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require 'label/description_formatter'
 
 def format input_string, prepend_string = "#"

data/spec/label_spec.rb

@@ -1,23 +1,24 @@
 # encoding: utf-8
+
 require "spec_helper"
 
 describe Label do
   describe "#process" do
-    it "should label unlabelled gems" do
+    it "labels unlabelled gems" do
       allow(File).to receive(:open).with("Gemfile").and_return(StringIO.new fixture("stock_gemfile"))
 
-      allow(subject).to receive(:describe).with("rspec", rubygems: true).and_return("BDD for Ruby")
+      allow(subject).to receive(:describe).with("rspec", nil).and_return("BDD for Ruby")
 
-      allow(subject).to receive(:describe).with("carrierwave", rubygems: true).and_return(
+      allow(subject).to receive(:describe).with("carrierwave", nil).and_return(
         "Upload files in your Ruby applications, map them to a range of ORMs, " +
         "store them on different backends."
       )
 
-      allow(subject).to receive(:describe).with("label", path: "./").and_return(
+      allow(subject).to receive(:describe).with("label", nil).and_return(
         "Label labels the gems in your Gemfile"
       )
 
-      allow(subject).to receive(:describe).with("pg", rubygems: true).and_return(
+      allow(subject).to receive(:describe).with("pg", nil).and_return(
         "Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/].\n\n"+
         "It works with {PostgreSQL 8.4 and later}[http://www.postgresql.org/support/versioning/]."+
         "\n\nA small example usage:\n\n  #!/usr/bin/env ruby\n\n  require 'pg'\n\n"+
@@ -28,7 +29,7 @@ describe Label do
         "row.values_at('procpid', 'usename', 'current_query')\n    end\n  end"
       )
 
-      allow(subject).to receive(:describe).with("nokogiri", rubygems: true).and_return(
+      allow(subject).to receive(:describe).with("nokogiri", nil).and_return(
         "Nokogiri (é\u008B¸) is an HTML, XML, SAX, and Reader "+
         "parser.  Among Nokogiri's\nmany features is the "+
         "ability to search documents via XPath or CSS3 "+
@@ -37,7 +38,7 @@ describe Label do
         "using\nenough of it."
       )
 
-      allow(subject).to receive(:describe).with("unicorn", rubygems: true).and_return(
+      allow(subject).to receive(:describe).with("unicorn", nil).and_return(
         "\\Unicorn is an HTTP server for Rack applications "+
         "designed to only serve\nfast clients on low-latency, high-bandwidth "+
         "connections and take\nadvantage of features in Unix/Unix-like kernels."+
@@ -46,10 +47,10 @@ describe Label do
         "\\Unicorn and slow clients."
       )
 
-      allow(subject).to receive(:describe).with("pry", github: "pry/pry", branch: "development")
+      allow(subject).to receive(:describe).with("pry", nil)
         .and_return("An IRB alternative and runtime developer console")
 
-      allow(subject).to receive(:describe).with("rspec-rails", rubygems: true).and_return(
+      allow(subject).to receive(:describe).with("rspec-rails", '~> 3.0.0.beta2').and_return(
         "Rspec for Rails"
       )
 
@@ -58,15 +59,30 @@ describe Label do
   end
 
   describe "#describe" do
-    it "should describe a given gem" do
-      expect(Gems).to receive(:info).with("label").and_return("info" => "Label gems in your Gemfile")
+    it "describes a given gem" do
+      expect(subject.describe("rake")).to eq "Rake is a Make-like program implemented in Ruby"
+    end
+
+    it "describes requested version of a given gem" do
+      expect(subject.describe("bundler", "~> 1.3")).to eq "The best way to manage your application's dependencies"
+    end
+
+    it "raises when a given gem could not be found" do
+      expect do
+        subject.describe("missing")
+      end.to raise_error Gem::LoadError, "Could not find 'missing' (>= 0)"
+    end
 
-      expect(subject.describe("label")).to eq "Label gems in your Gemfile"
+    it "raises when requested version of a given gem could not be found" do
+      expect do
+        subject.describe("bundler", "~> 1000.0")
+      end.to raise_error Gem::LoadError, "Could not find 'bundler' (~> 1000.0)"
     end
 
-    it "should describe a given gem from a github source" do
-      mock_github_response!
-      expect(subject.describe("label", github: "jgorset/label")).to eq "Label labels the gems in your Gemfile"
+    it "raises when given version requirement is malformed" do
+      expect do
+        subject.describe("bundler", "fweep")
+      end.to raise_error Gem::Requirement::BadRequirementError
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,10 +6,3 @@ Coveralls.wear!
 def fixture file
   File.read "spec/fixtures/#{file}"
 end
-
-def mock_github_response!
-  gemspec_contents = File.readlines("./label.gemspec").join("\n")
-  response_double  = double :response_double, body: gemspec_contents
-  expect(Net::HTTP).to receive(:get_response).with(anything())
-                                             .and_return(response_double)
-end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: label
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: gems
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +71,10 @@ files:
 - label.gemspec
 - lib/label.rb
 - lib/label/description_formatter.rb
-- lib/label/gemspec_info.rb
-- lib/label/summary_extractor.rb
 - lib/label/version.rb
 - spec/fixtures/processed_gemfile
 - spec/fixtures/stock_gemfile
 - spec/label/description_formatter_spec.rb
-- spec/label/gemspec_info_spec.rb
-- spec/label/summary_extractor_spec.rb
 - spec/label_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jgorset/label
@@ -115,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Label labels the gems in your Gemfile
@@ -123,7 +105,5 @@ test_files:
 - spec/fixtures/processed_gemfile
 - spec/fixtures/stock_gemfile
 - spec/label/description_formatter_spec.rb
-- spec/label/gemspec_info_spec.rb
-- spec/label/summary_extractor_spec.rb
 - spec/label_spec.rb
 - spec/spec_helper.rb

data/lib/label/gemspec_info.rb

@@ -1,76 +0,0 @@
-require 'label/summary_extractor'
-require 'net/http'
-
-module Label
-  # A class to represent a gemspec file in order
-  # to extract info from it
-  class GemspecInfo
-    attr_reader :gem_name, :source
-
-    GITHUB_RAW_URL = "https://raw.githubusercontent.com"
-
-    def initialize gem_name, source
-      @gem_name = gem_name
-      @source   = source
-    end
-
-    # Extracts the gemspec summary string
-    def summary
-      SummaryExtractor.new(content).extract_summary
-    end
-
-    # Raw contents of the gemspec file
-    def content
-      @content ||= fetch_gemspec_content!
-    end
-
-    private
-
-    # Fetch the content from a gemspec file that could be remote or
-    # that could be a file in the developer computer
-    #
-    # Returns a string with the gemspec file content
-    def fetch_gemspec_content!
-      case source_name
-      when :git
-        fetch_gemspec_content_from_git!
-      when :github
-        fetch_gemspec_content_from_github!
-      when :path
-        fetch_gemspec_content_from_path!
-      else
-        ""
-      end
-    end
-
-    # returns a symbol of the defined source
-    # it could be :git, :github, :path, etc
-    def source_name
-      [:git, :github, :path].each do |source_name|
-        return source_name if source[source_name]
-      end
-    end
-
-    # for simplicity git protocol calls that match with a github repo
-    # will be converted to a github url
-    def fetch_gemspec_content_from_git!
-      if md = source[:git].match(/git:\/\/github\.com:(?<repo>.*)/)
-        source[:github] = md[:repo]
-        source.delete :git
-        fetch_gemspec_content_from_github!
-      end
-    end
-
-    def fetch_gemspec_content_from_github!
-      repo   = source[:github]
-      branch = source[:branch] || "master"
-      file_url = "#{GITHUB_RAW_URL}/#{repo}/#{branch}/#{gem_name}.gemspec"
-      Net::HTTP.get_response(URI(file_url)).body
-    end
-
-    def fetch_gemspec_content_from_path!
-      File.readlines("#{source[:path]}/#{gem_name}.gemspec").join "\n"
-    end
-
-  end
-end

data/lib/label/summary_extractor.rb

@@ -1,23 +0,0 @@
-module Label
-  # A class to extract the summary from the contents of a gemspec file
-  class SummaryExtractor
-    attr_reader :content
-
-    STRING_REGEXPS = [
-      /\"(?<content>[^"]*)\"/,
-      /'(?<content>[^']*)'/,
-      /%q\{(?<content>[^}]*)\}/i
-    ]
-
-    def initialize content
-      @content = content
-    end
-
-    def extract_summary
-      STRING_REGEXPS.find do |regexp|
-        md = content.match(/\w+\.summary\s+=\s+#{regexp}/)
-        return md[:content] if md
-      end
-    end
-  end
-end

data/spec/label/gemspec_info_spec.rb

@@ -1,25 +0,0 @@
-require "spec_helper"
-require "label/gemspec_info"
-
-describe Label::GemspecInfo do
-
-  describe "#summary" do
-    it "should extract the summary from a gem from a github repo" do
-      mock_github_response!
-      info = Label::GemspecInfo.new "label", github: "jgorset/label"
-      expect(info.summary).to eq "Label labels the gems in your Gemfile"
-    end
-
-    it "should extract the summary from a gem from a git repo" do
-      mock_github_response!
-      info = Label::GemspecInfo.new "label", git: "git://github.com:jgorset/label"
-      expect(info.summary).to eq "Label labels the gems in your Gemfile"
-    end
-
-    it "should extract the summary from a gem from a path" do
-      info = Label::GemspecInfo.new "label", path: "./"
-      expect(info.summary).to eq "Label labels the gems in your Gemfile"
-    end
-  end
-
-end

data/spec/label/summary_extractor_spec.rb

@@ -1,49 +0,0 @@
-require "label/summary_extractor"
-
-shared_examples "extracts summary" do |expected_summary|
-  it "should extract summary" do
-    extractor = Label::SummaryExtractor.new(content)
-    expect(extractor.extract_summary).to eq expected_summary
-  end
-end
-
-describe Label::SummaryExtractor do
-
-  describe "#extract_summary" do
-    context "for double quoted strings containing single quoted strings" do
-      let(:content) { "s.email       = [\"fespinozacast@gmail.com\"]\n  s.homepage    = \"fespinoza.github.io\"\n  s.summary     = \"A series of generators an other rails 'defaults' for my projects\"\n  s.description = \"TODO.\"\n  s.license     = \"MIT\"\n\n" }
-
-      include_examples "extracts summary", "A series of generators an other rails 'defaults' for my projects"
-    end
-
-    context "for single quoted strings containing double quoted strings" do
-      let(:content) { "s.email       = [\"fespinozacast@gmail.com\"]\n  s.homepage    = \"fespinoza.github.io\"\n  s.summary     = 'A series of generators an other rails \"defaults\" for my projects'\n  s.description = \"TODO.\"\n  s.license     = \"MIT\"\n\n" }
-
-      include_examples "extracts summary", "A series of generators an other rails \"defaults\" for my projects"
-    end
-
-    context "for strings defined with %q{}" do
-      let(:content) { "s.email       = [\"fespinozacast@gmail.com\"]\n  s.homepage    = \"fespinoza.github.io\"\n  s.summary     = %q{A series of generators an other rails \"defaults\" for my 'projects'}\n  s.description = \"TODO.\"\n  s.license     = \"MIT\"\n\n" }
-
-      include_examples "extracts summary", "A series of generators an other rails \"defaults\" for my 'projects'"
-    end
-
-    context "for strings defined with %Q{}" do
-      let(:content) { "s.email       = [\"fespinozacast@gmail.com\"]\n  s.homepage    = \"fespinoza.github.io\"\n  s.summary     = %Q{A series of generators an other rails \"defaults\" for my 'projects'}\n  s.description = \"TODO.\"\n  s.license     = \"MIT\"\n\n" }
-
-      include_examples "extracts summary", "A series of generators an other rails \"defaults\" for my 'projects'"
-    end
-
-    context "for different gem configuration variable names" do
-      let(:content) { "g.email       = [\"fespinozacast@gmail.com\"]\n  g.homepage    = \"fespinoza.github.io\"\n  g.summary     = %q{A series of generators an other rails \"defaults\" for my 'projects'}\n  g.description = \"TODO.\"\n  g.license     = \"MIT\"\n\n" }
-
-      include_examples "extracts summary", "A series of generators an other rails \"defaults\" for my 'projects'"
-    end
-
-    context "for summaries that don't exist at all" do
-      let(:content) { "s.email       = [\"fespinozacast@gmail.com\"]\n  s.homepage    = \"fespinoza.github.io\"\n  s.description = \"TODO.\"\n  s.license     = \"MIT\"\n\n" }
-
-      include_examples "extracts summary", nil
-    end
-  end
-end