grape-roar 0.4.0 → 0.5.0

data/spec/extensions/relations/validations/mongoid_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+if defined?(Mongoid)
+  describe Grape::Roar::Extensions::Relations::Validations::Mongoid, :mongoid do
+    let(:model_klass) { double }
+    let(:map_reflection) do
+      proc do |r|
+        case r
+        when /and/     then 'ManyToMany'
+        when /many/    then 'Many'
+        when /one/     then 'One'
+        when /belongs/ then 'In'
+        end
+      end
+    end
+
+    subject do
+      klass = Class.new do
+        def initialize(klass)
+          @klass = klass
+        end
+
+        attr_reader :klass
+      end
+
+      klass.include(described_class)
+      klass.new(model_klass)
+    end
+
+    before do
+      expect(model_klass).to receive(:reflect_on_association).twice do |r|
+        if r == :test_rel
+          if Gem::Version.new(Mongoid::VERSION) < Gem::Version.new('7')
+            { relation: "Mongoid::Relations::#{relation_klass}::#{map_reflection.call(test_method)}".constantize }
+          else
+            { relation: "Mongoid::Association::#{relation_klass}::#{test_method.to_s.camelize}".constantize }
+          end
+        else
+          { relation: double }
+        end
+      end
+    end
+
+    context 'referenced' do
+      let(:relation_klass) { 'Referenced' }
+
+      %i[
+        belongs_to
+        has_and_belongs_to_many
+        has_many
+        has_one
+      ].each do |test_method|
+        describe "##{test_method}_valid? validates the relation" do
+          let(:test_method) { test_method }
+
+          it 'properly validates the relation' do
+            expect(subject.send("#{test_method}_valid?", :test_rel)).to eql(true)
+
+            expect do
+              subject.send("#{test_method}_valid?", :fail)
+            end.to raise_error(
+              Grape::Roar::Extensions::Relations::
+              Exceptions::InvalidRelationError
+            )
+          end
+        end
+      end
+    end
+
+    context 'embedded' do
+      let(:relation_klass) { 'Embedded' }
+
+      %i[embeds_one embeds_many].each do |test_method|
+        describe "##{test_method}_valid? validates the relation" do
+          let(:test_method) { test_method }
+
+          it 'properly validates the relation' do
+            expect(subject.send("#{test_method}_valid?", :test_rel)).to eql(true)
+
+            expect do
+              subject.send("#{test_method}_valid?", :fail)
+            end.to raise_error(
+              Grape::Roar::Extensions::Relations::
+              Exceptions::InvalidRelationError
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/nested_representer_spec.rb

@@ -1,20 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Roar do
-  subject do
-    Class.new(Grape::API)
-  end
-
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Roar
-  end
-
-  def app
-    subject
-  end
-
   context 'nested representer' do
+    include_context 'Grape API App'
+
     before do
       subject.get('/order/:id') do
         order = Order.new(id: params[:id], client_id: 42)

data/spec/present_with_spec.rb

@@ -1,18 +1,7 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Roar do
-  subject do
-    Class.new(Grape::API)
-  end
-
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Roar
-  end
-
-  def app
-    subject
-  end
+  include_context 'Grape API App'
 
   context 'using present' do
     before do

data/spec/relations_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+describe Grape::Roar::Extensions::Relations do
+  describe '.included' do
+    subject { Class.new }
+
+    after { subject.include(described_class) }
+
+    it 'mixes DSLMethods into the singleton class of its target' do
+      expect(subject.singleton_class).to receive(:include).with(
+        Grape::Roar::Extensions::Relations::DSLMethods
+      )
+    end
+  end
+
+  context 'with mongoid', :mongoid do
+    include_context 'Grape API App'
+
+    # Make sure Mongo is empty
+    before { Mongoid::Config.purge! }
+
+    let(:result) { JSON.parse(last_response.body) }
+
+    context 'has_many, embedded: false' do
+      before do
+        subject.get('/carts/:id') do
+          cart = Cart.create(id: params[:id])
+          Array.new(5).map { Item.create(cart: cart) }
+          present(cart, with: MongoidCartRepresenter)
+        end
+
+        get '/carts/1'
+      end
+
+      it 'correctly generates the self link' do
+        expect(result['_links']['self']['href']).to eql(
+          'http://example.org/carts/1'
+        )
+      end
+
+      it 'correctly generates links for items' do
+        expect(result['_links']['items'].map { |l| l['href'] }).to all(
+          match(%r{^http://example\.org/items/[A-Za-z0-9]*$})
+        )
+      end
+    end
+
+    context 'belongs_to, embedded: true' do
+      before do
+        subject.get('/items/:id') do
+          present(
+            Item.create(id: params[:id], cart: Cart.create),
+            with: MongoidItemRepresenter
+          )
+        end
+
+        get '/items/1'
+      end
+
+      it 'correctly generates the self link' do
+        expect(result['_links']['self']['href']).to eql(
+          'http://example.org/items/1'
+        )
+      end
+
+      it 'correctly represents the embedded cart' do
+        expect(result['_embedded']['cart']['_links']['self']['href'])
+          .to match(%r{^http://example\.org/carts/[A-Za-z0-9]*$})
+
+        expect(result['_embedded']['cart']['_links']['items'].count).to eql(1)
+        expect(result['_embedded']['cart']['_links']['items'].first).to eql(
+          result['_links']['self']
+        )
+      end
+    end
+  end
+end

data/spec/representer_spec.rb

@@ -1,29 +1,46 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Roar do
-  subject do
-    Class.new(Grape::API)
-  end
-
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Roar
-  end
-
-  def app
-    subject
-  end
+  include_context 'Grape API App'
 
   context 'representer' do
-    before do
-      subject.get('/article/:id') do
-        Article.new(title: 'Lonestar', id: params[:id])
+    context 'with a known model' do
+      before do
+        subject.get('/article/:id') do
+          Article.new(title: 'Lonestar', id: params[:id])
+        end
+      end
+
+      it 'returns a hypermedia representation' do
+        get '/article/666'
+        expect(last_response.body).to eq '{"title":"Lonestar","id":"666","links":[{"rel":"self","href":"/article/666"}]}'
       end
     end
 
-    it 'returns a hypermedia representation' do
-      get '/article/666'
-      expect(last_response.body).to eq '{"title":"Lonestar","id":"666","links":[{"rel":"self","href":"/article/666"}]}'
+    context 'without an instance singleton' do
+      context 'as nil' do
+        before do
+          subject.get('/article/:id') do
+            present(nil, with: ArticleRepresenter)
+          end
+        end
+
+        it 'raises TypeError' do
+          expect { get '/article/666' }.to raise_error(TypeError)
+        end
+      end
+
+      context 'as another immediate value' do
+        before do
+          subject.get('/article/:id') do
+            present(5, with: ArticleRepresenter)
+          end
+        end
+
+        it 'raises TypeError' do
+          expect { get '/article/666' }.to raise_error(TypeError)
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,16 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+require 'ostruct'
+require 'bigdecimal'
+require 'base64'
+require 'logger'
+
 require 'bundler'
 Bundler.setup :default, :test
+Bundler.require
 
 require 'grape'
 
@@ -16,6 +24,16 @@ require 'rspec'
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods
+  config.filter_run_excluding(
+    activerecord: true, mongoid: true
+  )
 end
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/all/**/*.rb"].each { |f| require f }
+
+# For Relational Extension Tests
+if defined?(Mongoid)
+  ENV['MONGOID_ENV'] ||= 'test'
+  Mongoid.load!('./spec/config/mongoid.yml')
+  Dir["#{File.dirname(__FILE__)}/support/mongoid/**/*.rb"].each { |f| require f }
+end

data/spec/support/{article.rb → all/article.rb}

@@ -1,4 +1,6 @@
-require 'support/article_representer'
+# frozen_string_literal: true
+
+require 'support/all/article_representer'
 
 class Article
   include Roar::JSON

data/spec/support/{article_representer.rb → all/article_representer.rb}

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module ArticleRepresenter
   include Roar::JSON
   include Roar::Hypermedia
+  include Grape::Roar::Representer
 
   property :title
   property :id

data/spec/support/all/grape_app_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+shared_context 'Grape API App' do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  before do
+    subject.format :json
+    subject.formatter :json, Grape::Formatter::Roar
+  end
+
+  def app
+    subject
+  end
+end

data/spec/support/{order.rb → all/order.rb}

@@ -1,4 +1,6 @@
-require 'support/order_representer'
+# frozen_string_literal: true
+
+require 'support/all/order_representer'
 
 class Order
   include Roar::JSON

data/spec/support/{order_representer.rb → all/order_representer.rb}

@@ -1,4 +1,6 @@
-require 'support/article'
+# frozen_string_literal: true
+
+require 'support/all/article'
 
 module OrderRepresenter
   include Roar::JSON

data/spec/support/{product.rb → all/product.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Product
   attr_accessor :title, :id
 

data/spec/support/{product_representer.rb → all/product_representer.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'roar/json/hal'
 
 module ProductRepresenter
@@ -10,6 +12,6 @@ module ProductRepresenter
 
   link :self do |opts|
     request = Grape::Request.new(opts[:env])
-    "#{request.url}"
+    request.url.to_s
   end
 end

data/spec/support/{user.rb → all/user.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class User
   attr_accessor :id, :name
 

data/spec/support/{user_representer.rb → all/user_representer.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UserRepresenter < Grape::Roar::Decorator
   include Roar::JSON
   include Roar::Hypermedia

data/spec/support/mongoid/relational_models/cart.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Cart
+  include ::Mongoid::Document
+
+  has_many :items
+end

data/spec/support/mongoid/relational_models/item.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Item
+  include ::Mongoid::Document
+
+  belongs_to :cart
+end

data/spec/support/mongoid/relational_models/mongoid_cart_representer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MongoidCartRepresenter
+  include Roar::JSON
+  include Roar::JSON::HAL
+  include Roar::Hypermedia
+
+  include Grape::Roar::Extensions::Relations
+
+  relation :has_many, :items
+
+  link_self
+end
+
+# Class style below, but want to test module
+
+# class MongoidCartRepresenter < Grape::Roar::Decorator
+#   include Roar::JSON
+#   include Roar::JSON::HAL
+#   include Roar::Hypermedia
+
+#   include Grape::Roar::Extensions::Relations
+
+#   relation :has_many, :items
+
+#   link_self
+# end

data/spec/support/mongoid/relational_models/mongoid_item_representer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class MongoidItemRepresenter < Grape::Roar::Decorator
+  include Roar::JSON
+  include Roar::JSON::HAL
+  include Roar::Hypermedia
+
+  include Grape::Roar::Extensions::Relations
+
+  relation :belongs_to, :cart, embedded: true
+
+  link_self
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-roar
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-18 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: roar
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +59,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/danger.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/test-activerecord.yml"
+- ".github/workflows/test-mongodb.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
+- Gemfile.danger
 - LICENSE
 - README.md
 - RELEASING.md
@@ -62,27 +84,57 @@ files:
 - lib/grape-roar.rb
 - lib/grape/roar.rb
 - lib/grape/roar/decorator.rb
+- lib/grape/roar/extensions.rb
+- lib/grape/roar/extensions/relations.rb
+- lib/grape/roar/extensions/relations/adapters.rb
+- lib/grape/roar/extensions/relations/adapters/active_record.rb
+- lib/grape/roar/extensions/relations/adapters/base.rb
+- lib/grape/roar/extensions/relations/adapters/mongoid.rb
+- lib/grape/roar/extensions/relations/dsl_methods.rb
+- lib/grape/roar/extensions/relations/exceptions.rb
+- lib/grape/roar/extensions/relations/mapper.rb
+- lib/grape/roar/extensions/relations/validations.rb
+- lib/grape/roar/extensions/relations/validations/active_record.rb
+- lib/grape/roar/extensions/relations/validations/misc.rb
+- lib/grape/roar/extensions/relations/validations/mongoid.rb
+- lib/grape/roar/extensions/relations/validations/mongoid/6.rb
+- lib/grape/roar/extensions/relations/validations/mongoid/7.rb
 - lib/grape/roar/formatter.rb
 - lib/grape/roar/representer.rb
 - lib/grape/roar/version.rb
+- spec/config/mongoid.yml
 - spec/decorator_spec.rb
+- spec/extensions/relations/adapters/active_record_spec.rb
+- spec/extensions/relations/adapters/adapters_module_spec.rb
+- spec/extensions/relations/adapters/mongoid_spec.rb
+- spec/extensions/relations/dsl_methods_spec.rb
+- spec/extensions/relations/mapper_spec.rb
+- spec/extensions/relations/validations/active_record_spec.rb
+- spec/extensions/relations/validations/mongoid_spec.rb
 - spec/nested_representer_spec.rb
 - spec/present_with_spec.rb
+- spec/relations_spec.rb
 - spec/representer_spec.rb
 - spec/spec_helper.rb
-- spec/support/article.rb
-- spec/support/article_representer.rb
-- spec/support/order.rb
-- spec/support/order_representer.rb
-- spec/support/product.rb
-- spec/support/product_representer.rb
-- spec/support/user.rb
-- spec/support/user_representer.rb
+- spec/support/all/article.rb
+- spec/support/all/article_representer.rb
+- spec/support/all/grape_app_context.rb
+- spec/support/all/order.rb
+- spec/support/all/order_representer.rb
+- spec/support/all/product.rb
+- spec/support/all/product_representer.rb
+- spec/support/all/user.rb
+- spec/support/all/user_representer.rb
+- spec/support/mongoid/relational_models/cart.rb
+- spec/support/mongoid/relational_models/item.rb
+- spec/support/mongoid/relational_models/mongoid_cart_representer.rb
+- spec/support/mongoid/relational_models/mongoid_item_representer.rb
 homepage: http://github.com/ruby-grape/grape-roar
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,9 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Enable Resource-Oriented Architectures in Grape API DSL
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
-sudo: false
-
-language: ruby
-
-cache: bundler
-
-rvm:
-  - ruby-head
-  - 2.2.2
-  - 2.3.1