adequate_serializer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75d51f7e119da79d4844eaf7588c35f5822f1d3a
-  data.tar.gz: 5f287e45995db1e14a3cba9224c30696037005a5
+  metadata.gz: 41bf0c76c529a67b403e18abe9130b3f45c67212
+  data.tar.gz: 01f9a35b1d5b2563b1798915173144e89d5a7ea1
 SHA512:
-  metadata.gz: 64b355e2ca1f0f92e0e7db1d321e8a98fbd15cd010c01616b05ccb5ef8d9da4341945710f95b6907b76c4eaf8805247458d15e5e41982f7a4fcef5803a8b031e
-  data.tar.gz: a9c19e14e8ba3672d61b6e1311bc3ffe7ec1290d9e675d916b22a9acda90c9a258c5451879cc4057792fc4d2e541c9219b68df6beedd13f7eea6757fa4a16eab
+  metadata.gz: a837ae3287a6b6b38e3dd35c17a5705f19dcfde73c02a3045ab3fb2879bf53f3c620ef0bdb2c4d29c378110cadd5ad2c16903feb91798999a0eb5c2551e2c83d
+  data.tar.gz: 905b0dca87e74872e8618b4a511f896cbb369c261854e71dcaec3857187c7e2b3c2a1c423ddc3fb9ea80dee00e4160b6472d4796df5778277914217d50174c5d

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,258 @@
+AccessorMethodName:
+  Enabled: false
+
+ActionFilter:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: leading
+
+DoubleNegation:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+InlineComment:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 85
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+Next:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false

data/README.md

@@ -139,6 +139,29 @@ class UserSerializer::Base
 end
 ```
 
+#### Scope
+
+By default, the `current_user` is available in the serializer as `scope`.
+
+```ruby
+class UserSerializer::Base
+  attributes :id, :created_at, :updated_at
+  associations :posts
+
+  def posts
+    Post.where(user_id: scope.id).published
+  end
+end
+```
+
+The scope can be customized in the controller.
+
+```ruby
+serialization_scope :user_id
+```
+
+In this example the `user_id` will be available as `scope`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/adequate_serializer/base.rb

@@ -29,12 +29,13 @@ module AdequateSerializer
       end
     end
 
-    attr_accessor :object, :includes, :root
+    attr_accessor :object, :includes, :root, :scope
 
-    def initialize(object, includes: nil, root: nil)
+    def initialize(object, options = {})
       @object = object
-      @includes = includes
-      @root = root
+      @includes = options[:includes]
+      @root = options[:root]
+      @scope = options[:scope]
     end
 
     def as_json(options = {})
@@ -98,7 +99,9 @@ module AdequateSerializer
       associated_objects = associated_objects(association_key)
 
       unless associated_objects.nil?
-        serialize(associated_objects, root: false, includes: includes)
+        serialize(
+          associated_objects, root: false, includes: includes, scope: scope
+        )
       end
     end
 

data/lib/adequate_serializer/collection.rb

@@ -5,19 +5,17 @@ module AdequateSerializer
   class Collection
     include Helper
 
-    attr_accessor :collection, :includes, :root, :serializer
+    attr_accessor :collection, :root, :collection_options
 
-    def initialize(collection, includes: nil, root: nil, serializer: nil)
+    def initialize(collection, options = {})
       @collection = collection
-      @includes = includes
-      @root = root
-      @serializer = serializer
+      @root = options.delete(:root)
+      @collection_options = options
+      @collection_options[:root] = false
     end
 
     def as_json(options = {})
-      data = collection.map do |item|
-        serialize(item, includes: includes, root: false, serializer: serializer)
-      end
+      data = collection.map { |item| serialize(item, collection_options) }
 
       if root == false
         data

data/lib/adequate_serializer/controller.rb

@@ -0,0 +1,44 @@
+require 'adequate_serializer/helper'
+
+module AdequateSerializer
+  module Controller
+    include Helper
+
+    alias_method :helper_serialize, :serialize
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        self._serialization_scope = :current_user
+      end
+    end
+
+    module ClassMethods
+      attr_accessor :_serialization_scope
+
+      def inherited(base)
+        base._serialization_scope = _serialization_scope
+      end
+
+      def serialization_scope(scope)
+        self._serialization_scope = scope
+      end
+    end
+
+    def serialize(entity, options = {})
+      options[:scope] = serialization_scope
+
+      helper_serialize(entity, options)
+    end
+
+    private
+
+    def serialization_scope
+      scope = self.class._serialization_scope
+
+      if scope && respond_to?(scope, true)
+        send(scope)
+      end
+    end
+  end
+end

data/lib/adequate_serializer/helper.rb

@@ -1,14 +1,19 @@
 module AdequateSerializer
   module Helper
-    def serialize(entity, includes: nil, root: nil, serializer: nil)
+    def serialize(entity, options = {})
       if entity.respond_to?(:each)
-        Collection.new(
-          entity, includes: includes, root: root, serializer: serializer
-        ).as_json
+        serializer = Collection
       else
-        serializer ||= Object.const_get("#{entity.class}Serializer")
-        serializer.new(entity, includes: includes, root: root).as_json
+        serializer = options[:serializer] || serializer_klass(entity)
       end
+
+      serializer.new(entity, options).as_json
+    end
+
+    private
+
+    def serializer_klass(entity)
+      Object.const_get("#{entity.class}Serializer")
     end
   end
 end

data/lib/adequate_serializer/railtie.rb

@@ -2,7 +2,7 @@ module AdequateSerializer
   class Railtie < Rails::Railtie
     initializer 'adequate_serializer.setup_helper' do
       ActiveSupport.on_load :action_controller do
-        include AdequateSerializer::Helper
+        include AdequateSerializer::Controller
       end
     end
   end

data/lib/adequate_serializer/version.rb

@@ -1,3 +1,3 @@
 module AdequateSerializer
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/adequate_serializer.rb

@@ -1,6 +1,7 @@
 require 'adequate_serializer/base'
 require 'adequate_serializer/collection'
 require 'adequate_serializer/helper'
+require 'adequate_serializer/controller'
 require 'adequate_serializer/version'
 require 'adequate_serializer/railtie' if defined?(Rails)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adequate_serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bastian Bartmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -86,6 +88,7 @@ files:
 - lib/adequate_serializer.rb
 - lib/adequate_serializer/base.rb
 - lib/adequate_serializer/collection.rb
+- lib/adequate_serializer/controller.rb
 - lib/adequate_serializer/helper.rb
 - lib/adequate_serializer/railtie.rb
 - lib/adequate_serializer/version.rb