i18n_def_scanner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b51a0a791a94023e300bcb4ce4adbec22ca89b727676a3bfdc3ee4c250a91d4
+  data.tar.gz: b16613c9edc828aedd3c83c906293fea403b4b4807b716c9092da34a46f3f6f2
+SHA512:
+  metadata.gz: 38334e257d1210d5e64a2f7b28ab8a944b450370faecfbde5219c95d0ffdaf714650c15e3dca2bce0d337c5f2f155f131e5980b76e96be659b34a8a807ba4ed3
+  data.tar.gz: 47e57861ba53e686d830c8eddeb12ac48a0f309c3d7af0c2c8223cd7da8ac263edc836fc7594ee83c3522d68b3d7c53da13c65940b667b6cf47fb153014786c8

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,52 @@
+# inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6.3
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.*'
+Naming/MethodName:
+  IgnoredPatterns:
+    - 'visit_I18nDefScanner_YAML_Nodes_/*'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/exe/**/*.*'
+RSpec/NestedGroups:
+  Max: 4
+
+Style/Documentation:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    i18n_def_scanner (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.4.2)
+    docile (1.3.2)
+    json (2.3.1)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-rspec (1.40.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  coveralls
+  i18n_def_scanner!
+  pry-byebug (~> 3.9.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.86.0)
+  rubocop-rspec (~> 1.40.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 GeorgeGorbanev
+
+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,74 @@
+# I18nDefScanner
+
+[![Coverage Status](https://coveralls.io/repos/github/GeorgeGorbanev/i18n_def_scanner/badge.svg?branch=master)](https://coveralls.io/github/GeorgeGorbanev/i18n_def_scanner?branch=master)
+
+I18nDefScanner is a CLI tool that helps to find where i18n translations defined. It accepts yaml key as argument and returns file path with line number where translation defined.
+
+## Motivation
+
+When rails-applications grows it becomes harder to maintain order in your translation files. Is it just one file with thousands of lines or hundreds files and directories it will always take time to find definition of translation you need to update if your code editor not configured to do it. So you can find plugin for your code editor or use this gem. Or configure your code editor to use this gem? :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_def_scanner', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_def_scanner
+
+## Usage
+
+All you need is to pass yaml key to executable
+``` sh
+bundle exec i18n_def_scanner en.my.deeply.nested.yaml.key
+```
+and it will print file path and definition number of line:
+```
+config/locales/en.yml:42
+```
+
+### Custom locales path
+
+Most of code editors plugins can't analyze rails-application config and consider with custom locales path. As this gem. But this gem has execution options with for locales path:
+
+``` sh
+bundle exec i18n_def_scanner en.my.deeply.nested.yaml.key --path=custom_locales_directory/**/*.yml
+```
+
+### As a lib
+
+If you need to locate any yaml definitions in your ruby code you can use this gem as lib, it has:
+
+1) Simple public API;
+2) No dependencies, using only ruby standard lib;
+3) No monkey patching.
+
+Example of usage:
+
+```ruby
+require 'i18n_def_scanner'
+
+scanning = I18nDefScanner::Scanning.new(query_path: 'some.key',load_path: 'locales/**/*.yml')
+puts scanning.result
+# locales/filename.yml:42
+```
+
+## Compatibility
+
+Ruby 2.6.3
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GeorgeGorbanev/i18n_def_scanner.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task(:default).clear.enhance(%w[spec rubocop])

data/exe/i18n_def_scanner

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'i18n_def_scanner'
+
+scanning_params = I18nDefScanner::CliArguments.new(ARGV)
+
+if scanning_params.help?
+  puts I18nDefScanner::HELP
+else
+  scanning = I18nDefScanner::Scanning.new(scanning_params.to_hash)
+  puts scanning.result
+end

data/i18n_def_scanner.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'i18n_def_scanner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'i18n_def_scanner'
+  spec.version       = I18nDefScanner::VERSION
+  spec.authors       = ['GeorgeGorbanev']
+  spec.email         = ['georgegorbanev@gmail.com']
+
+  spec.summary       = 'CLI tool to find where i18n translations defined.'
+  spec.description   = 'CLI tool accepts yaml key as argument and returns file path with' \
+                       'line number where translation defined.'
+  spec.homepage      = 'https://github.com/GeorgeGorbanev/i18n_def_scanner'
+  spec.license       = 'MIT'
+
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = ['i18n_def_scanner']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.86.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.40.0'
+end

data/lib/i18n_def_scanner.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'i18n_def_scanner/cli_arguments'
+require 'i18n_def_scanner/help'
+require 'i18n_def_scanner/scanning'
+require 'i18n_def_scanner/version'
+require 'i18n_def_scanner/yaml'
+
+module I18nDefScanner
+end

data/lib/i18n_def_scanner/cli_arguments.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module I18nDefScanner
+  class CliArguments
+    NAMED_ARGS_RE = /--?([^=\s]+)(?:=(\S+))?/.freeze
+
+    attr_accessor :argv_array
+
+    def initialize(argv_array)
+      self.argv_array = argv_array
+    end
+
+    def to_hash
+      { query_path: query_path, load_path: load_path }.compact
+    end
+
+    def help?
+      named_args.key?('help') || query_path.nil?
+    end
+
+    private
+
+    def query_path
+      argv_array[0]
+    end
+
+    def load_path
+      named_args['path']
+    end
+
+    def named_args
+      @named_args ||= Hash[argv_array.join(' ').scan(NAMED_ARGS_RE)]
+    end
+  end
+end

data/lib/i18n_def_scanner/help.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module I18nDefScanner
+  HELP = <<-HELP
+    Usage: i18n_def_scanner [yml key to find definition] [options]
+
+    Options:
+      --path=YMLS_PATH      Pattern of files to find definition,
+                            default value is "config/locales/**/*.yml"
+  HELP
+end

data/lib/i18n_def_scanner/scanning.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module I18nDefScanner
+  class Scanning
+    DEFAULT_LOAD_PATH = 'config/locales/**/*.yml'
+    NOT_FOUND_MESSAGE = 'yml key not found'
+
+    attr_accessor :load_path, :query_path
+
+    def initialize(load_path: DEFAULT_LOAD_PATH, query_path:)
+      self.load_path = load_path
+      self.query_path = query_path
+    end
+
+    def result
+      definition = nil
+
+      files.each do |file_path|
+        document_hash = I18nDefScanner::YAML.load_file(file_path)
+        string_number = document_hash.dig(*query_keys)
+        definition = "#{file_path}:#{string_number}" if string_number
+      end
+
+      definition || NOT_FOUND_MESSAGE
+    end
+
+    private
+
+    def query_keys
+      @query_keys ||= query_path.split('.')
+    end
+
+    def files
+      Dir[load_path]
+    end
+  end
+end

data/lib/i18n_def_scanner/version.rb

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

data/lib/i18n_def_scanner/yaml.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module I18nDefScanner
+  module YAML
+    def self.load_file(filename)
+      File.open(filename, 'r:bom|utf-8') do |f|
+        load(f, filename: filename)
+      end
+    end
+
+    def self.load(yaml, filename: nil)
+      result = parse(yaml, filename: filename)
+      result = result.to_ruby if result
+      result
+    end
+
+    def self.parse(yaml, filename: nil)
+      parse_stream(yaml, filename: filename) do |node|
+        return node
+      end
+    end
+
+    def self.parse_stream(yaml, filename: nil, &block)
+      handler = YAML::Handlers::DocumentStream.new(&block)
+      parser = Psych::Parser.new(handler)
+      parser.parse(yaml, filename)
+    end
+
+    module Handlers
+      class DocumentStream < ::YAML::Handlers::DocumentStream
+        def start_document(version, tag_directives, implicit)
+          n = YAML::Nodes::Document.new(version, tag_directives, implicit)
+          push(n)
+        end
+      end
+    end
+
+    module Nodes
+      module ToRubyOverride
+        def to_ruby
+          YAML::Visitors::ToRuby.create.accept(self)
+        end
+      end
+
+      class Alias < ::YAML::Nodes::Alias
+        include ToRubyOverride
+      end
+
+      class Document < ::YAML::Nodes::Document
+        include ToRubyOverride
+      end
+
+      class Mapping < ::YAML::Nodes::Mapping
+        include ToRubyOverride
+      end
+
+      class Node < ::YAML::Nodes::Node
+        include ToRubyOverride
+      end
+
+      class Scalar < ::YAML::Nodes::Scalar
+        include ToRubyOverride
+      end
+
+      class Sequence < ::YAML::Nodes::Sequence
+        include ToRubyOverride
+      end
+    end
+
+    module Visitors
+      class ToRuby < ::YAML::Visitors::ToRuby
+        def self.create
+          class_loader = ::YAML::ClassLoader.new
+          scanner = ::YAML::ScalarScanner.new(class_loader)
+          YAML::Visitors::ToRuby.new(scanner, class_loader)
+        end
+
+        def visit_I18nDefScanner_YAML_Nodes_Scalar(obj)
+          visit_Psych_Nodes_Scalar(obj)
+        end
+
+        def visit_I18nDefScanner_YAML_Nodes_Sequence(obj)
+          visit_Psych_Nodes_Sequence(obj)
+        end
+
+        def visit_I18nDefScanner_YAML_Nodes_Mapping(obj)
+          visit_Psych_Nodes_Mapping(obj)
+        end
+
+        def visit_I18nDefScanner_YAML_Nodes_Document(obj)
+          visit_Psych_Nodes_Document(obj)
+        end
+
+        def visit_I18nDefScanner_YAML_Nodes_Stream(obj)
+          visit_Psych_Nodes_Stream(obj)
+        end
+
+        def visit_I18nDefScanner_YAML_Nodes_Alias(obj)
+          visit_Psych_Nodes_Alias(obj)
+        end
+
+        def revive_hash(hash, obj)
+          obj.children.each_slice(2) do |key_node, value_node|
+            key = accept(key_node)
+            val = accept(value_node)
+            val = key_node.start_line + 1 unless val.is_a?(Hash)
+            hash[key] = val
+          end
+
+          hash
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: i18n_def_scanner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GeorgeGorbanev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-04 00:00:00.000000000 Z
+dependencies:
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.40.0
+description: CLI tool accepts yaml key as argument and returns file path withline
+  number where translation defined.
+email:
+- georgegorbanev@gmail.com
+executables:
+- i18n_def_scanner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/i18n_def_scanner
+- i18n_def_scanner.gemspec
+- lib/i18n_def_scanner.rb
+- lib/i18n_def_scanner/cli_arguments.rb
+- lib/i18n_def_scanner/help.rb
+- lib/i18n_def_scanner/scanning.rb
+- lib/i18n_def_scanner/version.rb
+- lib/i18n_def_scanner/yaml.rb
+homepage: https://github.com/GeorgeGorbanev/i18n_def_scanner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/GeorgeGorbanev/i18n_def_scanner
+  source_code_uri: https://github.com/GeorgeGorbanev/i18n_def_scanner
+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: CLI tool to find where i18n translations defined.
+test_files: []