mongoid-serializer 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2657c7992af64ad72f4fe27e78596692d0a4d80
-  data.tar.gz: 30cd54dd1c9a6c1c06b6ebafa50b54fee8521567
+  metadata.gz: 17785512c923879da4e67fa785a4dae5aa88e131
+  data.tar.gz: c96bb37b19a0c70b068758fa7cdc820098abcd16
 SHA512:
-  metadata.gz: 3208f6fe803c491399f8cb16f5b1be59aa60f49f36835ccd2bbeb0966713df06a2a7e854e0f009c65bfe08ce8d5fb4208828cf0f6f1c038465388385b6348ab4
-  data.tar.gz: 60eb85ebdd6caf5de102d823a9255d5cfd1ae46a4f93ab0a9f9a51cdcc403fe2d7a55c66d26a4dead11912767179e982569659662c0e7804d168bc81b2432bc3
+  metadata.gz: 87fbbbdcdb6d35093e53ffaa6c5661a1140f84264e83052df5c457bf12d2ad981b03fe75a58d738d479aa335da4e93d97d581df76e073824c169acbb529947a4
+  data.tar.gz: fbd5b1c71e490aeb22f8deedcdfc9b577fdb5ef0bad7a486c6d541e8fdb24f0f772d6db39bebdb086d35420a4ac04df7a2c0bf1511cd00bb4f73be6326bf2500

data/README.md

@@ -21,18 +21,16 @@ 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!
-```
+## Config
+
+`Mongoid::Serializer.configure!`
 
 ## Usage
 
 ```ruby
 class UserSerializer < ActiveModel::MongoidSerializer
-  attributes :id, :first_name, :last_name, :quote, :age
+  attributes :id, :first_name, :last_name, :quote, :age, http_status
 end
 ```
 
@@ -40,9 +38,9 @@ Additionally this gem includes a `ActiveModel::StateTracking` module. This modul
 
 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::StatusSerializer` is configured to try to hook into the `StateTracking` methods from [active_model-shaz](https://github.com/kristianmandrup/active_model-shaz) and set the JSON `http_status` key to either `201` or `204`, to reflect created or deleted state back to the client.
 
-`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.
+`ActiveModel::MongoidSerializer` extends `ActiveModel::StatusSerializer` and sets the `id` attribute to point to `_id` to better work with what the usual client side APIs expect (f.ex for use with ember-data).
 
 ## Contributing
 

data/lib/mongoid/serializer.rb

@@ -6,52 +6,27 @@ 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
 
-if defined?(Mongoid)
-  Mongoid::Serializer.configure!
-end
 
 module ActiveModel
-  class MongoidSerializer < Serializer
-    def id
-      object._id
-    end 
-
-    def status
+  class StatusSerializer < Serializer
+    def http_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
+module ActiveModel
+  class MongoidSerializer < StatusSerializer
+    def id
+      object._id
     end
   end
+end
 
-  def created?
-    @created == true
-  end
-
-  def destroyed?
-    @destroyed == true
-  end
+if defined?(Mongoid)
+  Mongoid::Serializer.configure!
 end

data/lib/mongoid/serializer/version.rb

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

data/mongoid-serializer.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'mongoid', '>= 3.0'
+  spec.add_dependency 'active_model-shaz'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kristian Mandrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: active_model-shaz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -65,7 +79,6 @@ 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

data/lib/mongoid/serializer/state_tracking.rb

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