hash-path 0.0.2 → 0.0.3

data/README

@@ -42,10 +42,37 @@ Example
   item.time  # => Sun Jan 10 19:30:00 +0900 2010
 
 
+Advanced
+========
+
+  # Extends HashPath to accept jsonpath syntax for path value.
+  # Install gem first, and then require 'hash-path/json'.
+  #
+  #   gem install jsonpath
+
+  require 'hash-path/json'
+
+  hash = {
+    "name"=>"Buono",
+    "members"=>
+      [{"name"=>"momo", "age"=>17},
+       {"name"=>"miya", "age"=>17},
+       {"name"=>"airi", "age"=>15}]
+  }
+
+  class Group < HashPath
+    path :leader              , "$..members[0]"
+    path :middle_school_member, "$..members[?(@['age'] <= 15)]"
+  end
+
+  group = Group.new(hash)
+  group.leader                # => [{"name"=>"momo", "age"=>17}]
+  group.middle_school_member  # => [{"name"=>"airi", "age"=>15}]
+
+
 Todo
 ====
 
-  * create spec
   * convert value to some type automatically
 
 

data/Rakefile

@@ -6,7 +6,7 @@ AUTHOR = "maiha"
 EMAIL = "maiha@wota.jp"
 HOMEPAGE = "http://github.com/maiha/hash-path"
 SUMMARY = "path accessor to hierarchical hash"
-GEM_VERSION = "0.0.2"
+GEM_VERSION = "0.0.3"
 
 spec = Gem::Specification.new do |s|
   s.rubyforge_project = 'asakusarb'

data/lib/hash-path.rb

@@ -1,23 +1,29 @@
-
 class HashPath < Hash
-  def self.paths
-    @paths ||= {}
-  end
+  class << self
+    def paths
+      @paths ||= {}
+    end
 
-  def self.path(key, path)
-    paths[key.to_s] = path
+    def path(key, path)
+      paths[key.to_s] = path
+    end
   end
 
   def [](key)
     key = key.to_s
 
-    # first, check exact value
-    return super if has_key?(key)
+    if (key[0,1] == '$') && defined?(JsonPath)
+      # jsonpath
+      @jsonpath ||= JsonPath.wrap(self)
+      return @jsonpath.path(key).to_a
 
-    # second, browse children
-    return key.split("/").inject(self) {|hash, key| hash[key]}
-  rescue Exception => e
-    return rescue_hierarchical_access(key, e)
+    else
+      # first, check if key has '/'
+      return super unless key.index('/')
+
+      # second, browse children
+      return key.split("/").inject(self) {|hash, k| hash ? hash[k] : nil}
+    end
   end
 
   def initialize(hash = {})
@@ -26,10 +32,6 @@ class HashPath < Hash
   end
 
   private
-    def rescue_hierarchical_access(key, e)
-      return nil
-    end
-
     def method_missing(name, *args, &block)
       if args.empty?
         self[ self.class.paths[name.to_s] || name ]

data/lib/hash-path/json.rb

@@ -0,0 +1,6 @@
+begin
+  require "jsonpath"
+rescue
+  $stderr.puts "'jsonpath' gem is not found. Please install it first!\ngem install jsonpath"
+  raise
+end

data/spec/api_spec.rb

@@ -10,25 +10,8 @@ describe HashPath do
     HashPath.new.should respond_to(:[])
   end
 
-  def data
-    {
-      "app" => {
-        "models"      => "ActiveRecord",
-        "controllers" => "ActionController",
-        "views"       => "ActionView",
-        "helpers"     => "ActionView::Helpers",
-      },
-      "vendor" => {
-        "plugins" => {
-          "aasm" => "Aasm",
-          "haml" => "Haml",
-        },
-      }
-    }
-  end
-
   describe "#[]" do
-    subject { HashPath.new(data) }
+    subject { HashPath.new(data('rails.json')) }
 
     context "(for present)" do
       its("app/models")     { should == "ActiveRecord" }
@@ -46,7 +29,7 @@ describe HashPath do
         path :nothing , "no/such/value"
       end
 
-      subject { Labeled.new(data) }
+      subject { Labeled.new(data('rails.json')) }
 
       its(:model)           { should == "ActiveRecord" }
       its("model")          { should == "ActiveRecord" }

data/spec/fixtures/group.json

@@ -0,0 +1,8 @@
+{
+  "name": "Buono",
+  "members": [
+    {"name": "momo", "age": 17},
+    {"name": "miya", "age": 17},
+    {"name": "airi", "age": 15}
+  ]
+}

data/spec/fixtures/rails.json

@@ -0,0 +1,14 @@
+{
+  "app": {
+    "models":  "ActiveRecord",
+    "controllers" : "ActionController",
+    "views" : "ActionView",
+    "helpers" : "ActionView::Helpers"
+  },
+  "vendor": {
+    "plugins": {
+      "haml" : "Haml",
+      "aasm" : "Aasm"
+    }
+  }
+}

data/spec/jsonpath_spec.rb

@@ -0,0 +1,29 @@
+
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe HashPath do
+  class Group < HashPath
+    path :name                , "name"
+    path :leader              , "$..members[0]"
+    path :middle_school_member, "$..members[?(@['age'] <= 15)]"
+  end
+
+  it "should recognize jsonpath syntax when jsonpath is loaded" do
+    require 'hash-path/json'
+
+    buono = Group.new(data('group.json'))
+    momo  = {"name"=> "momo", "age"=> 17}
+    airi  = {"name"=> "airi", "age"=> 15}
+
+    buono.name.should == "Buono"
+    buono.leader.should == [momo]
+    buono.middle_school_member.should == [airi]
+
+    # remove const to disable 'jsonpath' gem
+    Object.instance_eval { remove_const :JsonPath }
+
+    buono.name.should == "Buono"
+    buono.leader.should == nil
+    buono.middle_school_member.should == nil
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,19 @@
 
 require 'spec'
+require 'pathname'
 
 require File.join(File.dirname(__FILE__), '/../lib/hash-path')
 require File.join(File.dirname(__FILE__), '/its_helper')
 
 def data(key)
-  path = File.join(File.dirname(__FILE__) + "/fixtures/#{key}")
-  File.read(path){}
+  path   = Pathname(__FILE__).parent + "fixtures/#{key}"
+  buffer = File.read(path){}
+
+  case path.extname
+  when ".json"
+    require 'json'
+    buffer = JSON.parse(buffer)
+  end
+
+  return buffer
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hash-path
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - maiha
@@ -27,8 +27,12 @@ files:
 - README
 - Rakefile
 - lib/hash-path.rb
+- lib/hash-path/json.rb
 - spec/inherit_spec.rb
 - spec/api_spec.rb
+- spec/fixtures/rails.json
+- spec/fixtures/group.json
+- spec/jsonpath_spec.rb
 - spec/its_helper.rb
 - spec/spec_helper.rb
 has_rdoc: true