simplecov_url 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: feb5bd2e7ed75132e515c37a69f9b26a543a638798486baad001863bb753d283
+  data.tar.gz: 5800d99260b78ee1b76d4f8dd35925808a73538bc91961ceac4bec6cf4601327
+SHA512:
+  metadata.gz: 80567bf947749bc99cdb3b48d03c99f96db0c11ceeafe8db6b5a9802d1b1b5e2e69c5056c2094621910a846c54a2e103db33e43cf342c3358c6002872fd91c95
+  data.tar.gz: a0a5e21b6a3e99b0db8d535ed76239c2ba6e7f765e81b90e40efeb4547e4e7034f12b1d3b316bfabacf8c7f842fce4cd24b2eaebdb33236ff1ada8ec4b707463

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Evgeni Radev
+
+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 @@
+# SimplecovUrl
+
+The gem publishes Simplecov's test coverage reports to your_url/simplecov.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'simplecov_url', '~> 1.0'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Dependencies
+
+```
+gem 'rails', '~> 5.2.3'
+```
+
+```
+gem 'simplecov', '~> 0.16.1'
+```
+
+```
+gem 'simplecov-html', '~> 0.10.0'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/evgeniradev/simplecov_url](https://github.com/evgeniradev/simplecov_url).
+
+## License
+
+SimplecovUrl is released under the MIT License. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/controllers/simplecov_url/simplecov_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SimplecovUrl
+  class SimplecovController < ApplicationController
+    def index
+      render html: SimplecovUrl::HtmlProcessor.call
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  get :simplecov, to: 'simplecov_url/simplecov#index'
+end

data/lib/simplecov_url/access_manager.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SimplecovUrl
+  class AccessManager
+    def self.deny?
+      new.deny?
+    end
+
+    def deny?
+      tmp = ENV['ALLOWED_SIMPLECOV_ENVIRONMENTS']
+
+      tmp.present? ? tmp.split(',').none? { |env| env == Rails.env } : false
+    end
+  end
+end

data/lib/simplecov_url/html_processor.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'simplecov_url/access_manager'
+
+module SimplecovUrl
+  class HtmlProcessor
+    HTML_FILE         = 'index.html'
+    CSS_FILE          = 'application.css'
+    JAVASCRIPT_FILE   = 'application.js'
+
+    def self.call
+      new.html
+    end
+
+    def html
+      return no_report_message(' for environment') if AccessManager.deny?
+
+      tmp = read_file(HTML_FILE)
+
+      return no_report_message unless tmp
+
+      tmp = remove_link_and_script_tags(tmp)
+
+      tmp = img_href_tags_to_base64(tmp)
+
+      return frontend_error(CSS_FILE) unless css
+
+      return frontend_error(JAVASCRIPT_FILE) unless javascript
+
+      tmp = insert_css_and_javascript_as_inline(tmp)
+
+      tmp.html_safe
+    rescue StandardError => e
+      general_error(e)
+    end
+
+    private
+
+    def files
+      @files ||= Dir.glob(File.join(Rails.root, 'coverage', '**', '*'))
+    end
+
+    def read_file(name)
+      file = files.find { |f| f.include?(name) }
+
+      file ? File.read(file) : nil
+    end
+
+    def javascript
+      @javascript ||= begin
+        tmp = read_file(JAVASCRIPT_FILE)
+
+        return nil unless tmp
+
+        "<script>#{tmp}</script>"
+      end
+    end
+
+    def css
+      @css ||= begin
+        tmp = read_file(CSS_FILE)
+
+        return nil unless tmp
+
+        tmp = background_url_attributes_to_base64(tmp)
+
+        "<style>#{tmp}</style>"
+      end
+    end
+
+    def background_url_attributes_to_base64(content)
+      imgs_to_base64(
+        content,
+        attribute_regex: /url\(.*?\)/,
+        paths_regex: /(url\W*)|(\W*$)/,
+        replacement: lambda do |encoded_img, mime_type|
+          "url(data:#{mime_type};base64,#{encoded_img})"
+        end
+      )
+    end
+
+    def img_href_tags_to_base64(content)
+      imgs_to_base64(
+        content,
+        attribute_regex: /<img src=['|"].*?['|"]/,
+        paths_regex: /<img.*\.\/|\W*$/,
+        replacement: lambda do |encoded_img, mime_type|
+          "<img src='data:#{mime_type};base64,#{encoded_img}'"
+        end
+      )
+    end
+
+    def imgs_to_base64(content, attribute_regex:, paths_regex:, replacement:)
+      attributes = content.scan(attribute_regex).flatten
+
+      img_paths = attributes.map do |attribute|
+        [attribute, attribute.gsub(paths_regex, '')]
+      end
+
+      base64s = img_paths.map do |attribute, img_path|
+        file = files.find { |f| f.include?(img_path) }
+
+        mime_type = "image/#{File.extname(file).delete('.')}"
+
+        encoded_img = Base64.strict_encode64(File.read(file))
+
+        [attribute, replacement.call(encoded_img, mime_type)]
+      end.to_h
+
+      base64s.each do |attribute, base64|
+        content = content.gsub(attribute, base64)
+      end
+
+      content
+    end
+
+    def insert_css_and_javascript_as_inline(tmp)
+      position = (tmp =~ /<\/head>/)
+
+      tmp.insert(position, css)
+      tmp.insert(position, javascript)
+    end
+
+    def remove_link_and_script_tags(tmp)
+      tmp.gsub(/<link.*>/, '').gsub(/<script.*<\/script>/, '')
+    end
+
+    def no_report_message(extra = '')
+      "No test coverage report available#{extra}."
+    end
+
+    def frontend_error(filename)
+      "Error: '#{filename}' file is missing."
+    end
+
+    def general_error(error)
+      puts(error.message)
+      puts(error.backtrace)
+      'Error: Unable to load test coverage report.'
+    end
+  end
+end

data/lib/simplecov_url/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimplecovUrl
+  VERSION = '1.0.0'
+end

data/lib/simplecov_url.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'simplecov_url/html_processor'
+
+module SimplecovUrl
+  class Engine < Rails::Engine
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: simplecov_url
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Evgeni Radev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- evgeniradev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/simplecov_url/simplecov_controller.rb
+- config/routes.rb
+- lib/simplecov_url.rb
+- lib/simplecov_url/access_manager.rb
+- lib/simplecov_url/html_processor.rb
+- lib/simplecov_url/version.rb
+homepage: https://github.com/evgeniradev/simplecov_url
+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.7.9
+signing_key: 
+specification_version: 4
+summary: The gem publishes Simplecov's test coverage reports to your_url/simplecov.
+test_files: []