linked_rails 0.0.3 → 0.0.4

data/lib/linked_rails/helpers/delta_helper.rb

@@ -41,7 +41,10 @@ module LinkedRails
       end
 
       def changes_triples # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        serializer = RDF::Serializers.serializer_for(current_resource).new(current_resource)
+        serializer_class = RDF::Serializers.serializer_for(current_resource)
+        return [] if serializer_class.blank?
+
+        serializer = serializer_class.new(current_resource)
 
         current_resource.previous_changes_by_predicate.map do |predicate, (_old_value, _new_value)|
           serializer_attributes = current_resource.class.predicate_mapping[predicate]
@@ -75,11 +78,31 @@ module LinkedRails
       end
 
       def resource_added_delta(resource)
-        invalidate_parent_collections_delta(resource)
+        invalidate_parent_collections_delta(resource) + singular_added_delta(resource)
       end
 
       def resource_removed_delta(resource)
-        invalidate_parent_collections_delta(resource)
+        invalidate_parent_collections_delta(resource) + singular_removed_delta(resource)
+      end
+
+      def same_as_statement(from, to)
+        [
+          from,
+          Vocab.owl.sameAs,
+          to
+        ]
+      end
+
+      def singular_added_delta(resource)
+        return [] unless resource.try(:singular_resource?)
+
+        [same_as_statement(resource.singular_iri, resource.iri)]
+      end
+
+      def singular_removed_delta(resource)
+        return [] unless resource.try(:singular_resource?)
+
+        [invalidate_resource_delta(resource.singular_iri)]
       end
     end
   end

data/lib/linked_rails/helpers/ontola_actions_helper.rb

@@ -12,8 +12,8 @@ module LinkedRails
         Vocab.libro["actions/copyToClipboard?#{{value: value}.to_param}"]
       end
 
-      def ontola_dialog_action(resource, opener: nil)
-        Vocab.libro["actions/dialog/alert?#{{resource: resource, opener: opener}.compact.to_param}"]
+      def ontola_dialog_action(resource, opener: nil, size: nil)
+        Vocab.libro["actions/dialog/alert?#{{resource: resource, opener: opener, size: size}.compact.to_param}"]
       end
 
       def ontola_dialog_close_action

data/lib/linked_rails/helpers/resource_helper.rb

@@ -59,7 +59,7 @@ module LinkedRails
 
       def resolve_current_resource
         case action_name
-        when 'create', 'new'
+        when 'create'
           new_resource
         else
           requested_resource

data/lib/linked_rails/iri_mapper.rb

@@ -12,6 +12,7 @@ module LinkedRails
       #   => {
       #     action: 'show',
       #     class: Resource,
+      #     iri: 'https://example.com/resource/1?foo=bar',
       #     params: {
       #       id: '1',
       #       foo: 'bar'
@@ -22,6 +23,7 @@ module LinkedRails
       #   => {
       #     action: 'index',
       #     class: Resource,
+      #     iri: 'https://example.com/resources?foo=bar',
       #     params: {
       #       foo: 'bar'
       #     }
@@ -35,38 +37,21 @@ module LinkedRails
         query = Rack::Utils.parse_nested_query(URI(iri.to_s).query)
         params = Rails.application.routes.recognize_path(iri.to_s, method: method)
 
-        route_params_to_opts(params.merge(query))
+        route_params_to_opts(params.merge(query), iri.to_s)
       rescue ActionController::RoutingError
         EMPTY_IRI_OPTS.dup
       end
 
-      def index_resource_from_iri(iri, user_context)
-        ensure_absolute_iri!(iri)
-
-        opts = opts_from_iri(iri)
-        index_resource_from_opts(opts, user_context)
-      end
-
-      def index_resource_from_iri!(iri, user_context)
-        index_resource_from_iri(iri, user_context) || raise(ActiveRecord::RecordNotFound)
-      end
-
-      def index_resource_from_opts(opts, user_context)
-        opts[:class]&.requested_index_resource(opts[:params], user_context) if opts[:action] == 'index'
-      end
-
       def parent_from_params(params, user_context)
         return unless params.key?(:parent_iri)
 
-        parent_iri = "/#{params[:parent_iri]}"
-        opts = LinkedRails.iri_mapper.opts_from_iri(parent_iri)
-        opts[:params] = params.except(:parent_iri, :singular_route).merge(opts[:params])
+        parent_iri = LinkedRails.iri(path: "/#{params[:parent_iri]}")
 
-        LinkedRails.iri_mapper.resource_from_opts(opts, user_context)
+        LinkedRails.iri_mapper.resource_from_iri(parent_iri, user_context)
       end
 
       def resource_from_iri(iri, user_context)
-        ensure_absolute_iri!(iri)
+        return nil unless absolute_iri?(iri)
 
         opts = opts_from_iri(iri)
         resource_from_opts(opts, user_context)
@@ -80,7 +65,7 @@ module LinkedRails
         opts[:class]&.requested_resource(opts, user_context)
       end
 
-      def route_params_to_opts(params)
+      def route_params_to_opts(params, iri)
         controller_class = class_for_controller(params[:controller])
 
         return EMPTY_IRI_OPTS.dup if controller_class.blank?
@@ -88,27 +73,17 @@ module LinkedRails
         {
           action: params[:action],
           class: controller_class,
-          params: params.except(:action, :controller)
+          iri: iri,
+          params: sanitized_route_params(controller_class, params)
         }.with_indifferent_access
       end
 
-      def single_resource_from_iri(iri, user_context)
-        ensure_absolute_iri!(iri)
-
-        opts = opts_from_iri(iri)
-        single_resource_from_opts(opts, user_context)
-      end
-
-      def single_resource_from_iri!(iri, user_context)
-        single_resource_from_iri(iri, user_context) || raise(ActiveRecord::RecordNotFound)
-      end
+      private
 
-      def single_resource_from_opts(opts, user_context)
-        opts[:class]&.requested_single_resource(opts[:params], user_context) unless opts[:params] == 'index'
+      def absolute_iri?(iri)
+        iri.present? && !URI(iri).relative?
       end
 
-      private
-
       def class_for_controller(controller)
         return if controller.blank?
 
@@ -117,8 +92,11 @@ module LinkedRails
           .try(:controller_class)
       end
 
-      def ensure_absolute_iri!(iri)
-        raise("An absolute url is expected. #{iri} is given.") if iri.blank? || URI(iri).relative?
+      def sanitized_route_params(controller_class, params)
+        new_params = params.except(:action, :controller)
+        nested_key = :"#{controller_class.name.tableize.singularize}_id"
+        new_params[:id] ||= new_params.delete(nested_key) if new_params.key?(nested_key)
+        new_params
       end
     end
   end

data/lib/linked_rails/middleware/linked_data_params.rb

@@ -2,7 +2,7 @@
 
 module LinkedRails
   module Middleware
-    class LinkedDataParams # rubocop:disable Metrics/ClassLength
+    class LinkedDataParams
       def initialize(app)
         @app = app
       end
@@ -17,33 +17,8 @@ module LinkedRails
 
       private
 
-      def add_param(hash, key, value) # rubocop:disable Metrics/MethodLength
-        case hash[key]
-        when nil
-          hash[key] = value
-        when Hash
-          hash[key].merge!(value)
-        when Array
-          hash[key].append(value)
-        else
-          hash[key] = [hash[key], value]
-        end
-        hash
-      end
-
-      def associated_class_from_params(reflection, graph, subject)
-        return reflection.klass unless reflection.polymorphic?
-
-        query = graph.query(subject: subject, predicate: Vocab.rdfv[:type])
-        if query.empty?
-          raise("No type given for '#{subject}' referenced by polymorphic association '#{reflection.name}'")
-        end
-
-        iri_to_class(query.first.object)
-      end
-
-      def blob_attribute(base_params, value)
-        base_params["<#{value}>"] if value.starts_with?(Vocab.ll['blobs/'])
+      def add_param_from_query(data, target_class, key, value)
+        data[target_class.predicate_mapping[RDF::URI(key)].key] = value
       end
 
       def convert_query_params(request, target_class)
@@ -56,17 +31,6 @@ module LinkedRails
         request.update_param(class_key, data) if data.present?
       end
 
-      def add_param_from_query(data, target_class, key, value)
-        data[target_class.predicate_mapping[RDF::URI(key)].key] = value
-      end
-
-      def enum_attribute(klass, key, value)
-        opts = RDF::Serializers.serializer_for(klass).try(:enum_options, key)
-        return if opts.blank?
-
-        opts.detect { |_k, options| options.iri == value }&.first&.to_s
-      end
-
       def graph_from_request(request)
         request_graph = request.delete_param("<#{Vocab.ll[:graph].value}>")
         return if request_graph.blank?
@@ -79,33 +43,6 @@ module LinkedRails
         )
       end
 
-      def iri_to_class(iri)
-        iri.to_s.split(LinkedRails.app_vocab.to_s).pop&.classify&.safe_constantize ||
-          ApplicationRecord.descendants.detect { |klass| klass.iri == iri }
-      end
-
-      def logger
-        Rails.logger
-      end
-
-      def nested_attributes(base_params, graph, subject, klass, association, collection) # rubocop:disable Metrics/ParameterLists
-        nested_resources =
-          if graph.query([subject, Vocab.rdfv[:first], nil]).present?
-            nested_attributes_from_list(base_params, graph, subject, klass)
-          else
-            parsed = parse_nested_resource(base_params, graph, subject, klass)
-            collection ? {rand(1_000_000_000).to_s => parsed} : parsed
-          end
-        ["#{association}_attributes", nested_resources]
-      end
-
-      def nested_attributes_from_list(base_params, graph, subject, klass)
-        Hash[
-          RDF::List.new(subject: subject, graph: graph)
-            .map { |nested| [rand(1_000_000_000).to_s, parse_nested_resource(base_params, graph, nested, klass)] }
-        ]
-      end
-
       # Converts a serialized graph from a multipart request body to a nested
       # attributes hash.
       #
@@ -135,72 +72,13 @@ module LinkedRails
         convert_query_params(request, target_class)
       end
 
-      def parse_nested_resource(base_params, graph, subject, klass)
-        resource = parse_resource(base_params, graph, subject, klass)
-        resource[:id] ||= LinkedRails.iri_mapper.opts_from_iri(subject)[:params][:id] if subject.iri?
-        resource
-      end
-
-      # Recursively parses a resource from graph
-      def parse_resource(base_params, graph, subject, klass)
-        graph
-          .query([subject])
-          .map { |statement| parse_statement(base_params, graph, statement, klass) }
-          .compact
-          .reduce({}) { |h, (k, v)| add_param(h, k, v) }
-      end
-
-      def parse_statement(base_params, graph, statement, klass)
-        field = serializer_field(klass, statement.predicate)
-        if field.is_a?(FastJsonapi::Attribute)
-          parsed_attribute(base_params, klass, field.key, statement.object.value)
-        elsif field.is_a?(FastJsonapi::Relationship)
-          parsed_association(base_params, graph, statement.object, klass, field.association || field.key)
-        end
-      end
-
-      def parsed_association(base_params, graph, object, klass, association)
-        reflection = klass.reflect_on_association(association) || raise("#{association} not found for #{klass}")
-
-        if graph.has_subject?(object)
-          association_klass = associated_class_from_params(reflection, graph, object)
-          nested_attributes(base_params, graph, object, association_klass, association, reflection.collection?)
-        elsif object.iri?
-          attributes_from_iri(object, association, reflection)
-        end
-      end
-
-      def attributes_from_iri(object, association, reflection)
-        if reflection.options[:through]
-          key = reflection.has_one? ? "#{association}_id" : "#{association.to_s.singularize}_ids"
-        elsif reflection.belongs_to?
-          key = reflection.foreign_key
-        end
-        return unless key
-
-        resource = LinkedRails.iri_mapper.resource_from_iri(object, nil)
-        value = resource&.send(reflection.association_primary_key)
-
-        [key, value] if value
-      end
-
-      def parsed_attribute(base_params, klass, key, value)
-        [key, blob_attribute(base_params, value) || enum_attribute(klass, key, value) || value]
-      end
-
-      def serializer_field(klass, predicate)
-        field = klass.try(:predicate_mapping).try(:[], predicate)
-        logger.info("#{predicate} not found for #{klass || 'nil'}") if field.blank?
-        field
-      end
-
       def target_class_from_path(request) # rubocop:disable Metrics/AbcSize
         opts = LinkedRails.iri_mapper.opts_from_iri(
           request.base_url + request.env['REQUEST_URI'],
           method: request.request_method
         )
 
