supa 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07a270a2a9086ea44a5c82efb0bdc8571ac219ba
+  data.tar.gz: 1a222147091f881a346fff4b6467a536b4e995ad
+SHA512:
+  metadata.gz: 53e7f232f60a5ac4316a4c788802d564f5cbfdc46df0b80c59154fcd20affdd8f1ca18b85ec66084155ceb42dd39b73407f784094e09a361252de5b61f246421
+  data.tar.gz: db596cc0ca47081caa679d2f6689446004695b2ff4e9d92736cd144665069a21d8f5adc8ada0b4359c17c60e4724891bad2be0c11445152b208335f195eb02c5

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrey.duplischev@distribusion.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrey D
+
+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,209 @@
+# Supa
+
+Ruby object → JSON serialization.
+
+[![Build Status](https://travis-ci.org/dasnotme/supa.svg?branch=master)](https://travis-ci.org/dasnotme/supa)
+
+## Introduction
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'supa'
+```
+
+And then execute:
+```shell
+bundle install
+```
+
+Or install it yourself as:
+```
+gem install supa
+```
+
+## Usage
+
+### Example
+
+```ruby
+class Article
+  attr_accessor :id, :title, :text, :author, :comments
+end
+```
+```ruby
+class Author
+  attr_accessor :id, :first_name, :last_name
+end
+```
+```ruby
+class Comment
+  attr_accessor :id, :text
+end
+```
+
+```ruby
+class ArticleRepresenter
+  include Supa::Representable
+
+  define do
+    namespace :jsonapi do
+      attribute :version, getter: proc { 1.1 }
+    end
+
+    namespace :data do
+      attribute :id
+      attribute :type, getter: proc { 'articles' }
+
+      namespace :attributes do
+        attribute :title
+        attribute :text
+      end
+
+      namespace :relationships do
+        object :author do
+          namespace :data do
+            attribute :id
+            attribute :type, getter: proc { 'authors' }
+          end
+        end
+
+        namespace :comments do
+          collection :data, getter: proc { self.comments } do
+            attribute :id
+            attribute :type, getter: proc { 'comments' }
+          end
+        end
+      end
+    end
+
+    polymorphic :included, getter: proc { [self.author] } do
+      attribute :id
+      attribute :type, getter: proc { 'authors' }
+
+      namespace :attributes do
+        attribute :first_name
+        attribute :last_name
+      end
+    end
+
+    polymorphic :included, getter: proc { self.comments } do
+      attribute :id
+      attribute :type, getter: proc { 'comments' }
+
+      namespace :attributes do
+        attribute :text
+      end
+    end
+  end
+end
+```
+
+```ruby
+ArticleRepresenter.new(Article.new).to_json
+```
+
+```json
+{
+  "jsonapi": {
+    "version": 1.1
+  },
+  "data": {
+    "id": "7aa15512-1f9d-4a86-98ad-4bb0aae487a2",
+    "type": "articles",
+    "attributes": {
+      "title": "Pilot wave theory",
+      "text": "In theoretical physics, the pilot wave theory was the first known example of a hidden variable theory, presented by Louis de Broglie in 1927. Its more modern version, the de Broglie–Bohm theory, remains a non-mainstream attempt to interpret quantum mechanics as a deterministic theory, avoiding troublesome notions such as wave–particle duality, instantaneous wave function collapse and the paradox of Schrödinger's cat."
+    },
+    "relationships": {
+      "author": {
+        "data": {
+          "id": "52139b0b-bd22-4fc7-adc8-593f16ae034f",
+          "type": "authors"
+        }
+      },
+      "comments": {
+        "data": [
+          {
+            "id": "35a88ca5-80ec-4e49-9357-d8a16b8873f8",
+            "type": "comments"
+          },
+          {
+            "id": "0e02b198-299a-4e6b-99a0-8f2c33c15b1d",
+            "type": "comments"
+          }
+        ]
+      }
+    }
+  },
+  "included": [
+    {
+      "id": "52139b0b-bd22-4fc7-adc8-593f16ae034f",
+      "type": "authors",
+      "attributes": {
+        "first_name": "Louis",
+        "last_name": "de Broglie"
+      }
+    },
+    {
+      "id": "35a88ca5-80ec-4e49-9357-d8a16b8873f8",
+      "type": "comments",
+      "attributes": {
+        "text": "There can exist empty waves, represented by wave functions propagating in space and time but not carrying energy or momentum, and not associated with a particle."
+      }
+    },
+    {
+      "id": "0e02b198-299a-4e6b-99a0-8f2c33c15b1d",
+      "type": "comments",
+      "attributes": {
+        "text": "Let's call the concept ghost waves."
+      }
+    }
+  ]
+}
+```
+
+### `attribute`
+
+### `namespace`
+
+### `object`
+
+### `collection`
+
+### `polymorphic`
+
+## Development
+
+To install dependencies
+```shell
+bin/setup
+```
+
+To run tests
+```shell
+bundle exec rake test
+```
+
+To run benchmarks
+```shell
+bundle exec rake bench
+```
+
+To spin up an interactive prompt that will allow you to experiment
+```shell
+bin/console
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dasnotme/supa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << %w(spec lib)
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+Rake::TestTask.new(:bench) do |t|
+  t.libs << %w(spec lib)
+  t.test_files = FileList['spec/**/*_bench.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "supa"
+
+# 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,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/supa.rb

@@ -0,0 +1,6 @@
+require 'supa/version'
+require 'supa/builder'
+require 'supa/representable'
+
+module Supa
+end

data/lib/supa/builder.rb

@@ -0,0 +1,39 @@
+require 'supa/commands/attribute'
+require 'supa/commands/object'
+require 'supa/commands/namespace'
+require 'supa/commands/collection'
+require 'supa/commands/polymorphic'
+
+module Supa
+  class Builder
+    COMMANDS = %w(attribute object namespace collection polymorphic).freeze
+
+    COMMANDS.each do |command|
+      klass = Supa::Commands.const_get(command.capitalize)
+
+      define_method command do |name, options = {}, &block|
+        klass.new(context: context,
+                  tree: tree,
+                  name: name,
+                  options: options,
+                  &block).represent
+      end
+    end
+
+    def initialize(context:, tree:)
+      @context = context
+      @tree = tree
+    end
+
+    def to_hash
+      tree.to_hash
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
+    private
+    attr_reader :context, :tree
+  end
+end

data/lib/supa/command.rb

@@ -0,0 +1,26 @@
+module Supa
+  class Command
+    def initialize(context:, tree:, name:, options: {}, &block)
+      @context = context
+      @tree = tree
+      @name = name
+      @options = options
+      @block = block
+    end
+
+    def represent
+      raise NotImplementedError
+    end
+
+    private
+    attr_reader :context, :tree, :name, :options, :block
+
+    def with_getter?
+      options[:getter].is_a?(Proc)
+    end
+
+    def getter
+      options[:getter]
+    end
+  end
+end

data/lib/supa/commands/attribute.rb

@@ -0,0 +1,13 @@
+require 'supa/command'
+
+module Supa
+  module Commands
+    class Attribute < Supa::Command
+      def represent
+        value = with_getter? ? context.instance_exec(&getter) : context.send(name)
+
+        tree[name] = value
+      end
+    end
+  end
+end

data/lib/supa/commands/collection.rb

@@ -0,0 +1,19 @@
+require 'supa/command'
+
+module Supa
+  module Commands
+    class Collection < Supa::Command
+      def represent
+        values = with_getter? ? context.instance_exec(&getter) : context.send(name)
+
+        tree[name] = []
+
+        Array(values).each do |value|
+          tree[name] << {}
+
+          Supa::Builder.new(context: value, tree: tree[name][-1]).instance_exec(&block)
+        end
+      end
+    end
+  end
+end

data/lib/supa/commands/namespace.rb

@@ -0,0 +1,15 @@
+require 'supa/command'
+
+module Supa
+  module Commands
+    class Namespace < Supa::Command
+      def represent
+        tree[name] = {}
+
+        Supa::Builder.new(context: context, tree: tree[name]).instance_exec(&block)
+      end
+    end
+  end
+end
+
+

data/lib/supa/commands/object.rb

@@ -0,0 +1,15 @@
+require 'supa/command'
+
+module Supa
+  module Commands
+    class Object < Supa::Command
+      def represent
+        value = with_getter? ? context.instance_exec(&getter) : context.send(name)
+
+        tree[name] = {}
+
+        Supa::Builder.new(context: value, tree: tree[name]).instance_exec(&block)
+      end
+    end
+  end
+end

data/lib/supa/commands/polymorphic.rb

@@ -0,0 +1,19 @@
+require 'supa/command'
+
+module Supa
+  module Commands
+    class Polymorphic < Supa::Command
+      def represent
+        values = with_getter? ? context.instance_exec(&getter) : context.send(name)
+
+        tree[name] ||= []
+
+        Array(values).each do |value|
+          tree[name] << {}
+
+          Supa::Builder.new(context: value, tree: tree[name][-1]).instance_exec(&block)
+        end
+      end
+    end
+  end
+end

data/lib/supa/representable.rb

@@ -0,0 +1,35 @@
+module Supa
+  module Representable
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+      def initialize(object)
+        @object = object
+      end
+
+      def to_hash
+        Supa::Builder.new(context: object, tree: {}).tap do |builder|
+          builder.instance_exec(&self.class.definition)
+        end.to_hash
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+
+      private
+      attr_reader :object
+    end
+
+    module ClassMethods
+      def define(&block)
+        @definition = block
+      end
+
+      attr_reader :definition
+    end
+  end
+end

data/lib/supa/version.rb

@@ -0,0 +1,3 @@
+module Supa
+  VERSION = "0.1.1"
+end

data/supa.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'supa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "supa"
+  spec.version       = Supa::VERSION
+  spec.authors       = ["Das"]
+  spec.email         = [""]
+
+  spec.summary       = "Ruby object → JSON serialization."
+  spec.description   = "Ruby object → JSON serialization."
+  spec.homepage      = "https://github.com/dasnotme/supa"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: supa
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Das
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby object → JSON serialization.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/supa.rb
+- lib/supa/builder.rb
+- lib/supa/command.rb
+- lib/supa/commands/attribute.rb
+- lib/supa/commands/collection.rb
+- lib/supa/commands/namespace.rb
+- lib/supa/commands/object.rb
+- lib/supa/commands/polymorphic.rb
+- lib/supa/representable.rb
+- lib/supa/version.rb
+- supa-0.1.0.gem
+- supa.gemspec
+homepage: https://github.com/dasnotme/supa
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Ruby object → JSON serialization.
+test_files: []