yayaml 0.1.0

data/en.yml

@@ -0,0 +1,22 @@
+en:
+  hello: "Hello world"
+  timeline:
+    events:
+      invoice:
+        payment_failed: "Invoice payment failed"
+      outstanding_invoices_paid: Outstanding invoices paid
+      source_added: Customer added default credit card
+      source_updated: Customer updated default credit card
+      subscription:
+        canceled: "Subscription canceled"
+        canceled_at_period_end: "Subscription set to cancel at the end of the current billing cycle"
+        subscription_schedule_released: "Subscription schedule released"
+        updated_through_creation: "Subscription was updated via immediate downgrade in Stripe"
+      testing:
+        event_for_test_without_interpolation: "testing"
+        event_for_test_with_interpolation: "testing %{test_var}"
+  errors:
+    business_address:
+      argument_error:
+        already_exists: "A business address is already associated with this account"
+        incorrect_zip_format: "should be in the format of 12345 or 12345-6789"

data/example.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require "psych"
+require "pry"
+
+# Handler for detecting scalar values
+class YayHandler < Psych::Handler
+  # States:
+  # a -> start_map -> b
+  # b -> scalar -> c (push key)
+  # b -> end_map -> b (pop key)
+  # c -> scalar -> b (push value, pop key)
+  # c -> start_map -> b (push map)
+  # c -> end_map -> b (pop key)
+
+  attr_accessor :parser
+
+  def initialize(*args)
+    @state = :a
+    @prev = nil
+    @keys = []
+  end
+
+  def start_mapping(*args)
+    @prev = @state
+    case @state
+    when :a
+      @state = :b
+    when :c
+      @state = :b
+    else
+      fail
+    end
+
+    transition("start map")
+  end
+
+  def end_mapping
+    @prev = @state
+    case @state
+    when :b, :c
+      @state = :b
+      @keys.pop
+    else
+      fail
+    end
+
+    transition("end map")
+  end
+
+   def scalar(value, *args)
+     @prev = @state
+     case @state
+     when :b
+       @state = :c
+       @keys << value
+     when :c
+       @state = :b
+       puts "#{@keys.join('.')}:#{parser.mark.line + 1}: #{value}"
+       @keys.pop
+     else
+       fail
+     end
+
+     transition("scalar")
+   end
+
+   def transition(event)
+     # puts "#@prev -> (#{event}) -> #@state"
+   end
+end
+
+# yaml = File.read("/Users/timuruski/en.yml")
+yaml = DATA
+handler = YayHandler.new
+parser = Psych::Parser.new(handler)
+handler.parser = parser
+parser.parse(yaml)
+
+__END__
+---
+en:
+  page1:
+    button: Hello
+  page2:
+    button: Goodbye
+fr:
+  page1:
+    button: Bonjour

data/example.yml

@@ -0,0 +1,17 @@
+---
+en:
+  page1:
+    button: Hello world!
+  page2:
+    button: Goodbye
+  page3:
+    shopping:
+      - eggs
+      - butter
+      - bacon
+    button: Go shopping
+es:
+  page1:
+    button: "¡Hola, el mundo!"
+  page2:
+    button: Adios

data/exe/ya

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+
+require "psych"
+require "optparse"
+
+at_exit do
+  Yay::Command.new.run
+end
+
+module Yay
+  BOLD_RED = "\e[1m\e[38;5;1m"
+  RESET = "\e[0m"
+
+  class Command
+    def initialize(args = ARGV)
+      parser = OptionParser.new do |parser|
+        parser.on("-d", "--debug") { $DEBUG = true }
+        parser.on("-i", "--ignore-case") { |value| @ignore_case = value }
+        parser.on("-p", "--search-path") { |value| @match_path = value }
+      end
+
+      parser.banner = "Usage yay [options] \"<search pattern>\" <inputs>"
+      if args.empty?
+        abort parser.help
+      else
+        parser.parse!
+      end
+
+      @search_pattern = args.shift
+      @paths = args.flat_map { |filename| File.directory?(filename) ? Dir.glob("#{filename}/**/*.yml") : filename }
+      @paths.delete("--")
+    end
+
+    # TODO: Use abort if all YAML paths fail to parse.
+    def run
+      if @paths.empty?
+        warn "Reading from STDIN..." if STDIN.tty?
+        parse_yaml(STDIN, "STDIN")
+      else
+        @paths.each do |path|
+          File.open(path) do |file|
+            parse_yaml(file, file.path)
+          end
+        end
+      end
+    end
+
+    private def parse_yaml(input, filename)
+      handler = YayHandler.new(@search_pattern, @match_path, @ignore_case, filename)
+      Psych::Parser.new(handler).parse(input)
+    rescue Psych::SyntaxError => e
+      warn "Failed to parse YAML #{e.file}:#{e.line}:#{e.offset}"
+    end
+  end
+
+  # See these for details:
+  # https://ruby-doc.org/3.2.2/exts/psych/Psych/Handler.html
+  # https://github.com/ruby/psych/blob/master/lib/psych/handler.rb
+  class YayHandler < Psych::Handler
+    # State transitions:
+    # branch -> start_map -> branch (no-op)
+    # leaf -> start_map -> branch (no-op)
+    # branch -> scalar -> leaf (push key)
+    # leaf -> scalar -> leaf (pop key, handle value)
+    # branch -> end_map -> branch (pop key)
+    # leaf -> end_map -> branch (pop key)
+
+    def initialize(search_pattern, match_path, ignore_case, filename, *args)
+      @search_pattern = Regexp.new(search_pattern, ignore_case ? Regexp::IGNORECASE : nil)
+      @ignore_case = ignore_case
+      @match_path = match_path
+      @filename = filename
+    end
+
+    def start_document(*args)
+      debug "--> Start document #{@filename}"
+
+      @state = :branch
+      @prev = nil
+      @keys = []
+      @line = 0
+      @col = 0
+    end
+
+    def start_mapping(*args)
+      transition("start map") do
+        case @state
+        when :branch, :leaf
+          @state = :branch
+        else
+          panic("start map")
+        end
+      end
+    end
+
+    def end_mapping
+      transition("end map") do
+        case @state
+        when :branch, :leaf
+          @state = :branch
+          @keys.pop
+        else
+          panic("end map")
+        end
+      end
+    end
+
+    def scalar(value, *args)
+      transition("scalar") do
+        case @state
+        when :branch
+          @state = :leaf
+          @keys.push(value)
+        when :leaf
+          @state = :branch
+          handle_leaf(value)
+          @keys.pop
+        else
+          panic("scalar")
+        end
+      end
+    end
+
+    def event_location(start_line, start_column, _end_line, _end_column)
+      @line = start_line + 1
+      @col = start_column + 1
+    end
+
+    private def handle_leaf(value)
+      path = @keys.join(".")
+
+      if @match_path
+        if match = path.match(@search_pattern)
+          if $stdout.tty?
+            path_matched = path.sub(@search_pattern, "#{BOLD_RED}#{match}#{RESET}")
+            puts "#{@filename}:#{@line} #{path_matched}: #{value}"
+          else
+            puts "#{@filename}:#{@line} #{path}: #{value}"
+          end
+        end
+      else
+        if match = value.match(@search_pattern)
+          if $stdout.tty?
+            value_matched = value.sub(@search_pattern, "#{BOLD_RED}#{match}#{RESET}")
+            puts "#{@filename}:#{@line} #{path}: #{value_matched}"
+          else
+            puts "#{@filename}:#{@line} #{path}: #{value}"
+          end
+        end
+      end
+    end
+
+    private def transition(event)
+      @prev = @state
+      yield
+      debug "#@prev -> (#{event}) -> #@state"
+    end
+
+    private def debug(msg)
+      warn msg if $DEBUG || ENV["DEBUG"]
+    end
+
+    private def panic(event)
+      fail "Failed to parse #{event} at #{@filename}:#{@line}:#{@col}, state #{@state}"
+    end
+  end
+end

data/lib/yayaml/handler.rb

@@ -0,0 +1,88 @@
+require "psych"
+
+module Yayaml
+  class Handler < Psych::Handler
+    # State transitions:
+    # branch -> start_map -> branch (no-op)
+    # leaf -> start_map -> branch (no-op)
+    # branch -> scalar -> leaf (push key)
+    # leaf -> scalar -> leaf (pop key, handle value)
+    # branch -> end_map -> branch (pop key)
+    # leaf -> end_map -> branch (pop key)
+
+    attr_reader :matcher, :filename
+
+    def initialize(matcher, filename: nil)
+      @matcher = matcher
+      @filename = filename
+    end
+
+    def start_document(*args)
+      debug "--> Start document #{filename}"
+
+      @state = :branch
+      @prev = nil
+      @keys = []
+      @line = 0
+      @col = 0
+    end
+
+    def start_mapping(*args)
+      transition("start map") do
+        case @state
+        when :branch, :leaf
+          @state = :branch
+        else
+          panic("start_mapping")
+        end
+      end
+    end
+
+    def end_mapping
+      transition("end map") do
+        case @state
+        when :branch, :leaf
+          @state = :branch
+          @keys.pop
+        else
+          panic("end_mapping")
+        end
+      end
+    end
+
+    def scalar(value, *args)
+      transition("scalar") do
+        case @state
+        when :branch
+          @state = :leaf
+          @keys.push(value)
+        when :leaf
+          @state = :branch
+          matcher.on_node(@keys.dup, value)
+          @keys.pop
+        else
+          panic("scalar")
+        end
+      end
+    end
+
+    def event_location(start_line, start_column, end_line, end_column)
+      @line = start_line + 1
+      @col = start_column + 1
+    end
+
+    private def transition(event)
+      @prev = @state
+      yield
+      # debug "#@prev -> (#{event}) -> #@state"
+    end
+
+    private def debug(msg)
+      warn msg if @debug
+    end
+
+    private def panic(event)
+      fail "Failed to parse #{event} at #{filename}:#{@line}:#{@col}"
+    end
+  end
+end

data/lib/yayaml/matcher.rb

@@ -0,0 +1,52 @@
+module Yayaml
+  class Matcher
+    BOLD_RED = "\e[1m\e[38;5;1m"
+    RESET = "\e[0m"
+
+    attr_reader :nodes
+
+    def initialize(pattern, match_path: false, ignore_case: false)
+      @pattern = Regexp.compile(pattern)
+      @match_path = match_path
+      @ignore_case = ignore_case
+
+      @nodes = []
+    end
+
+    def on_node(keys, value)
+      @nodes << [keys, value]
+
+      path = keys.join(".")
+
+      if @match_path
+        if (match = path.match(@pattern))
+          path_matched = path.sub(@pattern, "#{BOLD_RED}#{match}#{RESET}")
+          # puts "#{path_matched}:#{@line}: #{value}"
+          puts "#{@filename}:#{@line} #{path_matched}: #{value}"
+        end
+      else
+        if (match = value.match(@pattern))
+          value_matched = value.sub(@pattern, "#{BOLD_RED}#{match}#{RESET}")
+          # puts "#{path}:#{@line}: #{value_matched}"
+          puts "#{@filename}:#{@line} #{path}: #{value_matched}"
+        end
+      end
+    end
+
+    private def match_value(keys, value)
+      if (match = value.match(@pattern))
+        value_matched = value.sub(@pattern, "#{BOLD_RED}#{match}#{RESET}")
+        # puts "#{path}:#{@line}: #{value_matched}"
+        puts "#{@filename}:#{@line} #{path}: #{value_matched}"
+      end
+    end
+
+    private def match_path(keys, value)
+      if (match = path.match(@pattern))
+        path_matched = path.sub(@pattern, "#{BOLD_RED}#{match}#{RESET}")
+        # puts "#{path_matched}:#{@line}: #{value}"
+        puts "#{@filename}:#{@line} #{path_matched}: #{value}"
+      end
+    end
+  end
+end

data/lib/yayaml/version.rb

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

data/lib/yayaml.rb

@@ -0,0 +1,5 @@
+module Yayaml
+end
+
+require_relative "yayaml/handler"
+require_relative "yayaml/matcher"

data/sig/yay/rb.rbs

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

data/test.yml

@@ -0,0 +1,9 @@
+---
+en:
+  page1:
+    button: Hello world
+  page2:
+    button: Goodbye
+fr:
+  page1:
+    button: Bonjour

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: yayaml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Uruski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.5
+description: A tool for searching the structure of YAML like i18n files
+email:
+- tim@uruski.xyz
+executables:
+- ya
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- args.rb
+- discourse.yml
+- en.yml
+- example.rb
+- example.yml
+- exe/ya
+- lib/yayaml.rb
+- lib/yayaml/handler.rb
+- lib/yayaml/matcher.rb
+- lib/yayaml/version.rb
+- sig/yay/rb.rbs
+- test.yml
+homepage: https://github.com/timuruski/yayaml
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/timuruski/yayaml
+  source_code_uri: https://github.com/timuruski/yayaml
+  changelog_uri: https://github.com/timuruski/yayaml/tree/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: A tool for searching YAML files
+test_files: []