leftovers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392cec9799ddf44fd1b532c714e70bdeb5bcd56d68843015fd45ab12aa747813
-  data.tar.gz: 2b34e3689fa2a376e83372234b936f0f9d0a4f0db1bd01f3cd4f48191f8d4f49
+  metadata.gz: b87286f8934cc673a0c9ccea260ac5bee0117230cf21917d244eb6988b70aede
+  data.tar.gz: c2daf36aaec3ffe393e4adab37bc80ba8bb5a5ffed2f1c94977a3138bbecde05
 SHA512:
-  metadata.gz: a8a681a625180b33210f36f74f2d5a2da5ade1955adbf357f9feefdd03fb32ea7088a57392056d4c31d6e937f4dbde79e54547ee80323ae8dd5d16997accea49
-  data.tar.gz: 1679d83c75a635bf12b2978bb415ae2d5f7280b5a162df16529058af2d3b0b814762e8710704cca3f84aa75e7d4809d396ee1baaa094a618544365fe47e21f77
+  metadata.gz: aca4a439cdbf92fbf6589bf2b9459d209e8ea3affd75bf432648110b58845870f06f80b9815bd1a5404e995a1f4a576885291cffbd1390d45c38f3ff658b9185
+  data.tar.gz: 464a65edd31f10324be77be82b5d28c3632b7b0f691e6268903d9b00190bed3e7c553f6301760c9222dceda12d62e4dba7e927d7dd717300b6effac3e57c790c

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# v0.2.0
+
+Play nice with rubocop
+
+# v0.1.0
+
+Initial release

data/leftovers.gemspec

@@ -16,13 +16,15 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'http://github.com/robotdana/leftovers'
-  spec.metadata['changelog_uri'] = 'http://github.com/robotdana/leftovers/blob/master/CHANGELOG'
+  spec.metadata['changelog_uri'] = 'http://github.com/robotdana/leftovers/blob/master/CHANGELOG.md'
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(::File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
+  spec.files = Dir.glob('{lib,exe}/**/{*,.*}') + %w{
+    CHANGELOG.md
+    Gemfile
+    LICENSE.txt
+    README.md
+    leftovers.gemspec
+  }
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| ::File.basename(f) }
   spec.require_paths = ['lib']
@@ -33,10 +35,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.1'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.74'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.4'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.35'
+
   spec.add_development_dependency 'spellr', '>= 0.8.1'
-  spec.add_dependency 'fast_ignore', '>= 0.8.3'
+  spec.add_dependency 'fast_ignore', '>= 0.9.0'
   spec.add_dependency 'parallel'
   spec.add_dependency 'parser'
 end

data/lib/config/ruby.yml

@@ -29,6 +29,10 @@ rules:
       - marshal_load # called by Marshal.load
       - _dump # called by Marshal.dump
       - _load # called by Marshal.load
+      - inherited # called by Subclass < Klass or Class.new(Klass)
+      - extended # called by extend Module
+      - included # called by include Module
+      - $VERBOSE # called by whatever is outputting warnings i guess
   - name:
       - send
       - public_send

data/lib/leftovers/argument_rule.rb

@@ -71,7 +71,7 @@ module Leftovers
     end
 
     def prepare_condition(conditions)
-      Array.wrap(conditions).each do |cond|
+      Leftovers.array_wrap(conditions).each do |cond|
         cond[:has_argument] = HashRule.new(cond[:has_argument]) if cond[:has_argument]
       end
     end
@@ -88,7 +88,7 @@ module Leftovers
       positions = Set.new
       keywords = []
 
-      Array.each_or_self(argument || arguments) do |arg|
+      Leftovers.each_or_self(argument || arguments) do |arg|
         case arg
         when '*'
           @all_positions = true
@@ -105,19 +105,21 @@ module Leftovers
       @keywords = NameRule.new(keywords) unless @all_keywords || keywords.empty?
     end
 
-    def matches(method_node) # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-      return Array::EMPTY unless all_conditions_match?(method_node)
+    def matches(method_node) # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
+      return [].freeze unless all_conditions_match?(method_node)
 
       result = []
 
       if @all_positions
-        result.gather values(method_node.positional_arguments, method_node)
+        result.leftovers_append values(method_node.positional_arguments, method_node)
       elsif @positions
