localer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a309d2dbc2fa3ea7e8ac7de8203ce0f035a7ca4
+  data.tar.gz: 865767a7d9351227ff9e4251ead00c9f85c03c0f
+SHA512:
+  metadata.gz: 36d7e4bb99174638cf5d9feb228cf89b690a694b48a0f3514820be3facf40f89c4bd681a23519707d22a2daf5fd6834d086b71cd82dd212a202e937ffef4704c
+  data.tar.gz: e94ff2870007d253cf7cf7ff2e58987ae0c59e72255c4fecbb6f6475aa1fef934c3f79fc3f54b34eae35e70a19ab8cf4765ff2b8506d666ba7db68e2d8acd977

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,68 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'Gemfile'
+    - 'Rakefile'
+    - '*.gemspec'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/DoubleNegation:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.0

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 deriabin@gmail.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in localer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Deryabin
+
+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 @@
+# Localer
+
+Automatic detecting missing I18n translations tool.
+
+
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'localer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install localer
+
+## 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/aderyabin/localer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) 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 Localer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aderyabin/localer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/bin/localer

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require "pry"
+require "thor"
+require_relative "../lib/localer"
+
+module Localer
+  class CLI < Thor
+    desc "version", "Print Localer version"
+    def version
+      say Localer::VERSION
+    end
+
+    desc "check", "Check I18n complete"
+    def check
+      if Localer.complete?
+        say "\xE2\x9C\x94 No missing translations found.", :green
+      else
+        missing_translations = Localer.missing_translations
+        say "\xE2\x9C\x96 Missing translations found (#{missing_translations.count}):", :red
+        missing_translations.each do |tr|
+          say "* #{tr}"
+        end
+
+        exit 1
+      end
+    end
+
+    desc "console", "Run console"
+    def console
+      binding.pry
+    end
+  end
+end
+
+
+Localer::CLI.start(ARGV)

data/lib/localer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "localer/version"
+require_relative "localer/service"
+require_relative "localer/parser"
+require_relative "localer/checker"
+require_relative "localer/config"
+require_relative "localer/missing_translations"
+
+module Localer # :nodoc:
+  class << self
+    def parcer
+      @parcer ||= begin
+        require File.expand_path("config/environment", Dir.pwd)
+        I18n.backend.send(:init_translations)
+        Parser.call(I18n.backend.send(:translations))
+      end
+    end
+
+    # returns array of available locales
+    def locales
+      parcer.locales
+    end
+
+    def data
+      parcer.data
+    end
+
+    # checks missing translations
+    def complete?
+      Checker.call(locales, data)
+    end
+
+    # returns array of missing translations
+    def missing_translations
+      MissingTranslations.call(locales, data)
+    end
+
+    def config
+      @config ||= Config.call
+    end
+
+    def each_data
+      data.each do |key, value|
+        locales.each do |locale|
+          yield locale, key, value[locale]
+        end
+      end
+    end
+  end
+end

data/lib/localer/checker.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Localer
+  # Check missing translations
+  # Returns true if no missing translations found, otherwise false
+  class Checker < Service
+    def call
+      Localer.each_data do |_locale, _key, value|
+        return false if value.nil?
+      end
+      true
+    end
+  end
+end

data/lib/localer/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Localer
+  # Loads and parse Localer config file `.localer.yml`
+  class Config < Service
+    option :exclude, default: -> { [] }
+    def call
+      return unless File.exist?(filename)
+      yaml = YAML.load_file(filename)
+      @exclude = yaml["Exclude"] if yaml&.key?("Exclude")
+      self
+    end
+
+    private
+
+    def filename
+      File.expand_path(".localer.yml", Dir.pwd)
+    end
+  end
+end

data/lib/localer/missing_translations.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Localer
+  # A service that returns array of missing translations
+  class MissingTranslations < Service
+    def call
+      missing = []
+      Localer.each_data do |locale, key, value|
+        missing.push("#{locale}#{key}") if value.nil?
+      end
+      missing
+    end
+  end
+end

data/lib/localer/parser.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Localer
+  # Parse translations into hash:
+  # key: translation key
+  # value: hash of locale values
+  class Parser < Service
+    param :translations
+    param :config, default: -> { Localer.config }
+
+    attr_reader :data, :locales
+
+    def call
+      @data = {}
+      @locales = []
+      @translations.each do |(locale, translation)|
+        @locales.push locale
+        compare(locale, translation)
+      end
+
+      self
+    end
+
+    private
+
+    def compare(locale, translation, prefix = "")
+      if translation.is_a?(Hash)
+        translation.each do |(key, value)|
+          full_key = prefix + ".#{key}"
+          next if full_key.start_with?(*config.exclude)
+          compare(locale, value, full_key)
+        end
+      else
+        @data[prefix] ||= {}
+        @data[prefix][locale] = translation
+      end
+    end
+  end
+end

data/lib/localer/service.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+module Localer
+  # Core service object
+  class Service
+    extend Dry::Initializer # use `param` and `option` for dependencies
+
+    class << self
+      # Instantiates and calls the service at once
+      def call(*args, &block)
+        new(*args).call(&block)
+      end
+
+      # Accepts both symbolized and stringified attributes
+      def new(*args)
+        args << args.pop.symbolize_keys if args.last.is_a?(Hash)
+        super(*args)
+      end
+    end
+  end
+end

data/lib/localer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Localer
+  VERSION = "0.0.1"
+end

data/localer.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "localer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "localer"
+  spec.version       = Localer::VERSION
+  spec.authors       = ["Andrey Deryabin"]
+  spec.email         = ["deriabin@gmail.com"]
+
+  spec.summary       = %q{Automatic detecting missing I18n translations tool.}
+  spec.description   = %q{Automatic detecting missing I18n translations tool.}
+  spec.homepage      = "https://github.com/aderyabin/localer"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "rubocop", "~> 0.50"
+
+  spec.add_dependency "thor", "~> 0.20.0"
+  spec.add_dependency "dry-initializer", "~> 2.3.0"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: localer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrey Deryabin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description: Automatic detecting missing I18n translations tool.
+email:
+- deriabin@gmail.com
+executables:
+- localer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/localer
+- lib/localer.rb
+- lib/localer/checker.rb
+- lib/localer/config.rb
+- lib/localer/missing_translations.rb
+- lib/localer/parser.rb
+- lib/localer/service.rb
+- lib/localer/version.rb
+- localer.gemspec
+homepage: https://github.com/aderyabin/localer
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Automatic detecting missing I18n translations tool.
+test_files: []