publishus 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,17 +1,103 @@
 = publishus
 
-Description goes here.
+== Introduction
 
-== Note on Patches/Pull Requests
+At this stage this is purely an experimental piece of work to help me understand more of everything. It came about because of our need for a generic publishing framework to support the following needs:
+
+* Allow for editing of generic content whilst retaining all the revision history
+* Allow for publishing individual content items when theyre ready to go live
+* Allow publishing of all unpublished content at once
+
+== Implementation
+
+We looked at some of the versioning frameworks, all of them seemed capable but we saw none that really addressed publishing as such. The one that stood out was <tt>vestal_versions</tt>[http://github.com/laserlemon/vestal_versions] so we used that as our starting point. This is an extremely thin layer on top of the excellent <tt>vestal_versions</tt>[http://github.com/laserlemon/vestal_versions]. Vestal versions handles all of the revisioning off to another table and some really nice features but we needed a way to track publishing itself hence some additional attributes on our models and some extra methods. The basic idea is that all publishable items gain a <tt>named_scope</tt> called <tt>published</tt> which will filter down the results to only include items that are currently considered "live". Each instance gains a <tt>live</tt> method that will return the current live version of that object. For now when using the named_scope you've got to call a proxy extension called <tt></tt> live. The named_scope returns items that have a published version and the live method actually reverts the items to those versions.
+
+== Installation
+
+Prerequisites:
+
+publishus requires vestal_versions by laserlemon
+Follow instructions on installing <tt>vestal_versions</tt>[http://github.com/laserlemon/vestal_versions] first
+
+Install the gem:
+
+  gem install publishus
+
+In <tt>environment.rb</tt>:
+
+  Rails::Initializer.run do |config|
+    ...
+    config.gem 'publishus'
+    ...
+  end
+
+At your application root, run:
+
+  $ sudo rake gems:install
+
+== Example
+
+To version and activate publishing add this to your models:
+
+  class Post < ActiveRecord::Base
+    publishable
+    has_many :comments
+  end
+
+  class Comment < ActiveRecord::Base
+    publishable
+    belongs_to :page
+  end
+
+And add some fields to your tables in a migration (hopefully we'll automate this stuff later):
+
+  add_column :posts, :published_at, :datetime
+  add_column :posts, :deleted_at, :datetime
+  add_column :comments, :published_at, :datetime
+  add_column :comments, :deleted_at, :datetime
+
+Using it:
+
+  >> page = Page.create(:name => "Page 1")
+  => #<Page id: 1, name: "Page 1">
+  >> page.version	
+  => 1 (this bit is vestal versions magic)
+  >> page.publish!
+  => true
+  >> page.update_attribute(:name, "Page 2")
+  => true
+  >> page
+  => #<Page id: 1, name: "Page 2">
+  >> page.live
+  => #<Page id: 1, name: "Page 1">
+  >> Page.published.live
+  => [#<Page id: 1, name: "Page 1">]
+
+And for associations
+
+  >> page.comments.create(:body => "Great page")
+  => #<Comment id: 1, body: "Great page">
+  >> page.comments.published
+  => []
+  >> page.comments.first.publish!
+  => true
+  >> page.comments.published.live
+  => [#<Comment id: 1, body: "Great page">]
+  >> page.comments.first.update_attribute(:body, "Just an ok page")
+  => true
+  >> page.comments.create(:body => "Another comment")
+  => #<Comment id: 2, body: "Another comment">
+  >> page.comments
+  => [#<Comment id: 1, body: "Just an ok page">, #<Comment id: 2, body: "Another comment">]
+  >> page.comments.published.live
+  => [#<Comment id: 1, body: "Great page">]
+
+
+== Notes
  
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* I really would't use this, its not tested and its not finished
+* If you're interested in helping out or know of something that already does this then let me know
 
 == Copyright
 
-Copyright (c) 2010 lostboy. See LICENSE for details.
+Copyright (c) 2010 lostboy. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/publishus.rb

@@ -45,7 +45,7 @@ module Publishus
     end
 
     def destroy(real=false)
-      self.update_attribute(:deleted_at, Time.now) unless real then super.destroy
+      self.update_attribute(:deleted_at, Time.now)
     end
     
     def publish!(time=nil)

data/publishus.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{publishus}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["lostboy"]
-  s.date = %q{2010-04-30}
+  s.date = %q{2010-05-18}
   s.description = %q{Publishus allows active record models and associations to be published and exist both in a 'current' and 'live' state}
   s.email = %q{paul.crabtree@gmail.com}
   s.extra_rdoc_files = [
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/lostboy/publishus}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{An experimental publishing structure on top of vestal versions}
   s.test_files = [
     "test/helper.rb",
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
       s.add_runtime_dependency(%q<vestal_versions>, ["= 1.0.2"])
     else

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: publishus
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - lostboy
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-30 00:00:00 +07:00
+date: 2010-05-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: vestal_versions
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 1
         - 0
@@ -73,23 +78,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: An experimental publishing structure on top of vestal versions