mongoid_publishable 1.0.0

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/growl'

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongoid_publishable.gemspec
+gemspec
+
+gem 'database_cleaner'
+gem 'rspec'
+gem 'autotest'
+gem 'autotest-growl'
+gem 'mongoid', '2.0.0.rc.8'
+gem 'bson_ext'
+gem 'mongoid-rspec'

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    mongoid_publishable (0.9.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.5)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-growl (0.2.9)
+    bson (1.2.4)
+    bson_ext (1.2.4)
+    builder (2.1.2)
+    database_cleaner (0.6.6)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    mongo (1.2.4)
+      bson (>= 1.2.4)
+    mongoid (2.0.0.rc.8)
+      activemodel (~> 3.0)
+      mongo (~> 1.2)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    mongoid-rspec (1.4.1)
+      mongoid (~> 2.0.0.rc.7)
+      mongoid-rspec
+      rspec (~> 2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    tzinfo (0.3.25)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  autotest-growl
+  bson_ext
+  database_cleaner
+  mongoid (= 2.0.0.rc.8)
+  mongoid-rspec
+  mongoid_publishable!
+  rspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/mongoid/publishable.rb

@@ -0,0 +1,52 @@
+module Mongoid
+  module Publishable
+    def self.included(base)
+      base.field :published_at, :type => DateTime, :default => nil
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      def scheduled
+        where(:published_at => {'$gt' => Time.now}).asc(:published_at)
+      end
+
+      def published
+        where(:published_at => {'$lte' => Time.now}).desc(:published_at)
+      end
+
+      def drafts
+        where(:published_at => nil).desc(:published_at)
+      end
+    end
+
+    module InstanceMethods
+      def is_scheduled?
+        return true if self.published_at && self.published_at > Time.now
+        false
+      end
+
+      def is_published?
+        return true if self.published_at && self.published_at <= Time.now
+        false
+      end
+
+      def is_draft?
+        return true if self.published_at.nil?
+        false
+      end
+
+      def schedule!(time)
+        update_attributes(:published_at => time)
+      end
+
+      def publish!
+        update_attributes(:published_at => Time.now)
+      end
+
+      def unpublish!
+        update_attributes(:published_at => nil)
+      end
+    end
+  end
+end

data/lib/mongoid/publishable/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Publishable
+    VERSION = "1.0.0"
+  end
+end

data/lib/mongoid_publishable.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'mongoid/publishable')

data/mongoid_publishable.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid/publishable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_publishable"
+  s.version     = Mongoid::Publishable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nicholas Bruning"]
+  s.email       = ["nicholas@bruning.com.au"]
+  s.homepage    = "http://github.com/thetron/mongoid_publishable"
+  s.summary     = %q{Add publishable behaviours to mongoid models.}
+  s.description = %q{This gem adds some fields, scopes and methods to simplify and declutter your models that need to be drafted and published.}
+
+  s.rubyforge_project = "mongoid_publishable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/readme.md

@@ -0,0 +1,48 @@
+# Mongoid Publishable
+
+Make no mistakes - this is a simple gem. Turned out
+[we](http://involved.com.au) use this sort of behaviour _a lot_ on our
+projects, so just broke out into a gem for simplicity.
+
+## What does it do?
+
+The gem add some fields, scopes and methods to your models which you
+want to be able to publish and unpublish. You know, things like blog
+posts and junk like that.
+
+## Getting started
+
+Add the gem to your Gemfile:
+
+    gem 'mongoid_publishable'
+
+And update your bundle:
+
+    $ bundle update
+
+## Installation
+
+In your model just add the following line, like you would with any
+other mongoid model extension:
+
+    include Mongoid::Publishable
+
+## Putting it to good use
+
+Your models will now have a `published_at` date as well as these
+instance methods (they should be self-explanatory):
+
+    is_scheduled?
+    is_published?
+    is_draft?
+    schedule!(date_time)
+    publish!
+    unpublish!
+
+Additionally, you get a couple of scopes to help find what you're
+looking for:
+
+    ModelName.scheduled # returns all scheduled models (published_at is
+in the future)
+    ModelName.published # returns all published models
+    ModelName.drafts # returns all unpublished models

