diligent 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab67b44dc93fb3550fbf7bbca30e77a013edff40
-  data.tar.gz: 91cbda452d99bd6c69a6bc4a52fbd6e472c8a997
+  metadata.gz: d6267d2dcc0208eed4d2a77c1dd4d66b509230a7
+  data.tar.gz: 27c8dfcc1802adb7fd5b6694b52d98818e9067cf
 SHA512:
-  metadata.gz: 568856534c5083a20163b2862c68c682e125a7f2fbd8d75cf7ad89851cd40bf0420e2e5e2dcfef111b67c3a65ff19fb3f92a639fc27bb543b9186aee25c4afe8
-  data.tar.gz: 3bc64833405d83002153a876f1a4f95a6cd583b289f5979c04d8caef7e42959dddffbbca52696a69dda823178de6ef04f58be34ff07c77f3813bc6c8aecdc6ee
+  metadata.gz: e6075a2548310d7db861c84d3286b53347288525e66453b6bb6ee12e1db2efcf8d21fd5897ec4d6d3877be2690d61da8d6fbc6353f346009db3c759fb7ac0abd
+  data.tar.gz: 27833a325cfcded47143b50e74929e553dc1b12361b4eb535c94c5281059dd0d81e32023376de2e5330321e8192079cacbf92931b30941a350a64e7549e0185a

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -6,6 +6,50 @@ diligent
 Comb your gems for licensing info and collate it nicely for the lawyers.
 
 
