boombera 0.1.2 → 0.2.0

data/Gemfile

@@ -3,9 +3,9 @@ source "http://rubygems.org"
 gem 'couchrest', '~> 1.0.2'
 
 group :development do
-  gem "rspec", "~> 2.3.0"
+  gem "rspec", "~> 2.6.0"
   gem "bundler", "~> 1.0.0"
-  gem "jeweler", :git => "git://github.com/jwilger/jeweler.git"
+  gem "jeweler", "~> 1.6.1"
   gem "rcov", ">= 0"
   gem "reek", "~> 1.2.8"
   gem "rdoc", "~> 3.6.1"

data/Gemfile.lock

@@ -1,12 +1,3 @@
-GIT
-  remote: git://github.com/jwilger/jeweler.git
-  revision: d7461cba474852ab16d31618e6465b56b00db49e
-  specs:
-    jeweler (1.6.0)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-
 GEM
   remote: http://rubygems.org/
   specs:
@@ -22,6 +13,10 @@ GEM
       rest-client (~> 1.6.1)
     diff-lcs (1.1.2)
     git (1.2.5)
+    jeweler (1.6.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
     json (1.5.1)
     mime-types (1.16)
     rake (0.9.0)
@@ -33,14 +28,14 @@ GEM
       sexp_processor (~> 3.0)
     rest-client (1.6.1)
       mime-types (>= 1.16)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.3)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
+    rspec-mocks (2.6.0)
     ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
@@ -58,8 +53,8 @@ DEPENDENCIES
   autotest-growl (~> 0.2.9)
   bundler (~> 1.0.0)
   couchrest (~> 1.0.2)
-  jeweler!
+  jeweler (~> 1.6.1)
   rcov
   rdoc (~> 3.6.1)
   reek (~> 1.2.8)
-  rspec (~> 2.3.0)
+  rspec (~> 2.6.0)

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/boombera.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{boombera}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger"]
@@ -47,9 +47,9 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<couchrest>, ["~> 1.0.2"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.1"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.6.1"])
@@ -58,9 +58,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<autotest-fsevent>, ["~> 0.2.5"])
     else
       s.add_dependency(%q<couchrest>, ["~> 1.0.2"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.1"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<reek>, ["~> 1.2.8"])
       s.add_dependency(%q<rdoc>, ["~> 3.6.1"])
@@ -70,9 +70,9 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<couchrest>, ["~> 1.0.2"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.1"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<reek>, ["~> 1.2.8"])
     s.add_dependency(%q<rdoc>, ["~> 3.6.1"])

data/lib/boombera.rb

@@ -11,6 +11,7 @@ require 'boombera/information'
 
 class Boombera
   VersionMismatch = Class.new(StandardError)
+  InvalidMapping = Class.new(RuntimeError)
 
   extend Boombera::Information
 
@@ -22,13 +23,19 @@ class Boombera
   end
 
   def put(path, body)
-    content_item = get(path) and content_item.body = body
+    content_item = get(path, :resolve_map => false) and content_item.body = body
     content_item ||= ContentItem.new(path, body, db)
     content_item.save
   end
 
-  def get(path)
-    ContentItem.get(path, db)
+  def get(path, options = {})
+    ContentItem.get(path, db, options)
+  end
+
+  def map(path, source_path)
+    content_map = get(path, :resolve_map => false) || ContentItem.new(path, nil, db)
+    content_map.map_to source_path
+    content_map.save
   end
 
   private

data/lib/boombera/content_item.rb

@@ -1,15 +1,20 @@
 class Boombera::ContentItem < CouchRest::Document
   class << self
-    def get(path, database)
+    def get(path, database, options = {})
       rows = database.view('boombera/content_map', :key => path)['rows']
       return nil if rows.empty?
-      id = rows.first['id']
-      new(database.get(id))
+      match = rows.first
+      maps_to = match['value']
+      if maps_to == path || options[:resolve_map] == false
+        new(database.get(match['id']))
+      else
+        get(maps_to, database)
+      end
     end
   end
 
   attr_accessor :body
-  attr_reader :path
+  attr_reader :path, :maps_to
 
   def initialize(doc_or_path, body = nil, database = nil)
     case doc_or_path
@@ -24,6 +29,22 @@ class Boombera::ContentItem < CouchRest::Document
     end
   end
 
+  def map_to(source_path)
+    rows = @database.view('boombera/content_map', :key => source_path)['rows']
+    if rows.empty?
+      raise Boombera::InvalidMapping,
+        "Tried to map #{path} to #{source_path}, but #{source_path} doesn't exist."
+    else
+      self.body = nil
+      self[:maps_to] = source_path
+    end
+  end
+
+  def referenced_by
+    rows = @database.view('boombera/map_references', :key => path)['rows']
+    rows.map{ |r| r['value'] }.sort
+  end
+
   # :nodoc:
   def path
     self[:path]
@@ -37,5 +58,11 @@ class Boombera::ContentItem < CouchRest::Document
   # :nodoc:
   def body=(new_body)
     self[:body] = new_body
+    self[:maps_to] = path unless new_body.nil?
+  end
+
+  # :nodoc:
+  def maps_to
+    self[:maps_to]
   end
 end

data/lib/boombera/information.rb

@@ -26,7 +26,20 @@ module Boombera::Information
           'map' => <<-EOF
             function(doc) {
               if (doc['path']) {
-                emit(doc.path, doc.path);
+                if (doc['maps_to']) {
+                  emit(doc.path, doc.maps_to);
+                } else {
+                  emit(doc.path, doc.path);
+                }
+              }
+            }
+            EOF
+        },
+        'map_references' => {
+          'map' => <<-EOF
+            function(doc) {
+              if(doc['maps_to'] && doc.maps_to != doc.path) {
+                emit(doc.maps_to, doc.path);
               }
             }
             EOF

data/spec/integration/boombera_spec.rb

@@ -81,6 +81,52 @@ describe 'The Boombera library:' do
       document['path'].should == '/foo'
       document['body'].should == 'the new content'
     end
+
+    it 'turns a pointer into a content item' do
+      boombera.put('/foo', 'foo bar baz')
+      boombera.map('/bar', '/foo')
+      boombera.put('/bar', 'the new content')
+      results = db.view('boombera/content_map', :key => '/bar')['rows']
+      results.length.should == 1
+      document = db.get(results.first['id'])
+      document['path'].should == '/bar'
+      document['body'].should == 'the new content'
+      document['points_to'].should be_nil
+    end
+  end
+
+  describe 'mapping content aliases' do
+    it 'creates a pointer from a path to another path' do
+      boombera.put('/foo', 'foo bar baz')
+      boombera.map('/bar', '/foo')
+      results = db.view('boombera/content_map', :key => '/bar')['rows']
+      results.length.should == 1
+      map_item = results.first
+      map_item['value'].should == '/foo'
+    end
+
+    it 'updates a pointer from a path to another path' do
+      boombera.put('/foo', 'foo bar baz')
+      boombera.put('/spam', 'ham spam can')
+      boombera.map('/bar', '/foo')
+      boombera.map('/bar', '/spam')
+      results = db.view('boombera/content_map', :key => '/bar')['rows']
+      results.length.should == 1
+      map_item = results.first
+      map_item['value'].should == '/spam'
+    end
+
+    it 'turns a content item into a pointer' do
+      boombera.put('/foo', 'foo bar baz')
+      boombera.put('/bar', 'some old bar content')
+      boombera.map('/bar', '/foo')
+      results = db.view('boombera/content_map', :key => '/bar')['rows']
+      results.length.should == 1
+      map_item = results.first
+      map_item['value'].should == '/foo'
+      doc = db.get(map_item['id'])
+      doc['body'].should be_nil
+    end
   end
 
   describe 'getting content from the database' do
@@ -94,6 +140,14 @@ describe 'The Boombera library:' do
       result.path.should == '/index'
       result.body.should == 'Hello, World!'
     end
+
+    it 'gives you the resulting ContentItem when a pointer is requested' do
+      boombera.put('/foo', 'some content')
+      boombera.map('/bar', '/foo')
+      result = boombera.get('/bar')
+      result.path.should == '/foo'
+      result.body.should == 'some content'
+    end
   end
 
   describe 'working with ContentItem' do
@@ -104,5 +158,16 @@ describe 'The Boombera library:' do
       content.save
       boombera.get('/foo').body.should == 'new content'
     end
+
+    it 'knows which pointers reference it' do
+      boombera.put('/foo', 'some content')
+      boombera.map('/zurg', '/foo')
+      boombera.map('/bar', '/foo')
+      boombera.map('/bar/baz', '/foo')
+      boombera.put('/spam', 'spam content')
+      boombera.map('/spam2', '/spam')
+      content = boombera.get('/foo')
+      content.referenced_by.should == ['/bar', '/bar/baz', '/zurg']
+    end
   end
 end

data/spec/lib/boombera/content_item_spec.rb

@@ -4,7 +4,7 @@ describe Boombera::ContentItem do
   describe '.get' do
     context 'with an existing content item' do
       it 'returns a ContentItem instance for the found document' do
-        view_result = {'rows' => [{'id' => '123'}]}
+        view_result = {'rows' => [{'id' => '123', 'value' => '/foo'}]}
         db = mock(CouchRest::Database)
         db.should_receive(:view) \
           .with('boombera/content_map', :key => '/foo') \
@@ -17,6 +17,51 @@ describe Boombera::ContentItem do
         result.body.should == 'bar'
       end
     end
+
+    context 'with a non-existant content item' do
+      it 'returns nil' do
+        view_result = {'rows' => []}
+        db = mock(CouchRest::Database)
+        db.should_receive(:view) \
+          .with('boombera/content_map', :key => '/foo') \
+          .and_return(view_result)
+        Boombera::ContentItem.get('/foo', db).should == nil
+      end
+    end
+
+    context 'with a path that maps to another content item' do
+      it 'returns the mapped content item' do
+        map_view_result = {'rows' => [{'id' => '123', 'value' => '/bar'}]}
+        content_view_result = {'rows' => [{'id' => '456', 'value' => '/bar'}]}
+        db = mock(CouchRest::Database)
+        db.should_receive(:view) \
+          .with('boombera/content_map', :key => '/foo') \
+          .and_return(map_view_result)
+        db.should_receive(:view) \
+          .with('boombera/content_map', :key => '/bar') \
+          .and_return(content_view_result)
+        db.should_receive(:get) \
+          .with('456') \
+          .and_return(CouchRest::Document.new('path' => '/bar', 'body' => 'bar'))
+        result = Boombera::ContentItem.get('/foo', db)
+        result.path.should == '/bar'
+        result.body.should == 'bar'
+      end
+
+      it 'returns the pointer content item when passed the :resolve_map option as false' do
+        map_view_result = {'rows' => [{'id' => '123', 'value' => '/bar'}]}
+        db = mock(CouchRest::Database)
+        db.should_receive(:view) \
+          .with('boombera/content_map', :key => '/foo') \
+          .and_return(map_view_result)
+        db.should_receive(:get) \
+          .with('123') \
+          .and_return(CouchRest::Document.new('path' => '/foo', 'maps_to' => '/bar'))
+        result = Boombera::ContentItem.get('/foo', db, :resolve_map => false)
+        result.path.should == '/foo'
+        result.maps_to.should == '/bar'
+      end
+    end
   end
 
   describe '.new' do
@@ -52,10 +97,58 @@ describe Boombera::ContentItem do
   end
 
   describe '#body=' do
+    let(:db) { stub(CouchRest::Database) }
+    let(:content) { Boombera::ContentItem.new('/foo', 'not bar', db) }
+
     it 'overwrites the current contents of the document body' do
-      content = Boombera::ContentItem.new('/foo', 'not bar')
       content.body = 'bar'
       content.body.should == 'bar'
     end
+
+    it 'sets the maps_to attribute equal to the path attribute if argument is not nil' do
+      db.stub!(:view => {'rows' => [{'value' => '/foo'}]})
+      content.map_to '/bar'
+      content.body = 'something'
+      content.maps_to.should == '/foo'
+    end
+
+    it 'does not change the maps_to attribute if the argument is nil' do
+      db.stub!(:view => {'rows' => [{'value' => '/foo'}]})
+      content.map_to '/bar'
+      content.body = nil
+      content.maps_to.should == '/bar'
+    end
+  end
+
+  describe '#map_to' do
+    context 'the source content item does not exist' do
+      it 'raises an InvalidMapping exception' do
+        db = stub(CouchRest::Database)
+        db.stub!(:view => {'rows' => []})
+        content = Boombera::ContentItem.new('/bar', nil, db)
+        lambda { content.map_to('/foo') }.should \
+          raise_error(Boombera::InvalidMapping, "Tried to map /bar to /foo, but /foo doesn't exist.")
+      end
+    end
+
+    context 'the source content item is a normal content item' do
+      let(:db) { stub(CouchRest::Database) }
+      let(:content) { Boombera::ContentItem.new('/bar', 'foo bar', db) }
+
+      before(:each) do
+        db.should_receive(:view) \
+          .with('boombera/content_map', :key => '/foo') \
+          .and_return({'rows' => [{'value' => '/foo'}]})
+        content.map_to '/foo'
+      end
+
+      it 'sets the maps_to attribute to the path of the source content' do
+        content.maps_to.should == '/foo'
+      end
+
+      it 'sets the body attribute to nil' do
+        content.body.should be_nil
+      end
+    end
   end
 end

data/spec/lib/boombera_spec.rb

@@ -7,6 +7,9 @@ describe Boombera do
     db
   end
 
+  let(:content_item) { stub(Boombera::ContentItem) }
+  let(:boombera) { Boombera.new('boombera_test') }
+
   before(:each) do
     Boombera.stub!(:version => '1.2.3')
     Boombera.stub!(:database_version => '1.2.3')
@@ -35,30 +38,25 @@ describe Boombera do
   end
 
   describe '#put' do
-    let(:content_item) { mock(Boombera::ContentItem) }
-    let(:content_item_save_expectations) do
-      lambda {
-        content_item.should_receive(:save).and_return(true)
-        boombera = Boombera.new('boombera_test')
-        boombera.put('/foo', 'bar').should == true
-      }
-    end
-
     context "to an existing path" do
       it 'updates and saves the existing content item' do
-        Boombera::ContentItem.should_receive(:get).with('/foo', db).and_return(content_item)
+        Boombera::ContentItem.should_receive(:get) \
+          .with('/foo', db, :resolve_map => false) \
+          .and_return(content_item)
         content_item.should_receive(:body=).with('bar')
-        content_item_save_expectations.call
+        content_item.should_receive(:save).and_return(true)
+        boombera.put('/foo', 'bar').should == true
       end
     end
 
     context "to a new path" do
-      it 'creates and saves the existing content item' do
+      it 'creates and saves the content item' do
         Boombera::ContentItem.stub!(:get => nil)
         Boombera::ContentItem.should_receive(:new) \
           .with('/foo', 'bar', db) \
           .and_return(content_item)
-        content_item_save_expectations.call
+        content_item.should_receive(:save).and_return(true)
+        boombera.put('/foo', 'bar').should == true
       end
     end
   end
@@ -66,12 +64,52 @@ describe Boombera do
   describe '#get' do
     it 'gets the content item at the specified path from the current database' do
       db.as_null_object
-      Boombera::ContentItem.should_receive(:get).with('/foo', db)
-      boombera = Boombera.new('boombera_test')
+      Boombera::ContentItem.should_receive(:get).with('/foo', db, {})
       boombera.get('/foo')
     end
   end
 
+  describe '#map' do
+    context 'to a new path' do
+      before(:each) do
+        Boombera::ContentItem.stub!(:get)
+        Boombera::ContentItem.should_receive(:new).with('/bar', nil, db).and_return(content_item)
+      end
+
+      it 'creates and saves ContentItem as pointer' do
+        content_item.should_receive(:map_to).with('/foo')
+        content_item.should_receive(:save).and_return(true)
+        boombera.map('/bar', '/foo').should == true
+      end
+
+      it 'raises an InvalidMapping exception if the source document does not exist' do
+        content_item.stub!(:map_to).and_raise(Boombera::InvalidMapping)
+        lambda { boombera.map('/bar', '/foo') }.should \
+          raise_error(Boombera::InvalidMapping)
+      end
+    end
+
+    context 'to an existing path' do
+      before(:each) do
+        Boombera::ContentItem.should_receive(:get) \
+          .with('/bar', db, :resolve_map => false) \
+          .and_return(content_item)
+      end
+
+      it 'updates ContentItem as pointer' do
+        content_item.should_receive(:map_to).with('/foo')
+        content_item.should_receive(:save).and_return(true)
+        boombera.map('/bar', '/foo').should == true
+      end
+
+      it 'raises an InvalidMapping exception if the source document does not exist' do
+        content_item.stub!(:map_to).and_raise(Boombera::InvalidMapping)
+        lambda { boombera.map('/bar', '/foo') }.should \
+          raise_error(Boombera::InvalidMapping)
+      end
+    end
+  end
+
   describe '.install_design_doc!' do
     context 'when the design doc does not yet exist' do
       it 'creates the design doc on the specified database' do

metadata

@@ -2,7 +2,7 @@
 name: boombera
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - John Wilger
@@ -31,7 +31,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.3.0
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: *id002
@@ -51,9 +51,9 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: *id004
@@ -165,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2330631431022327628
+      hash: -941585902333991149
       segments: 
       - 0
       version: "0"