danger-clorox 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99c9aa689fb59ed8d38855f1cf54c693e67b3687
+  data.tar.gz: ad581855f505ec8341b292cf47ec8451e482a620
+SHA512:
+  metadata.gz: a16eb5f79c13def553f4e2b973f59903f318be85de34e59c379bbd1760dcb5f3351933cf2178230387f4134dccb2c21662f48c2bed10cb10ab0d3e4bb91bc521
+  data.tar.gz: 56c2ec0c04c50c484a8bbac5ee03acb02685c23ee334c1e38ae17588a3bc57b491fb7fd9eefb2be9a4ebb99e1e5aea33a18fb2246a9ed236ec08bea40e3b2369

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'mocha'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'prettybacon'
+end

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    danger-swiftlint (0.0.1)
+      danger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    bacon (1.2.0)
+    claide (1.0.0)
+    coderay (1.1.1)
+    colored (1.2)
+    cork (0.1.0)
+      colored (~> 1.2)
+    danger (0.8.4)
+      claide (~> 1.0)
+      colored (~> 1.2)
+      cork (~> 0.1)
+      faraday (~> 0)
+      git (~> 1)
+      octokit (~> 4.2)
+      redcarpet (~> 3.3)
+      terminal-table (~> 1)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    git (1.3.0)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.2)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    mocha-on-bacon (0.2.2)
+      mocha (>= 0.13.0)
+    multipart-post (2.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.0)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.3.0)
+      sawyer (~> 0.7.0, >= 0.5.3)
+    prettybacon (0.0.2)
+      bacon (~> 1.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    redcarpet (3.3.4)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sawyer (0.7.0)
+      addressable (>= 2.3.5, < 2.5)
+      faraday (~> 0.8, < 0.10)
+    shellany (0.0.1)
+    slop (3.6.0)
+    terminal-table (1.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  bundler (~> 1.3)
+  danger-swiftlint!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  mocha
+  mocha-on-bacon
+  prettybacon
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.12.5

data/Guardfile

@@ -0,0 +1,21 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ash Furrow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# Danger Clorox
+
+A [Danger](https://github.com/danger/danger) plugin for [Clorox](https://github.com/barbosa/clorox) that runs on macOS.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```rb
+gem 'danger-clorox'
+```
+
+## Usage
+
+The easiest way to use is just add this to your Dangerfile:
+
+```rb
+clorox.check_files
+```
+
+## Attribution
+
+Original structure, sequence, and organization of repo taken from [danger-prose](https://github.com/dbgrandi/danger-prose) by [David Grandinetti](https://github.com/dbgrandi/).
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :spec do
+  Rake::Task['specs'].invoke
+end
+
+task :default => :spec
+

data/danger-clorox.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-clorox'
+  spec.version       = DangerClorox::VERSION
+  spec.authors       = ['Gustavo Barbosa']
+  spec.email         = ['gustavocsb@gmail.com']
+  spec.description   = %q{A Danger plugin for checking presence of file header comments.}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/barbosa/danger-clorox'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'danger'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  #  Testing support
+  spec.add_development_dependency "rspec", '~> 3.4'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency "guard", '~> 2.14'
+  spec.add_development_dependency "guard-rspec", '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency "listen", '3.0.7'
+
+  # This gives you the chance to run a REPL inside your test
+  # via
+  #    binding.pry
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency "pry"
+
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,60 @@
+module Danger
+
+
+  class DangerClorox < Plugin
+
+    # Checks presence of file header comments. Will fail if `clorox` cannot be installed correctly.
+    # Generates a `markdown` list of dirty Objective-C and Swift files
+    #
+    # @param   [String] files
+    #          A globbed string which should return the files that you want to check, defaults to nil.
+    #          if nil, modified and added files from the diff will be used.
+    # @return  [void]
+    #
+    def check_files(files=nil)
+      # Installs clorox if needed
+      system "pip install --target /tmp/danger_clorox clorox" unless clorox_installed?
+
+      # Check that this is in the user's PATH after installing
+      unless clorox_installed?
+        fail "clorox is not in the user's PATH, or it failed to install"
+        return
+      end
+
+      # Either use files provided, or use the modified + added
+      files = files ? Dir.glob(files) : (git.modified_files + git.added_files).uniq
+
+      require 'json'
+      result = JSON.parse(`python /tmp/danger_clorox/clorox/clorox.py -p #{files.join(" ")} -i -r json`)
+
+      message = ''
+      if result['status'] == 'dirty'
+        message = "### Clorox has found issues\n"
+        message << "Please, remove the header from the files below (those comments on the top of your file):\n\n"
+        message << parse_results(result['files'])
+        markdown message
+      end
+    end
+
+    # Parses clorox invocation results into a string
+    # which is formatted as a markdown table.
+    #
+    # @return  [String]
+    #
+    def parse_results(results)
+      message = ""
+      results.each do |r|
+        message << "- #{r} :hankey:\n"
+      end
+
+      message
+    end
+
+    # Determine if clorox is currently installed in the system paths.
+    # @return  [Bool]
+    #
+    def clorox_installed?
+      Dir.exists? "/tmp/danger_clorox"
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module DangerClorox
+  VERSION = "0.0.1".freeze
+end

data/spec/danger_plugin_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Danger
+  describe DangerClorox do
+    it 'is a plugin' do
+      expect(Danger::DangerClorox < Danger::Plugin).to be_truthy
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @clorox = testing_dangerfile.clorox
+      end
+
+      it "handles clorox not being installed" do
+        allow(@clorox).to receive(:`).with("which clorox").and_return("")
+        expect(@clorox.clorox_installed?).to be_falsy
+      end
+
+      it "handles clorox being installed" do
+        allow(@clorox).to receive(:`).with("which clorox").and_return("/bin/wherever/clorox")
+        expect(@clorox.clorox_installed?).to be_truthy
+      end
+
+      describe :lint_files do
+        before do
+          # So it doesn't try to install on your computer
+          allow(@clorox).to receive(:`).with("which clorox").and_return("/bin/wheverever/clorox")
+
+          # Set up our stubbed JSON response
+          @clorox_response = '[{"reason": "Force casts should be avoided.", "file": "/User/me/this_repo/spec/fixtures/SwiftFile.swift", "line": 13, "severity": "Error" }]'
+        end
+
+        it 'handles a known Clorox report' do
+          allow(@clorox).to receive(:`).with('clorox lint --quiet --reporter json --path spec/fixtures/SwiftFile.swift').and_return(@clorox_response)
+
+          # Do it
+          @clorox.lint_files("spec/fixtures/*.swift")
+
+          output = @clorox.status_report[:markdowns].first
+
+          expect(output).to_not be_empty
+
+          # A title
+          expect(output).to include("Clorox found issues")
+          # A warning
+          expect(output).to include("SwiftFile.swift | 13 | Force casts should be avoided.")
+        end
+
+        it 'handles no files' do
+          allow(@clorox).to receive(:modified_files).and_return('spec/fixtures/SwiftFile.swift')
+          allow(@clorox).to receive(:`).with('clorox lint --quiet --reporter json --path spec/fixtures/SwiftFile.swift').and_return(@clorox_response)
+
+          @clorox.lint_files("spec/fixtures/*.swift")
+
+          expect(@clorox.status_report[:markdowns].first).to_not be_empty
+        end
+
+      end
+    end
+  end
+end

data/spec/fixtures/SwiftFile.swift

@@ -0,0 +1 @@
+// This file intentional left blank-ish.

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'pathname'
+
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+RSpec.configure do |config|
+ # Use color in STDOUT
+  config.color = true
+end
+
+require 'bundler/setup'
+require 'pry'
+
+require 'danger'
+require 'cork'
+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
+def testing_ui
+  Cork::Board.new(silent: true)
+end
+
+# 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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: danger-clorox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Barbosa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Danger plugin for checking presence of file header comments.
+email:
+- gustavocsb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- danger-clorox.gemspec
+- lib/danger_plugin.rb
+- lib/version.rb
+- spec/danger_plugin_spec.rb
+- spec/fixtures/SwiftFile.swift
+- spec/spec_helper.rb
+homepage: https://github.com/barbosa/danger-clorox
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Danger plugin for checking presence of file header comments.
+test_files:
+- spec/danger_plugin_spec.rb
+- spec/fixtures/SwiftFile.swift
+- spec/spec_helper.rb
+has_rdoc: