mccabe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86c4e0a18d0b2971e6d30c63b019ca1bb74d02ef
+  data.tar.gz: 2d457e73f9afd1cccb07a539763171a88f4e8547
+SHA512:
+  metadata.gz: 02a5ed82955b75ae647e513fa3b615959756fe0186c485277b85e509d050170ae8b75358e2be7956b89069cfe0b8b8560d5880c700752a97b92f85ad838fde9a
+  data.tar.gz: 48eb68e4fc58b95c73f9f2eb745ff40bfe87bab48b2ce3ca6876c5c878517f13b8f19937d4f35a53f88a83bb1db5c62c23e293bdb0679d224eeeb066b7037ca9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mccabe.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Mason
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# McCabe
+
+Measure the McCabe or [cyclomatic](http://en.wikipedia.org/wiki/Cyclomatic_complexity)
+complexity of Ruby code.
+
+## Installation
+
+```
+$ gem install mccabe
+```
+
+## Usage
+
+From the command line, pass the list of files you want to analyze. You can
+optionally specify your own threshold as the first argument. The default
+threshold is 4. You will get error messages for any methods which have
+complexity greater than the threshold.
+
+If the first argument is not an integer, it will be interpreted as a file
+pattern (any other arguments are also file patterns).
+
+Note that the script only considers files with .rb extensions, so that it
+doesn't attempt to parse other languages as Ruby. So, if you have
+extensionless Ruby scripts, you won't be able to use this on them.
+
+Examples:
+```
+mccabe file1 ../file2
+mccabe 3 file1 # using a different threshold
+mccabe *.rb # wildcards work, too
+mccabe . # can also look through entire directories
+```
+
+## Contributing
+
+Fork and pull.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

data/bin/mccabe

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'mccabe/analyzer'
+require 'mccabe/cli'
+require 'mccabe/parser'
+
+options = McCabe::CLI.new.parse!(ARGV)
+
+if ARGV.empty?
+  puts "Please specify at least one file"
+  exit 1
+end
+
+results = McCabe::CLI.get_all_files(ARGV).map do |file|
+  file_results = McCabe::Analyzer.analyze(McCabe::Parser.parse(File.read(file)))
+  file_results.keep_if { |method, info| info[:complexity] > options[:threshold] }
+  unless options[:quiet]
+    McCabe::CLI.display_results(file_results) unless file_results.empty?
+  end
+  file_results
+end
+
+exit 1 unless results.flatten.empty?

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mccabe/analyzer.rb

@@ -0,0 +1,25 @@
+require 'mccabe/parser'
+
+module McCabe
+  class Analyzer
+    BRANCH_TYPES = [:if, :while, :until, :for, :when, :and, :or]
+
+    def self.analyze(ast)
+      results = {}
+      McCabe::Parser.collect_methods(ast).each do |name, method|
+        results[name] = {line: method[:line], complexity: complexity(method[:body])}
+      end
+      results
+    end
+
+    def self.complexity(ast)
+      nodes, complexity = [ast], 0
+      until nodes.empty?
+        node = nodes.shift
+        complexity += 1 if BRANCH_TYPES.include?(node.type)
+        nodes += node.children.select { |child| child.is_a? ::Parser::AST::Node }
+      end
+      complexity
+    end
+  end
+end

data/lib/mccabe/cli.rb

@@ -0,0 +1,72 @@
+require 'optparse'
+
+require 'mccabe/version'
+
+module McCabe
+  class CLI
+    DEFAULT_OPTIONS = {
+      threshold: 4,
+      quiet: false
+    }
+
+    # Print out the results of a file to the console.
+    def self.display_results(file_results)
+      file_results.each do |method, info|
+        puts "\t#{method} (line #{info[:line]}) had a complexity of #{info[:complexity]}"
+      end
+    end
+
+    # Get all files recursively.
+    def self.get_all_files(patterns)
+      files = []
+      patterns.each do |pattern|
+        files |=
+          if File.directory? pattern
+            sub_patterns =
+              (Dir.entries(pattern) - ['.', '..']).map { |sub_pat| "#{pattern}/#{sub_pat}" }
+            get_all_files(sub_patterns)
+          else
+            Dir[pattern]
+          end
+      end
+      files.select { |file| file.end_with? '.rb' }
+    end
+
+    def parse!(argv)
+      option_parser.parse! argv
+      DEFAULT_OPTIONS.merge options
+    end
+
+    private
+
+    def options
+      @options ||= {}
+    end
+
+    def option_parser
+      @option_parser ||= OptionParser.new do |option_parser|
+        option_parser.banner = "Usage: #{$0} file1... [options]"
+
+        option_parser.on '-tTHRESHOLD',
+                         '--threshold',
+                         "threshold of mccabe's complexity to allow through" do |t|
+          options[:threshold] = t.to_i
+        end
+
+        option_parser.on '--quiet', "No output to stdout. Exit code only (1 for failure)." do |q|
+          options[:quiet] = q
+        end
+
+        option_parser.on_tail '-h', '--help', "Display this help message" do
+          puts option_parser
+          exit 0
+        end
+
+        option_parser.on_tail '--version' do
+          puts "#{$0} #{McCabe::VERSION}"
+          exit 0
+        end
+      end
+    end
+  end
+end

data/lib/mccabe/parser.rb

@@ -0,0 +1,24 @@
+require 'parser/current'
+
+module McCabe
+  class Parser < Parser::CurrentRuby
+    # Collect all the methods from the AST.
+    def self.collect_methods(ast)
+      methods = {}
+      nodes = [ast]
+      until nodes.empty?
+        node = nodes.shift
+        case node.type
+        when :def, :defs
+          name = node.children.length == 4 ? node.children[1] : node.children.first
+          methods[name] = {body: node.children.last, line: node.loc.line}
+        when :class, :module, :begin
+          # Have to put node.children in an array and flatten in because the parser
+          # returns a frozen array.
+          nodes += node.children.select { |child| child.is_a? ::Parser::AST::Node }
+        end
+      end
+      methods
+    end
+  end
+end

data/lib/mccabe/version.rb

@@ -0,0 +1,3 @@
+module McCabe
+  VERSION = "0.1.0"
+end

data/lib/mccabe.rb

@@ -0,0 +1,2 @@
+module McCabe
+end

data/mccabe.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mccabe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mccabe"
+  spec.version       = McCabe::VERSION
+  spec.authors       = ["Andrew Mason"]
+  spec.email         = ["mason@case.edu"]
+
+  spec.summary       = %q{Tool for measuring McCabe's complexity of Ruby code.}
+  spec.homepage      = "https://github.com/ajm188/mccabe"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['mccabe']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'parser'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: mccabe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- mason@case.edu
+executables:
+- mccabe
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/mccabe
+- bin/setup
+- lib/mccabe.rb
+- lib/mccabe/analyzer.rb
+- lib/mccabe/cli.rb
+- lib/mccabe/parser.rb
+- lib/mccabe/version.rb
+- mccabe.gemspec
+homepage: https://github.com/ajm188/mccabe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Tool for measuring McCabe's complexity of Ruby code.
+test_files: []