graphiti-rb 1.0.alpha.1

data/lib/generators/jsonapi/templates/application_resource.rb.erb

@@ -0,0 +1,15 @@
+<%- unless omit_comments? -%>
+# ApplicationResource is similar to ApplicationRecord - a base class that
+# holds configuration/methods for subclasses.
+# All Resources should inherit from ApplicationResource.
+# Resource documentation: https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Resource.html
+<%- end -%>
+class ApplicationResource < Graphiti::Resource
+  <%- unless omit_comments? -%>
+  # Use the ActiveRecord Adapter for all subclasses.
+  # Subclasses can still override this default.
+  # More on adapters: https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Adapters/Abstract.html
+  <%- end -%>
+  self.abstract_class = true
+  self.adapter = Graphiti::Adapters::ActiveRecord::Base.new
+end

data/lib/generators/jsonapi/templates/controller.rb.erb

@@ -0,0 +1,61 @@
+<% module_namespacing do -%>
+class <%= model_klass.name.pluralize %>Controller < ApplicationController
+  <%- if actions?('index') -%>
+  def index
+    <%= file_name.pluralize %> = <%= resource_klass %>.all(params)
+    <%- if responders? -%>
+    respond_with(<%= file_name.pluralize %>)
+    <%- else -%>
+    render jsonapi: <%= file_name.pluralize %>
+    <%- end -%>
+  end
+  <%- end -%>
+  <%- if actions?('show') -%>
+
+  def show
+    <%= file_name %> = <%= resource_klass %>.find(params)
+    <%- if responders? -%>
+    respond_with(<%= file_name %>)
+    <%- else -%>
+    render jsonapi: <%= file_name %>
+    <%- end -%>
+  end
+  <%- end -%>
+  <%- if actions?('create') -%>
+
+  def create
+    <%= file_name %> = <%= resource_klass %>.build(params)
+
+    if <%= file_name %>.save
+      render jsonapi: <%= file_name %>, status: 201
+    else
+      render jsonapi_errors: <%= file_name %>
+    end
+  end
+  <%- end -%>
+  <%- if actions?('update') -%>
+
+  def update
+    <%= file_name %> = <%= resource_klass %>.find(params)
+
+    if <%= file_name %>.update_attributes
+      render jsonapi: <%= file_name %>
+    else
+      render jsonapi_errors: <%= file_name %>
+    end
+  end
+  <%- end -%>
+  <%- if actions?('destroy') -%>
+
+  def destroy
+    <%= file_name %> = <%= resource_klass %>.find(params)
+
+    if <%= file_name %>.destroy
+      render jsonapi: { meta: {} }, status: 200
+    else
+      render jsonapi_errors: <%= file_name %>
+    end
+  end
+  <%- end -%>
+end
+<% end -%>

data/lib/generators/jsonapi/templates/create_request_spec.rb.erb

@@ -0,0 +1,30 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#create", type: :request do
+  subject(:make_request) do
+    jsonapi_post "/<%= api_namespace %>/v1/<%= type %>", payload
+  end
+
+  describe 'basic create' do
+    let(:payload) do
+      {
+        data: {
+          type: '<%= type %>',
+          attributes: {
+            # ... your attrs here
+          }
+        }
+      }
+    end
+
+    it 'works' do
+      expect(<%= resource_klass %>).to receive(:build).and_call_original
+      expect {
+        make_request
+      }.to change { <%= model_klass %>.count }.by(1)
+      <%= file_name %> = <%= model_klass %>.last
+      # assert on properties
+      expect(response.status).to eq(201)
+    end
+  end
+end

data/lib/generators/jsonapi/templates/destroy_request_spec.rb.erb

@@ -0,0 +1,20 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#destroy", type: :request do
+  subject(:make_request) do
+    jsonapi_delete "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}"
+  end
+
+  describe 'basic destroy' do
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+
+    it 'updates the resource' do
+      expect(<%= resource_klass %>).to receive(:find).and_call_original
+      expect { make_request }.to change { <%= model_klass %>.count }.by(-1)
+      expect { <%= file_name %>.reload }
+        .to raise_error(ActiveRecord::RecordNotFound)
+      expect(response.status).to eq(200)
+      expect(json).to eq('meta' => {})
+    end
+  end
+end

data/lib/generators/jsonapi/templates/index_request_spec.rb.erb

@@ -0,0 +1,22 @@
+require 'rails_helper'
+
+RSpec.describe "<%= file_name.pluralize %>#index", type: :request do
+  let(:params) { {} }
+
+  subject(:make_request) do
+    jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>", params: params
+  end
+
+  describe 'basic fetch' do
+    let!(:<%= file_name %>1) { create(:<%= file_name %>) }
+    let!(:<%= file_name %>2) { create(:<%= file_name %>) }
+
+    it 'works' do
+      expect(<%= resource_klass %>).to receive(:all).and_call_original
+      make_request
+      expect(response.status).to eq(200)
+      expect(d.map(&:jsonapi_type).uniq).to eq(['<%= file_name.pluralize %>'])
+      expect(d.map(&:id)).to eq([<%= file_name %>1.id, <%= file_name %>2.id])
+    end
+  end
+end

