hasharay_ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ec145e647348b3f4801babbf82f8095c5f45c118a7ec6d1e7a702956a5a0096
+  data.tar.gz: 6f2a3c60af66104b3ae818140d42aa5a079cf663255b6078b4da370ea8960d19
+SHA512:
+  metadata.gz: 6c0f24289287d1d9aae0571e6a9383b1c0dc0449f421a0db0a60bd72f9ea52e8b248410e6b5babb86f1a718135541e0b644e3cc2b1ebcec324ed7d941775cdef
+  data.tar.gz: 7ad2a1d7e3db97d45ab1ba74b8cf29f7c587fd638a3f634966c243144d9e9e4e25df42e73975d34398545554649f5545f024533d6f6cfa56a6354ff48ea409ca

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,2 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-02-03
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hasharay_ext.gemspec
+gemspec
+
+gem "activesupport"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    hasharay_ext (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    i18n (1.9.1)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.2)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.25.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.7.0)
+      rubocop (= 1.25.0)
+      rubocop-performance (= 1.13.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport
+  hasharay_ext!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Igor Kasyanchuk
+
+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,117 @@
+# Hash/Array Extenstion
+
+The idea of this gem is to simplify fetching records from the Hash/Array.
+I had a need to read values from the complex hashes, and I was tired of doing lots of "dig/fetch". Code was just ugly.
+
+So, initial idea was to create a way to "query" Hash/Array similiar how we are querying CSS, but later idea was changed a little.
+
+Right now I've extracted my code into this gem and now can do the following:
+
+Instead of:
+```ruby
+h.fetch(:projects, []).map{|e| e[:name]}
+```
+I can just write:
+```ruby
+h.fpath('projects.name')
+```
+
+Even with a such simple example you can see that the code is much readable.
+It was a nice win for my project and at least I'm very happy with it :)
+
+Check more examples below to see if it can be useful for you too.
+
+## More Complex Example
+
+```ruby
+    # -----
+    # INITIAL DATA (see usage below)
+    # -----
+    hash = {
+      name: "john",
+      dob: Date.today,
+      projects: [ {name: "A", locations: ["Kyiv"]}, {name: "B", locations: ["Paris", "Berlin"]} ],
+      position: {
+        company: {
+          team: "position1",
+          office: "position2",
+          other: {
+            status: "unknown",
+            notes: ["note a", "note b"],
+            summaries: [
+              {worker: "John", level: "middle"},
+              {worker: "Bob", level: "senior"}
+            ]
+          }
+        }
+      },
+      locations: [ { city: "Kyiv", country: "Ukraine" }, { city: "Odessa", country: "Ukraine"}]
+    }
+
+    # -----
+    # USAGE with HASH
+    # -----
+    hash.fpath("name") # =>  "john"
+    hash.fetch_path("projects.name") # =>  ["A", "B"]
+    hash.fpath("projects.locations") # => [["Kyiv"], ["Paris", "Berlin"]]
+    hash.fpath!("position.company.other.summaries") # =>  [{"level" => "middle", "worker" => "John"}, {"level" => "senior", "worker" => "Bob"}]
+    hash.fetch_path!("position.company.other.status") # =>  "unknown"
+    hash.fpath("position.company.team+office") # =>  {"team" => "position1", "office" => "position2"}
+    hash.fpath("not_exising_name") # => nil
+    hash.fpath("not_exising_projects.not_exising_name") # => nil
+    hash.fpath("not_exising_projects.not_exising_name", default: 42) # => 42
+
+    # USAGE with ARRAY
+    array = [{name: "igor"}, {name: "john"}]
+    array.fpath("name") # => ["igor", "john"]
+
+    array = [{user: {first_name: "john"}}, {user: {first_name: "bob"}}]
+    array.fpath("user.first_name") # => ["john", "bob"]
+```
+
+### Methods & Options
+
+`fpath` or `fetch_path` will return vakue based on path to the value. If nothing - nil.
+`fpath!` or `fetch_path!` working same way as `fpath` but raise error is some key is not available.
+
+Available options: `def fpath(key, strict: false, separator: ".", default: nil)`.
+
+You can also return multiple values, pay attention to the `hash.fpath("position.company.team+office")`. Note that "+" works only for the last key in the queried "path".
+
+Note that keys in the returned hash are stringified.
+
+More examples available in the specs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hasharay_ext'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hasharay_ext
+
+## Ideas
+
+- Add support for "*" operator to search in hash/array for needed values.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/igorkasyanchuk/hasharay_ext.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hasharay_ext"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/hasharay_ext/version.rb

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

data/lib/hasharay_ext.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+require_relative "hasharay_ext/version"
+
+module HasharayExt
+  class Error < StandardError; end
+
+  module Interface
+    def fpath!(path, separator: ".", default: nil)
+      fpath(path, strict: true, separator: separator, default: default)
+    end
+    alias_method :fetch_path!, :fpath!
+  end
+
+  class Logic
+    attr_reader :data, :strict, :separator, :default
+
+    def initialize(data, strict: true, separator: ".", default: nil)
+      @data = data
+      @strict = strict
+      @separator = separator
+      @default = default
+    end
+
+    def get(path)
+      raise ArgumentError.new("Not specified key") if path.blank?
+
+      object = data.clone
+      tree = path.split(separator)
+
+      tree.each_with_index do |raw, index|
+        raise ArgumentError.new("Not specified key") if raw.blank?
+
+        keywords = raw.split("+")
+        if index == (tree.size - 1) && keywords.size > 1
+          # last iteration
+          case object
+          when Array
+            return keywords.map do |keyword|
+              fetch(object, keyword)
+            end.transpose
+          when Hash
+            return keywords.each_with_object({}) { |e, res|
+                     res[e] = fetch(object, e)
+                   }
+          end
+        else
+          # every key
+          object = fetch(object, raw)
+        end
+      end
+      object
+    end
+
+    private
+
+    def fetch(object, key)
+      case object
+      when Hash
+        e = object.fetch(key, strict ? invalid_key!(key, object) : default)
+        if e.is_a?(Proc)
+          e.call
+        else
+          object = e
+        end
+      when Array
+        object = object.fpath(key, strict: strict, separator: separator)
+      end
+      object
+    end
+
+    def invalid_key!(key, object)
+      proc { raise(ArgumentError.new("Key `#{key}` not found on attribute ##{object} strict: #{strict}, separator: #{separator}")) }
+    end
+  end
+end
+
+class Array
+  include HasharayExt::Interface
+
+  def fpath(key, strict: false, separator: ".", default: nil)
+    map do |e|
+      e.present? ? e.fpath(key, strict: strict, separator: separator, default: default) : default
+    end
+  end
+  alias_method :fetch_path, :fpath
+end
+
+class Hash
+  include HasharayExt::Interface
+
+  def fpath(path, strict: false, separator: ".", default: nil)
+    HasharayExt::Logic.new(clone.deep_stringify_keys, strict: strict, separator: separator, default: default).get(path)
+  end
+  alias_method :fetch_path, :fpath
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: hasharay_ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Useful method to fetch data from complex hashes and arrays
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/hasharay_ext.rb
+- lib/hasharay_ext/version.rb
+homepage: https://github.com/igorkasyanchuk/hasharay_ext
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igorkasyanchuk/hasharay_ext
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Useful method to fetch data from complex hashes and arrays
+test_files: []