rubocop-infl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1f2bad13d346b66bb105969eda469c6fc45a682
+  data.tar.gz: ed0e5074b19994f275f251a06374ccfb0e134eb2
+SHA512:
+  metadata.gz: 4ee9fc11216a22868cab9393e99482493ead824c0693eb70c239ae7b72e00faf9bbb37310ee77d2fe099f17b8a5c0c23a00b0ed20792a88af15fce8a71241321
+  data.tar.gz: e7742f6da0d59f149af2f80d3f4071c779a11aa2e1aa770adaeb357fa19e41296450ccdeec52d2516ebb9151df858386e9da2ea57582a461a4508d074b9b0720

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,2 @@
+# Use rubocop's defaults. This file's here to stop my personal one in my
+# home directory from overriding the defaults.

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+## master (unreleased)
+
+### Changes
+
+## 0.0.1 (2017-02-18)
+
+Initial release with `Infl/SoftLineLength` cop.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-infl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2017 Influitive Corp., Mike Stok
+
+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,46 @@
+# Rubocop::Infl
+
+This gem contains Influitive specific rubocop cops. To use them you can do this
+in your `Gemfile` for a project:
+
+    group :development to
+      gem 'rubocop', require: false
+      gem 'rubocop-infl', require: false
+    end
+
+And add this to your `.rubocop.yml` for the project:
+
+    require: "rubocop-infl"
+
+## Infl/SoftLineLength
+
+It is considered good style to limit the length of lines in Ruby source code,
+and we have found that *sometimes* there are lines which are a little longer
+than our conventional limit and breaking up made the code less readable and
+"greppable".  This Cop attempts to help with that situation by allowing a file
+to have up to a certain percentage of the lines be longer than our "usual"
+limit.
+
+    Metrics/LineLength:
+      Enabled: false
+
+    Infl/SoftLineLength:
+      Enabled: true
+      SoftLimit: 80
+      HardLimit: 120
+      AllowedLongLinePercentage: 2
+
+This would complain about *any* lines which were longer than 120 characters,
+and allow up to 2% of lines in a file to be longer than 80 characters
+before starting to complain about the lines longer that 80 characters.
+
+# Inspiration
+
+Shamelessly based on https://github.com/backus/rubocop-rspec
+
+http://rubocop.readthedocs.io/en/latest/extensions/#custom-cop has more
+information on custom cops.
+
+# License
+
+This is licensed under the [MIT License](./LICENSE.txt)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rubocop/infl'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/default.yml

@@ -0,0 +1,7 @@
+---
+Infl/SoftLineLength:
+  Description: Gentler line length checker
+  Enabled: true
+  SoftLimit: 80
+  HardLimit: 120
+  AllowedLongLinePercentage: 5

data/lib/rubocop-infl.rb

@@ -0,0 +1,14 @@
+# rubocop:disable Style/FileName
+
+require 'pathname'
+require 'yaml'
+
+require 'rubocop'
+
+require 'rubocop/infl'
+require 'rubocop/infl/version'
+require 'rubocop/infl/inject'
+
+RuboCop::Infl::Inject.defaults!
+
+require 'rubocop/cop/infl/soft_line_length'

data/lib/rubocop/cop/infl/soft_line_length.rb

@@ -0,0 +1,80 @@
+module RuboCop
+  module Cop
+    module Infl
+      # Checks forgivingly for line lengths
+      class SoftLineLength < Cop
+        HARD_MSG = 'Line exceeds hard length limit. [%d/%d]'.freeze
+        SOFT_MSG = 'Line exceeds soft length limit. [%d/%d]'.freeze
+
+        include RuboCop::Cop::ConfigurableEnforcedStyle
+
+        def investigate(processed_source)
+          stats = calculate_stats(processed_source)
+          soft_credit =
+            (stats.size * soft_allowance_percent_of_lines / 100.0).round
+
+          stats.each do |check, index, length|
+            soft_credit = report(soft_credit, check, index, length)
+          end
+        end
+
+        private
+
+        def calculate_stats(processed_source)
+          processed_source
+            .lines
+            .each_with_index
+            .map { |line, index| check_line(line, index) }
+            .compact
+        end
+
+        def check_line(line, index)
+          case line.length
+          when 0                         then nil
+          when ->(l) { l <= soft_limit } then [:ok, nil, nil]
+          when ->(l) { l <= hard_limit } then [:soft, index, line.length]
+          else                                [:hard, index, line.length]
+          end
+        end
+
+        def report(soft_credit, check, index, length)
+          case check
+          when :soft
+            soft_credit -= 1
+            soft_offense(processed_source, index, length) if soft_credit < 0
+          when :hard
+            hard_offense(processed_source, index, length)
+          end
+
+          soft_credit
+        end
+
+        def soft_offense(processed_source, index, length)
+          offense(processed_source, SOFT_MSG, index, length, soft_limit)
+        end
+
+        def hard_offense(processed_source, index, length)
+          offense(processed_source, HARD_MSG, index, length, hard_limit)
+        end
+
+        def offense(processed_source, template, index, length, limit)
+          loc = source_range(processed_source.buffer, index + 1, 0...length)
+          msg = format(template, length, limit)
+          add_offense(nil, loc, msg)
+        end
+
+        def soft_limit
+          cop_config['SoftLimit']
+        end
+
+        def hard_limit
+          cop_config['HardLimit']
+        end
+
+        def soft_allowance_percent_of_lines
+          cop_config['AllowedLongLinePercentage']
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/infl.rb

@@ -0,0 +1,11 @@
+require 'yaml'
+
+module RuboCop
+  module Infl # rubocop:disable Style/Documentation
+    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/infl/inject.rb

@@ -0,0 +1,14 @@
+module RuboCop
+  module Infl
+    module Inject # rubocop:disable Style/Documentation
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/infl/version.rb

@@ -0,0 +1,5 @@
+module Rubocop
+  module Infl
+    VERSION = '0.1.0'.freeze
+  end
+end

data/rubocop-infl.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/infl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-infl'
+  spec.version       = Rubocop::Infl::VERSION
+  spec.authors       = ['Mike Stok']
+  spec.email         = ['mike.stok@influitive.com']
+
+  spec.summary       = 'A package of Influitive cop(s) for Rubocop.'
+  spec.homepage      = 'https://github.com/influitive/rubocop-infl'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop', '>= 0.37.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-infl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Stok
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.37.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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: 
+email:
+- mike.stok@influitive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-infl.rb
+- lib/rubocop/cop/infl/soft_line_length.rb
+- lib/rubocop/infl.rb
+- lib/rubocop/infl/inject.rb
+- lib/rubocop/infl/version.rb
+- rubocop-infl.gemspec
+homepage: https://github.com/influitive/rubocop-infl
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A package of Influitive cop(s) for Rubocop.
+test_files: []