app_reporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3103273fc6390755fde74f62c4392e0a31c05e07
+  data.tar.gz: f1d37d776fb9f7310bf73e5883b8a6408f64beba
+SHA512:
+  metadata.gz: 03bce62d87262257dda41436b5a49e6edd49ab5fe1afeca98fedd9fa04fa96c54021eecb9043d60fd2eb64f925e99e8c3dbac8d65c3c4eb1efef074bd702710c
+  data.tar.gz: 48f84185b2cb02ebeaa8b98d304426a7b7e6fbe2639d340aeff316058fe22759ac0122150c69d15f5a1457ca43ca11c9d7f85cae4fb94aed3c1c0f9757478cb7

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rohit Bhore
+
+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,39 @@
+# AppReporter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/app_reporter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'app_reporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install app_reporter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/app_reporter/fork )
+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 a new Pull Request

data/Rakefile

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

data/app_reporter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'app_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "app_reporter"
+  spec.version       = AppReporter::VERSION
+  spec.authors       = ["Rohit Bhore"]
+  spec.email         = ["rohitpbhore@gmail.com"]
+
+  spec.summary       = %q{Code quality report through metric_fu and brakeman gem}
+  spec.description   = %q{Code quality report through metric_fu and brakeman gem}
+  spec.homepage      = "https://github.com/rohitpbhore/app_reporter.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "brakeman"
+  spec.add_runtime_dependency "metric_fu"
+  spec.add_runtime_dependency "railties"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "app_reporter"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/app_reporter.rb

@@ -0,0 +1,117 @@
+require "app_reporter/version"
+require 'app_reporter/railtie' if defined?(Rails)
+
+module AppReporter
+  def brakeman_report
+  	# Breakman source file
+		file = File.read("#{Rails.root}/report.json")
+		data_hash = JSON.parse(file)
+
+		# collect information related to the application
+		@breakman_info = {}
+		@breakman_info['security_warnings'] = data_hash['scan_info']['security_warnings']
+	  @breakman_info['errors'] = data_hash['errors']
+
+	  # Create an array of all warnings
+	  @brakeman_warnings = []
+	  data_hash['warnings'].each do |warning|
+	  	hash = {}
+	  	hash['warning_type'] = warning['warning_type']
+	  	hash['warning_code'] = warning['warning_code']
+	  	hash['fingerprint'] = warning['fingerprint']
+	  	hash['message'] = warning['message']
+	  	hash['file'] = warning['file']
+	  	hash['line'] = warning['line']
+	  	hash['code'] = warning['code']
+	  	hash['render_path'] = warning['render_path']
+	  	hash['location'] = warning['location']
+	  	hash['user_input'] = warning['user_input']
+	  	hash['confidence'] = warning['confidence']
+	  	@brakeman_warnings.push(hash)
+	  end
+	end
+
+	def metric_fu_report
+	  # parsing metric_fu report from .yml file
+	  @surveys = YAML.load(ERB.new(File.read("#{Rails.root}/tmp/metric_fu/report.yml")).result)
+    @matric_fu_info = []
+
+    @surveys.each do |survey|
+    	unless survey.blank?
+    		p "===== From #{survey[0]} ====="
+	      case survey[0]
+				when :flog
+	      	hash = {}
+					# hash['flog'] = "Flog measures code complexity. Total Flog score for all methods: #{survey[1][:total].round(1)}. Average Flog score for all methods: #{survey[1][:average].round(1)}"
+					hash['flog'] = survey[1][:average].round(1)
+					@matric_fu_info.push(hash)
+				when :stats
+					hash = {}
+					# hash['stats'] = "Lines of Code/Tests Metric Results. Lines of Code: #{survey[1][:codeLOC]}. Lines of Test: #{survey[1][:testLOC]}. Code to test ratio: #{survey[1][:code_to_test_ratio]}."
+					hash['stats'] = survey[1][:code_to_test_ratio]
+					hash['codeLOC'] = survey[1][:codeLOC]
+					hash['testLOC'] = survey[1][:testLOC]
+					@matric_fu_info.push(hash) 
+				when :roodi
+					hash = {}
+					hash['roodi'] = "Roodi parses Ruby code and warns about design issues. #{survey[1][:total].first} and found #{survey[1][:problems].count} problems."
+					@matric_fu_info.push(hash)
+				when :reek
+					hash = {}
+					hash['reek'] = "Reek detects common code smells in ruby code. Found #{survey[1][:matches].count} matches."
+					@matric_fu_info.push(hash)
+				when :cane
+					hash = {}
+					hash['cane'] = "Cane reports code quality threshold violations. Found total #{survey[1][:violations].count} types of #{survey[1][:total_violations]} violations."
+					@matric_fu_info.push(hash)
+			  when :flay
+			  	hash = {}
+			  	hash['flay'] = "Flay analyzes ruby code for structural similarities. Total Score (lower is better): #{survey[1][:total_score]}."
+			  	@matric_fu_info.push(hash)
+			  when :churn
+			  	hash = {}
+			  	hash['churn'] = "Source Control Churn Results. Files that change a lot in your project may be bad a sign. Count: #{survey[1][:changes].count}."
+			  	@matric_fu_info.push(hash)
+			  when :saikuro
+			  	hash = {}
+			  	hash['saikuro'] = "Saikuro analyzes ruby code for cyclomatic complexity. Analyzed #{survey[1][:files].count} Classes."
+			  	@matric_fu_info.push(hash)
+			  when :rails_best_practices
+			  	hash = {}
+			  	hash['rails_best_practices'] = survey[1][:total].first.gsub(/[^\d]/, '').to_i
+			  	@matric_fu_info.push(hash)
+				when :hotspots
+					hash = {}
+					hash['hotspots'] = "Meta analysis of metrics to find hotspots in code. Hotspot Results: #{survey[1]['files'].count}."
+					@matric_fu_info.push(hash)
+				else
+				  puts "No Report"
+				end
+			end
+    end
+	end
+
+  def generate_final_report
+  	spec = Gem::Specification.find_by_name 'app_reporter'
+		erb_file = "/#{spec.gem_dir}/lib/app_reporter/templates/summary_report.html.erb"
+		html_file = File.basename(erb_file, '.erb') 
+		erb_str = File.read(erb_file)
+
+  	@flog_info = @matric_fu_info.select{|d| d.keys.first == 'flog'}
+  	@stats_info = @matric_fu_info.select{|d| d.keys.first == 'stats'}
+  	@rails_best_practices_info = @matric_fu_info.select{|d| d.keys.first == 'rails_best_practices'}
+  	@app_root = Rails.root
+
+	  begin
+			renderer = ERB.new(erb_str)
+			result = renderer.result()
+
+			File.open(html_file, 'w') do |f|
+			  f.write(result)
+			end
+		rescue StandardError => e
+	  	p e.message
+	  	p e.backtrace
+	  end
+	end
+end

