fars 0.0.1 → 0.0.2

data/spec/array_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Array#serialize' do
+  subject { %w{green blue grey} }
+  let(:json_data) { { colors: [{ color: 'green' }, { color: 'blue' }, { color: 'grey' }] }.to_json }
+
+  specify 'with proc as item serializer' do
+    subject.serialize(root_key: :colors,
+      serializer: Proc.new { |c| { color: c } }).should == json_data
+  end
+
+  specify 'with block as item serializer' do
+    subject.serialize(root_key: :colors) { |c| { color: c } }.should == json_data
+  end
+
+  specify 'with custom class as item serializer' do
+    subject.serialize(root_key: :colors, serializer: 'ColorSerializer').should == json_data
+  end
+end

data/spec/fars/base_collection_serializer_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Fars::BaseCollectionSerializer do
+  before(:each) do
+    1.upto(2) { |i| Master.create(id: i, name: "Object#{i}", data: '123') }
+    1.upto(3) { |i| Slave.create(id: i, master_id: (i % 2) + 1, name: "Slave #{i}") }
+  end
+
+  context 'without API version' do
+    context '#to_json' do
+      it 'returns all fields with metadata' do
+        json_data = { masters: [
+          { master: { id: 1, name: 'Object1' }, _metadata: { metadata: :present } },
+          { master: { id: 2, name: 'Object2' }, _metadata: { metadata: :present } }
+        ] }.to_json
+
+        described_class.new(Master.where('1 = 1'),
+          add_metadata: true,
+          fields: [:id, :name]
+        ).to_json.should == json_data
+      end      
+    end
+  end
+
+  context 'with API version' do
+    context '#to_json' do
+      it 'returns all fields and relations withot metadata' do
+        json_data = { masters: [
+          { master: { id: 1, name: 'Object1', data: '123', updated_at: '2014-04-14',
+                      slaves: [{ slave: { id: 2, name: 'Slave 2', data: nil, updated_at: '2014-04-14' } }] } },
+          { master: { id: 2, name: 'Object2', data: '123', updated_at: '2014-04-14',
+                      slaves: [
+                        { slave: { id: 1, name: 'Slave 1', data: nil, updated_at: '2014-04-14'} },
+                        { slave: { id: 3, name: 'Slave 3', data: nil, updated_at: '2014-04-14'} }
+                      ] } }
+          ] }.to_json
+
+        described_class.new(Master.where('1 = 1'),
+          add_metadata: false,
+          api_version: 'V1'
+        ).to_json.should == json_data
+      end      
+    end
+  end
+end

