code_poetry 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f35c59a997f5fcc5544ad1c8e67e46e1d8fda47
-  data.tar.gz: 16e6e142767e8a0c4ce0b57b1be521945c958d78
+  metadata.gz: ea6e417400284ac72f6bee76317c61e49bb9a283
+  data.tar.gz: 87455110a8b39f187265f81eaa77e04038021770
 SHA512:
-  metadata.gz: ae820ea69f026dc1be7fcf43e9a91647856cb5798caabda62da9026cf82652f505628412d57aa6339a2b28f2988d2bfb9b22716247c22b61eb4631a550f96392
-  data.tar.gz: 1086ea2c0e514b3a0e68aeb2a0faf46aa5a2384a6dde95f4e7ec2ff7e8feaebcb1cf53986a64f49aa494b04fcb54016feec6c12ae0c06b36a188e52c7a808bf1
+  metadata.gz: c4e3b43fc5062d77356f025b26de306dd9304668b0e7c5f890c98ff28439ca97e4760d2db497b00e41deef93e8f7457c40d4cc74b119be83bfc8840732747436
+  data.tar.gz: 1ac55bdded39fe400b920aadc826de01aa7afbc22aec9a0b0faa287c202ead3ef3ef5ad2e6f3c3eb6942be4a719c6d1a444f49ac29764bd08cd08eabd219a6ab

data/.travis.yml

@@ -2,11 +2,14 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - 2.2.0
 addons:
   code_climate:
     repo_token:
       secure: "JJb9iyhNuNNUpnjGMWjNNIjaPOST53+vAzb6RHdzNKRC6jKgWZMXZsJ3Tzb6xFe21l+FmdBk+mKWVFHoBvUOlK34++CeXwDek8PhFi6bp7lJASqUabB66o32WPdTYnWy4WV5BesXJyFeKRL2SyFGoOw8B8Cpx+DrOVLR71s5Ovs="
 notifications:
-  slack: 
+  email: false
+  slack:
     rooms:
       secure: "bXtxfw97KhPDFNiS402PghKK2fvcfF4diZUWPaJu2VhRzBabveD+j4F4XQW7glRXcGzypOuCYqyTqHFXjjItO52+PEz4gUwak42UnFjHcGQ3//OeQB9bqCkR7IgyjILfWOS57JJE9XHa34p+cWnYntQ/u10rTiyivC1vfmjiufs="

data/README.md

@@ -23,6 +23,10 @@ And then execute:
 
     $ bundle
 
+Or install it yourself:
+
+    $ gem install code-poetry
+
 ## Usage
 
 Excecute from your application root:
@@ -31,6 +35,17 @@ Excecute from your application root:
 
 This will generate a HTML report to ```metrics/index.html```.
 
+Or if you installed the gem globally use:
+
+    $ code_poetry
+
+This will display your smells in the command line.
+
+You can also give a path to a file or subdirectory if you only want metrics for
+those files:
+
+    $ code_poetry app/models
+
 ## Contributing
 
 1. Fork it

data/bin/code_poetry

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require "code_poetry/formatter/cl_formatter"
+require "code_poetry/cli"
+
+formatter = CodePoetry::Formatter::CLFormatter.new
+
+CodePoetry::CLI.execute(ARGV[0], formatter)

data/lib/code_poetry/calculator.rb

@@ -5,9 +5,9 @@ require 'code_poetry/duplication_calculator'
 module CodePoetry
   class Calculator
     def initialize(path, files)
-      @path   = path
-      @files  = files
-      @stats  = []
+      @path = path || '.'
+      @files = files
+      @stats = []
     end
 
     def calculate

data/lib/code_poetry/churn_calculator.rb

@@ -1,6 +1,6 @@
 class ChurnCalculator
-  def initialize(repo_path)
-    @repo_path = repo_path
+  def initialize(path)
+    @repo_path = find_directory(path)
   end
 
   def calculate
@@ -9,6 +9,14 @@ class ChurnCalculator
 
   private
 
+  def find_directory(path)
+    if File.file?(path)
+      File.dirname(path)
+    else
+      path
+    end
+  end
+
   def parse_log_for_churns
     churns = {}
 

data/lib/code_poetry/cli.rb

@@ -1,29 +1,33 @@
-require 'code_poetry/calculator'
-require 'code_poetry/stat'
-require 'code_poetry/formatter'
-require 'code_poetry-html'
+require "code_poetry/calculator"
+require "code_poetry/stat"
 
 module CodePoetry
   class CLI
-    DIRECOTRIES = 'app,lib'
-    EXTENSIONS = 'rb,rake'
+    DIRECOTRIES = "app,lib"
+
+    def self.execute(path, formatter)
+      files = find_files(path)
 
-    def self.excecute(path)
-      files = Array(expand_directories_to_files(path).sort).compact
       calculator = Calculator.new(path, files)
       stats = calculator.calculate
 
-      formatter = CodePoetry::Formatter::HTMLFormatter.new
       formatter.format(stats)
     end
 
