rubocop-mirego 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 092aa7b1f465b752fe8c6416f871767fb643f3ac
+  data.tar.gz: b836c8a3674b77bf3be615b4cb4016ff13c7900b
+SHA512:
+  metadata.gz: e2f3a991ac5820e2a8a46fe545337688bc7f53099fd596584da84a736dc3e83c22493c686701c96948aba823d652e0b1732e3409443db120161ddc5a86aa7fe3
+  data.tar.gz: faf7cfb1f81200f7b2d24b12af3e121d5fef1b9b7e4d9ec2ea8d864cffb5592b1797a3b7428ed47b67aa30e8b1a413324fddc2149f653b0173ba37d32dee7b4e

data/.rubocop.yml

@@ -0,0 +1,72 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.1
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ParameterLists:
+  CountKeywordArgs: false
+
+SingleLineBlockParams:
+  Methods:
+    - reduce:
+      - memo
+      - item
+
+MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/ExtraSpacing:
+  Enabled: true
+
+RSpec/DescribedClass:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+# Use Travis container-based infrastructure
+sudo: false
+
+# Ruby baby!
+language: 'ruby'
+
+# Only build on our Ruby version
+rvm:
+  - '2.3.0'
+
+script:
+  - 'echo "Checking code style" && bundle exec phare'
+  - 'echo "Running tests" && bundle exec rspec'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    rubocop-mirego (0.0.2)
+      rubocop (= 0.39.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.2.0)
+    diff-lcs (1.2.5)
+    parser (2.3.0.7)
+      ast (~> 2.2)
+    phare (0.7.1)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.39.0)
+      parser (>= 2.3.0.7, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.4.1)
+      rubocop (= 0.39.0)
+    ruby-progressbar (1.7.5)
+    unicode-display_width (1.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  phare (~> 0.7)
+  rspec (~> 3.4)
+  rubocop-mirego!
+  rubocop-rspec (~> 1.4, >= 1.4.1)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1 @@
+## Rubocop-mirego

data/config/default.yml

@@ -0,0 +1,5 @@
+Mirego/ReceiveCounts:
+  Enabled: true
+
+Mirego/ExplicitReturnValue:
+  Enabled: true

data/lib/rubocop-mirego.rb

@@ -0,0 +1,9 @@
+require 'rubocop'
+
+require 'rubocop/mirego/version'
+require 'rubocop/mirego/inject'
+
+RuboCop::Mirego::Inject.defaults!
+
+require 'rubocop/cop/mirego/receive_counts'
+require 'rubocop/cop/mirego/explicit_return_value'

data/lib/rubocop/cop/mirego/explicit_return_value.rb

@@ -0,0 +1,42 @@
+module RuboCop
+  module Cop
+    module Mirego
+      class ExplicitReturnValue < Cop
+        MESSAGE = 'Always specify a value with `return`'.freeze
+
+        def on_def(node)
+          _, _, body = *node
+          check(node: body)
+        end
+
+        def on_defs(node)
+          _, _, _, body = *node
+          check(node: body)
+        end
+
+      protected
+
+        def check(node:)
+          expressions = *node
+          return nil unless node
+
+          if return_node_type(node: node)
+            check_return_node(node: node, children: node.children)
+          elsif expressions.last && return_node_type(node: expressions.last)
+            check_return_node(node: node, children: expressions.last.to_a)
+          end
+        end
+
+        def check_return_node(node:, children:)
+          return nil unless children.empty?
+
+          add_offense(node, :expression, MESSAGE)
+        end
+
+        def return_node_type(node:)
+          node.respond_to?(:type) && node.type == :return
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mirego/receive_counts.rb

@@ -0,0 +1,38 @@
+module RuboCop
+  module Cop
+    module Mirego
+      class ReceiveCounts < Cop
+        MESSAGE = 'Always specify a receive count with `receive`'.freeze
+        RECEIVE_COUNTS_METHODS = %i(once twice exactly at_least at_most).freeze
+
+        def on_send(node)
+          receiver, method_name, *args = *node
+          return nil unless method_name == :to
+          return nil if receiver.nil? || receiver.to_a[1] != :expect
+
+          methods_name = recursive_methods_name(nodes: args)
+          return nil unless methods_name.include? :receive
+          return nil unless (methods_name & RECEIVE_COUNTS_METHODS).empty?
+
+          add_offense(node, :expression, MESSAGE)
+        end
+
+      protected
+
+        def recursive_methods_name(nodes:)
+          methods_name = []
+          nodes.each do |node|
+            methods_name << node.children[1]
+
+            until node.children[0].nil?
+              node = node.children[0]
+              methods_name << node.children[1]
+            end
+          end
+
+          methods_name
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/mirego/inject.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module RuboCop
+  module Mirego
+    module Inject
+      DEFAULT_FILE = File.expand_path('../../../../config/default.yml', __FILE__).freeze
+
+      def self.defaults!
+        path = File.absolute_path(DEFAULT_FILE)
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/mirego/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Mirego
+    VERSION = '0.0.3'.freeze
+  end
+end

data/rubocop-mirego.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/mirego/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-mirego'
+  spec.version       = RuboCop::Mirego::VERSION
+  spec.authors       = ['Jean-François Chaput']
+  spec.email         = ['jfchaput@mirego.com']
+  spec.description   = 'Custom cops for Mirego.'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/mirego/rubocop-mirego'
+  spec.license       = 'BSD 3-Clause'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop', '0.39.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.4', '>= 1.4.1'
+  spec.add_development_dependency 'phare', '~> 0.7'
+end

data/spec/rubocop/cop/mirego/explicit_return_value_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe RuboCop::Cop::Mirego::ExplicitReturnValue do
+  let(:cop) { RuboCop::Cop::Mirego::ExplicitReturnValue.new }
+
+  before { inspect_source(cop, source) }
+
+  describe 'with a return with a value' do
+    let(:source) { 'def test; return nil; end' }
+
+    it { expect(cop.offenses.size).to eql(0) }
+  end
+
+  describe 'with a return with a value with a conditional' do
+    let(:source) { 'def test; return nil unless bool; end' }
+
+    it { expect(cop.offenses.size).to eql(0) }
+  end
+
+  describe 'with a return missing a value' do
+    let(:source) { 'def test; return; end' }
+
+    specify do
+      expect(cop.offenses.size).to eql(1)
+      expect(cop.offenses.first.cop_name).to eql('Mirego/ExplicitReturnValue')
+    end
+  end
+
+  describe 'with a return missing a value with a conditional' do
+    let(:source) { 'def test; return unless bool; end' }
+
+    specify do
+      expect(cop.offenses.size).to eql(1)
+      expect(cop.offenses.first.cop_name).to eql('Mirego/ExplicitReturnValue')
+    end
+  end
+
+  describe 'with a implicit return' do
+    let(:source) { 'def test; test; end' }
+
+    it { expect(cop.offenses.size).to eql(0) }
+  end
+end

data/spec/rubocop/cop/mirego/receive_counts_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe RuboCop::Cop::Mirego::ReceiveCounts do
+  let(:cop) { RuboCop::Cop::Mirego::ReceiveCounts.new }
+
+  before { inspect_source(cop, source) }
+
+  describe 'with a receive having a count' do
+    let(:source) { 'expect(object).to receive(:test).once' }
+
+    it { expect(cop.offenses.size).to eql(0) }
+  end
+
+  describe 'with an allow' do
+    let(:source) { 'allow(object).to receive(:test)' }
+
+    it { expect(cop.offenses.size).to eql(0) }
+  end
+
+  describe 'with a receive missing a count' do
+    let(:source) { 'expect(object).to receive(:test)' }
+
+    specify do
+      expect(cop.offenses.size).to eql(1)
+      expect(cop.offenses.first.cop_name).to eql('Mirego/ReceiveCounts')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubocop'
+
+rubocop_path = Bundler.rubygems.find_name('rubocop').first.full_gem_path
+require "#{rubocop_path}/spec/support/cop_helper"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubocop-mirego'
+
+RSpec.configure do |config|
+  # Disable `should` syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-mirego
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jean-François Chaput
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.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: 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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: phare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Custom cops for Mirego.
+email:
+- jfchaput@mirego.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- config/default.yml
+- lib/rubocop-mirego.rb
+- lib/rubocop/cop/mirego/explicit_return_value.rb
+- lib/rubocop/cop/mirego/receive_counts.rb
+- lib/rubocop/mirego/inject.rb
+- lib/rubocop/mirego/version.rb
+- rubocop-mirego.gemspec
+- spec/rubocop/cop/mirego/explicit_return_value_spec.rb
+- spec/rubocop/cop/mirego/receive_counts_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mirego/rubocop-mirego
+licenses:
+- BSD 3-Clause
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Custom cops for Mirego.
+test_files:
+- spec/rubocop/cop/mirego/explicit_return_value_spec.rb
+- spec/rubocop/cop/mirego/receive_counts_spec.rb
+- spec/spec_helper.rb