api_view 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 474ae37f4261ac132bcca7331d12e3eac1c56a62
+  data.tar.gz: a794b2806e37db11ae671fd870e88f905f61025d
+SHA512:
+  metadata.gz: 9461e48f8d5e2cfd3f4a71217d9143cbae4577f67693167e52939eda282fbf8acdb3afe2e26ca70575102d26211bf27430e03e52d092bb936fbe2b51bfa6f0ed
+  data.tar.gz: f8b2ec2d180baa84d3933d8e603cd08e3e3717e0688cbed49730078da2576879e1ca8f3eca7d20b311b0e0a3f0d69886aba907c35a8ef065d64c89fbab0565a4

data/.coco.yml

@@ -0,0 +1,7 @@
+:directories:
+- lib
+:excludes:
+- test
+- .direnv
+:single_line_report: true
+:show_link_in_terminal: true

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.2
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
+
+script: sh/test

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_view.gemspec
+gemspec
+
+gem 'codecov', :require => false, :group => :test

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roman Heinrich
+
+MIT License
+
+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,119 @@
+# ApiView
+
+[![Build Status](https://travis-ci.org/mindreframer/api_view.svg?branch=master)](http://travis-ci.org/mindreframer/api_view)
+[![codecov.io](https://codecov.io/github/mindreframer/api_view/coverage.svg?branch=master)](https://codecov.io/github/mindreframer/api_view?branch=master)
+
+a small and very performance focused serializer for complex nested objects. The initial code was taken from `chetan` and was wrapped into a gem with unit-tests and a bit more convenient API. The original links are below:
+  - http://techblog.thescore.com/benchmarking-json-generation-in-ruby/#comment-1678429451
+  - https://github.com/chetan/json_serialization_benchmark/tree/api_view
+  - https://gist.github.com/chetan/d613e8f7d45600e1ca34
+
+
+
+### Why should you even care? Is (... insert your favourite ruby serializer ... ) not good enough?
+
+  - you want great performance
+  - you care about object allocations (less garbage to collect for the Ruby VM)
+  - you want **blazing** fast test suite, so that you can switch globally the serialization off and test just the shape of the resulting Hash object
+    -> no converting to JSON, then parsing JSON back and checking values on it, that sux!
+  - really small and clean codebase
+  - unit-tested and with test 100% coverage
+
+ApiView gives you all that and stays very small doing that.
+
+## Installation
+
+    ## Add this line to your application's Gemfile:
+    gem 'api_view'
+
+
+    ## And then execute:
+    $ bundle
+
+
+## Usage
+
+  - you inherit from ApiView::Base
+  - you say, what model should be serialized by default with this serializer (optional)
+  - you specify an array of attributes, that will be copied from the object in serializer
+  - you tell how you main object is called (defaults to `object` / `obj`)
+  - you implement `instance_convert`-method for further customization of the serialization
+    -> `field` - a setter method, that also accepts `via: SomeSerializerApiView`
+
+
+        class EventApiView < EventSummaryApiView
+          # default serializer for BoxScore, will be picked, if none other was given
+          for_model ::Event
+
+          # the attributes to copy from the object
+          attributes :share_url, :sport_name
+
+          # the name of your main object, optional
+          main_object :event
+
+          # the method to add additional logic + fields
+          def instance_convert
+            # just a setter method with optional serializer for that sub-object
+            field :box_score, event.box_score, via: BasketballBoxScoreApiView
+          end
+        end
+
+
+  For more examples take a look into the `example/`-folder and run the benchmark script via `ruby example/benchmark.rb`.
+
+
+
+## Developement
+
+    # run tests
+    $ sh/test
+
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/api_view/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+
+## Benchmark numbers (ApiView vs the rest of the pack)
+
+                                                  user     system      total        real       allocations      memsize
+    RABL Ultra Simple                         4.860000   0.620000   5.480000 (  5.493406)              664        25787
+    AMS Ultra Simple                          0.220000   0.000000   0.220000 (  0.220079)               26          650
+    Presenters Ultra Simple                   0.140000   0.000000   0.140000 (  0.152729)               24          650
+    ApiView Ultra Simple                      0.190000   0.000000   0.190000 (  0.193124)               12          842
+    -------------------------------------------------------------------------------------------------------------------
+    RABL Simple                              21.470000   3.330000  24.800000 ( 25.147988)             2265       114051
+    AMS Simple                                1.060000   0.000000   1.060000 (  1.066668)              105         2726
+    Presenters Simple                         0.610000   0.000000   0.610000 (  0.611980)               98         2918
+    ApiView Simple                            0.280000   0.010000   0.290000 (  0.292290)               17         2246
+    -------------------------------------------------------------------------------------------------------------------
+    RABL Complex                             43.930000   6.850000  50.780000 ( 51.574975)             4325       248000
+    AMS Complex                               2.150000   0.000000   2.150000 (  2.160445)              209         5851
+    Presenters Complex                        1.210000   0.010000   1.220000 (  1.220806)              201         7395
+    ApiView Complex                           0.270000   0.000000   0.270000 (  0.270517)               21         1504
+
+
+    Collection tests:
+
+                                                  user     system      total        real       allocations      memsize
+    RABL Ultra Simple: Collection             3.560000   0.600000   4.160000 (  4.182852)            43102      1977224
+    AMS Ultra Simple: Collection              0.120000   0.000000   0.120000 (  0.124631)             1914        47786
+    Presenters Ultra Simple: Collection       0.100000   0.010000   0.110000 (  0.109781)             3508        67594
+    ApiView Ultra Simple: Collection          0.050000   0.000000   0.050000 (  0.050875)              311        46986
+    -------------------------------------------------------------------------------------------------------------------
+    RABL Simple: Collection                  18.720000   3.150000  21.870000 ( 21.924020)           202905     11255130
+    AMS Simple: Collection                    0.870000   0.010000   0.880000 (  0.890479)             9714       236186
+    Presenters Simple: Collection             0.540000   0.000000   0.540000 (  0.542100)            16108       380794
+    ApiView Simple: Collection                0.160000   0.000000   0.160000 (  0.166484)              812       187386
+    -------------------------------------------------------------------------------------------------------------------
+    RABL Complex: Collection                 41.190000   6.680000  47.870000 ( 48.438854)           408015     25251570
+    AMS Complex: Collection                   2.170000   0.030000   2.200000 (  2.211721)            20114       548686
+    Presenters Complex: Collection            1.380000   0.010000   1.390000 (  1.389608)            34408       960494
+    ApiView Complex: Collection               0.150000   0.000000   0.150000 (  0.145595)             1212       113186

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/api_view.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_view/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_view"
+  spec.version       = ApiView::VERSION
+  spec.authors       = ["Roman Heinrich"]
+  spec.email         = ["roman.heinrich@gmail.com"]
+  spec.summary       = %q{A fast and nimble object serializer}
+  spec.description   = %q{A fast and nimble object serializer}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "require_pattern"
+  spec.add_development_dependency "minitest", '~> 5.4.3'
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "oj"
+  spec.add_development_dependency "multi_json"
+  spec.add_development_dependency "ffaker"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "ruby-prof"
+  spec.add_development_dependency "allocation_stats"
+  spec.add_development_dependency "bixby-bench"
+  spec.add_development_dependency "coco"
+
+end

data/benchmark_results.md

@@ -0,0 +1,13 @@
+
+    Object tests:
+                                                  user     system      total        real       allocations      memsize
+    ApiView Ultra Simple                      0.180000   0.000000   0.180000 (  0.184020)               13          648
+    ApiView Simple                            0.310000   0.010000   0.320000 (  0.318673)               17         2251
+    ApiView Complex                           0.350000   0.000000   0.350000 (  0.352970)               17         1501
+
+
+    Collection tests:
+                                                  user     system      total        real       allocations      memsize
+    ApiView Ultra Simple: Collection          0.030000   0.000000   0.030000 (  0.028780)              113        46882
+    ApiView Simple: Collection                0.140000   0.010000   0.150000 (  0.144577)              712       187886
+    ApiView Complex: Collection               0.140000   0.000000   0.140000 (  0.140050)              712       112886

data/example/benchmark.rb

@@ -0,0 +1,43 @@
+require './example/require_models'
+# require 'ruby-prof'
+# require 'allocation_stats'
+require 'bixby/bench'
+
+module SerializationBenchmark
+  collection_size = 100
+  event = EventFactory.build_event
+  team  = event.home_team
+
+  event_collection = collection_size.times.map { event }
+  team_collection  = collection_size.times.map { EventFactory.home_team }
+
+  puts "\nObject tests:\n"
+  Bixby::Bench.run(10_000) do |b|
+    b.sample('ApiView Ultra Simple') do
+      ApiView::Engine.render(team)
+    end
+
+    b.sample('ApiView Simple') do
+      EventSummaryApiView.render(event)
+    end
+
+    b.sample('ApiView Complex') do
+      BasketballEventApiView.render(event)
+    end
+  end
+
+  puts "\n\nCollection tests:\n"
+  Bixby::Bench.run(100) do |b|
+    b.sample('ApiView Ultra Simple: Collection') do
+      ApiView::Engine.render(team_collection)
+    end
+
+    b.sample('ApiView Simple: Collection') do
+      EventSummaryApiView.render(event_collection)
+    end
+
+    b.sample('ApiView Complex: Collection') do
+      BasketballEventApiView.render(event_collection)
+    end
+  end
+end

data/example/models/box_score.rb

@@ -0,0 +1,7 @@
+class BoxScore < Model
+  attr_reader :attendance,
+              :has_statistics,
+              :last_play,
+              :progress,
+              :referees
+end

data/example/models/event.rb

@@ -0,0 +1,20 @@
+class Event < Model
+  attr_reader :away_ranking,
+              :away_region,
+              :away_team,
+              :box_score,
+              :game_date,
+              :game_type,
+              :home_ranking,
+              :home_region,
+              :home_team,
+              :important,
+              :location,
+              :share_url,
+              :sport_name,
+              :status
+
+  def ncaa?
+    true
+  end
+end

data/example/models/event_factory.rb

@@ -0,0 +1,61 @@
+require 'ffaker'
+class EventFactory
+  def self.build_event
+    Event.new(
+      away_team: away_team,
+      box_score: box_score,
+      home_team: home_team,
+      away_ranking: 10,
+      away_region: 'Pac-12',
+      game_date: Date.today,
+      game_type: 'Regular Season',
+      home_ranking: 15,
+      home_region: 'Top 25',
+      important: true,
+      location: 'Washington, DC',
+      share_url: 'http://thesco.re/123',
+      sport_name: 'basketball',
+      status: 'Final'
+    )
+  end
+
+  def self.last_play
+    PlayByPlayRecord.new(
+      points_type: 'Field Goal',
+      player_fouls: 10,
+      player_score: 15,
+      record_type: 'Postseason',
+      seconds: 100
+    )
+  end
+
+  def self.box_score
+    BoxScore.new(
+      last_play: last_play,
+      attendance: '21,307',
+      has_statistics: true,
+      progress: '11:23 2nd',
+      referees: 'Thuva, Nate, Roel'
+    )
+  end
+
+  def self.away_team
+    Team.new(
+      abbreviation: 'MIA',
+      full_name: Faker::Name.name,
+      location: Faker::AddressUS.state,
+      meidum_name: 'Miami',
+      short_name: 'Heats'
+    )
+  end
+
+  def self.home_team
+    Team.new(
+      abbreviation: 'TOR',
+      full_name: Faker::Name.name,
+      location: Faker::AddressUS.state,
+      medium_name: Faker::AddressUS.state,
+      short_name: 'Raptors'
+    )
+  end
+end

data/example/models/model.rb

@@ -0,0 +1,11 @@
+class Model
+  def initialize(attributes={})
+    attributes.each do |attribute, value|
+      instance_variable_set("@#{attribute}", value)
+    end
+  end
+
+  def read_attribute_for_serialization(attribute)
+    send(attribute)
+  end
+end

data/example/models/play_by_play_record.rb

@@ -0,0 +1,7 @@
+class PlayByPlayRecord < Model
+  attr_reader :points_type,
+              :player_fouls,
+              :player_score,
+              :record_type,
+              :seconds
+end

data/example/models/team.rb

@@ -0,0 +1,7 @@
+class Team < Model
+  attr_reader :abbreviation,
+              :full_name,
+              :location,
+              :medium_name,
+              :short_name
+end

data/example/require_models.rb

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler.setup
+require 'benchmark'
+require 'api_view'
+
+require 'multi_json'
+require 'oj'
+require 'pry'
+Oj.mimic_JSON() # this will speedup benchmarks using #to_json
+
+
+require 'require_pattern'
+require_relative_pattern 'models/**/**.rb'
+require_relative_pattern 'views/**/**.rb'
+

data/example/views/basketball/box_score.rb

@@ -0,0 +1,11 @@
+class BasketballBoxScoreApiView < BoxScoreApiView
+
+  attributes :attendance, :referees
+  main_object :box_score
+
+
+  def instance_convert
+    field :last_play, box_score.last_play, via: BasketballPlayByPlayRecordApiView
+  end
+
+end