simplecov-coverboard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 224f42ae9118e409f76d5d08a94973ee13539fc1
+  data.tar.gz: 2863fc83126ab91a54c3987762043a8c3d46ed9d
+SHA512:
+  metadata.gz: 3f7b4f9d3ccc983582a21fe17a8f41efb47334212ebbe99071b6fdadde88f20367a24b64795a43db6b2062323d3642b6e547ac9e8c850310a9faf4dbf277bdcf
+  data.tar.gz: 9f37b11d4db73b9a0aa729c8a180eba2f515d0d584ba1fc421643feee96bc938effe1b8949c1f6e19ba2a5b59f3c8fec264df72e9a05e237c9242f296b4e5ebf

data/.coverboard.yml

@@ -0,0 +1,3 @@
+coverboard:
+  uid: 'qwerty123456'
+  verbose: false

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,27 @@
+.rvmrc
+.bundle
+Gemfile.lock
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## RUBYMINE
+.idea
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.sass-cache

data/.rubocop.yml

@@ -0,0 +1,50 @@
+Metrics/BlockNesting:
+  Max: 2
+
+Metrics/LineLength:
+  AllowURI: true
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 10
+
+Metrics/ParameterLists:
+  Max: 4
+  CountKeywordArgs: true
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/CollectionMethods:
+  PreferredMethods:
+    map:      'collect'
+    reduce:   'inject'
+    find:     'detect'
+    find_all: 'select'
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/simplecov-coverboard.rb'
+    - 'test/test_simple_cov-html.rb'
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: 'comma'

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+
+before_install:
+  - gem install bundler
+
+bundler_args: --without development --jobs=3 --retry=3
+
+cache: bundler
+
+sudo: false
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+  - jruby
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby
+    - rvm: rbx-2
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+
+# Use local copy of simplecov in development when checked out, fetch from git otherwise
+if File.directory?(File.dirname(__FILE__) + "/../simplecov")
+  gem "simplecov", :path => File.dirname(__FILE__) + "/../simplecov"
+else
+  gem "simplecov", :git => "https://github.com/colszowka/simplecov"
+end
+
+group :test do
+  gem "test-unit"
+end
+
+group :development do
+  gem "rubocop"
+  gem "sass"
+  gem "sprockets"
+end

data/Guardfile

@@ -0,0 +1,12 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard "bundler" do
+  watch("Gemfile")
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end
+
+guard "rake", :task => "assets:compile" do
+  watch(%r{^assets\/})
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2013 Christoph Olszowka
+
+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,42 @@
+simplecov-coverboard
+=====================
+Helpling Hackathon project
+:beer: :pizza: :banana: :monkey:
+
+[![Build Status](https://travis-ci.org/Coverboard/simplecov-coverboard.svg)](https://travis-ci.org/Coverboard/simplecov-coverboard)
+
+## What?
+*simplecov-coverboard* is a SimpleCov::Formatter which sends your code coverage metrics. 
+You can see the metrics on the CoverBoard project dashboard.
+
+## How to install
+### Add required gems to your Gemfile
+```
+gem 'simplecov' 
+gem 'simplecov-coverboard', git: https://github.com/coverboard/simplecov-coverboard
+```
+### Configure your project
+Create a file which will contain the uid of your project: .coverboard.yml
+
+```
+coverboard:
+  uid: 'demo'
+```
+
+Set the default SimpleCov formatter
+
+```
+SimpleCov.formatter = SimpleCov::Formatter::CoverBoardFormatter
+```
+
+### Check the charts
+After running your tests check the charts https://aqueous-forest-2696.herokuapp.com/?project=demo
+
+## Contribution
+- fork the repository
+- create a PR 
+
+## About the author
+* [Lautaro](https://www.github.com/lautaro-mazzitelli-helpling)
+* [Michał](https://www.github.com/mfranczakhelpling)
+* [Yair](https://github.com/yair-helpling)

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+# See https://github.com/colszowka/simplecov/issues/171
+desc "Set permissions on all files so they are compatible with both user-local and system-wide installs"
+task :fix_permissions do
+  system 'bash -c "find . -type f -exec chmod 644 {} \; && find . -type d -exec chmod 755 {} \;"'
+end
+# Enforce proper permissions on each build
+Rake::Task[:build].prerequisites.unshift :fix_permissions
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    $stderr.puts "Rubocop is disabled"
+  end
+end
+
+task :default => [:test, :rubocop]

data/lib/api/application_message.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+class ApplicationMessage
+  attr_accessor :metrics, :uid, :ts
+
+  def to_json
+    msg = Hash.new
+    msg[:uid] = @uid
+    msg[:metrics] = @metrics
+    msg[:ts] = Time.now.strftime('%s')
+    msg.to_json
+  end
+end

data/lib/api/config.rb

@@ -0,0 +1,58 @@
+require 'yaml'
+
+module CoverBoard
+  class Config
+    DOT_FILE = '.coverboard.yml'
+
+    @@config = nil
+
+    HTTPS = true
+    HOST = 'aqueous-forest-2696.herokuapp.com'
+    PORT = 80
+    ENDPOINT = '/api/metrics'
+
+    def self.uid
+      from_yml 'uid'
+    end
+
+    def self.user
+      from_yml 'user'
+    end
+
+    def self.password
+      from_yml 'password'
+    end
+
+    def self.host
+      from_yml 'host', HOST
+    end
+
+    def self.port
+      from_yml 'port', PORT
+    end
+
+    def self.endpoint
+      from_yml 'endpoint', ENDPOINT
+    end
+
+    def self.verbose
+      from_yml 'verbose', false
+    end
+
+    def self.https
+      from_yml 'https', HTTPS
+    end
+
+    private
+      def self.from_yml(key, default='')
+        if @@config.nil?
+          path = "#{Dir.pwd}/#{DOT_FILE}"
+          if File.exists? path
+            @@config = YAML.load(File.read(path))
+          end
+        end
+        return default if @@config.nil? || @@config['coverboard'][key].nil?
+        @@config['coverboard'][key]
+      end
+  end
+end

data/lib/api/connector.rb

@@ -0,0 +1,36 @@
+require 'net/http'
+
+class Connector
+  def post(payload)
+    uri = build_uri
+    req = Net::HTTP::Post.new(uri)
+    req.content_type = 'application/json'
+    req.body = payload
+
+    if CoverBoard::Config.user && CoverBoard::Config.password
+      req.basic_auth CoverBoard::Config.user, CoverBoard::Config.password
+    end
+
+    if CoverBoard::Config.verbose
+      puts "Pushing to #{uri}"
+      puts "Application id #{CoverBoard::Config.uid}"
+      puts "Payload #{payload}"
+    end
+
+    response = Net::HTTP.new(uri.hostname, uri.port).start {|http| http.request(req) }
+
+    if CoverBoard::Config.verbose
+      puts "Response #{response.code} #{response.message}: #{response.body}"
+    end
+
+    response
+  end
+
+  private
+    def build_uri
+      uri = 'http'
+      uri += 's' if CoverBoard::Config.https
+
+      URI("#{uri}://#{CoverBoard::Config.host}:#{CoverBoard::Config.port}#{CoverBoard::Config.endpoint}")
+    end
+end

data/lib/simplecov-coverboard/version.rb

@@ -0,0 +1,27 @@
+module SimpleCov
+  module Formatter
+    class CoverBoardFormatter
+      VERSION = "0.1.0"
+
+      def VERSION.to_a
+        split(".").map(&:to_i)
+      end
+
+      def VERSION.major
+        to_a[0]
+      end
+
+      def VERSION.minor
+        to_a[1]
+      end
+
+      def VERSION.patch
+        to_a[2]
+      end
+
+      def VERSION.pre
+        to_a[3]
+      end
+    end
+  end
+end

data/lib/simplecov-coverboard.rb

@@ -0,0 +1,71 @@
+require "erb"
+require "cgi"
+require "fileutils"
+require "digest/sha1"
+require "time"
+
+# Ensure we are using a compatible version of SimpleCov
+major, minor, patch = SimpleCov::VERSION.scan(/\d+/).first(3).map(&:to_i)
+if major < 0 || minor < 9 || patch < 0
+  fail "The version of SimpleCov you are using is too old. "\
+  "Please update with `gem install simplecov` or `bundle update simplecov`"
+end
+
+module SimpleCov
+  module Formatter
+    class CoverBoardFormatter
+      DOT_FILE = '.coverboard.yml'
+
+      def initialize
+        @uid = load_from_config
+      end
+
+      def format(result)
+        send_to_api(create_message(metrics(result)))
+      end
+
+      private
+        # michal says: LATERRRRR
+        PRECISSION = 2
+        TIMESTAMP = Time.now.getutc
+
+        def metrics(numbers)
+          prefix = 'coverage-'
+
+          metrics = Hash.new
+          numbers.groups.each do |key, value|
+            key = prefix + key.gsub(' ','-').downcase
+            metrics[key] = value.covered_percent.round(PRECISSION)
+          end
+          metrics[prefix.gsub('-','')] = numbers.source_files.covered_percent.round(PRECISSION)
+          metrics
+        end
+
+        def create_message metrics
+          app_message = ApplicationMessage.new
+          app_message.uid = @uid
+          app_message.ts = TIMESTAMP
+          app_message.metrics = metrics
+          return app_message.to_json
+        end
+
+        def send_to_api msg
+          connector = Connector.new
+          puts connector.post msg
+        end
+
+      private
+        def load_from_config
+          config = YAML.load(File.read("#{Dir.pwd}/#{DOT_FILE}"))
+          @uid = config['coverboard']['uid']
+        end
+    end
+  end
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+require "simplecov-coverboard/version"
+
+require "api/config"
+require "api/application_message"
+require "api/connector"

data/simplecov-coverboard.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "simplecov-coverboard/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "simplecov-coverboard"
+  gem.version     = SimpleCov::Formatter::CoverBoardFormatter::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Michal Franczak", "Lautaro Mazzitelli"]
+  gem.homepage    = "https://github.com/lautaro-mazzitelli-helpling/simplecov-coverboard"
+  gem.description = %(Simplecov formatter which sends metrics to CoverBoard)
+  gem.summary     = gem.description
+  gem.license     = "MIT"
+
+  gem.required_ruby_version = ">= 1.8.7"
+  gem.add_development_dependency "bundler", "~> 1.9"
+  gem.add_runtime_dependency "simplecov"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+require "simplecov"
+require "simplecov-coverboard"
+require "test/unit"

data/test/test_simple_cov-html.rb

@@ -0,0 +1,8 @@
+require "helper"
+
+class TestSimpleCovCoverBoard < Test::Unit::TestCase
+  def test_defined
+    assert defined?(SimpleCov::Formatter::CoverBoardFormatter)
+    assert defined?(SimpleCov::Formatter::CoverBoardFormatter::VERSION)
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-coverboard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michal Franczak
+- Lautaro Mazzitelli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Simplecov formatter which sends metrics to CoverBoard
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coverboard.yml
+- .document
+- .gitignore
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/api/application_message.rb
+- lib/api/config.rb
+- lib/api/connector.rb
+- lib/simplecov-coverboard.rb
+- lib/simplecov-coverboard/version.rb
+- simplecov-coverboard.gemspec
+- test/helper.rb
+- test/test_simple_cov-html.rb
+homepage: https://github.com/lautaro-mazzitelli-helpling/simplecov-coverboard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simplecov formatter which sends metrics to CoverBoard
+test_files:
+- test/helper.rb
+- test/test_simple_cov-html.rb