data/spec/fars/base_model_serializer_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Fars::BaseModelSerializer do
+  before :each do
+    @object = Master.create(id: 1, name: 'Object1', data: '123')
+    1.upto(2) { |i| Slave.create(id: i, master_id: @object.id, name: "Slave #{i}") }
+  end
+
+  context 'without API version' do
+    context '#to_json' do
+      it 'returns all fields with metadata' do
+        json_data = {
+          master: { id: 1, name: 'Object1', data: '123' },
+          _metadata: { metadata: :present }
+        }.to_json
+
+        MasterSerializer.new(@object,
+          add_metadata: true,
+          fields: [:id, :name, :data]
+        ).to_json.should == json_data
+      end
+
+      it 'returns not all field, whithout metadata' do
+        json_data = { master: { id: 1, name: 'Object1' } }.to_json
+
+        MasterSerializer.new(@object,
+          add_metadata: false,
+          fields: [:id, :name]
+        ).to_json.should == json_data
+      end
+
+      it 'returns not all field, whithout metadata if serializer does not respond to meta method' do
+        json_data = { master: { id: 1, name: 'Object1' } }.to_json
+
+        MasterSerializer.any_instance.stub(:respond_to?).with(:meta).and_return(false)
+
+        MasterSerializer.new(@object,
+          fields: [:id, :name]
+        ).to_json.should == json_data
+      end
+
+      it 'returns all field with slaves' do
+        json_data = { master: { id: 1, name: 'Object1', data: '123',
+          slaves: [
+            { slave: { id: 1, name: 'Slave 1', data: nil } },
+            { slave: { id: 2, name: 'Slave 2', data: nil } },
+          ]}}.to_json
+
+        MasterSerializer.new(@object,
+          add_metadata: false,
+          fields: [:id, :name, :data, :slaves]
+        ).to_json.should == json_data
+      end
+
+      it 'returns all field with slaves' do
+        json_data = { master: { id: 1, name: 'Object1', data: '123',
+          slaves: [
+            { slave: { id: 1, name: 'Slave 1', data: nil } },
+            { slave: { id: 2, name: 'Slave 2', data: nil } },
+          ]}}.to_json
+
+        @object.serialize(
+          add_metadata: false,
+          fields: [:id, :name, :data, :slaves]
+        ).should == json_data
+      end
+    end
+  end
+
+  context 'with API version' do
+    context '#to_json' do
+      it 'returns all fields with metadata' do
+        json_data = {
+          master: { id: 1, name: 'Object1', data: '123' },
+          _metadata: { metadata: :present }
+        }.to_json
+
+        V1::MasterSerializer.new(@object,
+          add_metadata: true,
+          fields: [:id, :name, :data],
+          api_version: 'V1'
+        ).to_json.should == json_data
+      end
+
+      it 'returns not all field, whithout metadata' do
+        json_data = { master: { id: 1, name: 'Object1' } }.to_json
+
+        V1::MasterSerializer.new(@object,
+          add_metadata: false,
+          fields: [:id, :name],
+          api_version: 'V1'
+        ).to_json.should == json_data
+      end
+
+      it 'returns all field with slaves' do
+        json_data = { master: { id: 1, name: 'Object1', data: '123',
+          slaves: [
+            { slave: { id: 1, name: 'Slave 1', data: nil, updated_at: '2014-04-14' } },
+            { slave: { id: 2, name: 'Slave 2', data: nil, updated_at: '2014-04-14' } },
+          ]}}.to_json
+
+        V1::MasterSerializer.new(@object,
+          add_metadata: false,
+          fields: [:id, :name, :data, :slaves],
+          api_version: 'V1'
+        ).to_json.should == json_data
+      end
+    end
+  end
+end

data/spec/fars/base_object_serializer_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Fars::BaseObjectSerializer do
+  before(:all) { Book = Struct.new(:isbn, :title, :author, :price, :count) }
+  let(:book) { Book.new('isbn1', 'title1', 'author1', 10, nil) }
+  let(:book2) { Book.new('isbn2', 'title2', 'author2', 20.0, 4) }
+  let(:book3) { Book.new('isbn3', 'title3', 'author3', 30.5, 7) }
+  let(:books) { [book, book2, book3] }
+
+  it 'serializes any object with appropriate serializer' do
+    BookSerializer.new(book).as_json.should ==
+      { book: { isbn: 'isbn1', title: 'title1', author: 'author1', price: '10.00', count: 0 } }
+  end
+
+  it 'includes only requested fields' do
+    BookSerializer.new(book, fields: [:isbn, :title, :price]).as_json.should ==
+      { book: { isbn: 'isbn1', title: 'title1', price: '10.00' } }
+  end
+
+  it 'includes only requested fields reduced by #available_attributes methods' do
+    book_serializer = BookSerializer.new(book, fields: [:isbn, :title, :price])
+    def book_serializer.available_attributes
+      [:isbn, :price]
+    end
+    book_serializer.as_json.should == { book: { isbn: 'isbn1', price: '10.00' } }
+  end
+
+  it 'serializes collection which consists of objects of same tipe with appropriate serializer' do
+    books.serialize(root_key: :books, serializer: 'BookSerializer', fields: [:isbn, :title, :price]).should =={ books: [
+      { book: { isbn: 'isbn1', title: 'title1', price: '10.00' } },
+      { book: { isbn: 'isbn2', title: 'title2', price: '20.00' } },
+      { book: { isbn: 'isbn3', title: 'title3', price: '30.50' } }
+    ] }.to_json
+  end
+end