+# Quick Start
+
+1. `gem install diligent`
+2. `diligent --help`
+
+
+# Examples
+
+The following examples were run in the `diligent` project root.
+
+## JSON (default)
+
+`diligent list`
+
+`diligent list --format json --output diligent.json`
+
+Returns:
+
+```
+{"awesome_print":{"version":"1.2.0","author":"Michael Dvorkin","summary":"Pretty print Ruby objects with proper indentation and colors","description":"Great Ruby dubugging companion: pretty print Ruby objects to visualize their structure. Supports custom object formatting via plugins","license":null,"homepage":"http://github.com/michaeldv/awesome_print"},"bundler":{"version":"1.5.3","author":"André Arko","summary":"The best way to manage your application's dependencies","description":"Bundler manages an application's dependencies through its entire life, across many machines, systematically and repeatably","license":"MIT","homepage":"http://bundler.io"},"timers":{"version":"1.1.0","author":"Tony Arcieri","summary":"Schedule procs to run after a certain time, or at periodic intervals, using any API that accepts a timeout","description":"Pure Ruby one-shot and periodic timers","license":null,"homepage":"https://github.com/tarcieri/timers"},"celluloid":{"version":"0.15.2","author":"Tony Arcieri","summary":"Actor-based concurrent object framework for Ruby","description":"Celluloid enables people to build concurrent programs out of concurrent objects just as easily as they build sequential programs out of sequential objects","license":"MIT","homepage":"https://github.com/celluloid/celluloid"},"nio4r":{"version":"1.0.0","author":"Tony Arcieri","summary":"NIO provides a high performance selector API for monitoring IO objects","description":"New IO for Ruby","license":null,"homepage":"https://github.com/celluloid/nio4r"},"celluloid-io":{"version":"0.15.0","author":"Tony Arcieri","summary":"Celluloid::IO allows you to monitor multiple IO objects within a Celluloid actor","description":"Evented IO for Celluloid actors","license":"MIT","homepage":"http://github.com/celluloid/celluloid-io"},"coderay":{"version":"1.1.0","author":"Kornelius Kalnbach","summary":"Fast syntax highlighting for selected languages.","description":"Fast and easy syntax highlighting for selected languages, written in Ruby. Comes with RedCloth integration and LOC counter.","license":"MIT","homepage":"http://coderay.rubychan.de"},"diff-lcs":{"version":"1.2.5","author":"Austin Ziegler","summary":"Diff::LCS computes the difference between two Enumerable sequences using the McIlroy-Hunt longest common subsequence (LCS) algorithm","description":"Diff::LCS computes the difference between two Enumerable sequences using the\nMcIlroy-Hunt longest common subsequence (LCS) algorithm. It includes utilities\nto create a simple HTML diff output format and a standard diff-like tool.\n\nThis is release 1.2.4, fixing a bug introduced after diff-lcs 1.1.3 that did\nnot properly prune common sequences at the beginning of a comparison set.\nThanks to Paul Kunysch for fixing this issue.\n\nCoincident with the release of diff-lcs 1.2.3, we reported an issue with\nRubinius in 1.9 mode\n({rubinius/rubinius#2268}[https://github.com/rubinius/rubinius/issues/2268]).\nWe are happy to report that this issue has been resolved.","license":"MIT","homepage":"http://diff-lcs.rubyforge.org/"},"thor":{"version":"0.19.1","author":"Yehuda Katz","summary":"Thor is a toolkit for building powerful command-line interfaces.","description":"Thor is a toolkit for building powerful command-line interfaces.","license":"MIT","homepage":"http://whatisthor.com/"},"diligent":{"version":"0.1.0","author":"Jonathan Vaught","summary":"Comb your gems for licensing info and collate it nicely for the lawyers.","description":"Comb your gems for licensing info and collate it nicely for the lawyers.","license":"MIT","homepage":"https://github.com/copyhacker/diligent"},"ffi":{"version":"1.9.3","author":"Wayne Meissner","summary":"Ruby FFI","description":"Ruby FFI library","license":"BSD","homepage":"http://wiki.github.com/ffi/ffi"},"formatador":{"version":"0.2.4","author":"geemus (Wesley Beary)","summary":"Ruby STDOUT text formatting","description":"STDOUT text formatting","license":null,"homepage":"http://github.com/geemus/formatador"},"rb-fsevent":{"version":"0.9.4","author":"Thibaud Guillaume-Gentil","summary":"Very simple & usable FSEvents API","description":"FSEvents API with Signals catching (without RubyCocoa)","license":"MIT","homepage":"http://rubygems.org/gems/rb-fsevent"},"rb-inotify":{"version":"0.9.3","author":"Nathan Weizenbaum","summary":"A Ruby wrapper for Linux's inotify, using FFI","description":"A Ruby wrapper for Linux's inotify, using FFI","license":null,"homepage":"http://github.com/nex3/rb-inotify"},"listen":{"version":"2.7.1","author":"Thibaud Guillaume-Gentil","summary":"Listen to file modifications","description":"The Listen gem listens to file modifications and notifies you about the changes. Works everywhere!","license":"MIT","homepage":"https://github.com/guard/listen"},"lumberjack":{"version":"1.0.5","author":"Brian Durand","summary":"A simple, powerful, and very fast logging utility that can be a drop in replacement for Logger or ActiveSupport::BufferedLogger.","description":"A simple, powerful, and very fast logging utility that can be a drop in replacement for Logger or ActiveSupport::BufferedLogger. Provides support for automatically rolling log files even with multiple processes writing the same log file.","license":"MIT","homepage":"http://github.com/bdurand/lumberjack"},"method_source":{"version":"0.8.2","author":"John Mair (banisterfiend)","summary":"retrieve the sourcecode for a method","description":"retrieve the sourcecode for a method","license":null,"homepage":"http://banisterfiend.wordpress.com"},"slop":{"version":"3.5.0","author":"Lee Jarvis","summary":"Simple Lightweight Option Parsing","description":"A simple DSL for gathering options and parsing the command line","license":"MIT","homepage":"http://github.com/leejarvis/slop"},"pry":{"version":"0.9.12.6","author":"John Mair (banisterfiend)","summary":"An IRB alternative and runtime developer console","description":"An IRB alternative and runtime developer console","license":null,"homepage":"http://pry.github.com"},"guard":{"version":"2.6.0","author":"Thibaud Guillaume-Gentil","summary":"Guard keeps an eye on your file modifications","description":"Guard is a command line tool to easily handle events on file system modifications.","license":"MIT","homepage":"http://guardgem.org"},"rspec-support":{"version":"3.0.0.beta2","author":"David Chelimsky","summary":"rspec-support-3.0.0.beta2","description":"Support utilities for RSpec gems","license":"MIT","homepage":"https://github.com/rspec/rspec-support"},"rspec-core":{"version":"3.0.0.beta2","author":"Steven Baker","summary":"rspec-core-3.0.0.beta2","description":"BDD for Ruby. RSpec runner and example groups.","license":"MIT","homepage":"http://github.com/rspec/rspec-core"},"rspec-expectations":{"version":"3.0.0.beta2","author":"Steven Baker","summary":"rspec-expectations-3.0.0.beta2","description":"rspec-expectations provides a simple, readable API to express expected outcomes of a code example.","license":"MIT","homepage":"http://github.com/rspec/rspec-expectations"},"rspec-mocks":{"version":"3.0.0.beta2","author":"Steven Baker","summary":"rspec-mocks-3.0.0.beta2","description":"RSpec's 'test double' framework, with support for stubbing and mocking","license":"MIT","homepage":"http://github.com/rspec/rspec-mocks"},"rspec":{"version":"3.0.0.beta2","author":"Steven Baker","summary":"rspec-3.0.0.beta2","description":"BDD for Ruby","license":"MIT","homepage":"http://github.com/rspec"},"guard-rspec":{"version":"4.2.8","author":"Thibaud Guillaume-Gentil","summary":"Guard gem for RSpec","description":"Guard::RSpec automatically run your specs (much like autotest).","license":"MIT","homepage":"https://rubygems.org/gems/guard-rspec"},"mini_portile":{"version":"0.5.3","author":"Luis Lavena","summary":"Simplistic port-like solution for developers","description":"Simplistic port-like solution for developers. It provides a standard and simplified way to compile against dependency libraries without messing up your system.","license":"MIT","homepage":"http://github.com/luislavena/mini_portile"},"nokogiri":{"version":"1.6.1","author":"Aaron Patterson","summary":"Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser","description":"Nokogiri (鋸) 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’t solve your problems, you are not using\nenough of it.","license":"MIT","homepage":"http://nokogiri.org"}}
+```
+
+**Note:** the JSON output will always be returned to STDOUT regardless of whether you
+specify an output file.
+
+
+## CSV
+
+Output to `diligent.csv`:
+
+`diligent list --format csv`
+
+Output to `myfile.csv`:
+
+`diligent list --format csv --outfile myfile.csv`
+
+## HTML
+
+Nice clean formatted HTML with links to license text:
+
+`diligent list --format html`
+
+![HTML Output](https://dl.dropboxusercontent.com/u/117390/diligent_html.jpg)
+
 # TODO
 
 - [x] Command line or rake task
@@ -13,11 +57,11 @@ Comb your gems for licensing info and collate it nicely for the lawyers.
 - [x] Hit rubygems and/or GitHub for info on each gem
 - [x] Pull all that into a hash: name, version, owner, license type
 - [x] Link to license text
-- [X] Output options
+- [x] Output options
   - [x] JSON
-  - [X] HTML
+  - [x] HTML
   - [x] CSV
-- Documentation
+- [x] Documentation
 
 # Author
 

data/lib/diligent.rb

@@ -4,10 +4,17 @@ require 'diligent/list'
 
 module Diligent
   class Info
+    # Not-so-random legal jargon. Please don't try this at home.
+    #
+    # @return [String] legal jargon, for fun
     def self.legalese
       "New versions of the executable. If distribution of the alternative licenses, if any, in source and free culture, all users contributing to Wikimedia projects To grow the commons of free software, and (2) offer you this license is required to exercise the rights granted hereunder will terminate: (a) automatically without notice from Apple which Apple may grant in its Contribution, if any, must include the Program or Derived Programs thereof. Article 4 (Termination of Agreement) 1. The Recipient may not occur to you when allowing others to access the modified work as a relevant directory file) where a user would be entitled to make sure that they, too, receive or can get it if you want it to your programs, too."
     end
 
+    # Provides a URL linking to the text of a given open-source license.
+    #
+    # @param format [String] the short name of the license as listed at http://opensource.org/licenses/alphabetical
+    # @return [String] the URL where the full text of the license can be read
     def self.license_text(license_name)
       "http://opensource.org/licenses/#{license_name}"
     end

data/lib/diligent/list.rb

@@ -6,9 +6,21 @@ module Diligent
   class List
     include ERB::Util # for html escaping
 
-    attr_accessor :project_name, :specs
+    # @!attribute project_name
+    #   @return [String] the name of the project we're reading,
+    #     currently assumed to be the directory name.
+    attr_accessor :project_name
+
+    # @!attribute specs
+    #   @return [Bundler::SpecSet] Dependency info as generated by
+    #     `Bundler.load.specs`
+    attr_accessor :specs
 
     class << self
+
+      # Initialize and return gem info in a single step.
+      #   May be deprecated as it seems to be of limited use.
+      # @return [Hash] a hash containing dependency info
       def load
         self.new.as_hash
       end
@@ -16,11 +28,12 @@ module Diligent
 
     def initialize
       # TODO Optionally point at a different path?
-
       @project_name = File.split(FileUtils.getwd).last
       @specs = Bundler.load.specs
     end
 
+    # Output dependency info as a hash.
+    # @return [Hash] a hash containing dependency info
     def as_hash
       @specs.inject({}) do |hash, spec|
         hash[spec.name] = {
@@ -36,11 +49,18 @@ module Diligent
       end
     end
 
+    # Output dependency info as JSON.
+    #   A JSON string is returned by the method even if a filename is specified.
+    # @param filename [String] optional name of output file
+    # @return [String] a JSON string containing dependency info
     def as_json(filename = nil)
       json = as_hash.to_json
       write_to_file filename, json
     end
 
+    # Output dependency info as CSV.
+    # @param filename [String] optional name of output file
+    # @return [String] a CSV string containing dependency info, unless a filename is given
     def as_csv(filename = nil)
       as_array = as_hash.inject([]) do |arr, gem_info|
         row = []
@@ -59,6 +79,9 @@ module Diligent
       write_to_file filename, csv
     end
 
+    # Output dependency info as HTML.
+    # @param filename [String] optional name of output file
+    # @return [String] a CSV string containing dependency info, unless a filename is given
     def as_html(filename = nil)
       list = as_hash
       template_path = File.join(File.dirname(__FILE__), '../../templates/list.html.erb')

data/lib/diligent/version.rb

@@ -1,3 +1,3 @@
 module Diligent
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

data/templates/list.html.erb

@@ -1,3 +1,4 @@
+<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
 <html>
   <head>
     <title>Project '<%= project_name %>'</title>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diligent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonathan Vaught
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - Guardfile
 - LICENSE