codeclimate-services 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5743e344af855362cf8d9de84add9de905ddef4
-  data.tar.gz: 30a6496f74f2ab59c32bacf37435ebf2a85c5649
+  metadata.gz: 08767ab67555c51f2f492eea001853158febb41b
+  data.tar.gz: f097a06a711a69a01014dc8775bc99f2176bd028
 SHA512:
-  metadata.gz: 8fceef45fc66347e24f12790454d427be003e8fbdc3dec77849d8c3b0692323b1e56439bcd6baf9fce75859e6a8971607edaba0f9281ff860777c5e6f631d13a
-  data.tar.gz: 404ea8ec662df618b3a8e7e0077dbeb79cbdde38f4899c7c07edc8b921c6d1223537da59c023666d038cbf7a5467453820f2be788e54b87faf5904a157de0da3
+  metadata.gz: a668a902b808e680c2a0a350506313dcd87b12cbce904d634197c5a109be59a6f6009801dafd841d7df3d69fe7aa6bd2dd7a00c75d8cb067bdebf77c332340a6
+  data.tar.gz: fe1911f20809ac655ec9b94d8cb35394173a9592bd865d683c4c39ffa63aef3c9aa2867d7e8480bdf99299e00e168d204cb418e4bf1e95f064142f7257bffd9e

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: base_rubocop.yml

data/Gemfile

@@ -1,7 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in codeclimate-services.gemspec
 gemspec
 
 gem "pry"
-gem "codeclimate-test-reporter"

data/Rakefile

@@ -1,11 +1,8 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require "rspec/core/rake_task"
 
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "test"
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.ruby_opts = "-W"
 end
 
-task :default => :test
+task default: :spec

data/base_rubocop.yml

@@ -0,0 +1,152 @@
+################################################################################
+# Metrics
+################################################################################
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+################################################################################
+# Style
+################################################################################
+
+# Executables are conventionally named bin/foo-bar
+Style/FileName:
+  Exclude:
+  - bin/**/*
+
+# We don't (currently) document our code
+Style/Documentation:
+  Enabled: false
+
+# Always use double-quotes to keep things simple
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Use a trailing comma to keep diffs clean when elements are inserted or removed
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+# We avoid GuardClause because it can result in "suprise return"
+Style/GuardClause:
+  Enabled: false
+
+# We avoid IfUnlessModifier because it can result in "suprise if"
+Style/IfUnlessModifier:
+  Enabled: false
+
+# We don't care about the fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Common globals we allow
+Style/GlobalVars:
+  AllowedVariables:
+  - "$statsd"
+  - "$mongo"
+  - "$rollout"
+
+# Using english names requires loading an extra module, which is annoying, so
+# we prefer the perl names for consistency.
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_perl_names
+
+# We have common cases where has_ and have_ make sense
+Style/PredicateName:
+  Enabled: true
+  NamePrefixBlacklist:
+  - is_
+
+# We use %w[ ], not %w( ) because the former looks like an array
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%i": "[]"
+    "%I": "[]"
+    "%w": "[]"
+    "%W": "[]"
+
+# Allow "trivial" accessors when defined as a predicate? method
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+Style/Next:
+  Enabled: false
+
+# We think it's OK to use the "extend self" module pattern
+Style/ModuleFunction:
+  Enabled: false
+
+# Disallow extra spacing for token alignment
+Style/ExtraSpacing:
+  AllowForAlignment: false
+
+# and/or in conditionals has no meaningful difference (only gotchas), so we
+# disallow them there. When used for control flow, the difference in precedence
+# can make for a less noisy expression, as in:
+#
+#   x = find_x or raise XNotFound
+#
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# This has the behavior we want, but it has a bug in it which produces a lot of false positives
+# https://github.com/bbatsov/rubocop/issues/3462
+# MultilineMethodCallBraceLayout:
+#   EnforcedStyle: new_line
+
+################################################################################
+# Performance
+################################################################################
+
+Performance/RedundantMerge:
+  Enabled: false
+
+################################################################################
+# Rails - disable things because we're primarily non-rails
+################################################################################
+
+Rails/Delegate:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+################################################################################
+# Specs - be more lenient on length checks and block styles
+################################################################################
+
+Metrics/ModuleLength:
+  Exclude:
+  - spec/**/*
+
+Metrics/MethodLength:
+  Exclude:
+  - spec/**/*
+
+Style/ClassAndModuleChildren:
+  Exclude:
+  - spec/**/*
+
+Style/BlockDelimiters:
+  Exclude:
+  - spec/**/*

data/bin/bundler

@@ -6,11 +6,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('codeclimate-services', 'bundler')
+load Gem.bin_path("codeclimate-services", "bundler")

data/bin/coderay

@@ -6,11 +6,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('coderay', 'coderay')
+load Gem.bin_path("coderay", "coderay")

data/bin/nokogiri

@@ -6,11 +6,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('nokogiri', 'nokogiri')
+load Gem.bin_path("nokogiri", "nokogiri")

data/bin/pry

@@ -6,11 +6,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('pry', 'pry')
+load Gem.bin_path("pry", "pry")

data/bin/rake

@@ -6,11 +6,11 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
   Pathname.new(__FILE__).realpath)
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('codeclimate-services', 'rake')
+load Gem.bin_path("codeclimate-services", "rake")

data/codeclimate-services.gemspec

@@ -1,20 +1,20 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cc/services/version'
+lib = File.expand_path("../lib", __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require "cc/services/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "codeclimate-services"
-  spec.version       = CC::Services::VERSION
-  spec.authors       = ["Bryan Helmkamp"]
-  spec.email         = ["bryan@brynary.com"]
-  spec.summary       = %q{Service classes for Code Climate}
-  spec.description   = %q{Service classes for Code Climate}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.name = "codeclimate-services"
+  spec.version = CC::Services::VERSION
+  spec.authors = ["Bryan Helmkamp"]
+  spec.email = ["bryan@brynary.com"]
+  spec.summary = "Service classes for Code Climate"
+  spec.description = "Service classes for Code Climate"
+  spec.homepage = ""
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files`.split($/)
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", "0.8.8"
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activemodel", ">= 3.0"
   spec.add_dependency "activesupport", ">= 3.0"
   spec.add_development_dependency "bundler", ">= 1.6.2"
+  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "test-unit"
-  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rspec"
 end

data/config/load.rb

@@ -1,4 +1,4 @@
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
 require File.expand_path("../../lib/cc/services", __FILE__)

data/lib/cc/formatters/linked_formatter.rb

@@ -8,7 +8,7 @@ module CC
 
       def format_coverage
         message = message_prefix
-        message << "#{format_link(details_url, "Test coverage")}"
+        message << format_link(details_url, "Test coverage").to_s
         message << " has #{changed} to #{covered_percent}% (#{delta})"
 
         if compare_url
@@ -20,7 +20,7 @@ module CC
 
       def format_quality
         message = message_prefix
-        message << "#{format_link(details_url, constant_name)}"
+        message << format_link(details_url, constant_name).to_s
         message << " has #{changed} from #{previous_rating} to #{rating}"
 
         if compare_url

data/lib/cc/formatters/snapshot_formatter.rb

@@ -21,7 +21,7 @@ module CC::Formatters
       end
 
       def inspect
-        "<Rating:#{to_s}>"
+        "<Rating:#{self}>"
       end
 
       def to_s
@@ -52,25 +52,25 @@ module CC::Formatters
 
         data = {
           "from" => { "commit_sha" => payload["previous_commit_sha"] },
-          "to"   => { "commit_sha" => payload["commit_sha"] }
+          "to"   => { "commit_sha" => payload["commit_sha"] },
         }
 
-        @alert_constants_payload    = data.merge("constants" => alert_constants) if alert_constants.any?
+        @alert_constants_payload = data.merge("constants" => alert_constants) if alert_constants.any?
         @improved_constants_payload = data.merge("constants" => improved_constants) if improved_constants.any?
       end
 
-    private
+      private
 
       def new_constants_selector
-        Proc.new { |constant| to_rating(constant) < C }
+        proc { |constant| to_rating(constant) < C }
       end
 
       def decreased_constants_selector
-        Proc.new { |constant| from_rating(constant) > D && to_rating(constant) < C }
+        proc { |constant| from_rating(constant) > D && to_rating(constant) < C }
       end
 
       def improved_constants_selector
-        Proc.new { |constant| from_rating(constant) < C && to_rating(constant) > from_rating(constant) }
+        proc { |constant| from_rating(constant) < C && to_rating(constant) > from_rating(constant) }
       end
 
       def to_rating(constant)
@@ -86,15 +86,15 @@ module CC::Formatters
     # This is useful to show more information for testing the service.
     class Sample < Base
       def new_constants_selector
-        Proc.new { |_| true }
+        proc { |_| true }
       end
 
       def decreased_constants_selector
-        Proc.new { |constant| to_rating(constant) < from_rating(constant) }
+        proc { |constant| to_rating(constant) < from_rating(constant) }
       end
 
       def improved_constants_selector
-        Proc.new { |constant| to_rating(constant) > from_rating(constant) }
+        proc { |constant| to_rating(constant) > from_rating(constant) }
       end
     end
   end

data/lib/cc/formatters/ticket_formatter.rb

@@ -1,7 +1,6 @@
 module CC
   module Formatters
     class TicketFormatter < CC::Service::Formatter
-
       def format_vulnerability_title
         if multiple?
           "#{vulnerabilities.size} new #{warning_type} issues found"
@@ -21,7 +20,6 @@ module CC
         message << ".\n\n"
         message << details_url
       end
-
     end
   end
 end

data/lib/cc/helpers/quality_helper.rb

@@ -32,10 +32,10 @@ module CC::Service::QualityHelper
   end
 
   def with_article(letter, bold = false)
-    letter ||= '?'
+    letter ||= "?"
 
     text = bold ? "*#{letter}*" : letter
-    if %w( A F ).include?(letter.to_s)
+    if %w[A F].include?(letter.to_s)
       "an #{text}"
     else
       "a #{text}"