-        logger.info("No class found for #{request.base_url + request.env['REQUEST_URI']}") unless opts[:class]
+        Rails.logger.info("No class found for #{request.base_url + request.env['REQUEST_URI']}") unless opts[:class]
 
         opts[:class]
       end
@@ -215,7 +93,9 @@ module LinkedRails
 
       def update_target_params(request, graph, target_class)
         key = target_class.to_s.demodulize.underscore
-        from_body = parse_resource(request.params, graph, Vocab.ll[:targetResource], target_class)
+
+        parser = ParamsParser.new(graph: graph, params: request.params)
+        from_body = parser.parse_resource(Vocab.ll[:targetResource], target_class)
 
         request.update_param(key, from_body.merge(request.params[key] || {}))
       end

data/lib/linked_rails/model/actionable.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  module Model
+    module Actionable
+      extend ActiveSupport::Concern
+
+      def actions(user_context = nil)
+        action_list(user_context).actions
+      end
+
+      def action(tag, user_context = nil)
+        actions(user_context).find { |a| a.tag == tag }
+      end
+
+      def action_list(user_context)
+        @action_list ||= {}
+        @action_list[user_context] ||= self.class.action_list.new(resource: self, user_context: user_context)
+      end
+
+      def action_triples
+        @action_triples ||= triples_for_actions(actions) + triples_for_actions(collection_actions)
+      end
+
+      def collection_actions
+        (try(:collections) || []).map do |opts|
+          collection_for(opts[:name]).actions
+        end.flatten
+      end
+
+      def favorite_actions
+        actions.filter(&:favorite)
+      end
+
+      private
+
+      def triples_for_actions(actions)
+        actions.flat_map do |action|
+          [
+            [iri, action.predicate, action.iri],
+            [iri, Vocab.schema.potentialAction, action.iri]
+          ]
+        end
+      end
+
+      module ClassMethods
+        def action_list
+          return @action_list if @action_list.try(:actionable_class) == self
+
+          @action_list = defined_action_list || define_action_list
+        end
+
+        private
+
+        def action_superclass
+          superclass.try(:action_list) || LinkedRails.action_list_parent_class
+        end
+
+        def defined_action_list
+          'ActionList'.safe_constantize
+        end
+
+        def define_action_list
+          const_set('ActionList', Class.new(action_superclass))
+        end
+      end
+    end
+  end
+end

data/lib/linked_rails/model/collections.rb

@@ -5,8 +5,175 @@ module LinkedRails
     module Collections
       extend ActiveSupport::Concern
 
+      COLLECTION_CUSTOMIZABLE_OPTIONS = {
+        # display [Sym] The default display type.
+        #   Choose between :grid, :settingsTable, :table, :card, :default
+        display: :default,
+        # grid_max_columns [Integer] The default amount of columns to use in a grid.
+        grid_max_columns: 3,
+        # page_size [Integer] The default page size.
+        page_size: 20,
+        # table_type [Sym] The columns to use in the table.
+        table_type: lambda {
+          case display&.to_sym
+          when :table
+            :default
+          when :settingsTable
+            :settings
+          end
+        },
+        # title String The default title.
+        title: -> { title_from_translation },
+        # type [Sym] The default pagination type.
+        #   Choose between :paginated, :infinite.
+        type: :paginated
+      }.freeze
+      COLLECTION_STATIC_OPTIONS = {
+        # association [Sym] The association of the collection items.
+        association: nil,
+        # association_base [Scope, Array] The items of the collection.
+        association_base: -> { apply_scope(sorted_association(filtered_association)) },
+        # association_class [Class] The class of the collection items.
+        association_class: nil,
+        # association_scope [Sym] The scope applied to the collection.
+        association_scope: nil,
+        # collection_class [Class] The base class of the collection.
+        #   If you want to use a class other than LinkedRails.collection_class.
+        collection_class: nil,
+        # collection_class [Hash] The default filters applied to the collection.
+        default_filters: {},
+        # collection_class [Array<Hash>] The default sortings applied to the collection.
+        default_sortings: [{key: Vocab.schema.dateCreated, direction: :desc}],
+        # iri_template_keys [Array<Sym>] Custom query keys for the iri template
+        iri_template_keys: [],
+        # joins [Array<Sym>, Sym] The associations to join
+        joins: nil,
+        # parent [Instance] The default parent of a collection.
+        parent: nil,
+        # parent_iri [Array<String>] The iri elements of the parent
+        parent_iri: -> { parent&.iri_elements },
+        # part_of [Instance] The record to serialize as isPartOf
+        part_of: -> { parent },
+        # policy_scope [Scope] The policy scope class to be used for scoping
+        #   Set to false to skip scoping
+        policy_scope: -> { policy ? policy::Scope : Pundit::PolicyFinder.new(filtered_association).scope! },
+        # route_key [Symbol, String] The route key for the association
+        route_key: nil
+      }.freeze
+      COLLECTION_OPTIONS = COLLECTION_CUSTOMIZABLE_OPTIONS.merge(COLLECTION_STATIC_OPTIONS)
+
+      module ClassMethods
+        def collection_iri(**opts)
+          LinkedRails.iri(path: collection_root_relative_iri(**opts))
+        end
+
+        # Sets the defaults for all collections for this class.
+        # Can be overridden by #with_collection, called from associated models,
+        # or by passing parameters in an iri.
+        # @param [Hash] options
+        def collection_options(**options)
+          initialize_default_collection_opts
+
+          options.each do |key, value|
+            raise("Invalid key passed to collection_options: #{key}") unless valid_collection_option?(key)
+
+            _default_collection_opts[key] = value
+          end
+          _default_collection_opts[:iri_template] = LinkedRails.collection_class.generate_iri_template(
+            _default_collection_opts[:iri_template_keys]
+          )
+          _default_collection_opts
+        end
+
+        def collection_root_relative_iri(**opts)
+          opts[:filter] = LinkedRails.collection_class.filter_iri_opts(opts[:filter]) if opts.key?(:filter)
+          opts[:route_key] = collection_route_key
+          default_collection_option(:iri_template).expand(**opts)
+        end
+
+        def collection_route_key
+          default_collection_option(:route_key) || route_key
+        end
+
+        def default_collection_options
+          initialize_default_collection_opts
+
+          _default_collection_opts
+        end
+
+        def default_collection_option(key)
+          default_collection_options[key]
+        end
+
+        # Defines a collection to be used in {collection_for}
+        # @see Ldable#collection_for
+        # @note Adds a instance_method <name>_collection
+        # @param [Hash] name as to be used in {collection_for}
+        # @param [Hash] options See COLLECTION_OPTIONS
+        # @return [Collection]
+        def with_collection(name, **options) # rubocop:disable Metrics/AbcSize
+          options[:association] ||= name.to_sym
+          options[:association_class] ||= name.to_s.classify.constantize
+          merged_options = options[:association_class].default_collection_options.merge(options)
+          merged_options[:iri_template] = LinkedRails.collection_class.generate_iri_template(
+            merged_options[:iri_template_keys]
+          )
+          collections_add(name: name, options: merged_options)
+
+          define_method "#{name.to_s.singularize}_collection" do |opts = {}|
+            collection_for(name, **opts)
+          end
+        end
+
+        private
+
+        def collections_add(opts)
+          initialize_collections
+          collections.delete_if { |c| c[:name] == opts[:name] }
+          opts[:options] = sanitized_collection_options(opts[:options])
+          collections.append(opts)
+        end
+
+        def initialize_collections
+          return if collections && method(:collections).owner == singleton_class
+
+          self.collections = superclass.try(:collections)&.dup || []
+        end
+
+        def initialize_default_collection_opts # rubocop:disable Metrics/AbcSize
+          return if _default_collection_opts && method(:_default_collection_opts).owner == singleton_class
+
+          self._default_collection_opts = (superclass.try(:_default_collection_opts) || COLLECTION_OPTIONS).dup
+
+          _default_collection_opts[:collection_class] ||= LinkedRails.collection_class
+          _default_collection_opts[:association_class] = self
+          _default_collection_opts[:iri_template] = LinkedRails.collection_class.generate_iri_template(
+            _default_collection_opts[:iri_template_keys]
+          )
+
+          _default_collection_opts
+        end
+
+        def sanitized_collection_options(opts)
+          opts.each_with_object(HashWithIndifferentAccess.new) do |(key, value), hash|
+            raise("Invalid key passed to with_collection: #{key}") unless valid_collection_option?(key.to_sym)
+
+            hash_key = COLLECTION_CUSTOMIZABLE_OPTIONS.key?(key.to_sym) ? "default_#{key}" : key
+
+            hash[hash_key] = value
+          end
+        end
+
+        def valid_collection_option?(key)
+          COLLECTION_OPTIONS.key?(key) || key == :iri_template
+        end
+      end
+
       included do
         class_attribute :collections
