deadlyzer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44f9e798e87a8ce44f9cc08c7ebe56e3e9d9078f49cb0bcc25955f804c6961d8
+  data.tar.gz: d99a693be1a3d66c2cd4d0b459508ad07faafec82b8ff53fba0e8f6ebafc22e4
+SHA512:
+  metadata.gz: 07743314cfc763ba0ab1f2125fecfc93200747863453490e6671e5882b471ab2cd111bab3fa631ce9cf5525879438513681ae3a3cb5f16398cec102636bcf1c2
+  data.tar.gz: 1423f22fe859022afbf0a9fc9319e75ca49da0452a82d7b768f3411cffb47779f4c81782fe3d6c450b41dc187965391f11de2243183d8b513e3052d553d5e6f4

data/README.md

@@ -0,0 +1,47 @@
+# Deadlyzer
+Deadlyzer lets you to compare directories and reveal unreferenced, uncalled constats to remove
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deadlyzer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install deadlyzer
+
+## Usage
+
+To use deadlyzer you should create deadlyzer.yml file with following content
+
+```yaml
+target: 
+  path: './app/workers'
+  exclude_consts:
+    - 'Sidekiq::Worker' 
+against:   
+  path: './app/controllers'
+```
+
+Available options
+
+* exclude_const (Array)
+* exclude_dirs  (Array)
+
+```sh
+user@desktop: ~$ deadlyzer # to run
+```
+
+## Development
+
+Working principle is simple enough. Gem uses Rubocup and Parser gems to creat Abstract Syntax Tree. Using '(const ...)' pattern to match with nodes on the tree
+
+## Contributing
+Deadlyzer is still under development and created to use personal purpose where problems can solve with finding uncalled constants. If you also need it or would like to contribute it would be great :)

data/bin/console

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

@@ -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/exe/deadlyzer

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# require "bundler/setup"
+require "deadlyzer"
+
+analyzer = Deadlyzer::Analyzer.new(ARGV)
+analyzer.analize!

data/lib/deadlyzer/analyzer/configurator.rb

@@ -0,0 +1,10 @@
+require 'ostruct'
+
+module Deadlyzer
+  class Analyzer
+    
+    # @api private
+    # @since 0.1.0
+    class Configurator < OpenStruct; end
+  end
+end

data/lib/deadlyzer/analyzer/utils.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+module Deadlyzer
+  class Analyzer
+    module Utils
+      def self.included(base)
+        base.include InstanceMethods
+      end
+
+      module InstanceMethods
+        # @api private
+        # @since 0.1.0
+        def parse_yaml(path)
+          ctx = read_file(path)
+
+          YAML.load(ctx)
+        end
+        
+        # Default name of config file
+        # @api private
+        # @since 0.1.0
+        def default_config_file
+          './deadlyzer.yml'
+        end
+
+        # @api private
+        # @since 0.1.0
+        def read_file(path)
+          File.read(File.expand_path(path))
+        end
+        
+      end
+    end
+  end
+end

data/lib/deadlyzer/analyzer.rb