data/spec/hash_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'Hash#serialize' do
+  subject do
+    { '2014-01' => { visitors: 23, visits: 114 }, '2014-02' => { visitors: 27, visits: 217 } }
+  end
+
+  specify 'with proc as item serializer' do
+    json_data = { stats: [{ month: '2014-01', visitors: 23 }, { month: '2014-02', visitors: 27 }] }.to_json
+
+    subject.serialize(root_key: :stats,
+      serializer: Proc.new { |k, v| { month: k, visitors: v[:visitors] } }).should == json_data
+  end
+
+  specify 'with block as item serializer' do
+    json_data = { stats: [{ month: '2014-01', visitors: 23 }, { month: '2014-02', visitors: 27 }] }.to_json
+
+    subject.serialize(root_key: :stats) do |k, v|
+      { month: k, visitors: v[:visitors] }
+    end.should == json_data
+  end
+
+  specify 'custom class as item serializer' do
+    json_data = { stats: [{ stat_key: '2014-01', stat_value: { visitors: 23, visits: 114 } },
+              { stat_key: '2014-02', stat_value: { visitors: 27, visits: 217 } }] }.to_json
+
+    subject.serialize(root_key: :stats, serializer: 'StatSerializer').should == json_data
+  end
+
+  specify 'with custom class as item serializer and without root_key' do
+    json_data = [{ stat_key: '2014-01', stat_value: { visitors: 23, visits: 114 } },
+              { stat_key: '2014-02', stat_value: { visitors: 27, visits: 217 } }].to_json
+
+    subject.serialize(root_key: false, serializer: 'StatSerializer').should == json_data
+  end
+end

data/spec/spec_helper.rb

@@ -32,3 +32,9 @@ end
 root      = File.dirname(__FILE__)
 db_config = YAML.load_file("#{root}/config/database.yml")
 ActiveRecord::Base.establish_connection(db_config)
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.irregular 'slave', 'slaves'
+end

data/spec/support/models/master.rb

@@ -0,0 +1,3 @@
+class Master < ActiveRecord::Base
+  has_many :slaves
+end

data/spec/support/models/slave.rb

@@ -0,0 +1,3 @@
+class Slave < ActiveRecord::Base
+  belongs_to :master
+end

data/spec/support/serializers/another_master_serialiser.rb

@@ -0,0 +1,11 @@
+class AnotherMasterSerializer < Fars::BaseModelSerializer
+  self.model = Master
+  self.root_key = :father
+  attributes :id, :name, # attrs
+             :number, # methods
+             :slaves
+
+  def number
+    14
+  end
+end

data/spec/support/serializers/book_serializer.rb

@@ -0,0 +1,12 @@
+class BookSerializer < Fars::BaseObjectSerializer
+  attributes :isbn, :title, :author, # attrs
+             :price, :count # methods
+
+  def price
+    "%.2f" % object.price
+  end
+
+  def count
+    object.count.to_i
+  end
+end

data/spec/support/serializers/color_serializer.rb

@@ -0,0 +1,5 @@
+class ColorSerializer < Fars::BaseObjectSerializer
+  def as_json
+    { color: object }
+  end
+end

data/spec/support/serializers/master_serializer.rb

@@ -0,0 +1,8 @@
+class MasterSerializer < Fars::BaseModelSerializer
+  attributes :id, :name, :data, # attrs
+             :slaves
+
+  def meta
+    { 'metadata' => :present }
+  end
+end

data/spec/support/serializers/slave_serializer.rb

@@ -0,0 +1,3 @@
+class SlaveSerializer < Fars::BaseModelSerializer
+  attributes :id, :name, :data # attrs
+end

data/spec/support/serializers/stat_serializer.rb

@@ -0,0 +1,5 @@
+class StatSerializer < Fars::BaseObjectSerializer
+  def as_json
+    { stat_key: object[0], stat_value: object[1] }
+  end
+end

