yamlook 0.1.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 721149ad77c2d1122094c2861ebf1f4d0238dfe475c7849751468f804f94b5c9
-  data.tar.gz: 5a9bfa6256d28b43c02f2b40ae3a700e3b085c289c7d74a857e3e7d070feb191
+  metadata.gz: df1211ccca0c68e598391b78bd6328f09a1f67eb0948a926c5263bfa7206934a
+  data.tar.gz: 496953bbe6969dc05ff4165b2ab4ac8a76eb9df68be265b126c2b6eacb7061f8
 SHA512:
-  metadata.gz: 031f66fa62e1ddd557f663b085309576c8ebb62cfc671b3d979696b0e8df753598ead9e069ab322ef7631f5f35b3d14749776aa6757fb32079a4378e920b2c5d
-  data.tar.gz: 110c6cd592fcb0594a5efbd5cb8243bd49b1d6ac1fbedd6e1dd7f8422e7bd8da804a22b9bbbbb905b291e73459a98090822adc65d5c942b7fa3a278a51b8faf8
+  metadata.gz: bdf2d00d030814fc65940d1ad4d3bed49dbad70a022945d8b2534f303316646a289670d1e99cf40a8f993870f96cfbd35f942c2b9cb105acccdd6c522272302c
+  data.tar.gz: 7c68b6c0b71d2975014197ad68cde9f3e503213d5124ed993df1743530650e15e41ff450fd8b02d981ffde3a168fc567b31daf097823b786e7490fcd9596d06a

data/README.md

@@ -1,5 +1,16 @@
 # Yamlook
 
+Yamlook searches for dot-notated yaml keys occurrences in yaml files. It might be handy if you have localization
+or deep configs and you don't know where one or another value comes from.
+
+For instance you have such code:
+```
+<%= link_to t("admin.marketing.reports.some_report.title"), some_report_path(format: "csv") %>
+```
+Run `yamlook admin.marketing.reports.some_report.title` in terminal and it will show up all occurrences of that value
+in your internationalization yaml files. If you have all the internationalization in one yaml file, you will likely
+have to specify some root key as well, e.g. `yamlook en.admin.marketing.reports.some_report.title`.
+
 ## Installation
 
 ```
@@ -8,10 +19,16 @@ $ gem install yamlook
 
 ## Usage
 
+Run yamlook in terminal with dot-notated yaml keys as argument:
 ```
 $ yamlook some.deep.key.in.you.yaml.file
 ```
 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sl4vr/yamlook.
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/yamlook

@@ -5,4 +5,6 @@ $LOAD_PATH.unshift("#{__dir__}/../lib")
 
 require 'yamlook'
 
-Yamlook::Search.perform(ARGV[0].split('.'))
+cli_parser = Yamlook::Cli.new(ARGV)
+
+Yamlook::Search.perform(cli_parser.argument.split('.'))

data/lib/yamlook.rb

@@ -4,5 +4,7 @@ require 'psych'
 
 require 'yamlook/node'
 require 'yamlook/node_list'
+require 'yamlook/locale'
 require 'yamlook/file'
 require 'yamlook/search'
+require 'yamlook/cli'

data/lib/yamlook/cli.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'yamlook/version'
+
+module Yamlook
+  # Yamlook CLI
+  class Cli
+    attr_reader :arguments, :options
+
+    def initialize(arguments)
+      @arguments = arguments
+      @options = {}
+
+      opt_parser.parse!(@arguments)
+
+      show_help! if @arguments.empty?
+    rescue OptionParser::InvalidOption => e
+      puts e
+      exit 1
+    end
+
+    def argument
+      @arguments.first
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def opt_parser
+      @opt_parser ||= OptionParser.new do |opts|
+        opts.banner = 'Usage: yamlook KEYS'
+        opts.separator ''
+        opts.separator 'Example: yamlook some.deep.key.in.you.yaml.file'
+
+        opts.separator ''
+        opts.separator 'Options:'
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts.help
+          exit
+        end
+
+        opts.on_tail('--version', 'Show version') do
+          puts Yamlook::VERSION
+          exit
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def show_help!
+      puts opt_parser.help
+      exit
+    end
+  end
+end

data/lib/yamlook/file.rb

@@ -12,9 +12,11 @@ module Yamlook
     def search(keys)
       return unless yaml
 
-      findings = root_node_list.search(keys).flatten.compact.map do |finding|
-        finding.filename = filename
-        finding
+      findings = Locale.key_combinations(keys).flat_map do |key_combination|
+        root_node_list.search(key_combination).flatten.compact.map do |finding|
+          finding.filename = filename
+          finding
+        end
       end
 
       findings if findings.any?
@@ -33,11 +35,7 @@ module Yamlook
     end
 
     def root_node_list
-      NodeList.new(root_mapping.children)
-    end
-
-    def root_mapping
-      yaml.children.first
+      NodeList.new(yaml.root.children)
     end
   end
 end

data/lib/yamlook/locale.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Yamlook
+  # Possible locale keys handling
+  module Locale
+    LOCALES_FILEPATH = File.join(File.expand_path('../..', __dir__), 'locales.yaml')
+    LOCALES = Psych.load_file(LOCALES_FILEPATH)['locales'].freeze
+
+    module_function
+
+    def key_combinations(keys)
+      localized_keys = LOCALES.map { |locale| [locale, *keys] }
+
+      [keys, *localized_keys]
+    end
+  end
+end

data/lib/yamlook/node_list.rb

@@ -17,6 +17,8 @@ module Yamlook
     end
 
     def search(keys)
+      return [] unless nodes
+
       keys.each_index.map do |index|
         key = keys[0..index].join('.')
         rest_keys = keys[index + 1..-1]

data/lib/yamlook/search.rb

@@ -4,12 +4,16 @@ module Yamlook
   # Searches for occurrences of dot-notated keys in all yaml files
   # of current directory
   module Search
+    NoArgumentsError = Class.new(ArgumentError)
+
     EXTENSIONS = %w[yml yaml].freeze
     PATTERN = EXTENSIONS.map { |ext| ::File.join('**', "*.#{ext}") }.freeze
 
     module_function
 
     def perform(keys)
+      raise NoArgumentsError, 'Nothing to seach for.' if keys.empty?
+
       findings = Dir.glob(PATTERN).map do |filename|
         result = File.new(filename).search(keys)
         print_progress(result)
@@ -17,6 +21,8 @@ module Yamlook
       end
 
       print_result(findings.compact)
+    rescue NoArgumentsError => e
+      puts e.message
     end
 
     def print_progress(result)

data/lib/yamlook/version.rb

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

data/locales.yaml

@@ -0,0 +1,176 @@
+locales:
+- af
+- sq
+- am
+- ar
+- ar-dz
+- ar-bh
+- ar-eg
+- ar-iq
+- ar-jo
+- ar-kw
+- ar-lb
+- ar-ly
+- ar-ma
+- ar-om
+- ar-qa
+- ar-sa
+- ar-sy
+- ar-tn
+- ar-ae
+- ar-ye
+- hy
+- as
+- az
+- az-az
+- eu
+- be
+- bn
+- bs
+- bg
+- my
+- ca
+- zh
+- zh-cn
+- zh-hk
+- zh-mo
+- zh-sg
+- zh-tw
+- hr
+- cs
+- da
+- dv
+- nl
+- nl-be
+- nl-nl
+- en
+- en-au
+- en-bz
+- en-ca
+- en-cb
+- en-gb
+- en-in
+- en-ie
+- en-jm
+- en-nz
+- en-ph
+- en-za
+- en-tt
+- en-us
+- et
+- mk
+- fo
+- fa
+- fi
+- fr
+- fr-be
+- fr-ca
+- fr-fr
+- fr-lu
+- fr-ch
+- gd
+- gd-ie
+- gl
+- ka
+- de
+- de-at
+- de-de
+- de-li
+- de-lu
+- de-ch
+- el
+- gn
+- gu
+- he
+- hi
+- hu
+- is
+- id
+- it
+- it-it
+- it-ch
+- ja
+- kn
+- ks
+- kk
+- km
+- ko
+- lo
+- la
+- lv
+- lt
+- ms
+- ms-bn
+- ms-my
+- ml
+- mt
+- mi
+- mr
+- mn
+- ne
+- nb
+- no-no
+- nn
+- or
+- pl
+- pt
+- pt-br
+- pt-pt
+- pa
+- rm
+- ro
+- ro-mo
+- ru
+- ru-mo
+- sa
+- sr
+- sr-sp
+- tn
+- sd
+- si
+- sk
+- sl
+- so
+- sb
+- es
+- es-ar
+- es-bo
+- es-cl
+- es-co
+- es-cr
+- es-do
+- es-ec
+- es-sv
+- es-gt
+- es-hn
+- es-mx
+- es-ni
+- es-pa
+- es-py
+- es-pe
+- es-pr
+- es-es
+- es-uy
+- es-ve
+- sw
+- sv
+- sv-fi
+- sv-se
+- tg
+- ta
+- tt
+- te
+- th
+- bo
+- ts
+- tr
+- tk
+- uk
+- ur
+- uz
+- uz-uz
+- vi
+- cy
+- xh
+- yi
+- zu

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yamlook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Viacheslav Mefodin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2021-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -72,11 +72,14 @@ files:
 - README.md
 - bin/yamlook
 - lib/yamlook.rb
+- lib/yamlook/cli.rb
 - lib/yamlook/file.rb
+- lib/yamlook/locale.rb
 - lib/yamlook/node.rb
 - lib/yamlook/node_list.rb
 - lib/yamlook/search.rb
 - lib/yamlook/version.rb
+- locales.yaml
 homepage: https://github.com/sl4vr/yamlook
 licenses:
 - MIT
@@ -96,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Search occurrences of dot-notated yaml keys.