gravedigger 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 000db92231504a24d3ab6d87569148eafaa6d355af6192ebbb8efa0f8c881392
-  data.tar.gz: c4242466fcd30cc7a49a429b9e897732e09f441c06c8fc654bb68a12f53e8f1e
+  metadata.gz: 9c759391fd2e7994d2817a851ceb048db9ae1fa44e6871bc452c87910acd7b00
+  data.tar.gz: 38c08172baa3f34fe9ec5273d7d3748b295650aca62b6a6250169e73d1b7fed6
 SHA512:
-  metadata.gz: 545d8998fa99660778cc4686699c8d86d8b0ae6f6db2164f6bf9d7f4917c720db9ee98daeb12383253f3014317592bc1ecca2a5fb9c41211244fedab5c400190
-  data.tar.gz: f68a4188b3cad386ea55a7da0d45f7603516682f086b3f7243109a0a0968f9664b61f87b8adfac5d14ab44cb0908243472768c2082af9a49397c15825993af97
+  metadata.gz: 0db1fea6bb33cc4526feca9635043a2587266a6eb69c514252834d8caa9fbc8ff88997b5c3488ef3797e171839b42a5f69258c0ce03aca21f3fc493da69a98f0
+  data.tar.gz: bee13da0788e1224b5422d10fb9b6608a313787fa8109725a9544962b80a433d65873e9cf5eacdbd1eda43c480c0803ed8eaf4bf7c05f3d23751e4386b31391b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gravedigger (0.1.1)
+    gravedigger (0.1.2)
       thor
 
 GEM

data/lib/gravedigger.rb

@@ -9,12 +9,15 @@ module Gravedigger
     desc "dig", "Find unused code in your Rails project"
 
     def dig
-      method_definitions, get_definitions_errors = Gravedigger::DefinitionFinder.get_definitions
-      output, method_search_errors = Gravedigger::UsageSearcher.search_methods(method_definitions)
+      files_to_search = Dir[File.join(Dir.pwd,"/{app,lib,config}/**/*.{erb,haml,rb}")]
+      method_definitions, variable_definitions, definition_errors = Gravedigger::DefinitionFinder.get_definitions(files_to_search)
 
-      errors = get_definitions_errors.concat method_search_errors
+      unused_methods, method_search_errors = Gravedigger::UsageSearcher.search_methods(method_definitions, files_to_search)
+      unused_variables, variable_search_errors = Gravedigger::UsageSearcher.search_variables(variable_definitions, files_to_search)
 
-      Gravedigger::OutputPrinter.print_output(output, errors)
+      errors = definition_errors + method_search_errors + variable_search_errors
+
+      Gravedigger::OutputPrinter.print_output(unused_methods, unused_variables, errors)
     end
   end
 end

data/lib/gravedigger/definition_finder.rb

@@ -2,26 +2,29 @@
 
 module Gravedigger
   module DefinitionFinder
-    def self.get_definitions
-      all_file_names = Dir[File.join(Dir.pwd,"/{app,lib,config}/**/*.{erb,haml,rb}")]
+    def self.get_definitions(files_to_search)
       method_definitions = {}
+      variable_definitions = {}
       errors = []
 
-      all_file_names.each do |fileName|
+      files_to_search.each do |fileName|
         begin
-        File.readlines(fileName).each_with_index do |line,index|
-          next unless line
-          method_name = find_method_definitions(line)
-          location = "[#{fileName}:#{index+1}]"
+          File.readlines(fileName).each_with_index do |line,index|
+            next unless line
+            method_name = find_method_definitions(line)
+            variable_name = find_variable_definitions(line)
 
-          method_definitions[method_name] = location if method_name
-        end
+            location = "[#{fileName}:#{index+1}]"
+
+            method_definitions[method_name] = location if method_name
+            variable_definitions[variable_name] = location if variable_name
+          end
         rescue StandardError => error
           errors << "Error while reading file: #{fileName} \n #{error.message}"
         end
       end
 
-      return method_definitions, errors
+      return method_definitions, variable_definitions, errors
     end
 
     def self.find_method_definitions(line)
@@ -32,5 +35,12 @@ module Gravedigger
       end
       method_name
     end
