label 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43ed0e2234e5085642a6d2982e90208b061528ee
-  data.tar.gz: 182735232dd5c93b31ce73606a8f752535936dab
+  metadata.gz: 25dc28997376d566445cf8c15d3151daa408eda7
+  data.tar.gz: c122b3799a49542703ac11ba550820f0d21d8f69
 SHA512:
-  metadata.gz: 8565ec03ab01d7359743013922887c23bddac3b37e8de477c82dcb5df9346bcc078322e1fae46792be8bbdc1044925019d981fb481832d63c1b596d8fe1c2c31
-  data.tar.gz: 8d12c99cbafc397a45b15ee50b744e004d57fbd1fec91596db35a5c77632dafc44ddfa073ec29a125d1626df02f5531f2507ab6538e803211572de02de3ea532
+  metadata.gz: 510ef82eab2b5627931e647aa4edf68dd0f01f83c45c27204897dc9cc34b95df36fb6c7affa1d19785cc990fc3374b4b5a0d9dfd01771e7b26771b95364c7330
+  data.tar.gz: 9ae86f37ba891fed191a76180f190ac79989ff9d7101e653cc227b81665258bc5d9a0b9faf421b67565fc1e5edb5eb1c55b1879281ddf462e556d95c8192079b

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/AUTHORS.md

@@ -1,3 +1,4 @@
-Label is written and maintained by Johannes Gorset and various contributors:
+Label is written and maintained by [Johannes Gorset](https://github.com/jgorset) and various contributors:
 
-* Felipe Espinoza
+* [Felipe Espinoza](https://github.com/fespinoza)
+* [Tim Kurvers](https://github.com/timkurvers)

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in label.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -1,5 +1,11 @@
 # Label
 
+[![Gem Version](https://img.shields.io/gem/v/label.svg)](https://rubygems.org/gems/label)
+[![Build Status](https://img.shields.io/travis/jgorset/label.svg)](https://travis-ci.org/jgorset/label)
+[![Dependency Status](https://img.shields.io/gemnasium/jgorset/label.svg)](https://gemnasium.com/jgorset/label)
+[![Code Climate](https://img.shields.io/codeclimate/github/jgorset/label.svg)](https://codeclimate.com/github/jgorset/label)
+[![Coverage Status](https://img.shields.io/coveralls/jgorset/label.svg)](https://coveralls.io/r/jgorset/label)
+
 Label labels the gems in your Gemfile.
 
 ## Installation
@@ -8,17 +14,13 @@ Label labels the gems in your Gemfile.
 
 ## Usage
 
-    $ cd /path/to/Gemfile
-    $ label
+```zsh
+$ label
+```
 
 ```ruby
-# /path/to/Gemfile
-
 source 'http://rubygems.org'
 
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.0.0'
-
 # Flexible authentication solution for Rails with Warden
 gem 'devise'
 
@@ -31,10 +33,11 @@ gem 'carrierwave'
 gem 'rails_admin'
 ```
 
-Oh, and let's be real; you will always want to use label.
+Label will look for a `Gemfile` in your current working directory by default, but you can
+tell it to look somewhere else if you like:
 
-```bash
-alias bundle="bundle && label"
+```zsh
+$ label /path/to/Gemfile
 ```
 
 ## I love you

data/bin/label

@@ -2,4 +2,8 @@
 
 require "label"
 
-Label.label
+if ARGV.any?
+  Label.label ARGV.first
+else
+  Label.label
+end

data/lib/label.rb

@@ -1,5 +1,6 @@
 require "label/version"
 require "label/gemspec_info"
+require "label/description_formatter"
 require "optparse"
 require "ostruct"
 require "gems"
@@ -8,12 +9,10 @@ module Label
 
   class << self
 
-    def label
+    def label gemfile = "Gemfile"
       describing = lambda { |gem| STDOUT.write "#{gem}: " }
       described  = lambda { |description| STDOUT.puts description }
 
-      gemfile = "Gemfile"
-
       output = process gemfile, describing, described
 
       write gemfile, output
@@ -50,7 +49,7 @@ module Label
 
             described.call description if described
 
-            processed_lines << "#{whitespace}# #{description}"
+            processed_lines << format(description, "#{whitespace}#")
           end
         end
 
@@ -98,6 +97,10 @@ module Label
 
     private
 
+    def format description, prepend_string
+      DescriptionFormatter.format description, prepend_string
+    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

data/lib/label/description_formatter.rb

@@ -0,0 +1,48 @@
+module Label
+  class DescriptionFormatter
+
+    FIRST_SENTENCE_REGEXP = /(?<first_sentence>([^.]*https?:\/\/[^\s]*\..*\..*)|([^.]*\.))(?<rest>.*)/
+    CHARACTERS_PER_LINE = 90
+
+    # Formats a description
+    #
+    # description - A description String to be formatted.
+    # separator   - A String to be used as aditional separator formatting
+    def self.format description, separator = ''
+      if md = description.match(FIRST_SENTENCE_REGEXP)
+        break_in_lines md[:first_sentence].strip, separator
+      else
+        "#{separator} #{description}"
+      end
+    end
+
+    private
+
+    # split lines that are too long in multiple lines
+    def self.break_in_lines description, separator = ''
+      description.gsub!(/\n/, ' ')
+      description = "#{separator} #{description}"
+
+      index = CHARACTERS_PER_LINE
+      while description.length > index
+        index = previous_space_index description, index
+        new_line_string = "\n#{separator} "
+        description[index] = new_line_string
+        index += CHARACTERS_PER_LINE + new_line_string.length
+      end
+      description
+    end
+
+    # given a string returns and an index returns the index of the first previous
+    # space character in the given string
+    def self.previous_space_index description, index
+      limit_char = description[index]
+      while limit_char != ' '
+        index -= 1
+        limit_char = description[index]
+      end
+      index
+    end
+  end
+
+end

data/lib/label/summary_extractor.rb

@@ -6,7 +6,7 @@ module Label
     STRING_REGEXPS = [
       /\"(?<content>[^"]*)\"/,
       /'(?<content>[^']*)'/,
-      /%q\{(?<content>[^}]*)\}/,
+      /%q\{(?<content>[^}]*)\}/i
     ]
 
     def initialize content
@@ -14,7 +14,7 @@ module Label
     end
 
     def extract_summary
-      STRING_REGEXPS.each do |regexp|
+      STRING_REGEXPS.find do |regexp|
         md = content.match(/\w+\.summary\s+=\s+#{regexp}/)
         return md[:content] if md
       end

data/lib/label/version.rb

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

data/spec/fixtures/processed_gemfile

@@ -6,9 +6,22 @@ gem 'rails', '4.0.0'
 # Authentication
 gem 'devise'
 
-# Upload files in your Ruby applications, map them to a range of ORMs, store them on different backends.
+# Upload files in your Ruby applications, map them to a range of ORMs, store them on
+# different backends.
 gem 'carrierwave'
 
+# Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser.
+gem 'nokogiri'
+# Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/].
+gem 'pg'
+
+group :production do
+  # \Unicorn is an HTTP server for Rack applications designed to only serve fast clients
+  # on low-latency, high-bandwidth connections and take advantage of features in
+  # Unix/Unix-like kernels.
+  gem 'unicorn'
+end
+
 group :test do
   # BDD for Ruby
   gem 'rspec'

data/spec/fixtures/stock_gemfile

@@ -8,6 +8,13 @@ gem 'devise'
 
 gem 'carrierwave'
 
+gem 'nokogiri'
+gem 'pg'
+
+group :production do
+  gem 'unicorn'
+end
+
 group :test do
   gem 'rspec'
   # Guard is a command line tool to easily handle events on file system modifications.

data/spec/label/description_formatter_spec.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+require 'label/description_formatter'
+
+def format input_string, prepend_string = "#"
+  Label::DescriptionFormatter.format input_string, prepend_string
+end
+
+describe Label::DescriptionFormatter do
+
+  describe '.format' do
+    it 'does not change descriptions that are not that long' do
+      description = "An IRB alternative and runtime developer console"
+      expect(format(description)).to eq "# #{description}"
+    end
+
+    context 'with long descriptions' do
+      it 'returns the first sentence (ended by ".") for long descriptions' do
+        long_description = "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 "+
+          "selectors.\n\nXML is like violence - if it "+
+          "doesnâ\u0080\u0099t solve your problems, you are not"+
+          "using\nenough of it."
+        result = format(long_description)
+        expect(result).to eq "# Nokogiri (é\u008B¸) is an HTML, XML, SAX, and Reader parser."
+      end
+
+      it 'returns the first sentence an include urls correctly' do
+        long_description = "Pg is the Ruby interface to the {PostgreSQL RDBMS}"+
+          "[http://www.postgresql.org/].\n\nIt 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# Output a table of current "+
+          "connections to the DB\n  conn =PG.connect( dbname: 'sales' )\n  conn.exec("+
+          " \"SELECT * FROM pg_stat_activity\" ) do |result|\n    puts \"     PID |"+
+          " User             | Query\"\n  result.each do|row|\n      puts \" %7d |"+
+          " %-16s | %s \" %\nrow.values_at('procpid', 'usename', 'current_query')\n"+
+          "    end\n  end"
+        result = format long_description, '#'
+        expect(result).to eq "# Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/]."
+      end
+
+      it 'returns the first sentence in multiple lines when this is too long' do
+        long_description = "\\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."+
+          "Slow clients should\nonly be served by placing a reverse proxy capable"+
+          " of fully buffering\nboth the the request and response in between "+
+          "\\Unicorn and slow clients."
+
+        expected_description = "  # \\Unicorn is an HTTP server for Rack applications "+
+          "designed to only serve fast clients\n  # on low-latency, high-bandwidth "+
+          "connections and take advantage of features in\n  # Unix/Unix-like kernels."
+        expect(format(long_description, '  #')).to eq expected_description
+      end
+    end
+
+  end
+
+end

data/spec/label/summary_extractor_spec.rb

@@ -28,11 +28,22 @@ describe Label::SummaryExtractor do
       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

data/spec/label_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require "spec_helper"
 
 describe Label do
@@ -16,6 +17,35 @@ describe Label do
         "Label labels the gems in your Gemfile"
       )
 
+      allow(subject).to receive(:describe).with("pg", rubygems: true).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"+
+        "# Output a table of current connections to the DB\n  conn ="+
+        "PG.connect( dbname: 'sales' )\n  conn.exec( \"SELECT * FROM pg_stat_activity\" )"+
+        "do |result|\n    puts \"     PID | User             | Query\"\n  result.each do"+
+        "|row|\n      puts \" %7d | %-16s | %s \" %\n"+
+        "row.values_at('procpid', 'usename', 'current_query')\n    end\n  end"
+      )
+
+      allow(subject).to receive(:describe).with("nokogiri", rubygems: true).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 "+
+        "selectors.\n\nXML is like violence - if it "+
+        "doesnâ\u0080\u0099t solve your problems, you are not"+
+        "using\nenough of it."
+      )
+
+      allow(subject).to receive(:describe).with("unicorn", rubygems: true).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."+
+        "Slow clients should\nonly be served by placing a reverse proxy capable"+
+        " of fully buffering\nboth the the request and response in between "+
+        "\\Unicorn and slow clients."
+      )
+
       allow(subject).to receive(:describe).with("pry", github: "pry/pry", branch: "development")
         .and_return("An IRB alternative and runtime developer console")
 

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require "label"
 
+require "coveralls"
+Coveralls.wear!
+
 def fixture file
   File.read "spec/fixtures/#{file}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: label
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Johannes Gorset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gems
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - AUTHORS.md
 - Gemfile
 - LICENSE.txt
@@ -83,11 +84,13 @@ files:
 - bin/label
 - 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
@@ -119,7 +122,9 @@ summary: Label labels the gems in your Gemfile
 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
+has_rdoc: