pebbles-uid 0.0.3 → 0.0.4

data/README.md

@@ -15,7 +15,7 @@ The first label uniquely identifies which pebble the resource originated from.
 Any secondary labels are grouped into a `species`, which identify sub-types within a given pebble.
 
 ```
-  post.doc
+post.doc
 ```
 
 Here the genus is `post`, and the species is `doc`.
@@ -26,10 +26,10 @@ The path is a dot-delimited set of labels. The first label represents the realm,
 
 A single resource may have multiple paths (and therefore multiple uids). For example:
 
-    ```
-       post.card:tourism.norway.fjords$42
-       post.card:tourism.norway.west-coast$42
-    ```
+```
+post.card:tourism.norway.fjords$42
+post.card:tourism.norway.west-coast$42
+```
 
 ### Oid
 
@@ -51,9 +51,9 @@ Across the pebblestack universe, you can query for a specific resource by passin
 
 In addition, the wildcard query `genus:realm.*$oid` will identify a single resource, e.g.:
 
-    ```
-      post.card:tourism.*$42
-    ```
+```
+post.card:tourism.*$42
+```
 
 If a specific resource is targeted (i.e. genus and oid are both unambiguous), then realm is required.
 
@@ -63,33 +63,33 @@ If a specific resource is targeted (i.e. genus and oid are both unambiguous), th
 
 The most permissive query consists of any genus in any path, with any oid (implied):
 
-    ```
-      *:*
-    ```
+```
+*:*
+```
 
 This is the equivalent to:
 
-    ```
-      *:*$*
-    ```
+```
+*:*$*
+```
 
 Queries may not be made across multiple realms at one time. If realm is not specified in the path, then it is assumed that the application verifies realm if necessary.
 
 In the context of a genus or a path, you may specify any number of labels and terminate with an asterisk, which means: zero or more labels follow. E.g.:
 
-    ```
-      post.*:tourism.europe.*
-    ```
+```
+post.*:tourism.europe.*
+```
 
 NOTE: wildcard queries on species is not yet supported.
 
 This will return things like:
 
-    ```
-      post:tourism.europe$123
-      post:tourism.europe.france.sightseeing$234
-      post.card:tourism.europe.mountains$345
-    ```
+```
+post:tourism.europe$123
+post:tourism.europe.france.sightseeing$234
+post.card:tourism.europe.mountains$345
+```
 
 Asterisks may not occur in mid-sequence. In other words, `post:tourism.*.food` will not be accepted.
 
@@ -101,39 +101,39 @@ A pipe signifies _or_.
 
 This can be used in genus at any position:
 
-    ```
-      unit|group:*
-    ```
+```
+unit|group:*
+```
 
-    ```
-      post.doc|card:*
-    ```
+```
+post.doc|card:*
+```
 
 In a path, this can be used in any position except the first, as the realm must be unambiguous.
 
 Thus:
 
-    ```
-      post:realm.label1|label2.something
-    ```
+```
+post:realm.label1|label2.something
+```
 
 The following is not allowed:
 
-    ```
-      post:realm1|realm2.*
-    ```
+```
+post:realm1|realm2.*
+```
 
 If you wish to fetch a specific list of objects, you may use the pipe to delimit oids:
 
-    ```
-      post:realm.*$a|b|c|d|e|f|g
-    ```
+```
+post:realm.*$a|b|c|d|e|f|g
+```
 
 This is equivalent to the NOW deprecated comma-delimited uid query:
 
-    ```
-      post:realm.*$a,post:realm.*$b,post:realm.*$c,post:realm.*$d,post:realm.*$e,post:realm.*$f,post:realm.*$g,
-    ```
+```
+post:realm.*$a,post:realm.*$b,post:realm.*$c,post:realm.*$d,post:realm.*$e,post:realm.*$f,post:realm.*$g,
+```
 
 NOTE: realm is required in this case, because each term in the list must refer to a single resource.
 
