simple_json_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f79e962fb92a428343041ed39759f6e78564fce
+  data.tar.gz: 31d9bdcdfd654d50f96309080991040c0126ba59
+SHA512:
+  metadata.gz: 52ca5d094eb111beb2388bb9d57965b8f4d04aedbeb4169c4124d54d42b4ba5e05da2b70e90bce5ebdca243c8bbbe69214c4e960dac564762fe21a333994d4e9
+  data.tar.gz: e4304c2ed873421a9a82b0ef78e9e7d1edc54bb47f6e20b53a450e5ec8e5a1ffa84584a14499b4afc9892f95fa339454ef01d6dc03f55772af4be414b7883998

data/.gitignore

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

data/.overcommit.yml

@@ -0,0 +1,31 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/causes/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/causes/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/causes/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  Rubocop:
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#   quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  Exclude:
+    - test/tmp/*
+
+Style/PredicateName:
+  NamePrefix:
+    - is_
+    - have_

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.2.0
+env:
+  - 'RAILS_VERSION=4.0'
+  - 'RAILS_VERSION=4.1'
+  - 'RAILS_VERSION=4.2'
+  - 'RAILS_VERSION=master'
+matrix:
+  allow_failures:
+    - env: 'RAILS_VERSION=master'

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_json_api.gemspec
+gemspec
+
+version = ENV['RAILS_VERSION'] || '4.1'
+
+case version
+when 'master'
+  gem 'rails', github: 'rails/rails'
+
+  # Learned from AMS
+  # ugh https://github.com/rails/rails/issues/16063#issuecomment-48090125
+  gem 'arel', github: 'rails/arel'
+when '4.0', '4.1', '4.2'
+  gem 'rails', "~> #{version}.0"
+else
+  fail GemfileError, "Unsupported Rails version - #{version}"
+end
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gary Gordon
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Gary Gordon
+
+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,37 @@
+# SimpleJsonApi
+
+[![Build Status](https://travis-ci.org/ggordon/simple_json_api.svg?branch=master)](https://travis-ci.org/ggordon/simple_json_api) [![Code Climate](https://codeclimate.com/github/ggordon/simple_json_api/badges/gpa.svg)](https://codeclimate.com/github/ggordon/simple_json_api) [![Test Coverage](https://codeclimate.com/github/ggordon/simple_json_api/badges/coverage.svg)](https://codeclimate.com/github/ggordon/simple_json_api)
+
+A gem to render json following the [jsonapi](http://jsonapi.org) spec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_json_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_json_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## TODO
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_json_api/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

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+namespace :coverage do
+  desc 'Delete previous coverage results'
+  task :clean do
+    rm_rf 'coverage'
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs.push 'test'
+end
+task test: 'coverage:clean'
+task default: :test
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/simple_json_api.rb

@@ -0,0 +1,27 @@
+require 'simple_json_api/version'
+
+require 'simple_json_api/active_record_refinements'
+require 'simple_json_api/array_refinements'
+require 'simple_json_api/association'
+require 'simple_json_api/attribute'
+require 'simple_json_api/dsl'
+require 'simple_json_api/field_list'
+require 'simple_json_api/include_list'
+
+require 'simple_json_api/serializer'
+require 'simple_json_api/array_serializer'
+require 'simple_json_api/resource_serializer'
+
+require 'simple_json_api/json_api_builder'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  # Main hook to generate json
+  def self.render(model:, serializer:, options: {})
+    JsonApiBuilder.new(
+      model: model,
+      serializer: serializer,
+      options: options
+    ).to_json
+  end
+end

data/lib/simple_json_api/active_record_refinements.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  # Refinements on ActiveRecord
+  module ActiveRecordRefinements
+    refine ActiveRecord::Base do
+      def typed_json_id
+        [self.class.to_s.downcase.pluralize, json_id]
+      end
+
+      def json_id
+        send(json_pk).to_s
+      end
+
+      def json_pk
+        self.class.primary_key.to_sym
+      end
+    end
+  end
+end

data/lib/simple_json_api/array_refinements.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+
+# SimpleJsonApi
+module SimpleJsonApi
+  # Refinements on Hash
+  module ArrayRefinements
+    refine Array do
+      using ActiveRecordRefinements
+      def already_linked?(key:, id:)
+        find { |elem| elem[key] == id }
+      end
+    end
+  end
+end

data/lib/simple_json_api/array_serializer.rb

@@ -0,0 +1,16 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # The ArraySerializer will serialize a collection
+  class ArraySerializer < Serializer
+    def serialize
+      _object.map do |object|
+        serializer = _each_serializer.new(object: object, builder: _builder)
+        serializer.serialize
+      end
+    end
+
+    def _root_name
+      _each_serializer._root_name
+    end
+  end
+end

data/lib/simple_json_api/association.rb

@@ -0,0 +1,10 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # Wrapper for a linked association
+  Association = Struct.new(:name, :type, :serializer, :polymorphic, :key) do
+    def key
+      name_s = name.to_s
+      (type == :has_many) ? name_s.pluralize.to_sym : name_s.singularize.to_sym
+    end
+  end
+end

data/lib/simple_json_api/attribute.rb

@@ -0,0 +1,9 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # Attribute
+  Attribute = Struct.new(:name, :key) do
+    def key
+      self[:key] || self[:name]
+    end
+  end
+end

data/lib/simple_json_api/dsl.rb

@@ -0,0 +1,61 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # Define the public API for creating serializers
+  module DSL
+    attr_accessor :_associations
+    attr_accessor :_attributes
+    attr_reader :_root_name
+
+    def inherited(base)
+      base._associations = []
+      base._attributes = []
+    end
+
+    def serializes(name, options = {})
+      ResourceSerializer.register_serializer(
+        { serializer: self, resource: name },
+        options
+      )
+      @_root_name = name
+    end
+
+    def attribute(name, options = {})
+      register_attribute(name, options)
+    end
+
+    def belongs_to(name, options = {})
+      register_association(name, :belongs_to, options)
+    end
+
+    def has_many(name, options = {})
+      register_association(name, :has_many, options)
+    end
+
+    def has_one(name, options = {})
+      register_association(name, :has_one, options)
+    end
+
+    def default_fields
+      @_attributes.map(&:first).join(',')
+    end
+
+    private
+
+    def register_association(name, type, options)
+      serializer = options.fetch(:serializer, nil)
+      polymorphic = options.fetch(:polymorphic, false)
+      association = SimpleJsonApi::Association.new(
+        name, type, serializer, polymorphic
+      )
+      _associations << association
+      def_delegator :_object, association.name
+    end
+
+    def register_attribute(name, options)
+      key = options.fetch(:key, nil)
+      attribute = SimpleJsonApi::Attribute.new(name, key)
+      _attributes << attribute
+      def_delegator :_object, attribute.name
+    end
+  end
+end

data/lib/simple_json_api/field_list.rb

@@ -0,0 +1,33 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # List of Fields for a resource
+  class FieldList
+    def initialize(fields:, root_serializer:)
+      @fields = fields
+      @root_serializer = root_serializer
+    end
+
+    def field_list
+      @field_list ||= parse
+    end
+
+    def parse
+      result = {}
+      case @fields
+      when Hash
+        @fields.each do |resource, fields|
+          result[resource.to_sym] = FIELD_LIST_PARSER.call(fields)
+        end
+      when String
+        result[@root_serializer._root_name] = FIELD_LIST_PARSER.call(@fields)
+      end
+      result
+    end
+
+    def fields_for(resource)
+      field_list.fetch(resource, nil)
+    end
+
+    FIELD_LIST_PARSER = ->(list) { list.split(',').map(&:to_s) }
+  end
+end

data/lib/simple_json_api/include_list.rb

@@ -0,0 +1,20 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # List of Included associations for a resource
+  class IncludeList
+    def initialize(include:)
+      @include = include
+      @include_list = []
+    end
+
+    def parse
+      @include_list = @include.split(',').map(&:to_s) if @include.is_a? String
+      self
+    end
+
+    def include?(resource, parent = [])
+      path = [parent, resource].flatten.compact.join('.')
+      @include_list.include?(path)
+    end
+  end
+end

data/lib/simple_json_api/json_api_builder.rb

@@ -0,0 +1,92 @@
+# SimpleJsonApi
+module SimpleJsonApi
+  # The Builder to walk the hierarchy and contruct the JSON
+  class JsonApiBuilder
+    using ActiveRecordRefinements
+    using ArrayRefinements
+
+    extend Forwardable
+
+    attr_reader :serializer
+    attr_reader :model
+    attr_reader :_included_resources
+    attr_reader :include
+    attr_reader :field_list
+    attr_reader :result
+
+    def_delegators :@field_list, :fields_for
+
+    # TODO: sort: nil
+    def initialize(model:, serializer:, options: {})
+      @model = model
+      handle_options(options, serializer)
+      @serializer = get_serializer(serializer)
+      @_included_resources = {}
+      @result = {}
+      @linked = {}
+    end
+
+    def handle_options(options, serializer)
+      @field_list = FieldList.new(
+        fields: options.fetch(:fields, nil),
+        root_serializer: serializer
+      )
+      @include = IncludeList.new(
+        include: options.fetch(:include, nil)
+      ).parse
+    end
+
+    def as_json(options = nil)
+      build.as_json(options)
+    end
+
+    def build
+      result[@serializer._root_name] = @serializer.serialize
+      @result[:linked] = @linked unless @linked.empty?
+      @result
+    end
+
+    def add_linked_elem(elem, obj, association, base)
+      resource_name = elem.to_s.pluralize
+      obj = Array(obj) unless obj.respond_to?(:each)
+      obj.each do |item|
+        serialize_association(item, resource_name, association, base)
+      end
+    end
+
+    def serialize_association(item, resource_name, association, base)
+      # TODO: don't include middle unless explicitly requested.
+      return unless include.include?(resource_name, base)
+      assoc_base = [base, resource_name].compact.join('.')
+      serializer = ResourceSerializer.for(item, association)
+      add_to_linked(assoc_base, item, serializer)
+    end
+
+    def add_to_linked(assoc_base, item, serializer)
+      linked = @linked[serializer._root_name] ||= []
+      return if linked.already_linked?(key: item.json_pk, id: item.json_id)
+      linked << serializer.new(
+        object: item, builder: self, base: assoc_base
+      ).serialize
+    end
+
+    private
+
+    def get_serializer(serializer)
+      if use_array_serializer?
+        ArraySerializer.new(
+          object: @model,
+          each_serializer: serializer,
+          builder: self
+        )
+      else
+        serializer.new(object: @model, builder: self)
+      end
+    end
+
+    def use_array_serializer?
+      @model.is_a?(Array) ||
+        @model.is_a?(ActiveRecord::Associations::CollectionProxy)
+    end
+  end
+end