data/lib/app_reporter/railtie.rb

@@ -0,0 +1,8 @@
+module AppReporter
+  class Railtie < Rails::Railtie
+  	rake_tasks do
+    	spec = Gem::Specification.find_by_name 'app_reporter'
+			load "#{spec.gem_dir}/lib/tasks/app_reporter.rake"
+  	end
+  end
+end

data/lib/app_reporter/templates/summary_report.html.erb

@@ -0,0 +1,185 @@
+<!DOCTYPE HTML SYSTEM>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Brakeman Report</title>
+    <script>
+      function toggle(context) {
+        var elem = document.getElementById(context);
+
+        if (elem.style.display != "block")
+          elem.style.display = "block";
+        else
+          elem.style.display = "none";
+
+        elem.parentNode.scrollIntoView();
+      }
+    </script>
+    <style>
+      /* CSS style used for HTML reports */
+
+      body {
+        font-family: sans-serif;
+        color: #161616;
+        width: 70%;
+        margin: auto;
+      }
+      th {
+         background-color: #980905;
+         border-bottom: 5px solid #530200;
+         color: white;
+         font-size: 11pt;
+         padding: 1px 8px 1px 8px;
+       }
+
+       td {
+         border-bottom: 2px solid white;
+         font-family: monospace;
+         padding: 5px 8px 1px 8px;
+       }
+
+       table {
+         background-color: #FCF4D4;
+         border-collapse: collapse;
+       }
+
+       tr.first {
+         border-top: 1px solid #7ecc54;
+         padding-top: 2px;
+       }
+
+       tr.error {
+        background-color: #f4c1c1 !important
+       }
+
+       table{
+        width: 100%;
+        border: 1px;
+        border-color: black;
+       }
+       th, td{
+        width: 33.33%;
+       }
+
+      .done {
+        list-style: none; /* remove normal bullet for done items */
+        position: relative; /* necessary for positioning the :after */
+        margin-left: 30px;
+      }
+
+      .done:after {
+        content: "";
+        background-color: transparent;
+        
+        /* position the checkbox */
+        position: absolute;
+        left: -16px;
+        top: 0px;
+
+        /* setting the checkbox */
+          /* short arm */
+        width: 5px;
+        border-bottom: 3px solid #4D7C2A;
+          /* long arm */
+        height: 11px;
+        border-right: 3px solid #4D7C2A;
+        
+        /* rotate the mirrored L to make it a checkbox */
+        transform: rotate(45deg);
+        -o-transform: rotate(45deg);
+        -ms-transform: rotate(45deg);
+        -webkit-transform: rotate(45deg);
+      }
+
+      .cross:after{
+        display: inline-block;
+        content: "\00d7"; /* This will render the 'X' */
+        font-size: 30px;
+        color: #4D7C2A;
+      }
+    </style>
+  </head>
+  <body>
+
+    <table>
+      <tr>
+        <% if @brakeman_warnings.count > 1 %>
+          <td style="width:25%;"><span class='cross'></span>Brakeman Warnings(<%= @brakeman_warnings.count %>)</td>
+        <% else %>
+          <td style="width:25%;"><span class='done'></span>Brakeman Warnings(<%= @brakeman_warnings.count %>)</td>
+        <% end %>
+
+        <% if @rails_best_practices_info.first['rails_best_practices'] > 50 %>
+          <td style="width:25%;"><span class='cross'></span>Rails Best Practices(<%= @rails_best_practices_info.first['rails_best_practices'] %>)</td>
+        <% else %>
+          <td style="width:25%;"><span class='done'></span>Rails Best Practices(<%= @rails_best_practices_info.first['rails_best_practices'] %>)</td>
+        <% end %>
+
+        <% if @flog_info.first['flog'] > 5 %>
+          <td style="width:25%;"><span class='cross'></span>Flog(<%= @flog_info.first['flog'] %>)</td>
+        <% else %>
+          <td style="width:25%;"><span class='done'></span>Flog(<%= @flog_info.first['flog'] %>)</td>
+        <% end %>
+
+        <% if @stats_info.first['stats'] == 0.0 %>
+          <td style="width:25%;"><span class='cross'></span>Stats</td>
+        <% else %>
+          <td style="width:25%;"><span class='done'></span>Stats</td>
+        <% end %>
+      </tr>
+    </table>
+
+    <p></p>
+
+    <h2>Brakeman Warnings</h2>
+    <table>
+      <tr>
+        <th>Type</th>
+        <th>File</th>
+        <th>Message</th>
+      </tr>
+
+      <% @brakeman_warnings.each do |warning| %>
+        <tr>
+          <td><h4><%= warning['warning_type'] %></h4></td>
+          <td><%= warning['file'] %></td>
+          <td><%= warning['message'] %></td>
+        </tr>
+      <% end %>
+      <tr><td><a href="<%= @app_root %>/report.html">Report</a></td></tr>
+    </table>
+    <p></p>
+
+    <h2>Rails Best Practices</h2>
+    <table>
+      <tr>
+        <td><a href="<%= @app_root %>/tmp/metric_fu/output/rails_best_practices.html">Found <%= @rails_best_practices_info.first['rails_best_practices'] %> issues.</a></td>
+      </tr>
+    </table>
+    <p></p>
+
+    <h2>Flog code complexity</h2>
+    <table>
+      <tr>
+        <td><a href="<%= @app_root %>/tmp/metric_fu/output/flog.html">Average Flog score for all methods: <%= @flog_info.first['flog'] %></a></td>
+      </tr>
+    </table>
+    <p></p>
+
+
+    <h2>Stats</h2>
+    <table>
+      <tr>
+        <td>
+          testLOC: <%= @matric_fu_info.first['testLOC'] %>/
+          codeLOC: <%= @matric_fu_info.first['codeLOC'] %>
+          </br>
+          <a href="<%= @app_root %>/tmp/metric_fu/output/stats.html">Code to test ratio: <%= @stats_info.first['stats'] %></a>
+        </td>
+      </tr>
+    </table>
+    <p></p>
+
+    <h2><%= "Generated on #{Time.now}" %></h2>
+  </body>
+</html>

data/lib/app_reporter/version.rb

@@ -0,0 +1,3 @@
+module AppReporter
+  VERSION = "1.0.0"
+end

data/lib/tasks/app_reporter.rake

@@ -0,0 +1,17 @@
+require 'erb'
+
+namespace :app_reporter do
+  desc "Run AppReporter"
+  task :run do
+    extend AppReporter
+		# Function call
+		p "===== Collecting data from brakeman report ====="
+		self.brakeman_report
+
+		p "===== Collecting data from metric_fu_report report ====="
+		self.metric_fu_report
+
+		p "===== Generating final report ====="
+		self.generate_final_report
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: app_reporter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rohit Bhore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: brakeman
+  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: metric_fu
+  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: railties
+  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'
+description: Code quality report through metric_fu and brakeman gem
+email:
+- rohitpbhore@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app_reporter.gemspec
+- bin/console
+- bin/setup
+- lib/app_reporter.rb
+- lib/app_reporter/railtie.rb
+- lib/app_reporter/templates/summary_report.html.erb
+- lib/app_reporter/version.rb
+- lib/tasks/app_reporter.rake
+homepage: https://github.com/rohitpbhore/app_reporter.git
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Code quality report through metric_fu and brakeman gem
+test_files: []