serializer_field_filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b0dbf86f5db59c3f5ea4c6745e5ec3e823ad168
+  data.tar.gz: aaaa85edaf7b4f0ec44d2884aaedcfa534b58460
+SHA512:
+  metadata.gz: b042e03ea9805186345d0e85df506104f078e540a8a407e4bb9bcb68c68fe74f3bb50510a2447029b1c72ec0a515ea2e8c9e395b484d2788502bbe4f05f4dc8b
+  data.tar.gz: 0aabe79773c1b83d38ed094c8a0f5d34ab7c009f94856bf79cebe207a257082710d3cb9349117007af1361ba5500f4fdc17a9f3fa02deba38bfebd0616df02f1

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+*.tmproj
+.rbenv-version
+.ruby-gemset
+.ruby-version
+# Appraisal generated lockfiles
+*.gemfile.lock
+.DS_Store
+coverage/*
+.byebug-history

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rails', '>= 5.0.0'
+gem 'byebug'

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007 David Heinemeier Hansson
+
+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/README.md

@@ -0,0 +1,76 @@
+## serializer_field_filter
+
+field filter for [active_model_serializers](https://github.com/rails-api/active_model_serializers)
+
+
+### Install
+
+gem install 'serializer_field_filter'
+
+### Usage
+
+```Ruby
+  class BaseSerializer < ActiveModel::Serializer
+    include SerializerFieldFilter::Relation
+  end
+
+  class CourceSerializer < BaseSerializer
+    attributes :id, :name
+    has_one_with_filter :classroom
+    belongs_to_with_filter :teacher
+    has_many_with_filter :students
+  end
+
+  class ClassroomSerializer < BaseSerializer
+    attributes :id, :name
+  end
+
+  class TeacherSerializer < BaseSerializer
+    attributes :id, :name
+  end
+
+  class StudentSerializer < BaseSerializer
+    attributes :id, :name
+  end
+
+  class BaseModel
+    include ActiveModel::Model
+    include ActiveModel::Serialization
+  end
+
+  class Cource < BaseModel
+    attr_accessor :id, :name, :classroom, :teacher, :students
+  end
+
+  class Classroom < BaseModel
+    attr_accessor :id, :name
+  end
+
+  class Teacher < BaseModel
+    attr_accessor :id, :name
+  end
+
+  class Student < BaseModel
+    attr_accessor :id, :name
+  end
+
+  classroom = Classroom.new(id: 1, name: "classroom")
+  teacher   = Teacher.new(id: 1, name: "teacher")
+  student_1 = Student.new(id: 1, name: "student")
+  student_2 = Student.new(id: 2, name: "student")
+  cource    = Cource.new(id: 1, name: "cource", classroom: classroom, teacher: teacher, students: [student_1, student_2])
+
+  filter = SerializerFieldFilter.init(%w(id name classroom teacher.name students.id))
+
+  json = ActiveModelSerializers::SerializableResource.new(cource, filter.resource_options).as_json
+  # => {
+  #   id: 1,
+  #   name: 'cource',
+  #   classroom: { id: 1, name: 'classroom' },
+  #   teacher: { name: 'teacher' },
+  #   students: [
+  #     { id: 1 },
+  #     { id: 2 }
+  #   ]
+  # }
+  ```

data/Rakefile

@@ -0,0 +1,3 @@
+require "rubygems"
+require "bundler/setup"
+Bundler::GemHelper.install_tasks

data/lib/serializer_field_filter/all_field.rb

@@ -0,0 +1,12 @@
+class SerializerFieldFilter
+  class AllField
+    include ResourceOptions
+
+    def root_fields
+    end
+
+    def scope_of(resource_name)
+      AllField.new
+    end
+  end
+end

data/lib/serializer_field_filter/none_field.rb

@@ -0,0 +1,13 @@
+class SerializerFieldFilter
+  class NoneField
+    include ResourceOptions
+
+    def root_fields
+      []
+    end
+
+    def scope_of(resource_name)
+      NoneField.new
+    end
+  end
+end

data/lib/serializer_field_filter/relation.rb

@@ -0,0 +1,37 @@
+class SerializerFieldFilter
+  module Relation
+    extend ActiveSupport::Concern
+    included do
+      [:has_many, :belongs_to, :has_one].each do |relation_method_name|
+        class_eval <<-RUBY
+          def self.#{relation_method_name}_with_filter(resource_name, serializer: nil)
+            attribute resource_name
+            resource_method_module = Module.new do
+              define_method resource_name do
+                filter = instance_options[:field_filter]&.scope_of(resource_name)
+                resource_options = filter.resource_options.merge({
+                  serializer: serializer,
+                })
+                resources = defined?(super) ? super() : object.send(resource_name)
+                if "#{relation_method_name}" == "has_many"
+                  resources.to_a.map do |resource|
+                    serializer_for_resource(resource, resource_options) if resource.present?
+                  end
+                else
+                  serializer_for_resource(resources, resource_options) if resources.present?
+                end
+              end
+            end
+            prepend resource_method_module
+          end
+        RUBY
+      end
+
+      private
+
+      def serializer_for_resource(resource, resource_options)
+        ActiveModelSerializers::SerializableResource.new(resource, resource_options).as_json
+      end
+    end
+  end
+end

data/lib/serializer_field_filter/resource_options.rb

@@ -0,0 +1,10 @@
+class SerializerFieldFilter
+  module ResourceOptions
+    extend ActiveSupport::Concern
+    included do
+      def resource_options
+        { fields: root_fields, field_filter: self }
+      end
+    end
+  end
+end

data/lib/serializer_field_filter/version.rb

@@ -0,0 +1,3 @@
+class SerializerFieldFilter
+  VERSION = "0.0.1"
+end

data/lib/serializer_field_filter.rb

@@ -0,0 +1,35 @@
+require "active_model_serializers"
+require "serializer_field_filter/version"
+require "serializer_field_filter/resource_options"
+require "serializer_field_filter/all_field"
+require "serializer_field_filter/none_field"
+require "serializer_field_filter/relation"
+
+class SerializerFieldFilter
+  include ResourceOptions
+
+  attr_reader :fields
+
+  def initialize(fields = [])
+    @fields = fields
+  end
+
+  def self.init(fields = nil)
+    fields.present? ? new(fields) : AllField.new
+  end
+
+  def root_fields
+    return if fields.blank?
+    fields.map { |field| field.split('.').first.to_sym }.uniq
+  end
+
+  def scope_of(resource_name)
+    if fields.include?(resource_name.to_s)
+      AllField.new
+    else
+      scope_fields = fields.select { |field| field.start_with?("#{resource_name}.") }
+                           .map { |field| field.split('.', 2).last }
+      scope_fields.present? ? SerializerFieldFilter.new(scope_fields) : NoneField.new
+    end
+  end
+end

data/serializer_field_filter.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serializer_field_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serializer_field_filter"
+  spec.version       = SerializerFieldFilter::VERSION
+  spec.authors       = ["Franky"]
+  spec.email         = ["zhanglinjie412@gmail.com"]
+  spec.description   = %q{field filter for active_model_serializers}
+  spec.summary       = %q{field filter for active_model_serializers}
+  spec.homepage      = "https://github.com/zhanglinjie/serializer_field_filter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'active_model_serializers'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/serializer_field_filter/all_field_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+describe SerializerFieldFilter::AllField do
+  subject(:filter) { SerializerFieldFilter::AllField.new }
+  describe '#root_fields' do
+    it { expect(filter.root_fields).to eq(nil) }
+  end
+
+  describe '#scope_of' do
+    it { expect(filter.scope_of(:authors)).to be_a SerializerFieldFilter::AllField }
+  end
+end

data/spec/serializer_field_filter/none_field_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+describe SerializerFieldFilter::NoneField do
+  subject(:filter) { SerializerFieldFilter::NoneField.new }
+  describe '#root_fields' do
+    it { expect(filter.root_fields).to eq([]) }
+  end
+
+  describe '#scope_of' do
+    it { expect(filter.scope_of(:authors)).to be_a SerializerFieldFilter::NoneField }
+  end
+end

data/spec/serializer_field_filter/relation_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper"
+describe SerializerFieldFilter::Relation do
+  class BaseSerializer < ActiveModel::Serializer
+    include SerializerFieldFilter::Relation
+  end
+
+  class CourceSerializer < BaseSerializer
+    attributes :id, :name
+    has_one_with_filter :classroom
+    belongs_to_with_filter :teacher
+    has_many_with_filter :students
+  end
+
+  class ClassroomSerializer < BaseSerializer
+    attributes :id, :name
+  end
+
+  class TeacherSerializer < BaseSerializer
+    attributes :id, :name
+  end
+
+  class StudentSerializer < BaseSerializer
+    attributes :id, :name
+  end
+
+  class BaseModel
+    include ActiveModel::Model
+    include ActiveModel::Serialization
+  end
+
+  class Cource < BaseModel
+    attr_accessor :id, :name, :classroom, :teacher, :students
+  end
+
+  class Classroom < BaseModel
+    attr_accessor :id, :name
+  end
+
+  class Teacher < BaseModel
+    attr_accessor :id, :name
+  end
+
+  class Student < BaseModel
+    attr_accessor :id, :name
+  end
+
+  let(:classroom)    { Classroom.new(id: 1, name: "classroom") }
+  let(:teacher)   { Teacher.new(id: 1, name: "teacher") }
+  let(:student_1) { Student.new(id: 1, name: "student") }
+  let(:student_2) { Student.new(id: 2, name: "student") }
+  let(:cource)    { Cource.new(id: 1, name: "cource", classroom: classroom, teacher: teacher, students: [student_1, student_2])}
+
+  subject(:json) {
+    ActiveModelSerializers::SerializableResource.new(cource, filter.resource_options).as_json
+  }
+
+  context "with all field" do
+    let(:filter) { SerializerFieldFilter::AllField.new }
+    it { should eq({
+        id: 1,
+        name: 'cource',
+        classroom: { id: 1, name: 'classroom' },
+        teacher: { id: 1, name: 'teacher' },
+        students: [
+          { id: 1, name: 'student' },
+          { id: 2, name: 'student' }
+        ]
+      })
+     }
+  end
+
+  context "with none field" do
+    let(:filter) { SerializerFieldFilter::NoneField.new  }
+    it { should eq({})}
+  end
+
+  context "with root partial field" do
+    let(:filter) { SerializerFieldFilter.init(['id'])  }
+    it { should eq({ id: 1 }) }
+  end
+
+  context "with has_one all fields" do
+    let(:filter) { SerializerFieldFilter.init(['classroom'])  }
+    it { should eq({
+        classroom: { id: 1, name: 'classroom' }
+      })
+    }
+  end
+
+  context "with has_one partial fields" do
+    let(:filter) { SerializerFieldFilter.init(['classroom.id'])  }
+    it { should eq({
+        classroom: { id: 1 }
+      })
+    }
+  end
+
+  context "with belongs_to all fields" do
+    let(:filter) { SerializerFieldFilter.init(['teacher'])  }
+    it { should eq({
+        teacher: { id: 1, name: 'teacher' }
+      })
+    }
+  end
+
+  context "with belongs_to partial fields" do
+    let(:filter) { SerializerFieldFilter.init(['teacher.id'])  }
+    it { should eq({
+        teacher: { id: 1 }
+      })
+    }
+  end
+
+  context "with has_many all fields" do
+    let(:filter) { SerializerFieldFilter.init(['students'])  }
+    it { should eq({
+        students: [
+          { id: 1, name: 'student' },
+          { id: 2, name: 'student' }
+        ]
+      })
+    }
+  end
+
+  context "with has_many partial fields" do
+    let(:filter) { SerializerFieldFilter.init(['students.id'])  }
+    it { should eq({
+        students: [
+          { id: 1 },
+          { id: 2 }
+        ]
+      })
+    }
+  end
+end

data/spec/serializer_field_filter_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'spec_helper'
+RSpec.describe SerializerFieldFilter do
+  describe "::init" do
+    context "with nil params" do
+      subject { SerializerFieldFilter.init }
+      it { should be_a SerializerFieldFilter::AllField }
+    end
+
+    context "with empty params" do
+      subject { SerializerFieldFilter.init([]) }
+      it { should be_a SerializerFieldFilter::AllField }
+    end
+
+    context "with present params" do
+      subject { SerializerFieldFilter.init(['id', 'name']) }
+      it { should be_a SerializerFieldFilter }
+    end
+  end
+
+  describe "#root_fields" do
+    context "with fields depth 1" do
+      subject { SerializerFieldFilter.init(['id', 'name']).root_fields }
+      it { should eq([:id, :name]) }
+    end
+
+    context "with fields depth 2" do
+      subject { SerializerFieldFilter.init(['id', 'name', 'authors.id', 'authors.name']).root_fields }
+      it { should eq([:id, :name, :authors]) }
+    end
+  end
+
+  describe '#scope_of' do
+    context "with none fields" do
+      subject { SerializerFieldFilter.init(['id', 'title']).scope_of(:authors) }
+      it { should be_a SerializerFieldFilter::NoneField }
+    end
+
+    context "with all fields" do
+      subject { SerializerFieldFilter.init(['id', 'title', 'authors']).scope_of(:authors) }
+      it { should be_a SerializerFieldFilter::AllField }
+    end
+
+    context "with partial fields" do
+      subject { SerializerFieldFilter.init(['id', 'title', 'authors.id', 'authors.name']).scope_of(:authors) }
+      it { should be_a SerializerFieldFilter }
+      it { expect(subject.root_fields).to eq([:id, :name])}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'byebug'
+require 'rspec'
+require 'rails/all'
+require 'active_model_serializers'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'serializer_field_filter'
+
+ActiveModelSerializers.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new('/dev/null'))
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: serializer_field_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Franky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-16 00:00:00.000000000 Z
+dependencies:
+- !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: 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: active_model_serializers
+  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: rspec
+  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: simplecov
+  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: field filter for active_model_serializers
+email:
+- zhanglinjie412@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/serializer_field_filter.rb
+- lib/serializer_field_filter/all_field.rb
+- lib/serializer_field_filter/none_field.rb
+- lib/serializer_field_filter/relation.rb
+- lib/serializer_field_filter/resource_options.rb
+- lib/serializer_field_filter/version.rb
+- serializer_field_filter.gemspec
+- spec/serializer_field_filter/all_field_spec.rb
+- spec/serializer_field_filter/none_field_spec.rb
+- spec/serializer_field_filter/relation_spec.rb
+- spec/serializer_field_filter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zhanglinjie/serializer_field_filter
+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.5.2
+signing_key: 
+specification_version: 4
+summary: field filter for active_model_serializers
+test_files:
+- spec/serializer_field_filter/all_field_spec.rb
+- spec/serializer_field_filter/none_field_spec.rb
+- spec/serializer_field_filter/relation_spec.rb
+- spec/serializer_field_filter_spec.rb
+- spec/spec_helper.rb