rubycrap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db809cb564df163b709e7d1c7ae2114161644f32
+  data.tar.gz: 3d3cf3be27dc9382a1db7835f868848532281f18
+SHA512:
+  metadata.gz: c393f12154ab04189f87a9a32d7ee28d0426161f99f798cc74c12b1e13a8fae8384f00102680a5d44519333ca63225b26b5a634bb6cc32409bf6381e941ef59f
+  data.tar.gz: 5af210175f7635e59fcb91b8d44714b73075868eecfd5ac3698094933540858abc1d9e12ec8ea3b035a57be281872f396ad583b912667cd293f9cc43bc535f1f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at igj@certi.org.br. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ingo Gerhard Jauch
+
+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,43 @@
+# Rubycrap
+
+This is an implementation/interpretation of Alberto Savoia's C.R.A.P. Metric for RUBY (https://www.artima.com/weblogs/viewpost.jsp?thread=215899).
+Rubycrap works with the "flog score" instead of the cyclomatic complexity because be belive it is more meaningful for Ruby.
+It should work with Ruby 1.9+
+
+
+## Installation
+
+To build the gem you need to do:
+```
+	$ gem build rubycrap.gemspec
+```
+
+## Usage
+
+Requirements: 
+
+Simplecov (https://github.com/colszowka/simplecov with 'simplecov-json' gem) to generate a coverage.json file.
+e.g.
+```
+	$ cd test/testapp;bundle install
+	$ COVERAGE=true rspec spec
+```
+	=> Should result in coverage/coverage.json
+
+To generate the rubycrap metric you need to pass a simplecov .json file as the 1st argument
+```
+	$ ruby -Ilib ./bin/rubycrap test/testapp/coverage/coverage.json
+```
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ingojauch/rubycrap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task :default => :spec

data/bin/rubycrap

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "rubycrap"
+require 'logger'
+
+read_filename = ARGV[0]
+
+if read_filename == nil
+	puts "Please specify an Simplecov coverage.json file as argument"
+	exit 1
+end
+
+case ARGV[1]
+when '-d','--debug'
+  mode = Logger::DEBUG
+else
+  mode = Logger::WARN
+end
+
+Rubycrap.run(read_filename,mode)

data/lib/rubycrap.rb

@@ -0,0 +1,169 @@
+require 'parser/current'
+require 'flog_cli'
+require 'json'
+require 'builder'
+require 'logger'
+
+class Rubycrap
+	@simplecov_information=[]
+	@crap_methods=[]
+	def self.minfo(object)
+	  puts ">supports: #{(object.methods  - Object.methods).inspect}\n"
+	end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+	#
+	# => reads the sourcefile with an ast parser to get all the methods, then calculate the method coverage
+	#
+	def self.process_simplecov_file(file)
+	  #get filename with its coverage information
+	  filename = file["filename"]
+    logger.debug(filename)
+	  parse_method_coverage(file,filename)
+	end
+
+	def self.parse_method_coverage(file,filename)
+	  ast = Parser::CurrentRuby.parse(File.open(filename, "r").read)
+	  recursive_search_ast(file,ast)
+	end
+
+	def self.calculate_method_coverage(file,startline,lastline)
+	  # first we get the coverage lines from simplecov
+	  # start position -1 and number of total lines (-1 if you dont want the end)
+	  total_lines = lastline-startline
+    logger.debug("startline #{startline}")
+    logger.debug("latline #{lastline}")
+	  coveragelinestotal = file["coverage"]
+	  	 
+    logger.debug( "total_lines #{total_lines}")
+	  coveragelines = coveragelinestotal.slice(startline-1,total_lines)
+    logger.debug("coveragelines: #{coveragelines}")
+	  covered_lines = 0
+	  coveragelines.each do |line|
+	    if !(line.to_s.eql? "0" or line.to_s.eql? "")
+	      covered_lines = covered_lines + 1
+	    end
+	  end
+	  method_coverage = covered_lines.to_f / total_lines.to_f
+    logger.debug("method_coverage: #{method_coverage}")
+	  return method_coverage
+	end
+
+	def self.recursive_search_ast(file,ast)
+		begin
+			ast.children.each do |child|
+				if child.class.to_s == "Parser::AST::Node"
+				  if (child.type.to_s == "def" or child.type.to_s == "defs")
+
+				    methodname = child.children[0].to_s
+				    startline = child.loc.line
+				    lastline = child.loc.last_line
+				    logger.debug("\nmethodname: #{methodname}")
+				    method_coverage = calculate_method_coverage(file,startline,lastline)
+
+				    @simplecov_information << {:name => methodname, :coverage => method_coverage , :startline => startline, :lastline => lastline}
+				  else
+				    recursive_search_ast(file,child)
+				  end
+				end
+			end
+		rescue
+			# maybe empty source code
+		end
+	end
+
+	def self.crap(score,coverage)
+	#    CRAP(m) = comp(m)^2 * (1 � cov(m)/100)^3 + comp(m)
+	  comp = score
+	  cov = coverage
+	  comp ** 2 * (1 - cov) ** 3 + comp
+	end
+
+	def self.calcualte_crap_from_flog(file)
+		begin
+			FlogCLI.load_plugins
+			options = FlogCLI.parse_options "-qma"
+			flogger = FlogCLI.new options
+
+			flogger.flog file["filename"]
+      logger.debug("flogger absolute_filename: #{file["filename"]}")
+			flogger.each_by_score nil do |class_method, score, call_list|
+				startline = flogger.method_locations[class_method].split(":")[1]
+				absolute_filename = flogger.method_locations[class_method].split(":")[0]
+        logger.debug("flogger startline: #{startline}")
+				#match simplecov line with startine form floc
+				element = @simplecov_information.detect {|f| f[:startline] == startline.to_i }
+				if element.to_s == ""
+          logger.debug("no match with simplecov for logger class_method: #{class_method} startline: #{startline} ")
+				else
+          logger.debug("flogger class_method: #{class_method} simplecov: #{element}")
+					test_coverage = element[:coverage]
+					@crap_methods << {:methodname => class_method, :flog_score => score , :filepath => absolute_filename, :startline => startline, :method_coverage => test_coverage, :crap_score => crap(score,test_coverage)}
+				end
+			end
+		rescue
+			# something went wrong with flog
+		end
+	end
+
+	def self.hasharray_to_html( hashArray )
+	  # collect all hash keys, even if they don't appear in each hash:
+	  headers = hashArray.inject([]){|a,x| a |= x.keys ; a}  # use array union to find all unique headers/keys                              
+
+	  html = Builder::XmlMarkup.new(:indent => 2)
+	  html.table {
+	    html.tr { headers.each{|h| html.th(h)} }
+	    hashArray.each do |row|
+	      html.tr { row.values.each { |value| html.td(value) }}
+	    end
+	  }
+	  return html
+	end
+
+	def self.run(coveragefile,mode)
+    logger.level = mode
+    coverage = JSON.parse(File.open(coveragefile, "r").read)
+
+		# file = coverage["files"].first
+		#
+		# => get all the source filenames from the coverage file
+		#
+		puts "total files: #{coverage["files"].count}"
+		coverage["files"].each.with_index(1) do |file, index|
+      logger.debug("file nr. #{index}")
+		  process_simplecov_file(file)
+		  calcualte_crap_from_flog(file)
+		end
+
+		@sorted = @crap_methods.sort_by { |k| -k[:crap_score] }
+
+		puts "\nRESULTS"
+		@sorted.each do |element|
+			puts "#{element[:crap_score].round}".ljust(6) + "#{element[:methodname]}  ---> #{element[:filepath]}:#{element[:startline]}"
+		end
+
+		#
+		# buidler sucks
+		# it doesnt do thead and tbody
+		# and th: isnt accepted in datatables
+
+
+		# <script   src="https://code.jquery.com/jquery-2.2.2.min.js"   integrity="sha256-36cp2Co+/62rEAAYHLmRCPIych47CvdM+uTBJwSzWjI="   crossorigin="anonymous"></script>
+		# <script   src="https://cdn.datatables.net/1.10.11/js/jquery.dataTables.js" crossorigin="anonymous"></script>
+		# <link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/1.10.11/css/jquery.dataTables.min.css">
+		# <script type="text/javascript">
+		#   $(document).ready(function(){
+		#     $('#myTable').DataTable();
+		#   });
+		# </script>
+
+		# <table id="myTable">
+
+		File.open("CRAP.html", 'w') { |file| file.write(hasharray_to_html(@sorted)) }
+		puts "THE END"
+	end
+
+end
+

data/lib/rubycrap/logging.rb

@@ -0,0 +1,10 @@
+require 'logger'
+
+module Logging
+  def logger
+    Logging.logger
+  end
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/lib/rubycrap/version.rb

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

data/rubycrap.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubycrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubycrap"
+  spec.version       = Rubycrap::VERSION
+  spec.authors       = ["Ingo Gerhard Jauch","Gustavo Maestri"]
+  spec.email         = ["ingo.jauch@gmail.com","gumaestri@gmail.com"]
+
+  spec.summary       = "Ruby version of CRAP4J"
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "parser", '~> 2.3'
+  spec.add_runtime_dependency "flog", '~> 4.3'
+  spec.add_runtime_dependency "builder", '~> 3.2'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rubycrap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ingo Gerhard Jauch
+- Gustavo Maestri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: ''
+email:
+- ingo.jauch@gmail.com
+- gumaestri@gmail.com
+executables:
+- rubycrap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rubycrap
+- lib/rubycrap.rb
+- lib/rubycrap/logging.rb
+- lib/rubycrap/version.rb
+- rubycrap.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5
+signing_key: 
+specification_version: 4
+summary: Ruby version of CRAP4J
+test_files: []
+has_rdoc: