leftovers 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02f0f5136df6e16a7d27e47d118446f9118395f9242e29a32c91476ccd070591
-  data.tar.gz: fa438c525a212769b17cae1b2e2f05495c2772da5c9f3a05c9dd2d869743e969
+  metadata.gz: a3fb0707b239e6e7581c2997969483c72b3ff272895173828fc3434c08de165a
+  data.tar.gz: aadfba4e9fc93b110599c8e2bd66f723efbce39cabf4deda036d904358cfa131
 SHA512:
-  metadata.gz: 3c88300e0a1e822f510dd22ff72a91ab1db5ed35ac7cdd323ec3fe194f347748faad08efd62ac727501ed6f854e5623b6958589e216a4e2389ed44f9fc878b54
-  data.tar.gz: '08deaf4ffb911b2a1d53960e5bfc6c46a3990d0a6197d28f18b8ccfc60031b48c3701dca1e1d1ffe7db5e1ab892b1630c9332e87706769326141b0793115a2d6'
+  metadata.gz: 129fe2d42ec0f47d9f76105c1d53f0209133864d77688db231cb9fbc3c5ad3e6ea3ea8bdd95b1902b480b8a7e78709f2c197b261e1132ae0ce3cddc618e39899
+  data.tar.gz: 1d01550bdf1762344c2744d21f01c1590b928a751439714e5ad364211b2a914aec486415f1d5769113b1d3bf23023319c3d68bf72b733367dc7851fdc9e4ffb9

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+# v0.4.1
+- add `test_only:` to mark methods/constants/assignments as test_only in the config rather than just with magic comments
 
 # v0.4.0
 - add `requires:` to .leftovers.yml config to e.g. load inflections in a different place than `config/initializers/inflections`

data/README.md

@@ -72,16 +72,16 @@ class MyClass
 end
 ```
 This would report `MyClass` is unused, but not my_method
-To do this for all definitions of this name, add the name with `skip: true` in the configuration file.
+To do this for all definitions of this name, instead of adding a comment, add the name to the [`keep:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#keep) list in the [configuration file](#configuration-file).
 
-### `# leftovers:test`
+### `# leftovers:test_only`
 _aliases `leftovers:for_test`, `leftovers:for_tests`, `leftovers:test`, `leftovers:tests`, `leftovers:testing`_
 
-To mark a definition from a non-test dir, as intentionally only used by tests, use `leftovers:test`
+To mark a definition from a non-test dir, as intentionally only used by tests, use `leftovers:test_only`
 ```ruby
 # app/my_class.rb
 class MyClass
-  def my_method # leftovers:test
+  def my_method # leftovers:test_only
     true
   end
 end
@@ -95,6 +95,8 @@ end
 
 This would consider `my_method` to be used, even though it is only called by tests.
 
+To do this for all definitions of this name, instead of adding a comment, add the name to the [`test_only:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#test_only) list in the [configuration file](#configuration-file).
+
 ### `# leftovers:call`
 _aliases `leftovers:calls`_
 To mark a dynamic call that doesn't use literal values, use `leftovers:call` with the method name listed
