couch_visible 0.0.1 → 0.0.2

data/lib/couch_visible.rb

@@ -0,0 +1,2 @@
+require 'couch_visible/couch_visible'
+require 'couch_visible/config'

data/lib/couch_visible.rbc

@@ -0,0 +1,69 @@
+!RBIX
+17831730954501249321
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+20
+5
+7
+0
+64
+47
+49
+1
+1
+15
+5
+7
+2
+64
+47
+49
+1
+1
+15
+2
+11
+I
+2
+I
+0
+I
+0
+I
+0
+n
+p
+3
+s
+27
+couch_visible/couch_visible
+x
+7
+require
+s
+20
+couch_visible/config
+p
+5
+I
+0
+I
+1
+I
+9
+I
+2
+I
+14
+x
+61
+/Users/mparker/work/github/couch_visible/lib/couch_visible.rb
+p
+0

data/readme.markdown

@@ -0,0 +1,118 @@
+# CouchVisible
+
+CouchVisible is a mixin for your CouchRest::Model documents that provides a simple API for specifying the visibility of a document. This comes in handy in content publishing systems where you want to be able to hide and show documents on your website.  
+
+## Installation
+
+It's a gem. Either run `gem install couch_visible` at the command line, or add `gem 'couch_visible'` to your Gemfile.
+
+## Usage
+
+The gem provides a mixin `CouchVisible` for your `CouchRest::Model::Base` derived documents:
+  
+    class Article < CouchRest::Model::Base
+      include CouchVisible
+    end
+
+### Hidden by default
+
+Mixing it into your document will create a boolean "couch_visible" property on your document. By default, documents will be hidden; if you'd prefer your documents to be visible by default, simply use the `show_by_default!` macro: 
+    
+    class Article < CouchRest::Model::Base
+      include CouchVisible
+      show_by_default!
+    end
+
+You can also configure this globally:
+  
+    CouchVisible.show_by_default!
+
+Now, all document models that include CouchVisible will be shown by default. They could override the global default by calling "hide_by_default!":
+
+    class Post < CouchRest::Model::Base
+      include CouchVisible
+      hide_by_default!
+    end
+
+
+### Showing and Hiding Documents
+
+`CouchVisible` lets you toggle the visibility of documents via `show!` and `hide!` methods:
+    
+    a = Article.first
+
+    a.hide! 
+      #==> sets the couch_visible property to false and saves the document 
+
+    a.show!
+      #==> sets the couch_visible property to true and saves the document
+
+You can also ask whether the document is currently `hidden?` or `shown?`:
+    
+    a = Article.first
+    a.hide!   
+    a.shown?  #==> false
+    a.hidden? #==> true
+
+### Fetching Hidden/Shown documents
+
+Lastly, when you mixed `CouchVisible` into your document, a new map/reduce was created for your document that allows you to easily find shown and hidden documents:
+
+    hidden_article = Article.create
+    hidden_article.hide!
+    
+    Article.by_hidden
+    Article.count_hidden
+    Article.by_shown 
+    Article.count_shown
+
+You can use all of the typical options you would normally use in your `view_by`-created methods. 
+
+## CouchPublish / Memories Integration
+
+The `couch_visible` integrates nicely with the `couch_publish` and `memories` gems for versioning / publishing. If you mix `Memories` or `CouchPublish` into your document, then mix `CouchVisible` into it, then `CouchVisible` will create an unversioned `couch_visible` property, so that reverting versions won't unintentionally toggle the visibility of the document.   
+
+For example, let's create a document with several versions, then inspect that state of `couch_visible` after reverting:
+
+    class Article < CouchRest::Model::Base
+      include Publish
+      include CouchVisible
+      
+      property :title
+    end
+
+    a = Article.create :title => "The Mavs spank the Heat"
+    
+    a.hidden? 
+      #==> true
+
+    a.publish!
+
+    a.version
+      #==> 2
+
+
+Our document is published, but hidden. Now let's unhide the document:
+
+    a.show!
+    
+    a.version 
+      #==> 3
+
+Now the document is shown. Presumably, it would start showing up on the website.
+
+Next, let's imagine our editor wanted to make the title more specific. You update the title and republish: 
+
+    a.title
+      #==> "The spank the Heat in game 6"
+
+    a.publish!
+
+The editor's boss wasn't happy with the change; they ask you to revert back to the old title. Here's where it gets interesting. If `memories` had versioned the `couch_visible` boolean property, then reverting back to version `2` would hide the document again. But since `CouchVisible` detected that you were using `Memories` or `CouchPublish`, it created the `couch_visible` property as a non-versioned property.  
+
+    a.published_versions.first.publish! 
+
+    a.hidden?
+      #==> false
+
+So even though you've revert back to version 2, your document is still visible. 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couch_visible
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-18 00:00:00 -04:00
+date: 2011-07-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,8 +98,29 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- lib/couch_visible.rb
+- lib/couch_visible.rbc
+- lib/couch_visible/config.rb
+- lib/couch_visible/config.rbc
+- lib/couch_visible/couch_visible.rb
+- lib/couch_visible/couch_visible.rbc
+- VERSION
+- readme.markdown
+- features/configuration.feature
+- features/hide.feature
+- features/memories_integration.feature
+- features/show.feature
+- features/step_definitions/configuration_steps.rb
+- features/step_definitions/configuration_steps.rbc
+- features/step_definitions/hide_steps.rb
+- features/step_definitions/hide_steps.rbc
+- features/step_definitions/memories_integration_steps.rb
+- features/step_definitions/memories_integration_steps.rbc
+- features/step_definitions/show_steps.rb
+- features/step_definitions/show_steps.rbc
+- features/support/env.rb
+- features/support/env.rbc
 has_rdoc: true
 homepage: http://github.com/moonmaster9000/couch_visible
 licenses: []
@@ -134,5 +155,18 @@ rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Is a document visible?
-test_files: []
-
+test_files: 
+- features/configuration.feature
+- features/hide.feature
+- features/memories_integration.feature
+- features/show.feature
+- features/step_definitions/configuration_steps.rb
+- features/step_definitions/configuration_steps.rbc
+- features/step_definitions/hide_steps.rb
+- features/step_definitions/hide_steps.rbc
+- features/step_definitions/memories_integration_steps.rb
+- features/step_definitions/memories_integration_steps.rbc
+- features/step_definitions/show_steps.rb
+- features/step_definitions/show_steps.rbc
+- features/support/env.rb
+- features/support/env.rbc