yamlook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 968d1897a00350db31375552a70066d04d14c4edd7e52406ed2188e4951bb3e2
+  data.tar.gz: e45f29b9f4c56114fb8c5d546cc25d91f37c785575c1331879c774523b9ed8f6
+SHA512:
+  metadata.gz: 3a667a39333140b85e9710f5d8a87e89b3e951fe634065e2f464ddc7e4d7beb23fbfac0096acd72bf01aeaa28a0a322221dca11d1174fbc88728a0f59703a735
+  data.tar.gz: a1415e35e038896b2205d5fa409483aceedefee8566d43a636471b23c89bb423b1ca7b4c3c650a0f23d5af8d05ea8a9c39865443baa0aeecc12cf9771eca2880

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Viacheslav Mefodin
+
+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,17 @@
+# Yamlook
+
+## Installation
+
+```
+$ gem install yamlook
+```
+
+## Usage
+
+```
+$ yamlook some.deep.key.in.you.yaml.file
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/yamlook

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'yamlook'
+
+Yamlook::Search.perform(ARGV[0].split('.'))

data/lib/yamlook.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+require 'yamlook/node'
+require 'yamlook/node_list'
+require 'yamlook/file'
+require 'yamlook/search'

data/lib/yamlook/file.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Yamlook
+  # Yaml file to perform search
+  class File
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def search(keys)
+      return unless yaml
+
+      findings = root_node_list.search(keys).flatten.compact.map do |finding|
+        finding.filename = filename
+        finding
+      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/node.rb

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

data/lib/yamlook/node_list.rb

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

data/lib/yamlook/search.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Yamlook
+  # Searches for occurrences of dot-notated keys in all yaml files
+  # of current directory
+  module Search
+    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|
+        result = File.new(filename).search(keys)
+        print_progress(result)
+        result
+      end
+
+      print_result(findings.compact)
+    end
+
+    def print_progress(result)
+      print result ? "\033[32m*\033[0m" : "\033[33m.\033[0m"
+    end
+
+    def print_result(findings)
+      puts
+      puts '-' * 10
+      findings.any? ? print_success(findings) : print_failure
+    end
+
+    def print_failure
+      puts 'Nothing found.'
+    end
+
+    def print_success(findings)
+      print "Found #{findings.count} occurrences:"
+      findings.each do |finding|
+        puts
+        puts finding
+      end
+    end
+  end
+end

data/lib/yamlook/version.rb

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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: yamlook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Viacheslav Mefodin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description:
+email:
+- mefodin.v@gmail.com
+executables:
+- yamlook
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- bin/yamlook
+- lib/yamlook.rb
+- lib/yamlook/file.rb
+- lib/yamlook/node.rb
+- lib/yamlook/node_list.rb
+- lib/yamlook/search.rb
+- lib/yamlook/version.rb
+homepage: https://github.com/sl4vr/yamlook
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Search occurrences of dot-notated yaml keys.
+test_files: []