cycromatic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 737d504d14a3c4223d39792e314668df88d39f8b
+  data.tar.gz: 628f94b6c7cf38e27ff1104fb083169a6e1f4cc6
+SHA512:
+  metadata.gz: 8ee208f67d4f325f0cb5ee15d0820270f899700375471761ed818917696f3bef5df04999348b8ac75e8fed238def6b5788784ec1a7232a86edae8a1c433c799b
+  data.tar.gz: 9e8b3cbabf294d6620b218a67bd7aed7340ffafb69d41a364e6a66d8cc572f74655c120acd7d6a3c80c6c23a1cc3f2eb2331a45438796cb36512f9de49b43fef

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    cycromatic (0.1.0)
+      parser (~> 2.3)
+      rainbow (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    minitest (5.9.0)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    rainbow (2.1.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  cycromatic!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -0,0 +1,57 @@
+# Cycromatic
+
+Cycromatic calculates cyclomatic complexity of Ruby programs.
+
+* Cyclomatic Complexity - https://en.wikipedia.org/wiki/Cyclomatic_complexity
+
+## Installation
+
+Install by `gem`:
+
+    $ gem install cycromatic
+
+## Usage
+
+Run `cycromatic` command to calculate complexity:
+
+```
+$ cycromatic ruby_program.rb    # Specify paths to .rb files
+$ cycromatic app config         # Specify directories including .rb files
+```
+
+The output will be like the following:
+
+```
+$ cycromatic ../contror/lib/contror/anf/translator.rb
+../contror/lib/contror/anf/translator.rb	[toplevel]:1	1
+../contror/lib/contror/anf/translator.rb	initialize:8	1
+../contror/lib/contror/anf/translator.rb	translate:14	1
+../contror/lib/contror/anf/translator.rb	with_new_block:20	3
+../contror/lib/contror/anf/translator.rb	current_block:37	1
+../contror/lib/contror/anf/translator.rb	push_stmt:41	1
+../contror/lib/contror/anf/translator.rb	normalize_node:46	3
+../contror/lib/contror/anf/translator.rb	translate0:59	52
+../contror/lib/contror/anf/translator.rb	translate_arg:478	3
+../contror/lib/contror/anf/translator.rb	translate_call:491	2
+../contror/lib/contror/anf/translator.rb	translate_params:533	2
+../contror/lib/contror/anf/translator.rb	value_node?:547	7
+../contror/lib/contror/anf/translator.rb	fresh_var:566	1
+../contror/lib/contror/anf/translator.rb	translate_var:571	5
+```
+
+The tool accepts `--format=json` option to output in JSON format.
+
+## Calculation
+
+It calculates complexities as the following:
+
+* Basic block have complexity of 1 (base case)
+* Branching construct have complexity of 1
+* Loop construct have complexity of 1
+* `&&` and `||` have complexity of 1
+* Safe navigation operator have complexity of 1
+* Passing iterator block does not introduce complexity
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cycromatic.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cycromatic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cycromatic"
+  spec.version       = Cycromatic::VERSION
+  spec.authors       = ["Soutaro Matsumoto"]
+  spec.email         = ["matsumoto@soutaro.com"]
+
+  spec.summary       = %q{Cyclomatic Complexity}
+  spec.description   = %q{Compute Cyclomatic Complexity of Ruby programs}
+  spec.homepage      = "https://github.com/cycromatic"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "rainbow", "~> 2.1"
+  spec.add_dependency "parser", "~> 2.3"
+end

data/exe/cycromatic

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(__dir__, "../lib")
+
+require 'cycromatic'
+require 'cycromatic/cli'
+
+Cycromatic::CLI.start

data/lib/cycromatic/calculator.rb

@@ -0,0 +1,79 @@
+module Cycromatic
+  class Calculator
+    attr_reader :node
+
+    def initialize(node:)
+      @node = node
+    end
+
+    def each_complexity(&block)
+      if block_given?
+        calculate_toplevel node, &block
+      else
+        enum_for :each_complexity
+      end
+    end
+
+    private
+
+    COMPLEX_NODE_TYPES = Set.new([:if, :while, :while_post, :when, :resbody, :csend, :for,
+                                  :and, :or,
+                                  :optarg, :kwoptarg])
+
+    def calculate_toplevel(node, &block)
+      value = calculate_node(node, &block)
+      yield Complexity.new(type: :toplevel, node: node, value: value + 1)
+    end
+
+    def calculate_def(node, &block)
+      value = 0
+
+      case node.type
+      when :def
+        args = node.children[1]
+        body = node.children[2]
+      when :defs
+        args = node.children[2]
+        body = node.children[3]
+      end
+
+      value += calculate_node(args, &block)
+      value += calculate_node(body, &block) if body
+
+      yield Complexity.new(type: :method, node: node, value: value + 1)
+    end
+
+    def calculate_node(node, &block)
+      count = 0
+
+      case node.type
+      when :def
+        calculate_def node, &block
+        return 0
+      when :defs
+        calculate_def node, &block
+        return calculate_node(node.children[0], &block)
+      when :case
+        if node.children.last
+          count = 1
+        end
+      when :rescue
+        if node.children.last
+          count = 1
+        end
+      else
+        if COMPLEX_NODE_TYPES.include?(node.type)
+          count = 1
+        end
+      end
+
+      count + node.children.flat_map do |child|
+        if child.is_a? Parser::AST::Node
+          [calculate_node(child, &block)]
+        else
+          []
+        end
+      end.inject(0) {|x, y| x + y }
+    end
+  end
+end

data/lib/cycromatic/cli.rb

@@ -0,0 +1,50 @@
+require 'optparse'
+require 'rainbow'
+require 'pathname'
+
+module Cycromatic
+  class CLI
+    attr_reader :args
+
+    def self.start(args = ARGV)
+      self.new(args).run
+    end
+
+    def initialize(args)
+      @args = args
+
+      OptionParser.new do |opts|
+        opts.on("--format FORMAT") {|fmt| @format = fmt }
+      end.parse!(args)
+    end
+
+    def run
+      formatter = @format == 'json' ? JSONFormatter.new(io: STDOUT) : TextFormatter.new(io: STDOUT)
+
+      FileEnumerator.new(paths: paths).each do |path|
+        formatter.started path: path
+        begin
+          node = Parser::CurrentRuby.parse(path.read, path.to_s)
+          if node
+            Calculator.new(node: node).each_complexity do |complexity|
+              formatter.calculated(path: path, complexity: complexity)
+            end
+          end
+        rescue => exn
+          require 'pp'
+          p exn
+          pp exn.backtrace
+          formatter.error(path: path, exception: exn)
+        ensure
+          formatter.finished path: path
+        end
+      end
+
+      formatter.completed
+    end
+
+    def paths
+      args.map {|arg| Pathname(arg) }
+    end
+  end
+end

data/lib/cycromatic/complexity.rb

@@ -0,0 +1,13 @@
+module Cycromatic
+  class Complexity
+    attr_reader :type
+    attr_reader :node
+    attr_reader :value
+
+    def initialize(type:, node:, value:)
+      @type = type
+      @node = node
+      @value = value
+    end
+  end
+end

data/lib/cycromatic/file_enumerator.rb

@@ -0,0 +1,55 @@
+module Cycromatic
+  class FileEnumerator
+    attr_reader :paths
+
+    def initialize(paths:)
+      @paths = paths
+    end
+
+    def each(&block)
+      if block_given?
+        paths.each do |path|
+          case
+          when path.file?
+            yield path
+          when path.directory?
+            enumerate_files_in_dir(path, &block)
+          end
+        end
+      else
+        self.enum_for :each
+      end
+    end
+
+    private
+
+    def enumerate_files_in_dir(path, &block)
+      if path.basename.to_s =~ /\A\.[^\.]+/
+        # skip hidden paths
+        return
+      end
+
+      case
+      when path.directory?
+        path.children.each do |child|
+          enumerate_files_in_dir child, &block
+        end
+      when path.file?
+        if is_ruby_file?(path)
+          yield path
+        end
+      end
+    end
+
+    def is_ruby_file?(path)
+      case
+      when path.extname == ".rb"
+        true
+      when path.extname == ".gemspec"
+        true
+      when path.basename.to_s == "Rakefile"
+        true
+      end
+    end
+  end
+end

data/lib/cycromatic/json_formatter.rb

@@ -0,0 +1,48 @@
+module Cycromatic
+  class JSONFormatter
+    attr_reader :io
+
+    def initialize(io:)
+      @io = io
+      @results = {}
+    end
+
+    def started(path:)
+      @path_results = []
+      @results[path.to_s] = { results: @path_results }
+    end
+
+    def finished(path:)
+      @path_results = nil
+    end
+
+    def completed
+      @io.puts @results.to_json
+    end
+
+    def error(path:, exception:)
+      @results[path.to_s] = {
+        error: {
+          message: exception.to_s,
+          trace: exception.backtrace
+        }
+      }
+    end
+
+    def calculated(path:, complexity:)
+      loc = complexity.node.loc
+      name = case complexity.type
+             when :toplevel
+               "[toplevel]"
+             when :method
+               complexity.node.children.find {|c| c.is_a? Symbol }.to_s
+             end
+
+      @path_results << {
+        method: name,
+        line: [loc.first_line, loc.last_line],
+        complexity: complexity.value
+      }
+    end
+  end
+end

data/lib/cycromatic/text_formatter.rb

@@ -0,0 +1,34 @@
+module Cycromatic
+  class TextFormatter
+    attr_reader :io
+
+    def initialize(io:)
+      @io = io
+    end
+
+    def started(path:)
+    end
+
+    def finished(path:)
+    end
+
+    def completed
+    end
+
+    def error(path:, exception:)
+      io.puts "#{path}\t(error)"
+    end
+
+    def calculated(path:, complexity:)
+      loc = complexity.node.loc
+      name = case complexity.type
+             when :toplevel
+               "[toplevel]"
+             when :method
+               complexity.node.children.find {|c| c.is_a? Symbol }.to_s
+             end
+
+      io.puts "#{path}\t#{name}:#{loc.first_line}\t#{complexity.value}"
+    end
+  end
+end

data/lib/cycromatic/version.rb

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

data/lib/cycromatic.rb

@@ -0,0 +1,9 @@
+require 'parser/current'
+require 'json'
+
+require "cycromatic/version"
+require 'cycromatic/complexity'
+require 'cycromatic/calculator'
+require 'cycromatic/file_enumerator'
+require 'cycromatic/text_formatter'
+require 'cycromatic/json_formatter'

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: cycromatic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Soutaro Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Compute Cyclomatic Complexity of Ruby programs
+email:
+- matsumoto@soutaro.com
+executables:
+- cycromatic
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cycromatic.gemspec
+- exe/cycromatic
+- lib/cycromatic.rb
+- lib/cycromatic/calculator.rb
+- lib/cycromatic/cli.rb
+- lib/cycromatic/complexity.rb
+- lib/cycromatic/file_enumerator.rb
+- lib/cycromatic/json_formatter.rb
+- lib/cycromatic/text_formatter.rb
+- lib/cycromatic/version.rb
+homepage: https://github.com/cycromatic
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Cyclomatic Complexity
+test_files: []