card-mod-bookmarks 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c6a2b131d1140a546ee8c12b5b947deba44b681666eccbb8c7c4f46c927ba39
+  data.tar.gz: fe66a0b037a7257d68f31bdeb828c675541ab12136e53926f8174c49f86c6979
+SHA512:
+  metadata.gz: 549367ca28dba27ad03eccdd327cc7623403bb54a3992c527205cac4f45e89e27dd9a6236e8159d2d2bb27bb546a5cc91a99e429cc723cc2a86b4811049a3296
+  data.tar.gz: b4988234f764262a848cb8eee1fed09d346343ce9213575500784b8f01a7035e87eece0b03a2942e0107c28b1545bd5ec2732bb7c22837f7b14886b4092c3144

data/README.md

@@ -0,0 +1,68 @@
+<!--
+# @title README - mod: bookmarks
+-->
+
+# Bookmarks mod
+
+This mod provides functionality for:
+
+- bookmarking / unbookmarking cards with a single click
+- db storage of those bookmarks for signed-in users
+- session storage for non-signed in users
+- saving session bookmarks in db when users create accounts
+- navigating one's bookmarked content
+- letting users "follow" cards they have bookmarked
+
+## Sets modified
+
+### Abstract::Bookmarkable
+
+By including this set (via `include_set Abstract::Bookmarkable`), a set is made
+bookmarkable. It has a `:toggle_bookmark` event that can be triggered using the
+standard trigger API. Eg `card.update! trigger: :toggle_bookmark`.
+
+It also provides a `#currently_bookmarked?` method, as well as the following
+views:
+
+- :bookmark - shows the toggleable bookmark icon and the number of bookmarkers
+- :title_with_bookmark - prepends the bookmark view to a title.
+- :box_top - uses :title_with_bookmark in boxes
+- :bar_left - uses :title_with_bookmark in bars
+
+### Abstract::Bookmarker
+
+A bookmarker is a user that bookmarks. Any set that includes this one will be
+able to bookmark other sets.
+
+### Abstract::Accountable
+
+Extended to include `Abstract::Bookmarker`. Because most user sets already
+include `Abstract::Accountable`, monkeys will seldom need to
+include `Abstract::Bookmarker` explicitly.
+
+### Right::Account (Cards that end in +*account)
+
+Extended with `:save_session_bookmarks` event so that session bookmarks can be
+saved when an account is created.
+
+### Right::Bookmarkers (Cards that end in +bookmarkers)
+
+Searches that handle counting number of bookmarkers that have bookmarked a given
+card.
+
+### Right::Bookmarks (Cards that end in +bookmarks)
+
+These are the cards that actually store the bookmarks. For example, if `Joe
+User` bookmarks the card named `Pineapple`, then `Joe User+bookmarks` will 
+be a list of cards that contains the item `Pineapple`
+
+### Self::Anonymous (the card "Anonymous")
+
+When a user is not signed in, the "Anonymous" card acts as their user card.
+This mod extends that card to allow for anonymous bookmarks to be stored in
+the session.
+
+### Self::Bookmarked (the card "Bookmarked")
+
+This card is created as a follow option, making it possible to follow cards
+that you have bookmarked.

data/lib/card/bookmark.rb

@@ -0,0 +1,66 @@
+class Card
+  module Bookmark
+    class << self
+      CURRENT_IDS_KEY = "BM-current_ids".freeze
+      CURRENT_BOOKMARKS_KEY = "BM-current_bookmarks".freeze
+
+      def ok?
+        Auth.current.respond_to?(:bookmarks_card)
+      end
+
+      # @return Hash key is type_id, value is list of ids
+      def current_bookmarks
+        cache.fetch CURRENT_BOOKMARKS_KEY do
+          ok? ? bookmark_hash_for_list_card(current_list_card) : {}
+        end
+      end
+
+      # @param list_card [Card] +bookmarks card for (eg) user
+      # @return [Hash]. keys are type_ids, values are list of bookmarked card ids
+      def bookmark_hash_for_list_card list_card
+        list_card.item_cards.each_with_object({}) do |item, hash|
+          hash[item.type_id] ||= []
+          hash[item.type_id] << item.id
+        end
+      end
+
+      def current_list_card
+        Auth.current.bookmarks_card if ok?
+      end
+
+      def current_ids
+        cache.fetch CURRENT_IDS_KEY do # MOVE to session?
+          ok? ? current_list_card.item_ids : []
+        end
+      end
+
+      def bookmark_hash
+        ok? ? yield : {}
+      end
+
+      def id_restriction bookmarked=true
+        if current_ids.empty?
+          yield [] if bookmarked
+        else
+          yield([(bookmarked ? "in" : "not in")] + current_ids)
+        end
+      end
+
+      def cache
+        Card.cache.soft
+      end
+
+      def clear
+        cache.delete CURRENT_IDS_KEY
+        cache.delete CURRENT_BOOKMARKS_KEY
+      end
+
+      def add_sort_join rel, join_field
+        rel.joins(
+          "LEFT JOIN counts cts " \
+          "ON #{join_field} = cts.left_id AND cts.right_id = #{Card::BookmarkersID}"
+        )
+      end
+    end
+  end
+end

