mongoid-publishable 0.0.1

data/spec/mongoid/publishable/queuing_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+require "mongoid/publishable/queuing"
+
+describe Mongoid::Publishable::Queuing do
+  subject do
+    QueuingController.new
+  end
+  
+  describe "#deserialize_publishing_queue" do
+    it "should make the queue accessible via #publishing_queue" do
+      subject.send(:deserialize_publishing_queue)
+      expect(subject.publishing_queue).to respond_to :<<
+    end
+  end
+  
+  describe "#serialize_publishing_queue" do
+    it "should dump the data data to the session" do
+      data = { :one => "two" }
+      subject.send(:deserialize_publishing_queue)
+      subject.publishing_queue.should_receive(:dump).and_return(data)
+      subject.send(:serialize_publishing_queue)
+      expect(subject.session[:publishing_queue]).to eq data
+    end
+  end
+end

data/spec/mongoid/publishable/unpublished_object_spec.rb

@@ -0,0 +1,133 @@
+require "spec_helper"
+require "multi_json"
+require "mongoid/publishable/unpublished_object"
+
+describe Mongoid::Publishable::UnpublishedObject do
+  let(:model) { PublishableObject.new }
+
+  describe "::deserialize_from_session" do
+    it "should initialize with data" do
+      subject = Mongoid::Publishable::UnpublishedObject.deserialize_from_session("data")
+      expect(subject).to be_kind_of Mongoid::Publishable::UnpublishedObject
+    end
+  end
+  
+  describe "::initialize" do
+    subject do
+      Mongoid::Publishable::UnpublishedObject.new(params)
+    end
+    let(:params) { Hash.new }
+    
+    context "with a model" do
+      let(:params) do
+        { model: model }
+      end
+      
+      it "should not raise an error" do
+        expect { subject }.not_to raise_error
+      end
+    end
+    
+    context "with data" do
+      let(:params) do
+        { data: %Q({ class_name: "Item", id: 123 }) }
+      end
+      
+      it "should not raise an error" do
+        expect { subject }.not_to raise_error
+      end
+    end
+    
+    context "with no model or data" do      
+      it "should raise an argument error" do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+  
+  describe "#serialize_for_session" do
+    context "with a model" do
+      subject do
+        Mongoid::Publishable::UnpublishedObject.new(model: model)
+      end
+      
+      it "should return a string of JSON" do
+        json = MultiJson.load(subject.serialize_for_session)
+        expect(json["class_name"]).to eq model.class.name
+        expect(json["id"].to_s).to eq model.id.to_s
+      end
+    end
+    
+    context "with data" do
+      subject do
+        data = %Q({ "class_name": "Item", "id": "123" })
+        Mongoid::Publishable::UnpublishedObject.new(data: data)
+      end
+      
+      it "should return a string of JSON" do
+        json = MultiJson.load(subject.serialize_for_session)
+        expect(json["class_name"]).to eq "Item"
+        expect(json["id"].to_s).to eq "123"
+      end
+    end
+  end
+  
+  describe "#params" do
+    context "with data" do
+      subject do
+        data = %Q({ "class_name": "Item", "id": "123" })
+        Mongoid::Publishable::UnpublishedObject.new(data: data).params
+      end
+      
+      it "should return a string of JSON" do
+        expect(subject["class_name"]).to eq "Item"
+        expect(subject["id"].to_s).to eq "123"
+      end
+    end
+  end
+  
+  describe "#respond_to_missing?" do
+    subject do
+      Mongoid::Publishable::UnpublishedObject.new(model: model)
+    end
+
+    it "should return true if the model accepts the method" do
+      expect(subject.respond_to_missing?(:id)).to be_true
+    end
+  end
+  
+  describe "#method_missing" do
+    subject do
+      Mongoid::Publishable::UnpublishedObject.new(model: model)
+    end
+    
+    it "should delegate to the model" do
+      expect(subject.id).to eq model.id
+    end
+  end
+  
+  describe "#source_object" do
+    context "with data" do
+      subject do
+        data = %Q({ "class_name": "PublishableObject", "id": "123" })
+        Mongoid::Publishable::UnpublishedObject.new(data: data)
+      end
+      
+      it "should find the model" do
+        model = mock("model")
+        PublishableObject.should_receive(:find).with("123").and_return(model)
+        expect(subject.source_object).to eq model
+      end
+    end
+    
+    context "with a model" do
+      subject do
+        Mongoid::Publishable::UnpublishedObject.new(model: model)
+      end
+      
+      it "should return the model" do
+        expect(subject.source_object).to eq model
+      end
+    end
+  end
+end