data/spec/support/serializers/v1/master_serializer.rb

@@ -0,0 +1,15 @@
+module V1
+  class MasterSerializer < Fars::BaseModelSerializer
+    attributes :id, :name, :data, # attrs
+               :updated_at, # methods
+               :slaves
+
+    def updated_at
+      '2014-04-14'
+    end
+
+    def meta
+      { 'metadata' => :present }
+    end
+  end
+end

data/spec/support/serializers/v1/slave_serializer.rb

@@ -0,0 +1,10 @@
+module V1
+  class SlaveSerializer < Fars::BaseModelSerializer
+    attributes :id, :name, :data, # attrs
+               :updated_at # methods
+
+    def updated_at
+      '2014-04-14'
+    end
+  end
+end

data/spec/tasks/db_setup.rake

@@ -14,7 +14,7 @@ namespace :spec do
     task :migrate do
       ActiveRecord::Base.establish_connection(db_config)
 
-      ActiveRecord::Base.connection.execute(<<SQL
+      ActiveRecord::Base.connection.execute(<<-SQL
 DROP TABLE IF EXISTS "public"."masters";
 
 CREATE TABLE "public"."masters" (

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fars
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Denyago
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -47,7 +42,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,7 +49,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -63,7 +56,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -71,7 +63,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -79,7 +70,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -87,7 +77,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -95,7 +84,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -103,7 +91,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -125,39 +112,71 @@ files:
 - lib/fars.rb
 - lib/fars/base_collection_serializer.rb
 - lib/fars/base_model_serializer.rb
+- lib/fars/base_object_serializer.rb
+- lib/fars/model_serializable.rb
+- lib/fars/relation_serializable.rb
 - lib/fars/version.rb
+- spec/active_record/base_spec.rb
+- spec/active_record/relation_spec.rb
+- spec/array_spec.rb
 - spec/config/database.example.yml
-- spec/fars/api_version_spec.rb
-- spec/fars/fars_spec.rb
+- spec/fars/base_collection_serializer_spec.rb
+- spec/fars/base_model_serializer_spec.rb
+- spec/fars/base_object_serializer_spec.rb
+- spec/hash_spec.rb
 - spec/spec_helper.rb
+- spec/support/models/master.rb
+- spec/support/models/slave.rb
+- spec/support/serializers/another_master_serialiser.rb
+- spec/support/serializers/book_serializer.rb
+- spec/support/serializers/color_serializer.rb
+- spec/support/serializers/master_serializer.rb
+- spec/support/serializers/slave_serializer.rb
+- spec/support/serializers/stat_serializer.rb
+- spec/support/serializers/v1/master_serializer.rb
+- spec/support/serializers/v1/slave_serializer.rb
 - spec/tasks/db_setup.rake
 homepage: https://github.com/Lightpower/fars
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem provedes classes for fast serialisation of ActiveRecord relations.
 test_files:
+- spec/active_record/base_spec.rb
+- spec/active_record/relation_spec.rb
+- spec/array_spec.rb
 - spec/config/database.example.yml
-- spec/fars/api_version_spec.rb
-- spec/fars/fars_spec.rb
+- spec/fars/base_collection_serializer_spec.rb
+- spec/fars/base_model_serializer_spec.rb
+- spec/fars/base_object_serializer_spec.rb
+- spec/hash_spec.rb
 - spec/spec_helper.rb
+- spec/support/models/master.rb
+- spec/support/models/slave.rb
+- spec/support/serializers/another_master_serialiser.rb
+- spec/support/serializers/book_serializer.rb
+- spec/support/serializers/color_serializer.rb
+- spec/support/serializers/master_serializer.rb
+- spec/support/serializers/slave_serializer.rb
+- spec/support/serializers/stat_serializer.rb
+- spec/support/serializers/v1/master_serializer.rb
+- spec/support/serializers/v1/slave_serializer.rb
 - spec/tasks/db_setup.rake