data/spec/mongoid/publishable_spec.rb

@@ -0,0 +1,94 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+class Post
+  include Mongoid::Document
+  include Mongoid::Publishable
+  field :title
+end
+
+describe Mongoid::Publishable do
+  before :each do
+    @draft = Post.create(:published_at => nil)
+    @published = Post.create(:published_at => Time.now - 5.minutes)
+    @scheduled = Post.create(:published_at => Time.now + 12.hours)
+  end
+
+  it "should have a date and timestamp to represent publish state" do
+    Post.should have_field(:published_at).of_type(DateTime).with_default_value_of(nil)
+  end
+  
+  it "should be published if the published date is in the past" do
+    @published.is_draft?.should equal false
+    @published.is_published?.should equal true
+    @published.is_scheduled?.should equal false
+  end
+
+  it "should be a draft if the published date is not set" do
+    @draft.is_draft?.should == true
+    @draft.is_published?.should == false
+    @draft.is_scheduled?.should == false
+  end
+
+  it "should be scheduled if the published date is in the future" do
+    @scheduled.is_draft?.should == false
+    @scheduled.is_published?.should == false
+    @scheduled.is_scheduled?.should == true
+  end
+
+  it "should be publishable" do
+    @draft.should respond_to :publish!
+    @draft.publish!
+    @draft.is_published?.should equal true
+    @draft.published_at.to_i.should <= Time.now.to_i
+  end
+
+  it "should be unpublishable" do
+    @published.should respond_to :unpublish!
+    @published.unpublish!
+    @published.is_draft?.should equal true
+    @published.published_at.should be nil
+  end
+
+  it "should be scheduleable" do
+    @draft.should respond_to :schedule!
+    future = (Time.now + 12.hours).to_datetime
+    @draft.schedule!(future)
+    @draft.is_scheduled?.should equal true
+    @draft.published_at.to_i.should == future.to_i
+  end
+
+  it "should return all draft models" do
+    Post.drafts.count.should equal 1
+    Post.drafts.first.should == @draft
+  end
+
+  it "should return all published models" do
+    Post.published.count.should equal 1
+    Post.published.first.should == @published
+  end
+
+  it "should return all scheduled models" do
+    Post.scheduled.count.should equal 1
+    Post.scheduled.first.should == @scheduled
+  end
+
+  it "should return published posts in descending date order" do
+    @draft.publish!
+    @scheduled.publish!
+    last_stamp = Time.now
+    Post.published.each do |post|
+      post.published_at.should <= last_stamp
+      last_stamp = post.published_at
+    end
+  end
+
+  it "should return scheduled posts in ascending date order" do
+    @draft.schedule!(Time.now + 1.hour)
+    @published.schedule!(Time.now + 5.days)
+    last_stamp = Time.now
+    Post.scheduled.each do |post|
+      post.published_at.should > last_stamp
+      last_stamp = post.published_at
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'database_cleaner'
+require 'mongoid'
+require 'mongoid-rspec'
+require 'mongoid_publishable'
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_publishable_test")
+end
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_publishable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Nicholas Bruning
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-26 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: This gem adds some fields, scopes and methods to simplify and declutter your models that need to be drafted and published.
+email: 
+- nicholas@bruning.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/mongoid/publishable.rb
+- lib/mongoid/publishable/version.rb
+- lib/mongoid_publishable.rb
+- mongoid_publishable.gemspec
+- readme.md
+- spec/mongoid/publishable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/thetron/mongoid_publishable
+licenses: []
+
+post_install_message: 
+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: mongoid_publishable
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Add publishable behaviours to mongoid models.
+test_files: 
+- spec/mongoid/publishable_spec.rb
+- spec/spec_helper.rb