commentval 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2abf50dc0dfd5babdc920bd41f910a2485fd9b93
+  data.tar.gz: beb3c88cb6c2ea27ebd7d3ea7a64db414a7d8861
+SHA512:
+  metadata.gz: 6b11798058f3168819bd92c648c56cf1586842a73b04d256c504b44df57aa1927cd6c1a37ef8ce740065563031416cde068eed9cfe62225de10d3bbb6182db90
+  data.tar.gz: 2d3c5286083d3d39f70942ef81fceee570df341886fe665c4a7c695013c0d69d3abf39f5a7f895aa9ce3d9b50f066e9486a74f92f5d0a44be135d03668198ed9

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Andrew Moore
+
+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,20 @@
+Comment Validator
+===========
+
+This is a gem which will read the comments from files and check if they meet the targeted percentage.
+
+# How to use?
+
+```
+commentval <folders (seperate by comma)> <file extnesions (seperate by comma)> <comment threshold>
+```
+
+Example:
+
+```
+commentval propertyfrontend/ .py 0.9
+```
+
+# How does it check for a comment?
+
+It checks if there is either a # or a // in the file. If one of this is found this will count as a comment.

data/bin/commentval

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'commentval.rb'

data/lib/commentval.rb

@@ -0,0 +1,56 @@
+require 'nokogiri'
+
+if (ARGV[0].nil?) then
+  puts "Error: No Code folder provided"
+  exit(1)
+end
+
+code_folders = ARGV[0].split(',')
+
+if (ARGV[1].nil?) then
+  puts "Error: No Code extensions provided"
+  exit(1)
+end
+
+code_extensions = ARGV[1].split(',')
+
+if (ARGV[2].nil?) then
+  puts "Error: Coverage target missing"
+  exit(1)
+end
+
+target = ARGV[2].to_f;
+
+files = Array.new();
+
+code_folders.each do |filename|
+  all_files = Dir[filename + '**/**']
+  all_files.each do |filename|
+    if (code_extensions.include? File.extname(filename)) then
+      files.push(filename)
+    end
+  end
+end
+
+total = 0;
+passed = 0;
+
+files.each do |filename|
+  File.open(filename, "r") do |file_handle|
+    file_handle.each_line do |file_line|
+      total = total + 1
+      if ((file_line.scan(/#/i).count > 0) || (file_line.scan(/\/\//i).count > 0)) then
+        passed = passed + 1
+      end
+    end
+  end
+end
+
+actual = (passed.to_f / total.to_f).round(2)
+
+if (actual < target) then
+  puts "Error: Commenting is below target. Expected: >" + target.to_s + ", Actual: " + actual.to_s
+  exit(1)
+end
+
+puts "Success: Commenting is at or above target. Expected: >" + target.to_s + ", Actual: " + actual.to_s

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: commentval
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Andrew Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.15
+description: This gem will check if there the code has sufficient amount of comments.
+  This can be used in tools such as Jenkins to check if the comment meets the expected
+  quantity.
+email: mooreandrew@gmail.com
+executables:
+- commentval
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/commentval.rb
+- README.md
+- LICENSE
+- bin/commentval
+homepage: https://github.com/mooreandrew/commentval
+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.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []