code_poetry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb3462469131688d286ff7f768db70ae4de1e12a
+  data.tar.gz: 2c18647925f0741cb981670ad94a53890cacf7fd
+SHA512:
+  metadata.gz: 4c348c339d702a853aaa6cdf72c41bfb547f6d992223de44a20b2e28e6c5391ab4c861f4e72358eda2aa829b83e8dfd244d392137279c8e215ddd0bb75a5d1e9
+  data.tar.gz: d0e0ea9ffa4aa906eb797931e85e46502ad409e1152c0e4f48994fd15d44ff6fd9e02427a110a8eb5b5b626ab24af52ac6361550cc08678d057fe0dd9e45e369

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bastian Bartmann
+
+MIT License
+
+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,41 @@
+# Code Poetry
+
+The poor men's [Code Climate][cc].
+
+Analyzes the code of your Rails app and generates a straightforward HTML report.
+
+Currently it uses the following metrics:
+
+* Lines of Code
+* Churns [[Churn][ch]]
+* Code Complexity [[Flog][fl]]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'code_poetry'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Excecute from your application root:
+
+    $ rake metrics
+
+This will generate a HTML report to ```metrics/index.html```.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[cc]: https://codeclimate.com
+[ch]: https://github.com/danmayer/churn
+[fl]: https://github.com/seattlerb/flog

data/Rakefile

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