+        class_attribute :_default_collection_opts,
+                        instance_accessor: false,
+                        instance_predicate: false
       end
 
       # Initialises a {Collection} for one of the collections defined by {has_collection}
@@ -18,19 +185,42 @@ module LinkedRails
       # @param [ApplicationRecord] part_of
       # @param [Hash] opts Additional options to be passed to the collection.
       # @return [Collection]
-      def collection_for(name, instance_opts = {})
-        collection_opts = collections.detect { |c| c[:name] == name }.try(:[], :options).dup
+      def collection_for(name, **instance_opts)
+        collection_opts = collection_options_for(name).dup
         return if collection_opts.blank?
 
         collection_opts[:name] = name
         collection_opts[:parent] = self
-        collection_opts[:part_of] = collection_opts.key?(:part_of) ? send(collection_opts[:part_of]) : self
-        collection_class = collection_opts.delete(:collection_class) || LinkedRails.collection_class
+        collection_class =
+          collection_opts.delete(:collection_class) ||
+          collection_opts[:association_class].default_collection_option(:collection_class) ||
+          LinkedRails.collection_class
         collection_class.collection_or_view(collection_opts, instance_opts)
       end
 
+      def collection_iri(collection, **opts)
+        LinkedRails.iri(path: collection_root_relative_iri(collection, **opts))
+      end
+
+      def collection_options_for(name)
+        opts = collections.detect { |c| c[:name] == name.to_sym }
+        raise("Collection #{name} not found for #{self}") unless opts
+
+        opts[:options] || {}
+      end
+
+      def collection_root_relative_iri(collection, **opts)
+        collection_opts = collection_options_for(collection).dup
+        template = collection_opts[:iri_template]
+        klass = collection_opts[:association_class]
+        opts[:route_key] = collection_opts[:route_key] || klass.collection_route_key
+        opts[:parent_iri] = iri_elements
+
+        template.expand(**opts).to_s
+      end
+
       def parent_collections(user_context)
-        return [] if try(:parent).try(:collections).blank?
+        return [self.class.root_collection(user_context: user_context)] if try(:parent).try(:collections).blank?
 
         parent_collections_for(parent, user_context)
       end
@@ -43,40 +233,6 @@ module LinkedRails
           .select { |collection| is_a?(collection[:options][:association_class]) }
           .map { |collection| parent.collection_for(collection[:name], user_context: user_context) }
       end
-
-      module ClassMethods
-        def collections_add(opts)
-          initialize_collections
-          collections.delete_if { |c| c[:name] == opts[:name] }
-          collections.append(opts)
-        end
-
-        def initialize_collections
-          return if collections && method(:collections).owner == singleton_class
-
-          self.collections = superclass.try(:collections)&.dup || []
-        end
-
-        # Defines a collection to be used in {collection_for}
-        # @see Ldable#collection_for
-        # @note Adds a instance_method <name>_collection
-        # @param [Hash] name as to be used in {collection_for}
-        # @param [Hash] options
-        # @option options [Sym] association the name of the association
-        # @option options [Class] association_class the class of the association
-        # @option options [Sym] joins the associations to join
-        # @return [Collection]
-        def with_collection(name, options = {})
-          options[:association] ||= name.to_sym
-          options[:association_class] ||= name.to_s.classify.constantize
-
-          collections_add(name: name, options: options)
-
-          define_method "#{name.to_s.singularize}_collection" do |opts = {}|
-            collection_for(name, opts)
-          end
-        end
-      end
     end
   end
 end