bibliothecary 4.0.4 → 5.0.0

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.3.3
+  - 2.4.0
 cache: bundler
+script:
+  - bundle exec rake spec && bundle exec codeclimate-test-reporter

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bibliothecary.gemspec
 gemspec
+
+group :test do
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end

data/README.md

@@ -1,6 +1,12 @@
 # Bibliothecary
 
-Dependency manifest parsing service for https://libraries.io in Ruby
+Dependency manifest parsing library for https://libraries.io
+
+[![Build Status](https://travis-ci.org/librariesio/bibliothecary.svg?branch=master)](https://travis-ci.org/librariesio/bibliothecary)
+[![Code Climate](https://img.shields.io/codeclimate/github/librariesio/bibliothecary.svg?style=flat)](https://codeclimate.com/github/librariesio/bibliothecary)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/librariesio/bibliothecary.svg?style=flat)](https://codeclimate.com/github/librariesio/bibliothecary)
+[![Code Climate](https://img.shields.io/codeclimate/issues/github/librariesio/bibliothecary.svg)](https://codeclimate.com/github/librariesio/bibliothecary/issues)
+[![license](https://img.shields.io/github/license/librariesio/bibliothecary.svg)](https://github.com/librariesio/bibliothecary/blob/master/LICENSE.txt)
 
 ## Installation
 

data/bibliothecary.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sdl4r"
 
   spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/bibliothecary.rb

@@ -8,15 +8,29 @@ end
 module Bibliothecary
   def self.analyse(path)
     cmd = `find #{path} -type f | grep -vE "#{ignored_files}"`
-    file_list = cmd.split("\n")
+    file_list = cmd.split("\n").sort
     package_managers.map{|pm| pm.analyse(path, file_list) }.flatten.compact
   end
 
+  def self.analyse_file(file_path, contents)
+    package_managers.map do |pm|
+      pm.analyse_contents(file_path, contents)
+    end.flatten.uniq.compact
+  end
+
+  def self.identify_manifests(file_list)
+    package_managers.map do |pm|
+      file_list.select do |file_path|
+        pm.match?(file_path)
+      end
+    end.flatten.uniq.compact
+  end
+
   def self.package_managers
     Bibliothecary::Parsers.constants.map{|c| Bibliothecary::Parsers.const_get(c) }.sort_by{|c| c.to_s.downcase }
   end
 
   def self.ignored_files
-    ['.git', 'node_modules', 'bower_components'].join('|')
+    ['.git', 'node_modules', 'bower_components', 'spec/fixtures', 'vendor/bundle'].join('|')
   end
 end

data/lib/bibliothecary/analyser.rb

@@ -4,6 +4,19 @@ module Bibliothecary
       base.extend(ClassMethods)
     end
     module ClassMethods
+      def parse_file(filename, contents)
+        mapping.each do |regex, method_name|
+          if filename.match(regex)
+            return send(method_name, contents)
+          end
+        end
+        return []
+      end
+
+      def match?(filename)
+        mapping.keys.any?{|regex| filename.match(regex) }
+      end
+
       def platform_name
         self.name.to_s.split('::').last.downcase
       end
@@ -11,17 +24,18 @@ module Bibliothecary
       def analyse(folder_path, file_list)
         file_list.map do |path|
           filename = path.gsub(folder_path, '').gsub(/^\//, '')
-          analyse_file(filename, path)
+          contents = File.open(path).read
+          analyse_contents(filename, contents)
         end.compact
       end
 
-      def analyse_file(filename, path)
+      def analyse_contents(filename, contents)
         begin
-          dependencies = parse(filename, path)
+          dependencies = parse_file(filename, contents)
           if dependencies.any?
             {
               platform: platform_name,
-              path: path,
+              path: filename,
               dependencies: dependencies
             }
           else
@@ -31,6 +45,16 @@ module Bibliothecary
           nil
         end
       end
+
+      def parse_ruby_manifest(manifest)
+        manifest.dependencies.inject([]) do |deps, dep|
+          deps.push({
+            name: dep.name,
+            requirement: dep.requirement.to_s,
+            type: dep.type
+          })
+        end.uniq
+      end
     end
   end
 end

data/lib/bibliothecary/parsers/bower.rb

@@ -5,19 +5,16 @@ module Bibliothecary
     class Bower
       include Bibliothecary::Analyser
 
-      def self.parse(filename, path)
-        if filename.match(/^bower\.json$/)
-          file_contents = File.open(path).read
-          json = JSON.parse(file_contents)
-          parse_manifest(json)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /^bower\.json$/ => :parse_manifest
+        }
       end
 
       def self.parse_manifest(manifest)
-        map_dependencies(manifest, 'dependencies', 'runtime') +
-        map_dependencies(manifest, 'devDependencies', 'development')
+        json = JSON.parse(manifest)
+        map_dependencies(json, 'dependencies', 'runtime') +
+        map_dependencies(json, 'devDependencies', 'development')
       end
 
       def self.map_dependencies(hash, key, type)

data/lib/bibliothecary/parsers/cargo.rb

@@ -5,21 +5,15 @@ module Bibliothecary
     class Cargo
       include Bibliothecary::Analyser
 
-      def self.parse(filename, path)
-        if filename.match(/Cargo\.toml$/)
-          file_contents = File.open(path).read
-          toml = TOML.parse(file_contents)
-          parse_manifest(toml)
-        elsif filename.match(/Cargo\.lock$/)
-          file_contents = File.open(path).read
-          toml = TOML.parse(file_contents)
-          parse_lockfile(toml)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /Cargo\.toml$/ => :parse_manifest,
+          /Cargo\.lock$/ => :parse_lockfile
+        }
       end
 
-      def self.parse_manifest(manifest)
+      def self.parse_manifest(file_contents)
+        manifest = TOML.parse(file_contents)
         manifest.fetch('dependencies', []).map do |name, requirement|
           if requirement.respond_to?(:fetch)
             requirement = requirement['version'] or next
@@ -33,24 +27,8 @@ module Bibliothecary
           .compact
       end
 
-      def self.analyse_cargo_lock(folder_path, file_list)
-        paths = file_list.select{|path| path.gsub(folder_path, '').gsub(/^\//, '').match(/Cargo\.lock$/) }
-        return unless paths.any?
-
-        paths.map do |path|
-          manifest = TOML.load_file(path)
-
-          {
-            platform: PLATFORM_NAME,
-            path: path,
-            dependencies: parse_lockfile(manifest)
-          }
-        end
-      rescue
-        []
-      end
-
-      def self.parse_lockfile(manifest)
+      def self.parse_lockfile(file_contents)
+        manifest = TOML.parse(file_contents)
         manifest.fetch('package',[]).map do |dependency|
           next if not dependency['source'] or not dependency['source'].start_with?('registry+')
           {

data/lib/bibliothecary/parsers/carthage.rb

@@ -3,49 +3,28 @@ module Bibliothecary
     class Carthage
       include Bibliothecary::Analyser
 
-      def self.parse(filename, path)
-        if filename.match(/^Cartfile$/)
-          file_contents = File.open(path).read
-          parse_cartfile(file_contents)
-        elsif filename.match(/^Cartfile\.private$/)
-          file_contents = File.open(path).read
-          parse_cartfile_private(file_contents)
-        elsif filename.match(/^Cartfile\.resolved$/)
-          file_contents = File.open(path).read
-          parse_cartfile_resolved(file_contents)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /^Cartfile$/ => :parse_cartfile,
+          /^Cartfile\.private$/ => :parse_cartfile_private,
+          /^Cartfile\.resolved$/ => :parse_cartfile_resolved
+        }
       end
 
       def self.parse_cartfile(manifest)
-        response = Typhoeus.post("https://carthageparser.herokuapp.com/cartfile", params: {body: manifest})
-        json = JSON.parse(response.body)
-
-        json.map do |dependency|
-          {
-            name: dependency['name'],
-            version: dependency['version'],
-            type: dependency["type"]
-          }
-        end
+        map_dependencies(manifest, 'cartfile')
       end
 
       def self.parse_cartfile_private(manifest)
-        response = Typhoeus.post("https://carthageparser.herokuapp.com/cartfile.private", params: {body: manifest})
-        json = JSON.parse(response.body)
-
-        json.map do |dependency|
-          {
-            name: dependency['name'],
-            version: dependency['version'],
-            type: dependency["type"]
-          }
-        end
+        map_dependencies(manifest, 'cartfile.private')
       end
 
       def self.parse_cartfile_resolved(manifest)
-        response = Typhoeus.post("https://carthageparser.herokuapp.com/cartfile.resolved", params: {body: manifest})
+        map_dependencies(manifest, 'cartfile.resolved')
+      end
+
+      def self.map_dependencies(manifest, path)
+        response = Typhoeus.post("https://carthageparser.herokuapp.com/#{path}", params: {body: manifest})
         json = JSON.parse(response.body)
 
         json.map do |dependency|

data/lib/bibliothecary/parsers/clojars.rb

@@ -6,13 +6,10 @@ module Bibliothecary
     class Clojars
       include Bibliothecary::Analyser
 
-      def self.parse(filename, path)
-        if filename.match(/^project\.clj$/)
-          file_contents = File.open(path).read
-          parse_manifest(file_contents)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /^project\.clj$/ => :parse_manifest
+        }
       end
 
       def self.parse_manifest(manifest)

data/lib/bibliothecary/parsers/cocoapods.rb

@@ -9,29 +9,17 @@ module Bibliothecary
       NAME_VERSION = '(?! )(.*?)(?: \(([^-]*)(?:-(.*))?\))?'.freeze
       NAME_VERSION_4 = /^ {4}#{NAME_VERSION}$/
 
-      def self.parse(filename, path)
-        if filename.match(/^Podfile$/)
-          file_contents = File.open(path).read
-          manifest = Gemnasium::Parser.send(:podfile, file_contents)
-          parse_manifest(manifest)
-        elsif filename.match(/^[A-Za-z0-9_-]+\.podspec$/)
-          file_contents = File.open(path).read
-          manifest = Gemnasium::Parser.send(:podspec, file_contents)
-          parse_manifest(manifest)
-        elsif filename.match(/^Podfile\.lock$/)
-          file_contents = File.open(path).read
-          manifest = YAML.load file_contents
-          parse_podfile_lock(manifest)
-        elsif filename.match(/^[A-Za-z0-9_-]+\.podspec.json$/)
-          file_contents = File.open(path).read
-          json = JSON.parse(file_contents)
-          parse_json_manifest(json)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /^Podfile$/ => :parse_podfile,
+          /^[A-Za-z0-9_-]+\.podspec$/ => :parse_podspec,
+          /^Podfile\.lock$/ => :parse_podfile_lock,
+          /^[A-Za-z0-9_-]+\.podspec.json$/ => :parse_json_manifest
+        }
       end
 
-      def self.parse_podfile_lock(manifest)
+      def self.parse_podfile_lock(file_contents)
+        manifest = YAML.load file_contents
         manifest['PODS'].map do |row|
           pod = row.is_a?(String) ? row : row.keys.first
           match = pod.match(/(.+?)\s\((.+?)\)/i)
@@ -43,17 +31,18 @@ module Bibliothecary
         end.compact
       end
 
-      def self.parse_manifest(manifest)
-        manifest.dependencies.inject([]) do |deps, dep|
-          deps.push({
-            name: dep.name,
-            requirement: dep.requirement.to_s,
-            type: dep.type
-          })
-        end.uniq
+      def self.parse_podspec(file_contents)
+        manifest = Gemnasium::Parser.send(:podspec, file_contents)
+        parse_ruby_manifest(manifest)
+      end
+
+      def self.parse_podfile(file_contents)
+        manifest = Gemnasium::Parser.send(:podfile, file_contents)
+        parse_ruby_manifest(manifest)
       end
 
-      def self.parse_json_manifest(manifest)
+      def self.parse_json_manifest(file_contents)
+        manifest = JSON.parse(file_contents)
         manifest['dependencies'].inject([]) do |deps, dep|
           deps.push({
             name: dep[0],

data/lib/bibliothecary/parsers/cpan.rb

@@ -6,27 +6,22 @@ module Bibliothecary
     class CPAN
       include Bibliothecary::Analyser
 
-      def self.parse(filename, path)
-        if filename.match(/^META\.json$/i)
-          file_contents = File.open(path).read
-          json = JSON.parse file_contents
-          parse_json_manifest(json)
-        elsif filename.match(/^META\.yml$/i)
-          file_contents = File.open(path).read
-          yaml = YAML.load file_contents
-          parse_yaml_manifest(yaml)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /^META\.json$/i => :parse_json_manifest,
+          /^META\.yml$/i => :parse_yaml_manifest
+        }
       end
 
-      def self.parse_json_manifest(manifest)
-        manifest['prereqs'].map do |group, deps|
+      def self.parse_json_manifest(file_contents)
+        manifest = JSON.parse file_contents
+        manifest['prereqs'].map do |_group, deps|
           map_dependencies(deps, 'requires', 'runtime')
         end.flatten
       end
 
-      def self.parse_yaml_manifest(manifest)
+      def self.parse_yaml_manifest(file_contents)
+        manifest = YAML.load file_contents
         map_dependencies(manifest, 'requires', 'runtime')
       end
 

data/lib/bibliothecary/parsers/cran.rb

@@ -7,17 +7,14 @@ module Bibliothecary
 
       REQUIRE_REGEXP = /([a-zA-Z0-9\-_\.]+)\s?\(?([><=\s\d\.,]+)?\)?/
 
-      def self.parse(filename, path)
-        if filename.match(/^DESCRIPTION$/i)
-          file_contents = File.open(path).read
-          control = DebControl::ControlFileBase.parse(file_contents)
-          parse_description(control)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /^DESCRIPTION$/i => :parse_description
+        }
       end
 
-      def self.parse_description(manifest)
+      def self.parse_description(file_contents)
+        manifest = DebControl::ControlFileBase.parse(file_contents)
         parse_section(manifest, 'Depends') +
         parse_section(manifest, 'Imports') +
         parse_section(manifest, 'Suggests') +
@@ -26,7 +23,7 @@ module Bibliothecary
 
       def self.parse_section(manifest, name)
         return [] unless manifest.first[name]
-        deps = manifest.first[name].gsub("\n", '').split(',').map(&:strip)
+        deps = manifest.first[name].delete("\n").split(',').map(&:strip)
         deps.map do |dependency|
           dep = dependency.match(REQUIRE_REGEXP)
           {

data/lib/bibliothecary/parsers/dub.rb

@@ -6,20 +6,15 @@ module Bibliothecary
     class Dub
       include Bibliothecary::Analyser
 
-      def self.parse(filename, path)
-        if filename.match(/^dub\.json$/)
-          file_contents = File.open(path).read
-          json = JSON.parse(file_contents)
-          parse_manifest(json)
-        elsif filename.match(/^dub\.sdl$/)
-          file_contents = File.open(path).read
-          parse_sdl_manifest(file_contents)
-        else
-          []
-        end
+      def self.mapping
+        {
+          /^dub\.json$/ => :parse_manifest,
+          /^dub\.sdl$/ => :parse_sdl_manifest
+        }
       end
 
-      def self.parse_manifest(manifest)
+      def self.parse_manifest(file_contents)
+        manifest = JSON.parse(file_contents)
         map_dependencies(manifest, 'dependencies', 'runtime')
       end