pebbles-uid 0.0.15 → 0.0.16

data/README.md

@@ -43,6 +43,31 @@ There are currently two characters which cannot be included in an oid:
 
 Oid is optional when creating a new resource.
 
+## Relations
+
+A convention has emerged where the path of an object who belongs in a category
+is built up using the category's path, with the category's oid, appended.
+
+I.e.
+
+```ruby
+category = Pebbles::Uid.new('post.doc:edu.uni.abc$123')
+thing = Pebbles::Uid.new('course:edu.uni.abc.123$456')
+
+thing.parent
+# => 'course:edu.uni.abc$123'
+thing.parent('post.doc')
+# => 'post.doc:edu.uni.abc$123'
+
+category.child_path
+# => 'edu.uni.abc.123'
+
+category.children
+# => '*:edu.uni.abc.123'
+category.children('post.subcategory')
+# => 'post.subcategory:edu.uni.abc.123'
+```
+
 ## Queries
 
 ### For one specific resource

data/lib/pebbles-uid.rb

@@ -104,5 +104,9 @@ module Pebbles
       "#{path}.#{oid}"
     end
 
+    def children(child_species = '*')
+      "#{child_species}:#{child_path}"
+    end
+
   end
 end

data/lib/pebbles-uid/query.rb

@@ -27,7 +27,7 @@ module Pebbles
       end
 
       def for_one?
-        !wildcard_query? && !list?
+        oid?
       end
 
       def list?
@@ -42,7 +42,7 @@ module Pebbles
       end
 
       def collection?
-        wildcard_query?
+        !for_one? && !list?
       end
 
       def path?

data/lib/pebbles-uid/version.rb

@@ -1,5 +1,5 @@
 module Pebbles
   class Uid
-    VERSION = "0.0.15"
+    VERSION = "0.0.16"
   end
 end

data/spec/uid_spec.rb

@@ -155,6 +155,11 @@ describe Pebbles::Uid do
 
     its(:child_path) { should eq('tourism.norway.fjords.1234') }
 
+    its(:children) { should eq('*:tourism.norway.fjords.1234')}
+    it "has children of a certain species" do
+      subject.children('stuff').should eq('stuff:tourism.norway.fjords.1234')
+    end
+
     its(:cache_key) { should eq('post.card:tourism.*$1234') }
 
     its(:to_hash) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pebbles-uid
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70332659041680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70332659041680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Handle pebble UIDs conveniently.
 email:
 - katrina.owen@gmail.com
@@ -72,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Unique identifiers in the Pebblestack universe, in the format species[.genus]:path$oid,
@@ -85,4 +90,3 @@ test_files:
 - spec/roots_spec.rb
 - spec/uid_spec.rb
 - spec/wildcard_spec.rb
-has_rdoc: