boombera 0.2.0 → 0.2.1

data/README.rdoc

@@ -1,16 +1,63 @@
-= boombera
+= Boombera
 
-Description goes here.
+Boombera is a CouchDB-backed content repository aimed at multi-stage,
+multi-tenant web applications. If your application supports multiple customers,
+allows each customer to customize the content within their context, and goes
+through a staged deployment process (alpha -> beta -> staging -> production,
+etc.), then the Boombera content store can help you manage content that can be
+inherited and possibly overridden down hierarchies of both customer and
+environment.
 
-== Contributing to boombera
+== What Boombera Isn't
+
+Boombera does not provide a GUI for managing content; it is *not* a CMS.
+However, it does provide the code level interface for inserting content into the
+database, so you could build a CMS on top of it.
+
+Currently, Boombera does not attempt to understand the semantics of your
+customer and deployment hierarchies. While you can map one content path to
+another via the API, both your CMS and your consuming application must have
+knowledge of these hierarchies and how they map to your content paths. This
+hierarchy-awareness may be added to a future version of Boombera.
+
+== Why Use Boombera
+
+One of the major advantages of Boombera is CouchDB itself. CouchDB's excellent
+replication makes it easy to have your CMS update content on it's local CouchDB
+instance and have that content pushed out to replica databases on your
+application servers. This means you don't need to communicate over the network
+every time your application needs to fetch content.
+
+Because CouchDB can replicate bi-directionally, it should also be possible to
+support edit-in-place features within your application while still having that
+content pushed back to your CMS and to any additional application servers.
+Another application of this is to allow developers to work off-line, updating
+content that is tied to the features they are working on, and then have that
+updated content replicated back to the shared development infrastructure once
+they are finished.
+
+Boombera's content-mapping functionality reduces both the size of the database
+and the necessary network traffic for database updates when much of the content
+is identical between customers and/or deployment stages.
+
+== Usage Examples
+
+See the documentation on the Boombera class.
+
+== Contributing to Boombera
  
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/boombera.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{boombera}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger"]

data/lib/boombera.rb

@@ -1,15 +1,10 @@
 $:.unshift(File.expand_path(File.dirname(__FILE__)))
 require 'couchrest'
 
-# Boombera constant is defined first as `Class.new` so that the definitions in
-# the required files can use `class Boombera::Whatever` even with the `require`
-# statements appearing before the actual class definition.
-Boombera = Class.new
-
-require 'boombera/content_item'
-require 'boombera/information'
-
 class Boombera
+  require 'boombera/content_item'
+  require 'boombera/information'
+
   VersionMismatch = Class.new(StandardError)
   InvalidMapping = Class.new(RuntimeError)
 
@@ -41,7 +36,7 @@ class Boombera
   private
 
   def check_database_version!
-    database_version ||= Boombera.database_version(db)
+    database_version = Boombera.database_version(db)
     unless Boombera.version == database_version
       msg = if database_version.nil?
               "Database does not specify a Boombera version"

data/lib/boombera/content_item.rb

@@ -1,16 +1,36 @@
 class Boombera::ContentItem < CouchRest::Document
-  class << self
-    def get(path, database, options = {})
-      rows = database.view('boombera/content_map', :key => path)['rows']
-      return nil if rows.empty?
-      match = rows.first
-      maps_to = match['value']
-      if maps_to == path || options[:resolve_map] == false
-        new(database.get(match['id']))
+  class MapResolver
+    def initialize(path, database, options = {})
+      @path = path
+      @database = database
+      @final_attempt = options[:resolve_map] == false
+    end
+
+    def resolve
+      id, maps_to = content_map
+      return if id.nil?
+      if @final_attempt || maps_to == @path
+        Boombera::ContentItem.new(@database.get(id))
       else
-        get(maps_to, database)
+        @path = maps_to
+        resolve
       end
     end
+
+    private
+
+    def content_map
+      rows = @database.view('boombera/content_map', :key => @path)['rows']
+      return if rows.empty?
+      match = rows.first
+      [match['id'], match['value']]
+    end
+  end
+
+  class << self
+    def get(path, database, options = {})
+      MapResolver.new(path, database, options).resolve
+    end
   end
 
   attr_accessor :body
@@ -42,7 +62,7 @@ class Boombera::ContentItem < CouchRest::Document
 
   def referenced_by
     rows = @database.view('boombera/map_references', :key => path)['rows']
-    rows.map{ |r| r['value'] }.sort
+    rows.map{ |row| row['value'] }.sort
   end
 
   # :nodoc:

metadata

@@ -2,7 +2,7 @@
 name: boombera
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - John Wilger
@@ -165,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -941585902333991149
+      hash: -422599235011708873
       segments: 
       - 0
       version: "0"