license_finder 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfcc32451073719f18ccbd51a98c62a8a741500f
-  data.tar.gz: 5d51cb13de5f31a9b994ec5259850432b7ad5b6d
+  metadata.gz: d990fb1780e04248b610182ed8462f373566c55f
+  data.tar.gz: dcf2f4bf1333eab01c97c3f94dee4fda031250d0
 SHA512:
-  metadata.gz: 1bf9e97e40975279f6e3a8b7920093be14084b7ac3cfb668e54ee1429b03e825a8d5120877959df8e626e82a5882a84c5f7109c599919fcf1af4cf159b1ea647
-  data.tar.gz: bea4e4ad49d7567e2650bac22d018f3361868a7d8eaf4e2d6f35d4c7958db902c9e18aa007221ad59395a058bcff3fdaf6410178fac96d696c3e7fe1c6e988e4
+  metadata.gz: bb4c5f49e5e9acf40a7d614e5bc9db7800b62216fa7e1090e943ac2ff241f4102d5355a14f8d57aa348ab077eea6b912b0024fe629dc69a63b0ac7fbedaefd52
+  data.tar.gz: 8911df07b9c74ada47fafd4b506d6877d758d2299972fe93d9177352bd95aa7ff59b98245321db8277c28ca4ca26789f8ac5bc24586a0d93b57d6c779c5de488

data/.travis.yml

@@ -12,7 +12,7 @@ matrix:
     - rvm: jruby-head
 
 env:
-  - PATH=$PATH:$HOME/gradle/bin
+  - PATH=$PATH:$HOME/gradle/bin:$HOME/rebar
 
 notifications:
   email:
@@ -27,8 +27,12 @@ before_install:
   - pip --version
   - cd /tmp
   - wget http://services.gradle.org/distributions/gradle-1.11-all.zip
+  - wget https://raw.github.com/wiki/rebar/rebar/rebar
   - unzip -q gradle*
   - rm gradle*.zip
   - mv gradle* ~/gradle
+  - mkdir ~/rebar
+  - mv rebar ~/rebar/
+  - chmod u+x ~/rebar/rebar
   - npm install -g bower
   - cd -

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+=== 2.0.1 / 2015-03-02
+
+* Features
+
+  * Support for rebar projects
+
 === 2.0.0 / 2015-03-02
 
 * Features

data/README.md

@@ -25,6 +25,7 @@ report.
 
 * Java (via `maven`)
 * Java (via `gradle`)
+* Erlang (via `rebar`)
 * Objective-C (+ CocoaPods)
 
 
@@ -95,6 +96,7 @@ languages, as long as that language has a package definition in the project dire
 * `build.gradle` (for `gradle`)
 * `bower.json` (for `bower`)
 * `Podfile` (for CocoaPods)
+* `rebar.config` (for `rebar`)
 
 
 ### Continuous Integration
@@ -156,11 +158,8 @@ any other decision about your project.
 
 ### Decisions file
 
-Any decisions you make about approvals will be recorded in a YAML file.  Be
-default, `license_finder` expects it to be named
-`doc/dependency_decisions.yml`.  All commands can be passed `--decisions_file`
-to override this location.  See [Configuration](#configuration) for other
-options.
+Any decisions you make about approvals will be recorded in a YAML file named
+`doc/dependency_decisions.yml`.
 
 This file must be committed to version control.  Rarely, you will have to
 manually resolve conflicts in it.  In this situation, keep in mind that each
@@ -259,6 +258,23 @@ machine.  Adding it to the `ignored_dependencies` would prevent it
 
 ## Configuration
 
+Be default, `license_finder` expects the decisions file to be stored at
+`doc/dependency_decisions.yml`.  All commands can be passed `--decisions_file`
+to override this location.
+
+### Of Package Managers
+
+If you have a gradle project, you can invoke gradle with a custom script by
+passing (for example) `--gradle_command gradlew` to `license_finder` or
+`license_finder report`.
+
+
+Similarly you can invoke a custom rebar script with `--rebar_command rebar2`.
+If you store rebar dependencies in a custom directory (by setting `deps_dir` in
+`rebar.config`), set `--rebar_deps_dir`.
+
+### Saving Configuration
+
 It may be difficult to remember to pass command line options to every command.
 In some of these cases you can store default values in a YAML formatted config
 file. `license_finder` looks for this file in `config/license_finder.yml`.
@@ -269,22 +285,15 @@ As an example, the file might look like this:
 ---
 decisions_file: './some_path/decisions.yml'
 gradle_command: './gradlew'
+rebar_command: './rebarw'
+rebar_deps_dir: './rebar_deps'
 ```
 
-If you set `decisions_file`, you won't have to pass it to every CLI command.
-
-Read on to learn about how `gradle_command` is used on gradle projects.
-
 ### Gradle Projects
 
 You need to install the license gradle plugin:
 [https://github.com/hierynomus/license-gradle-plugin](https://github.com/hierynomus/license-gradle-plugin)
 
-LicenseFinder assumes that gradle is in your shell's command path and can be
-invoked by just calling `gradle`.  If you must invoke gradle some other way
-(e.g., with a custom `gradlew` script), pass `--gradle_command` to
-`license_finder` or `license_finder report`.
-
 By default, `license_finder` will report on gradle's "runtime" dependencies. If
 you want to generate a report for some other dependency configuration (e.g.
 Android projects will sometimes specify their meaningful dependencies in the

data/Rakefile

@@ -31,7 +31,8 @@ task :check_dependencies do
     "npm" => "node.js",
     "pip" => "Python",
     "gradle" => "Gradle",
-    "bower" => "Bower"
+    "bower" => "Bower",
+    "rebar" => "Rebar"
   }
   dependencies["pod"] = "Cocoapods" if LicenseFinder::Platform.darwin?
   satisfied = true

data/features/features/package_managers/rebar_spec.rb

@@ -0,0 +1,14 @@
+require 'feature_helper'
+
+describe "Rebar Dependencies" do
+  # As an Erlang developer
+  # I want to be able to manage rebar dependencies
+
+  let(:erlang_developer) { LicenseFinder::TestingDSL::User.new }
+
+  specify "are shown in reports" do
+    LicenseFinder::TestingDSL::RebarProject.create
+    erlang_developer.run_license_finder
+    expect(erlang_developer).to be_seeing_line "envy, \"BRANCH: master\", \"Apache 2.0\""
+  end
+end

data/features/fixtures/rebar.config

@@ -0,0 +1,12 @@
+%% -*- mode: erlang -*-
+%% -*- tab-width: 4;erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 ft=erlang et
+
+{erl_opts, [warnings_as_errors, {parse_transform, lager_transform}, debug_info]}.
+
+{deps,
+ [
+    {envy, ".*",
+         {git, "git://github.com/manderson26/envy.git", {branch, "master"}}}
+ ]
+}.

data/features/support/testing_dsl.rb

@@ -133,6 +133,16 @@ module LicenseFinder::TestingDSL
     end
   end
 
+  class RebarProject < Project
+    def add_dep
+      install_fixture("rebar.config")
+    end
+
+    def install
+      shell_out("rebar get-deps")
+    end
+  end
+
   class BundlerProject < Project
     def add_dep
       add_to_bundler('license_finder', path: Paths.root.to_s)

data/lib/license_finder/cli/base.rb

@@ -18,7 +18,7 @@ module LicenseFinder
       end
 
       def license_finder_config
-        result = extract_options(:decisions_file, :gradle_command)
+        result = extract_options(:decisions_file, :gradle_command, :rebar_command, :rebar_deps_dir)
         result[:logger] = logger_config
         result[:project_path] = Pathname.pwd
         result

data/lib/license_finder/cli/main.rb

@@ -16,6 +16,8 @@ module LicenseFinder
       class_option :format, desc: "The desired output format.", default: 'text', enum: FORMATS.keys
       class_option :columns, type: :array, desc: "For CSV reports, which columns to print. Pick from: #{CsvReport::AVAILABLE_COLUMNS}", default: %w[name version licenses]
       class_option :gradle_command, desc: "Command to use when fetching gradle packages. Only meaningful if used with a Java/gradle project. Defaults to 'gradle'."
+      class_option :rebar_command, desc: "Command to use when fetching rebar packages. Only meaningful if used with a Erlang/rebar project. Defaults to 'rebar'."
+      class_option :rebar_deps_dir, desc: "Path to rebar dependencies directory. Only meaningful if used with a Erlang/rebar project. Defaults to 'deps'."
 
       method_option :quiet, type: :boolean, desc: "silences progress report"
       method_option :debug, type: :boolean, desc: "emit detailed info about what LicenseFinder is doing"

data/lib/license_finder/configuration.rb

@@ -15,6 +15,14 @@ module LicenseFinder
       get(:gradle_command) || "gradle"
     end
 
+    def rebar_command
+      get(:rebar_command) || "rebar"
+    end
+
+    def rebar_deps_dir
+      get(:rebar_deps_dir) || "deps"
+    end
+
     def decisions_file
       file_name = get(:decisions_file) || "doc/dependency_decisions.yml"
       Pathname(file_name)

data/lib/license_finder/core.rb

@@ -59,8 +59,10 @@ module LicenseFinder
       PackageManager.current_packages(
         logger: logger,
         project_path: project_path,
+        ignore_groups: decisions.ignored_groups,
         gradle_command: config.gradle_command,
-        ignore_groups: decisions.ignored_groups
+        rebar_command: config.rebar_command,
+        rebar_deps_dir: config.rebar_deps_dir,
       )
     end
   end

data/lib/license_finder/package.rb

@@ -127,3 +127,4 @@ require 'license_finder/package_managers/npm_package'
 require 'license_finder/package_managers/maven_package'
 require 'license_finder/package_managers/gradle_package'
 require 'license_finder/package_managers/cocoa_pods_package'
+require 'license_finder/package_managers/rebar_package'

data/lib/license_finder/package_manager.rb

@@ -13,7 +13,7 @@ module LicenseFinder
   #
   class PackageManager
     def self.package_managers
-      [Bundler, NPM, Pip, Bower, Maven, Gradle, CocoaPods]
+      [Bundler, NPM, Pip, Bower, Maven, Gradle, CocoaPods, Rebar]
     end
 
     def self.current_packages(options)
@@ -57,5 +57,6 @@ require 'license_finder/package_managers/pip'
 require 'license_finder/package_managers/maven'
 require 'license_finder/package_managers/cocoa_pods'
 require 'license_finder/package_managers/gradle'
+require 'license_finder/package_managers/rebar'
 
 require 'license_finder/package'

data/lib/license_finder/package_managers/rebar.rb

@@ -0,0 +1,42 @@
+module LicenseFinder
+  class Rebar < PackageManager
+    def initialize(options={})
+      super
+      @command = options[:rebar_command] || "rebar"
+      @deps_path = Pathname(options[:rebar_deps_dir] || "deps")
+    end
+
+    def current_packages
+      rebar_ouput.map do |name, version_type, version_value, homepage|
+        RebarPackage.new(
+          name,
+          "#{version_type}: #{version_value}",
+          install_path: @deps_path.join(name),
+          homepage: homepage,
+          logger: logger
+        )
+      end
+    end
+
+    private
+
+    def rebar_ouput
+      command = "#{@command} list-deps"
+      output, success = capture(command)
+      raise "Command #{command} failed to execute: #{output}" unless success
+
+      output
+        .each_line
+        .reject { |line| line.start_with?("=") }
+        .map { |line| line.split(" ") }
+    end
+
+    def capture(command)
+      [`#{command}`, $?.success?]
+    end
+
+    def package_path
+      project_path.join('rebar.config')
+    end
+  end
+end

data/lib/license_finder/package_managers/rebar_package.rb

@@ -0,0 +1,4 @@
+module LicenseFinder
+  class RebarPackage < Package
+  end
+end

data/lib/license_finder/version.rb

@@ -1,3 +1,3 @@
 module LicenseFinder
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/fixtures/config/license_finder.yml

@@ -1,3 +1,5 @@
 ---
 decisions_file: './some_path/'
 gradle_command: 'gradlew'
+rebar_command: 'rebar_new'
+rebar_deps_dir: 'some_dir'

data/spec/lib/license_finder/package_managers/rebar_package_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module LicenseFinder
+  describe RebarPackage do
+    subject do
+      described_class.new(
+        "uuid",
+        "TAG: v1.3.2",
+        install_path: "deps/uuid",
+        homepage: "git://github.com/okeuday/uuid.git"
+      )
+    end
+
+    its(:name) { should == "uuid" }
+    its(:version) { should == "TAG: v1.3.2" }
+    its(:summary) { should eq "" }
+    its(:description) { should == "" }
+    its(:homepage) { should == "git://github.com/okeuday/uuid.git" }
+    its(:groups) { should == [] }
+    its(:children) { should == [] }
+    its(:install_path) { should eq "deps/uuid" }
+  end
+end

data/spec/lib/license_finder/package_managers/rebar_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module LicenseFinder
+  describe Rebar do
+    let(:rebar) { Rebar.new }
+    it_behaves_like "a PackageManager"
+
+    output = <<-CMDOUTPUT
+== Sample comment
+uuid TAG v1.3.2 git://github.com/okeuday/uuid.git
+jiffy TAG 0.9.0 https://github.com/davisp/jiffy.git
+    CMDOUTPUT
+
+    describe '.current_packages' do
+      it 'lists all the current packages' do
+        allow(rebar).to receive(:capture).with(/rebar/).and_return([output, true])
+
+        current_packages = rebar.current_packages
+
+        expect(current_packages.map(&:name)).to eq(["uuid", "jiffy"])
+        expect(current_packages.map(&:install_path)).to eq([Pathname("deps/uuid"), Pathname("deps/jiffy")])
+      end
+
+      it "fails when command fails" do
+        allow(rebar).to receive(:capture).with(/rebar/).and_return('Some error', false).once
+        expect { rebar.current_packages }.to raise_error(RuntimeError)
+      end
+
+      it "uses custom rebar command, if provided" do
+        rebar = Rebar.new(rebar_command: "rebarfoo")
+
+        allow(rebar).to receive(:capture).with(/rebarfoo/).and_return([output, true])
+
+        current_packages = rebar.current_packages
+
+        expect(current_packages.map(&:name)).to eq(["uuid", "jiffy"])
+      end
+
+      it "uses custom rebar_deps_dir, if provided" do
+        rebar = Rebar.new(rebar_deps_dir: "foo")
+
+        allow(rebar).to receive(:capture).with(/rebar/).and_return([output, true])
+
+        current_packages = rebar.current_packages
+
+        expect(current_packages.map(&:install_path)).to eq([Pathname("foo/uuid"), Pathname("foo/jiffy")])
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: license_finder
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Jacob Maine
@@ -230,11 +230,13 @@ files:
 - features/features/package_managers/maven_spec.rb
 - features/features/package_managers/npm_spec.rb
 - features/features/package_managers/pip_spec.rb
+- features/features/package_managers/rebar_spec.rb
 - features/features/report/csv_spec.rb
 - features/features/report/html_spec.rb
 - features/fixtures/Podfile
 - features/fixtures/build.gradle
 - features/fixtures/pom.xml
+- features/fixtures/rebar.config
 - features/support/testing_dsl.rb
 - lib/license_finder.rb
 - lib/license_finder/cli.rb
@@ -288,6 +290,8 @@ files:
 - lib/license_finder/package_managers/npm_package.rb
 - lib/license_finder/package_managers/pip.rb
 - lib/license_finder/package_managers/pip_package.rb
+- lib/license_finder/package_managers/rebar.rb
+- lib/license_finder/package_managers/rebar_package.rb
 - lib/license_finder/packages/activation.rb
 - lib/license_finder/packages/license_files.rb
 - lib/license_finder/packages/licensing.rb
@@ -313,6 +317,7 @@ files:
 - spec/fixtures/all_pms/build.gradle
 - spec/fixtures/all_pms/package.json
 - spec/fixtures/all_pms/pom.xml
+- spec/fixtures/all_pms/rebar.config
 - spec/fixtures/all_pms/requirements.txt
 - spec/fixtures/config/license_finder.yml
 - spec/fixtures/license_directory/COPYING
@@ -352,6 +357,8 @@ files:
 - spec/lib/license_finder/package_managers/npm_spec.rb
 - spec/lib/license_finder/package_managers/pip_package_spec.rb
 - spec/lib/license_finder/package_managers/pip_spec.rb
+- spec/lib/license_finder/package_managers/rebar_package_spec.rb
+- spec/lib/license_finder/package_managers/rebar_spec.rb
 - spec/lib/license_finder/package_spec.rb
 - spec/lib/license_finder/packages/activation_spec.rb
 - spec/lib/license_finder/packages/license_files_spec.rb
@@ -404,11 +411,13 @@ test_files:
 - features/features/package_managers/maven_spec.rb
 - features/features/package_managers/npm_spec.rb
 - features/features/package_managers/pip_spec.rb
+- features/features/package_managers/rebar_spec.rb
 - features/features/report/csv_spec.rb
 - features/features/report/html_spec.rb
 - features/fixtures/Podfile
 - features/fixtures/build.gradle
 - features/fixtures/pom.xml
+- features/fixtures/rebar.config
 - features/support/testing_dsl.rb
 - spec/feature_helper.rb
 - spec/fixtures/all_pms/Gemfile
@@ -417,6 +426,7 @@ test_files:
 - spec/fixtures/all_pms/build.gradle
 - spec/fixtures/all_pms/package.json
 - spec/fixtures/all_pms/pom.xml
+- spec/fixtures/all_pms/rebar.config
 - spec/fixtures/all_pms/requirements.txt
 - spec/fixtures/config/license_finder.yml
 - spec/fixtures/license_directory/COPYING
@@ -456,6 +466,8 @@ test_files:
 - spec/lib/license_finder/package_managers/npm_spec.rb
 - spec/lib/license_finder/package_managers/pip_package_spec.rb
 - spec/lib/license_finder/package_managers/pip_spec.rb
+- spec/lib/license_finder/package_managers/rebar_package_spec.rb
+- spec/lib/license_finder/package_managers/rebar_spec.rb
 - spec/lib/license_finder/package_spec.rb
 - spec/lib/license_finder/packages/activation_spec.rb
 - spec/lib/license_finder/packages/license_files_spec.rb