@@ -141,19 +141,18 @@ NOTE: realm is required in this case, because each term in the list must refer t
 
 In both genus and paths, a caret indicates ancestry up to the specified point:
 
-    ```
-      post:realm.europe.^norway.fjords.food
-    ```
+```
+post:realm.europe.^norway.fjords.food
+```
 
 This represents everything at the following locations:
 
-    ```
-      post:realm.europe
-      post:realm.europe.norway
-      post:realm.europe.norway.fjords
-      post:realm.europe.norway.fjords.food
-    ```
-
+```
+post:realm.europe
+post:realm.europe.norway
+post:realm.europe.norway.fjords
+post:realm.europe.norway.fjords.food
+```
 
 ## Installation
 
@@ -173,28 +172,45 @@ Or install it yourself as:
 
 ### Identifying an existing resource
 
-    uid = Pebbles::Uid.new('post.card:tourism.norway.fjords$1234')
+```
+uid = Pebbles::Uid.new('post.card:tourism.norway.fjords$1234')
+
+uid.realm
+=> "tourism"
+
+uid.genus
+=> "post.card"
+
+uid.species
+=> "card"
+
+uid.path
+=> "tourism.norway.fjords"
 
-    uid.realm
-    => "tourism"
+uid.oid
+=> 1234
 
-    uid.genus
-    => "post.card"
+uid.to_s
+=> 'post.card:tourism.norway.fjords$1234'
 
-    uid.species
-    => "card"
+uid.to_hash
+=> {'genus_0' => 'post', 'genus_1' => 'card', 'path_0' => 'tourism', 'path_1' => 'norway', 'path_2' => 'fjords', 'oid' => '1234'}
+```
+
+### Uid Queries
 
-    uid.path
-    => "tourism.norway.fjords"
+```
+query = Pebbles::Uid::Query.new('post.card:tourism.^norway.fjords|mountains.*')
 
-    uid.oid
-    => 1234
+query.list?
+=> false
 
-    uid.to_s
-    => 'post.card:tourism.norway.fjords$1234'
+query.collection?
+=> true
 
-    uid.to_hash
-    => {'genus_0' => 'post', 'genus_1' => 'card', 'path_0' => 'tourism', 'path_1' => 'norway', 'path_2' => 'fjords', 'oid' => '1234'}
+query.to_hash
+=> {'genus_0' => 'post', 'genus_1' => 'card', 'path_0' => 'tourism', 'path_1' => ['norway', nil], ['fjords', 'mountains', nil]}
+```
 
 ## TODO
 

data/lib/pebbles-uid.rb

@@ -17,8 +17,8 @@ module Pebbles
         [genus, path, oid.empty? ? nil : oid]
       end
 
-      def query(s)
-        Pebbles::Uid::Query.new(s)
+      def query(s, options = {})
+        Pebbles::Uid::Query.new(s, options)
       end
 
       def genus(s)

data/lib/pebbles-uid/labels.rb

@@ -2,12 +2,16 @@ module Pebbles
   class Uid
     class Labels
 
-      attr_reader :values, :name
+      NO_MARKER = Class.new
+
+      attr_reader :values, :name, :suffix, :stop
       def initialize(*values)
         options = values.pop if values.last.is_a?(Hash)
         options ||= {}
         @values = values.flatten.compact.map {|v| v.split('.') }.flatten
         @name = options[:name]
+        @suffix = options[:suffix]
+        @stop = options.fetch(:stop) { NO_MARKER }
       end
 
       def first
@@ -47,8 +51,25 @@ module Pebbles
         !!(value =~ /[\*\|\^]/)
       end
 
-      def to_hash(options = {})
-        Conditions.new(values, {:name => name}.merge(options)).to_hash
+      def to_hash
+        conditions.to_hash
+      end
+
+      def next_label
+        conditions.next
+      end
+
+      def conditions
+        unless @conditions
+          options = {:name => name, :suffix => suffix}
+          options.merge!(:stop => stop) if use_stop_marker?
+          @conditions = Conditions.new(values, options)
+        end
+        @conditions
+      end
+
+      def use_stop_marker?
+        stop != NO_MARKER
       end
 
     end

data/lib/pebbles-uid/query.rb

@@ -2,16 +2,26 @@ module Pebbles
   class Uid
     class Query
 
-      attr_reader :term, :terms, :genus, :path, :oid
-      def initialize(term)
+      NO_MARKER = Class.new
+
+      attr_reader :term, :terms, :genus, :path, :oid,
+        :genus_name, :path_name, :suffix, :stop
+      def initialize(term, options = {})
         @term = term
+        @genus_name = options.fetch(:genus) { 'genus' }
+        @path_name = options.fetch(:path) { 'path' }
+        @suffix = options[:suffix]
+        @stop = options.fetch(:stop) { NO_MARKER }
 
         if wildcard_query?
           @terms = [term]
-          @genus, @path, @oid = Pebbles::Uid.parse(term)
         else
           @terms = extract_terms
         end
+
+        if !list?
+          @genus, @path, @oid = Pebbles::Uid.parse(term)
+        end
       end
 
       def for_one?
@@ -22,6 +32,13 @@ module Pebbles
         terms.size != 1
       end
 
+      def list
+        if !list?
+          raise "Cannot expand non-list query"
+        end
+        terms
+      end
+
       def collection?
         wildcard_query?
       end
@@ -56,18 +73,35 @@ module Pebbles
         end
 
         hash = genus_wrapper.to_hash.merge(path_wrapper.to_hash)
-        hash = hash.merge(:oid => oid) if oid?
+        if oid?
+          oid_key = ['oid', suffix].compact.join('_').to_sym
+          hash = hash.merge(oid_key => oid)
+        end
         hash
       end
 
+      def next_path_label
+        path_wrapper.next_label
+      end
+
       private
 
       def genus_wrapper
-        @genus_wrapper ||= Labels.new(genus, :name => 'genus')
+        unless @genus_wrapper
+          options = {:name => genus_name, :suffix => suffix}
+          options.merge!(:stop => stop) if use_stop_marker?
+          @genus_wrapper = Labels.new(genus, options)
+        end
+        @genus_wrapper
       end
 
       def path_wrapper
-        @path_wrapper ||= Labels.new(path, :name => 'path')
+        unless @path_wrapper
+          options = {:name => path_name, :suffix => suffix}
+          options.merge!(:stop => stop) if use_stop_marker?
+          @path_wrapper = Labels.new(path, options)
+        end
+        @path_wrapper
       end
 
       def wildcard_query?
@@ -102,6 +136,9 @@ module Pebbles
         end.flatten
       end
 
+      def use_stop_marker?
+        stop != NO_MARKER
+      end
     end
   end
 end

data/lib/pebbles-uid/version.rb

@@ -1,5 +1,5 @@
 module Pebbles
   class Uid
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/labels_spec.rb

@@ -13,6 +13,15 @@ describe Pebbles::Uid::Labels do
     subject.size.should eq(3)
   end
 
+  it "knows the next label" do
+    subject.next_label.should eq(:thing_3)
+  end
+
+  it "can use a suffix on the hash" do
+    uid = Pebbles::Uid::Labels.new('a.b.c', :name => 'whatevs', :suffix => 'hey')
+    uid.to_hash.should eq(:whatevs_0_hey => 'a', :whatevs_1_hey => 'b', :whatevs_2_hey => 'c')
+  end
+
   describe "alternate constructors" do
     it { Pebbles::Uid::Labels.new('a', 'b', 'c').to_s.should eq('a.b.c') }
     it { Pebbles::Uid::Labels.new(['a', 'b', 'c']).to_s.should eq('a.b.c') }

data/spec/query_spec.rb

@@ -9,7 +9,7 @@ describe Pebbles::Uid::Query do
 
   context "for a single resource" do
     let(:term) { "post:area51$abc" }
-    subject { Pebbles::Uid::Query.new(term) }
+    subject { Pebbles::Uid::Query.new(term, :suffix => '') }
 
     its(:term) { should == term }
 
@@ -17,6 +17,7 @@ describe Pebbles::Uid::Query do
     its(:list?) { should == false }
     its(:collection?) { should == false }
     its(:cache_keys) { should eq(['post:area51.*$abc']) }
+    its(:to_hash) { should eq(:genus_0_ => 'post', :path_0_ => 'area51', :oid_ => 'abc') }
 
     it "handles a wildcard path if realm is given" do
       query = Pebbles::Uid::Query.new('post:area51.*$abc')
@@ -32,6 +33,10 @@ describe Pebbles::Uid::Query do
       ->{ Pebbles::Uid::Query.new('post:*$abc') }.should raise_error(ArgumentError)
       ->{ Pebbles::Uid::Query.new('post:$abc') }.should raise_error(ArgumentError)
     end
+
+    it "doesn't have a list of uids" do
+      ->{ subject.list }.should raise_error StandardError
+    end
   end
 
   context "for a list of resources" do
@@ -47,7 +52,7 @@ describe Pebbles::Uid::Query do
     context "by oid" do
       subject { Pebbles::Uid::Query.new("post:area51$abc|xyz") }
 
-      its(:terms) { should eq(['post:area51$abc', 'post:area51$xyz']) }
+      its(:list) { should eq(['post:area51$abc', 'post:area51$xyz']) }
 
       it "can't do hashes under these circumstances" do
         ->{ subject.to_hash }.should raise_error(RuntimeError)
@@ -101,6 +106,10 @@ describe Pebbles::Uid::Query do
       its(:oid?) { should == false }
 
       its(:to_hash) { should == {} }
+
+      it "doesn't have a list of uids" do
+        ->{ subject.list }.should raise_error StandardError
+      end
     end
 
     context "everything, with any oid" do
@@ -140,6 +149,23 @@ describe Pebbles::Uid::Query do
       its(:to_hash) { should == {:oid => 'yak'} }
     end
 
+    context "a typical search" do
+      subject { Pebbles::Uid::Query.new('beast:myths.*', :genus => 'klass', :path => 'label', :suffix => '') }
+      its(:to_hash) { should == {:klass_0_ => 'beast', :label_0_ => 'myths'} }
+      its(:next_path_label) { should == :label_1_ }
+    end
+
+    context "with a wildcard path" do
+      subject { Pebbles::Uid::Query.new('beast:myths.scary') }
+      its(:for_one?) { should == false }
+      its(:collection?) { should == true }
+    end
+
+    context "a search with stops" do
+      subject { Pebbles::Uid::Query.new('beast:myths$*', :genus => 'klass', :path => 'label', :suffix => '', :stop => nil) }
+      its(:to_hash) { should == {:klass_0_ => 'beast', :klass_1_ => nil, :label_0_ => 'myths', :label_1_ => nil} }
+      its(:next_path_label) { should == :label_1_ }
+    end
   end
 
 end

data/spec/uid_spec.rb

@@ -7,7 +7,7 @@ describe Pebbles::Uid do
   describe "query" do
     it "returns a query object" do
       s = 'post:tourism.*$*'
-      Pebbles::Uid::Query.should_receive(:new).with s
+      Pebbles::Uid::Query.should_receive(:new).with s, {}
       query = Pebbles::Uid.query(s)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pebbles-uid
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70108731034840 !ruby/object:Gem::Requirement
+  requirement: &70099323387380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70108731034840
+  version_requirements: *70099323387380
 description: Handle pebble UIDs conveniently.
 email:
 - katrina.owen@gmail.com