scoped_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fbd0dea1bb6ee4232f72241d4ac445b730b7e06
+  data.tar.gz: 8a9841173c363ee66e3928e3fd55b0bfac0772d8
+SHA512:
+  metadata.gz: 7d625b615545c73c6465a3fa4408ec1d131e1e99e0493299b224353a07dfd779f18451cb2f2c5373536e730c8a7e73fb2e2d2d23d55e4d8bc93ff3b34d246e6b
+  data.tar.gz: ead71b87fcc96ae6dd2d173ea1f9519cb2428b1d499da8b2756c98251e4981b9323d80edacb0728a2137ed9bc84fffb15bbe3372dc3cb7ccce2002e10d9ba960

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Booqable
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ScopedSerializer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/scoped_serializer/array_serializer.rb

@@ -0,0 +1,29 @@
+module ScopedSerializer
+  class ArraySerializer < BaseSerializer
+
+    attr_reader :array, :scope, :scope_name, :options
+
+    def initialize(array, scope_name=:default, options={})
+      @array = array
+      @scope_name = scope_name
+      @options = options || {}
+    end
+
+    def serializable_hash(options={})
+      array.collect do |object|
+        ScopedSerializer.for(object, @scope_name, @options.merge(:root => false)).as_json
+      end
+    end
+
+    def meta
+      data = super
+
+      if @array.respond_to?(:total_count)
+        data = {}.merge(data).merge({ :total_count => @array.total_count })
+      end
+
+      data
+    end
+
+  end
+end

data/lib/scoped_serializer/base_serializer.rb

@@ -0,0 +1,58 @@
+module ScopedSerializer
+  class BaseSerializer
+
+    ##
+    # Sets scope and settings based on @options.
+    #
+    def set_scope(scope)
+      if @options[:associations].present? || @options[:attributes].present?
+        @scope = scope.dup
+        @scope.attributes *@options[:attributes] if @options[:attributes]
+        @scope._association [@options[:associations]] if @options[:associations]
+      else
+        @scope = scope
+      end
+    end
+
+    ##
+    # Tries to find the default root key.
+    #
+    # @example
+    #   default_root_key(User) # => 'user'
+    #
+    def default_root_key(object_class)
+      if object_class.respond_to?(:model_name)
+        object_class.model_name.element
+      else
+        object_class.name
+      end
+    end
+
+    ##
+    # Returns JSON using {serializable_hash} which must be implemented on a class.
+    # Uses the root key from @options when set.
+    #
+    def as_json(options={})
+      options = @options.merge(options)
+
+      if options[:root]
+        { options[:root].to_sym => serializable_hash }.merge(meta_hash)
+      else
+        serializable_hash
+      end
+    end
+
+    def meta_hash
+      if meta.present?
+        { :meta => meta }
+      else
+        {}
+      end
+    end
+
+    def meta
+      @options[:meta] || {}
+    end
+
+  end
+end

data/lib/scoped_serializer/collection_serializer.rb

@@ -0,0 +1,12 @@
+module ScopedSerializer
+  class CollectionSerializer < ArraySerializer
+
+    def initialize(*args)
+      super
+
+      # Configure root element
+      @options[:root] = default_root_key(@array.klass).pluralize if @options[:root].nil?
+    end
+
+  end
+end

data/lib/scoped_serializer/default_serializer.rb

@@ -0,0 +1,13 @@
+module ScopedSerializer
+  class DefaultSerializer < BaseSerializer
+
+    def initialize(resource, scope=:default, options={})
+      @resource = resource
+    end
+
+    def as_json(options={})
+      @resource.as_json(options)
+    end
+
+  end
+end

data/lib/scoped_serializer/scope.rb

@@ -0,0 +1,114 @@
+module ScopedSerializer
+  class Scope
+
+    METHODS = [:root, :attributes, :association, :belongs_to, :has_one, :has_many]
+
+    attr_accessor :name, :attributes, :associations, :options
+
+    def initialize(name, default=nil, &block)
+      @name = name
+      @options = {}
+      @attributes = []
+      @associations = {}
+
+      # Merge defaults
+      merge!(default) if default
+
+      self.instance_eval &block if block_given?
+    end
+
+    ##
+    # Merges data with given scope.
+    #
+    # @example
+    #   scope.merge!(another_scope)
+    #
+    def merge!(scope)
+      @options.merge!(scope.options)
+
+      @attributes += scope.attributes
+      @associations.merge!(scope.associations)
+
+      @attributes.uniq!
+
+      self
+    end
+
+    ##
+    # Defines the root key.
+    #
+    # @example
+    #   scope :collection
+    #     root :reservations
+    #   end
+    #
+    def root(key)
+      @options.merge!({ :root => key })
+    end
+
+    ##
+    # Defines attributes.
+    #
+    # @example
+    #   scope :collection
+    #     attributes :status
+    #   end
+    #
+    def attributes(*attrs)
+      if attrs.any?
+        @attributes += attrs
+        @attributes.uniq!
+      else
+        @attributes
+      end
+    end
+
+    ##
+    # Defines an association.
+    #
+    # @example
+    #   scope :collection
+    #     association :customer
+    #     association :posts => :user, :serializer => UserPostSerializer, :root => :user_posts
+    #   end
+    #
+    def association(*args)
+      _association(args, { :preload => true })
+    end
+    alias :belongs_to :association
+    alias :has_one    :association
+    alias :has_many   :association
+
+    ##
+    # Duplicates scope.
+    #
+    def dup
+      clone = Scope.new(name)
+      clone.merge!(self)
+    end
+
+    ##
+    # Actually defines the association but without default_options.
+    #
+    def _association(args, default_options={})
+      return if options.nil?
+
+      options = args.first
+
+      if options.is_a?(Hash)
+        options     = {}.merge(options)
+        name        = options.keys.first
+        properties  = options.delete(name)
+
+        @associations[name] = default_options.merge({ :include => properties }).merge(options)
+      elsif options.is_a?(Array)
+        options.each do |option|
+          association option
+        end
+      else
+        @associations[options] = args[1] || {}
+      end
+    end
+
+  end
+end

data/lib/scoped_serializer/serializer.rb

@@ -0,0 +1,192 @@
+module ScopedSerializer
+  class Serializer < BaseSerializer
+
+    class << self
+
+      attr_accessor :default_scope, :scopes
+
+      ##
+      # Set default values.
+      #
+      def inherited(base)
+        base.scopes = {}
+
+        if scopes.present?
+          # Inheritance from a serializer that has scoped defined
+          scopes.each do |name, scope|
+            base.scopes[name] = Scope.new(name, scope)
+          end
+
+          base.default_scope = base.find_scope(:default)
+        else
+          # Nothing to inherit, set defaults
+          base.default_scope = Scope.new(:default)
+          base.scopes = { :default => base.default_scope }
+        end
+      end
+
+      ##
+      # Defines a scope. In this scope all scopes methods are available. See {ScopedSerializer::Scope}
+      #
+      # @example
+      #   scope :resource do
+      #     association :notes, :employee
+      #   end
+      #
+      def scope(name, &block)
+        self.scopes[name] = Scope.new(name, self.default_scope, &block)
+      end
+
+      ##
+      # Finds a defined scope by name.
+      #
+      def find_scope(name)
+        self.scopes ||= {}
+        self.scopes[name] || self.default_scope || Scope.new(:default)
+      end
+
+      ##
+      # Define available default scope methods.
+      # These are default values, thus define them on every scope.
+      #
+      Scope::METHODS.each do |method|
+        define_method method do |*args|
+          self.scopes.each do |name, scope|
+            scope.send(method, *args)
+          end
+        end
+      end
+
+    end
+
+    attr_reader :resource, :scope, :options
+
+    def initialize(resource, scope=:default, options={})
+      @resource = resource
+      @options  = options || {}
+
+      if options[:scope].present?
+        scope = options[:scope]
+      end
+
+      if scope.is_a?(Symbol)
+        @scope_name = scope
+        @scope = self.class.find_scope(scope)
+      else
+        @scope_name = scope.name
+        @scope = scope
+      end
+
+      set_scope(@scope)
+
+      # Inherit options from scope
+      @options = {}.merge(@scope.options).merge(@options)
+
+      if @resource
+        @options[:root] = default_root_key(@resource.class) unless @options.key?(:root)
+      end
+    end
+
+    ##
+    # Collects attributes for serialization.
+    # Attributes can be overwritten in the serializer.
+    #
+    # @return [Hash]
+    #
+    def attributes_hash
+      @scope.attributes.collect do |attr|
+        [attr, fetch_property(attr)]
+      end.to_h
+    end
+
+    ##
+    # Collects associations for serialization.
+    # Associations can be overwritten in the serializer.
+    #
+    # @return [Hash]
+    #
+    def associations_hash
+      hash = {}
+      @scope.associations.each do |association, options|
+        hash.merge!(render_association(association, options))
+      end
+      hash
+    end
+
+    ##
+    # Renders a specific association.
+    #
+    # @return [Hash]
+    #
+    # @example
+    #   render_association(:employee)
+    #   render_association([:employee, :company])
+    #   render_association({ :employee => :address })
+    #
+    def render_association(association_data, options={})
+      hash = {}
+
+      if association_data.is_a?(Hash)
+        association_data.each do |association, association_options|
+          data = render_association(association, options.merge(:include => association_options))
+          hash.merge!(data) if data
+        end
+      elsif association_data.is_a?(Array)
+        association_data.each do |option|
+          data = render_association(option)
+          hash.merge!(data) if data
+        end
+      else
+        if options[:preload]
+          includes = options[:preload] == true ? options[:include] : options[:preload]
+        end
+
+        object  = fetch_association(association_data, includes)
+        data    = ScopedSerializer.for(object, :default, options.merge(:associations => options[:include])).as_json
+
+        hash.merge!(data) if data
+      end
+
+      hash
+    end
+
+    ##
+    # Fetches property from the serializer or resource.
+    # This method makes it possible to overwrite defined attributes or associations.
+    #
+    def fetch_property(property)
+      return nil unless property
+
+      unless respond_to?(property)
+        object = @resource.send(property)
+      else
+        object = send(property)
+      end
+    end
+
+    ##
+    # Fetches association and eager loads data.
+    # Doesn't eager load when includes is empty or when the association has already been loaded.
+    #
+    # @example
+    #   fetch_association(:comments, :user)
+    #
+    def fetch_association(name, includes=nil)
+      association = fetch_property(name)
+
+      if includes.present? && ! @resource.association(name).loaded?
+        association.includes(includes)
+      else
+        association
+      end
+    end
+
+    ##
+    # The serializable hash returned.
+    #
+    def serializable_hash(options={})
+      {}.merge(attributes_hash).merge(associations_hash)
+    end
+
+  end
+end

data/lib/scoped_serializer/version.rb

@@ -0,0 +1,3 @@
+module ScopedSerializer
+  VERSION = "0.0.1"
+end

data/lib/scoped_serializer.rb

@@ -0,0 +1,87 @@
+require 'scoped_serializer/scope'
+require 'scoped_serializer/base_serializer'
+require 'scoped_serializer/serializer'
+require 'scoped_serializer/default_serializer'
+require 'scoped_serializer/array_serializer'
+require 'scoped_serializer/collection_serializer'
+
+##
+# ScopedSerializer takes care of complex and abstract serialization classes.
+# It does this by allowing serialization scopes. For example, you can define a collection and a resource scope.
+# This means you can render a different JSON output based on context (index/show).
+# You can define any scope you want, there are no predefined scopes.
+#
+# ScopedSerializer supports association and automatically eager loads them when needed.
+#
+# @example
+#
+#   class OrderSerializer < ScopedSerializer::Serializer
+#     attributes :status, :price_in_cents
+#
+#     scope :collection do
+#       association :customer => :addresses
+#     end
+#
+#     scope :resource do
+#       association :customer
+#       association :notes, :employee
+#     end
+#   end
+#
+#  ScopedSerializer.render(@order, :resource)
+#  ScopedSerializer.render(Order.order('id ASC'), :collection)
+#
+
+module ScopedSerializer
+
+  class << self
+
+    ##
+    # Renders a given object.
+    # Object can be an ActiveRecord object, array or a ActiveRecord collection.
+    #
+    # @return [Hash]
+    #
+    def render(object, scope=:default, options={})
+      options.merge!({
+        :super => true
+      })
+
+      self.for(object, scope, options).as_json
+    end
+
+    ##
+    # Returns an instantized serializer for the given object.
+    #
+    def for(object, scope=:default, options={})
+      if object.respond_to?(:each)
+        serializer = find_serializer(object)
+      else
+        serializer = options[:serializer] || find_serializer(object) || DefaultSerializer
+      end
+
+      serializer.new(object, scope, options) if serializer
+    end
+
+    ##
+    # Finds serializer based on object's class.
+    #
+    def find_serializer(object)
+      return object.serializer_class if object.respond_to?(:serializer_class)
+
+      case object
+      when ActiveRecord::Relation, ActiveRecord::Associations::CollectionProxy
+        CollectionSerializer
+      when Array
+        ArraySerializer
+      else
+        find_serializer_by_class(object.class)
+      end
+    end
+
+    def find_serializer_by_class(object_class)
+      "#{object_class.name}Serializer".safe_constantize
+    end
+
+  end
+end

data/lib/tasks/scoped_serializer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :scoped_serializer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: scoped_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arjen Oosterkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Scoped serializers for Rails
+email:
+- mail@arjen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/scoped_serializer.rb
+- lib/scoped_serializer/array_serializer.rb
+- lib/scoped_serializer/base_serializer.rb
+- lib/scoped_serializer/collection_serializer.rb
+- lib/scoped_serializer/default_serializer.rb
+- lib/scoped_serializer/scope.rb
+- lib/scoped_serializer/serializer.rb
+- lib/scoped_serializer/version.rb
+- lib/tasks/scoped_serializer_tasks.rake
+homepage: https://github.com/booqable/scoped_serializer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Scoped serializers for Rails
+test_files: []