-        result.gather values(method_node.positional_arguments_at(@positions).compact, method_node)
+        result.leftovers_append(
+          values(method_node.positional_arguments_at(@positions).compact, method_node)
+        )
       end
 
       if @keywords || @all_keywords || @key
-        result.gather hash_values(method_node.kwargs, method_node)
+        result.leftovers_append hash_values(method_node.kwargs, method_node)
       end
       result << method_value(method_node) if @itself
 

data/lib/leftovers/ast/builder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Leftovers
+  module AST
+    class Builder < ::Parser::Builders::Default
+      # Generates {Node} from the given information.
+      #
+      # @return [Node] the generated node
+      def n(type, children, source_map)
+        Leftovers::AST::Node.new(type, children, location: source_map)
+      end
+
+      # Don't complain about invalid strings
+      def string_value(token)
+        value(token)
+      end
+    end
+  end
+end

data/lib/leftovers/{node.rb → ast/node.rb}

@@ -2,9 +2,9 @@
 
 require 'parser'
 
-module Parser
+module Leftovers
   module AST
-    class Node # rubocop:disable Metrics/ClassLength
+    class Node < Parser::AST::Node # rubocop:disable Metrics/ClassLength
       def initialize(type, children = [], properties = {})
         # ::AST::Node#initialize freezes itself.
         # so can't use normal memoizations

data/lib/leftovers/core_ext.rb

@@ -3,30 +3,11 @@
 require 'set'
 
 class Array
-  # concat, # push, # add, #
-  EMPTY = [].freeze
-
-  def gather(other)
+  def leftovers_append(other)
     case other
     when Array, Set then concat(other)
     when nil then self
     else self.<< other
     end
   end
-
-  def self.wrap(value)
-    case value
-    when nil then EMPTY
-    when Array then value
-    else [value]
-    end
-  end
-
-  def self.each_or_self(value, &block)
-    case value
-    when nil then nil
-    when Array then value.each(&block)
-    else block.call(value)
-    end
-  end
 end

data/lib/leftovers/file_collector.rb

@@ -4,7 +4,8 @@ require 'fast_ignore'
 require 'set'
 require 'parser'
 require 'parser/current'
-require_relative 'node'
+require_relative 'ast/builder'
+require_relative 'ast/node'
 require_relative 'definition'
 
 module Leftovers
@@ -33,8 +34,33 @@ module Leftovers
       }
     end
 
+    # mostly copied from https://github.com/whitequark/parser/blob/master/lib/parser/base.rb
+    # but with our builder
+    def self.parser # rubocop:disable Metrics/MethodLength
+      p = ::Parser::CurrentRuby.new(Leftovers::AST::Builder.new)
+      p.diagnostics.all_errors_are_fatal = true
+      p.diagnostics.ignore_warnings = true
+
+      p.diagnostics.consumer = lambda do |diagnostic|
+        warn(diagnostic.render)
+      end
+
+      p
+    end
+    PARSER = parser
+
+    # mostly copied from https://github.com/whitequark/parser/blob/master/lib/parser/base.rb
+    # but with our parser
+    def parse_with_comments(string, file = '(string)', line = 1)
+      PARSER.reset
+      source_buffer = ::Parser::CurrentRuby.send(
+        :setup_source_buffer, file, line, string, PARSER.default_encoding
+      )
+      PARSER.parse_with_comments(source_buffer)
+    end
+
     def collect
-      ast, comments = Parser::CurrentRuby.parse_with_comments(@ruby)
+      ast, comments = parse_with_comments(@ruby, @file)
       process_comments(comments)
       process(ast)
     rescue Parser::SyntaxError => e

data/lib/leftovers/hash_rule.rb

@@ -9,7 +9,7 @@ module Leftovers
     def initialize(patterns) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
       keys = []
       pairs = []