@@ -0,0 +1,140 @@
+require 'deadlyzer/analyzer/utils'
+require 'deadlyzer/analyzer/configurator'
+require 'deadlyzer/constant_loader'
+require 'deadlyzer/ast_parser'
+
+require 'spinning_cursor'
+require 'corol'
+
+module Deadlyzer
+  class Analyzer
+    include Deadlyzer::Analyzer::Utils
+    
+    # @api private
+    # @since 0.1.0
+    attr_reader :config_file
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :config
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :config_file_ctx
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :target_constants
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :against_constants
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :constants_may_not_used
+
+    attr_reader :empty_files
+    
+    def initialize(argv = [])
+      @config_file            = argv.pop || default_config_file
+      @empty_files            = []
+      @constants_may_not_used = []
+    end
+
+    # Main wrapper analize method
+    # @since 0.1.0
+    def analize!
+      SpinningCursor.run do
+        banner "Analyzing".yellow
+        type :dots
+        
+        action do
+          read_configs!
+          load_config!
+          load_target_constants!
+          load_against_constants!
+          match!
+          send_out!
+        end
+      end
+    end
+
+    private
+    # @api private
+    # @since 0.1.0
+    def read_configs!
+      @config_file_ctx = parse_yaml(config_file)
+    rescue
+      puts 'No config file found'
+      exit 1
+    end
+
+    # @api private
+    # @since 0.1.0
+    def load_config!
+      @config = Configurator.new(config_file_ctx)
+    end
+
+    # @api private
+    # @since 0.1.0
+    def load_target_constants!
+      cl = ConstantLoader.new(
+        directory:       config.target.fetch('path',           nil),
+        excluded_dirs:   config.target.fetch('exclude_dirs',   nil),
+        excluded_consts: config.target.fetch('exclude_consts', nil),
+      )
+      
+      empty_files.push cl.empty_files.uniq
+      @target_constants = cl.constants.uniq
+    end
+
+    # @api private
+    # @since 0.1.0
+    def load_against_constants!
+      cl = ConstantLoader.new(
+        directory:       config.against.fetch('path',           nil),
+        excluded_dirs:   config.against.fetch('exclude_dirs',   nil),
+        excluded_consts: config.against.fetch('exclude_consts', nil),
+      )
+      
+      empty_files.push cl.empty_files.uniq
+      @against_constants = cl.constants.uniq
+    end
+
+    # @api private
+    # @since 0.1.0
+    def match!
+      match_constants(target: target_constants, against: against_constants)
+      constants_may_not_used
+    end
+
+    # @api private
+    # @since 0.1.0
+    def send_out!
+      puts "Files might be empty"
+      empty_files.each do |file|
+        puts file
+      end
+
+      puts "\nContants may not refered\n"
+      constants_may_not_used.each do |constant|
+        puts constant
+      end
+    end
+
+    # @api private
+    # @since 0.1.0
+    def match_constants(target:, against:)
+      used_constants = target.select do |tc|
+         tc.name if against.any? {|ac| ac.name == tc.name}
+      end
+      
+      constants = (used_constants + target).group_by(&:itself).transform_values(&:count)
+      constants.each do |constant, count|
+        constants_may_not_used.push constant if count < 2
+      end
+    end
+
+  end
+end

data/lib/deadlyzer/ast_matcher.rb

@@ -0,0 +1,36 @@
+module Deadlyzer
+  module AST
+    class Matcher
+      # @api private
+      # @since 0.1.0
+      DEFAULT_PATTERN = '(const ... )'
+
+      # @api private
+      # @since 0.1.0
+      attr_reader :matcher
+      
+      # @api private
+      # @since 0.1.0
+      attr_reader :pattern
+      
+      def initialize(matcher: nil, pattern: nil)
+        @matcher  = matcher || default_matcher
+        @pattern  = pattern || DEFAULT_PATTERN
+      end
+
+      # @api private
+      # @since 0.1.0
+      def match(node:)
+        matcher.new(pattern).match(node)
+      end
+
+      private
+      # @api private
+      # @since 0.1.0
+      def default_matcher
+        require 'rubocop'
+        RuboCop::NodePattern
+      end    
+    end
+  end
+end

data/lib/deadlyzer/ast_parser.rb

@@ -0,0 +1,47 @@
+module Deadlyzer
+  module AST
+    class Parser
+      # AST Parser
+      # @api private
+      # @since 0.1.0
+
+      # @api private
+      # @since 0.1.0
+      attr_reader :parser
+      
+      # @since 0.1.0
+      attr_reader :ast
+
+      # @since 0.1.0
+      attr_reader :file
+
+      def initialize(parser: nil)
+        @parser = parser || default_parser
+      end
+
+      # @api private
+      # @since 0.1.0
+      def parse(code, file = nil)
+        processed_source = parse_code(code, file)
+        @ast             = processed_source.ast
+        @file            = processed_source.path
+        self
+      end
+
+      private
+      # @api private
+      # @since 0.1.0
+      def default_parser
+        require 'rubocop'
+        RuboCop::ProcessedSource
+      end
+
+      # @api private
+      # @since 0.1.0
+      def parse_code(code, file)
+        parser.new(code, RUBY_VERSION.to_f, file)
+      end
+
+    end
+  end
+end

data/lib/deadlyzer/constant_loader.rb

