waveguide 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68aafe56c56693aa78e51c25183674813758da5a
+  data.tar.gz: d53ee7ee8b0fc06ac94381004b5020e2a1f2e69a
+SHA512:
+  metadata.gz: 32338cc59b822e86be83a16d6d4cb6bd24189756feb026248530565734989bcf21f4dce9bdcdaa81197947c4cf45bca98bb4cafdce6974fe5c24bbfa4f1d73df
+  data.tar.gz: 02c7ffd90f624a18ac4c517b756f520b1f5b7172b4fb70f41a925dcc7989b4abc9c70d28cd7f469469ab3f6aec60da8fae99300ca5cc5c0e059327cdcdceebe6

data/.fasterer.yml

@@ -0,0 +1,3 @@
+exclude_paths:
+  - 'spec/**/*.rb'
+  - 'spec/*.rb'

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--order random

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in waveguide.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Aaron Gough
+
+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,81 @@
+# Waveguide
+
+Waveguide is a fast serializer library for Ruby. It's designed to be partly compatible with ActiveModelSerializers, but much faster:
+
+```shell
+300x Events (8701 objects) (Waveguide)  : 111.56 ms
+300x Events (8701 objects) (AMS)        : 774.62 ms
+```
+
+## Usage
+
+```ruby
+class PlayerSerializer < Waveguide::Serializer
+  # define a single attribute
+  attribute :first_name
+
+  # override the source of an attribute with a block
+  attribute :last_name { object.parent.last_name }
+
+  attribute :full_name do
+    "#{object.first_name} #{object.last_name}"
+  end
+
+  # define a list of attributes
+  attributes :first_name, :last_name
+
+  # define a singular relation
+  has_one :country, serializer: CountrySerializer
+
+  # define a singular relation with a different key name
+  has_one :country, as: :origin_country, serializer: CountrySerializer  
+
+  # define a multiple relation
+  has_many :games, serializer: GameSerializer
+
+  # define a multiple relation with a different key name
+  has_many :games, as: :events, serializer: GameSerializer
+
+  # conditionally include an attribute
+  include? :country do 
+    object.respond_to?(:country)
+  end
+end
+```
+
+Example:
+
+```ruby
+class EventSerializer < Waveguide::Serializer
+  has_many :players, serializer: PlayerSerializer
+  attributes :start_date, :end_date
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'waveguide'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install waveguide
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "waveguide"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/waveguide.rb

@@ -0,0 +1,6 @@
+require "waveguide/version"
+require "waveguide/serializer"
+
+module Waveguide
+
+end

data/lib/waveguide/serializer.rb

@@ -0,0 +1,109 @@
+module Waveguide
+  class Serializer
+
+    attr_reader :object, :scope
+
+    def initialize(object, scope = nil)
+      @object = object
+      @scope = scope
+    end
+
+    def as_json
+      self.class.attributes_to_serialize ||= []
+      self.class.conditional_attributes ||= []
+      self.class.serializer_methods ||= {}
+
+      output = {}
+
+      self.class.attributes_to_serialize.each do |key|
+        output[key] = self.send(key)
+      end 
+
+      self.class.conditional_attributes.each do |key|
+        output[key] = self.send(key) if self.send("include_#{key}?")
+      end 
+
+      output
+    end
+
+    class << self
+
+      attr_accessor :attributes_to_serialize,
+                    :conditional_attributes,
+                    :serializer_methods
+
+      def inherited(base)
+        super
+        base.attributes_to_serialize = attributes_to_serialize.dup || []
+        base.conditional_attributes = conditional_attributes.dup || []
+        base.serializer_methods = serializer_methods.dup || {}
+
+        (self.serializer_methods || {}).each do |key, block|
+          base.send(:define_method, key, &block)
+        end
+      end
+
+      def add_attribute(attr_name)
+        return if self.conditional_attributes.include?(attr_name)
+
+        self.attributes_to_serialize ||= []
+        self.attributes_to_serialize << attr_name
+        self.attributes_to_serialize.uniq!
+      end
+
+      def add_conditional_attribute(attr_name)
+        self.conditional_attributes ||= []
+        self.conditional_attributes << attr_name
+        self.conditional_attributes.uniq!
+
+        self.attributes_to_serialize.delete(attr_name)
+      end
+
+      def define_serializer_method(name, &block)
+        self.serializer_methods ||= {}
+        self.serializer_methods[name] = block
+
+        define_method(name, &block)
+      end
+
+      def attributes(*attr_names)
+        attr_names.each do |attr_name|
+          attribute(attr_name)
+        end
+      end
+
+      def attribute(attr_name, &block)
+        add_attribute(attr_name)
+
+        if block.nil?
+          define_serializer_method(attr_name) { object.send(attr_name) }
+        else
+          define_serializer_method(attr_name, &block)
+        end
+      end
+
+      def has_one(relation_name, as: nil, serializer:)
+        key = as || relation_name
+        add_attribute(key)
+        define_serializer_method(key) do
+          serializer.new(object.send(relation_name)).as_json
+        end
+      end
+
+      def has_many(relation_name, as: nil, serializer:)
+        key = as || relation_name
+        add_attribute(key)
+        define_serializer_method(key) do
+          object.send(relation_name).map do |item|
+            serializer.new(item).as_json
+          end
+        end
+      end
+
+      def include?(attr_name, &block)
+        add_conditional_attribute(attr_name)
+        define_serializer_method("include_#{attr_name}?", &block)
+      end
+    end
+  end
+end

data/lib/waveguide/version.rb

@@ -0,0 +1,3 @@
+module Waveguide
+  VERSION = "0.1.0"
+end

data/waveguide.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "waveguide/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "waveguide"
+  spec.version       = Waveguide::VERSION
+  spec.authors       = ["Aaron Gough"]
+  spec.email         = ["aaron@aarongough.com"]
+
+  spec.summary       = %q{An ultra-fast serialization library.}
+  spec.description   = %q{An ultra-fast serialization library.}
+  spec.homepage      = "http://github.com/aarongough/waveguide."
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "active_model_serializers", "~> 0.10.0"
+  spec.add_development_dependency "ruby-prof"
+  spec.add_development_dependency "fasterer"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: waveguide
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Gough
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  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: fasterer
+  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: An ultra-fast serialization library.
+email:
+- aaron@aarongough.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".fasterer.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/waveguide.rb
+- lib/waveguide/serializer.rb
+- lib/waveguide/version.rb
+- waveguide.gemspec
+homepage: http://github.com/aarongough/waveguide.
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: An ultra-fast serialization library.
+test_files: []