easy_serializer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 700ae3daae7ea9a9b78584ba113372d51de24f29
-  data.tar.gz: 1918451e17315912e938cb82c2759b2346e6d4f6
+  metadata.gz: 0cc2097011b0fa8a92990c2207848e77eae0891a
+  data.tar.gz: ea4d21a3fe3bf12dfdedd7b795b884962564a990
 SHA512:
-  metadata.gz: e55d290b237a04be9fef19fc3ceea6266a76b06baabce9b171436ec019d42e6ec6ca534cf59dbc612d8c41897a5935ad33f4c8166043a8614eb43a5c126a1067
-  data.tar.gz: 33150c86072b21384f81a2185a1b6ac1c054be9dfdfc7e6ad786b57293537bdb4f4ed960af519ac4ff1ea9b89218e5b55ee90e237a839921633dbb63ba2ddd7c
+  metadata.gz: 80b141c0fb80d95525bcf0ae6b9b3335795fcf61ae6bcaff8c51b253ffd4650f277eb5f57f0be5ad0d50cf229bf0faf2f13a06e5ff65fb25e9fda1b921796f30
+  data.tar.gz: fea25e7aebe7a75967856269096a2f6ad84a049e236c1b6a88fefec005c15b5e7a024a03054d2593adbe3f451a34beb96a41a6c487e468fe1648d2eca47753af

data/.gitignore

@@ -2,8 +2,9 @@
 /.yardoc
 /Gemfile.lock
 /_yardoc/
-/coverage/
 /doc/
 /pkg/
 /spec/reports/
+/coverage/
 /tmp/
+easy_serializer*.gem

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in easy_serializer.gemspec
 gemspec
+gem 'pry'
+gem 'simplecov', :require => false, :group => :test

data/README.md

@@ -1,7 +1,20 @@
 # EasySerializer
 
+[ ![Codeship Status for arturictus/easy_serializer](https://codeship.com/projects/5a101d20-6dda-0133-b7b2-666194911eaf/status?branch=master)](https://codeship.com/projects/115737)
+[![Code Climate](https://codeclimate.com/github/arturictus/easy_serializer/badges/gpa.svg)](https://codeclimate.com/github/arturictus/easy_serializer)
+[![Test Coverage](https://codeclimate.com/github/arturictus/easy_serializer/badges/coverage.svg)](https://codeclimate.com/github/arturictus/easy_serializer/coverage)
+
 Semantic serializer for making easy serializing objects.
 
+features:
+- Nice and simple serialization DSL.
+- Cache helpers to use with your favorite adapter like rails cache.
+
+Advantages:
+- Separated responsibility from Model class and serialization allowing multiple serializers for the same Model class, very useful for API versioning.
+- In contraposition with active model serializers with EasySerializer you can serialize any object responding to the methods you want to serialize.
+- EasySerializer is an small library with few dependencies.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,10 +31,209 @@ Or install it yourself as:
 
     $ gem install easy_serializer
 
+Add the configuration file:
+
+**Only if you need caching.**
+
+_If your are in a Rails environment place this file at config/initializers_
+
+```ruby
+EasySerializer.setup do |config|
+  # = perform_caching
+  #
+  # Enable o disable caching.
+  # default: false
+  #
+  # config.perform_caching = true
+
+  # = cache
+  #
+  # Set your caching tool for the serializer
+  # must respond to fetch(obj, opts, &block) like Rails Cache.
+  # default: nil
+  #
+  # config.cache = Rails.cache
+end
+```
+
 ## Usage
 
-example:
-_serializer:_
+### Simple example:
+
+```ruby
+user = OpenStruct.new(name: 'John', surname: 'Doe')
+
+class UserSerializer < EasySerializer::Base
+  attributes :name, :surname
+end
+
+UserSerializer.call(user)
+# =>
+{
+  name: 'John',
+  surname: 'Doe'
+}
+```
+**Using blocks:**
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  attribute(:name) { |user| user.name.capitalize }
+  attribute(:surname) { |user| user.surname.capitalize }
+end
+```
+
+**Changing keys:**
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  attribute :name, key: :named
+  attribute(:surname, key: :lastname) { |user| user.surname.capitalize }
+end
+```
+
+### Serializing attributes with serializer
+
+```ruby
+user = OpenStruct.new(
+  name: 'John',
+  surname: 'Doe',
+  address: OpenStruct.new(
+    street: 'Happy street',
+    country: 'Wonderland'
+  )
+)
+
+class AddressSerializer < EasySerializer::Base
+  attributes :street, :country
+end
+
+class UserSerializer < EasySerializer::Base
+  attributes :name, :surname
+  collection :address, serializer: AddressSerializer
+end
+
+UserSerializer.call(user)
+# =>
+{
+  name: 'John',
+  surname: 'Doe',
+  address: {
+    street: 'Happy street',
+    country: 'Wonderland'
+  }
+}
+```
+
+**Removing keys from nested hashes:**
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  attribute :name, :lastname
+  attribute :address,
+            key: false,
+            serializer: AddressSerializer
+end
+UserSerializer.call(user)
+# =>
+{
+  name: 'John',
+  surname: 'Doe',
+  street: 'Happy street',
+  country: 'Wonderland'
+}
+```
+
+**Serializer option accepts a Proc:**
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  attributes :name, :surname
+  attribute :address,
+            serializer: proc { |serializer| "#{serializer.klass_ins.name}Serializer" },
+            cache: true
+end
+```
+
+### Collection Example:
+
+```ruby
+user = OpenStruct.new(
+  name: 'John',
+  surname: 'Doe',
+  emails: [
+    OpenStruct.new(address: 'hello@email.com', type: 'work')
+  ]
+)
+
+class EmailSerializer < EasySerializer::Base
+  attributes :address, :type
+end
+
+class UserSerializer < EasySerializer::Base
+  attributes :name, :surname
+  collection :emails, serializer: EmailSerializer
+end
+
+UserSerializer.call(user)
+# =>
+{
+  name: 'John',
+  surname: 'Doe',
+  emails: [ { address: 'hello@email.com', type: 'work' } ]
+}
+```
+
+### Cache
+
+**Important** cache will only work if is set in the configuration file.
+
+**Caching the serialized object:**
+
+Serialization will happen only once and the result hash will be stored in the cache.
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  cache true
+  attributes :name, :surname
+end
+```
+
+**Caching attributes:**
+
+Attributes can be cached independently.
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  attributes :name, :surname
+  attribute :costly_query, cache: true
+end
+```
+
+of course it works with blocks:
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  attributes :name, :surname
+  attribute(:costly_query, cache: true) do |user|
+    user.best_friends
+  end
+end
+```
+
+**Caching Collections:**
+
+Cache will try to fetch the cached object in the collection **one by one, the whole collection is not cached**.
+
+```ruby
+class UserSerializer < EasySerializer::Base
+  attributes :name, :surname
+  collection :address, serializer: AddressSerializer, cache: true
+end
+```
+
+### Complex example using all features:
+
 ```ruby
 class PolymorphicSerializer < EasySerializer::Base
   cache true
@@ -36,7 +248,7 @@ class PolymorphicSerializer < EasySerializer::Base
 
   attribute :subject,
             key: false,
-            serializer: proc {|serializer| serializer.serializer_for_subject },
+            serializer: proc { |serializer| serializer.serializer_for_subject },
             cache: true
   collection :elements, serializer: ElementsSerializer, cache: true
 
@@ -49,8 +261,8 @@ end
 ```
 
 ```ruby
-PolymorphicSerializer.new(Polymorphic.last).serialize
-# => Hash with the object serialized  
+PolymorphicSerializer.call(Polymorphic.last)
+# => Hash with the object serialized
 ```
 
 ## Development
@@ -61,7 +273,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_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 at https://github.com/arturictus/easy_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.
 
 
 ## License

data/bin/console

@@ -7,8 +7,8 @@ require "easy_serializer"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require "irb"
-IRB.start
+# require "irb"
+# IRB.start

data/lib/easy_serializer/base.rb

@@ -7,6 +7,14 @@ module EasySerializer
     end
 
     class << self
+
+      def call(obj)
+        new(obj).serialize
+      end
+      alias_method :serialize, :call
+      alias_method :to_hash, :call
+      alias_method :to_h, :call
+
       def attribute(name, opts = {}, &block)
         @__serializable_attributes ||= []
         @__serializable_attributes << { name: name, block: block }.merge(opts)
@@ -76,16 +84,24 @@ module EasySerializer
     end
 
     def attr_serializer(setup)
-      return setup[:block].call(klass_ins) if setup[:block]
-      content = klass_ins.send(setup[:name])
+      content = cache_or_attribute(klass_ins, setup)
       return content unless serializer = setup[:serializer]
       if setup[:collection]
-        content.map { |o|  cache_or_serialize(serializer, o, setup) }
+        Array.wrap(content).map { |o|  cache_or_serialize(serializer, o, setup) }
       else
         cache_or_serialize(serializer, content, setup)
       end
     end
 
+    def cache_or_attribute(obj, setup)
+      execute = setup[:block] || proc { |o| o.send(setup[:name]) }
+      if EasySerializer.perform_caching && setup[:cache] && !setup[:serializer]
+        EasySerializer.cache.fetch(obj, setup[:name]) { execute.call(obj) }
+      else
+        execute.call(obj)
+      end
+    end
+
     def cache_or_serialize(serializer, content, opts)
       return unless content
       if EasySerializer.perform_caching && opts[:cache]
@@ -95,7 +111,7 @@ module EasySerializer
           [content, 'EasySerialized']
         end
         # Be Aware
-        # We are cahing the serialized object
+        # We are caching the serialized object
         EasySerializer.cache.fetch(key) { send_to_serializer(serializer, content) }
       else
         send_to_serializer(serializer, content)

data/lib/easy_serializer/version.rb

@@ -1,3 +1,3 @@
 module EasySerializer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler