forestadmin-jsonapi-serializers 2.0.0.pre.beta.2

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'factory_girl'
+require './lib/jsonapi-serializers'
+require './spec/support/serializers'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.before(:each) do
+    # Force FactoryGirl sequences to be fully reset before each test run to simplify ID testing
+    # since we are not using a database or real fixtures. Inside of each test case, IDs will
+    # increment per type starting at 1.
+    FactoryGirl.reload
+    load './spec/support/factory.rb'
+  end
+end

data/spec/support/factory.rb

@@ -0,0 +1,44 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+  factory :post, class: MyApp::Post do
+    skip_create
+    sequence(:id) {|n| n }
+    sequence(:title) {|n| "Title for Post #{n}" }
+    sequence(:body) {|n| "Body for Post #{n}" }
+
+    trait :with_author do
+      association :author, factory: :user
+    end
+  end
+
+  # Post with some added property to test inheritance in serializer.
+  factory :tagged_post, class: MyApp::TaggedPost do
+    skip_create
+    sequence(:id) {|n| n }
+    sequence(:title) {|n| "Title for TaggedPost #{n}" }
+    sequence(:body) {|n| "Body for TaggedPost #{n}" }
+    sequence(:tag) {|n| "Tag for TaggedPost #{n}" }
+
+    trait :with_author do
+      association :author, factory: :user
+    end
+  end
+
+  factory :long_comment, class: MyApp::LongComment do
+    skip_create
+    sequence(:id) {|n| n }
+    sequence(:body) {|n| "Body for LongComment #{n}" }
+  end
+
+  factory :user, class: MyApp::User do
+    skip_create
+    sequence(:id) {|n| n }
+    sequence(:name) {|n| "User ##{n}"}
+  end
+
+  factory :underscore_test, class: MyApp::UnderscoreTest do
+    skip_create
+    sequence(:id) {|n| n }
+  end
+end

data/spec/support/serializers.rb

@@ -0,0 +1,264 @@
+module MyApp
+  class Post
+    attr_accessor :id
+    attr_accessor :title
+    attr_accessor :body
+    attr_accessor :author
+    attr_accessor :long_comments
+  end
+
+  class TaggedPost
+    attr_accessor :id
+    attr_accessor :title
+    attr_accessor :body
+    attr_accessor :tag
+    attr_accessor :author
+    attr_accessor :long_comments
+  end
+
+  class LongComment
+    attr_accessor :id
+    attr_accessor :body
+    attr_accessor :user
+    attr_accessor :post
+
+    # Just a copy of the default implementation, we need this to exist to be able to stub in tests.
+    def jsonapi_serializer_class_name
+      'MyApp::LongCommentSerializer'
+    end
+  end
+
+  class User
+    attr_accessor :id
+    attr_accessor :name
+
+    def jsonapi_serializer_class_name
+      'MyAppOtherNamespace::UserSerializer'
+    end
+  end
+
+  class UnderscoreTest
+    attr_accessor :id
+
+    def tagged_posts
+      []
+    end
+  end
+
+  class PostSerializer
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :title
+    attribute :long_content do
+      object.body
+    end
+
+    has_one :author
+    has_many :long_comments
+  end
+
+  class UnderscoreTestSerializer
+    include ForestAdmin::JSONAPI::Serializer
+
+    has_many :tagged_posts
+
+    def format_name(attribute_name)
+      attribute_name.to_s.underscore
+    end
+  end
+
+  class LongCommentSerializer
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :body
+    has_one :user
+
+    # Circular-reference back to post.
+    has_one :post
+  end
+
+  # More customized, one-off serializers to test particular behaviors:
+
+  class SimplestPostSerializer
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :title
+    attribute :long_content do
+      object.body
+    end
+
+    def type
+      :posts
+    end
+  end
+
+  class PostSerializerWithMetadata
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :title
+    attribute :long_content do
+      object.body
+    end
+
+    def type
+      'posts'  # Intentionally test string type.
+    end
+
+    def meta
+      {
+        'copyright' => 'Copyright 2015 Example Corp.',
+        'authors' => ['Aliens'],
+      }
+    end
+  end
+
+  class PostSerializerWithoutIncludeLinks
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :title
+
+    has_one :author, include_links: false
+    has_many :long_comments, include_links: false
+
+    def type
+      :posts
+    end
+  end
+
+  class PostSerializerWithIncludeData
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :title
+
+    has_one :author, include_data: true
+    has_many :long_comments, include_data: true
+
+    def type
+      :posts
+    end
+  end
+
+  class PostSerializerWithContext < PostSerializer
+    attribute :body, if: :show_body?, unless: :hide_body?
+
+    def show_body?
+      context.fetch(:show_body, true)
+    end
+
+    def hide_body?
+      context.fetch(:hide_body, false)
+    end
+  end
+
+  class LongCommentsSerializerWithContext
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :body, if: :show_body?
+    has_one :user, if: :show_comments_user?
+
+    def show_body?
+      context.fetch(:show_body, true)
+    end
+
+    def show_comments_user?
+      context.fetch(:show_comments_user, true)
+    end
+  end
+
+
+  class PostSerializerWithoutLinks
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :title
+    attribute :long_content do
+      object.body
+    end
+
+    has_one :author
+    has_many :long_comments
+
+    def self_link
+      nil
+    end
+
+    def relationship_self_link(attribute_name)
+      nil
+    end
+
+    def relationship_related_link(attribute_name)
+      nil
+    end
+  end
+
+  class PostSerializerWithBaseUrl
+    include ForestAdmin::JSONAPI::Serializer
+
+    def base_url
+      'http://example.com'
+    end
+
+    attribute :title
+    attribute :long_content do
+      object.body
+    end
+
+    has_one :author
+    has_many :long_comments
+  end
+
+  class EmptySerializer
+    include ForestAdmin::JSONAPI::Serializer
+  end
+
+  class MultipleAttributesSerializer
+    include ForestAdmin::JSONAPI::Serializer
+
+    attributes :title, :body
+  end
+
+  class PostSerializerWithInheritedProperties < PostSerializer
+    # Add only :tag, inherit the rest.
+    attribute :tag
+  end
+end
+
+# Test the `jsonapi_serializer_class_name` override method for serializers in different namespaces.
+# There is no explicit test for this, just implicit tests that correctly serialize User objects.
+module MyAppOtherNamespace
+  class UserSerializer
+    include ForestAdmin::JSONAPI::Serializer
+
+    attribute :name
+  end
+end
+
+module Api
+  module V1
+    module MyApp
+      class UserSerializer
+        include ForestAdmin::JSONAPI::Serializer
+
+        attribute :name
+      end
+
+      class PostSerializer
+        include ForestAdmin::JSONAPI::Serializer
+
+        attribute :title
+
+        has_one :author
+        has_many :long_comments
+      end
+
+      class LongCommentSerializer
+        include ForestAdmin::JSONAPI::Serializer
+
+        attribute :body
+        has_one :user
+
+        # Circular-reference back to post.
+        has_one :post
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: forestadmin-jsonapi-serializers
+version: !ruby/object:Gem::Version
+  version: 2.0.0.pre.beta.2
+platform: ruby
+authors:
+- Mike Fotinakis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Pure Ruby readonly serializers for the JSON:API spec.
+email:
+- mike@fotinakis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- forestadmin-jsonapi-serializers.gemspec
+- lib/jsonapi-serializers.rb
+- lib/jsonapi-serializers/attributes.rb
+- lib/jsonapi-serializers/serializer.rb
+- lib/jsonapi-serializers/version.rb
+- spec/serializer_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory.rb
+- spec/support/serializers.rb
+homepage: https://github.com/forestadmin/jsonapi-serializers
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Pure Ruby readonly serializers for the JSON:API spec.
+test_files:
+- spec/serializer_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory.rb
+- spec/support/serializers.rb