data/lib/generators/jsonapi/templates/resource.rb.erb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Resource < ApplicationResource
+  <%- attributes.each do |a| -%>
+  <%- if [:created_at, :updated_at].include?(a.name.to_sym) -%>
+  attribute :<%= a.name %>, :<%= a.type %>, writable: false
+  <%- else -%>
+  attribute :<%= a.name %>, :<%= a.type %>
+  <%- end -%>
+  <%- end -%>
+end
+<% end -%>

data/lib/generators/jsonapi/templates/resource_reads_spec.rb.erb

@@ -0,0 +1,62 @@
+require 'rails_helper'
+
+RSpec.describe <%= resource_klass %>, type: :resource do
+  describe 'serialization' do
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+
+    it 'works' do
+      render
+      data = jsonapi_data[0]
+      expect(data.id).to eq(<%= file_name %>.id)
+      expect(data.jsonapi_type).to eq('<%= file_name.pluralize %>')
+      <%- attributes.each do |a| -%>
+      <%- if [:created_at, :updated_at].include?(a.name.to_sym) -%>
+      expect(data.<%= a.name %>).to eq(datetime(<%= file_name %>.<%= a.name %>))
+      <%- else -%>
+      expect(data.<%= a.name %>).to eq(<%= file_name %>.<%= a.name %>)
+      <%- end -%>
+      <%- end -%>
+    end
+  end
+  <%- if actions?('index') -%>
+
+  describe 'filtering' do
+    let!(:<%= file_name %>1) { create(:<%= file_name %>) }
+    let!(:<%= file_name %>2) { create(:<%= file_name %>) }
+
+    context 'by id' do
+      before do
+        params[:filter] = { id: { eq: <%= file_name %>2.id } }
+      end
+
+      it 'works' do
+        render
+        expect(d.map(&:id)).to eq([<%= file_name %>2.id])
+      end
+    end
+  end
+
+  describe 'sorting' do
+    context 'by id descending' do
+      let!(:<%= file_name %>1) { create(:<%= file_name %>) }
+      let!(:<%= file_name %>2) { create(:<%= file_name %>) }
+
+      before do
+        params[:sort] = '-id'
+      end
+
+      it 'works' do
+        render
+        expect(d.map(&:id)).to eq([
+          <%= file_name %>2.id,
+          <%= file_name %>1.id
+        ])
+      end
+    end
+  end
+  <%- end -%>
+
+  describe 'sideloading' do
+    # ... your tests ...
+  end
+end

data/lib/generators/jsonapi/templates/resource_writes_spec.rb.erb

@@ -0,0 +1,63 @@
+require 'rails_helper'
+
+RSpec.describe <%= resource_klass %>, type: :resource do
+  describe 'creating' do
+    let(:payload) do
+      {
+        data: {
+          type: '<%= file_name.pluralize %>',
+          attributes: { }
+        }
+      }
+    end
+
+    let(:instance) do
+      <%= resource_klass %>.build(payload)
+    end
+
+    it 'works' do
+      expect {
+        expect(instance.save).to eq(true)
+      }.to change { <%= model_klass %>.count }.by(1)
+    end
+  end
+
+  describe 'updating' do
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+
+    let(:payload) do
+      {
+        data: {
+          id: <%= file_name %>.id.to_s,
+          type: '<%= file_name.pluralize %>',
+          attributes: { } # Todo!
+        }
+      }
+    end
+
+    let(:instance) do
+      <%= resource_klass %>.find(payload)
+    end
+
+    xit 'works (add some attributes and enable this spec)' do
+      expect {
+        expect(instance.update_attributes).to eq(true)
+      }.to change { <%= file_name %>.reload.updated_at }
+      # and change { instance.foo }.to('bar') <- example
+    end
+  end
+
+  describe 'destroying' do
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+
+    let(:instance) do
+      <%= resource_klass %>.find(id: <%= file_name %>.id)
+    end
+
+    it 'works' do
+      expect {
+        expect(instance.destroy).to eq(true)
+      }.to change { <%= model_klass %>.count }.by(-1)
+    end
+  end
+end

data/lib/generators/jsonapi/templates/show_request_spec.rb.erb

@@ -0,0 +1,21 @@
+require 'rails_helper'
+
+RSpec.describe "<%= file_name.pluralize %>#show", type: :request do
+  let(:params) { {} }
+
+  subject(:make_request) do
+    jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>/#{<%= file_name %>.id}", params: params
+  end
+
+  describe 'basic fetch' do
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+
+    it 'works' do
+      expect(<%= resource_klass %>).to receive(:find).and_call_original
+      make_request
+      expect(response.status).to eq(200)
+      expect(d.jsonapi_type).to eq('<%= file_name.pluralize %>')
+      expect(d.id).to eq(<%= file_name %>.id)
+    end
+  end
+end

data/lib/generators/jsonapi/templates/update_request_spec.rb.erb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#update", type: :request do
+  subject(:make_request) do
+    jsonapi_put "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}", payload
+  end
+
+  describe 'basic update' do
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+
+    let(:payload) do
+      {
+        data: {
+          id: <%= file_name %>.id.to_s,
+          type: '<%= type %>',
+          attributes: {
+            # ... your attrs here
+          }
+        }
+      }
+    end
+
+    # Replace 'xit' with 'it' after adding attributes
+    xit 'updates the resource' do
+      expect(<%= resource_klass %>).to receive(:find).and_call_original
+      expect {
+        make_request
+      }.to change { <%= file_name %>.reload.attributes }
+      expect(response.status).to eq(200)
+
+      # ... assert updates attributes ...
+    end
+  end
+end

data/lib/graphiti-rb.rb

@@ -0,0 +1 @@
+require 'graphiti'

data/lib/graphiti.rb

@@ -0,0 +1,121 @@
+require 'json'
+require 'forwardable'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/hash/conversions' # to_xml
+require 'active_support/concern'
+require 'active_support/time'
+
+require 'dry-types'
+require 'jsonapi_errorable'
+
+require 'jsonapi/serializable'
+
+require "graphiti/version"
+require "graphiti/jsonapi_serializable_ext"
+require "graphiti/configuration"
+require "graphiti/context"
+require "graphiti/errors"
+require "graphiti/types"
+require "graphiti/adapters/abstract"
+require "graphiti/resource/sideloading"
+require "graphiti/resource/configuration"
+require "graphiti/resource/dsl"
+require "graphiti/resource/interface"
+require "graphiti/resource/polymorphism"
+require "graphiti/sideload"
+require "graphiti/sideload/has_many"
+require "graphiti/sideload/belongs_to"
+require "graphiti/sideload/has_one"
+require "graphiti/sideload/many_to_many"
+require "graphiti/sideload/polymorphic_belongs_to"
+require "graphiti/resource"
+require "graphiti/resource_proxy"
+require "graphiti/query"
+require "graphiti/scope"
+require "graphiti/deserializer"
+require "graphiti/renderer"
+require "graphiti/hash_renderer"
+require "graphiti/filter_operators"
+require "graphiti/scoping/base"
+require "graphiti/scoping/sort"
+require "graphiti/scoping/paginate"
+require "graphiti/scoping/extra_attributes"
+require "graphiti/scoping/filterable"
+require "graphiti/scoping/default_filter"
+require "graphiti/scoping/filter"
+require "graphiti/stats/dsl"
+require "graphiti/stats/payload"
+require "graphiti/util/include_params"
+require "graphiti/util/field_params"
+require "graphiti/util/hash"
+require "graphiti/util/relationship_payload"
+require "graphiti/util/persistence"
+require "graphiti/util/validation_response"
+require "graphiti/util/sideload"
+require "graphiti/util/hooks"
+require "graphiti/util/attribute_check"
+require "graphiti/util/serializer_attributes"
+
+require 'graphiti/adapters/null'
+
+require "graphiti/extensions/extra_attribute"
+require "graphiti/extensions/boolean_attribute"
+require "graphiti/extensions/temp_id"
+
+if defined?(ActiveRecord)
+  require 'graphiti/adapters/active_record'
+end
+
+if defined?(Rails)
+  require 'graphiti/railtie'
+  require 'graphiti/rails'
+  require 'graphiti/responders'
+end
+
+module Graphiti
+  autoload :Base, 'graphiti/base'
+
+  def self.included(klass)
+    klass.instance_eval do
+      include Base
+    end
+  end
+
+  # @api private
+  def self.context
+    Thread.current[:context] ||= {}
+  end
+
+  # @api private
+  def self.context=(val)
+    Thread.current[:context] = val
+  end
+
+  # @api private
+  def self.with_context(obj, namespace = nil)
+    begin
+      prior = self.context
+      self.context = { object: obj, namespace: namespace }
+      yield
+    ensure
+      self.context = prior
+    end
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # @example
+  #   Graphiti.configure do |c|
+  #     c.raise_on_missing_sideload = false
+  #   end
+  #
+  # @see Configuration
+  def self.configure
+    yield config
+  end
+end
+
+require "graphiti/runner"