couch_publish 0.0.2 → 0.0.3

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/readme.markdown

@@ -0,0 +1,67 @@
+# Introduction
+
+Powerful, easy-to-use publishing logic, for couchdb documents. Relies on the `memories` gem for versioning. 
+
+## Installation
+
+This be a gem. Install it.
+
+    # gem install couch_publish
+
+Then, include `CouchPublish` in your `CouchRest::Model::Base` derived classes.
+
+    class Article < CouchRest::Model::Base
+      include CouchPublish
+
+      property :title
+      property :author
+      property :body
+    end
+## Publishing
+
+Wanna publish a document? Awesome. There's a `publish!` method. First, save your document, then `publish!` it!
+  
+    @article = Article.create :title => 'Publishing made simple!', :author => 'moonmaster9000', :body => 'CouchPublish makes publishing simple'
+    @article.publish!
+
+Wanna know if the current version of your document is published? Simple!
+
+    @article.published? #==> true, since the current version is published
+
+## Drafts
+
+So you've published a document. Now you want to make some more changes, but your not ready to publish those. Simple!
+
+    @article.title = 'Publishing gets simpler'
+    @article.save
+    @article.draft? #==> true
+    @article.previously_published? # ==> true
+
+## Drafts are cool, but how do I go back to the published version?
+
+But, you ask, how do you access the last published version of your document? Simple!
+
+    @article.last_published_version #==> an instance of the last published version
+
+But, you ask, how do you access an array of all the published versions of your document? Simple!
+
+    @article.published_versions #==> an array of Memories::MilestoneProxy's of all the published versions.  
+    @article.published_versions.first.revision #==> 'rev-2-jklfdsjklfdsjalkfdsa'
+    @article.published_versions.first.version_number #==> 2
+    @article.published_versions.first.instance #==> an instance of the first published version
+
+## Accessing the old published version is nice, but I want to discard the draft and revert back to the last published version
+
+Discard the working draft, you say? Simple!
+
+    @article.discard_draft! #==> reverts the document back to the last published state and saves
+    @article.published? # ==> true, since the current version is now published
+    
+But, you say, what if I want to discard the working draft and revert back to the last published state, but I want to save it on my own, and optionally publish the reversion? Simple!
+
+    @article.discard_draft #==> reverts the document back to the last published state, but doesn't save
+    @article.published? # ==> false, since the current version, though reverted, has not been saved
+    @article.save 
+    @article.published? # ==> false! it's up to you now to decide if/when you publish this reversion.
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couch_publish
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Matt Parker
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 -05:00
-default_executable: 
+date: 2011-07-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: memories
@@ -26,14 +25,28 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 31
         segments: 
         - 0
         - 3
-        - 3
-        version: 0.3.3
+        - 6
+        version: 0.3.6
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Rides on top of the `memories` gem to add simple publishing functionality with rollback and preview support.
 email: moonmaster9000@gmail.com
 executables: []
@@ -43,11 +56,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/couch_publish.rb
 - lib/couch_publish/couch_publish.rb
+- lib/couch_publish.rb
+- VERSION
+- readme.markdown
 - spec/lib/couch_publish_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/moonmaster9000/couch_publish
 licenses: []
 
@@ -77,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Publishing functionality for couchdb documents.