sinja 0.2.0.beta2 → 1.0.0.pre1

data/Rakefile

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new do |t|
+  t.test_files = FileList[File.expand_path('test/**/*_test.rb', __dir__)]
+  t.warning = false
+end
 
-task :default=>:spec
+task default: :test

data/demo-app/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec :path=>'..'

data/demo-app/app.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'sinatra'
+require 'sinatra/jsonapi'
+
+require_relative 'classes/author'
+require_relative 'classes/comment'
+require_relative 'classes/post'
+require_relative 'classes/tag'
+
+require 'sinja/helpers/sequel'
+
+configure_jsonapi do |c|
+  Sinja::Helpers::Sequel.config(c)
+end
+
+helpers Sinja::Helpers::Sequel do
+  def current_user
+    # TESTING/DEMO PURPOSES ONLY -- DO NOT DO THIS IN PRODUCTION
+    Author.first_by_email(env['HTTP_X_EMAIL']) if env.key?('HTTP_X_EMAIL')
+  end
+
+  def role
+    [].tap do |a|
+      a << :logged_in if current_user
+      a << :superuser if current_user&.admin?
+    end
+  end
+
+  def database
+    DB
+  end
+end
+
+resource :authors, AuthorController
+resource :comments, CommentController
+resource :posts, PostController
+resource :tags, TagController
+
+freeze_jsonapi

data/demo-app/base.rb

@@ -0,0 +1,9 @@
+# require_string_literal: true
+require_relative 'boot'
+
+class BaseSerializer
+  include JSONAPI::Serializer
+end
+
+Sequel::Model.plugin :tactical_eager_loading
+Sequel::Model.plugin :validation_helpers

data/demo-app/boot.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'bundler/setup'
+
+Bundler.require(:default, :development)

data/demo-app/classes/author.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+require_relative '../base'
+require_relative '../database'
+
+DB.create_table?(:authors) do
+  primary_key :id
+  String :email, :null=>false, :unique=>true
+  String :real_name
+  String :display_name
+  TrueClass :admin, :default=>false
+  DateTime :created_at
+  DateTime :updated_at
+end
+
+class Author < Sequel::Model
+  plugin :timestamps
+  plugin :boolean_readers
+
+  finder def self.by_email(arg)
+    where(:email=>arg)
+  end
+
+  one_to_many :comments
+  one_to_many :posts
+end
+
+Author.create(email: 'all@yourbase.com', admin: true)
+
+class AuthorSerializer < BaseSerializer
+  attribute(:display_name) { object.display_name || 'Anonymous Coward' }
+
+  has_many :comments
+  has_many :posts
+end
+
+AuthorController = proc do
+  helpers do
+    def find(id)
+      Author[id.to_i]
+    end
+
+    def role
+      if resource == current_user
+        super.push(:self)
+      else
+        super
+      end
+    end
+
+    def fields
+      %i[email real_name display_name].tap do |a|
+        a << :admin if role?(:superuser)
+      end
+    end
+  end
+
+  show
+
+  index do
+    Author.all
+  end
+
+  create do |attr|
+    author = Author.new
+    author.set_fields(attr, fields)
+    next_pk author.save(validate: false)
+  end
+
+  update(roles: %i[self superuser]) do |attr|
+    resource.update_fields(attr, fields, validate: false, missing: :skip)
+  end
+
+  destroy(roles: %i[self superuser]) do
+    resource.destroy
+  end
+
+  has_many :comments do
+    fetch(roles: :logged_in) do
+      resource.comments
+    end
+  end
+
+  has_many :posts do
+    fetch do
+      resource.posts
+    end
+  end
+end

data/demo-app/classes/comment.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+require_relative '../base'
+require_relative '../database'
+
+DB.create_table?(:comments) do
+  primary_key :id
+  foreign_key :author_id, :authors, :on_delete=>:cascade
+  foreign_key :post_slug, :posts, :on_delete=>:cascade, :type=>String
+  String :body, :text=>true, :null=>false
+  DateTime :created_at
+  DateTime :updated_at
+end
+
+class Comment < Sequel::Model
+  plugin :timestamps
+
+  many_to_one :author
+  many_to_one :post
+
+  def validate
+    super
+    validates_not_null [:author, :post]
+  end
+end
+
+class CommentSerializer < BaseSerializer
+  attribute :body
+
+  has_one :author
+  has_one :post
+end
+
+CommentController = proc do
+  helpers do
+    def find(id)
+      Comment[id.to_i]
+    end
+
+    def role
+      if resource&.author == current_user
+        super.push(:owner)
+      else
+        super
+      end
+    end
+  end
+
+  show do |id|
+    next find(id), include: 'author'
+  end
+
+  create(roles: :logged_in) do |attr|
+    comment = Comment.new
+    comment.set_fields(attr, %i[body])
+    comment.save(validate: false)
+    next_pk comment
+  end
+
+  update(roles: %i[owner superuser]) do |attr|
+    resource.update_fields(attr, %i[body], validate: false, missing: :skip)
+  end
+
+  destroy(roles: %i[owner superuser]) do
+    resource.destroy
+  end
+
+  has_one :post do
+    pluck do
+      resource.post
+    end
+
+    graft(roles: :superuser, sideload_on: :create) do |rio|
+      resource.post = Post.with_pk!(rio[:id].to_i)
+      resource.save_changes(validate: !sideloaded?)
+    end
+  end
+
+  has_one :author do
+    pluck do
+      resource.author
+    end
+
+    graft(roles: :superuser, sideload_on: :create) do |rio|
+      halt 403, 'You may only assign yourself as comment author!' \
+        unless role?(:superuser) || rio[:id].to_i == current_user.id
+
+      resource.author = Author.with_pk!(rio[:id].to_i)
+      resource.save_changes(validate: !sideloaded?)
+    end
+  end
+end

