hpath 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b2a7bf6f795402f608054a5ff3bda6911c9fa46
-  data.tar.gz: 268739d05a0fba52a2749607a0a58ed15f9b3c86
+  metadata.gz: d97f5894eb225d22238c604ab0fc4e06a31e5fa1
+  data.tar.gz: a52d7400d901e41584dafb8613048358cfb78a2f
 SHA512:
-  metadata.gz: 89828fbd36cda4309defa91141f7db48f6718c77a8fe78b7c0d4add014c2070b82e34ae92aa830be2cd710d307665c6bd50730e8373acc7a31d218afcdfb4902
-  data.tar.gz: ff88f0679aa35a6d674de076774c8c51f5589998054a1679ef8e222f23c166095076d165000f511ec4e9f71a5ad9d8876ea31e341518ba4616ccda3662418087
+  metadata.gz: 7ed6a57ed11bd16a296a6572ea282190960f0f60ca925d7226c469c461948c9bdc89e10972fed14221316c0fa138382cabf6c10b9a05485bbcf524b1b49f3bc1
+  data.tar.gz: 3e0bb084b7274f51c8c53bd175ee3992f7049d3689d257f9851a31376ce88bd01cc8e6800d3a105c761869fd3e8f7fb3497b064c66b004f3f3c2abbf16368af4

data/.rspec

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

data/Gemfile

@@ -1,4 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in hpath.gemspec
 gemspec
+
+gem "pry",                "~> 0.9.12.6"
+gem "pry-nav",            "~> 0.2.3"
+gem "pry-stack_explorer", "~> 0.4.9.1"
+gem "pry-syntax-hacks",   "~> 0.0.6"

data/README.md

@@ -1,6 +1,6 @@
 # Hpath
 
-TODO: Write a gem description
+This code is heavy work in progress and does not work today. The examples and usage hints given below only show the goals.
 
 ## Installation
 
@@ -18,7 +18,125 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Here are some examples of hpath in action.
+
+```ruby
+record = {
+  title: "About a hash",
+  creator: [
+    "Hashman",
+    "Hashboy"
+  ],
+  price: [
+    { currency: :USD, value: 12.99 },
+    { currency: :EUR, value:  8.99 }
+  ],
+  subject: [
+    { type: "automatic", value: "hash" },
+    { type: "automatic", value: "hashes" },
+    { type: "automatic", value: "ruby" },
+    { type: "manual", value: "hash" },
+    { type: "manual", value: "array" },
+    { type: "manual", value: "Hashman" },
+    { type: "manual", value: "Hashboy" },
+  ],
+  _source: {
+    "id" => "123",
+    "title" => "<h1>About a hash</h1>",
+    ...
+  }
+}
+
+Hpath.get record, "/title"
+# => "About a hash"
+
+Hpath.get record, "/_source/id"
+# => "123"
+
+Hpath.get record, "/_source/[id, title]"
+# => { "id" => "123", "title" => "<h1>About a hash</h1>" }
+
+Hpath.get record, "/price/*[currency=USD]"
+# => [{ currency: :USD, value: 12.99 }]
+
+Hpath.get record, "/price/*[currency=USD,value<10]"
+# => nil
+
+Hpath.get record, "/price/*[(currency=USD|currency=EUR),value<10]"
+# => [{ currency: :EUR, value:  8.99 }]
+
+Hpath.get record, "/subject/*[type=automatic]"
+# => [
+#      { type: "automatic", value: "hash" },
+#      { type: "automatic", value: "hashes" },
+#      { type: "automatic", value: "ruby" }
+#    ]
+
+Hpath.get record, "/subject/*[type=automatic]/type"
+# => ["automatic", "automatic", "automatic"]
+```
+
+## Syntax
+
+### `/`
+Get the root element.
+
+```ruby
+Hpath.get [:a,:b,:c], "/"
+# => [:a,:b,:c]
+```
+
+### `/[n]`
+Get the n-th element of an array.
+
+```ruby
+Hpath.get [:a,:b,:c], "/[1]"
+# => :a
+```
+
+### `/[n,m,...]`
+Get the n-th, m-th and ... element of an array.
+
+```ruby
+Hpath.get [:a,:b,:c], "/[1,2]"
+# => [:a,:b]
+```
+
+### `/[key1, key2, ...]`
+If current element is a hash, get a hash only with the given keys. Since it cannot be determined, if the key is a symbol or a string, both interpretations are checked. If the current object is not a hash, but has methods named `key1, key2`, this methods are called and the results are returned.
+
+```ruby
+Hpath.get {a: "b", c: "d", e: "f"}, "/[a,c]"
+# => {a: "b", c: "d"}
+```
+
+### `/*`
+Get all elements of the current root element. If it's a array, this simply returns the array. If it's a hash, an array of all key/value pairs is returned.
+
+```ruby
+Hpath.get [:a,:b,:c], "/*"
+# => [:a,:b,:c]
+```
+
+```ruby
+Hpath.get {a: "b", c: "d", e: "f"}, "/*"
+# => [{a: "b"}, {c: "d"}, {e: "f"}]
+```
+
+### `/key`
+If the current element is a hash, return the value of the given key. If the current element is not a hash, but has a method named `key`, this method is called and the result is returned.
+
+```ruby
+Hpath.get {a: { b: "c" } }, "/a"
+# => { b: "c" }
+```
+
+If the current element is an array, the non-array behaviour is applied to all members of the array.
+
+```ruby
+Hpath.get([{a:"1", b:"2", c:"3"}, {a:"2", b:"5", c:"6"}], "/a")
+# => ["1", "2"]
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hpath.gemspec

@@ -1,13 +1,12 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hpath/version'
+require "hpath/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "hpath"
   spec.version       = Hpath::VERSION
   spec.authors       = ["Michael Sievers"]
-  #spec.email         = ["michael_sievers@web.de"]
   spec.summary       = %q{HPath for ruby}
   spec.homepage      = "https://github.com/hpath/hpath-ruby"
   spec.license       = "MIT"
@@ -17,6 +16,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "parslet", ">= 1.6.1"
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",   ">= 3.0.0", "< 4.0.0"
 end

data/lib/hpath.rb

@@ -1,5 +1,93 @@
-require "hpath/version"
-
 module Hpath
-  # Your code goes here...
+  require "hpath/filter"
+  require "hpath/parser"
+  require "hpath/version"
+
+  def self.get(object, hpath_string)
+    hpath = Hpath::Parser.parse(hpath_string)
+    _get(object, hpath[:path])
+  end
+
+  #
+  private
+  #
+  def self._get(object, paths, parent = object)
+    _object = object
+
+    if paths.empty?
+      return object
+    else
+      path = paths.shift
+    end
+
+    if path[:identifier]
+      object = _resolve_identifier(object, path[:identifier])
+    elsif path[:axis] == "parent"
+      object = parent
+    end
+
+    if path[:indices]
+      object = _resolve_indices(object, path[:indices])
+    elsif path[:keys]
+      object = _resolve_keys(object, path[:keys])
+    end
+
+    unless path[:filter].nil?
+      object = _apply_filters(object, Hpath::Filter.new(path[:filter]))
+    end
+
+    self._get(object, paths, _object)
+  end
+
+  def self._apply_filters(object, filter)
+    if object.is_a?(Array)
+      object.select do |element|
+        filter.applies?(element)
+      end
+    else
+      #binding.pry
+    end
+  end
+
+  def self._resolve_identifier(object, identifier)
+    if object.is_a?(Array)
+      if identifier.to_s == "*"
+        object
+      else
+        object.map do |element|
+          if element.is_a?(Hash)
+            element[identifier.to_s] || element[identifier.to_sym] 
+          elsif element.respond_to?(identifier)
+            element.send(identifier)
+          else
+            raise "Cannot apply identifier to collection object!"
+          end
+        end
+      end
+    elsif object.is_a?(Hash)
+      if identifier.to_s == "*"
+        object.map { |key, value| {key => value} }
+      else
+        object[identifier.to_s] || object[identifier.to_sym]
+      end
+    else
+      #binding.pry
+    end
+  end
+
+  def self._resolve_indices(object, indices)
+    if indices.length == 1
+      object[indices.first]
+    else
+      indices.map { |index| object[index] }
+    end
+  end
+
+  def self._resolve_keys(object, keys)
+    if object.is_a?(Hash)
+      object.select { |key, value| keys.include?(key.to_s) || keys.include?(key.to_sym) }
+    else
+      raise "Cannot resolve keys for non-hash objects!"
+    end
+  end
 end

data/lib/hpath/filter.rb

@@ -0,0 +1,33 @@
+class Hpath::Filter
+
+  def initialize(filter_hash)
+    @type = filter_hash.keys.first
+    
+    if @type == :and_filter || @type == :or_filter
+      @children = filter_hash.values.first.map do |element|
+        Hpath::Filter.new(element)
+      end
+    elsif @type == :key_value_filter
+      @key = filter_hash[:key_value_filter][:key]
+      @value = filter_hash[:key_value_filter][:value]
+    end
+  end
+
+  def applies?(object)
+    if @type == :and_filter
+      @children.all? { |child_filter| child_filter.applies?(object) }
+    elsif @type == :or_filter
+      @children.any? { |child_filter| child_filter.applies?(object) }
+    elsif @type == :key_value_filter
+      if object.is_a?(Hash) && (@value.is_a?(String) || @value.is_a?(Symbol))
+        object[@key.to_s] == @value.to_s || object[@key.to_sym] == @value.to_s ||
+        object[@key.to_s] == @value.to_sym || object[@key.to_sym] == @value.to_sym
+      else
+        if object.respond_to(@key)
+          object.send(@key) == @value
+        end
+      end
+    end
+  end
+
+end

data/lib/hpath/parser.rb

@@ -0,0 +1,105 @@
+require "parslet"
+
+class Hpath::Parser
+  def self.parse(string)
+    self.new.parse(string)
+  end
+
+  def parse(string)
+    transform(normalize(parser.parse(string)))
+  end
+
+  #
+  private
+  #
+  def normalize(result_tree) # to ease transformation
+    result_tree[:path].map! do |element|
+      element[:axis] ||= nil
+      element[:identifier] ||= nil
+      element[:filter] ||= nil
+      element[:indices] ||= nil
+      element[:indices] = [element[:indices]] if !element[:indices].nil? && !element[:indices].is_a?(Array)
+      element[:keys] ||= nil
+      element[:keys] = [element[:keys]] if !element[:keys].nil? && !element[:keys].is_a?(Array)
+      element
+    end
+
+    result_tree
+  end
+
+  def parser
+    @parser ||=
+    Class.new(Parslet::Parser) do
+      rule(:space)  { match('\s').repeat(1) }
+      rule(:space?) { space.maybe }
+
+      rule(:key_value_filter) {
+        space? >> match['a-zA-Z'].repeat(1).maybe.as(:key) >> (str("<") | str(">") | str("=").repeat(1,3)).as(:operator) >> match['a-zA-Z0-9'].repeat(1).as(:value) >> space?
+      }
+
+      rule(:or_filter) {
+        ((and_filter.as(:and_filter) | key_value_filter.as(:key_value_filter)) >> str("|")).repeat(1) >> (and_filter.as(:and_filter) | key_value_filter.as(:key_value_filter))
+      }
+
+      rule(:primary) {
+        str("(") >> or_filter.as(:or_filter) >> str(")")
+      }
+
+      rule(:and_filter) {
+        ((primary | key_value_filter.as(:key_value_filter)) >>
+        str(",")).repeat(1) >>
+        (primary | key_value_filter.as(:key_value_filter))
+      }
+
+      rule(:filter) {
+        space? >> (or_filter.as(:or_filter) | and_filter.as(:and_filter) | key_value_filter.as(:key_value_filter)).as(:filter) >> space?
+      }
+
+      rule(:keys) {
+        match('[a-zA-Z0-9]').repeat(1).as(:key) >> (space? >> str(",") >> space? >> match('[a-zA-Z0-9]').repeat(1).as(:key)).repeat
+      }
+
+      rule(:indices) {
+        match('[0-9]').repeat(1).as(:index) >> (space? >> str(",") >> match('[0-9]').repeat(1).as(:index)).repeat
+      }
+
+      rule(:identifier) {
+        match('[a-zA-Z0-9*_]').repeat(1)
+      }
+
+      rule(:node) {
+        str("/") >> (identifier.as(:identifier) | (str("::") >> identifier.as(:axis))).maybe >> (str("[") >> space? >> (indices.as(:indices) | filter | keys.as(:keys)) >> space? >> str("]")).maybe
+      }
+
+      rule(:path) {
+        node.repeat(1).as(:path)
+      }
+
+      # root
+      root(:path)
+    end.new
+  end
+
+  def transform(result_tree)
+    transformation.apply(result_tree)
+  end
+
+  def transformation
+    @transformation ||=
+    Class.new(Parslet::Transform) do
+      rule(axis: simple(:axis), identifier: simple(:identifier), filter: subtree(:filter), indices: subtree(:indices), keys: subtree(:keys)) {
+        {
+          axis: axis.nil? ? nil : axis.to_s,
+          identifier: identifier.nil? ? nil : identifier.to_s,
+          filter: filter,
+          indices: indices.nil? ? nil : indices.map { |element| Integer(element[:index]) },
+          keys: keys.nil? ? nil : keys.map { |element| element[:key].to_s.to_sym }
+        }
+      }
+
+      rule(key: simple(:key), operator: simple(:operator), value: simple(:value)) {
+        { key: key.nil? ? nil : key.to_sym, operator: operator.to_s, value: value.to_s }
+      }
+    end.new
+  end
+end

data/lib/hpath/version.rb

@@ -1,3 +1,3 @@
 module Hpath
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/hpath/filter_spec.rb

@@ -0,0 +1,15 @@
+describe Hpath::Filter do
+  context "initialized with a (nested) filter hash" do
+    let(:filter_hash) { Hpath::Parser.new.parse("/array/*[a=b,c=d,(e=d|e=f)]")[:path].first[:filter] }
+
+    describe ".filter" do
+      context "when given object is an array containing hashes" do
+        let(:filter) { Hpath::Filter.new(Hpath::Parser.new.parse("/array/*[a=b,c=d,(e=d|e=f)]")[:path][1][:filter]) }
+
+        it "returns only hashes which match the filter" do
+          #w = [{a: "b", c: "d", e: "f"}, {a: "b", c: "d", e: "z"}].select { |e| filter.applies?(e) }
+        end
+      end
+    end
+  end
+end

data/spec/hpath/parser_spec.rb

@@ -0,0 +1,26 @@
+describe Hpath::Parser do
+  let(:parser) { Hpath::Parser.new }
+
+  it "parses a hpath string into a tree structure" do
+=begin
+    expect(parser.parse("/foo/bar/*[a=b,c=d,(e<d|e>f)]/foo[1]/bar[<10]")).to eq(
+      {:path=>
+        [{:identifier=>:foo, :filter=>nil, :index=>nil},
+         {:identifier=>:bar, :filter=>nil, :index=>nil},
+         {:identifier=>:*,
+          :filter=>
+           {:and_filter=>
+             [{:key_value_filter=>{:key=>:a, :operator=>"=", :value=>"b"}},
+              {:key_value_filter=>{:key=>:c, :operator=>"=", :value=>"d"}},
+              {:or_filter=>
+                [{:key_value_filter=>{:key=>:e, :operator=>"<", :value=>"d"}},
+                 {:key_value_filter=>{:key=>:e, :operator=>">", :value=>"f"}}]}]},
+          :index=>nil},
+         {:identifier=>:foo, :filter=>nil, :index=>1},
+         {:identifier=>:bar,
+          :filter=>{:key_value_filter=>{:key=>nil, :operator=>"<", :value=>"10"}},
+          :index=>nil}]}
+    )
+=end
+  end
+end

data/spec/hpath_spec.rb

@@ -0,0 +1,70 @@
+describe Hpath do
+  describe "#get" do
+    describe "returns the corresponding value from the given object" do
+      it "processes \"/key\" for a nested hash" do
+        hpath_result = Hpath.get({ foo: { bar: 1 } }, "/foo")
+        expect(hpath_result).to eq({ bar: 1 })
+      end
+
+      it "processes \"/[n]\" for an array" do
+        hpath_result = Hpath.get([1,2,3], "/[0]")
+        expect(hpath_result).to eq(1)
+      end
+
+      it "processes \"/[m,n]\" for an array" do
+        hpath_result = Hpath.get([1,2,3], "/[0,1]")
+        expect(hpath_result).to eq([1,2])
+      end
+
+      it "processes \"/key1/key2\" for a nested hash" do
+        hpath_result = Hpath.get({ foo: { bar: 1 } }, "/foo/bar")
+        expect(hpath_result).to eq(1)
+      end
+
+      it "processes \"/*\" for an array" do
+        hpath_result = Hpath.get([1,2,3], "/*")
+        expect(hpath_result).to eq([1,2,3])
+      end
+
+      it "processes \"/*\" for a hash" do
+        hpath_result = Hpath.get({a: "b", c: "d"}, "/*")
+        expect(hpath_result).to eq([{a: "b"}, {c: "d"}])
+      end
+      
+      it "processes \"/[key1, key2]\" for a hash" do
+        hpath_result = Hpath.get({a: 1, b: 2, "c" => 3}, "/[a,c]")
+        expect(hpath_result).to eq({a: 1, "c" => 3})
+      end
+
+      it "processes \"/[key=value]\" for a array of hashes" do
+        hpath_result = Hpath.get([{a: "foo"}, {a: "bar"}, { "a" => :bar }, {a: "muff"}], "/[a=bar]")
+        expect(hpath_result).to eq([{:a=>"bar"}, {"a"=>:bar}])
+      end
+
+      it "processes \"/[key1=value1,key2=value2]\" for a array of hashes" do
+        hpath_result = Hpath.get([{a:"1", b:"2", c:"3"}, {"a" => "1", "b" => "2", c:"3"}, {a:"2", b:"1", c:"3"}], "/[a=1,b=2]")
+        expect(hpath_result).to eq([{:a=>"1", :b=>"2", :c=>"3"}, {"a"=>"1", "b"=>"2", :c=>"3"}])
+      end
+
+      it "processes \"/[key1=value1,(key2=value2|key3=value3)]\" for a array of hashes" do
+        hpath_result = Hpath.get([{a:"1", b:"2", c:"3"}, {a:"1", b:"5", c:"6"}, {a:"2", b:"1", c:"3"}], "/[a=1,(b=5|c=3)]")
+        expect(hpath_result).to eq([{:a=>"1", :b=>"2", :c=>"3"}, {:a=>"1", :b=>"5", :c=>"6"}])
+      end
+      
+      it "processes \"/array/key\" for an array of hashes" do
+        hpath_result = Hpath.get([{a:"1", b:"2", c:"3"}, {a:"1", b:"5", c:"6"}, {a:"2", b:"1", c:"3"}], "/a")
+        expect(hpath_result).to eq(["1", "1", "2"])
+      end
+      
+      it "processes \"/key1/::parent\" for a hash" do
+        hpath_result = Hpath.get({ foo: { bar: "foobar" } },  "/foo/::parent")
+        expect(hpath_result).to eq({ foo: { bar: "foobar" } })
+      end
+
+      it "processes \"/[n]/::parent\" for an array of hashes" do
+        hpath_result = Hpath.get([{ foo: { bar: "foobar" } }],  "/[0]/::parent")
+        expect(hpath_result).to eq([{ foo: { bar: "foobar" } }])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "hpath"
+begin
+  require "pry"
+rescue LoadError
+end
+
+RSpec.configure do |config|
+end
+
+def read_asset(path_to_file)
+  File.read(File.expand_path(File.join(File.dirname(__FILE__), "assets", path_to_file)))
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hpath
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Sievers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: 
 email: 
 executables: []
@@ -45,13 +79,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - hpath.gemspec
 - lib/hpath.rb
+- lib/hpath/filter.rb
+- lib/hpath/parser.rb
 - lib/hpath/version.rb
+- spec/hpath/filter_spec.rb
+- spec/hpath/parser_spec.rb
+- spec/hpath_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/hpath/hpath-ruby
 licenses:
 - MIT
@@ -76,4 +117,8 @@ rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: HPath for ruby
-test_files: []
+test_files:
+- spec/hpath/filter_spec.rb
+- spec/hpath/parser_spec.rb
+- spec/hpath_spec.rb
+- spec/spec_helper.rb