adequate_serializer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51d4f06cfbdbc34070c3a165637576031e8e0e14
-  data.tar.gz: ed2dca6154272060b027e144888d479551ac4739
+  metadata.gz: fa402c6b2f3c574115120ec0fecd0bf881f3ba8b
+  data.tar.gz: 4751584ac3ac456908d745fe16ab76c2a8d662e7
 SHA512:
-  metadata.gz: 3ce860ec614186a9052f89ad4fe9f5099c6410b008b12d543cec420d4c581832309b2df7fba055c621209b340e3ee13c5815e5425d5eff19b9a21d0fa78520a7
-  data.tar.gz: 6d36d252fc2dc5756e93e32aca94d5632ae1351269a1c959a483e64b1c1935322abc19b890159f80dde3c8808f70b99e8039a084a7b5e0a019eff94707a650b2
+  metadata.gz: 4547364833383fb4a1f88e18c4753e7fb9acdf9ebf56e7d9a75936b940f6538e728101a374dc7ca0dca1160a88e6e0bf09209ec81153e4819779591ee0a10536
+  data.tar.gz: f2651a12bafe90ef26f70feb711497c4e95738ae21c6af9119dd444345ea3db20789a1ac39f2146d0eb8874c7798570bfb7f768b7cc737899a7d7cc0bdc5b7be

data/.travis.yml

@@ -2,3 +2,7 @@ language: ruby
 rvm:
   - 2.2.2
 before_install: gem install bundler -v 1.10.5
+notifications:
+  email: false
+  slack:
+    secure: pms4y+KAAznnss/WF3cl7Nsm9gTNe4gTGQYjqcCC7Ygd9Ecuh1W76g2ttwdk4dXQMJE0+2M7TiEPSQijA/zdvjiaFsjm7ghLmyAJze1Yon9RL/JScF+2Ryqun/5LMMAN7vlEJ2FtYkBwCb9BpJNhmwSz5QH110nFvOo3cwgl+1cfFJyxtIT1ByEedrdRg7hfaETiHal7OG0MQcvJcQAh/xxjCEYq9ljRbWCDOYDWPnrmq4abqvZfZaXKg6xj5ZZIXQVWSbguCoao1zvWrxPAF5r2jJWlbL3AcAPRl2CdjmKWzubrf2xV0mwEGx+LbRwZB0ePw3jCg0+u+3QHtd2Dxs/25llk6zKB4KnfKDtlPSuBixFiQLXs2HowJN+0n0gLfbnSqCxsBeToDu7+tVkeMNa5CK6PMes8B2n2C1b7w4Q4bugf9BFFUMPZ2QXx738Bs6zXtI0nB42HV8fCIqtBfVtkdI7OeJRGj3JCvNajocz2gj5XdyW40alkcdPq7rqSqJecE6PfUIJIzDYlOmdcPbZlQjLhq1EWHPviycyIq4/Ddjj3oO747C97HsvoH7MwbCj+/A3hkP0sTJBcDUyCtMLIi54q1fZVKuWKU3jA92kWb06X0FPHBUH8PUF+0gw85sANcBRFTlLEMI7VDq/L8ahWMYCdx/J7+HWkClx6JJw=

data/README.md

@@ -1,8 +1,8 @@
 # AdequateSerializer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/adequate_serializer`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version][vb]][vl] [![Build Status][tb]][tl] [![Code Climate][cb]][cl]
 
-TODO: Delete this and the text above, and describe your gem
+A very opinionated lightweight serializer.
 
 ## Installation
 
@@ -22,20 +22,138 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Controller
+
+Just use AdequateSerializer's `serialize` method to serialize your data.
+It doesn't matter whether it is just one object or a collection.
+
+```ruby
+class UsersController < ApplicationController
+  def index
+    @users = User.all
+    render json: serialize(@users)
+  end
+
+  def show
+    @user = User.find(params[:id])
+    render json: serialize(@user)
+  end
+end
+```
+
+The serialize method will infer the serializer's name from the class of the
+object it serializes. In this case it will look for a `UserSerializer`.
+
+If you want another serializer, you can just pass it to the `serialize`
+method.
+
+```ruby
+render json: serialize(@user, serializer: AdminSerializer)
+```
+
+### Root Key
+
+By default the `serialize` method will infer the root key from the objects it
+is serializing. For example, when you give it a user the root will be `user`
+or rather `users` if you provide a collection of users.
+
+You can also define the root key yourself:
+
+```ruby
+serialize(@user, root: :admin)
+```
+
+or use no root at all:
+
+```ruby
+serialize(@user, root: false)
+```
+
+### Attributes
+
+You can specify which attributes of your objects will be serialized in the
+serializer.
+
+```ruby
+class UserSerializer::Base
+  attributes :id, :full_name, :created_at, :updated_at
+
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+  end
+end
+```
+
+These can be attributes or methods of your model. You can also define methods
+in the serializer itself and use them.
+
+Within a serializer's methods, you can access the object being serialized as
+`object`.
+
+### Associations
+
+If you want to include associations, just specify them in the controller.
+
+```ruby
+serialize(@user, includes: :posts)
+```
+
+In this case the PostSerializer will be used to nest the user's posts under the
+`posts` key in the user JSON object.
+
+You can also include multiple associations by using an array of association
+keys.
+
+#### Overriding association methods
+
+If you want to override any association, you can use:
+
+```ruby
+class UserSerializer::Base
+  attributes :id, :created_at, :updated_at
+
+  def posts
+    object.posts.published
+  end
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and tags, and push the `.gem` file to
+[rubygems.org][rg].
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/adequate_serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on [GitHub][gh]. This project is
+intended to be a safe, welcoming space for collaboration, and contributors
+are expected to adhere to the [Contributor Covenant][cc] code of conduct.
+
+## Credits
+
+![netflower][nl]
 
+AdequateSerializer is maintained by [netflower Ltd. & Co. KG][n].
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+[vb]: https://badge.fury.io/rb/adequate_serializer.svg
+[vl]: http://badge.fury.io/rb/adequate_serializer
+[tb]: https://travis-ci.org/netflower/adequate_serializer.svg?branch=master
+[tl]: https://travis-ci.org/netflower/adequate_serializer
+[cb]: https://codeclimate.com/github/netflower/adequate_serializer/badges/gpa.svg
+[cl]: https://codeclimate.com/github/netflower/adequate_serializer
+[rg]: https://rubygems.org
+[gh]: https://github.com/netflower/adequate_serializer
+[cc]: contributor-covenant.org
+[n]: http://netflower.de
+[nl]: https://cloud.githubusercontent.com/assets/464565/5997997/91da2232-aac2-11e4-9278-fdf21fb8a6e9.png

data/lib/adequate_serializer/base.rb

@@ -81,8 +81,16 @@ module AdequateSerializer
     end
 
     def serialize_association(association_key)
-      associated_objects = object.send(association_key)
+      associated_objects = associated_objects(association_key)
       serialize(associated_objects, root: false)
     end
+
+    def associated_objects(association_key)
+      if respond_to?(association_key)
+        send(association_key)
+      else
+        object.send(association_key)
+      end
+    end
   end
 end

data/lib/adequate_serializer/version.rb

@@ -1,3 +1,3 @@
 module AdequateSerializer
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adequate_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bastian Bartmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport