couch_visible 0.0.2 → 0.1.1

data/readme.markdown

@@ -9,64 +9,77 @@ It's a gem. Either run `gem install couch_visible` at the command line, or add `
 ## Usage
 
 The gem provides a mixin `CouchVisible` for your `CouchRest::Model::Base` derived documents:
-  
-    class Article < CouchRest::Model::Base
-      include CouchVisible
-    end
+
+```ruby
+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
+
+```ruby
+class Article < CouchRest::Model::Base
+  include CouchVisible
+  show_by_default!
+end
+```
 
 You can also configure this globally:
   
-    CouchVisible.show_by_default!
+```ruby
+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
-
+```ruby
+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
+```ruby
+a = Article.first
 
-    a.hide! 
-      #==> sets the couch_visible property to false and saves the document 
+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
+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
+```ruby
+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
+```ruby
+hidden_article = Article.create
+hidden_article.hide!
 
-You can use all of the typical options you would normally use in your `view_by`-created methods. 
+Article.map_by_hidden.get!
+Article.count_by_hidden.get!
+Article.map_by_shown.get!
+Article.count_by_shown.get!
+```
+
+You can use all of the typical CouchDB options you would normally use in your queries. If you're unfamiliar with this format, checkout the `couch_view` gem, which `couch_visible` depends on: http://github.com/moonmaster9000/couch_view
 
 ## CouchPublish / Memories Integration
 
@@ -74,45 +87,69 @@ The `couch_visible` integrates nicely with the `couch_publish` and `memories` ge
 
 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
+```ruby
+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 = Article.create :title => "The Mavs spank the Heat"
 
-    a.publish!
+a.hidden? 
+  #==> true
 
-    a.version
-      #==> 2
+a.publish!
 
+a.version
+  #==> 2
+```
 
 Our document is published, but hidden. Now let's unhide the document:
 
-    a.show!
-    
-    a.version 
-      #==> 3
+```ruby
+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"
+```ruby
+a.title
+  #==> "The spank the Heat in game 6"
 
-    a.publish!
+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! 
+```ruby
+a.published_versions.first.publish! 
+
+a.hidden?
+  #==> false
+```
+
+So even though you've reverted back to version 2, your document is still visible. 
+
+### Filtering your views by published and unpublished
+
+Another nice integration: when you include `CouchVisible` into a model that already includes `CouchPublish`, you'll be able to filter your `map_by_hidden`/`count_by_hidden`/`map_by_shown`/`count_by_shown` queries for `published` and `unpublished` documents: 
+
+```ruby
+class Article < CouchRest::Model::Base
+  include CouchPublish
+  include CouchVisible
+end
 
-    a.hidden?
-      #==> false
+Article.map_by_shown.published.get!
+  #==> all of the shown and published Article documents
 
-So even though you've revert back to version 2, your document is still visible. 
+Article.count_by_hidden.unpublished.get!
+  #==> all of the hidden documents that have never been published
+```

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couch_visible
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
-  - 0
-  - 2
-  version: 0.0.2
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 -04:00
-default_executable: 
+date: 2011-08-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
@@ -61,7 +60,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: memories
+  name: couch_publish
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -90,6 +89,22 @@ dependencies:
         version: 1.0.0
   type: :runtime
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: couch_view
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id006
 description: Specify whether or not a document is visible.
 email: moonmaster9000@gmail.com
 executables: []
@@ -99,20 +114,30 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/couch_visible.rb
-- lib/couch_visible.rbc
+- lib/couch_visible/conditions/published.rb
+- lib/couch_visible/conditions/unpublished.rb
 - lib/couch_visible/config.rb
 - lib/couch_visible/config.rbc
 - lib/couch_visible/couch_visible.rb
 - lib/couch_visible/couch_visible.rbc
+- lib/couch_visible/integrations/couch_publish.rb
+- lib/couch_visible/maps/by_hidden.rb
+- lib/couch_visible/maps/by_hidden.rbc
+- lib/couch_visible/maps/by_shown.rb
+- lib/couch_visible/maps/by_shown.rbc
+- lib/couch_visible.rb
+- lib/couch_visible.rbc
 - VERSION
 - readme.markdown
 - features/configuration.feature
+- features/couch_publish_integration.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/couch_publish_integration.rb
+- features/step_definitions/couch_publish_integration.rbc
 - features/step_definitions/hide_steps.rb
 - features/step_definitions/hide_steps.rbc
 - features/step_definitions/memories_integration_steps.rb
@@ -121,7 +146,6 @@ files:
 - 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: []
 
@@ -151,17 +175,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Is a document visible?
 test_files: 
 - features/configuration.feature
+- features/couch_publish_integration.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/couch_publish_integration.rb
+- features/step_definitions/couch_publish_integration.rbc
 - features/step_definitions/hide_steps.rb
 - features/step_definitions/hide_steps.rbc
 - features/step_definitions/memories_integration_steps.rb