findyml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24167ff7d45f6430782e0a071dde14d82c123152a4fc80015de958636a09af66
+  data.tar.gz: cbd75aa4977eda3ee732361e41af67383cfe34dda933390e2dce3d4ebd44a92d
+SHA512:
+  metadata.gz: 80fc4923eafba7bce45ace925a9c3f1becd25cbe1da00b7c219a1f90fb50074eb93642a7b260b18c7eb7c803058d8026b4b552ec196de8b68c6bd32a028fbe1d
+  data.tar.gz: 95c2d6dedf85c7313f5f9e7871740f83b1265e763eb2bc494c66231bf37dca5ce10935ab2e0dc4e08cb65bb2f6da6a8e7774c8568289dfd54e23b94f289e19be

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Danielle Smith
+
+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,63 @@
+# Findyml
+
+Search for yaml keys across multiple files
+
+Ever wondered where that i18n locale was defined but your project is massive and legacy and has multiple competing inconsistent standards of organisation? Let findyml ease your pain by finding that key for you!
+
+## Installation
+
+```sh
+gem install findyml
+```
+
+## Usage
+
+```sh
+findyml [path] query
+```
+
+Outputs all matching keys across all `*.yml` files in the given directory, including line and column number.
+
+(Defaults to current directory if you don't specify a path)
+
+Example:
+
+```sh
+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.
+
+```sh
+findyml .activerecord.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 🙃.
+
+## 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
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/danini-the-panini/findyml.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/exe/findyml

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "findyml"
+
+dir, query = case ARGV.size
+when 1
+  [Dir.pwd, ARGV.last]
+when 2
+  ARGV
+else
+  puts "Usage: #{$0} [path] query"
+  exit(1)
+end
+
+Findyml.find_and_print(query, dir)

data/lib/findyml/version.rb

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

data/lib/findyml.rb

@@ -0,0 +1,263 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+require_relative "findyml/version"
+
+module Findyml
+  class Error < StandardError; end
+
+  Key = Struct.new(:file, :node, :path, :terminal, :alias_path) do
+    def terminal? = terminal
+
+    def line
+      node.start_line + 1
+    end
+
+    def col
+      node.start_column + 1
+    end
+
+    def inspect
+      "#{path.map(&:inspect).join('.')} -> #{self}"
+    end
+  end
+
+  class KeyNode
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+    end
+
+    def ==(other)
+      other.is_a?(KeyNode) &&
+        node.class == other.node.class &&
+        to_s == other.to_s
+    end
+    alias :eql? :==
+
+    def hash
+      [node.class, to_s].hash
+    end
+
+    def line
+      node.start_line + 1
+    end
+
+    def to_s
+      @to_s ||= case node
+      when Psych::Nodes::Scalar
+        node.value
+      when Psych::Nodes::Mapping
+        "{#{node.children.each_slice(2).map { |k, v| "#{KeyNode.new(k).to_s}:#{KeyNode.new(v).to_s}" }.join(',')}}"
+      when Psych::Nodes::Sequence
+        "[#{node.children.map { KeyNode.new(_1).to_s }.join(',')}]"
+      end
+    end
+
+    def inspect
+      "#<Findyml::KeyNode @node=#{self}>"
+    end
+  end
+
+  class IndexNode < KeyNode
+    def initialize(node, index)
+      super(node)
+      @index = index
+    end
+
+    def to_s
+      @index.to_s
+    end
+  end
+
+  class FileExtractor
+    def self.call(file, &block)
+      new(file).extract(&block)
+    end
+
+    def initialize(file)
+      @file = File.expand_path(file)
+      @yaml = YAML.parse_file(@file)
+      @anchors = {}
+    end
+
+    def extract(&block)
+      all_nodes = @yaml.children.map { construct_nodes(_1) }
+
+      all_nodes.each do |nodes, _|
+        extract_nodes(nodes, &block)
+      end
+    end
+
+    def extract_nodes(nodes, path=[], alias_path=[], &block)
+      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)
+        extract_nodes(children, new_path, new_alias_path, &block) if children
+      end
+    end
+
+    def construct_nodes(current_node=yaml)
+      nodes = case current_node
+      when Psych::Nodes::Document
+        return construct_nodes(current_node.children.first)
+      when Psych::Nodes::Mapping
+        current_node
+          .children
+          .each_slice(2)
+          .each_with_object({}) { |(key, node), h|
+            if key.is_a?(Psych::Nodes::Scalar) && key.value == '<<'
+              h.merge!(construct_nodes(node).first)
+            else
+              key_node = KeyNode.new(key)
+              h.delete(key_node)
+              h[key_node] = construct_nodes(node)
+            end
+          }
+      when Psych::Nodes::Sequence
+        current_node
+          .children
+          .each_with_index
+          .map { |node, index| [IndexNode.new(node, index), construct_nodes(node)] }
+      when Psych::Nodes::Scalar
+        nil
+      when Psych::Nodes::Alias
+        a_nodes, anchor = @anchors[current_node.anchor]
+        return [a_nodes.transform_values { |(a, b, c)| [a, b, [*c, current_node]] }, anchor]
+      end
+
+      case current_node
+      when Psych::Nodes::Mapping, Psych::Nodes::Sequence, Psych::Nodes::Scalar
+        @anchors[current_node.anchor] = [nodes, current_node, []] if current_node.anchor
+      end
+
+      [nodes, current_node, []]
+    end
+
+    def to_s
+      "FileExtractor(#{@file})"
+    end
+
+    def inspect
+      "#<Findyml::FileExtractor @file=#{@file.inspect}>"
+    end
+  end
+
+  def self.find(query_string, dir = Dir.pwd)
+    return to_enum(:find, query_string, dir) 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|
+        yield key if key_match?(key.path, query)
+      end
+    rescue YAML::SyntaxError
+      # just skip files we can't parse
+      # TODO: silence warnings?
+      warn "Skipping #{file} due to parse error"
+    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('')}"
+    end
+  end
+
+  def self.parse_key(key)
+    pre  = []
+    post = []
+    if key =~ /\A\./ # start with a dot
+      key = $' # everything after the dot
+      pre << :splat
+    end
+    if key =~ /\.\z/ # end with a dot
+      key = $` # everything before the dot
+      post << :splat
+    end
+    [*pre, *parse_key_parts(key), *post]
+  end
+
+  def self.parse_key_parts(key)
+    invalid_key! if key.empty?
+
+    case key
+    # starts with quote
+    when /\A['"]/
+       # invalid unless rest has matching quote
+      invalid_key! unless $' =~ /#{$&}/
+
+      # everything before the next matching quote (i.e. contents of quotes)
+      quoted_key = $`
+
+      case $'
+      # quote was at end of string
+      when ''     then [quoted_key]
+
+      # dot follows quote, parse everything after the dot
+      when /\A\./ then [quoted_key, *parse_key_parts($')]
+
+      # anything else after the quote is not allowed
+      else invalid_key!
+      end
+
+    # includes a dot
+    when /\./
+      # invalid unless something before the dot
+      invalid_key! if $`.empty?
+
+      k = $` == '*' ? :splat : $`
+
+      # parse everything after the dot
+      [k, *parse_key_parts($')]
+
+    # splat at the end of the string
+    when '*' then [:splat]
+
+    # single key query
+    else [key]
+    end
+  end
+
+  def self.invalid_key!
+    raise Error, "invalid key"
+  end
+
+  def self.key_match?(path, query)
+    path == query unless query.include? :splat
+
+    query_parts = query.slice_before(:splat)
+
+    query_parts.each do |q|
+      case q
+      in [:splat]
+        return false if path.empty?
+        path = []
+      in [:splat, *partial]
+        return false if path.empty?
+        rest = munch(path[1..], partial)
+        return false unless rest
+        path = rest
+      else
+        return false unless path[0...q.size] == q
+        path = path.drop(q.size)
+      end
+    end
+
+    path.empty?
+  end
+
+  def self.munch(arr, part)
+    raise ArgumentError, "part must not be empty" if part.empty?
+    return if arr.empty?
+    return if arr.size < part.size
+    return arr[part.size..] if arr[0...part.size] == part
+
+    munch(arr[1..], part)
+  end
+end

data/sig/findyml.rbs

@@ -0,0 +1,4 @@
+module Findyml
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: findyml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danielle Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-09-21 00:00:00.000000000 Z
+dependencies: []
+description: Even wondered where that i18n locale was defined but your project is
+  massive and legacy and has multiple competing inconsistent standards of organisation?
+  Let findyml ease your pain by finding that key for you!
+email:
+- code@danini.dev
+executables:
+- findyml
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/findyml
+- lib/findyml.rb
+- lib/findyml/version.rb
+- sig/findyml.rbs
+homepage: https://github.com/danini-the-panini/findyml
+licenses:
+- MIT
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.17
+signing_key: 
+specification_version: 4
+summary: Search for yaml keys across multiple files
+test_files: []