ld4l_virtual_collection 0.1.0

data/app/controllers/ld4l_virtual_collection/application_controller.rb

@@ -0,0 +1,9 @@
+# # MODIFIED to have engine application controller extend main application's controller
+class Ld4lVirtualCollection::ApplicationController < ApplicationController
+end
+
+# # GENERATED
+# module Ld4lVirtualCollection
+#   class ApplicationController < ActionController::Base
+#   end
+# end

data/app/controllers/ld4l_virtual_collection/collections_controller.rb

@@ -0,0 +1,101 @@
+require_dependency "ld4l_virtual_collection/application_controller"
+
+
+# TODO This code implies that @collection is an instance of the Collection model, but it is actually an instance of
+#      LD4L::OreRDF::Aggregation.  Should the Collection model be updated to hold the instance of LD4L::OreRDF::Aggregation
+#      and have the methods updated to redirect to the Aggregation model?  OR should Collection inherit from
+#      LD4L::OreRDF::Aggregation and get the methods that way?  That seems the cleaner way to go.
+
+
+module Ld4lVirtualCollection
+  class CollectionsController < ApplicationController
+    before_action :set_collection, only: [:show, :edit, :update, :destroy]
+
+    # GET /collections
+    def index
+      @collections = Collection.all
+    end
+
+    # GET /collections/1
+    def show
+      # puts("*** Entering CTRL: show collection")
+    end
+
+    # GET /collections/new
+    def new
+      # puts("*** Entering CTRL: new collection")
+      @collection = Collection.new
+    end
+
+    # GET /collections/1/edit
+    def edit
+      # puts("*** Entering CTRL: edit")
+    end
+
+    # POST /collections
+    def create
+      # puts("*** Entering CTRL: create collection")
+      @collection = Collection.new(collection_params)
+      persisted = false
+      error_msg = ''
+      begin
+        persisted = LD4L::OreRDF::PersistAggregation.call(@collection)
+      rescue ArgumentError
+        # TODO should check that error message from ArgumentError is that Title is missing.
+        error_msg = "Title is required."
+      end
+      if persisted == true
+        flash[:notice] = 'Collection was successfully created.'
+        redirect_to my_virtual_collection_path(@collection.id.to_s)
+      else
+        flash[:error] = "Collection not created.  #{error_msg}"
+        redirect_to my_virtual_collections_path
+      end
+    end
+
+    # PATCH/PUT /collections/1
+    def update
+      # puts("*** Entering CTRL: update collection")
+      @collection = Collection.update(collection_params)
+      persisted = false
+      error_msg = ''
+      begin
+        # TODO -- should update check that proxies persisted as well???
+        persisted = LD4L::OreRDF::PersistAggregation.call(@collection)
+      rescue ArgumentError
+        # TODO should check that error message from ArgumentError is that Title is missing.
+        error_msg = "Title is required."
+      end
+      if persisted == true
+        flash[:notice] = 'Collection was successfully updated.'
+        redirect_to my_virtual_collection_path(@collection.id.to_s)
+      else
+        flash[:error] = "Collection not updated.  #{error_msg}"
+        redirect_to my_virtual_collections_path
+      end
+    end
+
+    # DELETE /collections/1
+    def destroy
+      # puts("*** Entering CTRL: destroy collection")
+      if LD4L::OreRDF::DestroyAggregation.call(@collection) == true
+        redirect_to my_virtual_collections_path, notice: 'Collection was successfully destroyed.'
+      else
+        # TODO Should it redirect to edit???  OR list???  OR  where???
+        # TODO How to add error message about what failed to be destroyed???
+        render :edit
+      end
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_collection
+        @collection = Collection.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def collection_params
+        params[:collection]
+      end
+  end
+end

data/app/controllers/ld4l_virtual_collection/items_controller.rb