-  private
+    private
+
+    def self.find_files(path)
+      paths = expand_path_to_files(path)
+      Array(paths).compact.sort
+    end
 
-    def self.expand_directories_to_files(path)
-      if path
-        Dir[File.join(path, "{#{DIRECOTRIES}}**", '**', "*.{#{EXTENSIONS}}")]
+    def self.expand_path_to_files(path)
+      if path.nil?
+        Dir[File.join(".", "{#{DIRECOTRIES}**}", "**", "*.rb")]
+      elsif File.file?(path)
+        path
       else
-        FileList[File.join("{#{DIRECOTRIES}}**", '**', "*.{#{EXTENSIONS}}")]
+        Dir[File.join(path, "**", "*.rb")]
       end
     end
   end

data/lib/code_poetry/formatter/cl_formatter.rb

@@ -0,0 +1,62 @@
+module CodePoetry
+  module Formatter
+    class CLFormatter
+      def format(stats)
+        smelly_stats = stats.reject { |stat| stat.smells.empty? }
+
+        smelly_stats.each { |stat| print_smells_for(stat) }
+      end
+
+      private
+
+      def print_smells_for(stat)
+        smells = stat.smells
+        return if smells.empty?
+
+        puts stat.name
+
+        smells.each do |smell|
+          print_smell(stat, smell)
+        end
+
+        puts
+      end
+
+      def print_smell(stat, smell)
+        send("print_#{smell.type}", stat, smell)
+      end
+
+      def print_duplication(stat, smell)
+        duplication = smell.object
+
+        puts <<-MESSAGE.gsub(/^ {8}/, '').gsub(/\n  /, ' ')
+          #{duplication.severity} Code found in #{duplication.node} nodes
+          (mass  = #{duplication.mass})
+        MESSAGE
+
+        duplication.methods.each do |method|
+          puts "    #{method.pretty_location}"
+        end
+      end
+
+      def print_complex_method(_, smell)
+        method = smell.object
+
+        puts <<-MESSAGE.gsub(/^ {8}/, '').gsub(/\n  /, ' ')
+          Complex Method #{method.pretty_name} #{method.complexity}
+          (complexity = #{method.complexity})
+        MESSAGE
+      end
+
+      def print_complex_class(stat, _)
+        puts "  Complex Class (complexity = #{stat.complexity})"
+      end
+
+      def print_complex_class_definition(stat, _)
+        puts <<-MESSAGE.gsub(/^ {8}/, '')
+          Complex Class Definition (complexity = #{stat.definition_complexity})
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/code_poetry/railtie.rb

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

data/lib/code_poetry/version.rb

@@ -1,3 +1,3 @@
 module CodePoetry
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/code_poetry.rb

@@ -1,32 +1,27 @@
-require 'code_poetry/version'
-require 'fileutils'
+require "code_poetry/version"
+require "fileutils"
 
 module CodePoetry
   if defined?(Rails)
-    require 'code_poetry/railtie'
-  else
-    load 'tasks/code_poetry.rake'
+    require "code_poetry/railtie"
   end
 
   class << self
     def root
-      return @root if defined? @root
-      @root = File.expand_path(Dir.getwd)
+      @root ||= File.expand_path(Dir.getwd)
     end
 
     def coverage_path
-      coverage_path = File.expand_path('metrics', root)
-      FileUtils.mkdir_p 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('_', ' ')
+      @project_name ||= File.basename(root)
+        .split(/[-_]/)
+        .map(&:capitalize)
+        .join(" ")
     end
   end
 end

data/lib/tasks/code_poetry.rake

@@ -1,8 +1,9 @@
 desc 'Generate code metrics'
 task :metrics, :path do |t, args|
+  require 'code_poetry-html'
   require 'code_poetry/cli'
 
-  path = args.path || '.'
+  formatter = CodePoetry::Formatter::HTMLFormatter.new
 
-  CodePoetry::CLI.excecute(path)
+  CodePoetry::CLI.execute(args.path, formatter)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_poetry
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bastian Bartmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_poetry-html
@@ -112,7 +112,8 @@ description: Analyzes the code of your Rails app and generates a straightforward
   report.
 email:
 - babartmann@gmail.com
-executables: []
+executables:
+- code_poetry
 extensions: []
 extra_rdoc_files: []
 files:
@@ -124,6 +125,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/code_poetry
 - code_poetry.gemspec
 - lib/code_poetry.rb
 - lib/code_poetry/calculator.rb
@@ -131,7 +133,7 @@ files:
 - lib/code_poetry/cli.rb
 - lib/code_poetry/complexity_calculator.rb
 - lib/code_poetry/duplication_calculator.rb
-- lib/code_poetry/formatter.rb
+- lib/code_poetry/formatter/cl_formatter.rb
 - lib/code_poetry/method.rb
 - lib/code_poetry/railtie.rb
 - lib/code_poetry/stat.rb

data/lib/code_poetry/formatter.rb

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