digivizer-style 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff91b9e9b0fbd2c9bd6b59bd45623694d7361848
+  data.tar.gz: fee81c5288b0ac66ab0619f76e82dc0aad431b88
+SHA512:
+  metadata.gz: c0f86d8bec2f6cadc2563f4c33f97ac47895b323aabf84b091ff136b4e41a1cc578d531ce11a16410de5ab37af03687d78a7f1aadada480b205cefc0532b7fff
+  data.tar.gz: f383c5b85230efa6fda87918c8467df67a9c0a28d03ef78def381b643b5f23f4e4c3ea2d50501c06bbf9710df07a7d8a9a5d36237a46d9b08b847fc628652994

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+source 'https://gems.dgvz.net'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    digibits (1.5)
+      rubocop (~> 0.42.1.pre)
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://gems.dgvz.net/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      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)
+    rubocop (0.42.1.pre)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  digibits!
+  rake
+  rspec
+
+BUNDLED WITH
+   1.11.2

data/digivizer-style.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'digivizer-style'
+  spec.version       = '1.1'
+  spec.authors       = ['Digivizer Developer']
+  spec.email         = ['dev-accounts@digivizer.com']
+  spec.description   = 'The Digivizer Manual of Style'
+  spec.summary       = 'This gem contains a rubocop configuration for Digivizer'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'rubocop', '~> 0.45'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 11.2'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+end

data/lib/dgvz_method_length.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Metrics
+      # This cop checks if the length a method exceeds some maximum value.
+      # Comment lines can optionally be ignored.
+      # The maximum allowed length is configurable.
+      class DGVZMethodLength < Cop
+        include OnMethodDef
+        include CodeLength
+
+        private
+
+        def on_method_def(node, _method_name, _args, _body)
+          check_code_length(node)
+        end
+
+        def message(length, max_length)
+          format('Method has far too many lines. [%d/%d]', length, max_length)
+        end
+
+        def code_length(node)
+          lines = node.source.lines.to_a[1..-2] || []
+
+          lines.count { |line| !dgvz_irrelevant_line(line) }
+        end
+
+        def blacklist
+          cop_config['Blacklist']
+        end
+
+        def logger_line?(source_line)
+          blacklist.find { |o| source_line.include?(o) }
+        end
+
+        def dgvz_irrelevant_line(source_line)
+          source_line.blank? || (!count_comments? && comment_line?(source_line)) || logger_line?(source_line)
+        end
+      end
+    end
+  end
+end

data/lib/raise_exception.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+# frozen_string_literal: true
+# author: Harry Lee
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for uses of `raise e`.
+      # @example
+      # case e
+      # when condition
+      #   statement
+      # else
+      #   raise e
+      # end
+      class RaiseException < Cop
+        MSG = 'Raise strings or constants, not variables.'.freeze
+
+        ALLOWED_TYPES = [:const, :str]
+
+        def on_send(node)
+          return unless node.command?(:raise)
+
+          # args will contain the type of arguments ex) (send nil :e)
+          _receiver, _selector, args = *node
+
+          add_offense(node, :expression, MSG) unless ALLOWED_TYPES.include?(args.type)
+        end
+      end
+    end
+  end
+end

data/rubocop.yml

@@ -0,0 +1,142 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+AccessorMethodName:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+SpaceBeforeFirstArg:
+  Enabled: false
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+ClassLength:
+  Max: 180
+
+ColonMethodCall:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 160
+
+Loop:
+  Enabled: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+# DGVZMethodLength:
+#   Enabled: true
+#   Max: 23
+#   Blacklist:
+#     - .error
+#     - .info
+#     - .debug
+#     - .fatal
+#     - .trace
+
+MethodLength:
+  Max: 23
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+ParenthesesAroundCondition:
+  Enabled: false
+
+Style/TernaryParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses
+
+RedundantSelf:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+Void:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: true
+
+Style/DocumentationMethod:
+  Enabled: true
+
+Style/Lambda:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+  EnforcedStyle: empty_lines
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+  EnforcedStyle: empty_lines
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/EmptyLiteral:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false

data/spec/dgvz_method_length_spec.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/dgvz_method_length'
+
+describe RuboCop::Cop::Metrics::DGVZMethodLength, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { { 'Max' => 5,  'Blacklist' => ['.error', '.info', '.debug', '.fatal', '.trace'] } }
+
+
+  it 'accept a method with .error' do
+    inspect_source(cop, ['def m',
+                         'logger.error{"abc"}',
+                         'logger.error{"abc"}',
+                         'logger.error{"abc"}',
+                         'logger.error{"abc"}',
+                         'logger.error{"abc"}',
+                         'logger.error{"abc"}',
+                         'logger.error{"abc"}',
+                         'logger.error{"abc"}',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accept a method with .info' do
+    inspect_source(cop, ['def m',
+                         'logger.info{"abc"}',
+                         'logger.info{"abc"}',
+                         'logger.info{"abc"}',
+                         'logger.info{"abc"}',
+                         'logger.info{"abc"}',
+                         'logger.info{"abc"}',
+                         'logger.info{"abc"}',
+                         'logger.info{"abc"}',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accept a method with .debug' do
+    inspect_source(cop, ['def m',
+                         'logger.debug{"abc"}',
+                         'logger.debug{"abc"}',
+                         'logger.debug{"abc"}',
+                         'logger.debug{"abc"}',
+                         'logger.debug{"abc"}',
+                         'logger.debug{"abc"}',
+                         'logger.debug{"abc"}',
+                         'logger.debug{"abc"}',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accept a method with .fatal' do
+    inspect_source(cop, ['def m',
+                         'logger.fatal{"abc"}',
+                         'logger.fatal{"abc"}',
+                         'logger.fatal{"abc"}',
+                         'logger.fatal{"abc"}',
+                         'logger.fatal{"abc"}',
+                         'logger.fatal{"abc"}',
+                         'logger.fatal{"abc"}',
+                         'logger.fatal{"abc"}',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accept a method with .trace' do
+    inspect_source(cop, ['def m',
+                         'logger.trace{"abc"}',
+                         'logger.trace{"abc"}',
+                         'logger.trace{"abc"}',
+                         'logger.trace{"abc"}',
+                         'logger.trace{"abc"}',
+                         'logger.trace{"abc"}',
+                         'logger.trace{"abc"}',
+                         'logger.trace{"abc"}',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accepts a method with less than 5 lines' do
+    inspect_source(cop, ['def m()',
+                         '  a = 1',
+                         '  a = 2',
+                         '  a = 3',
+                         '  a = 4',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'rejects a method with more than 5 lines' do
+    inspect_source(cop, ['def m()',
+                         '  a = 1',
+                         '  a = 2',
+                         '  a = 3',
+                         '  a = 4',
+                         '  a = 5',
+                         '  a = 6',
+                         'end'])
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'does not count blank lines' do
+    inspect_source(cop, ['def m()',
+                         '  a = 1',
+                         '  a = 2',
+                         '  a = 3',
+                         '  a = 4',
+                         '',
+                         '',
+                         '  a = 7',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'accepts empty methods' do
+    inspect_source(cop, ['def m()',
+                         'end'])
+    expect(cop.offenses).to be_empty
+  end
+end

data/spec/raise_exception_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'spec_helper'
+require './lib/raise_exception.rb'
+
+describe RuboCop::Cop::Style::RaiseException do
+  subject(:cop) { described_class.new }
+
+  it 'reports an offense for a raise with variables' do
+    inspect_source(cop, 'raise e, msg')
+    expect(cop.offenses.size).to eq(1)
+  end
+
+  it 'reports an offense for a raise with variables' do
+    inspect_source(cop, 'raise Error, msg')
+    expect(cop.offenses.size).to eq(0)
+  end
+
+  it 'reports an offense for a raise with variables' do
+    inspect_source(cop, 'raise "my error", msg')
+    expect(cop.offenses.size).to eq(0)
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: digivizer-style
+version: !ruby/object:Gem::Version
+  version: '1.1'
+platform: ruby
+authors:
+- Digivizer Developer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !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: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: The Digivizer Manual of Style
+email:
+- dev-accounts@digivizer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- digivizer-style.gemspec
+- lib/dgvz_method_length.rb
+- lib/raise_exception.rb
+- rubocop.yml
+- spec/dgvz_method_length_spec.rb
+- spec/raise_exception_spec.rb
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This gem contains a rubocop configuration for Digivizer
+test_files:
+- spec/dgvz_method_length_spec.rb
+- spec/raise_exception_spec.rb