license_finder 0.1.0

data/spec/fixtures/other_licensed_gem/LICENSE

@@ -0,0 +1,3 @@
+MY RANDOM LICENSE
+
+Gimme your money

data/spec/fixtures/utf8_gem/README

@@ -0,0 +1,210 @@
+= Project: Builder
+
+== Goal
+
+Provide a simple way to create XML markup and data structures.
+
+== Classes
+
+Builder::XmlMarkup:: Generate XML markup notiation
+Builder::XmlEvents:: Generate XML events (i.e. SAX-like)
+
+<b>Notes</b>:: 
+
+* An <tt>Builder::XmlTree</tt> class to generate XML tree
+  (i.e. DOM-like) structures is also planned, but not yet implemented.
+  Also, the events builder is currently lagging the markup builder in
+  features.
+
+== Usage
+
+  require 'rubygems'	
+  require_gem 'builder', '~> 2.0'
+
+  builder = Builder::XmlMarkup.new
+  xml = builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+  xml #=> <person><name>Jim</name><phone>555-1234</phone></person>
+
+or
+
+  require 'rubygems'	
+  require_gem 'builder'
+
+  builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)
+  builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+  #
+  # Prints:
+  # <person>
+  #   <name>Jim</name>
+  #   <phone>555-1234</phone>
+  # </person>
+
+== Compatibility
+
+=== Version 2.0.0 Compatibility Changes
+
+Version 2.0.0 introduces automatically escaped attribute values for
+the first time.  Versions prior to 2.0.0 did not insert escape
+characters into attribute values in the XML markup.  This allowed
+attribute values to explicitly reference entities, which was
+occasionally used by a small number of developers.  Since strings
+could always be explicitly escaped by hand, this was not a major
+restriction in functionality.
+
+However, it did suprise most users of builder.  Since the body text is
+normally escaped, everybody expected the attribute values to be
+escaped as well.  Escaped attribute values were the number one support
+request on the 1.x Builder series.
+
+Starting with Builder version 2.0.0, all attribute values expressed as
+strings will be processed and the appropriate characters will be
+escaped (e.g. "&" will be tranlated to "&amp;").  Attribute values
+that are expressed as Symbol values will not be processed for escaped
+characters and will be unchanged in output. (Yes, this probably counts
+as Symbol abuse, but the convention is convenient and flexible).
+
+Example:
+
+  xml = Builder::XmlMarkup.new
+  xml.sample(:escaped=>"This&That", :unescaped=>:"Here&amp;There")
+  xml.target!  =>
+    <sample escaped="This&amp;That" unescaped="Here&amp;There"/>
+
+=== Version 1.0.0 Compatibility Changes
+
+Version 1.0.0 introduces some changes that are not backwards
+compatible with earlier releases of builder.  The main areas of
+incompatibility are:
+
+* Keyword based arguments to +new+ (rather than positional based).  It
+  was found that a developer would often like to specify indentation
+  without providing an explicit target, or specify a target without
+  indentation.  Keyword based arguments handle this situation nicely.
+
+* Builder must now be an explicit target for markup tags.  Instead of
+  writing
+
+    xml_markup = Builder::XmlMarkup.new
+    xml_markup.div { strong("text") }
+
+  you need to write
+
+    xml_markup = Builder::XmlMarkup.new
+    xml_markup.div { xml_markup.strong("text") }
+
+* The builder object is passed as a parameter to all nested markup
+  blocks.  This allows you to create a short alias for the builder
+  object that can be used within the block.  For example, the previous
+  example can be written as:
+
+    xml_markup = Builder::XmlMarkup.new
+    xml_markup.div { |xml| xml.strong("text") }
+
+* If you have both a pre-1.0 and a post-1.0 gem of builder installed,
+  you can choose which version to use through the RubyGems
+  +require_gem+ facility.
+
+    require_gem 'builder', "~> 0.0"   # Gets the old version
+    require_gem 'builder', "~> 1.0"   # Gets the new version
+
+== Features
+
+* XML Comments are supported ...
+
+    xml_markup.comment! "This is a comment"
+      #=>  <!-- This is a comment -->
+
+* XML processing instructions are supported ...
+
+    xml_markup.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      #=>  <?xml version="1.0" encoding="UTF-8"?>
+   
+  If the processing instruction is omitted, it defaults to "xml".
+  When the processing instruction is "xml", the defaults attributes
+  are:
+  
+  <b>version</b>:: 1.0
+  <b>encoding</b>:: "UTF-8"
+
+* XML entity declarations are now supported to a small degree.
+
+    xml_markup.declare! :DOCTYPE, :chapter, :SYSTEM, "../dtds/chapter.dtd"
+      #=>  <!DOCTYPE chapter SYSTEM "../dtds/chapter.dtd">
+
+  The parameters to a declare! method must be either symbols or
+  strings. Symbols are inserted without quotes, and strings are
+  inserted with double quotes.  Attribute-like arguments in hashes are
+  not allowed.
+
+  If you need to have an argument to declare! be inserted without
+  quotes, but the arguement does not conform to the typical Ruby
+  syntax for symbols, then use the :"string" form to specify a symbol.
+
+  For example:
+
+    xml_markup.declare! :ELEMENT, :chapter, :"(title,para+)"
+      #=>  <!ELEMENT chapter (title,para+)>
+
+  Nested entity declarations are allowed.  For example:
+
+    @xml_markup.declare! :DOCTYPE, :chapter do |x|
+      x.declare! :ELEMENT, :chapter, :"(title,para+)"
+      x.declare! :ELEMENT, :title, :"(#PCDATA)"
+      x.declare! :ELEMENT, :para, :"(#PCDATA)"
+    end
+
+    #=>
+
+    <!DOCTYPE chapter [
+      <!ELEMENT chapter (title,para+)>
+      <!ELEMENT title (#PCDATA)>
+      <!ELEMENT para (#PCDATA)>
+    ]>
+
+* Some support for XML namespaces is now available.  If the first
+  argument to a tag call is a symbol, it will be joined to the tag to
+  produce a namespace:tag combination.  It is easier to show this than
+  describe it.
+
+   xml.SOAP :Envelope do ... end
+
+  Just put a space before the colon in a namespace to produce the
+  right form for builder (e.g. "<tt>SOAP:Envelope</tt>" =>
+  "<tt>xml.SOAP :Envelope</tt>")
+
+* String attribute values are <em>now</em> escaped by default by
+  Builder (<b>NOTE:</b> this is _new_ behavior as of version 2.0).
+
+  However, occasionally you need to use entities in attribute values.
+  Using a symbols (rather than a string) for an attribute value will
+  cause Builder to not run its quoting/escaping algorithm on that
+  particular value.
+
+  (<b>Note:</b> The +escape_attrs+ option for builder is now
+  obsolete).
+
+  Example:
+
+    xml = Builder::XmlMarkup.new
+    xml.sample(:escaped=>"This&That", :unescaped=>:"Here&amp;There")
+    xml.target!  =>
+      <sample escaped="This&amp;That" unescaped="Here&amp;There"/>
+
+* UTF-8 Support
+
+  Builder correctly translates UTF-8 characters into valid XML.  (New
+  in version 2.0.0).  Thanks to Sam Ruby for the translation code.
+
+  Example:
+
+    xml = Builder::Markup.new
+    xml.sample("I�t�rn�ti�n�l")
+    xml.target!  =>
+      "<sample>I&#241;t&#235;rn&#226;ti&#244;n&#224;l</sample>"
+
+== Contact
+
+Author::     Jim Weirich
+Email::      jim@weirichhouse.org
+Home Page::  http://onestepback.org
+License::    MIT Licence (http://www.opensource.org/licenses/mit-license.html)

data/spec/gem_spec_details_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe LicenseFinder::GemSpecDetails do
+  before do
+    @mock_gemspec = Class.new do
+      def initialize(path = nil)
+        @path = path
+      end
+
+      def name
+        'spec_name'
+      end
+
+      def version
+        '2.1.3'
+      end
+
+      def full_gem_path
+        if @path
+          gem_install_path = File.join(File.dirname(__FILE__), '/../', @path)
+          raise Errno::ENOENT, @path unless File.exists?(gem_install_path)
+          gem_install_path
+        else
+          'install/path'
+        end
+      end
+    end
+  end
+
+  subject { LicenseFinder::GemSpecDetails.new(@mock_gemspec.new) }
+
+  its(:name) { should == 'spec_name 2.1.3' }
+  its(:dependency_name) { should == 'spec_name' }
+  its(:dependency_version) { should == '2.1.3' }
+  its(:install_path) { should == 'install/path' }
+
+  describe "#license_files" do
+    it "is empty if there aren't any license files" do
+      LicenseFinder::GemSpecDetails.new(@mock_gemspec.new).license_files.should == []
+    end
+
+    it "includes files with names like LICENSE, License or COPYING" do
+      gem_spec = @mock_gemspec.new('spec/fixtures/license_names')
+      LicenseFinder::GemSpecDetails.new(gem_spec).license_files.map(&:file_name).should =~
+          %w[COPYING.txt LICENSE Mit-License README.rdoc]
+    end
+
+    it "includes files deep in the hierarchy" do
+      gem_spec = @mock_gemspec.new('spec/fixtures/nested_gem')
+      LicenseFinder::GemSpecDetails.new(gem_spec).license_files.map { |f| [f.file_name, f.file_path] }.should =~
+          [['LICENSE', 'vendor/LICENSE']]
+    end
+
+    it "includes both files nested inside LICENSE directory and top level files" do
+      gem_spec = @mock_gemspec.new('spec/fixtures/license_directory')
+      found_license_files = LicenseFinder::GemSpecDetails.new(gem_spec).license_files
+      found_license_files.map(&:file_name).should =~
+            %w[BSD-2-Clause.txt GPL-2.0.txt MIT.txt RUBY.txt COPYING LICENSE]
+      found_license_files.map(&:file_path).should =~
+            %w[LICENSE/BSD-2-Clause.txt LICENSE/GPL-2.0.txt LICENSE/MIT.txt  LICENSE/RUBY.txt COPYING LICENSE/LICENSE]
+    end
+  end
+
+  describe "#readme_files" do
+    it "is empty if there aren't any readme files" do
+      LicenseFinder::GemSpecDetails.new(@mock_gemspec.new).readme_files.should == []
+    end
+
+    it "includes files with names like README, Readme or COPYING" do
+      gem_spec = @mock_gemspec.new('spec/fixtures/readme')
+      LicenseFinder::GemSpecDetails.new(gem_spec).readme_files.map(&:file_name).should =~
+          %w[Project\ ReadMe README Readme.markdown]
+    end
+
+    it "includes files deep in the hierarchy" do
+      gem_spec = @mock_gemspec.new('spec/fixtures/nested_readme')
+      LicenseFinder::GemSpecDetails.new(gem_spec).readme_files.map { |f| [f.file_name, f.file_path] }.should =~
+          [['README', 'vendor/README']]
+    end
+  end
+
+  describe 'to dependency' do
+    describe 'with MIT License' do
+      subject do
+        LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/mit_licensed_gem'), ['MIT']).dependency
+      end
+
+      its(:name) { should == 'spec_name' }
+      its(:version) { should == '2.1.3' }
+      its(:license) { should == 'MIT' }
+      its(:approved) { should == true }
+      its(:license_url) { should == '' }
+      its(:notes) { should == '' }
+    end
+
+    describe 'with MIT License in README' do
+      subject do
+        LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/mit_licensed_gem_in_README'), ['MIT']).dependency
+      end
+
+      its(:name) { should == 'spec_name' }
+      its(:version) { should == '2.1.3' }
+      its(:license) { should == 'MIT' }
+      its(:approved) { should == true }
+      its(:license_url) { should == '' }
+      its(:notes) { should == '' }
+    end
+
+    describe 'with MIT License in README' do
+      subject do
+        LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/mit_licensed_gem_via_url'), ['MIT']).dependency
+      end
+
+      its(:name) { should == 'spec_name' }
+      its(:version) { should == '2.1.3' }
+      its(:license) { should == 'MIT' }
+      its(:approved) { should == true }
+      its(:license_url) { should == '' }
+      its(:notes) { should == '' }
+    end
+
+    describe 'with Apache License' do
+      subject do
+        LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/apache_licensed_gem'), ['Apache 2.0']).dependency
+      end
+
+      its(:name) { should == 'spec_name' }
+      its(:version) { should == '2.1.3' }
+      its(:license) { should == 'Apache 2.0' }
+      its(:approved) { should == true }
+      its(:license_url) { should == '' }
+      its(:notes) { should == '' }
+    end
+
+    describe 'with GPLv2 License' do
+      subject do
+        LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/gplv2_licensed_gem'), ['GPLv2']).dependency
+      end
+
+      its(:name) { should == 'spec_name' }
+      its(:version) { should == '2.1.3' }
+      its(:license) { should == 'GPLv2' }
+      its(:approved) { should == true }
+      its(:license_url) { should == '' }
+      its(:notes) { should == '' }
+    end
+
+    describe 'with unknown license' do
+      subject { LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/other_licensed_gem')).dependency }
+
+      its(:name) { should == 'spec_name' }
+      its(:version) { should == '2.1.3' }
+      its(:license) { should == 'other' }
+      its(:approved) { should == false }
+      its(:license_url) { should == '' }
+      its(:notes) { should == '' }
+    end
+
+    describe 'with UTF8 file License' do
+      it "handles non UTF8 encodings" do
+        expect do
+          LicenseFinder::GemSpecDetails.new(@mock_gemspec.new('spec/fixtures/utf8_gem')).dependency
+        end.not_to raise_error ArgumentError, "invalid byte sequence in UTF-8"
+      end
+    end
+  end
+end

data/spec/license_file_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe LicenseFinder::LicenseFile do
+  subject { LicenseFinder::LicenseFile.new('gem', 'gem/license/path') }
+
+  context "ignoring text" do
+    before do
+      stub(IO).read { "file text" }
+      stub(IO).binread { "file text" }
+    end
+
+    describe "#to_hash" do
+      it "includes file path" do
+        subject.to_hash['file_name'].should == 'license/path'
+      end
+      
+      it "does not include file text by default" do
+        subject.to_hash['text'].should be_nil
+      end
+
+      it "includes file text if requested" do
+        subject.include_license_text = true
+        subject.to_hash['text'].should == 'file text'
+      end
+      
+      it "includes data about license" do
+        subject.to_hash.should have_key 'body_type'
+        subject.to_hash.should have_key 'header_type'
+        subject.to_hash.should have_key 'disclaimer_of_liability'
+      end
+    end
+  end
+
+  context "with MIT like license" do
+    before do
+      stub(IO).read { File.read(File.join(File.dirname(__FILE__), '/fixtures/MIT-LICENSE')) }
+      stub(IO).binread { File.read(File.join(File.dirname(__FILE__), '/fixtures/MIT-LICENSE')) }
+    end
+
+    its(:body_type) { should == 'mit' }
+    its(:header_type) { should == 'mit' }
+    its(:disclaimer_of_liability) { should == 'mit: THE AUTHORS OR COPYRIGHT HOLDERS' }
+  end
+  
+  context "with MIT reference in README" do
+    before do
+      stub(IO).read { File.read(File.join(File.dirname(__FILE__), '/fixtures/README-with-MIT-LICENSE')) }
+      stub(IO).binread { File.read(File.join(File.dirname(__FILE__), '/fixtures/README-with-MIT-LICENSE')) }
+    end
+
+    its(:body_type) { should == 'other' }
+    its(:header_type) { should == 'mit' }
+    its(:disclaimer_of_liability) { should == 'other' }
+  end
+  
+  context "with MIT url in README" do
+    before do
+      stub(IO).read { 'MIT Licence (http://www.opensource.org/licenses/mit-license.html)' }
+      stub(IO).binread { 'MIT Licence (http://www.opensource.org/licenses/mit-license.html)' }
+    end
+
+    its(:body_type) { should == 'mit' }
+    its(:disclaimer_of_liability) { should == 'mit: THE AUTHORS OR COPYRIGHT HOLDERS' }
+  end
+  
+  
+
+  context "with Apache like license" do
+    before do
+      stub(IO).read { File.read(File.join(File.dirname(__FILE__), '/fixtures/APACHE-2-LICENSE')) }
+      stub(IO).binread { File.read(File.join(File.dirname(__FILE__), '/fixtures/APACHE-2-LICENSE')) }
+    end
+
+    its(:body_type) { should == 'apache' }
+  end
+
+  context "with GPLv2 like license" do
+    before do
+      stub(IO).read { File.read(File.join(File.dirname(__FILE__), '/fixtures/GPLv2')) }
+      stub(IO).binread { File.read(File.join(File.dirname(__FILE__), '/fixtures/GPLv2')) }
+    end
+
+    its(:body_type) { should == 'gplv2' }
+  end
+  
+  context "with another license" do
+    before do
+      stub(IO).read { "a non-standard license" }
+      stub(IO).binread { "a non-standard license" }
+    end
+
+    its(:body_type) { should == 'other' }
+    its(:header_type) { should == 'other' }
+    its(:disclaimer_of_liability) { should == 'other' }
+  end
+  
+  context "with variation in disclaimer of liability" do
+    before do
+      stub(IO).read { File.read('spec/fixtures/MIT-LICENSE-with-varied-disclaimer') }
+      stub(IO).binread { File.read('spec/fixtures/MIT-LICENSE-with-varied-disclaimer') }
+    end
+
+    its(:body_type) { should == 'mit' }
+    its(:header_type) { should == 'mit' }
+    its(:disclaimer_of_liability) { should == 'mit: THE AUTHORS' }
+  end
+  
+  context "with empty license file" do
+    before do
+      stub(IO).read { "" }
+      stub(IO).binread { "" }
+    end
+    
+    describe "#to_hash" do
+      it "is safe" do
+        lambda { subject.to_hash }.should_not raise_error
+      end
+    end
+  end
+  
+  describe "with variations on MIT header" do
+    before do
+      stub(IO).read { '(The MIT License)' }
+      stub(IO).binread { '(The MIT License)' }
+    end
+
+    its(:header_type) { should == 'mit' }
+  end
+end