data/set/abstract/01_bookmarker.rb

@@ -0,0 +1 @@
+card_accessor :bookmarks, type: PointerID

data/set/abstract/accountable.rb

@@ -0,0 +1,3 @@
+include_set Abstract::Bookmarker
+
+card_accessor :bookmarks, type: PointerID

data/set/abstract/bookmarkable.rb

@@ -0,0 +1,42 @@
+card_accessor :bookmarkers, type: :search_type
+
+event :toggle_bookmark, :prepare_to_validate, on: :save, trigger: :required do
+  toggle_bookmarks_item
+  list = Card::Bookmark.current_list_card
+  if Auth.signed_in?
+    list.save!
+  else
+    # when using save!, session card was getting saved to db
+    list.store_in_session
+    abort :triumph
+  end
+end
+
+def currently_bookmarked?
+  Card::Bookmark.current_ids.include? id
+end
+
+format :html do
+  view :bookmark, wrap: :slot do
+    link_to_view :bookmark, field_nest(:bookmarkers, view: :toggle),
+                 path: { action: :update, card: { trigger: :toggle_bookmark } }
+  end
+
+  view :title_with_bookmark, template: :haml
+
+  view :box_top do
+    render :title_with_bookmark
+  end
+
+  view :bar_left do
+    render :title_with_bookmark
+  end
+end
+
+private
+
+def toggle_bookmarks_item
+  action = currently_bookmarked? ? :drop : :add
+  Card::Bookmark.current_list_card.send "#{action}_item", name
+  Card::Bookmark.clear
+end

data/set/abstract/title_with_bookmark.haml

@@ -0,0 +1,3 @@
+.title-with-bookmark
+  = render :bookmark
+  = render :title_link

data/set/right/account.rb

@@ -0,0 +1,6 @@
+event :save_session_bookmarks, :integrate, on: :create do
+  session_bookmark_card = Card[:anonymous].bookmarks_card
+  return if session_bookmark_card.item_names.blank?
+
+  left.add_subfield :bookmarks, type: :pointer, content: session_bookmark_card.content
+end

data/set/right/bookmarkers/toggle.haml

@@ -0,0 +1,5 @@
+.bookmark-toggle._stop_propagation{ class: bookmark_status_class }
+  = fa_icon "bookmark"
+  %span.bookmark-count
+    = count
+  // = modal_link count, class: "bookmark-count"

data/set/right/bookmarkers.rb

@@ -0,0 +1,17 @@
+# cache # of users who have bookmarked this metric/topic/whatever(=left)
+include_set Abstract::ListRefCachedCount,
+            type_to_count: :user,
+            list_field: :bookmarks,
+            count_trait: :bookmarkers
+
+def active?
+  left&.currently_bookmarked?
+end
+
+format :html do
+  view :toggle, cache: :never, template: :haml
+
+  def bookmark_status_class
+    card.active? ? "active-bookmark" : "inactive-bookmark"
+  end
+end

data/set/right/bookmarks.rb

@@ -0,0 +1,15 @@
+include_set Type::List
+include_set Abstract::IdPointer
+
+def history?
+  false
+end
+
+def followable?
+  false
+end
+
+def item_cards_of_type type
+  type_id = type.card_id
+  item_cards.select { |i| i.type_id == type_id }
+end

data/set/self/anonymous.rb

@@ -0,0 +1,7 @@
+# card_accessor :bookmarks, type: SessionID
+# accessor wasn't working, because
+#
+
+def bookmarks_card
+  @bookmarks_card ||= fetch(:bookmarks, new: { type_id: Card::SessionID })
+end

data/set/self/bookmarked.rb

@@ -0,0 +1,20 @@
+include_set Abstract::FollowOption
+
+restrictive_follow_opts position: 3
+
+follower_candidate_ids do |card|
+  Card.search({ right_plus: [:bookmarks, { refer_to: card.name }], return: :id },
+              "bookmarked follower candidate ids for #{card.name}")
+end
+
+def title
+  'Following content you bookmarked'
+end
+
+def label
+  'follow if I bookmarked'
+end
+
+def description set_card
+  "#{set_card.follow_label} I bookmarked"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-bookmarks
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Philipp Kühl
+- Ethan McCutchen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: card-mod-counts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: WikiRate.org is driving development on this to-be-generalized decko bookmarking
+  tool.
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/card/bookmark.rb
+- set/abstract/01_bookmarker.rb
+- set/abstract/accountable.rb
+- set/abstract/bookmarkable.rb
+- set/abstract/title_with_bookmark.haml
+- set/right/account.rb
+- set/right/bookmarkers.rb
+- set/right/bookmarkers/toggle.haml
+- set/right/bookmarks.rb
+- set/self/anonymous.rb
+- set/self/bookmarked.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: bookmarks
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: bookmarking on decko cards
+test_files: []