wor-simple_crud 0.2.1

data/spec/dummy/db/migrate/20200110191019_devise_create_users.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class DeviseCreateUsers < ActiveRecord::Migration[6.0]
+  def change
+    create_table :users do |t|
+      ## Database authenticatable
+      t.string :email,              null: false, default: ''
+      t.string :encrypted_password, null: false, default: ''
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Trackable
+      # t.integer  :sign_in_count, default: 0, null: false
+      # t.datetime :current_sign_in_at
+      # t.datetime :last_sign_in_at
+      # t.string   :current_sign_in_ip
+      # t.string   :last_sign_in_ip
+
+      ## Confirmable
+      # t.string   :confirmation_token
+      # t.datetime :confirmed_at
+      # t.datetime :confirmation_sent_at
+      # t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+      # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
+      # t.string   :unlock_token # Only if unlock strategy is :email or :both
+      # t.datetime :locked_at
+
+      t.timestamps null: false
+    end
+
+    add_index :users, :email,                unique: true
+    add_index :users, :reset_password_token, unique: true
+    # add_index :users, :confirmation_token,   unique: true
+    # add_index :users, :unlock_token,         unique: true
+  end
+end

data/spec/dummy/db/migrate/20200120165657_add_user_id_to_dummy_models.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddUserIdToDummyModels < ActiveRecord::Migration[6.0]
+  def change
+    add_reference :dummy_models, :user, foreign_key: true
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `rails
+# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20_200_120_165_657) do
+  create_table 'dummy_models', force: :cascade do |t|
+    t.string 'name'
+    t.integer 'something'
+    t.integer 'user_id'
+    t.index ['user_id'], name: 'index_dummy_models_on_user_id'
+  end
+
+  create_table 'users', force: :cascade do |t|
+    t.string 'email', default: '', null: false
+    t.string 'encrypted_password', default: '', null: false
+    t.string 'reset_password_token'
+    t.datetime 'reset_password_sent_at'
+    t.datetime 'remember_created_at'
+    t.datetime 'created_at', precision: 6, null: false
+    t.datetime 'updated_at', precision: 6, null: false
+    t.index ['email'], name: 'index_users_on_email', unique: true
+    t.index ['reset_password_token'], name: 'index_users_on_reset_password_token', unique: true
+  end
+
+  add_foreign_key 'dummy_models', 'users'
+end

data/spec/dummy/spec/factories/dummy_models.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :dummy_model do
+    name { rand(36 * 4).to_s(36) }
+    something { rand(100) }
+    user
+  end
+end

data/spec/dummy/spec/factories/users.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    email { Faker::Internet.email }
+    password { Faker::Internet.password }
+  end
+end

data/spec/dummy_controller_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+describe DummyModelsController, type: :controller do
+  include_examples 'simple crud for update'
+  include_examples 'simple crud for show'
+  include_examples 'simple crud for create'
+  include_examples 'simple crud for index'
+  include_examples 'simple crud for destroy'
+
+  describe 'POST #create with invalid attributes' do
+    include_context 'with authenticated user'
+
+    it 'responds with unprocessable entity' do
+      post :create, params: { something: 1, user_id: current_user.id }
+      expect(response).to have_http_status(ApplicationController::UNPROCESSABLE_STATUS)
+    end
+  end
+end

data/spec/dummy_model_policy_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DummyModelPolicy do
+  let(:user) { create(:user) }
+  let(:other_user) { create(:user) }
+  let(:dummy_model) { create(:dummy_model, user: user) }
+
+  describe '#destroy?' do
+    it 'allows the owning user' do
+      expect(described_class.new(user, dummy_model).destroy?).to be true
+    end
+
+    it 'denies a different user' do
+      expect(described_class.new(other_user, dummy_model).destroy?).to be false
+    end
+  end
+
+  describe '#index?' do
+    it 'allows the owning user' do
+      expect(described_class.new(user, dummy_model).index?).to be true
+    end
+
+    it 'denies a different user' do
+      expect(described_class.new(other_user, dummy_model).index?).to be false
+    end
+  end
+end

data/spec/dummy_model_serializer_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DummyModelSerializer do
+  let(:user) { create(:user) }
+  let(:dummy_model) { create(:dummy_model, user: user) }
+  let(:full_response) { { 'id' => dummy_model.id, 'something' => dummy_model.something, 'user_id' => user.id } }
+
+  it 'matches a response including all serializer attributes' do
+    expect(full_response).to have_been_serialized_with(described_class)
+  end
+
+  it 'does not match a response missing serializer attributes' do
+    expect({ 'id' => dummy_model.id }).not_to have_been_serialized_with(described_class)
+  end
+
+  it 'describes itself' do
+    expect(have_been_serialized_with(described_class).description)
+      .to eq("checks to see if all the serializer's attributes are in the JSON response")
+  end
+
+  it 'produces a failure message when it does not match' do
+    matcher = have_been_serialized_with(described_class)
+    matcher.matches?({ 'id' => dummy_model.id })
+
+    expect(matcher.failure_message).to match(/expected attributes of/)
+  end
+
+  it 'produces a negated failure message when it matches but was expected not to' do
+    matcher = have_been_serialized_with(described_class)
+    matcher.matches?(full_response)
+
+    expect(matcher.failure_message_when_negated).to match(/not to be included in/)
+  end
+end

data/spec/simple_crud/authorization/action_policy_adapter_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_crud/authorization/action_policy_adapter'
+
+class ActionPolicyTestRecord
+  attr_reader :owner_id
+
+  def initialize(owner_id)
+    @owner_id = owner_id
+  end
+end
+
+class ActionPolicyTestRecordPolicy < ActionPolicy::Base
+  def show?
+    user == record.owner_id
+  end
+end
+
+class ActionPolicyTestController
+  include ActionPolicy::Controller
+  authorize :user, through: :current_user
+
+  attr_accessor :action_name, :current_user
+end
+
+describe SimpleCrud::Authorization::ActionPolicyAdapter do
+  subject(:adapter) { described_class.new }
+
+  let(:controller) do
+    ActionPolicyTestController.new.tap do |c|
+      c.action_name = 'show'
+      c.current_user = 1
+    end
+  end
+
+  describe '#authorize' do
+    it 'passes for a record the policy allows' do
+      expect { adapter.authorize(controller, ActionPolicyTestRecord.new(1)) }.not_to raise_error
+    end
+
+    it 'raises for a record the policy denies' do
+      expect do
+        adapter.authorize(controller, ActionPolicyTestRecord.new(2))
+      end.to raise_error(ActionPolicy::Unauthorized)
+    end
+  end
+
+  describe '#policy_defined?' do
+    it 'is true when a matching policy class exists' do
+      expect(adapter.policy_defined?(ActionPolicyTestRecord)).to be true
+    end
+
+    it 'is false when no matching policy class exists' do
+      expect(adapter.policy_defined?(String)).to be false
+    end
+  end
+end

data/spec/simple_crud/authorization/can_can_can_adapter_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_crud/authorization/can_can_can_adapter'
+
+class CanCanCanTestRecord
+  attr_reader :owner_id
+
+  def initialize(owner_id)
+    @owner_id = owner_id
+  end
+end
+
+class Ability
+  include CanCan::Ability
+
+  def initialize(user_id)
+    can :manage, CanCanCanTestRecord, owner_id: user_id
+  end
+end
+
+class CanCanCanTestController
+  include CanCan::ControllerAdditions
+
+  attr_accessor :action_name, :current_user
+end
+
+describe SimpleCrud::Authorization::CanCanCanAdapter do
+  subject(:adapter) { described_class.new }
+
+  let(:controller) do
+    CanCanCanTestController.new.tap do |c|
+      c.action_name = 'show'
+      c.current_user = 1
+    end
+  end
+
+  describe '#authorize' do
+    it 'passes for a record the ability grants' do
+      expect { adapter.authorize(controller, CanCanCanTestRecord.new(1)) }.not_to raise_error
+    end
+
+    it 'raises for a record the ability denies' do
+      expect { adapter.authorize(controller, CanCanCanTestRecord.new(2)) }.to raise_error(CanCan::AccessDenied)
+    end
+  end
+
+  describe '#policy_defined?' do
+    it 'is true when an Ability class exists' do
+      expect(adapter.policy_defined?(CanCanCanTestRecord)).to be true
+    end
+  end
+end

data/spec/simple_crud/pagination/adapters_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_crud/pagination/kaminari_adapter'
+require 'simple_crud/pagination/will_paginate_adapter'
+require 'simple_crud/pagination/pagy_adapter'
+
+describe 'pagination adapters', type: :request do
+  let(:user) { create(:user) }
+  let(:auth_headers) { Devise::JWT::TestHelpers.auth_headers({}, user) }
+
+  before do
+    create_list(:dummy_model, 15, user: user)
+    # Index authorizes against a blank klass.new (no owner), so the real
+    # ownership-based policy can never pass here.
+    allow(DummyModelPolicy).to receive(:new).and_return(instance_double(DummyModelPolicy, index?: true))
+  end
+
+  around do |example|
+    original_adapter = SimpleCrud::Config.pagination_adapter
+    example.run
+    SimpleCrud::Config.pagination_adapter = original_adapter
+  end
+
+  it 'paginates with Kaminari' do
+    SimpleCrud::Config.pagination_adapter = SimpleCrud::Pagination::KaminariAdapter.new
+
+    get '/dummy_models', params: { page: 2, per_page: 5 }, headers: auth_headers
+
+    expect(response.parsed_body.size).to eq(5)
+  end
+
+  it 'paginates with will_paginate' do
+    SimpleCrud::Config.pagination_adapter = SimpleCrud::Pagination::WillPaginateAdapter.new
+
+    get '/dummy_models', params: { page: 2, per_page: 5 }, headers: auth_headers
+
+    expect(response.parsed_body.size).to eq(5)
+  end
+
+  it 'paginates with Pagy' do
+    SimpleCrud::Config.pagination_adapter = SimpleCrud::Pagination::PagyAdapter.new
+
+    get '/dummy_models', params: { page: 2, limit: 5 }, headers: auth_headers
+
+    expect(response.parsed_body.size).to eq(5)
+  end
+end

data/spec/simple_crud_configuration_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'simple_crud/authorization/pundit_adapter'
+require 'simple_crud/pagination/wor_paginate_adapter'
+
+class IncompleteAuthorizationAdapter
+  include SimpleCrud::Authorization::Adapter
+end
+
+class IncompletePaginationAdapter
+  include SimpleCrud::Pagination::Adapter
+end
+
+describe SimpleCrud do
+  describe '.configure' do
+    it 'yields SimpleCrud::Config' do
+      expect { |b| described_class.configure(&b) }.to yield_with_args(SimpleCrud::Config)
+    end
+
+    it 'lets a custom authorization adapter replace the Pundit default' do
+      original_adapter = SimpleCrud::Config.authorization_adapter
+      custom_adapter = instance_double(SimpleCrud::Authorization::PunditAdapter)
+
+      described_class.configure { |config| config.authorization_adapter = custom_adapter }
+      expect(SimpleCrud::Config.authorization_adapter).to eq(custom_adapter)
+
+      SimpleCrud::Config.authorization_adapter = original_adapter
+    end
+
+    it 'lets a custom pagination adapter replace the wor-paginate default' do
+      original_adapter = SimpleCrud::Config.pagination_adapter
+      custom_adapter = instance_double(SimpleCrud::Pagination::WorPaginateAdapter)
+
+      described_class.configure { |config| config.pagination_adapter = custom_adapter }
+      expect(SimpleCrud::Config.pagination_adapter).to eq(custom_adapter)
+
+      SimpleCrud::Config.pagination_adapter = original_adapter
+    end
+  end
+
+  describe SimpleCrud::Authorization::Adapter do
+    subject(:adapter) { IncompleteAuthorizationAdapter.new }
+
+    it 'requires #authorize to be implemented' do
+      expect { adapter.authorize(nil, nil) }.to raise_error(NotImplementedError)
+    end
+
+    it 'requires #policy_defined? to be implemented' do
+      expect { adapter.policy_defined?(nil) }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe SimpleCrud::Pagination::Adapter do
+    subject(:adapter) { IncompletePaginationAdapter.new }
+
+    it 'requires #paginate to be implemented' do
+      expect { adapter.paginate(nil, nil, nil) }.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/simple_crud_controller_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class UnpoliceableThing; end
+
+class UnpoliceableThingsController
+  extend SimpleCrudController
+end
+
+describe SimpleCrudController do
+  describe '.check_policies' do
+    it 'returns when a matching policy exists' do
+      expect { DummyModelsController.check_policies(authorize: true) }.not_to raise_error
+    end
+
+    it 'throws when no matching policy exists' do
+      expect do
+        UnpoliceableThingsController.check_policies(authorize: true)
+      end.to raise_error(UncaughtThrowError)
+    end
+  end
+
+  describe '.check_serializer' do
+    it 'returns when the serializer option is blank' do
+      expect { DummyModelsController.check_serializer({}) }.not_to raise_error
+    end
+
+    it 'returns when a matching serializer exists' do
+      expect do
+        DummyModelsController.check_serializer(serializer: 'DummyModelSerializer')
+      end.not_to raise_error
+    end
+
+    it 'throws when no matching serializer exists' do
+      expect do
+        DummyModelsController.check_serializer(serializer: 'NonExistentSerializer')
+      end.to raise_error(UncaughtThrowError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'simplecov'
+SimpleCov.start do
+  minimum_coverage 100
+end
+
+require File.expand_path('../spec/dummy/config/environment.rb', __dir__)
+require 'simple_crud'
+require 'rspec/rails'
+require 'pundit/rspec'
+require 'wor/paginate/rspec'
+require 'simple_crud/rspec'
+require 'devise'
+require 'devise/jwt/test_helpers'
+
+Dir[Rails.root.join('spec/support/**/*.rb')].sort.each { |f| require f }
+
+ActiveRecord::Migrator.migrations_paths = [File.expand_path('../spec/dummy/db/migrate', __dir__)]
+
+RSpec.configure do |config|
+  config.include ActionDispatch::TestProcess
+  config.file_fixture_path = Rails.root.join('spec', 'support', 'fixtures')
+
+  config.infer_spec_type_from_file_location!
+  config.include Devise::Test::ControllerHelpers, type: :controller
+  config.include Devise::Test::IntegrationHelpers, type: :request
+  config.include FactoryBot::Syntax::Methods
+  config.include Response::JSONParser, type: :controller
+  config.order = 'random'
+
+  # DatabaseCleaner already wraps each example in a transaction below.
+  # rspec-rails's own wrapping double-nests it and was observed to leak
+  # committed rows. Disable it here.
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+
+    # Warms the schema cache before any DatabaseCleaner transaction opens.
+    # Otherwise the first example touching a table triggers a PRAGMA
+    # table_info query mid-transaction, which silently ends it and commits
+    # that example's rows for real instead of rolling back.
+    conn = ActiveRecord::Base.connection
+    conn.data_sources.each { |t| conn.schema_cache.add(t) }
+  end
+
+  config.around do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end
+
+ActiveRecord::Migration.maintain_test_schema!
+
+require 'byebug'

data/spec/spy.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+#
+# Class used in tests to keep track of amount of calls for a method in a klass.
+#
+# Example in a controller spec:
+#
+# before do
+#   Spy.spy(controller, 'authenticate_entity')
+#   perform_some_request
+# end
+#
+# it 'calls authenticate_entity defined by the user' do
+#   count = controller.spied_authenticate_entity_counter
+#   expect(count).to be(1)
+# end
+#
+class Spy
+  # Defines a counter for the given method and overrides it to update
+  # the counter in every call before being executed.
+  def self.spy(klass, method)
+    define_counter(klass, method)
+    klass.singleton_class.class_eval do
+      define_method(method) do |*args, &block|
+        instance_variable_set("@spied_#{method}_counter", instance_variable_get("@spied_#{method}_counter") + 1)
+        super(*args, &block)
+      end
+    end
+  end
+
+  # Defines a counter (and its getter) for the given method as an instance variable of the given klass.
+  def self.define_counter(klass, method)
+    klass.instance_variable_set("@spied_#{method}_counter".to_sym, 0)
+
+    klass.singleton_class.class_eval do
+      define_method("spied_#{method}_counter".to_sym) do
+        instance_variable_get("@spied_#{method}_counter")
+      end
+    end
+  end
+end

data/spec/without_pagination/dummy_models_controller_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+describe WithoutPagination::DummyModelsController, type: :controller do
+  include_examples 'simple crud for index'
+end

data/wor-simple_crud.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_crud/version"
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = "wor-simple_crud"
+  s.version     = SimpleCrud::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.date        = Date.today
+  s.authors     = ["icoluccio"]
+  s.email       = ["ignacio.coluccio@gmail.com"]
+  s.homepage    = "https://github.com/icoluccio/simple-crud"
+  s.summary     = "Simplified CRUD endpoints for Rails API controllers"
+  s.description = "Simple CRUD is a gem for Rails that simplifies CRUD controllers, with default implementations and specs for common tasks"
+  s.license     = "MIT"
+  s.required_ruby_version = '>= 3.2'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rails', '>= 6.1', '< 9'
+end