primalize-jsonapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a54bbfbd717461fa2970ee531c180c63953107d2eb30d0f7e5dfaea0401ddd9
+  data.tar.gz: 376871b57087786d7572b772ad7e215f65e9bf79a833dfffa37471b8763843d0
+SHA512:
+  metadata.gz: a24643c1bb63eb580c75488b3fc3fa0b8c90e249dfbfbd66d598fce2000057ba2d9c83a9a1e43230698ea1cae293f9d6ed43a093b64a145eae2e792f33c5d23e
+  data.tar.gz: 3095c2f8937b23532bcda02270fc600cc8addb6f31fc6a047982644e50097fe31cf9b1e1fbcea72c8a47d6e5195d2f776d3d5d55c59a9a20771f30c3a650c00b

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.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 jgaskins@gmail.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in primalize-jsonapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jamie Gaskins
+
+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,65 @@
+# Primalize::JSONAPI
+
+This is a JSON-API adapter for the [`primalize` gem](https://github.com/jgaskins/primalize). It aims to provide some level of compatibility with the JSON-API spec while still allowing for the type checking of Primalize.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'primalize-jsonapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install primalize-jsonapi
+
+## Usage
+
+```ruby
+class OrderSerializer < Primalize::JSONAPI
+  # Notice we no longer need the `id` field. It is assumed.
+  attributes(
+    customer_name: string,
+    delivery_address: primalize(AddressSerializer),
+    delivery_instructions: optional(string),
+    shipping_carrier: enum(
+      'UPS',
+      'FedEx',
+      'USPS',
+      'Creepy white van',
+    ),
+    subtotal_cents: integer,
+    shipping_fee_cents: integer,
+    tax_cents: integer,
+    total_cents: integer,
+  )
+
+  # Associations are similar to other serialization gems, but you need to
+  # specify the serializer. There is no runtime inference. We do it inside
+  # a block in case it has not been loaded yet.
+  has_many(:line_items) { LineItemSerializer }
+  has_one(:customer) { CustomerSerializer }
+end
+
+## 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/jgaskins/primalize-jsonapi. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Primalize::JSONAPI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jgaskins/primalize-jsonapi/blob/master/CODE_OF_CONDUCT.md).

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 "primalize/jsonapi"
+
+# 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/primalize/jsonapi/version.rb

@@ -0,0 +1,5 @@
+module Primalize
+  module JSONAPI
+    VERSION = "0.1.0"
+  end
+end

data/lib/primalize/jsonapi.rb

@@ -0,0 +1,250 @@
+require 'primalize/jsonapi/version'
+require 'primalize/single'
+require 'primalize/many'
+
+module Primalize
+  module JSONAPI
+    class Relationships
+      def initialize
+        @rels = []
+        @map = {}
+      end
+
+      def << rel
+        @rels << rel
+        @map[rel.attr] = rel
+      end
+
+      def [] rel
+        @map[rel]
+      end
+
+      def metadata(model, cache:)
+        @rels.each_with_object({}) do |rel, hash|
+          hash[rel.attr] = rel.metadata(model, cache: cache)
+        end
+      end
+
+      def call(model, cache:)
+        @rels.each_with_object({}) do |rel, hash|
+          hash[rel.attr] = rel.call(model)
+        end
+      end
+    end
+
+    class HasMany
+      attr_reader :attr
+      def initialize attr, &block
+        @attr = attr
+        @block = block
+      end
+
+      def call(model, cache:)
+        model.send(@attr).map do |obj|
+          cache.fetch(:serialization, obj) do
+            primalizer.new(obj).call
+          end
+        end
+      end
+
+      def primalizer
+        @primalizer ||= @block.call
+      end
+
+      def metadata(model, cache:)
+        result = model.send(@attr).map do |obj|
+          cache.fetch(:metadata, obj) do
+            MetadataPrimalizer.new(obj).call
+          end
+        end
+
+        { data: result }
+      end
+    end
+
+    class HasOne
+      attr_reader :attr
+      def initialize attr, &block
+        @attr = attr
+        @block = block
+      end
+
+      def call(model, cache:)
+        model = model.send(@attr)
+        cache.fetch(:serialization, model) do
+          primalizer.new(model).call
+        end
+      end
+
+      def primalizer
+        @primalizer ||= @block.call
+      end
+
+      def metadata(model, cache:)
+        model = model.send(@attr)
+        cache.fetch(:metadata, model) do
+          { data: MetadataPrimalizer.new(model).call }
+        end
+      end
+    end
+
+    class MetadataPrimalizer < Single
+      attributes(id: string(&:to_s), type: string)
+
+      def type
+        object.class.name.gsub(/(.)([A-Z])/, '\1_\2').downcase
+      end
+    end
+
+    class Cache
+      def initialize
+        # Three-layer cache: metadata/serialization, class, and id
+        @cache = Hash.new do |h, k|
+          puts "Creating type hash: #{k}"
+          h[k] = Hash.new do |h, k|
+            puts "Creating model hash: #{k}"
+            h[k] = {}
+          end
+        end
+      end
+
+      def [] type, model
+        @cache[type][model.class][model.id]
+      end
+
+      def []= type, model, value
+        @cache[type][model.class][model.id] = value
+      end
+
+      def fetch type, model
+        @cache[type][model.class][model.id] ||= yield
+      end
+    end
+
+    def self.[] *args
+      Class.new(Single) do
+        def self.model_primalizer
+          @model_primalizer ||= Class.new(Single) do
+            def self.attributes **attrs
+              attribute_primalizer.attributes attrs
+            end
+
+            def self.attribute_primalizer
+              @attribute_primalizer ||= Class.new(Single) do
+              end
+            end
+
+            def self.relationships
+              @relationships ||= Relationships.new
+            end
+
+            def self.has_many *args, &block
+              relationships << HasMany.new(*args, &block)
+            end
+
+            def self.has_one *args, &block
+              relationships << HasOne.new(*args, &block)
+            end
+
+            _attributes(
+              id: string(&:to_s),
+              type: string,
+              attributes: object,
+              relationships: object,
+            )
+
+            attr_reader :cache
+
+            def initialize model, cache: Cache.new
+              super(model)
+              @cache = cache
+            end
+
+            def self.name
+              'ModelPrimalizer'
+            end
+
+            def type
+              object.class.name.gsub(/(.)([A-Z])/, '\1_\2').downcase
+            end
+
+            def attributes
+              self.class.attribute_primalizer.new(object).call
+            end
+
+            def relationships
+              self.class.relationships.metadata object, cache: cache
+            end
+          end
+        end
+
+        def self.attributes **attrs
+          model_primalizer.attributes attrs
+        end
+
+        _attributes data: array(primalize(model_primalizer))
+
+        def self.has_many *args, &block
+          model_primalizer.has_many *args, &block
+        end
+
+        def self.has_one *args, &block
+          model_primalizer.has_one *args, &block
+        end
+
+        attr_reader :cache
+
+        def initialize models, include: [], meta: nil, cache: Cache.new
+          super Array(models)
+
+          @include = include
+          @meta = meta
+          @cache = cache
+        end
+
+        def call
+          puts "#{self.class}#call"
+
+          super.tap do |value|
+            if @meta
+              value[:meta] = @meta
+            end
+
+            unless @include.to_a.empty?
+              included = Set.new
+
+              @include.each do |rel|
+                object.each do |model|
+                  primalizer = self.class.model_primalizer.relationships[rel]
+                  relationship = primalizer.call(model, cache: cache)
+
+                  case relationship
+                  when Array
+                    relationship.each do |object|
+                      object[:data].each do |data|
+                        data.delete :relationships
+                        included << data
+                      end
+                    end
+                  when Hash
+                    data = relationship[:data].first
+                    data.delete :relationships
+                    included << data
+                  end
+                end
+              end
+
+              value[:included] = included.to_a
+            end
+          end
+        end
+
+        def data
+          object.map do |model|
+            self.class.model_primalizer.new(model, cache: cache).call
+          end
+        end
+      end
+    end
+  end
+end

data/primalize-jsonapi.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "primalize/jsonapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "primalize-jsonapi"
+  spec.version       = Primalize::JSONAPI::VERSION
+  spec.authors       = ["Jamie Gaskins"]
+  spec.email         = ["jgaskins@gmail.com"]
+
+  spec.summary       = %q{JSON API support for the Primalize gem}
+  spec.homepage      = "https://github.com/jgaskins/primalize-jsonapi"
+  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_dependency "primalize"
+  spec.add_development_dependency "grand_central"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: primalize-jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: primalize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grand_central
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: pry
+  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: 
+email:
+- jgaskins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/primalize/jsonapi.rb
+- lib/primalize/jsonapi/version.rb
+- primalize-jsonapi.gemspec
+homepage: https://github.com/jgaskins/primalize-jsonapi
+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.7.3
+signing_key: 
+specification_version: 4
+summary: JSON API support for the Primalize gem
+test_files: []