-      Array.each_or_self(patterns) do |pat|
+      Leftovers.each_or_self(patterns) do |pat|
         if pat.is_a?(Hash) && pat[:value]
           pairs << [
             (NameRule.new(pat[:keyword]) if pat[:keyword]),

data/lib/leftovers/name_rule.rb

@@ -8,7 +8,7 @@ module Leftovers
     def initialize(patterns) # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
       regexps = []
       syms = Set.new
-      Array.each_or_self(patterns) do |pat|
+      Leftovers.each_or_self(patterns) do |pat|
         case pat
         when Leftovers::NameRule
           syms.merge(pat.sym) if pat.sym

data/lib/leftovers/value_rule.rb

@@ -6,7 +6,7 @@ module Leftovers
       literal_values = Set.new
       value_types = Set.new
 
-      Array.each_or_self(values) do |value|
+      Leftovers.each_or_self(values) do |value|
         case value
         when Hash
           raise ArgumentError, "invalid value #{value.inspect}" unless value[:type]

data/lib/leftovers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Leftovers
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/leftovers.rb

@@ -6,7 +6,7 @@ require_relative './leftovers/collector'
 require_relative './leftovers/merged_config'
 require_relative './leftovers/reporter'
 
-module Leftovers
+module Leftovers # rubocop:disable Metrics/ModuleLength
   module_function
 
   class << self
@@ -124,4 +124,20 @@ module Leftovers
       end
     end
   end
+
+  def each_or_self(value, &block)
+    case value
+    when nil then nil
+    when Array then value.each(&block)
+    else yield(value)
+    end
+  end
+
+  def array_wrap(value)
+    case value
+    when nil then [].freeze
+    when Array then value
+    else [value]
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leftovers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dana Sherson
@@ -98,30 +98,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.35'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.35'
 - !ruby/object:Gem::Dependency
   name: spellr
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -186,24 +200,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".leftovers.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".spellr.yml"
-- ".spellr_wordlists/english.txt"
-- ".spellr_wordlists/lorem.txt"
-- ".spellr_wordlists/ruby.txt"
-- ".spellr_wordlists/shell.txt"
-- ".travis.yml"
-- Configuration.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - exe/leftovers
 - leftovers.gemspec
 - lib/config/attr_encrypted.yml
@@ -230,6 +230,8 @@ files:
 - lib/config/will_paginate.yml
 - lib/leftovers.rb
 - lib/leftovers/argument_rule.rb
+- lib/leftovers/ast/builder.rb
+- lib/leftovers/ast/node.rb
 - lib/leftovers/backports.rb
 - lib/leftovers/cli.rb
 - lib/leftovers/collector.rb
@@ -245,7 +247,6 @@ files:
 - lib/leftovers/hash_rule.rb
 - lib/leftovers/merged_config.rb
 - lib/leftovers/name_rule.rb
-- lib/leftovers/node.rb
 - lib/leftovers/rake_task.rb
 - lib/leftovers/reporter.rb
 - lib/leftovers/rule.rb
@@ -258,7 +259,7 @@ licenses:
 metadata:
   homepage_uri: http://github.com/robotdana/leftovers
   source_code_uri: http://github.com/robotdana/leftovers
-  changelog_uri: http://github.com/robotdana/leftovers/blob/master/CHANGELOG
+  changelog_uri: http://github.com/robotdana/leftovers/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.gitignore

@@ -1,4 +0,0 @@
-.rspec_status
-Gemfile.lock
-/pkg/
-

data/.leftovers.yml

@@ -1,19 +0,0 @@
-exclude_paths:
-  - /vendor
-
-rules:
-  - skip: true
-    name:
-      - add_insert_cmd # called by ::ERB::Compiler
-      - add_put_cmd # called by ::ERB::Compiler
-      - Node
-  - name:
-      - RUBY_STRING_METHODS
-      - ACTIVESUPPORT_STRING_METHODS
-      - CUSTOM_TRANSFORMS
-    calls:
-      argument: 1
-  - name: HASH_VALUE_TRANSFORMS
-    calls:
-      argument: 1
-      add_suffix: _dynamic

data/.rspec

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

data/.rubocop.yml

@@ -1,216 +0,0 @@
-require: rubocop-rspec
-
-# Reference:
-# https://rubocop.readthedocs.io/en/latest/
-
-# Keep this in alphabetical order.
-# Each override should have a comment (even if it's just "default is bad")
-
-AllCops:
-  NewCops: enable
-  Exclude:
-    - db/schema*
-    - .bundle/**/*
-    - tmp/**/*
-    - vendor/**/*
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  TargetRubyVersion: 2.4
-
-# all of our layout customisations are because we prefer indentation to be
-# always consistently 2 spaces, for blocks, scopes, multiline expressions, etc
-# e.g.
-# class Klass
-#   def method(arg1,
-#     arg2)
-#     value = if arg1 == 'value' && arg2 == 'value'
-#       method2
-#         .method(arg_a, arg_b,
-#           arg_c, arg_d, keyword1: true,
-#           keyword2: true) do
-#             @last = [
-#               arg_a, arg_b,
-#               arg_c, arg_d
-#             ]
-#           end
-#     end
-#     value
-#   end
-# end
-
-# to match our preference for consistent indentation
-Layout/HashAlignment:
-  EnforcedLastArgumentHashStyle: always_ignore
-
-# to match our preference for consistent indentation
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-# to match our preference for consistent indentation
-Layout/BlockAlignment:
-  EnforcedStyleAlignWith: start_of_block
-
-# to match our preference for consistent indentation
-Layout/CaseIndentation:
-  EnforcedStyle: end
-
-# to match our preference for consistent indentation
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: start_of_line
-
-# Aligning Assignments, etc makes diffs noisy
-Layout/ExtraSpacing:
-  AllowForAlignment: false
-
-# to match our preference for consistent indentation
-Layout/FirstArrayElementLineBreak:
-  Enabled: true
-
-# to match our preference for consistent indentation
-Layout/FirstHashElementLineBreak:
-  Enabled: true
-
-# to match our preference for consistent indentation
-Layout/FirstArgumentIndentation:
-  EnforcedStyle: consistent
-
-# to match our preference for consistent indentation
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-# to match our preference for consistent indentation
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-# to match our preference for consistent indentation
-# and hanging assignment looks lost
-Layout/MultilineAssignmentLayout:
-  EnforcedStyle: same_line
-
-# this changes our preferred:
-#   value = if thing1 &&
-#     thing2
-# to:
-#   value = if thing1 &&
-#       thing2
-# even though the IndentationWidth is 2
-# but it's right most of the time so I put up with it
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-# Temporarily disable this spec as a recent change has broken it for us:
-# https://github.com/rubocop-hq/rubocop/issues/6254
-Layout/RescueEnsureAlignment:
-  Enabled: false
-
-Metrics:
-  CountComments: false
-
-Metrics/BlockLength:
-  ExcludedMethods:
-    - configure
-    - describe
-    - context
-    - it
-
-Layout/LineLength:
-  Max: 100
-  IgnoreCopDirectives: true
-
-Metrics/MethodLength:
-  Max: 5
-
-Naming/MethodParameterName:
-  AllowedNames: [_, io, id, to, by, 'on', in, at, ip, db]
-
-RSpec:
-  Enabled: true
-  Include:
-    - spec/**/*.rb
-
-RSpec/DescribeClass:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-# I misuse matchers often
-RSpec/ExpectActual:
-  Enabled: false
-
-RSpec/FilePath:
-  Enabled: false
-
-# Multiple expectations are useful
-# checking you've partially achieved something on the way to completely achieving it is useful for debugging failures
-RSpec/MultipleExpectations:
-  Enabled: false
-
-# It should be obvious from context. Chill out rubocop
-RSpec/NamedSubject:
-  Enabled: false
-
-
-# This matches the style we've been using all along (ever so slightly more frequently)
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/CollectionMethods:
-  Enabled: true
-
-# we don't rdoc
-Style/Documentation:
-  Enabled: false
-
-# [a, b].include?(x) is more unclear than a == x || b == x
-Style/MultipleComparison:
-  Enabled: false
-
-Style/NumericPredicate:
-  Enabled: false
-
-# we use %w{} pretty frequently
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    default: '{}'
-    '%w': '{}'
-    '%W': '{}'
-    '%i': '{}'
-    '%I': '{}'
-    '%r': '{}'
-
-# We want this to warn to force consistency within the codebase.
-Style/SafeNavigation:
-  Enabled: true
-
-# different methods calls that do exactly the same thing are a smell, regardless of semantics
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-# this wants less descriptive names
-Style/SingleLineBlockParams:
-  Enabled: false
-
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-
-# hey rubocop you even use parser which uses :true and :false types. no
-Lint/BooleanSymbol:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-RSpec/InstanceVariable:
-  Enabled: false # I'll figure it out soon

data/.ruby-version

@@ -1 +0,0 @@
-2.5.1

data/.spellr.yml

@@ -1,13 +0,0 @@
-excludes:
-  - vendor
-languages:
-  english:
-    locale: [US, AU]
-  lorem:
-    includes:
-      - /spec/
-  ruby:
-    includes:
-      - README.md
-      - Configuration.md
-      - '*.yml'

data/.spellr_wordlists/english.txt

@@ -1,21 +0,0 @@
-affixxed
-backports
-classnames
-codebase
-esque
-gemfile
-hashbang
-lorem
-nocov
-noninfringement
-precompiled
-readme
-requirables
-rspec
-rubo
-rvm
-sherson
-todo
-unmemoize
-wtf
-yml

data/.spellr_wordlists/lorem.txt

@@ -1 +0,0 @@
-baz

data/.spellr_wordlists/ruby.txt

@@ -1,67 +0,0 @@
-activesupport
-asgn
-ast
-autolink
-bigint
-camelcase
-camelize
-capfile
-casgn
-cattr
-changelog
-codespan
-configs
-coverband
-csend
-cvasgn
-cyclomatic
-deconstantize
-demodulize
-diffable
-dstr
-dsym
-eflipflop
-encryptor
-gitignore
-guardfile
-gvasgn
-haml
-hrule
-iflipflop
-irange
-ivasgn
-jbuilder
-kwbegin
-kwoptarg
-kwrestarg
-linebreak
-lvars
-lvasgn
-masgn
-mattr
-memoizations
-optarg
-postexe
-postprocess
-precompile
-preexe
-preload
-procarg
-pryrc
-regexps
-resbody
-restarg
-rhtml
-rjs
-rspec
-rubocop
-shadowarg
-simplecov
-strikethrough
-subnodes
-syms
-titlecase
-titleize
-usr
-vasgn
-xstr

data/.spellr_wordlists/shell.txt

@@ -1,3 +0,0 @@
-env
-euo
-usr

data/.travis.yml

@@ -1,10 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-before_install: gem install bundler
-

data/Configuration.md

@@ -1,427 +0,0 @@
-# Configuration
-
-The configuration is read from `.leftovers.yml` in your project root.
-Its presence is optional and all of these settings are optional:
-
-see the [built in config files](https://github.com/robotdana/leftovers/tree/master/lib/config) for examples.
-
-- [`include_paths:`](#include_paths)
-- [`exclude_paths:`](#exclude_paths)
-- [`test_paths:`](#test_paths)
-- [`gems:`](#gems)
-- [`rules:`](#rules)
-  - [`names:`](#names)
-    - [`has_prefix](#has_prefix-has_suffix)
-    - [`has_suffix](#has_prefix-has_suffix)
-    - [`matches](#matches)
-  - [`paths:`](#paths)
-  - [`skip:`](#skip)
-  - [`calls:`](#calls-defines), [`defines:`](#calls-defines)
-    - [`arguments:`](#arguments), [`keys:`](#keys-), [`itself:`](#itself-true)
-    - [`transforms:`](#transforms), [`linked_transforms:`](#linked_transforms)
-        - `original:`, `add_prefix:`, `add_suffix:`, `delete_prefix:`, `delete_suffix:`, `replace_with:`
-        - `delete_before:`, `delete_after:`, `downcase:`, `upcase:`, `capitalize:`, `swapcase:`
-        - `pluralize`, `singularize`, `camelize`, `underscore`, `demodulize`, `deconstantize`
-    - [`if:`](#if-unless), [`unless:`](#if-unless)
-      - [`has_argument:`](#has_argument)
-        - `keyword:`
-          - [`has_prefix:`](#has_prefix-has_suffix)
-          - [`has_suffix:`](#has_prefix-has_suffix)
-          - [`matches:`](#matches)
-        - `value:`
-          - [`has_prefix:`](#has_prefix-has_suffix)
-          - [`has_suffix:`](#has_prefix-has_suffix)
-          - [`matches:`](#matches)
-          - `type:`
-
-
-## `include_paths:`
-
-List filenames/paths in the gitignore format of files to be checked using a [gitignore-esque format](https://github.com/robotdana/fast_ignore#using-an-includes-list).
-
-```yml
-include_paths:
-  - '*.rb'
-  - '*.rake'
-  - Gemfile
-```
-
-Also it will check files with no extension that have `ruby` in the shebang/hashbang, e.g. `#!/usr/bin/env ruby` or `#!/usr/bin/ruby` etc
-
-## `exclude_paths:`
-
-List filenames/paths that match the above that you might want to exclude, using the gitignore format.
-By default it will also read your project's .gitignore file and ignore anything there.
-
-```yml
-exclude_paths:
-  - /some/long/irrelevant/generated/file
-```
-
-## `test_paths:`
-
-list filenames/paths of test directories that will be used to determine if a method/etc is only tested but not otherwise used.
-Also in the gitignore format
-
-```yml
-test_paths:
-  - /test/
-  - /spec/
-```
-
-## `gems:`
-
-By default Leftovers will look at your Gemfile.lock file to find all gem dependencies
-
-If you don't use bundler, or don't have a Gemfile.lock for some reason, you can still take advantage of the built in handling for certain gems
-```yml
-gems:
-  - rspec
-  - rails
-```
-
-## `rules:`
-
-This is the most complex part of configuration, and is a list of methods that define/call other methods/classes/etc.
-Each must have a list of `names:`. and can optionally be limited to a list of `paths:`.
-
-This rule can either `skip:` these names, or describe method/class `calls:` and definitions (`defines:`).
-
-### `names:`
-**required**
-
-_alias `name:`_
-
-list methods/classnames/etc that this rule applies to.
-
-```yml
-rules:
-  - names:
-      - initialize
-      - ClassName
-    skip: true
-  - name: respond_to_missing?
-    skip: true
-```
-
-#### `has_prefix:`, `has_suffix:`
-
-To match names other than exact strings, you can use has_suffix or has_prefix or both if you're feeling fancy.
-
-```yml
-rules:
-  - names:
-      - has_suffix: Helper # will match Helper, LinkHelper FormHelper, etc
-      - has_prefix: be_ # will match be_equal, be_invalid, etc
-      - { has_prefix: is_, has_suffix: '?' } # will match is_invalid?, is_equal? etc
-    skip: true
-```
-
-
-#### `matches:`
-
-if `has_suffix:` and `has_prefix:` isn't enough, you can use `matches:` to supply a regexp.
-This string is automatically converted into a ruby regexp and must match the whole method/constant name.
-```yml
-rules:
-  - names:
-      - matches: 'column_\d+' # will match column_1, column_2, column_99, but not column_left etc
-    skip: true
-```
-
-### `paths:`
-_alias `path:`_
-
-An optional list of paths that limits what paths this method rule can apply to, defined using a .gitignore-esque format
-
-```yml
-rules:
-  - name:
-      - has_suffix: Helper
-    path: /app/helpers
-    skip: true
-```
-
-### `skip:`
-
-Skip methods that are called on your behalf by code outside your project, or called dynamically using send with variables.
-
-You can also skip method calls and definitions in place using [magic comments](https://github.com/robotdana/leftovers/tree/master/README.md#magic-comments).
-
-```yml
-rules:
-  - name: initialize
-    skip: true
-```
-```ruby
-def initialize
-end
-```
-
-will not report that you didn't directly use the initialize method
-
-### `calls:`, `defines:`
-_aliases `call:`, `define:`_
-Describe implicitly called and defined methods using these keys. they're structured the same way:
-
-It must have at least one of `argument:`, `itself: true`, or `keys: '*'` which points to the implied method definition/call.
-This value must be a literal string, symbol, or array of strings or symbols.
-
-#### `arguments:`
-_alias `argument:`_
-
-the position or keyword of the value or values being implicitly called/defined.
-it can be a single argument or a list.
-
-This value must be itself a literal String, Symbol, or Array or Hash whose values are Strings and Symbols or more nested Arrays and Hashes.
-Variables and other method calls returning values will be ignored.
-
-`*` means all positional arguments values. `**` means all keyword arguments values.
-Positional arguments start at 1.
-
-```yml
-rules:
-  # `send(:my_method, arg)` is equivalent to `my_method(arg)`
-  - name: send
-    calls:
-      argument: 1
-```
-```ruby
-  user.send(:my_private_method, true)
-```
-will count as a call to `my_private_method`.
-
-```yml
-  - name: attr_reader
-    defines:
-      arguments: '*'
-```
-```ruby
-attr_reader :my_attr, :my_other_attr
-```
-will count as a definition of `my_attr` and `my_other_attr` and will need to be used elsewhere or they'll be reported as leftovers.
-
-```yml
-rules:
-  - name: validate
-    calls:
-      - arguments: ['*', if, unless]
-```
-```ruby
-validate :does_not_match_existing_record, if: :new_record?
-```
-will count as a call to `does_not_match_existing_record`, and `new_record?`
-
-##### Constant assignment.
-
-In addition to method call arguments, this can be used for constant assignment, as often constant assignment plus class_eval/instance_eval/define_method is used to dry up similar methods.
-```yml
-rules:
-  - name: METHOD_NAMES
-    defines:
-      - arguments: 1
-        add_suffix: _attributes
-    calls:
-      - arguments: 1
-```
-```ruby
-METHOD_NAMES = %w{user account}.freeze
-METHOD_NAMES.each do |method_name|
-  class_eval <<~RUBY, __FILE__, __LINE__ + 1
-    def #{method}_attributes
-      self.#{method}
-    end
-  end
-end
-```
-counts as a definition of `user_attributes` and `account_attributes` and calls to `user` and `account`
-
-use `arguments: '**'`, and or `keys: true` for assigning hashes
-```yml
-rules:
-  - name: METHOD_NAMES
-    defines:
-      - keys: '*'
-        add_prefix: setup_
-    calls:
-      - arguments: '**'
-        add_prefix: build_
-```
-```ruby
-METHOD_NAMES = { user: :login, account: :profile }
-METHOD_NAMES.each do |method_name|
-  class_eval <<~RUBY, __FILE__, __LINE__ + 1
-    def setup_#{method}
-      build_#{method}
-    end
-  end
-end
-```
-Would count as defining `setup_user`, and `setup_account` and calling `build_login` and `build_profile`
-
-#### `itself: true`
-
-Will supply the method/constant name itself as the thing to be transformed.
-The original method/constant name will continue to be defined as normal
-```yml
-- name:
-      has_prefix: be_
-    calls:
-      itself: true
-      delete_prefix: be_
-      add_suffix: '?'
-```
-```ruby
-expect(value).to be_empty
-```
-will count `be_empty` as a call to `empty?`
-
-#### `keys: '*'`
-When the keyword argument **keywords** are the thing being called.
-
-```yml
-rules:
-  - name: validates
-      calls:
-        - arguments: '*'
-        - keys: '*'
-          add_suffix: Validator
-          activesupport: camelize
-```
-```ruby
-validates :first_name, :surname, presence: true
-```
-will count calls for `validates`, `first_name`, `surname`, and `PresenceValidator`
-
-#### `transforms:`
-
-Sometimes the method being called is modified from the literal argument, sometimes that's just appending an `=` and sometimes it's more complex:
-
-```yml
-- name: attribute
-    defines:
-      - argument: 1
-        transforms:
-          - original # no transformation
-          - add_suffix: '?'
-          - add_suffix: '='
-```
-```ruby
-attribute :first_name
-```
-will count as a definition of `first_name`, `first_name=` and `first_name?`
-
-If there is just one transform for the arguments you can remove the `transforms:` keyword and move everything up a level.
-
-```yml
-- name: attr_writer
-  defines:
-    - argument: '*'
-      add_suffix: '='
-```
-```ruby
-attr_writer :first_name, :surname
-```
-will count as the definition of `first_name=`, and `surname=`
-
-| transform | examples | effect |
-| --- | --- | --- |
-|original| `original`, `original: true` | no change. useful when grouped with other transforms |
-|add_prefix| `add_prefix: be_`, `add_prefix: { from_argument: 'to', joiner: '_' }` | adds the prefix string. possibly from another attribute (used for rails' delegate). |
-|add_suffix| `add_suffix: '?'`, `add_suffix: Validator` | adds the suffix string. possibly from another attribute. |
-|delete_prefix| `delete_prefix: be_` | removes the prefix string. |
-|delete_suffix| `delete_suffix: _html` | removes the suffix string. |
-|delete_before| `delete_before: '#'` | removes everything up to and including the string. used for rails' routes. |
-|delete_after| `delete_after: '#'` | removes everything after to and including the string. used for rails' routes. |
-|replace_with| `replace_with: html` | replaces the original string, perhaps because it dynamically calls it |
-|downcase| `downcase`, `downcase: true` | calls ruby's `String#downcase` |
-|upcase| `upcase`, `upcase: true` | calls ruby's `String#upcase` |
-|capitalize| `capitalize`, `capitalize: true` | calls ruby's `String#capitalize` |
-|swapcase| `swapcase`, `swapcase: true` | calls ruby's `String#swapcase` |
-|pluralize| `pluralize`, `pluralize: true` | calls activesupport's `String#pluralize` extension. Will try to load config/initializers/inflections.rb |
-|singularize| `singularize`, `singularize: true` | calls activesupport's `String#singularize` extension. Will try to load config/initializers/inflections.rb |
-|camelize| `camelize`, `camelize: true`, `camelcase`, `camelcase: true` | calls activesupport's `String#camelize` extension. Will try to load config/initializers/inflections.rb |
-|underscore| `underscore`, `underscore: true` | calls activesupport's `String#underscore` extension. |
-|demodulize| `demodulize`, `demodulize: true` | calls activesupport's `String#demodulize` extension. |
-|deconstantize| `deconstantize`, `deconstantize: true` | calls activesupport's `String#deconstantize` extension. |
-|titleize| `titleize`, `titleize: true`, `titlecase`, `titlecase: true` | calls activesupport's `String#titleize` extension. |
-|parameterize| `parameterize`, `parameterize: true` | calls activesupport's `String#parameterize` extension. |
-
-#### `linked_transforms:`
-
-This is identical to `transforms:` except that a call to one of the defined methods counts as a call to them all.
-
-```yml
-- name: attribute
-    defines:
-      - argument: 1
-        linked_transforms:
-          - original # no transformation
-          - add_suffix: '?'
-          - add_suffix: '='
-```
-```ruby
-attribute :first_name
-
-def initialize
-  self.first_name = 'dana'
-end
-```
-will count as a definition of `first_name`, `first_name=` and `first_name?`, and because of `linked_transforms` the call to `first_name=` also counts as a call to `first_name?` and `first_name`
-
-#### `if:`, `unless:`
-
-Sometimes what to do depends on other arguments than the ones looked at:
-e.g. rails' `delegate` method has a `prefix:` argument of its own that is used when defining methods:
-
-`if:` and `unless:` work the same way and can be given a list or single value of conditions. For a list, all conditions must be met.
-
-```yml
-rules:
-  - name: field
-    calls:
-      - argument: 1
-        unless:
-          has_argument: method
-      - argument: method
-```
-```ruby
-field :first_name
-field :family_name, method: :surname
-```
-would count calls to `first_name`, and `surname`, but not `family_name`
-
-##### `has_argument:`
-
-has_argument can be given a keyword or list of keywords. or a list of patterns like name.
-or to check either the exact value or type of value it can be given `keyword:` and `value:` which also match the patterns like `name:`.
-instead of an exact value `value:` can be given a type or list of type.
-
-This all comes together to give the most complex rule, rails delegate method.
-```yml
-rules:
-  - name: delegate
-    defines:
-      - argument: '*'
-        if:
-          has_argument:
-            keyword: prefix
-            value: true # if the value of the prefix keyword argument is literal true value
-        add_prefix:
-          from_argument: to # use the value of the "to" keyword as the prefix
-          joiner: '_' # joining with _ to the original string
-      - argument: '*'
-        if: # if the method call has a prefix keyword argument that is not a literal true value
-          has_argument:
-            keyword: prefix
-            value:
-              type: [String, Symbol]
-        add_prefix:
-          from_argument: prefix # use the value of the "prefix" keyword as the prefix
-          joiner: '_' # joining with _ to the original string
-    calls:
-      - argument: to # consider the to argument called.
-      - argument: '*'
-        if:
-          has_argument: prefix # if there is a prefix, consider the original method called.
-```

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'spellr/rake_task'
-require_relative 'lib/leftovers/rake_task'
-
-# RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:spec)
-Spellr::RakeTask.generate_task
-Leftovers::RakeTask.generate_task(:leftovers, '--no-progress')
-
-# rubocop is misbehaving currently
-task default: %i{spec spellr leftovers}

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'leftovers'
-
-# 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(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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