linked_rails 0.0.1

data/app/serializers/linked_rails/menus/list_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  module Menus
+    class ListSerializer < LinkedRails.serializer_parent_class
+      include LinkedRails::Serializer
+
+      has_many :menus, predicate: Vocab.ontola[:menus], polymorphic: true do |object|
+        object.menus&.compact
+      end
+    end
+  end
+end

data/app/serializers/linked_rails/ontology/class_serializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class Ontology
+    class ClassSerializer < LinkedRails.serializer_parent_class
+      attribute :description, predicate: Vocab.schema.description
+      attribute :input_select_property, predicate: Vocab.ontola['forms/inputs/select/displayProp']
+      attribute :label, predicate: Vocab.rdfs.label
+      attribute :plural_label, predicate: Vocab.ontola[:pluralLabel]
+      attribute :image, predicate: Vocab.schema.image
+      attribute :parent_class, predicate: Vocab.rdfs.subClassOf
+      statements :data
+
+      def self.data(object, _params)
+        object.data
+      end
+    end
+  end
+end

data/app/serializers/linked_rails/ontology/property_serializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class Ontology
+    class PropertySerializer < LinkedRails.serializer_parent_class
+      attribute :description, predicate: Vocab.schema.description
+      attribute :label, predicate: Vocab.rdfs.label
+      attribute :image, predicate: Vocab.schema.image
+      statements :data
+
+      def self.data(object, _params)
+        object.data
+      end
+    end
+  end
+end

data/app/serializers/linked_rails/ontology_serializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class OntologySerializer < LinkedRails.serializer_parent_class
+    has_many :classes
+    has_many :properties
+  end
+end

data/app/serializers/linked_rails/rdf_error_serializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class RDFErrorSerializer < LinkedRails.serializer_parent_class
+    attribute :title, predicate: Vocab.schema.name
+    attribute :message, predicate: Vocab.schema.text
+  end
+end

data/app/serializers/linked_rails/sequence_serializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class SequenceSerializer < LinkedRails.serializer_parent_class
+    include LinkedRails::Serializer
+
+    statements :sequence
+    has_many :members, polymorphic: true
+
+    def self.sequence(object, _params)
+      object.sequence
+    end
+  end
+end

data/app/serializers/linked_rails/shacl/node_shape_serializer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  module SHACL
+    class NodeShapeSerializer < ShapeSerializer
+      attribute :closed, predicate: Vocab.sh.closed
+      attribute :ignored_properties, predicate: Vocab.sh.ignoredProperties
+      attribute :sparql, predicate: Vocab.sh.sparql
+      has_many :property, predicate: Vocab.sh.property, polymorphic: true
+    end
+  end
+end

data/app/serializers/linked_rails/shacl/property_shape_serializer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  module SHACL
+    class PropertyShapeSerializer < ShapeSerializer
+      attribute :datatype, predicate: Vocab.sh.datatype
+      attribute :default_value, predicate: Vocab.sh.defaultValue
+      attribute :description, predicate: Vocab.sh.description
+      attribute :disjoint, predicate: Vocab.sh.disjoint
+      attribute :has_value, predicate: Vocab.sh.hasValue
+      attribute :equals, predicate: Vocab.sh.equals
+      attribute :flags, predicate: Vocab.sh.flags
+      attribute :group, predicate: Vocab.sh.group
+      attribute :language, predicate: Vocab.sh.languageIn
+      attribute :less_than, predicate: Vocab.sh.lessThan
+      attribute :less_than_or_equals, predicate: Vocab.sh.lessThanOrEquals
+      attribute :max_count, predicate: Vocab.sh.maxCount
+      attribute :max_exclusive, predicate: Vocab.sh.maxExclusive
+      attribute :max_inclusive, predicate: Vocab.sh.maxInclusive
+      attribute :max_length, predicate: Vocab.sh.maxLength
+      attribute :min_count, predicate: Vocab.sh.minCount
+      attribute :min_exclusive, predicate: Vocab.sh.minExclusive
+      attribute :min_inclusive, predicate: Vocab.sh.minInclusive
+      attribute :min_length, predicate: Vocab.sh.minLength
+      attribute :name, predicate: Vocab.sh.name
+      attribute :node, predicate: Vocab.sh.node
+      attribute :pattern, predicate: Vocab.sh.pattern
+      attribute :sh_class, predicate: Vocab.sh.class
+      attribute :sh_in, predicate: Vocab.sh.in
+      attribute :unique_language, predicate: Vocab.sh.uniqueLang
+      attribute :qualified_max_count, predicate: Vocab.sh.qualifiedMaxCount
+      attribute :qualified_min_count, predicate: Vocab.sh.qualifiedMinCount
+      attribute :qualified_value_shape, predicate: Vocab.sh.qualifiedValueShape
+
+      has_many :path, predicate: Vocab.sh.path, sequence: true, polymorphic: true
+    end
+  end
+end

data/app/serializers/linked_rails/shacl/shape_serializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  module SHACL
+    class ShapeSerializer < LinkedRails.serializer_parent_class
+      include LinkedRails::Serializer
+
+      attribute :deactivated, predicate: Vocab.sh.deactivated
+      attribute :message, predicate: Vocab.sh.message
+      attribute :node_kind, predicate: Vocab.sh.nodeKind
+      attribute :severity, predicate: Vocab.sh.severity
+      attribute :target_class, predicate: Vocab.sh.targetClass
+      attribute :target_node, predicate: Vocab.sh.targetNode
+      attribute :target_objects_of, predicate: Vocab.sh.targetObjectsOf
+      attribute :target_subjects_of, predicate: Vocab.sh.targetSubjectsOf
+      has_one :sh_not, predicate: Vocab.sh.not, polymorphic: true
+      has_many :and, predicate: Vocab.sh.and, polymorphic: true
+      has_many :or, predicate: Vocab.sh.or, polymorphic: true
+      has_many :xone, predicate: Vocab.sh.xone, polymorphic: true
+      has_many :nested_shapes, polymorphic: true do |object|
+        [object.and, object.or, object.sh_not, object.xone].flatten.compact
+      end
+    end
+  end
+end

data/app/serializers/linked_rails/web_page_serializer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class WebPageSerializer < CreativeWorkSerializer
+    has_one :cover_photo, predicate: Vocab.ontola[:coverPhoto], polymorphic: true
+    has_one :widget_sequence, predicate: Vocab.ontola[:widgets], polymorphic: true
+    has_many :includes, polymorphic: true
+    attribute :hide_header, predicate: Vocab.ontola[:hideHeader]
+  end
+end

data/app/serializers/linked_rails/web_site_serializer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class WebSiteSerializer < CreativeWorkSerializer
+    has_one :homepage, predicate: Vocab.foaf.homepage, polymorphic: true
+    attribute :image, predicate: Vocab.schema.image do |object|
+      serialize_image(object.image)
+    end
+    attribute :navigations_menu, predicate: Vocab.ontola[:navigationsMenu]
+  end
+end

data/app/serializers/linked_rails/widget_serializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class WidgetSerializer < LinkedRails.serializer_parent_class
+    include LinkedRails::Serializer
+
+    attribute :size, predicate: Vocab.ontola[:widgetSize]
+    attribute :topology, predicate: Vocab.ontola[:topology]
+    has_one :resource_sequence, predicate: Vocab.ontola[:widgetResource], polymorphic: true
+    has_one :parent, predicate: Vocab.schema.isPartOf, polymorphic: true
+    has_many :property_shapes, polymorphic: true do |object|
+      object.property_shapes.values
+    end
+  end
+end

data/config/initializers/inflections.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.acronym 'LD'
+end

data/lib/generators/linked_rails/install/install_generator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module LinkedRails
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+    source_root File.expand_path('templates', __dir__)
+    desc 'Installs LinkedRails.'
+
+    def install # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      template 'vocab.rb', 'lib/vocab.rb'
+      template 'initializer.rb', 'config/initializers/linked_rails.rb'
+      template 'application_action_list.rb', 'app/actions/application_action_list.rb'
+      template 'application_form.rb', 'app/forms/application_form.rb'
+      template 'application_menu_list.rb', 'app/menus/application_menu_list.rb'
+      template 'application_policy.rb', 'app/policies/application_policy.rb'
+      template 'application_serializer.rb', 'app/serializers/application_serializer.rb'
+      template 'app_menu_list.rb', 'app/menus/app_menu_list.rb'
+      template 'rdf_responder.rb', 'app/responders/rdf_responder.rb'
+      template 'rdf_serializers_initializer.rb', 'config/initializers/rdf_serializers.rb'
+      template 'locales.yml', 'config/locales/linked_rails.en.yml'
+      template 'vocab.yml', 'config/locales/vocab.en.yml'
+      route 'use_linked_rails'
+      application 'config.middleware.use LinkedRails::Middleware::LinkedDataParams'
+      application 'config.jwt_encryption_method = :hs512'
+      inject_includes
+    end
+
+    private
+
+    def inject_includes
+      inject_controller_include
+      inject_model_include
+    end
+
+    def inject_controller_include# rubocop:disable Metrics/MethodLength
+      sentinel = /class ApplicationController < ActionController::API\n/m
+      in_root do
+        inject_into_file(
+          'app/controllers/application_controller.rb',
+          optimize_indentation(
+            "include ActionController::MimeResponds\n"\
+            "include ActiveResponse::Controller\n"\
+            'include LinkedRails::Controller',
+            2
+          ),
+          after: sentinel
+        )
+      end
+    end
+
+    def inject_model_include
+      sentinel = /class ApplicationRecord < ActiveRecord::Base\n/m
+      in_root do
+        inject_into_file(
+          'app/models/application_record.rb',
+          optimize_indentation("include LinkedRails::Model\n", 2),
+          after: sentinel
+        )
+      end
+    end
+  end
+end

