gravedigger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 981a99b8dd89163d3a8b3da974548b4218571936a43f28924175f9fc67720fef
-  data.tar.gz: 8c9feed4b4615b0e95cf1a8d665f90d682b717684b15119cf8de22a04e4706a8
+  metadata.gz: 000db92231504a24d3ab6d87569148eafaa6d355af6192ebbb8efa0f8c881392
+  data.tar.gz: c4242466fcd30cc7a49a429b9e897732e09f441c06c8fc654bb68a12f53e8f1e
 SHA512:
-  metadata.gz: 7b8d7a8b07b0da61c993342de347d968a267d4c9581418633d47c4ef4e1fc1893908ec75a88f665cf149c8d66f978641a7e222f64a7cb98aab15795407e716de
-  data.tar.gz: c3414c46a831f2224392b1099135e95d38c906c0a20683a345ded1c90f05a8d3fed053745fe870fd0d9387c5e5540588d1083984f244762f067f604df045df75
+  metadata.gz: 545d8998fa99660778cc4686699c8d86d8b0ae6f6db2164f6bf9d7f4917c720db9ee98daeb12383253f3014317592bc1ecca2a5fb9c41211244fedab5c400190
+  data.tar.gz: f68a4188b3cad386ea55a7da0d45f7603516682f086b3f7243109a0a0968f9664b61f87b8adfac5d14ab44cb0908243472768c2082af9a49397c15825993af97

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    gravedigger (0.1.0)
-      thor (~> 0.20.3)
+    gravedigger (0.1.1)
+      thor
 
 GEM
   remote: https://rubygems.org/

data/gravedigger.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 
-  spec.add_dependency('thor', '~> 0.20.3')
+  spec.add_dependency('thor')
 end

data/lib/gravedigger/definition_finder.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Gravedigger
+  module DefinitionFinder
+    def self.get_definitions
+      all_file_names = Dir[File.join(Dir.pwd,"/{app,lib,config}/**/*.{erb,haml,rb}")]
+      method_definitions = {}
+      errors = []
+
+      all_file_names.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}]"
+
+          method_definitions[method_name] = location if method_name
+        end
+        rescue StandardError => error
+          errors << "Error while reading file: #{fileName} \n #{error.message}"
+        end
+      end
+
+      return method_definitions, errors
+    end
+
+    def self.find_method_definitions(line)
+      find_method_regex_result = line[/[ ]+def [a-zA-Z0-9?_.\!]*/]
+      if find_method_regex_result
+        method_name = find_method_regex_result.strip.slice(4..-1)
+        method_name = method_name.slice(0,4) if method_name && method_name[0..4] == 'self.'
+      end
+      method_name
+    end
+  end
+end

data/lib/gravedigger/output_printer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Gravedigger
+  module OutputPrinter
+    NEW_LINE = "\n"
+    def self.print_output(output, error_messages = [])
+      print_scan_results(output.length, error_messages.length)
+
+      if output.any?
+        puts NEW_LINE
+        puts "Unused methods in your project:"
+        puts NEW_LINE
+        output.each do |method_name, location|
+          puts "#{method_name}: #{location}"
+        end
+      end
+
+      if error_messages.any?
+        puts NEW_LINE
+        puts "Errors encountered while processing:"
+        puts NEW_LINE
+        error_messages.each do |error_message|
+          puts error_message
+        end
+      end
+    end
+
+    def self.print_scan_results(output_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_red_color(error_messages_length) + " errors encountered."
+      puts "="*80 +NEW_LINE
+    end
+
+    def self.print_with_green_color(string)
+      "\e[32m#{string}\e[0m"
+    end
+
+    def self.print_with_red_color(string)
+      "\e[31m#{string}\e[0m"
+    end
+  end
+end

data/lib/gravedigger/usage_searcher.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Gravedigger
+  module UsageSearcher
+    def self.search_methods(method_definitions)
+      all_file_names = Dir[File.join(Dir.pwd,"/{app,lib,config}/**/*.{erb,haml,rb}")]
+      errors = []
+      all_file_names.each do |fileName|
+        begin
+          File.open(fileName).each_line do |line|
+            next unless line
+            method_usage_matches = line.scan(/(?<!def)[ \.\-\:\'\(\{\!\=\&\#\[\*]+([a-zA-Z0-9?_\!]+)?(?=[\\ \,\/\[\'\:\(\)\.\}]|$)/)
+            method_usage_matches.each do |method_usage_match|
+              method_definitions.delete(method_usage_match.first) if method_usage_match
+            end
+          end
+        rescue StandardError => error
+          errors << "Error while searching method: #{method_name} in file: #{fileName}\n"\
+"#{error.message}"
+        end
+      end
+
+      return method_definitions, errors
+    end
+  end
+end

data/lib/gravedigger/version.rb

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

data/lib/gravedigger.rb

@@ -1,10 +1,20 @@
 require "thor"
-require "rubygems"
+require "gravedigger/definition_finder.rb"
+require "gravedigger/usage_searcher"
+require "gravedigger/output_printer"
 
 module Gravedigger
   class CLI < Thor
+
     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)
+
+      errors = get_definitions_errors.concat method_search_errors
+
+      Gravedigger::OutputPrinter.print_output(output, errors)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gravedigger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Oğuzhan Göller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-24 00:00:00.000000000 Z
+date: 2019-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: '0'
 description: Gravedigger iterates through your project searching unused   methods
   and constants, helping you detect and eliminate dead code.
 email:
@@ -76,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -83,11 +84,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
 - bin/gravedigger
-- bin/setup
 - gravedigger.gemspec
 - lib/gravedigger.rb
+- lib/gravedigger/definition_finder.rb
+- lib/gravedigger/output_printer.rb
+- lib/gravedigger/usage_searcher.rb
 - lib/gravedigger/version.rb
 homepage: https://github.com/oguzhangoller/gravedigger
 licenses:

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "gravedigger"
-
-# 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