@@ -0,0 +1,94 @@
+require_dependency "ld4l_virtual_collection/application_controller"
+
+module Ld4lVirtualCollection
+  class ItemsController < ApplicationController
+    before_action :set_collection
+    before_action :set_item, only: [:show, :edit, :update, :destroy, :metadata_from_uri]
+
+    # GET /collections/1/items
+    def index
+      @items = Item.all(@collection)
+    end
+
+    # GET /collections/1/items/1
+    def show
+    end
+
+    # GET /collections/1/items/new
+    def new
+      # puts("*** Entering CTRL: new item")
+      @item = Item.new(@collection)
+      @proxy_for = ""
+    end
+
+    # GET /items/1/edit
+    def edit
+      # puts("*** Entering CTRL: edit item")
+    end
+
+    # POST /collections/1/items
+    def create
+      # puts("*** Entering CTRL: create item")
+      @item = Item.new(@collection, item_params)
+
+      # TODO How to save only affected items & collection instead of all items & collection???
+      if LD4L::OreRDF::PersistAggregation.call(@collection) == true
+        redirect_to my_virtual_collection_path(@collection.id.to_s), notice: 'Item was successfully created.'
+      else
+        # TODO How to add error message about what failed to persist???
+        render :new
+      end
+    end
+
+    # PATCH/PUT /collections/1/items/1
+    def update
+      # puts("*** Entering CTRL: update item")
+      @item = Item.update(@collection, @item, item_params)
+      # TODO How to save only affected items & collection instead of all items & collection???
+      if LD4L::OreRDF::PersistAggregation.call(@collection) == true
+        redirect_to my_virtual_collection_path(@collection.id.to_s), notice: 'Item was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # GET /collections/1/items/1
+    def metadata_from_uri
+      # puts("*** Entering CTRL: create_from_uri (item)")
+      LD4L::WorksRDF::GetMetadataFromURI(@proxy_for)
+    end
+
+    # DELETE /collections/1/items/1
+    def destroy
+      # puts("*** Entering CTRL: destroy item")
+      # TODO -- need to implement destroy in ORE Gem -- Destroying just the item leaves the aggregates triples
+      @item.destroy   ## TODO REMOVE THIS LINE WHEN DestroyProxy IS IMPLEMENTED
+      # if LD4L::OreRDF::DestroyProxy.call(@collection,@item.rdf_subject) == true
+      redirect_to my_virtual_collection_path(@collection.id.to_s), notice: 'Item was successfully removed.'
+      # else
+      #   # TODO Should it redirect to edit???  OR list???  OR  where???
+      #   # TODO How to add error message about what failed to be destroyed???
+      #  render :edit
+      # end
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_item
+        @item = Item.find(params[:id])
+        @proxy_for = @item.proxy_for_subject
+        @proxy_for |= ""
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def item_params
+        white_list_params = params.permit(:proxy_for)                  unless params.has_key?(:item)
+        white_list_params = params.require(:item).permit(:proxy_for)   if params.has_key?(:item)
+        white_list_params
+      end
+
+      def set_collection
+        @collection = Collection.find(params["collection_id"])
+      end
+  end
+end

data/app/controllers/ld4l_virtual_collection/my_virtual_collections_controller.rb

@@ -0,0 +1,189 @@
+require_dependency "ld4l_virtual_collection/application_controller"
+
+
+# TODO This code implies that @collection is an instance of the Collection model, but it is actually an instance of
+#      LD4L::OreRDF::Aggregation.  Should the Collection model be updated to hold the instance of LD4L::OreRDF::Aggregation
+#      and have the methods updated to redirect to the Aggregation model?  OR should Collection inherit from
+#      LD4L::OreRDF::Aggregation and get the methods that way?  That seems the cleaner way to go.
+
+
+module Ld4lVirtualCollection
+  class MyVirtualCollectionsController < ApplicationController
+    before_action :set_collections, :set_page_title
+    before_action :set_collection, only: [:edit, :update, :destroy, :edit_collection_modal, :new_collection_item_modal]
+    before_action :set_collection_and_items, only: [:show]
+
+    # GET /my_virtual_collections
+    def index
+      @collection = Collection.new
+    end
+
+    # GET /my_virtual_collections/1
+    def show
+      # puts("*** Entering CTRL: show virtual collection")
+    end
+
+    # GET /my_virtual_collections/new_collection_modal
+    def new_collection_modal
+      # puts("*** Entering CTRL: new virtual collection")
+      @collection = Collection.new
+      respond_to do |format|
+        format.html
+        format.js
+      end
+    end
+
+    # GET /my_virtual_collections/edit_collection_modal/1
+    def edit_collection_modal
+      # puts("*** Entering CTRL: edit virtual collection")
+      respond_to do |format|
+        format.html
+        format.js
+      end
+    end
+
+
+    # GET /my_virtual_collections/new_collection_item_modal/1
+    def new_collection_item_modal
+      # puts("*** Entering CTRL: new virtual collection item")
+      @item = Item.new(@collection)
+      @proxy_for = ""
+      respond_to do |format|
+        format.html
+        format.js
+      end
+    end
+
+
+    # # TODO XXX
+    # # GET /my_virtual_collections/new_collection_items_by_query_modal/1
+    # def new_collection_items_by_query_modal
+    #   # puts("*** Entering CTRL: new virtual collection items by query")
+    #   @item = Item.new(@collection)
+    #   @proxy_for = ""
+    #   respond_to do |format|
+    #     format.html
+    #     format.js
+    #   end
+    # end
+
+
+    # # GET /my_virtual_collections/1/edit
+    # def edit
+    #   # puts("*** Entering CTRL: edit")
+    # end
+    #
+    # # POST /my_virtual_collections
+    # def create
+    #   puts("*** Entering CTRL: create collection")
+    #   @collection = Collection.new(collection_params)
+    #   if LD4L::OreRDF::PersistAggregation.call(@collection) == true
+    #     redirect_to collection_path(@collection.id.to_s), notice: 'Collection was successfully created.'
+    #   else
+    #     # TODO How to add error message about what failed to persist???
+    #     render :new
+    #   end
+    # end
+    #
+    # # PATCH/PUT /my_virtual_collections/1
+    # def update
+    #   puts("*** Entering CTRL: update collection")
+    #   @collection = Collection.update(collection_params)
+    #   # TODO -- should update check that proxies persisted as well???
+    #   if LD4L::OreRDF::PersistAggregation.call(@collection) == true
+    #     redirect_to collection_path(@collection.id.to_s), notice: 'Collection was successfully updated.'
+    #   else
+    #     # TODO How to add error message about what failed to persist???
+    #     render :edit
+    #   end
+    # end
+    #
+    # # DELETE /my_virtual_collections/1
+    # def destroy
+    #   puts("*** Entering CTRL: destroy collection")
+    #   if LD4L::OreRDF::DestroyAggregation.call(@collection) == true
+    #     redirect_to collections_url, notice: 'Collection was successfully destroyed.'
+    #   else
+    #     # TODO Should it redirect to edit???  OR list???  OR  where???
+    #     # TODO How to add error message about what failed to be destroyed???
+    #     render :edit
+    #   end
+    # end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_page_title
+        @heading = "Virtual Collections"
+      end
+
+      def set_collections
+        @collections = []
+        collections = Collection.all
+Ld4lVirtualCollection::Engine.configuration.debug_logger.warn("*** Entering CTRL: set_collections -- @collections=#{@collections}")
+        collections.each do |uri, col|
+          parsed_col = {}
+          parsed_col[:title] = col[:title]
+          parsed_col[:description] = col[:description]
+          parsed_col[:uri] = uri
+          parsed_col[:id] = /https?:\/\/(\w*):?(\d{4})?([\/\w]*)\/(\w{10}-\w{4}-\w{4}-\w{4}-\w{12})/.match(uri).values_at(4)
+          @collections << parsed_col
+        end
+
+        # TODO Sorting collections alphabetically...
+        # TODO   * @collections is a hash, so it can't be sorted
+        # TODO   * need to convert @collections from a hash to an array
+
+        # @watched = Watched.all
+      end
+
+      def set_collection
+        @select_id  = params[:id]
+        @collection = Collection.find(@select_id)
+      end
+
+      def set_collection_and_items
+Ld4lVirtualCollection::Engine.configuration.debug_logger.warn("*** Entering CTRL: set_collection_and_items")
+Ld4lVirtualCollection::Engine.configuration.debug_logger.warn("params=#{params}")
+        @select_id  = params[:id]
+        @collection = Collection.find(@select_id)
+        @items = []
+        if @collection
+Ld4lVirtualCollection::Engine.configuration.debug_logger.warn("****** Get metadata for virtual collection #{@collection.title}")
+          @collection.proxy_resources.each do |proxy|
+            next if proxy.nil?
+            uri = proxy.proxy_for_subject
+            next if uri.nil?
+Ld4lVirtualCollection::Engine.configuration.debug_logger.warn("   begin processing URI: #{uri}")
+            parsable_uri = URI(uri)  if uri
+            metadata_callback = Ld4lVirtualCollection::Engine.configuration.find_metadata_callback(parsable_uri.host) if parsable_uri
+            metadata_callback = Ld4lVirtualCollection::Engine.configuration.get_default_metadata_callback  unless metadata_callback
+            items_metadata = metadata_callback.call( [ uri ] )  if metadata_callback
+
+            notes = Ld4lVirtualCollection::Note.all(@collection,proxy)
+            note = notes.first                                         if     notes && notes.size > 0
+            note = Ld4lVirtualCollection::Note.new(@collection,proxy)  unless notes && notes.size > 0
+
+            tag_values = Ld4lVirtualCollection::Tag.all_values(proxy)
+            tag = Ld4lVirtualCollection::Tag.new(@collection,proxy)
+
+            @items << { :proxy => proxy, :metadata => items_metadata.first, :proxy_for => uri, :note => note, :tag => tag, :tags => tag_values }  if items_metadata && items_metadata.size > 0
+
+Ld4lVirtualCollection::Engine.configuration.debug_logger.warn("   processing complete - #{@items.size} items retrieved")
+### TODO Look for all usage of proxy_for and make sure correct.  Cause it isn't correct here.
+
+            # @proxy_for = uri  ### TODO This isn't correct as the proxy gets reset with every loop.  How is it being used?  Should get proxy from @items.
+          end
+        end
+        # TODO: Following 3 values are kludged for first page.  Need better method for calculating when multiple pages.
+        @first_idx  = @items.size > 0 ? 1 : 0
+        @last_idx   = @items.size <= 20 ? @items.size : 20
+        @num_items  = @items.size
+        @note = nil
+      end
+
+    # Only allow a trusted parameter "white list" through.
+      def my_virtual_collection_params
+        params[:collection]
+      end
+  end
+end

data/app/controllers/ld4l_virtual_collection/notes_controller.rb

@@ -0,0 +1,84 @@
+require_dependency "ld4l_virtual_collection/application_controller"
+
+module Ld4lVirtualCollection
+  class NotesController < ApplicationController
+    before_action :set_collection_and_item, only: [:new, :create, :index]
+    before_action :set_note, only: [:show, :edit, :update, :destroy]
+
+    # GET /collections/1/items/1/notes
+    def index
+      @notes = Note.all(@collection,@item)
+    end
+
+    # GET /notes/1
+    def show
+    end
+
+    # GET /collections/1/items/1/notes/new
+    def new
+      # puts("*** Entering CTRL: new note")
+      @note = Note.new(@collection,@item)
+    end
+
+    # GET /notes/1/edit
+    def edit
+      # puts("*** Entering CTRL: edit note")
+    end
+
+    # POST /collections/1/items/1/notes
+    def create
+      # puts("*** Entering CTRL: create note")
+      @note = Note.new(@collection, @item, note_params)
+
+      if @note.persist! == true
+        redirect_to my_virtual_collection_path(@collection.id.to_s), notice: 'Note was successfully created.'
+      else
+        # TODO How to add error message about what failed to persist???
+        render :new
+      end
+    end
+
+    # PATCH/PUT /notes/1
+    def update
+      # puts("*** Entering CTRL: update note")
+      @note = Note.update(@note, note_params)
+      # TODO should check old and new values and only update if changed
+      # TODO How to save only affected items & collection instead of all items & collection???
+      if @note.persist! == true
+        redirect_to my_virtual_collection_path(note_params[:collection_id]), notice: 'Note was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /notes/1
+    def destroy
+      # puts("*** Entering CTRL: destroy note")
+      @note.destroy
+      # if LD4L::OreRDF::DestroyProxy.call(@collection,@item.rdf_subject) == true
+      redirect_to my_virtual_collection_path(@collection.id.to_s), notice: 'Note was successfully removed.'
+      # else
+      #   # TODO Should it redirect to edit???  OR list???  OR  where???
+      #   # TODO How to add error message about what failed to be destroyed???
+      #  render :edit
+      # end
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_note
+        @note = Note.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def note_params
+        params[:note]
+      end
+
+      def set_collection_and_item
+        @collection = Collection.find(params["collection_id"])
+        @item = Item.find(params["item_id"])
+        @proxy_for = @item && @item.proxy_for && @item.proxy_for.first ? @item.proxy_for.first.rdf_subject : ""
+      end
+  end
+end