data/code_poetry.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'code_poetry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "code_poetry"
+  spec.version       = CodePoetry::VERSION
+  spec.authors       = ["Bastian Bartmann"]
+  spec.email         = ["babartmann@gmail.com"]
+  spec.description   = %q{Analyzes the code of your Rails app and generates a straightforward HTML report.}
+  spec.summary       = %q{The poor men's Code Climate}
+  spec.homepage      = "https://github.com/coding-chimp/code_poetry"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency 'code_poetry-html', ['~> 0.0']
+  spec.add_runtime_dependency 'code_metrics',     ['~> 0.1']
+  spec.add_runtime_dependency 'churn',            ['~> 0.0']
+  spec.add_runtime_dependency 'flog',             ['~> 4.2']
+end

data/lib/code_poetry/calculator.rb

@@ -0,0 +1,69 @@
+require 'churn/churn_calculator'
+require 'flog_cli'
+require 'ripper'
+
+module CodePoetry
+  class Calculator
+    def initialize(files)
+      @files  = files
+      @churns = {}
+      @stats  = []
+    end
+
+    def calculate
+      puts 'Calculating'
+
+      measure_churns
+
+      @files.each do |file|
+        stat = Stat.new(file)
+
+        stat.set_churns(@churns[file])
+        measure_flog(stat)
+
+        @stats << stat
+      end
+
+      @stats
+    end
+
+  private
+
+    def measure_churns
+      churns = Churn::ChurnCalculator.new(history: false).report(false)
+
+      churns[:churn][:changes].each do |churn|
+        @churns[churn[:file_path]] = churn[:times_changed]
+      end
+    end
+
+    def measure_flog(stat)
+      flogger = FlogCLI.new(all: true)
+      flogger.flog(stat.file)
+      flogger.calculate
+
+      outside_methods = 0
+
+      unless flogger.scores.empty?
+        klass                      = flogger.scores.first[0]
+        stat.complexity            = flogger.total_score.round(2)
+        stat.complexity_per_method = flogger.average.round(2)
+
+        flogger.method_scores[klass].each do |name, score|
+          next if score.nil?
+
+          name = (name.match(/#(.+)/) || name.match(/::(.+)/))[1]
+          method = stat.get_method(name)
+
+          if method
+            method[:complexity] = score.round(2)
+          else
+            outside_methods += score
+          end
+        end
+      end
+
+      stat.set_outside_of_methods_complexity(outside_methods.round(2))
+    end
+  end
+end

data/lib/code_poetry/cli.rb

@@ -0,0 +1,17 @@
+require 'code_poetry/calculator'
+require 'code_poetry/stat'
+require 'code_poetry/formatter'
+require 'code_poetry-html'
+
+module CodePoetry
+  class CLI
+    def self.excecute
+      files = Array(FileList['app/**/*.rb']).compact
+      calculator = Calculator.new(files)
+      stats = calculator.calculate
+
+      formatter = CodePoetry::Formatter::HTMLFormatter.new
+      formatter.format(stats)
+    end
+  end
+end

data/lib/code_poetry/formatter.rb

@@ -0,0 +1,4 @@
+module CodePoetry
+  module Formatter
+  end
+end

data/lib/code_poetry/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module CodePoetry
+  class Railtie < Rails::Railtie
+    railtie_name :code_poetry
+
+    rake_tasks do
+      load "tasks/code_poetry.rake"
+    end
+  end
+end

data/lib/code_poetry/stat.rb

@@ -0,0 +1,133 @@
+require 'code_poetry/warning_scanner'
+
+module CodePoetry
+  class Stat
+    attr_accessor :file, :name, :lines, :lines_of_code, :churns, :complexity, :details, :complexity_per_method
+
+    def initialize(file)
+      @lines_of_code, @churns, @complexity, @complexity_per_method = 0, 0, 0, 0
+      @file    = file
+      @lines   = {}
+      @details = []
+
+      parse_file
+    end
+
+    def set_churns(churns)
+      @churns = churns if churns
+    end
+
+    def get_method(name)
+      method = details.select{|method| method[:name] == name}
+      method[0] unless method.empty?
+    end
+
+    def set_method_complexity(name, complexity)
+      method = details.select{|method| method[:name] == name}
+      method[0][:complexity] = complexity unless method.empty?
+    end
+
+    def set_outside_of_methods_complexity(complexity)
+      @details.unshift({name: "none", complexity: complexity})
+    end
+
+    def get_method_at_line(line)
+      @method = nil
+
+      @details.each do |detail|
+        next if detail[:first_line].nil?
+
+        if detail[:last_line].nil?
+          if detail[:first_line] == line
+            @method = detail
+            break
+          else
+            next
+          end
+        end
+
+        if detail[:first_line] <= line && detail[:last_line] >= line
+          @method = detail
+          break
+        end
+      end
+
+      @method
+    end
+
+  private
+
+    def parse_file
+      @content = File.open(@file, "r").read
+      @indentation_warnings = indentation_warnings
+
+      set_name
+      set_lines
+      set_methods
+    end
+
+    def set_name
+      @content = File.open(@file, "r").read
+
+      if match = /^\s*class\s+(\S+)/.match(@content) || /^\s*module\s+(\S+)/.match(@content)
+        @name = match[1]
+      end
+    end
+
+    def set_lines
+      @content.each_line.with_index(1) do |line, i|
+        @lines[i] = line
+        next if line =~ /^\s*$/
+        next if line =~ /^\s*#/
+        @lines_of_code += 1
+      end
+    end
+
+    def set_methods
+      sexp = Ripper.sexp(@content)
+      scan_sexp(sexp)
+    end
+
+    def scan_sexp(sexp)
+      sexp.each do |element|
+        next unless element.kind_of?(Array)
+
+        case element.first
+        when :def, :defs
+          name, first_line = find_method_params(element)
+
+          if @indentation_warnings['def'] && @indentation_warnings['def'].any? { |first, last| first == first_line }
+            warning = @indentation_warnings['def'].select{|first, last| first == first_line}[0]
+            last_line = warning[1]
+          else
+            last_line = find_last_line(name, first_line)
+          end
+
+          @details << {name: name, first_line: first_line, last_line: last_line, complexity: 0}
+        else
+          scan_sexp(element)
+        end
+      end
+    end
+
+    def find_method_params(sexp)
+      if sexp.first == :def
+        sexp[1].flatten[1,2]
+      else
+        sexp[3].flatten[1,2]
+      end
+    end
+
+    def find_last_line(token_name, line)
+      token_indentation = @lines[line].index('def')
+
+      last_line = @lines.values[line..-1].index { |l| l =~ %r(\A\s{#{token_indentation}}end\s*\z) }
+      last_line ? last_line + line + 1 : nil
+    end
+
+    def indentation_warnings
+      warning_scanner = WarningScanner.new
+      warning_scanner.scan(@content)
+    end
+  end
+end

data/lib/code_poetry/version.rb

@@ -0,0 +1,3 @@
+module CodePoetry
+  VERSION = "0.0.1"
+end

data/lib/code_poetry/warning_scanner.rb

@@ -0,0 +1,45 @@
+require 'open3'
+
+module CodePoetry
+  class WarningScanner
+    INDENTATION_WARNING_REGEXP = /at 'end' with '(def|class|module)' at (\d+)\z/
+
+    def scan(source)
+      if defined? Bundler
+        Bundler.with_clean_env do
+          status, @warnings, process = validate(source)
+        end
+      else
+        status, @warnings, process = validate(source)
+      end
+
+      @indentation_warnings = parse_warnings
+    end
+
+  private
+
+    def validate(source)
+      Open3.capture3('ruby -wc', stdin_data: source)
+    end
+
+    def parse_warnings
+      @warnings.split("\n").inject({}) do |warnings, warning|
+        token, line, end_line = extract_indentation_mismatch(warning)
+        if token == 'def'
+          warnings[token] ||= []
+          warnings[token] << [line.to_i, end_line.to_i]
+        end
+        warnings
+      end
+    end
+
+    def extract_indentation_mismatch(warning_line)
+      _, end_line_num, warning_type, warning_body = warning_line.split(':').map(&:strip)
+      return nil unless warning_type == 'warning'
+      return nil unless warning_body =~ /at 'end' with '(def|class|module)' at (\d+)\z/
+
+      warning_body.match(INDENTATION_WARNING_REGEXP)[1..2] << end_line_num
+    end
+
+  end
+end

data/lib/code_poetry.rb

@@ -0,0 +1,34 @@
+require 'code_poetry/version'
+require 'fileutils'
+
+module CodePoetry
+  if defined?(Rails)
+    require 'code_poetry/railtie'
+  else
+    load 'tasks/code_poetry.rake'
+  end
+
+  class << self
+
+    def root
+      return @root if defined? @root
+      @root = File.expand_path(Dir.getwd)
+    end
+
+    def coverage_path
+      coverage_path = File.expand_path('metrics', root)
+      FileUtils.mkdir_p coverage_path
+      coverage_path
+    end
+
+    def project_name
+      return @project_name if defined? @project_name
+      @project_name = File.basename(root.split('/').last).capitalize.gsub('_', ' ')
+    end
+
+    def project_name
+      File.basename(root.split('/').last).capitalize.gsub('_', ' ')
+    end
+
+  end
+end

data/lib/tasks/code_poetry.rake

@@ -0,0 +1,5 @@
+desc "Generate code metrics"
+task :metrics do
+  require 'code_poetry/cli'
+  CodePoetry::CLI.excecute
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: code_poetry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bastian Bartmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: code_poetry-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: code_metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: churn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Analyzes the code of your Rails app and generates a straightforward HTML
+  report.
+email:
+- babartmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- code_poetry.gemspec
+- lib/code_poetry.rb
+- lib/code_poetry/calculator.rb
+- lib/code_poetry/cli.rb
+- lib/code_poetry/formatter.rb
+- lib/code_poetry/railtie.rb
+- lib/code_poetry/stat.rb
+- lib/code_poetry/version.rb
+- lib/code_poetry/warning_scanner.rb
+- lib/tasks/code_poetry.rake
+homepage: https://github.com/coding-chimp/code_poetry
+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.0.3
+signing_key: 
+specification_version: 4
+summary: The poor men's Code Climate
+test_files: []
+has_rdoc: