findyml 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cf98578abdfc460a7dd2983b91aa5d8121de3f43846033112ab7da4151f3d3
-  data.tar.gz: 367437456f64b85060592b5deab077375ad39b7915d4e99cdf0e9d7f61692a8c
+  metadata.gz: f4d5da18159d29c04d47739dd1c4761bcbe6b6cc0586bc6b46af1e2b08ab2b0f
+  data.tar.gz: 3133810f4ca036c7b5f8108eba68c11906e30864c732bcb37f2313363ca1d680
 SHA512:
-  metadata.gz: c4d8d89095e22b5c066f291b45884b9990fe025edf8a41699b266837026f773d06c8de64ed823c244b8afe64ca37439daac5b4eb6741ae1f9b07c8794600cb86
-  data.tar.gz: 2926cd54e783a5bb7d978da7dfc08f878d497998e3d1fd6ad9acad5f1c33434c102f90a6d7062652bc3b1457f24938a3160e7580fb5ca9e76bb3043cd1733632
+  metadata.gz: ace304e0a1e1bc8c0d137a7633b7e47f5facdf2d53cf83e4ed6a55b9de6baa938c138ba816e9c384b070e4ea509a9cf04acb2a735c931d1a250136fa0da948b7
+  data.tar.gz: 337a9138a8f38d7bb33cb36e6813fe39d5c1fae6dec3907f717760766fb9cc7952f3a9e6b3bd71a35c89232467aa665ed3b18576be8eae2b498fd915c7952ae1

data/README.md

@@ -27,23 +27,20 @@ findyml config/locales en.activerecord.attributes
 # config/locales/active_record.en.yml:3:6
 ```
 
-You can also do partial matches, by starting/ending with a dot or putting an asterisk (`*`) in place of a key.
+You can also do partial matches, by starting/ending with a dot or putting a double-dot `..` in the middle.
 
 ```sh
 findyml .activerecord.attributes
-findyml 'en.*.attributes'
+findyml en..attributes
 ```
 
-(You have to quote the query if you use `*` because your shell might thing it is a dir glob)
-
-**NOTE**: if you end with a dot, or the last key is an asterisk, it will return _every single sub key_. i.e. careful if you try `findyml en.` or `findyml en.*`, you will get every line of every locale file 🙃.
+**NOTE**: if you end with a dot, it will return _every single sub key_. i.e. careful if you try `findyml en.`, you will get every line of every english locale file 🙃.
 
 ## TODO
 
 - Allow optional keys in query: `foo.[bar,baz].qux` (`qux` key in either `bar` or `baz` parent key)
 - Allow negated keys in query: `foo.!bar.baz` (`baz` with any parent but `bar`)
 - Partial key matches: `foo.bar_*` (any key starting with `bar_`)
-- Allow `*` and `**` like directory globbing.
 - Fuzzy matching?
 - Find and fix bugs
 - Optimisation, caching

data/exe/findyml

@@ -3,7 +3,34 @@
 
 $0 = "findyml"
 
+require "optparse"
 require "findyml"
 
-dir, query = Findyml.parse_options
-Findyml.find_and_print(query, dir)
+options = { path: Dir.pwd }
+option_parser = OptionParser.new do |parser|
+  parser.banner = "Usage: #{$0} [-ar] [-p path] query"
+
+  parser.on("-a", "--[no-]aliases", "Show aliases") do |v|
+    options[:show_aliases] = v
+  end
+
+  parser.on("-r", "--[no-]relative", "Print relative paths") do |v|
+    options[:print_relative_paths] = v
+  end
+
+  parser.on("-p PATH", "--path=PATH", "Path to search from (default PWD)") do |v|
+    options[:path] = v
+  end
+
+  parser.on("-h", "--help", "Prints this help") do
+    puts parser
+    exit
+  end
+end.parse!
+
+if ARGV.length != 1
+  puts option_parser
+  exit(1)
+end
+
+Findyml.find_and_print(ARGV.first, options.delete(:path), **options)

data/lib/findyml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Findyml
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/findyml.rb

@@ -21,6 +21,10 @@ module Findyml
     def inspect
       "#{path.map(&:inspect).join('.')} -> #{self}"
     end
+
+    def location
+      [file, line, col].join(':')
+    end
   end
 
   class KeyNode
@@ -73,14 +77,23 @@ module Findyml
   end
 
   class FileExtractor
-    def self.call(file, &block)
-      new(file).extract(&block)
+    def self.call(file, **kwargs, &block)
+      new(file, **kwargs).extract(&block)
     end
 
-    def initialize(file)
+    def initialize(file, dedup: false)
       @file = File.expand_path(file)
       @yaml = YAML.parse_file(@file)
       @anchors = {}
+      @dups = {} if dedup
+    end
+
+    def dedup?
+      !!@dups
+    end
+
+    def yielded?(key)
+      @dups[[key.line, key.col]]
     end
 
     def extract(&block)
@@ -97,7 +110,11 @@ module Findyml
       nodes.each do |key_node, (children, yaml_node, alias_node)|
         new_path = [*path, key_node.to_s]
         new_alias_path = [*alias_path, *alias_node]
-        yield Key.new(@file, key_node.node, new_path, children.nil?, new_alias_path)
+        key = Key.new(@file, key_node.node, new_path, children.nil?, @dups ? [] : new_alias_path)
+        if !dedup? || !yielded?(key)
+          @dups[[key.line, key.col]] = true if dedup?
+          yield key
+        end
         extract_nodes(children, new_path, new_alias_path, &block) if children
       end
     end
@@ -148,26 +165,14 @@ module Findyml
     end
   end
 
-  def self.parse_options
-    case ARGV.size
-    when 1
-      [Dir.pwd, ARGV.last]
-    when 2
-      ARGV
-    else
-      puts "Usage: #{$0} [path] query"
-      exit(1)
-    end
-  end
-
-  def self.find(query_string, dir = Dir.pwd)
-    return to_enum(:find, query_string, dir) unless block_given?
+  def self.find(query_string, dir = Dir.pwd, dedup: false)
+    return to_enum(:find, query_string, dir, dedup:) unless block_given?
 
     # TODO: cache fast key lookup in a temporary sqlite db?
     query = parse_key(query_string)
     files = Dir.glob(File.join(dir, '**', '*.yml'))
     files.each do |file|
-      FileExtractor.call(file) do |key|
+      FileExtractor.call(file, dedup:) do |key|
         yield key if key_match?(key.path, query)
       end
     rescue YAML::SyntaxError
@@ -177,9 +182,18 @@ module Findyml
     end
   end
 
-  def self.find_and_print(*args)
-    find(*args) do |key|
-      puts "#{key.file}:#{key.line}:#{key.col}#{key.alias_path.map{"(#{_1.start_line+1})"}.join('')}"
+  def self.find_and_print(*args, print_relative_paths: false, show_aliases: false)
+    find(*args, dedup: !show_aliases) do |key|
+      file = key.file
+      if print_relative_paths
+        file = Pathname.new(file).relative_path_from(Dir.pwd).to_s
+      end
+      output = [file, key.line, key.col].join(':')
+      if show_aliases
+        output = [output, *key.alias_path.map { _1.start_line + 1 }].join(' <- ')
+      end
+      puts output
+      # puts "#{key.file}:#{key.line}:#{key.col}#{key.alias_path.map{"(#{_1.start_line+1})"}.join('')}"
     end
   end
 
@@ -222,16 +236,10 @@ module Findyml
 
     # includes a dot
     when /\./
-      # invalid unless something before the dot
-      invalid_key! if $`.empty?
-
-      k = $` == '*' ? :splat : $`
+      pre = $`.empty? ? :splat : $`
 
       # parse everything after the dot
-      [k, *parse_key_parts($')]
-
-    # splat at the end of the string
-    when '*' then [:splat]
+      [pre, *parse_key_parts($')]
 
     # single key query
     else [key]

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: findyml
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Danielle Smith
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Ever wondered where that i18n locale was defined but your project is
   massive and legacy and has multiple competing inconsistent standards of organisation?
@@ -34,7 +33,6 @@ metadata:
   homepage_uri: https://github.com/danini-the-panini/findyml
   source_code_uri: https://github.com/danini-the-panini/findyml
   changelog_uri: https://github.com/danini-the-panini/findyml/releases
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Search for yaml keys across multiple files
 test_files: []