jat 0.0.1 → 0.0.3

data/test/lib/jat_test.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Jat do
+  let(:jat_class) { Class.new(Jat) }
+
+  describe ".plugin" do
+    it "raises error when trying to load not a symbol or module" do
+      plugin = "TEST_PLUGIN"
+      error = assert_raises(Jat::Error) { jat_class.plugin(plugin) }
+
+      error_message = "Plugin class must be a Symbol or a Module, #{plugin.inspect} given"
+      assert_equal error_message, error.message
+    end
+  end
+
+  describe ".config" do
+    it "returns config object" do
+      config = jat_class.config
+      assert_equal jat_class::Config, config.class
+    end
+  end
+
+  describe ".inherited" do
+    let(:parent) { jat_class }
+
+    it "inherits config class with same options" do
+      parent.config[:foo] = :bar
+      child = Class.new(parent)
+
+      assert_equal parent::Config, child::Config.superclass
+      assert_equal :bar, child.config[:foo]
+    end
+
+    it "inherits attributes" do
+      parent.attribute(:foo) { :bar }
+      child = Class.new(parent)
+
+      assert_equal parent::Attribute, child::Attribute.superclass
+      assert child.attributes[:foo]
+    end
+
+    it "inherits presenter" do
+      child = Class.new(parent)
+      assert_equal parent::Presenter, child::Presenter.superclass
+    end
+  end
+
+  describe ".call" do
+    it "returns self" do
+      assert_equal jat_class, jat_class.call
+    end
+  end
+
+  describe ".to_h" do
+    it "raises error that we should add some response generation plugin" do
+      error = assert_raises(Jat::Error) { jat_class.to_h(nil) }
+
+      error_message = "Method #to_h must be implemented by plugin"
+      assert_equal error_message, error.message
+    end
+
+    it "initializes serializer instance with provided attributes" do
+      jat_class.expects(:new).with("obj", "context")
+      jat_class.to_h("obj", "context")
+    end
+
+    it "adds empty hash context when context not provided" do
+      jat_class.expects(:new).with("obj", {})
+      jat_class.to_h("obj")
+    end
+  end
+
+  describe ".attributes" do
+    it "initializes new attributes hash" do
+      assert_equal({}, jat_class.attributes)
+      assert_same jat_class.attributes, jat_class.instance_variable_get(:@attributes)
+    end
+  end
+
+  describe ".attribute" do
+    it "adds new attribute to attributes hash" do
+      attribute = jat_class.attribute :foo
+      assert_equal jat_class.attributes[:foo], attribute
+    end
+
+    it "adds method to Presenter class" do
+      jat_class.attribute :foo
+      assert jat_class::Presenter.method_defined?(:foo)
+    end
+  end
+
+  describe "#initialize" do
+    it "initializes object and context attributes" do
+      jat = jat_class.new("obj", "context")
+
+      assert_equal "obj", jat.object
+      assert_equal "context", jat.context
+    end
+  end
+
+  describe "#to_h" do
+    it "raises error" do
+      jat = jat_class.new(nil, nil)
+
+      error = assert_raises(Jat::Error) { jat.to_h }
+      error_message = "Method #to_h must be implemented by plugin"
+      assert_equal error_message, error.message
+    end
+  end
+
+  describe "#config" do
+    it "returns self class config" do
+      jat = jat_class.new(nil, nil)
+
+      assert_same jat.config, jat_class.config
+    end
+  end
+end

data/test/lib/plugin_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "test_plugin"
+
+describe "plugin system" do
+  describe "Jat.plugin" do
+    let(:jat_class) { Class.new(Jat) }
+    let(:components) { [jat_class, jat_class::Attribute, jat_class::Config, jat_class::Presenter] }
+
+    before do
+      components.each do |component|
+        component::InstanceMethods.send(:define_method, :foo) { :foo }
+        component::ClassMethods.send(:define_method, :foo) { :foo }
+      end
+    end
+
+    after do
+      components.each do |component|
+        component::InstanceMethods.send(:undef_method, :foo)
+        component::ClassMethods.send(:undef_method, :foo)
+      end
+    end
+
+    it "allows the plugin to override base methods of core classes" do
+      components.each do |component|
+        assert_equal :foo, component.foo
+        assert_equal :foo, component.allocate.foo
+      end
+
+      jat_class.plugin(TestPlugin)
+
+      components.each do |component|
+        assert_equal :plugin_foo, component.foo
+        assert_equal :plugin_foo, component.allocate.foo
+      end
+    end
+
+    it "loads dependencies before loading plugin" do
+      jat_class.plugin(TestPlugin)
+      assert_equal :foo, jat_class.config[:before_load]
+    end
+
+    it "after_loads after loading plugin" do
+      jat_class.plugin(TestPlugin)
+      assert_equal :plugin_foo, jat_class.config[:after_load]
+    end
+  end
+end

data/test/support/activerecord.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+conn = ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:").connection
+
+conn.create_table(:users) do |t|
+  t.string :name
+end
+
+conn.create_table(:comments) do |t|
+  t.belongs_to :user, index: false
+  t.text :text
+end
+
+module AR
+  class User < ActiveRecord::Base
+    has_many :comments
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :user
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+
+if RUBY_VERSION >= "2.7"
+  Warning[:deprecated] = true
+  Warning[:experimental] = true
+end
+
+require "bundler/setup"
+require "minitest/autorun"
+require "mocha/minitest"
+require "pry-byebug"
+
+require_relative "../lib/jat"

data/test/test_plugin.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module TestPlugin
+  def self.before_load(jat_class, *)
+    jat_class.config[:before_load] = jat_class.foo
+  end
+
+  def self.after_load(jat_class, *)
+    jat_class.config[:after_load] = jat_class.foo
+  end
+
+  module ClassMethods
+    def foo
+      :plugin_foo
+    end
+  end
+
+  module InstanceMethods
+    def foo
+      :plugin_foo
+    end
+  end
+
+  module AttributeClassMethods
+    def foo
+      :plugin_foo
+    end
+  end
+
+  module AttributeMethods
+    def foo
+      :plugin_foo
+    end
+  end
+
+  module ConfigClassMethods
+    def foo
+      :plugin_foo
+    end
+  end
+
+  module ConfigMethods
+    def foo
+      :plugin_foo
+    end
+  end
+
+  module PresenterClassMethods
+    def foo
+      :plugin_foo
+    end
+  end
+
+  module PresenterMethods
+    def foo
+      :plugin_foo
+    end
+  end
+end

metadata

@@ -1,28 +1,214 @@
 --- !ruby/object:Gem::Specification
 name: jat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
-- aglushkov
+- Andrey Glushkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
-dependencies: []
-description: 'Serialization tool to build JSON API response
-
-'
+date: 2021-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |
+  The JAT serializer allows you to generate a JSON response based on the fields requested by the client.
+  Besides, it avoids manually adding includes and solves N+1 problems on its own.
 email: aglushkov@shakuro.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- README.md
+- jat.gemspec
 - lib/jat.rb
+- lib/jat/attribute.rb
+- lib/jat/config.rb
+- lib/jat/plugins.rb
+- lib/jat/plugins/_activerecord_preloads/_activerecord_preloads.rb
+- lib/jat/plugins/_activerecord_preloads/lib/preloader.rb
+- lib/jat/plugins/_json_api_activerecord/_json_api_activerecord.rb
+- lib/jat/plugins/_json_api_activerecord/lib/preloads.rb
+- lib/jat/plugins/_preloads/_preloads.rb
+- lib/jat/plugins/_preloads/lib/format_user_preloads.rb
+- lib/jat/plugins/_preloads/lib/preloads_with_path.rb
+- lib/jat/plugins/cache/cache.rb
+- lib/jat/plugins/camel_lower/camel_lower.rb
+- lib/jat/plugins/json_api/json_api.rb
+- lib/jat/plugins/json_api/lib/construct_traversal_map.rb
+- lib/jat/plugins/json_api/lib/map.rb
+- lib/jat/plugins/json_api/lib/params/fields.rb
+- lib/jat/plugins/json_api/lib/params/fields/parse.rb
+- lib/jat/plugins/json_api/lib/params/fields/validate.rb
+- lib/jat/plugins/json_api/lib/params/include.rb
+- lib/jat/plugins/json_api/lib/params/include/parse.rb
+- lib/jat/plugins/json_api/lib/params/include/validate.rb
+- lib/jat/plugins/json_api/lib/presenters/document_links_presenter.rb
+- lib/jat/plugins/json_api/lib/presenters/document_meta_presenter.rb
+- lib/jat/plugins/json_api/lib/presenters/jsonapi_presenter.rb
+- lib/jat/plugins/json_api/lib/presenters/links_presenter.rb
+- lib/jat/plugins/json_api/lib/presenters/meta_presenter.rb
+- lib/jat/plugins/json_api/lib/presenters/relationship_links_presenter.rb
+- lib/jat/plugins/json_api/lib/presenters/relationship_meta_presenter.rb
+- lib/jat/plugins/json_api/lib/response.rb
+- lib/jat/plugins/json_api/lib/traversal_map.rb
+- lib/jat/plugins/simple_api/lib/construct_traversal_map.rb
+- lib/jat/plugins/simple_api/lib/map.rb
+- lib/jat/plugins/simple_api/lib/params/parse.rb
+- lib/jat/plugins/simple_api/lib/response.rb
+- lib/jat/plugins/simple_api/simple_api.rb
+- lib/jat/plugins/to_str/to_str.rb
+- lib/jat/presenter.rb
+- lib/jat/utils/enum_deep_dup.rb
+- lib/jat/utils/enum_deep_freeze.rb
+- test/lib/jat/attribute_test.rb
+- test/lib/jat/config_test.rb
+- test/lib/jat/plugins/_activerecord_preloads/_activerecord_preloads_test.rb
+- test/lib/jat/plugins/_activerecord_preloads/lib/preloader_test.rb
+- test/lib/jat/plugins/_json_api_activerecord/_json_api_activerecord_test.rb
+- test/lib/jat/plugins/_json_api_activerecord/lib/preloads_test.rb
+- test/lib/jat/plugins/_preloads/_preloads_test.rb
+- test/lib/jat/plugins/_preloads/lib/format_user_preloads_test.rb
+- test/lib/jat/plugins/_preloads/lib/preloads_with_path_test.rb
+- test/lib/jat/plugins/cache/cache_test.rb
+- test/lib/jat/plugins/camel_lower/camel_lower_test.rb
+- test/lib/jat/plugins/json_api/json_api_test.rb
+- test/lib/jat/plugins/json_api/lib/construct_traversal_map_test.rb
+- test/lib/jat/plugins/json_api/lib/map_test.rb
+- test/lib/jat/plugins/json_api/lib/params/fields/parse_test.rb
+- test/lib/jat/plugins/json_api/lib/params/fields/validate_test.rb
+- test/lib/jat/plugins/json_api/lib/params/fields_test.rb
+- test/lib/jat/plugins/json_api/lib/params/include/parse_test.rb
+- test/lib/jat/plugins/json_api/lib/params/include/validate_test.rb
+- test/lib/jat/plugins/json_api/lib/params/include_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/document_links_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/document_meta_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/jsonapi_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/links_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/meta_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/relationship_links_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/relationship_meta_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/response_test.rb
+- test/lib/jat/plugins/json_api/lib/traversal_map_test.rb
+- test/lib/jat/plugins/simple_api/lib/construct_traversal_map_test.rb
+- test/lib/jat/plugins/simple_api/lib/map_test.rb
+- test/lib/jat/plugins/simple_api/lib/params/parse_test.rb
+- test/lib/jat/plugins/simple_api/lib/response_test.rb
+- test/lib/jat/plugins/simple_api/simple_api_test.rb
+- test/lib/jat/plugins/to_str/to_str_test.rb
+- test/lib/jat/presenter_test.rb
+- test/lib/jat/utils/enum_deep_dup_test.rb
+- test/lib/jat/utils/enum_deep_freeze_test.rb
+- test/lib/jat_test.rb
+- test/lib/plugin_test.rb
+- test/support/activerecord.rb
+- test/test_helper.rb
+- test/test_plugin.rb
 homepage: https://github.com/aglushkov/jat
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/aglushkov/jat/issues
+  changelog_uri: https://github.com/aglushkov/jat/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/aglushkov/jat
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -38,8 +224,51 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.1
 signing_key: 
 specification_version: 4
-summary: JSON API Serializer
-test_files: []
+summary: JSON API TOOLKIT
+test_files:
+- test/lib/jat/attribute_test.rb
+- test/lib/jat/config_test.rb
+- test/lib/jat/plugins/_activerecord_preloads/_activerecord_preloads_test.rb
+- test/lib/jat/plugins/_activerecord_preloads/lib/preloader_test.rb
+- test/lib/jat/plugins/_json_api_activerecord/_json_api_activerecord_test.rb
+- test/lib/jat/plugins/_json_api_activerecord/lib/preloads_test.rb
+- test/lib/jat/plugins/_preloads/_preloads_test.rb
+- test/lib/jat/plugins/_preloads/lib/format_user_preloads_test.rb
+- test/lib/jat/plugins/_preloads/lib/preloads_with_path_test.rb
+- test/lib/jat/plugins/cache/cache_test.rb
+- test/lib/jat/plugins/camel_lower/camel_lower_test.rb
+- test/lib/jat/plugins/json_api/json_api_test.rb
+- test/lib/jat/plugins/json_api/lib/construct_traversal_map_test.rb
+- test/lib/jat/plugins/json_api/lib/map_test.rb
+- test/lib/jat/plugins/json_api/lib/params/fields/parse_test.rb
+- test/lib/jat/plugins/json_api/lib/params/fields/validate_test.rb
+- test/lib/jat/plugins/json_api/lib/params/fields_test.rb
+- test/lib/jat/plugins/json_api/lib/params/include/parse_test.rb
+- test/lib/jat/plugins/json_api/lib/params/include/validate_test.rb
+- test/lib/jat/plugins/json_api/lib/params/include_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/document_links_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/document_meta_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/jsonapi_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/links_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/meta_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/relationship_links_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/presenters/relationship_meta_presenter_test.rb
+- test/lib/jat/plugins/json_api/lib/response_test.rb
+- test/lib/jat/plugins/json_api/lib/traversal_map_test.rb
+- test/lib/jat/plugins/simple_api/lib/construct_traversal_map_test.rb
+- test/lib/jat/plugins/simple_api/lib/map_test.rb
+- test/lib/jat/plugins/simple_api/lib/params/parse_test.rb
+- test/lib/jat/plugins/simple_api/lib/response_test.rb
+- test/lib/jat/plugins/simple_api/simple_api_test.rb
+- test/lib/jat/plugins/to_str/to_str_test.rb
+- test/lib/jat/presenter_test.rb
+- test/lib/jat/utils/enum_deep_dup_test.rb
+- test/lib/jat/utils/enum_deep_freeze_test.rb
+- test/lib/jat_test.rb
+- test/lib/plugin_test.rb
+- test/support/activerecord.rb
+- test/test_helper.rb
+- test/test_plugin.rb