danger-periphery 0.0.1

data/spec/danger_plugin_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerPeriphery do
+    it "should be a plugin" do
+      expect(Danger::DangerPeriphery.new(nil)).to be_a Danger::Plugin
+    end
+
+    context "with Dangerfile" do
+      let(:dangerfile) { testing_dangerfile }
+      let(:periphery) { dangerfile.periphery }
+
+      before do
+        periphery.binary_path = binary("periphery")
+        json = File.read("#{File.dirname(__FILE__)}/support/fixtures/github_pr.json") # example json: `curl https://api.github.com/repos/danger/danger-plugin-template/pulls/18 > github_pr.json`
+        allow(periphery.github).to receive(:pr_json).and_return(json)
+        allow(Pathname).to receive(:getwd).and_return fixtures_path
+      end
+
+      context "when periphery is not installed" do
+        before { periphery.binary_path = "not_installed" }
+
+        it "fails with error" do
+          expect { periphery.scan }.to raise_error Errno::ENOENT
+        end
+      end
+
+      context "when .swift files not in diff" do
+        before do
+          allow(periphery.git).to receive(:renamed_files).and_return []
+          allow(periphery.git).to receive(:modified_files).and_return []
+          allow(periphery.git).to receive(:deleted_files).and_return []
+          allow(periphery.git).to receive(:added_files).and_return []
+        end
+
+        it "reports nothing" do
+          periphery.scan(
+            project: fixture("test.xcodeproj"),
+            targets: "test",
+            schemes: "test"
+          )
+
+          expect(dangerfile.status_report[:warnings]).to be_empty
+        end
+      end
+
+      context "when .swift files were added" do
+        before do
+          allow(periphery.git).to receive(:renamed_files).and_return []
+          allow(periphery.git).to receive(:modified_files).and_return []
+          allow(periphery.git).to receive(:deleted_files).and_return []
+          allow(periphery.git).to receive(:added_files).and_return ["test/main.swift"]
+        end
+
+        it "reports unused code" do
+          periphery.scan(
+            project: fixture("test.xcodeproj"),
+            targets: "test",
+            schemes: "test"
+          )
+
+          expect(dangerfile.status_report[:warnings]).to eq(["Enum 'UnusedEnum' is unused"])
+        end
+      end
+
+      context "when .swift files were modified" do
+        before do
+          allow(periphery.git).to receive(:renamed_files).and_return []
+          allow(periphery.git).to receive(:modified_files).and_return ["test/main.swift"]
+          allow(periphery.git).to receive(:deleted_files).and_return []
+          allow(periphery.git).to receive(:added_files).and_return []
+        end
+
+        it "reports unused code" do
+          periphery.scan(
+            project: fixture("test.xcodeproj"),
+            targets: "test",
+            schemes: "test"
+          )
+
+          expect(dangerfile.status_report[:warnings]).to eq(["Enum 'UnusedEnum' is unused"])
+        end
+      end
+    end
+  end
+end

data/spec/periphery/runner_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "periphery/runner"
+
+module Periphery
+  describe Runner do
+    subject(:runner) { described_class.new(binary_path) }
+
+    let(:binary_path) { binary("periphery") }
+
+    describe "#scan" do
+      subject { runner.scan(options) }
+
+      context "with valid args" do
+        let(:options) do
+          {
+            project: fixture("test.xcodeproj"),
+            targets: "test",
+            schemes: "test"
+          }
+        end
+
+        it "runs scan without args" do
+          expect(subject).to include "warning:"
+        end
+      end
+    end
+
+    describe "#scan_arguments" do
+      subject { runner.scan_arguments(options) }
+
+      context "with empty options" do
+        let(:options) { {} }
+
+        it { is_expected.to be_empty }
+      end
+
+      context "with options that takes no argument" do
+        let(:options) do
+          {
+            clean_build: true,
+            skip_build: true
+          }
+        end
+
+        it "returns correct arguments" do
+          expect(subject).to eq %w(--clean-build --skip-build)
+        end
+      end
+
+      context "with options that takes an argument" do
+        let(:options) do
+          {
+            project: "test.xcodeproj",
+            targets: "test1,test2"
+          }
+        end
+
+        it "returns correct arguments" do
+          expect(subject).to eq %w(--project test.xcodeproj --targets test1,test2)
+        end
+      end
+
+      context "with options that takes an array as argument" do
+        let(:options) do
+          {
+            project: "test.xcodeproj",
+            targets: %w(test1 test2)
+          }
+        end
+
+        it "returns correct arguments" do
+          expect(subject).to eq %w(--project test.xcodeproj --targets test1,test2)
+        end
+      end
+    end
+  end
+end

data/spec/periphery/scan_log_parser_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "periphery/scan_log_parser"
+
+module Periphery
+  describe ScanLogParser do
+    describe "#parse" do
+      subject { described_class.new.parse(string) }
+
+      context "with empty string" do
+        let(:string) { "" }
+
+        it { is_expected.to be_empty }
+      end
+
+      context "with a valid string" do
+        let(:string) do
+          <<~LOG
+          * Inspecting project...
+          * Building danger-periphery...
+          * Indexing...
+          * Analyzing...
+
+          /Users/manicmaniac/danger-periphery/main.swift:1:1: warning: Typealias 'UnusedTypeAlias' is unused
+          /Users/manicmaniac/danger-periphery/main.swift:2:1: warning: Class 'UnusedClass' is unused
+          /Users/manicmaniac/danger-periphery/main.swift:3:1: warning: Protocol 'UnusedProtocol' is unused
+
+          * Seeing false positives?
+          - Periphery only analyzes files that are members of the targets you specify.
+            References to declarations identified as unused may reside in files that are members of other targets, e.g test targets.
+          - By default, Periphery does not assume that all public declarations are in use.
+            You can instruct it to do so with the --retain-public option.
+          - Periphery is a very precise tool, false positives often turn out to be correct after further investigation.
+          - If it really is a false positive, please report it - https://github.com/peripheryapp/periphery/issues.
+          LOG
+        end
+
+        before { allow(Pathname).to receive(:getwd).and_return Pathname.new("/Users/manicmaniac/danger-periphery") }
+
+        it "parses all warnings without garbages" do
+          expect(subject).to eq [
+            ScanLogEntry.new("main.swift", 1, 1, "Typealias 'UnusedTypeAlias' is unused"),
+            ScanLogEntry.new("main.swift", 2, 1, "Class 'UnusedClass' is unused"),
+            ScanLogEntry.new("main.swift", 3, 1, "Protocol 'UnusedProtocol' is unused")
+          ]
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift("#{ROOT}lib".to_s)
+$:.unshift("#{ROOT}spec".to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end
+
+def fixtures_path
+  Pathname.new("../support/fixtures").expand_path(__FILE__)
+end
+
+def fixture(filename)
+  fixtures_path.join(filename).to_s
+end
+
+def binaries_path
+  Pathname.new("../../bin").expand_path(__FILE__)
+end
+
+def binary(filename)
+  binaries_path.join(filename).to_s
+end