+
+    def self.find_variable_definitions(line)
+      result = line.scan(/^[ ]+([A-Za-z0-9_\!\@]*)[ ]*\=[^\=\>]/)
+      return nil if result.empty?
+      result[0][0].sub!(/^@/, '')
+      result[0][0]
+    end
   end
 end

data/lib/gravedigger/output_printer.rb

@@ -3,18 +3,27 @@
 module Gravedigger
   module OutputPrinter
     NEW_LINE = "\n"
-    def self.print_output(output, error_messages = [])
-      print_scan_results(output.length, error_messages.length)
+    def self.print_output(unused_methods, unused_variables, error_messages = [])
+      print_scan_results(unused_methods.length, unused_variables.length, error_messages.length)
 
-      if output.any?
+      if unused_methods.any?
         puts NEW_LINE
         puts "Unused methods in your project:"
         puts NEW_LINE
-        output.each do |method_name, location|
+        unused_methods.each do |method_name, location|
           puts "#{method_name}: #{location}"
         end
       end
 
+      if unused_variables.any?
+        puts NEW_LINE
+        puts "Unused variables in your project:"
+        puts NEW_LINE
+        unused_variables.each do |variable_name, location|
+          puts "#{variable_name}: #{location}"
+        end
+      end
+
       if error_messages.any?
         puts NEW_LINE
         puts "Errors encountered while processing:"
@@ -25,10 +34,11 @@ module Gravedigger
       end
     end
 
-    def self.print_scan_results(output_length, error_messages_length)
+    def self.print_scan_results(unused_methods_length, unused_variables_length, error_messages_length)
       puts "="*80 + NEW_LINE
       puts "Scanning completed."
-      puts print_with_green_color(output_length) + " unused method definitions found."
+      puts print_with_green_color(unused_methods_length) + " unused method definitions found."
+      puts print_with_green_color(unused_variables_length) + " unused variable definitions found."
       puts print_with_red_color(error_messages_length) + " errors encountered."
       puts "="*80 +NEW_LINE
     end

data/lib/gravedigger/usage_searcher.rb

@@ -2,10 +2,9 @@
 
 module Gravedigger
   module UsageSearcher
-    def self.search_methods(method_definitions)
-      all_file_names = Dir[File.join(Dir.pwd,"/{app,lib,config}/**/*.{erb,haml,rb}")]
+    def self.search_methods(method_definitions, files_to_search)
       errors = []
-      all_file_names.each do |fileName|
+      files_to_search.each do |fileName|
         begin
           File.open(fileName).each_line do |line|
             next unless line
@@ -15,12 +14,44 @@ module Gravedigger
             end
           end
         rescue StandardError => error
-          errors << "Error while searching method: #{method_name} in file: #{fileName}\n"\
+          errors << "Error while searching method in file: #{fileName}\n"\
 "#{error.message}"
         end
       end
 
       return method_definitions, errors
     end
+
+    def self.search_variables(variable_definitions, files_to_search)
+      errors = []
+      files_to_search.each do |fileName|
+        begin
+          File.readlines(fileName).each_with_index do |line,index|
+            next unless line
+            variable_usage_matchs = line.scan(/[ \(\{\[\=\,\+\*\-\/\:]+([A-Za-z0-9\_\-\?\!\@]+)/)
+            variable_usage_matchs.each do |variable_usage_match|
+              next unless variable_usage_match
+              variable_usage = extract_variable_usage(variable_usage_match)
+              if variable_definitions[variable_usage] != "[#{fileName}:#{index+1}]"
+                variable_definitions.delete(variable_usage)
+              end
+              
+            end
+          end
+        rescue StandardError => error
+          errors << "Error while searching variable in file: #{fileName}\n"\
+"#{error.message}"
+        end
+      end
+
+      return variable_definitions, errors
+    end
+
+    def self.extract_variable_usage(variable_usage_match)
+      variable_usage = variable_usage_match.first
+      variable_usage.sub!(/[@!]/, '')  # remove ! and @ characters from string
+
+      variable_usage
+    end
   end
 end

data/lib/gravedigger/version.rb

@@ -1,3 +1,3 @@
 module Gravedigger
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gravedigger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Oğuzhan Göller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-14 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler