diligent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab67b44dc93fb3550fbf7bbca30e77a013edff40
+  data.tar.gz: 91cbda452d99bd6c69a6bc4a52fbd6e472c8a997
+SHA512:
+  metadata.gz: 568856534c5083a20163b2862c68c682e125a7f2fbd8d75cf7ad89851cd40bf0420e2e5e2dcfef111b67c3a65ff19fb3f92a639fc27bb543b9186aee25c4afe8
+  data.tar.gz: 3bc64833405d83002153a876f1a4f95a6cd583b289f5979c04d8caef7e42959dddffbbca52696a69dda823178de6ef04f58be34ff07c77f3813bc6c8aecdc6ee

data/.gitignore

@@ -0,0 +1,20 @@
+Gemfile.lock
+*.gem
+*.rbc
+.ruby-version
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode
+  
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec', all_on_start: true do
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jonathan Vaught
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+diligent
+========
+
+[![Build Status](https://secure.travis-ci.org/copyhacker/diligent.png?branch=master)](https://travis-ci.org/copyhacker/diligent)
+
+Comb your gems for licensing info and collate it nicely for the lawyers.
+
+
+# TODO
+
+- [x] Command line or rake task
+- [x] Run and parse `bundle list`
+- [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] JSON
+  - [X] HTML
+  - [x] CSV
+- Documentation
+
+# Author
+
+- [Jonathan Vaught](http://github.com/copyhacker)
+
+# Contributors
+
+- [Brian Nelson](http://github.com/briannelsondesign)

data/bin/diligent

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'diligent/cli'
+
+Diligent::CLI.start(ARGV)

data/diligent.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'diligent/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'diligent'
+  s.version     = Diligent::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.date        = '2014-03-24'
+  s.summary     = "Comb your gems for licensing info and collate it nicely for the lawyers."
+  s.description = "Comb your gems for licensing info and collate it nicely for the lawyers."
+  s.authors     = [ "Jonathan Vaught" ]
+  s.email       = 'jonathan.vaught@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.executables   = [ "diligent" ]
+  s.test_files  = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = [ "lib" ]
+  s.homepage    =
+    'https://github.com/copyhacker/diligent'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency     'thor',           '~> 0.19'
+  s.add_runtime_dependency     'bundler',        '~> 1.0'
+
+  s.add_development_dependency 'awesome_print',  '~> 1.2'
+  s.add_development_dependency 'guard',          '~> 2.6'
+  s.add_development_dependency 'guard-rspec',    '~> 4.2'
+  s.add_development_dependency 'nokogiri',       '~> 1.6'
+  s.add_development_dependency 'pry',            '~> 0.9'
+  s.add_development_dependency 'rspec',          '~> 3.0.beta'
+end

data/lib/diligent/cli.rb

@@ -0,0 +1,29 @@
+require 'thor'
+require 'diligent'
+
+module Diligent
+  class CLI < Thor
+    desc 'legalese', 'If you can read this, thank a lawyer.'
+    def legalese
+      puts Diligent::Info.legalese
+    end
+
+    desc 'list', 'List of gem information. JSON by default, or pass format option.'
+    option :format
+    option :outfile
+    def list
+      list = Diligent::List.new
+
+      case (options[:format] || 'json')
+      when 'csv'
+        list.as_csv(options[:outfile] || './diligent.csv')
+      when 'json'
+        puts list.as_json(options[:outfile] || nil)
+      when 'html'
+        list.as_html(options[:outfile] || './diligent.html')
+      else
+        raise 'Only CSV, HTML and JSON are currently supported.'
+      end
+    end
+  end
+end

data/lib/diligent/list.rb

@@ -0,0 +1,77 @@
+require 'csv'
+require 'erb'
+require 'json'
+
+module Diligent
+  class List
+    include ERB::Util # for html escaping
+
+    attr_accessor :project_name, :specs
+
+    class << self
+      def load
+        self.new.as_hash
+      end
+    end
+
+    def initialize
+      # TODO Optionally point at a different path?
+
+      @project_name = File.split(FileUtils.getwd).last
+      @specs = Bundler.load.specs
+    end
+
+    def as_hash
+      @specs.inject({}) do |hash, spec|
+        hash[spec.name] = {
+          'version'      => spec.version.to_s,
+          'author'       => spec.author,
+          'summary'      => spec.summary,
+          'description'  => spec.description,
+          'license'      => spec.license,
+          'homepage'     => spec.homepage
+        }
+
+        hash
+      end
+    end
+
+    def as_json(filename = nil)
+      json = as_hash.to_json
+      write_to_file filename, json
+    end
+
+    def as_csv(filename = nil)
+      as_array = as_hash.inject([]) do |arr, gem_info|
+        row = []
+        row << gem_info.first
+        gem_info.last.inject(row) do |r, i|
+          r << i.last
+        end
+        arr << row
+      end
+
+      csv = CSV.generate do |csv|
+        csv << %w{ Gem Version Author Summary Description License Homepage }
+        as_array.each { |row| csv << row }
+      end
+
+      write_to_file filename, csv
+    end
+
+    def as_html(filename = nil)
+      list = as_hash
+      template_path = File.join(File.dirname(__FILE__), '../../templates/list.html.erb')
+      html = ERB.new(File.read(template_path)).result(binding)
+
+      write_to_file filename, html
+    end
+
+  protected
+
+    def write_to_file(filename, content)
+      File.open(filename, 'w') { |f| f.write(content) } if filename
+      content
+    end
+  end
+end

data/lib/diligent/version.rb

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

data/lib/diligent.rb

@@ -0,0 +1,15 @@
+require 'bundler'
+require 'diligent/version'
+require 'diligent/list'
+
+module Diligent
+  class Info
+    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
+
+    def self.license_text(license_name)
+      "http://opensource.org/licenses/#{license_name}"
+    end
+  end
+end

data/spec/diligent/info_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Diligent::Info do
+  describe '.license_text' do
+    it 'should return a link to the full license text' do
+      expect(Diligent::Info.license_text('MIT')).to eq("http://opensource.org/licenses/MIT")
+    end
+  end
+end

data/spec/diligent/list_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'csv'
+require 'nokogiri'
+
+describe Diligent::List do
+  before { @list = Diligent::List.load }
+
+  context '.load' do
+    it 'should be a list of gems used' do
+      expect(@list['awesome_print']['author']).to eq('Michael Dvorkin')
+    end
+  end
+
+  context '#as_csv' do
+    after { FileUtils.rm('/tmp/diligent.csv') if File.exists?('/tmp/diligent.csv') }
+
+    it 'should put the list in CSV format' do
+      @csv = Diligent::List.new.as_csv
+      check_csv_content CSV.parse(@csv)
+    end
+
+    it 'should output to a file' do
+      @csv = Diligent::List.new.as_csv('/tmp/diligent.csv')
+      check_csv_content CSV.read('/tmp/diligent.csv')
+    end
+  end
+
+  context '#as_html' do
+    after { FileUtils.rm('/tmp/diligent.html') if File.exists?('/tmp/diligent.html') }
+
+    it 'should put the list in HTML format' do
+      @html = Diligent::List.new.as_html
+      check_html_content @html
+    end
+  end
+end
+
+# FIXME: Brittle
+def check_csv_content(csv_rows)
+  expect(csv_rows.first).to eq(%w{ Gem Version Author Summary Description License Homepage })
+  expect(csv_rows[1].first).to eq ('awesome_print')
+end
+
+def check_html_content(html)
+  Nokogiri::HTML(html).tap do |doc|
+    # Nokogiri is too picky for this to work
+    # expect(doc.errors).to be_empty
+
+    expect(doc.children.first.name).to eq('html')
+
+    # Too brittle, again
+    # expect(doc.at('table').children[1].children.first.text).to eq('awesome_print')
+  end
+end

data/spec/diligent_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Diligent::Info do
+  context '.legalese' do
+    it 'should be present' do
+      expect(Diligent::Info.legalese).not_to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'diligent'
+
+Bundler.require :default, :development
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/templates/list.html.erb

@@ -0,0 +1,107 @@
+<html>
+  <head>
+    <title>Project '<%= project_name %>'</title>
+    <style>
+      * {
+        box-sizing: border-box;
+      }
+      body {
+        box-sizing: border-box;
+        color: #444;
+        font: 14px/20px normal "Helvetica Neue", Arial, Helvetica, sans-serif;
+        margin: 25px;
+      }
+      h1 {
+        font-weight: 300;
+        font-size: 36px;
+        line-height: 46px;
+        margin: 0;
+      }
+      h2 {
+        color: #999;
+        font-size: 20px;
+        font-weight: normal;
+        line-height: 30px;
+        margin: 0 0 30px;
+      }
+      table {
+        border-collapse: collapse;
+        font-size: 14px;
+        text-align: left;
+        width: 100%;
+      }
+      table tr th {
+        border-bottom: 2px solid #bbb;
+        padding: 6px;
+      }
+      table tr td {
+        border-top: 1px solid #ddd;
+        padding: 6px;
+      }
+      table tr:hover td {
+        background: #f5f5f5;
+      }
+      p {
+        margin: 0;
+      }
+      a.truncate-link {
+        font-size: 11px;
+      }
+      .gem {}
+      .version {}
+      .author { font-size: 12px; }
+      .summary { font-size: 12px; }
+      .description { font-size: 12px; }
+      .license { font-size: 12px; }
+      .url {}
+    </style>
+  </head>
+
+  <body>
+    <h1><%= project_name %></h1>
+    <h2>Dependencies and licensing compiled by <a href="https://github.com/copyhacker/diligent">Diligent</a></h2>
+    <table>
+      <tr>
+        <th>Gem</th>
+        <th>Version</th>
+        <th>Author</th>
+        <th>Summary</th>
+        <th>Description</th>
+        <th>License</th>
+      </tr>
+
+      <% list.each do |gem_name, values| %>
+        <tr id="<%= h gem_name %>">
+          <td class="gem"><a href="<%= values['homepage'] %>"><%= h gem_name %></a></td>
+          <% values.each do |key, val| %>
+            <td class="<%= key %>">
+              <% case key
+              when 'license' %>
+                <a href="<%= Diligent::Info.license_text(val) %>"><%= val %></a>
+              <% when 'summary', 'description' %>
+                <p><%= h val %></p>
+              <% when 'homepage' #NOP %>
+              <% else %>
+                <%= h val %>
+              <% end %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </table>
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
+    <script>
+      (function(c){function g(b,a){this.element=b;this.options=c.extend({},h,a);c(this.element).data("max-height",this.options.maxHeight);c(this.element).data("height-margin",this.options.heightMargin);delete this.options.maxHeight;if(this.options.embedCSS&&!k){var d=".readmore-js-toggle, .readmore-js-section { "+this.options.sectionCSS+" } .readmore-js-section { overflow: hidden; }",e=document.createElement("style");e.type="text/css";e.styleSheet?e.styleSheet.cssText=d:e.appendChild(document.createTextNode(d));document.getElementsByTagName("head")[0].appendChild(e);k=!0}this._defaults=h;this._name=f;this.init()}var f="readmore",h={speed:100,maxHeight:200,heightMargin:16,moreLink:'<a href="#">Read More</a>',lessLink:'<a href="#">Close</a>',embedCSS:!0,sectionCSS:"display: block; width: 100%;",startOpen:!1,expandedClass:"readmore-js-expanded",collapsedClass:"readmore-js-collapsed",beforeToggle:function(){},afterToggle:function(){}},k=!1;g.prototype={init:function(){var b=this;c(this.element).each(function(){var a=c(this),d=a.css("max-height").replace(/[^-\d\.]/g,"")>a.data("max-height")?a.css("max-height").replace(/[^-\d\.]/g,""):a.data("max-height"),e=a.data("height-margin");"none"!=a.css("max-height")&&a.css("max-height","none");b.setBoxHeight(a);if(a.outerHeight(!0)<=d+e)return!0;a.addClass("readmore-js-section "+b.options.collapsedClass).data("collapsedHeight",d);a.after(c(b.options.startOpen?b.options.lessLink:b.options.moreLink).on("click",function(c){b.toggleSlider(this,a,c)}).addClass("readmore-js-toggle"));b.options.startOpen||a.css({height:d})});c(window).on("resize",function(a){b.resizeBoxes()})},toggleSlider:function(b,a,d){d.preventDefault();var e=this;d=newLink=sectionClass="";var f=!1;d=c(a).data("collapsedHeight");c(a).height()<=d?(d=c(a).data("expandedHeight")+"px",newLink="lessLink",f=!0,sectionClass=e.options.expandedClass):(newLink="moreLink",sectionClass=e.options.collapsedClass);e.options.beforeToggle(b,a,f);c(a).animate({height:d},{duration:e.options.speed,complete:function(){e.options.afterToggle(b,a,f);c(b).replaceWith(c(e.options[newLink]).on("click",function(b){e.toggleSlider(this,a,b)}).addClass("readmore-js-toggle"));c(this).removeClass(e.options.collapsedClass+" "+e.options.expandedClass).addClass(sectionClass)}})},setBoxHeight:function(b){var a=b.clone().css({height:"auto",width:b.width(),overflow:"hidden"}).insertAfter(b),c=a.outerHeight(!0);a.remove();b.data("expandedHeight",c)},resizeBoxes:function(){var b=this;c(".readmore-js-section").each(function(){var a=c(this);b.setBoxHeight(a);(a.height()>a.data("expandedHeight")||a.hasClass(b.options.expandedClass)&&a.height()<a.data("expandedHeight"))&&a.css("height",a.data("expandedHeight"))})},destroy:function(){var b=this;c(this.element).each(function(){var a=c(this);a.removeClass("readmore-js-section "+b.options.collapsedClass+" "+b.options.expandedClass).css({"max-height":"",height:"auto"}).next(".readmore-js-toggle").remove();a.removeData()})}};c.fn[f]=function(b){var a=arguments;if(void 0===b||"object"===typeof b)return this.each(function(){if(c.data(this,"plugin_"+f)){var a=c.data(this,"plugin_"+f);a.destroy.apply(a)}c.data(this,"plugin_"+f,new g(this,b))});if("string"===typeof b&&"_"!==b[0]&&"init"!==b)return this.each(function(){var d=c.data(this,"plugin_"+f);d instanceof g&&"function"===typeof d[b]&&d[b].apply(d,Array.prototype.slice.call(a,1))})}})(jQuery);
+    </script>
+    <script>
+      $(document).ready(function(){
+        $('p').readmore({
+          maxHeight: 15,
+          moreLink: '<a class="truncate-link" href="#">More</a>',
+          lessLink: '<a class="truncate-link" href="#">Less</a>'
+        });
+      });
+    </script>
+
+  </body>
+</html>

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: diligent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Vaught
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.beta
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.beta
+description: Comb your gems for licensing info and collate it nicely for the lawyers.
+email: jonathan.vaught@gmail.com
+executables:
+- diligent
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- bin/diligent
+- diligent.gemspec
+- lib/diligent.rb
+- lib/diligent/cli.rb
+- lib/diligent/list.rb
+- lib/diligent/version.rb
+- spec/diligent/info_spec.rb
+- spec/diligent/list_spec.rb
+- spec/diligent_spec.rb
+- spec/spec_helper.rb
+- templates/list.html.erb
+homepage: https://github.com/copyhacker/diligent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Comb your gems for licensing info and collate it nicely for the lawyers.
+test_files:
+- spec/diligent/info_spec.rb
+- spec/diligent/list_spec.rb
+- spec/diligent_spec.rb
+- spec/spec_helper.rb
+has_rdoc: