collection_json_serializer 0.0.1

data/test/fixtures/serializers/custom_item_serializer.rb

@@ -0,0 +1,3 @@
+class CustomItemSerializer < CollectionJson::Serializer
+  attributes name: { anything: "at all", whatever: "really" }
+end

data/test/fixtures/serializers/custom_template_serializer.rb

@@ -0,0 +1,5 @@
+class CustomTemplateSerializer < CollectionJson::Serializer
+  template :name, email: { prompt: "My email",
+                           anything: "at all",
+                           whatever: "really" }
+end

data/test/fixtures/serializers/invalid_serializer.rb

@@ -0,0 +1,4 @@
+class InvalidSerializer < CollectionJson::Serializer
+  href self: "/users/1", collection: "www.users.com"
+  links dashboard: { href: "/my-dashboard" }
+end

data/test/fixtures/serializers/multiple_href_serializer.rb

@@ -0,0 +1,3 @@
+class MultipleHrefSerializer < CollectionJson::Serializer
+  href "/a", "/b", "/c"
+end

data/test/fixtures/serializers/unknown_attribute_serializer.rb

@@ -0,0 +1,3 @@
+class UnknownAttributeSerializer < CollectionJson::Serializer
+  attributes :unknown
+end

data/test/fixtures/serializers/user_serializer.rb

@@ -0,0 +1,7 @@
+class UserSerializer < CollectionJson::Serializer
+  href self: "http://example.com/users/{id}",
+       collection: "http://example.com/users"
+  attributes :name, :email
+  template :name, email: { prompt: "My email" }
+  links dashboard: { href: "http://example.com/my-dashboard" }
+end

data/test/fixtures/serializers/valid_serializer.rb

@@ -0,0 +1,5 @@
+class ValidSerializer < CollectionJson::Serializer
+  href self: "http://example.com/users/1",
+       collection: "http://example.com/users"
+  links dashboard: { href: "http://example.com/my-dashboard" }
+end

data/test/minitest_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "collection_json_serializer"
+
+require "minitest/autorun"
+
+require "fixtures/poro"
+require "fixtures/models"
+Dir.glob(File.dirname(__FILE__) + "/fixtures/serializers/**/*.rb") { |file| require file }
+
+require "active_support/json"
+require "active_support/inflector"

data/test/objects/item_test.rb

@@ -0,0 +1,82 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class Objects
+      class Item
+        class TestItem < Minitest::Test
+          def setup
+            @user1 = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+            @user2 = User.new(name: "Aina Jove", email: "hola@example.com")
+            @user_serializer = UserSerializer.new(@user1)
+            @item = Item.new(@user_serializer)
+          end
+
+          def test_that_an_item_can_be_build
+            expected = {
+              href: "http://example.com/users/#{@user1.id}",
+              data: [
+                { name: "name", value: "Carles Jove" },
+                { name: "email", value: "hola@carlus.cat" }
+              ],
+              links: [
+                { name: "dashboard", href: "http://example.com/my-dashboard" }
+              ]
+            }
+
+            assert_equal expected.to_json, @item.create.to_json
+          end
+
+          def test_that_an_item_can_be_built_passing_an_index
+            user_serializer = UserSerializer.new([@user1, @user2])
+            item = Item.new(user_serializer, item: 1)
+
+            expected = {
+              href: "http://example.com/users/#{@user2.id}",
+              data: [
+                { name: "name", value: "Aina Jove" },
+                { name: "email", value: "hola@example.com" }
+              ],
+              links: [
+                { name: "dashboard", href: "http://example.com/my-dashboard" }
+              ]
+            }
+
+            assert_equal expected.to_json, item.create.to_json
+          end
+
+          def test_that_an_item_can_be_build_with_random_attributes
+            custom_serializer = CustomItemSerializer.new(@user1)
+            item = Item.new(custom_serializer)
+
+            expected = {
+              data: [
+                { name: "name", value: "Carles Jove", anything: "at all", whatever: "really" },
+              ]
+            }
+            assert_equal expected.to_json, item.create.to_json
+          end
+
+          def test_that_an_item_link_can_be_build_with_unlimited_attributes
+            custom_serializer = CustomItemLinksSerializer.new(@user1)
+            item = Item.new(custom_serializer)
+
+            expected = {
+              links: [
+                { name: "dashboard", href: "/my-dashboard", anything: "at all", whatever: "really" }
+              ]
+            }
+
+            assert_equal expected[:links], item.create[:links]
+          end
+
+          def test_that_unknown_attributes_are_silently_ignored
+            serializer_with_unknown_attr = UnknownAttributeSerializer.new(@user1)
+            item = Item.new(serializer_with_unknown_attr)
+            refute item.create.include?(:unknown)
+          end
+        end
+      end
+    end
+  end
+end

data/test/objects/template_test.rb

@@ -0,0 +1,40 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class Objects
+      class Template
+        class TestTemplate < Minitest::Test
+          def setup
+            @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+            @account = Account.new(id: 1, name: "My Account", created_at: Time.now)
+            @user.account = @account
+            @user_serializer = UserSerializer.new(@user)
+            @template = Template.new(@user_serializer)
+          end
+
+          def test_that_a_template_can_be_build
+            expected = [
+              { name: "name", value: "" },
+              { name: "email", value: "", prompt: "My email" }
+            ]
+
+            assert_equal expected.to_json, @template.create.to_json
+          end
+
+          def test_that_a_template_can_be_build_with_random_attributes
+            custom_serializer = CustomTemplateSerializer.new(@user)
+            template = Template.new(custom_serializer)
+
+            expected = [
+              { name: "name", value: "" },
+              { name: "email", value: "", prompt: "My email", anything: "at all", whatever: "really" }
+            ]
+
+            assert_equal expected.to_json, template.create.to_json
+          end
+        end
+      end
+    end
+  end
+end

data/test/serializer/data_test.rb

@@ -0,0 +1,29 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class TestData < Minitest::Test
+      def setup
+        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+        @user_serializer = UserSerializer.new(@user)
+      end
+
+      def test_attributes_properties
+        assert_equal [:name, :email], @user_serializer.class.attributes
+      end
+
+      def test_that_any_attributes_can_be_passed
+        custom_serializer = CustomItemSerializer.new(@user)
+        expected = [
+          name:
+          {
+            anything: "at all",
+            whatever: "really"
+          }
+        ]
+
+        assert_equal expected, custom_serializer.class.attributes
+      end
+    end
+  end
+end

data/test/serializer/href_test.rb

@@ -0,0 +1,39 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class TestHref < Minitest::Test
+      def setup
+        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+        @user_serializer = UserSerializer.new(@user)
+      end
+
+      def test_href_object
+        expected = [{
+          self: "http://example.com/users/{id}",
+          collection: "http://example.com/users"
+        }]
+        assert_equal expected, @user_serializer.class.href
+      end
+
+      def test_that_only_one_href_value_is_passed_to_builder
+        multiple_href_serializer = MultipleHrefSerializer.new(@user)
+        assert_equal %w(/a /b /c), multiple_href_serializer.class.href
+        assert_equal "/a", multiple_href_serializer.href
+      end
+
+      def test_that_a_placeholder_can_be_used_for_urls
+        user_serializer = CollectionJson::Serializer.new(@user)
+        user_serializer.class.attributes = [:name]
+        user_serializer.class.links = []
+        user_serializer.class.template = []
+        user_serializer.class.href = [self: "http://example.com/users/{id}"]
+        builder = Builder.new(user_serializer)
+
+        expected = "http://example.com/users/#{@user.id}"
+        actual = builder.pack[:collection][:items].first[:href]
+        assert_equal expected, actual
+      end
+    end
+  end
+end

data/test/serializer/links_test.rb

@@ -0,0 +1,23 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class TestLinks < Minitest::Test
+      def setup
+        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+        @user_serializer = UserSerializer.new(@user)
+      end
+
+      def test_item_links_attributes
+        expected = [dashboard: { href: "http://example.com/my-dashboard" }]
+        assert_equal expected, @user_serializer.class.links
+      end
+
+      def test_item_links_attributes_can_take_unlimited_properties
+        custom_serializer = CustomItemLinksSerializer.new(@user)
+        expected = [dashboard: { href: "/my-dashboard", anything: "at all", whatever: "really" }]
+        assert_equal expected, custom_serializer.class.links
+      end
+    end
+  end
+end

data/test/serializer/template_test.rb

@@ -0,0 +1,30 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class TestTemplate < Minitest::Test
+      def setup
+        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+        @user_serializer = UserSerializer.new(@user)
+      end
+
+      def test_template_attributes
+        assert_equal [:name, email: { prompt: "My email" }], @user_serializer.class.template
+      end
+
+      def test_that_any_attributes_can_be_passed
+        custom_serializer = CustomTemplateSerializer.new(@user)
+        expected = [
+          :name,
+          email: {
+            prompt: "My email",
+            anything: "at all",
+            whatever: "really"
+          }
+        ]
+
+        assert_equal expected, custom_serializer.class.template
+      end
+    end
+  end
+end

data/test/support/ext_test.rb

@@ -0,0 +1,23 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class TestExtractParams < Minitest::Test
+      def test_extract_params_for_hash
+        attrs = { test: { prompt: "works" } }
+
+        params = attrs.extract_params
+        assert_equal :test, params[:name]
+        assert_equal attrs[:test], params[:properties]
+      end
+
+      def test_extract_params_for_symbol
+        attrs = :test
+
+        params = attrs.extract_params
+        assert_equal :test, params[:name]
+        assert params[:properties].nil?
+      end
+    end
+  end
+end

data/test/support/support_test.rb

@@ -0,0 +1,29 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    module Support
+      class TestSupport < Minitest::Test
+        include CollectionJson::Serializer::Support
+
+        def setup
+          @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+          @user_serializer = UserSerializer.new(@user)
+          @builder = Builder.new(@user_serializer)
+        end
+
+        def test_extract_value
+          actual = extract_value_from(@user_serializer.resources.first, :name)
+          assert_equal "Carles Jove", actual
+        end
+
+        def test_that_an_url_with_placeholder_can_be_parsed
+          url = "http://example.com/users/{id}"
+          expected = "http://example.com/users/#{@user.id}"
+
+          assert_equal expected, parse_url(url, @user)
+        end
+      end
+    end
+  end
+end

data/test/validator/invalid_test.rb

@@ -0,0 +1,138 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class Validator
+      class TestInvalid < Minitest::Test
+        def setup
+          @user = User.new(
+            name: "Carles Jove",
+            email: "hola@carlus.cat"
+          )
+          @account = Account.new(
+            id: 1,
+            name: "My Account",
+            created_at: Time.now
+          )
+          @user.account = @account
+
+          @invalid_value_types = [
+            /regex/,
+            :symbol,
+            {},
+            []
+          ]
+
+          @invalid = CollectionJson::Serializer.new(@user)
+          @invalid.class.attributes = []
+          @invalid.class.href = []
+          @invalid.class.links = []
+          @invalid.class.template = []
+        end
+
+        # href
+        def test_that_href_generates_errors
+          @invalid.class.href = [self: "/users/1", collection: "www.users.com"]
+
+          assert @invalid.invalid?
+          assert @invalid.errors.include? :href
+          assert @invalid.errors[:href][0].
+                  include? "href:self is an invalid URL"
+          assert @invalid.errors[:href][1].
+                  include? "href:collection is an invalid URL"
+
+          @invalid.class.href = ["/users/1"]
+
+          assert @invalid.invalid?
+          assert @invalid.errors.include? :href
+          assert @invalid.errors[:href][0].
+                  include? "href is an invalid URL"
+        end
+
+        # links
+        def test_that_links_generates_errors
+          @invalid.class.links = [dashboard: { href: "/my-dashboard" }]
+          assert @invalid.invalid?
+          assert @invalid.errors.include? :links
+          assert @invalid.errors[:links].first.
+                  include? "links:dashboard:href is an invalid URL"
+
+          @invalid.class.links = [
+            dashboard: {
+              href: "http://valid.url.com",
+              prompt: /invalid/
+            }
+          ]
+          assert @invalid.invalid?
+          assert @invalid.errors.include? :links
+          assert @invalid.errors[:links].first.
+                  include? "links:dashboard:prompt is an invalid value"
+        end
+
+        def test_that_links_missing_href_generates_error
+          @invalid.class.links = [dashboard: {}]
+          assert @invalid.invalid?
+          assert @invalid.errors.include? :links
+          assert @invalid.errors[:links].first.
+                  include? "links:dashboard:href is missing"
+        end
+
+        # attributes
+        def test_that_invalid_attributes_return_values_generate_errors
+          @invalid.class.attributes = [:name]
+
+          @invalid_value_types.each do |invalidate|
+            @user.name = invalidate
+            assert @invalid.invalid?,
+                   "#{invalidate} should be invalid"
+            assert @invalid.errors.include?(:attributes),
+                   "#{invalidate} should be invalid"
+            assert @invalid.errors[:attributes].
+                    first.include? "attributes:name is an invalid value"
+          end
+        end
+
+        def test_that_invalid_attributes_properties_values_generate_errors
+          @invalid_value_types.each do |invalidate|
+            @invalid.class.attributes = [
+              name: {
+                prompt: invalidate,
+                test: invalidate
+              }
+            ]
+
+            assert @invalid.invalid?,
+                   "#{invalidate} should be invalid"
+            assert @invalid.errors.include?(:attributes),
+                   "#{invalidate} should be invalid"
+            assert @invalid.errors[:attributes][0].
+                    include? "attributes:name:prompt is an invalid value"
+            assert @invalid.errors[:attributes][1].
+                    include? "attributes:name:test is an invalid value"
+          end
+        end
+
+        # template
+        def test_that_template_values_validate
+          @invalid_value_types.each do |invalidate|
+            @invalid.class.template = [
+              name: {
+                prompt: invalidate,
+                name: invalidate
+              }
+            ]
+
+            assert @invalid.invalid?,
+                   "#{invalidate} should be invalid"
+            assert @invalid.errors.include?(:template),
+                   "#{invalidate} should be invalid"
+            assert @invalid.errors[:template][0].
+                    include? "template:name:prompt is an invalid value"
+            assert @invalid.errors[:template][1].
+                    include? "template:name:name is an invalid value"
+          end
+        end
+      end
+    end
+  end
+end