serial 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 726a364ac913fa10ae6b515961c6d868ae2c3fb3
+  data.tar.gz: e4fab7b274b159f7fcc6127213d5a14262f8da47
+SHA512:
+  metadata.gz: 5e1e2d538b088082e41b9bd873d455074cd5ce85812179978cbe4aedbc63df29f1898966a9040f0f185f11e980ca41ae46d8360d9d68e891981610dd4f69f75a
+  data.tar.gz: f0308bd4d267cea9bfb3eb47df0a6722fd96eea4430616dfae7e1f34f9f94193c6d4db14617111cf93082fd9b1260018ec48bc381581f17f124d1028e28d1d23

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serial.gemspec
+gemspec

data/README.md

@@ -0,0 +1,85 @@
+# Serial
+
+Serial is a serialization library. Its primary purpose is to generate simple
+datastructures from object graphs.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serial'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serial
+
+## Usage
+
+You can set up your serializers like this:
+
+``` ruby
+# app/serializers/person_serializer.rb
+PersonSerializer = Serializer.new do |h, person|
+  h.attribute(:id, person.id)
+  h.attribute(:name, person.name)
+end
+
+# app/serializers/project_serializer.rb
+ProjectSerializer = Serializer.new do |h, project|
+  h.attribute(:id, project.id)
+  h.attribute(:projectName, project.name)
+  h.attribute(:description, project.description)
+
+  h.attribute(:client, project.client) do |h, client|
+    h.attribute(:id, client.id)
+    h.attribute(:name, client.name)
+  end
+
+  h.map(:assignments, project.assignments) do |h, assignment|
+    h.attribute(:id, assignment.id)
+    h.attribute(:duration, assignment.duration)
+
+    # This is how you compose serializers.
+    h.attribute(:person, assignment.person, &PersonSerializer)
+  end
+
+  h.map(:people, project.people, &PersonSerializer)
+end
+```
+
+Whenever you need to use them you invoke them like this:
+
+``` ruby
+person = Person.find(1)
+render json: PersonSerializer.call(self, person)
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/elabs/serial. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## 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 "serial"
+
+# 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

data/bin/setup

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

data/lib/serial.rb

@@ -0,0 +1,8 @@
+require "serial/version"
+require "serial/serializer"
+require "serial/builder"
+require "serial/hash_builder"
+require "serial/array_builder"
+
+module Serial
+end

data/lib/serial/array_builder.rb

@@ -0,0 +1,18 @@
+module Serial
+  # @api private
+  class ArrayBuilder < Builder
+    def initialize(context, &block)
+      @context = context
+      @data = []
+      yield self
+    end
+
+    def element(&block)
+      @data << build(HashBuilder, &block)
+    end
+
+    def collection(key, &block)
+      @data << build(ArrayBuilder, &block)
+    end
+  end
+end

data/lib/serial/builder.rb

@@ -0,0 +1,24 @@
+module Serial
+  # @api private
+  class Builder
+    def self.build(context, &block)
+      new(context, &block).data
+    end
+
+    attr_reader :data
+
+    def exec(*args, &block)
+      if @context
+        @context.instance_exec(self, *args, &block)
+      else
+        block.call(self, *args)
+      end
+    end
+
+    def build(builder_klass, *args, &block)
+      builder_klass.build(@context) do |builder|
+        builder.exec(*args, &block)
+      end
+    end
+  end
+end

data/lib/serial/hash_builder.rb

@@ -0,0 +1,28 @@
+module Serial
+  # @api private
+  class HashBuilder < Builder
+    def initialize(context, &block)
+      @context = context
+      @data = {}
+      yield self
+    end
+
+    def attribute(key, value = nil, &block)
+      value = build(HashBuilder, value, &block) if block
+      @data[key.to_s] = value
+    end
+
+    def collection(key, &block)
+      list = build(ArrayBuilder, &block)
+      attribute(key, list)
+    end
+
+    def map(key, list, &block)
+      collection(key) do |builder|
+        list.each do |item|
+          builder.element { |element| element.exec(item, &block) }
+        end
+      end
+    end
+  end
+end

data/lib/serial/serializer.rb

@@ -0,0 +1,23 @@
+module Serial
+  class Serializer
+    def initialize(&block)
+      @block = block
+    end
+
+    def map(list)
+      list.map { |item| call(item) }
+    end
+
+    def call(context = nil, value)
+      block = @block
+      HashBuilder.build(context) do |builder|
+        builder.exec(value, &block)
+      end
+    end
+
+    def to_proc
+      block = @block
+      proc { |builder, value| builder.exec(value, &block) }
+    end
+  end
+end

data/lib/serial/version.rb

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

data/serial.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serial/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serial"
+  spec.version       = Serial::VERSION
+  spec.authors       = ["Jonas Nicklas", "Kim Burgestrand"]
+  spec.email         = ["jonas@elabs.se", "kim@elabs.se"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Plain old Ruby for generating simple data structures from object graphs.}
+  spec.homepage      = "https://github.com/elabs/serial"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "yard", "~> 0.8"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: serial
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Nicklas
+- Kim Burgestrand
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- jonas@elabs.se
+- kim@elabs.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/serial.rb
+- lib/serial/array_builder.rb
+- lib/serial/builder.rb
+- lib/serial/hash_builder.rb
+- lib/serial/serializer.rb
+- lib/serial/version.rb
+- serial.gemspec
+homepage: https://github.com/elabs/serial
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Plain old Ruby for generating simple data structures from object graphs.
+test_files: []
+has_rdoc: