mongoid-publishable 0.2.1 → 0.3.1

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mongoid_publishable.gemspec
 gemspec
+
+case RUBY_PLATFORM
+when /darwin/
+  gem "rb-fsevent", require: false
+when /linux/
+  gem "rb-inotify", require: false
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/README.md

@@ -2,10 +2,12 @@
 
 Ever wanted to allow your users to create something (or somethings) before authenticating. For example, you might want to let them write a review, before you ask them to login and publish it. This is what Mongoid::Publishable handles.
 
-[![Build Status][2]][1]
+[![Build Status][2]][1] [![Code Climate][3]][4]
 
   [1]: http://travis-ci.org/ryantownsend/mongoid-publishable
   [2]: https://secure.travis-ci.org/ryantownsend/mongoid-publishable.png?branch=master
+  [3]: https://codeclimate.com/badge.png
+  [4]: https://codeclimate.com/github/ryantownsend/mongoid-publishable
 
 ## Installation
 
@@ -168,6 +170,19 @@ class Review
 end
 ```
 
+You can define custom publishing requirements:
+
+```ruby
+class Tweet
+  include Mongoid::Document
+  include Mongoid::Publishable
+
+  publishing_conditions do |tweet|
+    tweet.user.has_twitter_account?
+  end # => should return true / false
+end
+```
+
 ## Contributing
 
 1. Fork it
@@ -177,4 +192,8 @@ end
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
 
-After running specs, you can find a test coverage report at coverage/index.html
+After running specs, you can find a test coverage report at `coverage/index.html`.
+
+Note: you can run the test suite automatically by starting Guard, do this with the following command:
+
+    $ bundle exec guard start

data/Rakefile

@@ -9,4 +9,4 @@ desc "Run specs"
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
   # Put spec opts in a file named .rspec in root
-end
+end

data/lib/mongoid/publishable.rb

@@ -22,10 +22,20 @@ module Mongoid
         @publisher_column || :user_id
       end
 
+      # gets/sets the foreign key of the publisher to be stored
       def publisher_foreign_key(name = nil)
         @publisher_foreign_key = name if name
         @publisher_foreign_key || :id
       end
+      
+      # gets/sets custom publishing conditions
+      def publishing_conditions(&block)
+        if block_given?
+          @publishing_conditions = block
+        else
+          @publishing_conditions
+        end
+      end
     end
 
     module InstanceMethods
@@ -68,8 +78,11 @@ module Mongoid
           value = publisher.send(publisher_foreign_key)
           # update this instance with the key
           self.send("#{publisher_column}=", value)
-          # mark as just published
-          run_after_publish_callbacks
+          # if this now counts as published
+          if pre_published?
+            # mark as just published
+            run_after_publish_callbacks
+          end
         end
       end
 
@@ -81,12 +94,33 @@ module Mongoid
 
       # returns boolean of whether this instance has been published
       def published?
-        persisted? && send(publisher_column)
+        persisted? && has_publisher_id? && meets_custom_publishing_conditions?
+      end
+      
+      # returns boolean of whether this instance has been published
+      # regardless of whether it's been persisted yet
+      def pre_published?
+        has_publisher_id? && meets_custom_publishing_conditions?
       end
 
       # returns whether this instance needs publishing (persisted, not published)
       def requires_publishing?
-        persisted? && !send(publisher_column)
+        persisted? && (!has_publisher_id? || !meets_custom_publishing_conditions?)
+      end
+      
+      # returns whether or not the publisher is present
+      def has_publisher_id?
+        !!send(publisher_column)
+      end
+      
+      # returns true if there are no conditions, or the resulting yield is true
+      def meets_custom_publishing_conditions?
+        publishing_conditions.nil? || publishing_conditions.yield(self)
+      end
+      
+      # returns a block with custom publishing conditions
+      def publishing_conditions
+        self.class.publishing_conditions
       end
 
       # raises an UnpublishedError containing this object as a reference

data/lib/mongoid/publishable/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Publishable
-    VERSION = "0.2.1"
+    VERSION = "0.3.1"
   end
 end

data/mongoid_publishable.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec"
   s.add_development_dependency "foreman"
   s.add_development_dependency "simplecov"
+  s.add_development_dependency "guard-rspec"
 end

data/spec/mongoid/publishable_spec.rb

@@ -183,6 +183,30 @@ describe Mongoid::Publishable do
         end
       end
     end
+    
+    describe "#meets_custom_publishing_conditions?" do
+      context "without custom publishing conditions" do
+        before(:each) do
+          subject.stub(:publishing_conditions).and_return(nil)
+        end
+        
+        it "should return true" do
+          expect(subject.meets_custom_publishing_conditions?).to be_true
+        end
+      end
+      
+      context "with custom publishing conditions" do
+        before(:each) do
+          subject.class.publishing_conditions do |object|
+            !!object.user_id
+          end
+        end
+        
+        it "should return false" do
+          expect(subject.meets_custom_publishing_conditions?).to be_false
+        end
+      end
+    end
 
     describe "#requires_publishing?" do
       context "when persisted" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-publishable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A mixin for Mongoid document models allowing for publishing them after
   authentication
 email:
@@ -119,6 +135,7 @@ files:
 - .rvmrc
 - .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - Procfile
 - README.md
@@ -166,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2933550559147298580
+      hash: 4223141326906407503
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -175,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2933550559147298580
+      hash: 4223141326906407503
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24