mongoid-serializer 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e380bd97fc4b5e407ee221cd59f24af08d4527a0
-  data.tar.gz: 929c73d202c6bcb2e344594e6f6c1feeb3163ab4
+  metadata.gz: c2657c7992af64ad72f4fe27e78596692d0a4d80
+  data.tar.gz: 30cd54dd1c9a6c1c06b6ebafa50b54fee8521567
 SHA512:
-  metadata.gz: 691e55d9dd487f51e4fe6fe7bd4ed36defcc7f5011fe3a35e5610863ec1297ff0d51ea9bf8d73f4bec7a026843d0283b95627ea084fa3fde38ae7ec1c96871f4
-  data.tar.gz: d8cfd49e0eca5f757bbac2c0ecc1b37359df8588f3a89f821ed9207df1ffe37575941da4644fadad09320720c7aa40ee02840e3118c0ab0efb20d77998a75174
+  metadata.gz: 3208f6fe803c491399f8cb16f5b1be59aa60f49f36835ccd2bbeb0966713df06a2a7e854e0f009c65bfe08ce8d5fb4208828cf0f6f1c038465388385b6348ab4
+  data.tar.gz: 60eb85ebdd6caf5de102d823a9255d5cfd1ae46a4f93ab0a9f9a51cdcc403fe2d7a55c66d26a4dead11912767179e982569659662c0e7804d168bc81b2432bc3

data/README.md

@@ -21,14 +21,29 @@ Or install it yourself as:
 
     $ gem install mongoid-serializer
 
+If the gem isn't activated automatically, you can add configuration in an initializer file, f.ex `mongoid_config.rb` 
+
+```ruby
+# mongoid_config.rb
+Mongoid::Serializer.configure!
+```
+
 ## Usage
 
 ```ruby
-class UserSerializer < MongoidSerializer
+class UserSerializer < ActiveModel::MongoidSerializer
   attributes :id, :first_name, :last_name, :quote, :age
 end
 ```
 
+Additionally this gem includes a `ActiveModel::StateTracking` module. This modules provides the methods `created?` and `deleted?` for use with any Mongoid Document.
+
+You can either include this module in models of your choice, or include it into `Mongoid::Document` to make it part of every model. 
+
+For convenience, a method `Mongoid::Serializer.enable_state_tracking!` is made available to add state tracking to all Documents.
+
+`ActiveModel::MongoidSerializer` is configured to try to hook into the `StateTracking` methods and set the JSON `status:` key to either `201` or `204`, to reflect created or deleted state back to the client.
+
 ## Contributing
 
 1. Fork it

data/lib/mongoid/serializer.rb

@@ -6,6 +6,10 @@ module Mongoid
       Mongoid::Document.send(:include, ActiveModel::SerializerSupport)
       Mongoid::Criteria.delegate(:active_model_serializer, to: :to_a)
     end
+
+    def self.enable_state_tracking!
+      require "mongoid/serializer/state_tracking"
+    end
   end
 end
 
@@ -18,5 +22,36 @@ module ActiveModel
     def id
       object._id
     end 
+
+    def status
+      return 204 if object.respond_to?(:destroyed?) && object.destroyed?
+      return 201 if object.respond_to?(:created?) && object.created?      
+    end
   end
 end
+
+module ActiveModel::StateTracking
+  extend ActiveSupport::Concern
+
+  included do
+    after_create do
+      @created = true
+    end
+
+    after_update do
+      @created = false
+    end
+
+    after_destroy do
+      @destroyed = true
+    end
+  end
+
+  def created?
+    @created == true
+  end
+
+  def destroyed?
+    @destroyed == true
+  end
+end

data/lib/mongoid/serializer/state_tracking.rb

@@ -0,0 +1,3 @@
+module Mongoid::Document
+  include ActiveModel::StateTracking
+end

data/lib/mongoid/serializer/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Serializer
-    VERSION = "0.0.1"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Kristian Mandrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -65,6 +65,7 @@ files:
 - README.md
 - Rakefile
 - lib/mongoid/serializer.rb
+- lib/mongoid/serializer/state_tracking.rb
 - lib/mongoid/serializer/version.rb
 - mongoid-serializer.gemspec
 homepage: https://github.com/kristianmandrup/mongoid-serializer