scoped_serializer 0.1.0 → 1.0.0.b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c32261f4040ce1b81c7e955dc1e0122163cde4d
-  data.tar.gz: b84e63cf91a309ea2b683af89cc260ea51028506
+  metadata.gz: 0e9612c4d1cdb699e0f40eb48488a7070c2c0061
+  data.tar.gz: 81cba16a43b750cc6cb0f0a5d430f6f7ac9dcb09
 SHA512:
-  metadata.gz: db2ffb1aa94ce0bf5e6d57187079ecd7fc993e1429a718f4a13050e3449752bb45abda201d1ca1ac44e256c5ac3142f861a052cb33c2ad40db28a949d14ea8ab
-  data.tar.gz: 44234ef5494e7eacd4ed8a77a30e0718d6f89254143d50c8f3a1add90be4f00540f314686753a6bc2b3c110afe22dca0cacca027d256d5ec0d8a6c112492f20c
+  metadata.gz: 7d1b6de7261469f277e6f68b18317b57d6e5f7a769d54f12043ee746131d46cbb5bb6d4ca08c64edf697ef44a830be0a570d0949729bad0c3692a7a16c8c35fa
+  data.tar.gz: 75f0c405ffcb113f1ad0a8ccfc05f24b4393023d40de02485b22f5ae3f7349a5e1706dfc001ba5415df7851013bfa553fc2f4661833f10a513ee7561235a746b

data/lib/action_controller/serialization.rb

@@ -0,0 +1,50 @@
+module ActionController
+  module Serialization
+
+    extend ActiveSupport::Concern
+
+    ##
+    # Returns scope based on action.
+    #
+    def serializer_scope
+      scope = case action_name
+      when 'new', 'show', 'edit', 'update', 'create', 'destroy'
+        :resource
+      when 'index'
+        :collection
+      else
+        :default
+      end
+    end
+
+    ##
+    # Default serializer options.
+    #
+    def default_serializer_options
+      {}
+    end
+
+    ##
+    # JSON serializer to use.
+    #
+    def build_json_serializer(object, options={})
+      ScopedSerializer.for(object, { :scope => serializer_scope, :super => true }.merge(options.merge(default_serializer_options)))
+    end
+
+    ##
+    # Renders specific JSON serializer see {ScopedSerializer}.
+    #
+    [:_render_option_json, :_render_with_renderer_json].each do |method|
+      define_method method do |resource, options|
+        serializer = build_json_serializer(resource, options)
+
+        if serializer
+          super(serializer, options)
+        else
+          super(resource, options)
+        end
+      end
+    end
+
+  end
+end

data/lib/scoped_serializer/array_serializer.rb

@@ -1,18 +1,15 @@
 module ScopedSerializer
   class ArraySerializer < BaseSerializer
 
-    attr_reader :array, :scope, :scope_name, :options
+    attr_reader :array, :options
 
-    def initialize(array, scope_name=:default, options={})
+    def initialize(array, 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
+      serializable_objects.collect(&:as_json)
     end
 
     def meta
@@ -25,5 +22,28 @@ module ScopedSerializer
       data
     end
 
+    ##
+    # Returns attributes as a CSV string.
+    #
+    def to_csv(options={})
+      columns = options.delete(:columns)
+
+      CSV.generate(options) do |csv|
+        csv << columns if columns.present?
+
+        serializable_objects.each do |object|
+          csv << object.attributes_hash.values
+        end
+      end
+    end
+
+    protected
+
+      def serializable_objects
+        @serializable_objects ||= array.collect do |object|
+          ScopedSerializer.for(object, @options.merge(:root => false))
+        end
+      end
+
   end
 end

data/lib/scoped_serializer/base_serializer.rb

@@ -1,3 +1,5 @@
+require 'csv'
+
 module ScopedSerializer
   class BaseSerializer
 
@@ -54,5 +56,24 @@ module ScopedSerializer
       @options[:meta] || {}
     end
 
+    ##
+    # Returns attributes as a CSV string.
+    #
+    def to_csv(options={})
+      CSV.generate(options) do |csv|
+        csv << scope.attributes
+        csv << attributes_hash.values
+      end
+    end
+
+    ##
+    # Returns attributes as an XLS string.
+    #
+    def to_xls(options={})
+      options.merge!(:col_sep => "\t")
+
+      to_csv(options)
+    end
+
   end
 end

data/lib/scoped_serializer/collection_serializer.rb

@@ -4,8 +4,21 @@ module ScopedSerializer
     def initialize(*args)
       super
 
+      options = args.extract_options!
+
+      # Allow to define own model class
+      @model_class = options.delete(:model_class) || @array.klass
+
       # Configure root element
-      @options[:root] = default_root_key(@array.klass).pluralize if @options[:root].nil?
+      @options[:root] = default_root_key(@model_class).pluralize if @options[:root].nil?
+    end
+
+    def to_csv(options={})
+      attributes = ScopedSerializer.find_serializer_by_class(@model_class)
+             .find_scope(options[:scope] || :default)
+             .attributes
+
+      super(options.merge(:columns => attributes))
     end
 
   end

data/lib/scoped_serializer/serializer.rb

@@ -61,13 +61,10 @@ module ScopedSerializer
 
     attr_reader :resource, :scope, :options
 
-    def initialize(resource, scope=:default, options={})
+    def initialize(resource, options={})
       @resource = resource
       @options  = options || {}
-
-      if options[:scope].present?
-        scope = options[:scope]
-      end
+      scope = options[:scope] || :default
 
       if scope.is_a?(Symbol)
         @scope_name = scope
@@ -146,7 +143,7 @@ module ScopedSerializer
         end
 
         object  = fetch_association(association_data, includes)
-        data    = ScopedSerializer.for(object, :default, options.merge(:associations => options[:include])).as_json
+        data    = ScopedSerializer.for(object, options.merge(:associations => options[:include])).as_json
 
         hash.merge!(data) if data
       end

data/lib/scoped_serializer/version.rb

@@ -1,3 +1,3 @@
 module ScopedSerializer
-  VERSION = "0.1.0"
+  VERSION = "1.0.0.b"
 end

data/lib/scoped_serializer.rb

@@ -5,6 +5,17 @@ require 'scoped_serializer/default_serializer'
 require 'scoped_serializer/array_serializer'
 require 'scoped_serializer/collection_serializer'
 
+begin
+  require 'action_controller'
+  require 'action_controller/serialization'
+
+  ActiveSupport.on_load(:action_controller) do
+    include ::ActionController::Serialization
+  end
+rescue LoadError
+  # No Rails?
+end
+
 ##
 # 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.
@@ -28,8 +39,8 @@ require 'scoped_serializer/collection_serializer'
 #     end
 #   end
 #
-#  ScopedSerializer.render(@order, :resource)
-#  ScopedSerializer.render(Order.order('id ASC'), :collection)
+#  ScopedSerializer.render(@order, :scope => :resource)
+#  ScopedSerializer.render(Order.order('id ASC'), :scope => :collection)
 #
 
 module ScopedSerializer
@@ -42,25 +53,25 @@ module ScopedSerializer
     #
     # @return [Hash]
     #
-    def render(object, scope=:default, options={})
+    def render(object, options={})
       options.merge!({
         :super => true
       })
 
-      self.for(object, scope, options).as_json
+      self.for(object, options).as_json
     end
 
     ##
     # Returns an instantized serializer for the given object.
     #
-    def for(object, scope=:default, options={})
+    def for(object, 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
+      serializer.new(object, options) if serializer
     end
 
     ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scoped_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0.b
 platform: ruby
 authors:
 - Arjen Oosterkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: actionpack
+  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: activesupport
+  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
@@ -117,6 +159,7 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - Rakefile
+- lib/action_controller/serialization.rb
 - lib/scoped_serializer.rb
 - lib/scoped_serializer/array_serializer.rb
 - lib/scoped_serializer/base_serializer.rb
@@ -141,12 +184,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Scoped serializers for Rails