i18n-coverage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 776761959a5e1226e1622b341e3db434020b336a02e23f9666707293484a64d0
+  data.tar.gz: d98f78f24993f50ebef9ea318a4d3c99be7a1e033c97c8e92368e9b387606948
+SHA512:
+  metadata.gz: '0963aedd591d0f12af222870069d01df77dfdae86280c1737dca2a1613247d7f1cbf43132a626182f658a2fbf4696bacb84bccf0fefd2a64039274ca3bb8552b'
+  data.tar.gz: f3df449e75079be37369ef8104fddbac7915917070dc81cc847e19affbd31f98645d16d400eea0f841f4468fcc76ee59b9c497d79e8796eebec4573b9c6fd653

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in i18n-coverage.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    i18n-coverage (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    git (1.5.0)
+    github_api (0.18.2)
+      addressable (~> 2.4)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8)
+      hashie (~> 3.5, >= 3.5.2)
+      oauth2 (~> 1.0)
+    hashie (3.6.0)
+    highline (2.0.2)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    juwelier (2.4.9)
+      builder
+      bundler
+      git
+      github_api
+      highline
+      kamelcase (~> 0)
+      nokogiri
+      psych
+      rake
+      rdoc
+      semver2
+    jwt (2.2.1)
+    kamelcase (0.0.2)
+      semver2 (~> 3)
+    mini_portile2 (2.4.0)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    psych (3.1.0)
+    public_suffix (3.1.0)
+    rack (2.0.7)
+    rake (10.5.0)
+    rdoc (6.1.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    semver2 (3.4.2)
+    thread_safe (0.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  i18n (~> 0.7)
+  i18n-coverage!
+  juwelier (~> 2.4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,50 @@
+# I18n-coverage
+[![Build Status](https://travis-ci.org/hiptest/i18n-coverage.svg?branch=master)](https://travis-ci.org/hiptest/i18n-coverage)
+
+Simple gem to see how much of your i18n keys are used during tests. It requires that the translations are handled by the [i18n](https://rubygems.org/gems/i18n/) gem.
+
+This gem is not meant to replace tools such as [i18n-tasks](https://rubygems.org/gems/i18n-tasks), but more to give you an idea of which keys are not covered by tests (especially when adding translations to a gem where strings were hard-coded previously).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n-coverage'
+```
+
+## Usage
+
+First, you need to ensure that the gem is correctly loaded when running the tests. When using rspec for example:
+
+```ruby
+# file spec_helper.rb
+require 'i18n-coverage'
+```
+
+You also need to output/read the results of the coverage. This should be done once all the tests have been executed. Once again, an example with rspec:
+
+```ruby
+RSpec.configure do |config|
+  config.after(:suite) do
+    I18n::Coverage::Reporter.report if ENV['I18N_COVERAGE']
+  end
+end
+```
+
+Then, when running the tests, you need to enable coverage by setting the environment variable `I18N_COVERAGE`. For example with rspec:
+
+```shell
+I18N_COVERAGE=1 bundle exec rspec
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hiptest/i18n-coverage.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "i18n/coverage"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/i18n-coverage.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "i18n/coverage/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n-coverage"
+  spec.version       = I18n::Coverage::VERSION
+  spec.authors       = ["Hiptest"]
+  spec.email         = ["contact@hiptest.com"]
+
+  spec.summary       = %q{Provides a coverage of I18n keys used during test suite}
+  spec.homepage      = "https://github.com/hiptest/i18n-coverage"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/hiptest/i18n-coverage"
+    spec.metadata["changelog_uri"] = "https://github.com/hiptest/i18n-coverage/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "i18n", "~> 0.7"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "juwelier", "~> 2.4"
+
+end

data/lib/i18n/backend/key_logger.rb

@@ -0,0 +1,12 @@
+require 'i18n/coverage/key_logger'
+
+module I18n
+  module Backend
+    module KeyLogger
+      def translate(*args)
+        I18n::Coverage::KeyLogger.store_key(args[1])
+        super
+      end
+    end
+  end
+end

data/lib/i18n/coverage.rb

@@ -0,0 +1,9 @@
+require "i18n/coverage/version"
+require "i18n/backend/key_logger"
+
+module I18n
+  module Coverage
+  end
+end
+
+I18n::Backend::Simple.send(:include, I18n::Backend::KeyLogger) if ENV['I18N_COVERAGE']

data/lib/i18n/coverage/key_lister.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+
+module I18n
+  module Coverage
+    class KeyLister
+      def self.list_keys(locale: 'en', locale_dir_path: 'config/locales')
+        KeyLister.new(locale, locale_dir_path).list_keys
+      end
+  
+      def initialize(locale, locale_dir_path)
+        @locale = locale
+        @source = YAML.load(File.open(File.expand_path("#{locale_dir_path}/#{locale}.yml")))
+        @keys = Set[]
+      end
+  
+      def list_keys
+        visit_childs(path: [])
+        @keys
+      end
+  
+      private
+  
+      def visit_childs(path: )
+        node = @source.dig(*[@locale, path].flatten.compact)
+        if node.respond_to? :keys
+          keys = node.keys
+
+          if pluralization_keys?(keys)
+            @keys.add(path.join('.'))
+          else
+            keys.map {|key| visit_childs(path: [path, key].flatten.compact)}
+          end
+        else
+          @keys.add(path.join('.'))
+        end
+      end
+
+      def pluralization_keys?(keys)
+        return (keys - ['zero', 'one', 'other']).empty?
+      end
+    end
+  end
+end

data/lib/i18n/coverage/key_logger.rb

@@ -0,0 +1,29 @@
+module I18n
+  module Coverage
+    class KeyLogger
+      def self.store_key(key)
+        KeyLogger.new.store_key(key)
+      end
+
+      def self.stored_keys
+        KeyLogger.new.stored_keys
+      end
+
+      def self.clear_keys
+        KeyLogger.new.clear_keys
+      end
+
+      def store_key(key)
+        stored_keys.add(key)
+      end
+
+      def clear_keys
+        stored_keys.clear        
+      end
+
+      def stored_keys
+        @@stored_keys ||= Set[]
+      end
+    end
+  end
+end

data/lib/i18n/coverage/reporter.rb

@@ -0,0 +1,39 @@
+require 'i18n/coverage/key_lister'
+require 'i18n/coverage/key_logger'
+
+module I18n
+  module Coverage
+    class Reporter
+      def self.report(locale: 'en', locale_dir_path: 'config/locales')
+        Reporter.new(locale: locale, locale_dir_path: locale_dir_path).report
+      end
+
+      def initialize(locale: 'en', locale_dir_path: 'config/locales')
+        @existing_keys = KeyLister.list_keys(locale: locale, locale_dir_path: locale_dir_path)
+        @used_keys = KeyLogger.stored_keys
+        @percentage_used = (@used_keys.count.to_f / @existing_keys.count.to_f) * 100
+        @unused_keys = @existing_keys - @used_keys
+      end
+
+      def report
+        puts ""
+        puts "I18n Coverage: #{@percentage_used.round(2)}% of the keys used"
+        puts "#{@existing_keys.count} keys found in yml file, #{@used_keys.count} keys used during the tests"
+
+        if @unused_keys
+          puts "Unused keys:"
+          @unused_keys.map {|k| puts "  #{k}"}
+        end
+      end
+
+      def hash_report
+        {
+          key_count: @existing_keys.count,
+          used_key_count: @used_keys.count,
+          percentage_used: @percentage_used,
+          unused_keys: @unused_keys
+        }
+      end
+    end
+  end
+end

data/lib/i18n/coverage/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module Coverage
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: i18n-coverage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiptest
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: 
+email:
+- contact@hiptest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n-coverage.gemspec
+- lib/i18n/backend/key_logger.rb
+- lib/i18n/coverage.rb
+- lib/i18n/coverage/key_lister.rb
+- lib/i18n/coverage/key_logger.rb
+- lib/i18n/coverage/reporter.rb
+- lib/i18n/coverage/version.rb
+homepage: https://github.com/hiptest/i18n-coverage
+licenses: []
+metadata:
+  homepage_uri: https://github.com/hiptest/i18n-coverage
+  source_code_uri: https://github.com/hiptest/i18n-coverage
+  changelog_uri: https://github.com/hiptest/i18n-coverage/CHANGELOG.md
+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: Provides a coverage of I18n keys used during test suite
+test_files: []