data/lib/generators/linked_rails/install/templates/app_menu_list.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class AppMenuList < ApplicationMenuList
+  has_menu :navigations,
+           iri_base: '/menus',
+           menus: -> { navigation_links }
+  has_menu :user,
+           menus: -> { user_menu_items }
+
+  def iri_template
+    @iri_template ||= URITemplate.new('/menus{#fragment}')
+  end
+
+  private
+
+  def navigation_links
+    items = []
+    items << menu_item(
+      :home,
+      label: I18n.t('menus.home'),
+      href: LinkedRails.iri,
+      image: 'fa-home'
+    )
+    items
+  end
+
+  def user_menu_items
+    return [] if user_context.guest?
+
+    [user_menu_sign_out_item]
+  end
+
+  def user_menu_sign_out_item
+    menu_item(
+      :signout,
+      action: Vocab.libro['actions/logout'],
+      label: I18n.t('menus.sign_out'),
+      href: LinkedRails.iri(path: :logout)
+    )
+  end
+end

data/lib/generators/linked_rails/install/templates/application_action_list.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class ApplicationActionList < LinkedRails::Actions::List; end

data/lib/generators/linked_rails/install/templates/application_form.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class ApplicationForm < LinkedRails::Form; end

data/lib/generators/linked_rails/install/templates/application_menu_list.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class ApplicationMenuList < LinkedRails::Menus::List; end

data/lib/generators/linked_rails/install/templates/application_policy.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ApplicationPolicy
+  include LinkedRails::Policy
+
+  class Scope
+    attr_reader :user, :scope
+
+    def initialize(user, scope)
+      @user  = user
+      @scope = scope
+    end
+
+    def resolve
+      scope
+    end
+  end
+end

data/lib/generators/linked_rails/install/templates/application_serializer.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationSerializer
+  include LinkedRails::Serializer
+end

data/lib/generators/linked_rails/install/templates/initializer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/vocab'
+
+LinkedRails.host = 'example.com'
+LinkedRails.scheme = :https
+LinkedRails.app_vocab = Vocab.example
+
+LinkedRails::Renderers.register!

data/lib/generators/linked_rails/install/templates/locales.yml

@@ -0,0 +1,12 @@
+en:
+  linked_rails:
+    status:
+      400: "Error in request"
+      401: "You have to be logged in to perform this action."
+      403: "This page is not available."
+      404: "The item was not found, try reloading the page."
+      429: "You're making too many requests, please try again later."
+      500: "Something went wrong on our side, please try again later."
+  menus:
+    home: "Home"
+    sign_out: "Sign out"

data/lib/generators/linked_rails/install/templates/rdf_responder.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'linked_rails/active_response/responders/rdf'
+
+class RDFResponder < LinkedRails::ActiveResponse::Responders::RDF; end

data/lib/generators/linked_rails/install/templates/rdf_serializers_initializer.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RDF::Serializers.configure do |config|
+  config.default_graph = Vocab.ll[:supplant]
+end

data/lib/generators/linked_rails/install/templates/vocab.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Vocab < LinkedRails::Vocab
+  register(:example, 'https://example.com/my_vocab#')
+end

data/lib/generators/linked_rails/install/templates/vocab.yml

@@ -0,0 +1,26 @@
+en:
+  foaf:
+    name:
+      label: "Naam"
+  ontola:
+    password:
+      label: "Wachtwoord"
+    quickActions:
+      label: "Actions"
+  rdfv:
+    type:
+      label: "Type"
+  schema:
+    Thing:
+      label: "Thing"
+      plural_label: "Things"
+    dateCreated:
+      label: "Date created"
+    dateModified:
+      label: "Date modified"
+    email:
+      label: "Email"
+    image:
+      label: "Image"
+    name:
+      label: "Name"