data/demo-app/classes/post.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+require_relative '../base'
+require_relative '../database'
+
+DB.create_table?(:posts) do
+  String :slug, :primary_key=>true
+  foreign_key :author_id, :authors, :on_delete=>:cascade
+  String :title, :null=>false
+  String :body, :text=>true, :null=>false
+  DateTime :created_at
+  DateTime :updated_at
+end
+
+class Post < Sequel::Model
+  plugin :timestamps
+
+  unrestrict_primary_key
+
+  many_to_one :author
+  one_to_many :comments
+  many_to_many :tags, :left_key=>:post_slug
+
+  def validate
+    super
+    validates_not_null :author
+  end
+end
+
+class PostSerializer < BaseSerializer
+  def id
+    object.slug
+  end
+
+  attributes :title, :body
+
+  has_one :author
+  has_many :comments
+  has_many :tags
+end
+
+PostController = proc do
+  helpers do
+    def find(slug)
+      Post[slug.to_s]
+    end
+
+    def role
+      if resource&.author == current_user
+        super.push(:owner)
+      else
+        super
+      end
+    end
+  end
+
+  show do |slug|
+    next find(slug), include: %w[author comments tags]
+  end
+
+  index do
+    # TODO: Filter/sort by created_at and/or updated_at?
+    Post.all
+  end
+
+  create(roles: :logged_in) do |attr, slug|
+    post = Post.new
+    post.set_fields(attr, %i[title body])
+    post.slug = slug.to_s # set primary key
+    post.save(validate: false)
+    next_pk post
+  end
+
+  update(roles: %i[owner superuser]) do |attr|
+    resource.update_fields(attr, %i[title body], validate: false, missing: :skip)
+  end
+
+  destroy(roles: %i[owner superuser]) do
+    resource.destroy
+  end
+
+  has_one :author do
+    pluck do
+      resource.author
+    end
+
+    graft(roles: :superuser, sideload_on: :create) do |rio|
+      halt 403, 'You may only assign yourself as post author!' \
+        unless role?(:superuser) || rio[:id].to_i == current_user.id
+
+      resource.author = Author.with_pk!(rio[:id].to_i)
+      resource.save_changes(validate: !sideloaded?)
+    end
+  end
+
+  has_many :comments do
+    fetch do
+      next resource.comments, include: 'author'
+    end
+  end
+
+  has_many :tags do
+    fetch do
+      resource.tags
+    end
+
+    merge(roles: %i[owner superuser], sideload_on: %i[create update]) do |rios|
+      add_missing(:tags, rios)
+    end
+
+    subtract(roles: %i[owner superuser]) do |rios|
+      remove_present(:tags, rios)
+    end
+
+    clear(roles: %i[owner superuser], sideload_on: :update) do
+      resource.remove_all_tags
+    end
+  end
+end

data/demo-app/classes/tag.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require_relative '../base'
+require_relative '../database'
+
+require_relative 'post' # make sure we create the posts table before the join table
+
+DB.create_table?(:tags) do
+  primary_key :id
+  String :name, :null=>false, :unique=>true
+end
+
+DB.create_table?(:posts_tags) do
+  foreign_key :post_slug, :posts, :null=>false, :on_delete=>:cascade, :type=>String
+  foreign_key :tag_id, :tags, :null=>false, :on_delete=>:cascade
+  primary_key [:post_slug, :tag_id]
+  index [:tag_id, :post_slug]
+end
+
+class Tag < Sequel::Model
+  many_to_many :posts
+end
+
+class TagSerializer < BaseSerializer
+  attribute :name
+
+  has_many :posts
+end
+
+TagController = proc do
+  helpers do
+    def find(id)
+      Tag[id.to_i]
+    end
+  end
+
+  show
+
+  index do
+    Tag.all
+  end
+
+  create(roles: :logged_in) do |attr|
+    tag = Tag.new
+    tag.set_fields(attr, %i[name])
+    tag.save(validate: false)
+    next_pk tag
+  end
+
+  destroy(roles: :superuser) do
+    resource.destroy
+  end
+
+  has_many :posts do
+    fetch do
+      resource.posts
+    end
+
+    merge(roles: :logged_in) do |rios|
+      add_missing(:posts, rios) do |post|
+        role?(:superuser) || post.author == current_user
+      end
+    end
+
+    subtract(roles: :logged_in) do |rios|
+      remove_present(:posts, rios) do |post|
+        role?(:superuser) || post.author == current_user
+      end
+    end
+  end
+end

data/demo-app/database.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'logger'
+require_relative 'boot'
+
+DB =
+  if defined?(JRUBY_VERSION)
+    Sequel.connect 'jdbc:sqlite::memory:'
+  else
+    Sequel.sqlite
+  end
+
+DB.loggers << Logger.new($stderr) if Sinatra::Base.development?