@@ -116,6 +118,7 @@ Its presence is optional and all of these settings are optional.
 - [`requires:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#requires)
 - [`gems:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#gems)
 - [`keep:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#keep)
+- [`test_only:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#test_only)
 - [`dynamic:`](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md#dynamic)
 
 see the [complete config documentation](https://github.com/robotdana/leftovers/tree/main/docs/Configuration.md) for details.

data/docs/Configuration.md

@@ -9,6 +9,7 @@ Its presence is optional and all of these settings are optional.
 - [`requires:`](#requires)
 - [`gems:`](#gems)
 - [`keep:`](#keep)
+- [`test_only:](#test_only)
 - [`dynamic:`](#dynamic)
 
 see the [built in config files](https://github.com/robotdana/leftovers/tree/main/lib/config) or [this repo's own config](https://github.com/robotdana/leftovers/tree/main/.leftovers.yml) for examples.
@@ -120,6 +121,34 @@ keep:
 
 Alternatively, you can mark method/constants/variables in-place using [magic comments](https://github.com/robotdana/leftovers/tree/main/README.md#magic-comments).
 
+## `test_only:`
+
+This is a list of methods/constants/variables that are ok to be defined outside of [test paths](#test_paths), but only used within test paths, maybe because they're your public api, or convenience methods for tests etc.
+
+Each entry can be a string (an exact match for a method, constant, or variable name that includes the sigil), or have at least one of the following properties:
+- [`names:`](#names)
+  or the properties from `names:`
+  - [`has_prefix:`](#has_prefix)
+  - [`has_suffix:`](#has_suffix)
+  - [`matches:`](#matches) (can't be used in the same entry as `has_prefix:` or `has_suffix:`)
+- [`paths:`](#paths)
+- [`has_arguments:`](#has_arguments)
+- [`unless`](#unless)
+
+Arrays are not necessary for single values
+
+example from rails.yml
+```yml
+test_only:
+  - APP_PATH
+  - ssl_configured?
+  - has_suffix: Helper
+    path: /app/helpers
+  ...
+```
+
+Alternatively, you can mark method/constants/variables in-place using [magic comments](https://github.com/robotdana/leftovers/tree/main/README.md#magic-comments).
+
 ## `dynamic:`
 
 This is a list of methods, constants, or variables whose called arguments or assigned value/s are used to dynamically `call:` or define (`define:`) other methods, constants, or variables

data/lib/leftovers.rb

@@ -11,6 +11,7 @@ module Leftovers # rubocop:disable Metrics/ModuleLength
   autoload(:Collector, "#{__dir__}/leftovers/collector")
   autoload(:ConfigValidator, "#{__dir__}/leftovers/config_validator")
   autoload(:Config, "#{__dir__}/leftovers/config")
+  autoload(:DefinitionNode, "#{__dir__}/leftovers/definition_node")
   autoload(:DefinitionSet, "#{__dir__}/leftovers/definition_set")
   autoload(:Definition, "#{__dir__}/leftovers/definition")
   autoload(:ERB, "#{__dir__}/leftovers/erb")

data/lib/leftovers/ast/node.rb

@@ -25,12 +25,12 @@ module Leftovers
         @memo[:path] ||= loc.expression.source_buffer.name.to_s
       end
 
-      def test?
-        @memo[:test]
+      def test_line?
+        @memo[:test_line]
       end
 
-      def test=(value)
-        @memo[:test] = value
+      def test_line=(value)
+        @memo[:test_line] = value
       end
 
       def keep_line=(value)

data/lib/leftovers/config.rb

@@ -40,6 +40,10 @@ module Leftovers
       @keep ||= ::Leftovers::MatcherBuilders::Node.build(yaml[:keep])
     end
 
+    def test_only
+      @test_only ||= ::Leftovers::MatcherBuilders::Node.build(yaml[:test_only])
+    end
+
     def requires
       @requires ||= Array(yaml[:requires])
     end

data/lib/leftovers/config_validator/schema_hash.rb

@@ -445,7 +445,7 @@ module Leftovers
             { '$ref' => '#/definitions/dynamic' }
           ]
         },
-        'keep' => {
+        'keepTestOnly' => {
           'anyOf' => [
             { '$ref' => '#/definitions/string' },
             {
@@ -460,7 +460,7 @@ module Leftovers
                     'has_prefix' => true, 'has_suffix' => true, 'matches' => true,
                     'path' => true, 'paths' => true,
                     'has_argument' => true, 'has_arguments' => true,
-                    'unless' => { '$ref' => '#/definitions/keepList' }
+                    'unless' => { '$ref' => '#/definitions/keepTestOnlyList' }
                   },
                   'additionalProperties' => false,
                   'minProperties' => 1
@@ -469,15 +469,15 @@ module Leftovers
             }
           ]
         },
-        'keepList' => {
+        'keepTestOnlyList' => {
           'anyOf' => [
             {
               'type' => 'array',
-              'items' => { '$ref' => '#/definitions/keep' },
+              'items' => { '$ref' => '#/definitions/keepTestOnly' },
               'minItems' => 1,
               'uniqueItems' => true
             },
-            { '$ref' => '#/definitions/keep' }
+            { '$ref' => '#/definitions/keepTestOnly' }
           ]
         }
       },
@@ -487,7 +487,8 @@ module Leftovers
         'test_paths' => { '$ref' => '#/definitions/stringList' },
         'requires' => { '$ref' => '#/definitions/stringList' },
         'gems' => { '$ref' => '#/definitions/stringList' },
-        'keep' => { '$ref' => '#/definitions/keepList' },
+        'keep' => { '$ref' => '#/definitions/keepTestOnlyList' },
+        'test_only' => { '$ref' => '#/definitions/keepTestOnlyList' },
         'dynamic' => { '$ref' => '#/definitions/dynamicList' }
       }
     }.freeze

data/lib/leftovers/definition.rb

@@ -9,11 +9,11 @@ module Leftovers
 
     def initialize(
       name,
-      method_node: nil,
       location: method_node.loc.expression,
-      test: method_node.test?
+      test: method_node.test_line?
     )
       @name = name
+      @path = location.source_buffer.name.to_s
       @location_source_line = location.source_line.to_s
       @location_column_range_begin = location.column_range.begin.to_i
       @location_column_range_end = location.column_range.end.to_i

data/lib/leftovers/definition_node.rb

@@ -0,0 +1,36 @@
+# frozen-string-literal: true
+
+# To give to matchers before creating a Definition
+
+module Leftovers
+  class DefinitionNode
+    attr_reader :path, :name
+
+    def initialize(name, path)
+      @name = name
+      @path = path
+
+      freeze
+    end
+
+    # these are the methods checked by things in lib/leftovers/matchers
+    def kwargs
+      nil
+    end
+
+    def positional_arguments
+      nil
+    end
+
+    # these two i'm not sure are possible with the current config flags
+    # :nocov:
+    def scalar?
+      false
+    end
+
+    def type
+      :leftovers_definition
+    end
+    # :nocov:
+  end
+end

data/lib/leftovers/definition_set.rb

@@ -1,18 +1,13 @@
 # frozen_string_literal: true
 
 module Leftovers
-  class DefinitionSet < ::Leftovers::Definition
+  class DefinitionSet
     attr_reader :definitions
 
-    def initialize(
-      definitions,
-      method_node: nil,
-      location: method_node.loc.expression,
-      test: method_node.test?
-    )
+    def initialize(definitions)
       @definitions = definitions
 
-      super
+      freeze
     end
 
     def names
@@ -23,10 +18,22 @@ module Leftovers
       @definitions.map(&:to_s).join(', ')
     end
 
+    def location_s
+      @definitions.first.location_s
+    end
+
+    def highlighted_source(*args)
+      @definitions.first.highlighted_source(*args)
+    end
+
     def in_collection?
       @definitions.any?(&:in_collection?)
     end
 
+    def test?
+      @definitions.any?(&:test?)
+    end
+
     def in_test_collection?
       @definitions.any?(&:in_test_collection?)
     end

data/lib/leftovers/file_collector.rb

@@ -57,7 +57,7 @@ module Leftovers
     NAME_RE = Regexp.union(METHOD_NAME_RE, NON_ALNUM_METHOD_NAME_RE, CONSTANT_NAME_RE)
     LEFTOVERS_CALL_RE = /\bleftovers:call(?:s|ed|er|ers|) (#{NAME_RE}(?:[, :]+#{NAME_RE})*)/.freeze
     LEFTOVERS_ALLOW_RE = /\bleftovers:(?:keeps?|skip(?:s|ped|)|allow(?:s|ed|))\b/.freeze
-    LEFTOVERS_TEST_RE = /\bleftovers:(?:for_tests?|tests?|testing)\b/.freeze
+    LEFTOVERS_TEST_RE = /\bleftovers:(?:for_tests?|tests?|testing|test_only)\b/.freeze
     def process_comments(comments) # rubocop:disable Metrics/AbcSize
       comments.each do |comment|
         @allow_lines << comment.loc.line if comment.text.match?(LEFTOVERS_ALLOW_RE)
@@ -171,15 +171,20 @@ module Leftovers
 
     private
 
-    def test?(loc)
-      @file.test? || @test_lines.include?(loc.line)
+    def test_line?(loc)
+      @file.test? ||
+        @test_lines.include?(loc.line)
+    end
+
+    def test_node?(node, loc)
+      test_line?(loc) || ::Leftovers.config.test_only === node
     end
 
     def add_definition(node, name: node.name, loc: node.loc.name)
       return if @allow_lines.include?(loc.line)
       return if Leftovers.config.keep === node
 
-      definitions << Leftovers::Definition.new(name, location: loc, test: test?(loc))
+      definitions << Leftovers::Definition.new(name, location: loc, test: test_node?(node, loc))
     end
 
     def add_call(name)
@@ -222,7 +227,7 @@ module Leftovers
 
     def collect_dynamic(node) # rubocop:disable Metrics/AbcSize
       node.keep_line = @allow_lines.include?(node.loc.line)
-      node.test = test?(node.loc) unless node.keep_line?
+      node.test_line = test_line?(node.loc) unless node.keep_line?
 
       Leftovers.config.dynamic.process(node, self)
     rescue StandardError => e

data/lib/leftovers/merged_config.rb

@@ -64,6 +64,10 @@ module Leftovers
       @keep ||= ::Leftovers::MatcherBuilders::Or.build(@configs.map(&:keep))
     end
 
+    def test_only
+      @test_only ||= ::Leftovers::MatcherBuilders::Or.build(@configs.map(&:test_only))
+    end
+
     private
 
     def load_bundled_gem_config

data/lib/leftovers/value_processors/each_for_definition_set.rb

@@ -9,7 +9,7 @@ module Leftovers
         freeze
       end
 
-      def process(str, node, method_node) # rubocop:disable Metrics/MethodLength
+      def process(str, node, method_node)
         definitions = @then_processors.map do |then_processor|
           processed = then_processor.process(str, node, method_node)
           return if processed == :keep # rubocop:disable Lint/NonLocalExitFromIterator
@@ -22,11 +22,7 @@ module Leftovers
 
         return definitions.first if definitions.length <= 1
 
-        ::Leftovers::DefinitionSet.new(
-          definitions,
-          location: node.loc.expression,
-          method_node: method_node
-        )
+        ::Leftovers::DefinitionSet.new(definitions)
       end
     end
   end

data/lib/leftovers/value_processors/return_definition.rb

@@ -11,12 +11,14 @@ module Leftovers
         return unless str
         return if str.empty?
 
-        return :keep if ::Leftovers.config.keep === node
+        str_node = Leftovers::DefinitionNode.new(str.to_sym, method_node.path)
+
+        return :keep if ::Leftovers.config.keep === str_node
 
         Leftovers::Definition.new(
-          str.to_sym,
+          str_node.name,
           location: node.loc.expression,
-          method_node: method_node
+          test: method_node.test_line? || ::Leftovers.config.test_only === str_node
         )
       end
     end

data/lib/leftovers/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leftovers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Dana Sherson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -313,6 +313,7 @@ files:
 - lib/leftovers/config_validator/error_processor.rb
 - lib/leftovers/config_validator/schema_hash.rb
 - lib/leftovers/definition.rb
+- lib/leftovers/definition_node.rb
 - lib/leftovers/definition_set.rb
 - lib/leftovers/dynamic_processors.rb
 - lib/leftovers/dynamic_processors/call.rb
@@ -438,8 +439,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Find unused methods and classes/modules