views_coverage 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45aac1ef2be75a4ae2b9ed458ae8d32aa33de4d323d2c81c2a4e4693417f627e
+  data.tar.gz: 0ae68763a28f4ea77ddab63810292fcc78ed12bd7f43468dbbdb03a7a129bf16
+SHA512:
+  metadata.gz: 1a54185cd78ef104c6aa76989247fbc5dcd2fa7786fe1ba5b0165ad04a41734e545b579f516a5eb5d7a141b2b68217f9b30ec62f2c1a35dd004ef6cec15a01bc
+  data.tar.gz: 2a0e86ac8fd7ed55ce3e863515917c46546458526dbf231d7b26c568cadc77f61fa0626fa67da7b6fe06b3cbc777e41c9e8ae699dd5acaefcdb14a3f1f2f704b

data/.gitignore

@@ -0,0 +1,59 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# Rubymine
+.idea

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at macku@jchsoft.cz. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in views_coverage.gemspec
+gemspec
+
+group :test do
+  gem 'activerecord'
+  gem 'activesupport'
+  gem 'minitest'
+  gem 'minitest-hooks'
+  gem 'pg'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 JchSoft s.r.o.
+
+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,55 @@
+# views_coverage
+ViewsCoverage is Minitest plugin for showing which views or partials was generated during tests. Plugin listening for [render notification from Rails framework](https://guides.rubyonrails.org/active_support_instrumentation.html#action-view) and save data from this event (path to view and how many times it was generated). 
+
+## Installation
+Add this line to your application's Gemfile:
+
+```
+gem 'views_coverage'
+```
+
+And then execute:
+        
+```
+$ bundle
+```
+
+## Usage
+__Warning: Plugin dont support parallel tests. If you want to use this plugin, set `parallelize(workers: 1)` or comment `parallelize` line in your `test_helper.rb`.__ 
+
+Basic usage is run tests with `--views-coverage` flag:
+
+```
+rails test --views-coverage
+```
+
+or if you run system tests, this flag must be passed in TESTOPS:
+
+```
+rails test:system TESTOPTS="--views-coverage"
+```
+
+This command will generate following files:
+* for unit tests - `views_coverage_result_unit_pretty.txt` and `views_coverage_result_unit.yml`
+* for system tests - `views_coverage_result_system_pretty.txt` and `views_coverage_result_system.yml`
+
+`*.txt` files are containing pretty printed coverage output.
+`*.yml` files are containing coverage for "merge" mode (viz next paragraph).
+
+### Merge results from multiple test runs
+If you want to merge results from multiple test runs (for example from unit tests and system tests), you should pass `--views-coverage-mode=merge` when running tests:
+
+```
+rails test:system TESTOPTS="--views-coverage --views-coverage-mode=merge"
+```
+
+This mode load content of YML files and merge their results into `views_coverage_result_merged_pretty.txt` and `views_coverage_result_merged_pretty.yml` files.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/jchsoft/views_coverage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+Everyone interacting in the ViewsCoverage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jchsoft/views_coverage/blob/master/CODE_OF_CONDUCT.md).

data/lib/minitest/views_coverage_plugin.rb

@@ -0,0 +1,94 @@
+module Minitest
+  class ViewsCoverage < AbstractReporter
+    NO_TEMPLATE_IDENTIFIERS = ['html template', 'text template'].freeze
+    RESULT_FILENAME_PREFIX = 'views_coverage_result_'.freeze
+    MERGE_MODE_FLAG = 'merge'.freeze
+
+    def initialize(options)
+      super()
+      @mode = options.delete(:mode) || 'clean'
+      @coverage_result = {}
+      subscribe_to_notifications
+    end
+
+    def prerecord(klass, _name)
+      @test_type = klass < ActionDispatch::SystemTestCase ? :system : :unit
+    end
+
+    def report
+      write_result(@coverage_result[:unit], :unit) if @coverage_result[:unit].present?
+      write_result(@coverage_result[:system], :system) if @coverage_result[:system].present?
+      write_merged_result if @mode == MERGE_MODE_FLAG
+    end
+
+    private
+
+    def subscribe_to_notifications
+      %w[render_template.action_view render_partial.action_view render_collection.action_view].each do |event_name|
+        ActiveSupport::Notifications.subscribe event_name do |_name, _start, _finish, _id, payload|
+          @coverage_result[@test_type] ||= prepare_result_hash
+          @coverage_result[@test_type][payload[:identifier].delete_prefix("#{::Rails.root.to_s}/")] += 1
+        end
+      end
+    end
+
+    def write_merged_result
+      if @coverage_result[:system].present?
+        result = merge_results(current_result: @coverage_result[:system], previous_test_type: :unit)
+      else
+        result = merge_results(current_result: @coverage_result[:unit], previous_test_type: :system)
+      end
+      write_result(result, :merged)
+    end
+
+    def merge_results(current_result:, previous_test_type:)
+      previous_result = YAML.load_file("#{RESULT_FILENAME_PREFIX}#{previous_test_type}.yml")
+      current_result.merge(previous_result) { |_path, previous_count, current_count| previous_count + current_count }
+    end
+
+    def prepare_result_hash
+      {}.tap do |hash|
+        NO_TEMPLATE_IDENTIFIERS.each { |identifier| hash[identifier] = 0 }
+        Dir.glob('app/views/**/*.*').each { |file_path| hash[file_path] = 0 }
+      end
+    end
+
+    def write_result(result, type)
+      File.open("#{RESULT_FILENAME_PREFIX}#{type}.yml", 'w') do |file|
+        file.write(YAML.dump(result))
+      end
+
+      called_views = result.select { |_, count| count.positive? }
+      not_called_views = result.select { |_, count| count.zero? }
+
+      file = File.new("#{RESULT_FILENAME_PREFIX}#{type}_pretty.txt", 'w')
+      file.write("=============== Not called ===============\n")
+      not_called_views.keys.sort.each { |path| file.write("#{path}\n") }
+
+      file.write("\n\n\n")
+      file.write("=============== Called ===============\n")
+      called_views.each_pair { |path, call_counter| file.write("#{call_counter}:\t\t#{path}\n") }
+
+      file.write("\n\n\n")
+      file.write("=============== Summary ===============\n")
+      file.write("Uncalled: #{not_called_views.length}\n")
+      file.write("Called: #{called_views.length}\n")
+      file.write("Coverage %: #{((called_views.length.to_d / result.length) * 100).to_s}")
+      file.close
+    end
+  end
+
+  def self.plugin_views_coverage_options(opts, options)
+    opts.on "--views-coverage", "Generate coverage for views" do
+      options[:views_coverage] = true
+    end
+
+    opts.on '--views-coverage-mode MODE', String do |mode|
+      options[:mode] = mode
+    end
+  end
+
+  def self.plugin_views_coverage_init(options)
+    self.reporter << ViewsCoverage.new(options) if options[:views_coverage]
+  end
+end

data/lib/views_coverage.rb

@@ -0,0 +1,2 @@
+module ViewsCoverage
+end

data/views_coverage.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'views_coverage'
+  s.version     = '0.0.2'
+  s.summary     = 'Minitest plugin providing test coverage for views (which templates and partials were and werent generated during tests).'
+  s.authors     = ['mmacku']
+  s.email       = 'macku@jchsoft.cz'
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files    = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.homepage    = 'https://github.com/jchsoft/views_coverage'
+  s.license     = 'MIT'
+  s.add_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: views_coverage
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- mmacku
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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:
+email: macku@jchsoft.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/minitest/views_coverage_plugin.rb
+- lib/views_coverage.rb
+- views_coverage.gemspec
+homepage: https://github.com/jchsoft/views_coverage
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Minitest plugin providing test coverage for views (which templates and partials
+  were and werent generated during tests).
+test_files: []