data/spec/mongoid/publishable_spec.rb

@@ -0,0 +1,215 @@
+require "spec_helper"
+require "mongoid/publishable"
+
+describe Mongoid::Publishable do
+  let(:user) { mock("user", id: 123) }
+  
+  describe "a class that includes the module" do
+    subject { PublishableObject }
+    
+    before(:each) do
+      @publisher_column = subject.publisher_column
+      @publisher_foreign_key = subject.publisher_foreign_key
+    end
+    
+    after(:each) do
+      subject.publisher_column @publisher_column
+      subject.publisher_foreign_key @publisher_foreign_key
+    end
+    
+    it "should include Mongoid::Publishable::Callbacks" do
+      expect(subject.included_modules).to include Mongoid::Publishable::Callbacks
+    end
+    
+    describe "::publisher_column" do
+      it "should return :user_id by default" do
+        expect(subject.publisher_column).to eq :user_id
+      end
+      
+      it "should be overridable" do
+        subject.publisher_column :author_id
+        expect(subject.publisher_column).to eq :author_id
+        subject.publisher_column :user_id
+      end
+    end
+  
+    describe "::publisher_foreign_key" do
+      it "should return :id by default" do
+        expect(subject.publisher_foreign_key).to eq :id
+      end
+      
+      it "should be overridable" do
+        subject.publisher_foreign_key :username
+        expect(subject.publisher_foreign_key).to eq :username
+        subject.publisher_column :user_id
+      end
+    end
+  end
+  
+  describe "an instance of a class that includes the module" do
+    subject { PublishableObject.new }
+    
+    describe "#publisher_column" do
+      it "should return :user_id by default" do
+        expect(subject.publisher_column).to eq :user_id
+      end
+    end
+    
+    describe "#publisher_column=" do
+      it "should be override #publisher_column" do
+        subject.publisher_column = :author_id
+        expect(subject.publisher_column).to eq :author_id
+      end
+    end
+    
+    describe "#publisher_foreign_key" do
+      it "should return :id by default" do
+        expect(subject.publisher_foreign_key).to eq :id
+      end
+    end
+
+    describe "#publisher_foreign_key=" do
+      it "should be override #publisher_foreign_key" do
+        subject.publisher_foreign_key = :username
+        expect(subject.publisher_foreign_key).to eq :username
+      end
+    end
+
+    describe "#persist_and_publish" do
+      context "when persisted" do
+        before(:each) do
+          subject.stub(:save).and_return(true)
+        end
+        
+        context "without a publisher" do
+          it "should return false" do
+            expect(subject.persist_and_publish).to be_false
+          end
+        end
+        
+        context "with a publisher" do
+          it "should return true" do
+            expect(subject.persist_and_publish(user)).to be_true
+          end
+        end
+      end
+      
+      context "when not persisted" do
+        before(:each) do
+          subject.stub(:save).and_return(false)
+        end
+        
+        it "should return false" do
+          expect(subject.persist_and_publish(user)).to be_false
+        end
+        
+        it "should still update the publisher" do
+          subject.persist_and_publish(user)
+          expect(subject.user_id).to eq user.id
+        end
+      end
+    end
+
+    describe "#persist_and_publish!" do
+      context "when persisted" do
+        before(:each) do
+          subject.stub(:persisted?).and_return(true)
+          subject.stub(:save).and_return(true)
+        end
+        
+        context "but not published" do
+          it "should raise an exception" do
+            expect {
+              subject.persist_and_publish!(nil)
+            }.to raise_error(Mongoid::Publishable::UnpublishedError)
+          end
+        end
+        
+        context "and published" do
+          it "should return true" do
+            expect(subject.persist_and_publish!(user)).to be_true
+          end
+        end
+      end
+      
+      context "when it fails validation" do
+        before(:each) do
+          subject.stub(:save).and_return(false)
+        end
+        
+        it "should return false" do
+          expect(subject.persist_and_publish!(user)).to be_false
+        end
+      end
+    end
+
+    describe "#publish_via" do
+      it "should set the publisher on the object" do
+        subject.publish_via(user)
+        expect(subject.user_id).to eq user.id
+      end
+    end
+
+    describe "#publish_via!" do
+      it "should set the publisher on the object and persist" do
+        subject.should_receive(:save).and_return(true)
+        expect(subject.publish_via!(user)).to be_true
+        expect(subject.user_id).to eq user.id
+      end
+    end
+
+    describe "#published?" do
+      context "when not persisted" do
+        it "should return false" do
+          expect(subject.published?).to be_false
+        end
+      end
+      
+      context "when persisted" do
+        before(:each) do
+          subject.stub(:persisted?).and_return(true)
+        end
+        
+        context "without a publisher" do
+          it "should return false" do
+            expect(subject.published?).to be_false
+          end
+        end
+        
+        context "with a publisher" do
+          it "should return true" do
+            subject.publish_via(user)
+            expect(subject.published?).to be_true
+          end
+        end
+      end
+    end
+
+    describe "#requires_publishing?" do
+      context "when persisted" do
+        before(:each) do
+          subject.stub(:persisted?).and_return(true)
+        end
+        
+        context "and the publisher is set" do
+          it "should return false" do
+            subject.publish_via(user)
+            expect(subject.requires_publishing?).to be_false
+          end
+        end
+        
+        context "and the publisher is not set" do
+          it "should return true" do
+            expect(subject.requires_publishing?).to be_true
+          end
+        end
+      end
+      
+      context "when not persisted" do
+        it "should return false" do
+          expect(subject.requires_publishing?).to be_false
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require "mongoid"
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }

data/spec/support/env.rb

@@ -0,0 +1,8 @@
+RSpec.configure do |config|
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+
+	config.color_enabled = true
+	config.order = :random
+end

data/spec/support/models/callbackable_object.rb

@@ -0,0 +1,6 @@
+require "mongoid/publishable/callbacks"
+
+class CallbackableObject
+  def self.after_save(*args); end
+  include Mongoid::Publishable::Callbacks
+end

data/spec/support/models/publishable_object.rb

@@ -0,0 +1,8 @@
+require "mongoid/publishable"
+
+class PublishableObject
+  include Mongoid::Document
+  include Mongoid::Publishable
+
+  belongs_to :user, class_name: "Publisher"
+end

data/spec/support/models/publisher.rb

@@ -0,0 +1,3 @@
+class Publisher
+  include Mongoid::Document
+end

data/spec/support/models/queuing_controller.rb

@@ -0,0 +1,8 @@
+require "mongoid/publishable/queuing"
+
+class QueuingController
+  def self.before_filter(*args); end
+  def self.after_filter(*args); end
+  def session; @session ||= {}; end
+  include Mongoid::Publishable::Queuing
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-publishable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Townsend
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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:
+- ryan@ryantownsend.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid/.DS_Store
+- lib/mongoid/publishable.rb
+- lib/mongoid/publishable/callback.rb
+- lib/mongoid/publishable/callback_collection.rb
+- lib/mongoid/publishable/callbacks.rb
+- lib/mongoid/publishable/queue.rb
+- lib/mongoid/publishable/queuing.rb
+- lib/mongoid/publishable/unpublished_error.rb
+- lib/mongoid/publishable/unpublished_object.rb
+- lib/mongoid/publishable/version.rb
+- lib/mongoid_publishable.rb
+- mongoid_publishable.gemspec
+- spec/.DS_Store
+- spec/mongoid/publishable/callback_collection_spec.rb
+- spec/mongoid/publishable/callback_spec.rb
+- spec/mongoid/publishable/callbacks_spec.rb
+- spec/mongoid/publishable/queue_spec.rb
+- spec/mongoid/publishable/queuing_spec.rb
+- spec/mongoid/publishable/unpublished_object_spec.rb
+- spec/mongoid/publishable_spec.rb
+- spec/spec_helper.rb
+- spec/support/env.rb
+- spec/support/models/callbackable_object.rb
+- spec/support/models/publishable_object.rb
+- spec/support/models/publisher.rb
+- spec/support/models/queuing_controller.rb
+homepage: https://github.com/ryantownsend/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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A mixin for Mongoid document models allowing for publishing them after authentication
+test_files:
+- spec/.DS_Store
+- spec/mongoid/publishable/callback_collection_spec.rb
+- spec/mongoid/publishable/callback_spec.rb
+- spec/mongoid/publishable/callbacks_spec.rb
+- spec/mongoid/publishable/queue_spec.rb
+- spec/mongoid/publishable/queuing_spec.rb
+- spec/mongoid/publishable/unpublished_object_spec.rb
+- spec/mongoid/publishable_spec.rb
+- spec/spec_helper.rb
+- spec/support/env.rb
+- spec/support/models/callbackable_object.rb
+- spec/support/models/publishable_object.rb
+- spec/support/models/publisher.rb
+- spec/support/models/queuing_controller.rb