yamlook 0.1.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d60c103a1ccc580ea4ef6e0d3e2f5f053caae8a43cf43938faa120b953a5c6
-  data.tar.gz: 7056f0a884fd99fc881360bd6c2945554699995546e2de3e81c73187613d4994
+  metadata.gz: 4ff790519841c559a55d2502b075037d0c6f8e9c7b204ddccc24a7940bd9c64c
+  data.tar.gz: c3de76314369e83a5bce053c194108987fbe3cb09884325552b3cdfcecec932a
 SHA512:
-  metadata.gz: 1589f85031a782dc1e269d857f77f4b2ef686fb34823334cc0bf0a722bfc48545b69f8b121822e20855948bfd34180394743c691286bc63574ef47f9ff6bafdb
-  data.tar.gz: 76fedaacd5a13e16ef5d1feab2604c91b275047873e80e303242c9444cced2b04e2a51e3c77d3ddd9e1f8af8dac8b774122d0aecdd2e084edbd0aeb804026a9b
+  metadata.gz: c92be1c326364a5e48bfe927738e6fab7c1ebc7b1621f7a29388eb9addf9b8de75fe55c5a234f9a280d61b640f66890ffd11784d67ab6c00e20b4d38b82d266c
+  data.tar.gz: b7efd21a23b6bee5624b07a7eb4ca69c6f3096e8f5b0c626f8a962c6be81b48cc6910a105d4e956b58aa102e2618bae58f54e66a719d6fac0fae8562eacc6678

data/README.md

@@ -5,7 +5,7 @@ or deep configs and you don't know where one or another value comes from.
 
 For instance you have such code:
 ```
-t("admin.marketing.reports.some_report.title"), some_report_path(format: "csv")
+<%= 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
@@ -26,7 +26,7 @@ $ yamlook some.deep.key.in.you.yaml.file
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[sl4vr]/yamlook.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sl4vr/yamlook.
 
 
 ## License

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(Yamlook::SEPARATOR))

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

@@ -10,34 +10,17 @@ module Yamlook
     end
 
     def search(keys)
-      return unless yaml
+      file = ::File.read(filename)
+      handler = Handler.new(keys: keys, locales: LOCALES)
+      parser = ::Psych::Parser.new(handler)
 
-      findings = root_node_list.search(keys).flatten.compact.map do |finding|
-        finding.filename = filename
-        finding
+      findings = parser.parse(file).handler.found.map do |value, line, column|
+        "#{filename}:#{line}:#{column}\n#{value}"
       end
 
       findings if findings.any?
-    end
-
-    def yaml
-      @yaml ||= parse_file(filename)
-    end
-
-    private
-
-    def parse_file(filename)
-      ::Psych.parse_file(filename)
     rescue ::Psych::Exception
       nil
     end
-
-    def root_node_list
-      NodeList.new(root_mapping.children)
-    end
-
-    def root_mapping
-      yaml.children.first
-    end
   end
 end

data/lib/yamlook/handler.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module Yamlook
+  # Handler for Psych::Parser
+  class Handler < ::Psych::Handler
+    attr_reader :found
+
+    def initialize(keys:, locales: [])
+      super()
+      @keys = keys
+      @locales = locales
+      @found = []
+
+      @iterations = []
+      @current_iteration = Iteration.new(active: true)
+    end
+
+    def event_location(start_line, start_column, _end_line, _end_column)
+      @start_line = start_line
+      @start_column = start_column
+    end
+
+    def start_mapping(_anchor, _tag, _implicit, _style)
+      @iterations.push(@current_iteration.dup)
+      @current_iteration.reset!
+    end
+
+    def end_mapping
+      @iterations.pop
+      @current_iteration.reset!
+    end
+
+    def scalar(value, _anchor, _tag, _plain, _quoted, _style) # rubocop:disable Metrics/ParameterLists
+      @found << [value, @start_line.next, @start_column.next] if keys_out? && all_active?
+
+      refresh_current_interation!(value)
+    end
+
+    def refresh_current_interation!(value)
+      value_keys = value.split(SEPARATOR)
+
+      value_keys.shift if current_offset.zero? && LOCALES.include?(value_keys.first)
+
+      @current_iteration.offset = value_keys.count
+      @current_iteration.active = current_keys == value_keys
+    end
+
+    def current_offset
+      @iterations.sum(&:offset)
+    end
+
+    def current_keys
+      @keys.drop(current_offset).take(@current_iteration.offset)
+    end
+
+    def keys_out?
+      current_offset + @current_iteration.offset == @keys.size
+    end
+
+    def all_active?
+      @iterations.any? && @iterations.all?(&:active) && @current_iteration.active
+    end
+  end
+end

data/lib/yamlook/iteration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Yamlook
+  # Holds information for iteration over Psych::Handler iterating through mappings
+  class Iteration
+    attr_accessor :active, :offset
+
+    def initialize(active: false, offset: 0)
+      @active = active
+      @offset = offset
+    end
+
+    def reset!
+      @active = false
+      @offset = 0
+    end
+  end
+end

data/lib/yamlook/search.rb

@@ -4,19 +4,25 @@ 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)
-      findings = Dir.glob(PATTERN).map do |filename|
+      raise NoArgumentsError, "Nothing to search for.\n" if keys.empty?
+
+      findings = Dir.glob(PATTERN).flat_map do |filename|
         result = File.new(filename).search(keys)
         print_progress(result)
         result
       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.1'
+  VERSION = '0.4.1'
 end

data/lib/yamlook.rb

@@ -2,7 +2,14 @@
 
 require 'psych'
 
-require 'yamlook/node'
-require 'yamlook/node_list'
+require 'yamlook/iteration'
+require 'yamlook/handler'
 require 'yamlook/file'
 require 'yamlook/search'
+require 'yamlook/cli'
+
+module Yamlook
+  SEPARATOR = '.'
+  LOCALES_FILEPATH = ::File.join(::File.expand_path('..', __dir__), 'locales.yaml')
+  LOCALES = Psych.load_file(LOCALES_FILEPATH)['locales'].freeze
+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.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Viacheslav Mefodin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -72,11 +72,13 @@ files:
 - README.md
 - bin/yamlook
 - lib/yamlook.rb
+- lib/yamlook/cli.rb
 - lib/yamlook/file.rb
-- lib/yamlook/node.rb
-- lib/yamlook/node_list.rb
+- lib/yamlook/handler.rb
+- lib/yamlook/iteration.rb
 - lib/yamlook/search.rb
 - lib/yamlook/version.rb
+- locales.yaml
 homepage: https://github.com/sl4vr/yamlook
 licenses:
 - MIT
@@ -96,7 +98,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.

data/lib/yamlook/node.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Yamlook
-  # Result of search - scalar node
-  class Node
-    attr_reader :value, :line, :column
-    attr_accessor :filename
-
-    def self.from_scalar(scalar)
-      return unless scalar
-
-      new(
-        value: scalar.value,
-        line: scalar.start_line + 1,
-        column: scalar.start_column + 1
-      )
-    end
-
-    def initialize(value:, line:, column:, filename: nil)
-      @value = value
-      @line = line
-      @column = column
-      @filename = filename
-    end
-
-    def to_s
-      "#{filename}:#{line}:#{column}\n#{value}"
-    end
-  end
-end

data/lib/yamlook/node_list.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Yamlook
-  Mapping = ::Psych::Nodes::Mapping
-  Scalar = ::Psych::Nodes::Scalar
-
-  # List of yaml nodes
-  class NodeList
-    attr_reader :nodes
-
-    def self.from_mapping(mapping)
-      new(mapping.children)
-    end
-
-    def initialize(nodes)
-      @nodes = nodes
-    end
-
-    def search(keys)
-      keys.each_index.map do |index|
-        key = keys[0..index].join('.')
-        rest_keys = keys[index + 1..-1]
-        result = find(key)
-
-        case result
-        when Mapping then NodeList.from_mapping(result).search(rest_keys)
-        when Scalar then Node.from_scalar(result) if rest_keys.empty?
-        end
-      end
-    end
-
-    private
-
-    def find(key)
-      key_node_index = find_key_node_index(key)
-      nodes[key_node_index + 1] if key_node_index
-    end
-
-    def find_key_node_index(key)
-      nodes.find_index { |node| node.is_a?(Scalar) && node.value == key }
-    end
-  end
-end