@@ -0,0 +1,186 @@
+require 'deadlyzer/ast_parser'
+require 'deadlyzer/ast_matcher'
+
+module Deadlyzer
+  class ConstantLoader
+    CURRENT_DIRECTORY = File.expand_path('.', __dir__)
+    DEFAULT_PATTERN   = '/**/*.rb'
+    
+    # @api private
+    # @since 0.1.0
+    attr_reader :directory
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :excluded_dirs
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :empty_files
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :excluded_consts
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :exclude
+
+    # @api private
+    # @since 0.1.0
+    attr_reader :pattern
+
+    # @api private
+    # @since 0.1.0
+    attr_accessor :ast
+    
+    def initialize(directory: nil, excluded_dirs: nil, excluded_consts: nil, pattern: nil)
+      @directory       = directory
+      @excluded_dirs   = excluded_dirs || []
+      @excluded_consts = excluded_consts || []
+      @pattern         = pattern       || DEFAULT_PATTERN
+      @ast             = []
+      @constants       = []
+      @empty_files     = []
+    end
+
+    # @api private
+    # @since 0.1.0
+    def constants
+      load_ast!
+      load_matcher!
+      load_constants!
+      @constants
+    end
+
+    private
+    # @api private
+    # @since 0.1.0
+    def load_ast!
+      files.each do |file|
+        # TODO: check momory issue
+        parser = Deadlyzer::AST::Parser.new
+        ast.push parser.parse(read(file), file)
+      end
+    end
+
+    # @api private
+    # @since 0.1.0
+    def load_matcher!
+      @matcher = Deadlyzer::AST::Matcher.new
+    end
+
+    # @api private
+    # @since 0.1.0
+    def load_constants!
+      ast.each do |node|
+        @empty_files.push node.file && next if node.ast.nil?
+        
+        file    = node.file
+        results = determine_consts(@matcher, node.ast)
+
+        results.each do |result|
+          line, name = humanize_const(result)
+          @constants.push(Constant.new(file, line, name)) unless excluded_consts.include?(name)
+        end
+      end
+    end
+
+    # @api private
+    # @since 0.1.0
+    def determine_consts(matcher, node)
+      match = matcher.match(node: node)
+      if match
+        match == true ? node : [match, node]
+      else
+        if node.respond_to?(:children) && !node.children.empty?
+          node.children.grep(RuboCop::AST::Node).flat_map{|e| determine_consts(matcher, e)}.compact
+        end
+      end
+    end
+
+    # @api private
+    # @since 0.1.0
+    def humanize_const(result)
+      if result.is_a?(RuboCop::AST::Node)
+        range = result.source_range
+        result = result.source
+      else
+        result, node = result
+        range = node.source_range
+      end
+      [range.line, result, :ruby]
+    end
+
+    # @api private
+    # @since 0.1.0
+    def files
+      target_directory = list_dir(path(directory + pattern))
+      remove(files: excluded_files, from: target_directory)
+    end
+
+    # @api private
+    # @since 0.1.0
+    def excluded_files
+      excluded_dirs.flat_map {|dir| list_dir(path(dir+ pattern))}.flatten
+    end
+
+    # @api private
+    # @since 0.1.0
+    # def excluded_constants
+
+    # end
+    
+    # @api private
+    # @since 0.1.0
+    def path(dir)
+      File.expand_path(dir)
+    end
+
+    # @api private
+    # @since 0.1.0
+    def list_dir(dir)
+      Dir[dir]
+    end
+
+    # @api private
+    # @since 0.1.0
+    def remove(files:, from:)
+      files.each do |file|
+        from.delete file
+      end
+      from
+    end
+
+    # @api private
+    # @since 0.1.0
+    def read(file)
+      File.read file
+    end
+
+    # @api private
+    # @since 0.1.0
+    class Constant
+      require 'coderay'
+
+      attr_reader :file
+      attr_reader :line
+      attr_reader :name
+      def initialize(file, line, name)
+        @file = file
+        @line = line
+        @name = name
+      end
+
+      def to_s
+        [file, line, rubyize(name)].join(':')
+      end
+
+      private
+      def rubyize(name)
+        " #{CodeRay.scan(name, :ruby).term}"
+      end
+    end
+
+  end
+end

data/lib/deadlyzer/version.rb

@@ -0,0 +1,5 @@
+module Deadlyzer
+  # @api private
+  # @since 0.1.0
+  VERSION = "0.1.0"
+end

data/lib/deadlyzer.rb

@@ -0,0 +1,5 @@
+require 'deadlyzer/analyzer'
+require 'deadlyzer/version'
+
+module Deadlyzer
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: deadlyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Farhad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spinning_cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: corol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Scan find unused constant on other directories, compare and remove
+email:
+- farhad9801@gmail.com
+executables:
+- deadlyzer
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- exe/deadlyzer
+- lib/deadlyzer.rb
+- lib/deadlyzer/analyzer.rb
+- lib/deadlyzer/analyzer/configurator.rb
+- lib/deadlyzer/analyzer/utils.rb
+- lib/deadlyzer/ast_matcher.rb
+- lib/deadlyzer/ast_parser.rb
+- lib/deadlyzer/constant_loader.rb
+- lib/deadlyzer/version.rb
+homepage: https://github.com/0x2C6/deadlyzer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Reveal uncalled constants
+test_files: []