RubyGems - license_finder - Versions diffs - 0.6.0 → 0.7.0 - Mend

license_finder 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (51) hide show

data/.gitignore +4 -0
data/Gemfile +0 -1
data/bin/license_finder +21 -1
data/features/approve_dependencies.feature +10 -0
data/features/license_finder.feature +13 -3
data/features/license_finder_rake_task.feature +3 -3
data/features/set_license.feature +14 -0
data/features/step_definitions/steps.rb +5 -0
data/lib/license_finder.rb +13 -2
data/lib/license_finder/bundle.rb +25 -3
data/lib/license_finder/bundle_syncer.rb +12 -0
data/lib/license_finder/bundled_gem.rb +12 -1
data/lib/license_finder/cli.rb +42 -3
data/lib/license_finder/configuration.rb +1 -31
data/lib/license_finder/dependency.rb +30 -94
data/lib/license_finder/dependency_report.rb +30 -0
data/lib/license_finder/html_report.rb +14 -0
data/lib/license_finder/persistence.rb +1 -0
data/lib/license_finder/persistence/yaml.rb +7 -0
data/lib/license_finder/persistence/yaml/configuration.rb +34 -0
data/lib/license_finder/persistence/yaml/dependency.rb +127 -0
data/lib/license_finder/reporter.rb +7 -38
data/lib/license_finder/source_syncer.rb +40 -0
data/lib/license_finder/text_report.rb +9 -0
data/lib/templates/dependency.html.erb +2 -2
data/lib/templates/html_report.erb +93 -0
data/lib/templates/text_report.erb +2 -0
data/license_finder.gemspec +2 -2
data/{README.markdown → readme.md} +22 -11
data/spec/lib/license_finder/bundle_spec.rb +58 -0
data/spec/lib/license_finder/bundle_syncer_spec.rb +22 -0
data/spec/lib/license_finder/bundled_gem_spec.rb +17 -14
data/spec/lib/license_finder/cli_spec.rb +38 -0
data/spec/lib/license_finder/dependency_spec.rb +130 -223
data/spec/lib/license_finder/html_report_spec.rb +67 -0
data/spec/lib/license_finder/persistence/yaml/configuration_spec.rb +5 -0
data/spec/lib/license_finder/persistence/yaml/dependency_spec.rb +5 -0
data/spec/lib/license_finder/possible_license_file_spec.rb +4 -9
data/spec/lib/license_finder/reporter_spec.rb +0 -1
data/spec/lib/license_finder/source_syncer_spec.rb +37 -0
data/spec/lib/license_finder/text_report_spec.rb +29 -0
data/spec/lib/license_finder_spec.rb +9 -11
data/spec/spec_helper.rb +1 -1
data/spec/support/license_examples.rb +1 -1
data/spec/support/shared_examples/persistence/configuration.rb +34 -0
data/spec/support/shared_examples/persistence/dependency.rb +139 -0
metadata +38 -26
data/lib/license_finder/dependency_list.rb +0 -80
data/lib/license_finder/viewable.rb +0 -31
data/lib/templates/dependency_list.html.erb +0 -38
data/spec/lib/license_finder/dependency_list_spec.rb +0 -243

data/lib/license_finder/dependency_list.rb DELETED

@@ -1,80 +0,0 @@
-# encoding: utf-8
-module LicenseFinder
-  class DependencyList
-    include Viewable
-    attr_reader :dependencies
-    def self.from_bundler
-      dep_list = new(Bundle.new.gems.map(&:to_dependency))
-      setup_parents_of_dependencies(dep_list)
-      dep_list
-    end
-    def self.setup_parents_of_dependencies(dep_list)
-      dependency_index = {}
-      dep_list.dependencies.each do |dep|
-        dependency_index[dep.name] = dep
-      end
-      dep_list.dependencies.each do |dep|
-        dep.children.each do |child_dep|
-          license_finder_dependency = dependency_index[child_dep.name]
-          license_finder_dependency.parents << dep if license_finder_dependency
-        end
-      end
-    end
-    def self.from_yaml(yaml)
-      deps = YAML.load(yaml)
-      new(deps.map { |attrs| Dependency.from_hash(attrs) })
-    end
-    def initialize(dependencies)
-      @dependencies = dependencies
-    end
-    def merge(new_list)
-      deps = new_list.dependencies.map do |new_dep|
-        old_dep = dependencies.detect { |d| d.name == new_dep.name }
-        if old_dep
-          old_dep.merge(new_dep)
-        else
-          new_dep
-        end
-      end
-      deps += dependencies.select { |d| d.source != "bundle" }
-      self.class.new(deps)
-    end
-    def as_yaml
-      sorted_dependencies.map(&:as_yaml)
-    end
-    def to_s
-      sorted_dependencies.map(&:to_s).join("\n")
-    end
-    def action_items
-      sorted_dependencies.reject(&:approved).map(&:to_s).join "\n"
-    end
-    private
-    def unapproved_dependencies
-      dependencies.reject(&:approved)
-    end
-    def sorted_dependencies
-      dependencies.sort_by(&:name)
-    end
-    def grouped_dependencies
-      dependencies.group_by(&:license).sort_by { |_, group| group.size }.reverse
-    end
-  end
-end

data/lib/license_finder/viewable.rb DELETED

@@ -1,31 +0,0 @@
-module LicenseFinder
-  module Viewable
-    def self.included(base)
-      base.class_eval do
-        extend ClassMethods
-      end
-    end
-    module ClassMethods
-      def underscored_name
-        @underscored_name ||= begin
-          str = name.dup
-          str.sub!(/.*::/, '')
-          str.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-          str.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-          str.downcase!
-        end
-      end
-    end
-    def to_yaml
-      as_yaml.to_yaml
-    end
-    def to_html
-      filename = File.join(File.dirname(__FILE__), '..', 'templates', "#{self.class.underscored_name}.html.erb")
-      template = ERB.new(File.read(filename))
-      template.result(binding)
-    end
-  end
-end

data/lib/templates/dependency_list.html.erb DELETED

@@ -1,38 +0,0 @@
-<html>
-<head>
-  <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.1.1/css/bootstrap.min.css" rel="stylesheet">
-  <style type="text/css">
-    body {
-      margin: 50px;
-    }
-    .unapproved h2, .unapproved h2 a {
-      color: red;
-    }
-  </style>
-</head>
-<body>
-<div class="container">
-  <div class="summary hero-unit">
-    <h1>Dependencies</h1>
-    <h4>
-      <%= dependencies.size %> total
-      <% if unapproved_dependencies.any? %>
-        <span class="badge badge-important"><%= unapproved_dependencies.size %> unapproved</span>
-      <% end %>
-    </h4>
-    <ul>
-      <% grouped_dependencies.each do |license, group| %>
-        <li><%= group.size %> <%= license %></li>
-      <% end %>
-    </ul>
-  </div>
-  <div class="dependencies">
-    <%= sorted_dependencies.map(&:to_html).join("\n") %>
-  </div>
-</div>
-</body>
-</html>

data/spec/lib/license_finder/dependency_list_spec.rb DELETED

@@ -1,243 +0,0 @@
-require 'spec_helper'
-describe LicenseFinder::DependencyList do
-  def build_gemspec(name, version, dependency=nil)
-    Gem::Specification.new do |s|
-      s.name = name
-      s.version = version
-      s.summary = 'summary'
-      s.description = 'description'
-      if dependency
-        s.add_dependency dependency
-      end
-    end
-  end
-  before do
-    config = stub(LicenseFinder).config.stub!
-    config.whitelist { [] }
-    config.ignore_groups { [] }
-  end
-  describe '.from_bundler' do
-    subject do
-      bundle = stub(Bundler::Definition).build.stub!
-      bundle.dependencies { [] }
-      bundle.groups { [] }
-      bundle.specs_for { [build_gemspec('gem1', '1.2.3'), build_gemspec('gem2', '0.4.2')] }
-      LicenseFinder::DependencyList.from_bundler
-    end
-    it "should have 2 dependencies" do
-      subject.dependencies.size.should == 2
-    end
-    it 'should maintain the incoming order' do
-      subject.dependencies[0].name.should == 'gem1'
-      subject.dependencies[0].version.should == '1.2.3'
-      subject.dependencies[1].name.should == 'gem2'
-      subject.dependencies[1].version.should == '0.4.2'
-    end
-    context "when initialized with a parent and child gem" do
-      subject do
-        bundle = stub(Bundler::Definition).build.stub!
-        bundle.dependencies { [] }
-        bundle.groups { [] }
-        bundle.specs_for { [build_gemspec('gem1', '1.2.3', 'gem2'), build_gemspec('gem2', '0.4.2')] }
-        LicenseFinder::DependencyList.from_bundler
-      end
-      it "should update the child dependency with its parent data" do
-        gem1 = subject.dependencies.first
-        gem2 = subject.dependencies.last
-        gem2.parents.should == [gem1]
-      end
-    end
-  end
-  describe '#from_yaml' do
-    subject do
-      LicenseFinder::DependencyList.from_yaml([
-        {'name' => 'gem1', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false},
-        {'name' => 'gem2', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false}
-      ].to_yaml)
-    end
-    it 'should have 2 dependencies' do
-      subject.dependencies.size.should == 2
-    end
-    it 'should maintain the incoming order' do
-      subject.dependencies[0].name.should == 'gem1'
-      subject.dependencies[0].version.should == '1.2.3'
-      subject.dependencies[1].name.should == 'gem2'
-      subject.dependencies[1].version.should == '0.4.2'
-    end
-  end
-  describe '#as_yaml' do
-    it "should generate yaml" do
-      list = LicenseFinder::DependencyList.new([
-        LicenseFinder::Dependency.new('name' => 'b_gem', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false, 'source' => "bundle"),
-        LicenseFinder::Dependency.new('name' => 'a_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false)
-      ])
-      list.as_yaml.should == [
-        {
-          'name' => 'a_gem',
-          'version' => '1.2.3',
-          'license' => 'MIT',
-          'approved' => false,
-          'source' => nil,
-          'homepage' => nil,
-          'license_url' => LicenseFinder::License::MIT.license_url,
-          'notes' => '',
-          'license_files' => nil,
-          'readme_files' => nil
-        },
-        {
-          'name' => 'b_gem',
-          'version' => '0.4.2',
-          'license' => 'MIT',
-          'approved' => false,
-          'source' => 'bundle',
-          'homepage' => nil,
-          'license_url' => LicenseFinder::License::MIT.license_url,
-          'notes' => '',
-          'license_files' => nil,
-          'readme_files' => nil
-        }
-      ]
-    end
-  end
-  describe '#to_yaml' do
-    it "should generate yaml" do
-      list = LicenseFinder::DependencyList.new([
-        LicenseFinder::Dependency.new('name' => 'b_gem', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false, 'source' => "bundle"),
-        LicenseFinder::Dependency.new('name' => 'a_gem', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false)
-      ])
-      yaml = YAML.load(list.to_yaml)
-      yaml.should == list.as_yaml
-    end
-  end
-  describe 'round trip' do
-    it 'should recreate from to_yaml' do
-      list = LicenseFinder::DependencyList.new([
-        LicenseFinder::Dependency.new('name' => 'gem1', 'version' => '1.2.3', 'license' => 'MIT', 'approved' => false),
-        LicenseFinder::Dependency.new('name' => 'gem2', 'version' => '0.4.2', 'license' => 'MIT', 'approved' => false)
-      ])
-      new_list = LicenseFinder::DependencyList.from_yaml(list.to_yaml)
-      new_list.dependencies.size.should == 2
-      new_list.dependencies.first.name.should == 'gem1'
-      new_list.dependencies[1].name.should == 'gem2'
-    end
-  end
-  describe '#merge' do
-    let(:old_dep) do
-      LicenseFinder::Dependency.new(
-        'name' => 'foo',
-        'version' => '0.0.1',
-        'source' => 'bundle'
-      )
-    end
-    let(:old_list) { LicenseFinder::DependencyList.new([old_dep]) }
-    let(:new_dep) do
-      LicenseFinder::Dependency.new(
-        'name' => 'foo',
-        'version' => '0.0.2',
-        'source' => 'bundle'
-      )
-    end
-    let(:new_list) { LicenseFinder::DependencyList.new([new_dep]) }
-    it 'should merge dependencies with the same name' do
-      merged_list = old_list.merge(new_list)
-      merged_deps = merged_list.dependencies.select { |d| d.name == 'foo' }
-      merged_deps.should have(1).item
-      merged_dep = merged_deps.first
-      merged_dep.name.should == 'foo'
-      merged_dep.version.should == '0.0.2'
-    end
-    it 'should add new dependencies' do
-      new_dep.name = 'bar'
-      merged_list = old_list.merge(new_list)
-      merged_list.dependencies.should include(new_dep)
-    end
-    it 'should keep dependencies not originating from the bundle' do
-      old_dep.source = ''
-      merged_list = old_list.merge(new_list)
-      merged_list.dependencies.should include(old_dep)
-    end
-    it 'should remove dependencies missing from the bundle' do
-      old_dep.source = 'bundle'
-      merged_list = old_list.merge(new_list)
-      merged_list.dependencies.should_not include(old_dep)
-    end
-  end
-  describe "#to_s" do
-    it "should return a human readable list of dependencies" do
-      gem1 = Struct.new(:name, :to_s).new("a", "a string")
-      gem2 = Struct.new(:name, :to_s).new("b", "b string")
-      list = LicenseFinder::DependencyList.new([gem2, gem1])
-      list.to_s.should == "a string\nb string"
-    end
-  end
-  describe '#action_items' do
-    it "should return all unapproved dependencies" do
-      gem1 = LicenseFinder::Dependency.new('name' => 'a', 'approved' => true)
-      stub(gem1).to_s { 'a string' }
-      gem2 = LicenseFinder::Dependency.new('name' => 'b', 'approved' => false)
-      stub(gem2).to_s { 'b string' }
-      gem3 = LicenseFinder::Dependency.new('name' => 'c', 'approved' => false)
-      stub(gem3).to_s { 'c string' }
-      list = LicenseFinder::DependencyList.new([gem1, gem2, gem3])
-      list.action_items.should == "b string\nc string"
-    end
-  end
-  describe '#to_html' do
-    it "should concatenate the results of the each dependency's #to_html and plop it into a proper HTML document" do
-      gem1 = LicenseFinder::Dependency.new('name' => 'a')
-      stub(gem1).to_html { 'A' }
-      gem2 = LicenseFinder::Dependency.new('name' => 'b')
-      stub(gem2).to_html { 'B' }
-      list = LicenseFinder::DependencyList.new([gem1, gem2])
-      html = list.to_html
-      html.should include "A"
-      html.should include "B"
-    end
-  end
-end