label 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6cf01f17f6dfd3998588bb648512af9cfcf416a
-  data.tar.gz: 555966948a51a9e8dcdba72aba1b0c7bc76b37df
+  metadata.gz: 43ed0e2234e5085642a6d2982e90208b061528ee
+  data.tar.gz: 182735232dd5c93b31ce73606a8f752535936dab
 SHA512:
-  metadata.gz: f51ead279688c2374b76c6a12064223946cf009b23b09636377285027de3efbaf46e3e0eee799afa5991b58dc9a00ba363d853afc522a3fb8991f2c51197fb55
-  data.tar.gz: b64196c0b500ed673b0d781394228e2fc4d9fd1b52883225e123d69bf328acad37ffdf24984b1da5fdd74cf9cb2ec11c5d87beb699ffc44c6d0efc4546cce2b0
+  metadata.gz: 8565ec03ab01d7359743013922887c23bddac3b37e8de477c82dcb5df9346bcc078322e1fae46792be8bbdc1044925019d981fb481832d63c1b596d8fe1c2c31
+  data.tar.gz: 8d12c99cbafc397a45b15ee50b744e004d57fbd1fec91596db35a5c77632dafc44ddfa073ec29a125d1626df02f5531f2507ab6538e803211572de02de3ea532

data/AUTHORS.md

@@ -0,0 +1,3 @@
+Label is written and maintained by Johannes Gorset and various contributors:
+
+* Felipe Espinoza

data/README.md

@@ -31,6 +31,12 @@ gem 'carrierwave'
 gem 'rails_admin'
 ```
 
+Oh, and let's be real; you will always want to use label.
+
+```bash
+alias bundle="bundle && label"
+```
+
 ## I love you
 
 Johannes Gorset made this. You should [tweet me](http://twitter.com/jgorset) if you can't get

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/label.rb

@@ -1,4 +1,5 @@
 require "label/version"
+require "label/gemspec_info"
 require "optparse"
 require "ostruct"
 require "gems"
@@ -17,7 +18,7 @@ module Label
 
       write gemfile, output
     end
-    
+
     # Process the given Gemfile.
     #
     # gemfile    - A String describing the path to a Gemfile.
@@ -40,11 +41,12 @@ module Label
 
           whitespace = matches[1]
           gem        = matches[2]
+          source     = extract_source_and_options line
 
           unless previous_line =~ /^ *#/
             describing.call gem if describing
 
-            description = describe gem
+            description = describe gem, source
 
             described.call description if described
 
@@ -77,11 +79,37 @@ module Label
 
     # Describe the given gem.
     #
-    # gem - A String describing the name of a gem.
+    # gem    - A String describing the name of a gem.
+    # source - A hash with the gem source options, posible values:
+    #           - rubygems
+    #           - github
+    #           - path
+    #           - git
     #
     # Returns a String.
-    def describe gem
-      Gems.info(gem).fetch "info"
+    def describe gem, source = { rubygems: true }
+      if source[:rubygems]
+        Gems.info(gem).fetch "info"
+      else
+        info = GemspecInfo.new gem, source
+        info.summary
+      end
+    end
+
+    private
+
+    # 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|
+        args = option.split(":").map {|arg| arg.strip.gsub(/('|\")/, '') }
+        source[args.first.to_sym] = args.last
+      end
+      source[:rubygems] = true if source.empty?
+      source
     end
 
   end

data/lib/label/gemspec_info.rb

@@ -0,0 +1,76 @@
+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

@@ -0,0 +1,23 @@
+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>[^}]*)\}/,
+    ]
+
+    def initialize content
+      @content = content
+    end
+
+    def extract_summary
+      STRING_REGEXPS.each do |regexp|
+        md = content.match(/\w+\.summary\s+=\s+#{regexp}/)
+        return md[:content] if md
+      end
+    end
+  end
+end

data/lib/label/version.rb

@@ -1,3 +1,3 @@
 module Label
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/fixtures/processed_gemfile

@@ -15,3 +15,10 @@ group :test do
   # Guard is a command line tool to easily handle events on file system modifications.
   gem 'guard'
 end
+
+group :development
+  # Label labels the gems in your Gemfile
+  gem 'label', path: './'
+  # An IRB alternative and runtime developer console
+  gem 'pry', github: 'pry/pry', branch: 'development'
+end

data/spec/fixtures/stock_gemfile

@@ -13,3 +13,8 @@ group :test do
   # Guard is a command line tool to easily handle events on file system modifications.
   gem 'guard'
 end
+
+group :development
+  gem 'label', path: './'
+  gem 'pry', github: 'pry/pry', branch: 'development'
+end

data/spec/label/gemspec_info_spec.rb

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,38 @@
+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 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
+
+  end
+end

data/spec/label_spec.rb

@@ -5,13 +5,20 @@ describe Label do
     it "should label unlabelled gems" do
       allow(File).to receive(:open).with("Gemfile").and_return(StringIO.new fixture("stock_gemfile"))
 
-      allow(subject).to receive(:describe).with("rspec").and_return("BDD for Ruby")
+      allow(subject).to receive(:describe).with("rspec", rubygems: true).and_return("BDD for Ruby")
 
-      allow(subject).to receive(:describe).with("carrierwave").and_return(
-        "Upload files in your Ruby applications, map them to a range of ORMs, " + 
+      allow(subject).to receive(:describe).with("carrierwave", rubygems: true).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(
+        "Label labels the gems in your Gemfile"
+      )
+
+      allow(subject).to receive(:describe).with("pry", github: "pry/pry", branch: "development")
+        .and_return("An IRB alternative and runtime developer console")
+
       expect(subject.process("Gemfile")).to eq fixture("processed_gemfile")
     end
   end
@@ -22,5 +29,10 @@ describe Label do
 
       expect(subject.describe("label")).to eq "Label gems in your Gemfile"
     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"
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,3 +3,10 @@ require "label"
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: label
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2014-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gems
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- AUTHORS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -82,9 +83,13 @@ files:
 - bin/label
 - label.gemspec
 - lib/label.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/gemspec_info_spec.rb
+- spec/label/summary_extractor_spec.rb
 - spec/label_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jgorset/label
@@ -107,12 +112,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Label labels the gems in your Gemfile
 test_files:
 - spec/fixtures/processed_gemfile
 - spec/fixtures/stock_gemfile
+- spec/label/gemspec_info_spec.rb
+- spec/label/summary_extractor_spec.rb
 - spec/label_spec.rb
 - spec/spec_helper.rb