vote_fu 0.0.11 → 2.0.1

data/app/javascript/vote_fu/controllers/vote_fu_reactions_controller.js

@@ -0,0 +1,92 @@
+import { Controller } from "@hotwired/stimulus"
+
+/**
+ * Reactions Stimulus Controller
+ *
+ * Handles emoji reaction interactions with optimistic updates.
+ */
+export default class extends Controller {
+  static targets = ["reaction", "addButton", "picker"]
+
+  static values = {
+    voteableType: String,
+    voteableId: Number,
+    allowMultiple: { type: Boolean, default: true }
+  }
+
+  connect() {
+    this.pickerVisible = false
+  }
+
+  /**
+   * Toggle a reaction
+   */
+  toggle(event) {
+    const form = event.target.closest("form")
+    const scope = form.querySelector("[name='scope']")?.value
+    const button = form.querySelector("button")
+
+    if (!button) return
+
+    const isActive = button.classList.contains("vote-fu-reaction--active")
+
+    // Optimistic update
+    if (isActive) {
+      this.removeReaction(button, scope)
+    } else {
+      this.addReaction(button, scope)
+    }
+  }
+
+  /**
+   * Add reaction (optimistic)
+   */
+  addReaction(button, scope) {
+    button.classList.add("vote-fu-reaction--active")
+    button.closest(".vote-fu-reaction-wrapper")?.classList.add("vote-fu-reaction-wrapper--active")
+
+    // Update count
+    const countEl = button.querySelector(".vote-fu-reaction-count")
+    if (countEl) {
+      const count = parseInt(countEl.textContent, 10) || 0
+      countEl.textContent = count + 1
+    }
+  }
+
+  /**
+   * Remove reaction (optimistic)
+   */
+  removeReaction(button, scope) {
+    button.classList.remove("vote-fu-reaction--active")
+    button.closest(".vote-fu-reaction-wrapper")?.classList.remove("vote-fu-reaction-wrapper--active")
+
+    // Update count
+    const countEl = button.querySelector(".vote-fu-reaction-count")
+    if (countEl) {
+      const count = parseInt(countEl.textContent, 10) || 0
+      countEl.textContent = Math.max(0, count - 1)
+    }
+  }
+
+  /**
+   * Show reaction picker
+   */
+  showPicker(event) {
+    // Emit custom event for apps to handle their own picker UI
+    this.dispatch("showPicker", {
+      detail: {
+        voteableType: this.voteableTypeValue,
+        voteableId: this.voteableIdValue,
+        target: event.target
+      }
+    })
+  }
+
+  /**
+   * Hide reaction picker
+   */
+  hidePicker() {
+    this.pickerVisible = false
+    this.dispatch("hidePicker")
+  }
+}

data/app/javascript/vote_fu/controllers/vote_fu_stars_controller.js

@@ -0,0 +1,77 @@
+import { Controller } from "@hotwired/stimulus"
+
+/**
+ * Star Rating Stimulus Controller
+ *
+ * Handles star rating interactions with optimistic updates.
+ */
+export default class extends Controller {
+  static targets = ["star"]
+
+  static values = {
+    voteableType: String,
+    voteableId: Number,
+    scope: String,
+    currentRating: Number,
+    maxStars: { type: Number, default: 5 }
+  }
+
+  connect() {
+    this.originalRating = this.currentRatingValue
+    this.hoverRating = 0
+  }
+
+  /**
+   * Handle star hover
+   */
+  hover(event) {
+    const starValue = parseInt(event.target.dataset.starValue, 10)
+    this.hoverRating = starValue
+    this.updateStarDisplay(starValue)
+  }
+
+  /**
+   * Handle mouse leave
+   */
+  leave() {
+    this.hoverRating = 0
+    this.updateStarDisplay(this.currentRatingValue)
+  }
+
+  /**
+   * Handle rating submission
+   */
+  rate(event) {
+    const form = event.target.closest("form")
+    const starValue = parseInt(form.querySelector("[name='value']").value, 10)
+
+    // Optimistic update
+    this.currentRatingValue = starValue
+    this.updateStarDisplay(starValue)
+  }
+
+  /**
+   * Update star visual display
+   */
+  updateStarDisplay(rating) {
+    this.starTargets.forEach((star) => {
+      const starValue = parseInt(star.dataset.starValue, 10)
+      const isFilled = starValue <= rating
+
+      star.classList.toggle("vote-fu-star-filled", isFilled)
+
+      // Update star character if using text content
+      if (star.tagName === "BUTTON") {
+        star.textContent = isFilled ? "★" : "☆"
+      }
+    })
+  }
+
+  /**
+   * Reset to original state (on error)
+   */
+  reset() {
+    this.currentRatingValue = this.originalRating
+    this.updateStarDisplay(this.originalRating)
+  }
+}

data/app/models/vote_fu/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module VoteFu
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/vote_fu/vote.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module VoteFu
+  class Vote < ApplicationRecord
+    self.table_name = "vote_fu_votes"
+
+    # Associations
+    belongs_to :voter, polymorphic: true
+    belongs_to :voteable, polymorphic: true
+
+    # Validations
+    validates :value, presence: true, numericality: { only_integer: true }
+    validates :voter_id, uniqueness: {
+      scope: %i[voter_type voteable_id voteable_type scope],
+      message: "has already voted on this item"
+    }, unless: :allow_duplicate_votes?
+
+    # Scopes
+    scope :up, -> { where(value: 1..) }
+    scope :down, -> { where(value: ..0) }
+    scope :with_scope, ->(s) { s.present? ? where(scope: s) : where(scope: nil) }
+    scope :for_voter, ->(voter) { where(voter: voter) }
+    scope :for_voteable, ->(voteable) { where(voteable: voteable) }
+    scope :recent, ->(since = 2.weeks.ago) { where(created_at: since..) }
+    scope :chronological, -> { order(created_at: :desc) }
+    scope :by_value, -> { order(value: :desc) }
+
+    # Callbacks for counter cache
+    after_create :increment_voteable_counters
+    after_update :update_voteable_counters, if: :saved_change_to_value?
+    after_destroy :decrement_voteable_counters
+
+    # Callbacks for broadcasts
+    after_commit :broadcast_vote_change, if: :broadcasts_enabled?
+
+    # Instance methods
+    def up?
+      value.positive?
+    end
+
+    def down?
+      value.negative?
+    end
+
+    def direction
+      return :up if up?
+      return :down if down?
+
+      :neutral
+    end
+
+    private
+
+    def allow_duplicate_votes?
+      VoteFu.configuration.allow_duplicate_votes
+    end
+
+    def broadcasts_enabled?
+      VoteFu.configuration.turbo_broadcasts && defined?(Turbo::StreamsChannel)
+    end
+
+    def increment_voteable_counters
+      return unless VoteFu.configuration.counter_cache
+      return unless voteable.respond_to?(:increment_vote_counters)
+
+      voteable.increment_vote_counters(value)
+    end
+
+    def update_voteable_counters
+      return unless VoteFu.configuration.counter_cache
+      return unless voteable.respond_to?(:update_vote_counters)
+
+      old_value = value_before_last_save
+      voteable.update_vote_counters(old_value, value)
+    end
+
+    def decrement_voteable_counters
+      return unless VoteFu.configuration.counter_cache
+      return unless voteable.respond_to?(:decrement_vote_counters)
+
+      voteable.decrement_vote_counters(value)
+    end
+
+    def broadcast_vote_change
+      return unless voteable.respond_to?(:broadcast_vote_update)
+
+      voteable.broadcast_vote_update
+    end
+  end
+end

data/app/views/vote_fu/votes/_count.html.erb

@@ -0,0 +1,29 @@
+<%#
+  Vote Count Partial
+
+  Required locals:
+    - voteable: The voteable record
+
+  Optional locals:
+    - scope: Vote scope (default: nil)
+    - format: Display format - :plusminus, :total, :percentage (default: :plusminus)
+%>
+<%
+  scope ||= nil
+  format = local_assigns.fetch(:format, :plusminus)
+  scope_suffix = scope.present? ? "_#{scope}" : ""
+  dom_id_base = "vote_fu_#{voteable.model_name.singular}_#{voteable.id}#{scope_suffix}"
+
+  value = case format
+          when :total then voteable.votes_total(scope: scope)
+          when :percentage then "#{voteable.percent_for(scope: scope)}%"
+          when :split then "+#{voteable.votes_for(scope: scope)} / -#{voteable.votes_against(scope: scope)}"
+          else voteable.plusminus(scope: scope)
+          end
+%>
+
+<span id="<%= dom_id_base %>_count"
+      class="vote-fu-count"
+      data-vote-fu-target="count">
+  <%= value %>
+</span>

data/app/views/vote_fu/votes/_downvote_button.html.erb

@@ -0,0 +1,40 @@
+<%#
+  Standalone Downvote Button Partial
+
+  Required locals:
+    - voteable: The voteable record
+
+  Optional locals:
+    - voter: The current voter
+    - scope: Vote scope (default: nil)
+    - label: Button label (default: "▼")
+    - class: Additional CSS classes
+%>
+<%
+  scope ||= nil
+  voter ||= nil
+  label = local_assigns.fetch(:label, "▼")
+  css_class = local_assigns.fetch(:class, "")
+
+  vote = voter ? voteable.received_votes.find_by(voter: voter, scope: scope) : nil
+  voted_down = vote&.down?
+%>
+
+<% if voter %>
+  <%= form_with url: vote_fu.toggle_votes_path, method: :post, data: { turbo_stream: true } do |f| %>
+    <%= f.hidden_field :voteable_type, value: voteable.class.name %>
+    <%= f.hidden_field :voteable_id, value: voteable.id %>
+    <%= f.hidden_field :scope, value: scope %>
+    <%= f.hidden_field :direction, value: :down %>
+
+    <button type="submit"
+            class="vote-fu-btn vote-fu-downvote <%= "vote-fu-active" if voted_down %> <%= css_class %>"
+            title="<%= voted_down ? "Remove downvote" : "Downvote" %>">
+      <%= label %>
+    </button>
+  <% end %>
+<% else %>
+  <span class="vote-fu-btn vote-fu-downvote vote-fu-disabled <%= css_class %>">
+    <%= label %>
+  </span>
+<% end %>

data/app/views/vote_fu/votes/_error.html.erb

@@ -0,0 +1,9 @@
+<%#
+  Vote Error Partial
+
+  Required locals:
+    - message: The error message
+%>
+<div class="vote-fu-error" role="alert">
+  <%= message %>
+</div>

data/app/views/vote_fu/votes/_like_button.html.erb

@@ -0,0 +1,67 @@
+<%#
+  Like Button Partial (Single Button Style)
+
+  For simple "like" functionality without downvotes.
+
+  Required locals:
+    - voteable: The voteable record
+
+  Optional locals:
+    - voter: The current voter
+    - scope: Vote scope (default: nil)
+    - liked_label: Button label when liked (default: "♥")
+    - unliked_label: Button label when not liked (default: "♡")
+    - show_count: Whether to show like count (default: true)
+    - class: Additional CSS classes
+%>
+<%
+  scope ||= nil
+  voter ||= nil
+  liked_label = local_assigns.fetch(:liked_label, "♥")
+  unliked_label = local_assigns.fetch(:unliked_label, "♡")
+  show_count = local_assigns.fetch(:show_count, true)
+  css_class = local_assigns.fetch(:class, "")
+
+  vote = voter ? voteable.received_votes.find_by(voter: voter, scope: scope) : nil
+  liked = vote&.up?
+  like_count = voteable.votes_for(scope: scope)
+
+  scope_suffix = scope.present? ? "_#{scope}" : ""
+  dom_id_base = "vote_fu_#{voteable.model_name.singular}_#{voteable.id}#{scope_suffix}"
+%>
+
+<div id="<%= dom_id_base %>_widget"
+     class="vote-fu-like-widget <%= "vote-fu-liked" if liked %> <%= css_class %>"
+     data-controller="vote-fu"
+     data-vote-fu-voteable-type-value="<%= voteable.class.name %>"
+     data-vote-fu-voteable-id-value="<%= voteable.id %>"
+     data-vote-fu-scope-value="<%= scope %>">
+
+  <% if voter %>
+    <%= form_with url: vote_fu.toggle_votes_path, method: :post, data: { turbo_stream: true, action: "submit->vote-fu#vote" } do |f| %>
+      <%= f.hidden_field :voteable_type, value: voteable.class.name %>
+      <%= f.hidden_field :voteable_id, value: voteable.id %>
+      <%= f.hidden_field :scope, value: scope %>
+      <%= f.hidden_field :direction, value: :up %>
+
+      <button type="submit"
+              class="vote-fu-btn vote-fu-like <%= "vote-fu-active" if liked %>"
+              data-vote-fu-target="likeBtn"
+              title="<%= liked ? "Unlike" : "Like" %>">
+        <%= liked ? liked_label : unliked_label %>
+      </button>
+    <% end %>
+  <% else %>
+    <span class="vote-fu-btn vote-fu-like vote-fu-disabled">
+      <%= unliked_label %>
+    </span>
+  <% end %>
+
+  <% if show_count %>
+    <span id="<%= dom_id_base %>_count"
+          class="vote-fu-count"
+          data-vote-fu-target="count">
+      <%= like_count %>
+    </span>
+  <% end %>
+</div>

data/app/views/vote_fu/votes/_upvote_button.html.erb

@@ -0,0 +1,40 @@
+<%#
+  Standalone Upvote Button Partial
+
+  Required locals:
+    - voteable: The voteable record
+
+  Optional locals:
+    - voter: The current voter
+    - scope: Vote scope (default: nil)
+    - label: Button label (default: "▲")
+    - class: Additional CSS classes
+%>
+<%
+  scope ||= nil
+  voter ||= nil
+  label = local_assigns.fetch(:label, "▲")
+  css_class = local_assigns.fetch(:class, "")
+
+  vote = voter ? voteable.received_votes.find_by(voter: voter, scope: scope) : nil
+  voted_up = vote&.up?
+%>
+
+<% if voter %>
+  <%= form_with url: vote_fu.toggle_votes_path, method: :post, data: { turbo_stream: true } do |f| %>
+    <%= f.hidden_field :voteable_type, value: voteable.class.name %>
+    <%= f.hidden_field :voteable_id, value: voteable.id %>
+    <%= f.hidden_field :scope, value: scope %>
+    <%= f.hidden_field :direction, value: :up %>
+
+    <button type="submit"
+            class="vote-fu-btn vote-fu-upvote <%= "vote-fu-active" if voted_up %> <%= css_class %>"
+            title="<%= voted_up ? "Remove upvote" : "Upvote" %>">
+      <%= label %>
+    </button>
+  <% end %>
+<% else %>
+  <span class="vote-fu-btn vote-fu-upvote vote-fu-disabled <%= css_class %>">
+    <%= label %>
+  </span>
+<% end %>

data/app/views/vote_fu/votes/_widget.html.erb

@@ -0,0 +1,85 @@
+<%#
+  Vote Widget Partial
+
+  Required locals:
+    - voteable: The voteable record
+    - voter: The current voter (can be nil)
+
+  Optional locals:
+    - scope: Vote scope (default: nil)
+    - action: The action that just occurred (:created, :updated, :removed)
+    - show_count: Whether to show vote count (default: true)
+    - upvote_label: Custom upvote label (default: "▲")
+    - downvote_label: Custom downvote label (default: "▼")
+%>
+<%
+  scope ||= nil
+  action ||= nil
+  show_count = local_assigns.fetch(:show_count, true)
+  upvote_label = local_assigns.fetch(:upvote_label, "▲")
+  downvote_label = local_assigns.fetch(:downvote_label, "▼")
+
+  vote = voter ? voteable.received_votes.find_by(voter: voter, scope: scope) : nil
+  voted_up = vote&.up?
+  voted_down = vote&.down?
+
+  scope_suffix = scope.present? ? "_#{scope}" : ""
+  dom_id_base = "vote_fu_#{voteable.model_name.singular}_#{voteable.id}#{scope_suffix}"
+%>
+
+<div id="<%= dom_id_base %>_widget"
+     class="vote-fu-widget <%= "vote-fu-voted-up" if voted_up %> <%= "vote-fu-voted-down" if voted_down %>"
+     data-controller="vote-fu"
+     data-vote-fu-voteable-type-value="<%= voteable.class.name %>"
+     data-vote-fu-voteable-id-value="<%= voteable.id %>"
+     data-vote-fu-scope-value="<%= scope %>"
+     data-vote-fu-voted-value="<%= vote.present? %>"
+     data-vote-fu-direction-value="<%= vote&.direction %>">
+
+  <% if voter %>
+    <%= form_with url: vote_fu.toggle_votes_path, method: :post, data: { turbo_stream: true, action: "submit->vote-fu#vote" } do |f| %>
+      <%= f.hidden_field :voteable_type, value: voteable.class.name %>
+      <%= f.hidden_field :voteable_id, value: voteable.id %>
+      <%= f.hidden_field :scope, value: scope %>
+      <%= f.hidden_field :direction, value: :up %>
+
+      <button type="submit"
+              class="vote-fu-btn vote-fu-upvote <%= "vote-fu-active" if voted_up %>"
+              data-vote-fu-target="upvoteBtn"
+              title="<%= voted_up ? "Remove upvote" : "Upvote" %>">
+        <%= upvote_label %>
+      </button>
+    <% end %>
+
+    <% if show_count %>
+      <span id="<%= dom_id_base %>_count"
+            class="vote-fu-count"
+            data-vote-fu-target="count">
+        <%= voteable.plusminus(scope: scope) %>
+      </span>
+    <% end %>
+
+    <%= form_with url: vote_fu.toggle_votes_path, method: :post, data: { turbo_stream: true, action: "submit->vote-fu#vote" } do |f| %>
+      <%= f.hidden_field :voteable_type, value: voteable.class.name %>
+      <%= f.hidden_field :voteable_id, value: voteable.id %>
+      <%= f.hidden_field :scope, value: scope %>
+      <%= f.hidden_field :direction, value: :down %>
+
+      <button type="submit"
+              class="vote-fu-btn vote-fu-downvote <%= "vote-fu-active" if voted_down %>"
+              data-vote-fu-target="downvoteBtn"
+              title="<%= voted_down ? "Remove downvote" : "Downvote" %>">
+        <%= downvote_label %>
+      </button>
+    <% end %>
+  <% else %>
+    <%# Guest view - no voting buttons, just count %>
+    <span class="vote-fu-btn vote-fu-upvote vote-fu-disabled"><%= upvote_label %></span>
+    <% if show_count %>
+      <span id="<%= dom_id_base %>_count" class="vote-fu-count">
+        <%= voteable.plusminus(scope: scope) %>
+      </span>
+    <% end %>
+    <span class="vote-fu-btn vote-fu-downvote vote-fu-disabled"><%= downvote_label %></span>
+  <% end %>
+</div>

data/config/importmap.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# VoteFu JavaScript imports
+pin_all_from VoteFu::Engine.root.join("app/javascript/vote_fu/controllers"),
+             under: "vote_fu/controllers",
+             to: "vote_fu/controllers"

data/config/routes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+VoteFu::Engine.routes.draw do
+  resources :votes, only: %i[create update destroy] do
+    collection do
+      post :toggle
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module VoteFu
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install VoteFu: creates initializer and migration"
+
+      def create_initializer
+        template "initializer.rb", "config/initializers/vote_fu.rb"
+      end
+
+      def create_migration
+        migration_template(
+          "migration.rb.erb",
+          "db/migrate/create_vote_fu_votes.rb"
+        )
+      end
+
+      def show_post_install_message
+        say ""
+        say "VoteFu installed successfully!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Run migrations: rails db:migrate"
+        say "  2. Add to your models:"
+        say ""
+        say "     class Post < ApplicationRecord"
+        say "       acts_as_voteable"
+        say "     end"
+        say ""
+        say "     class User < ApplicationRecord"
+        say "       acts_as_voter"
+        say "     end"
+        say ""
+        say "  3. Start voting:"
+        say "     user.upvote(post)"
+        say "     user.downvote(post)"
+        say "     post.plusminus"
+        say ""
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# VoteFu Configuration
+#
+# For more information, see: https://github.com/peteonrails/vote_fu
+
+VoteFu.configure do |config|
+  # Allow voters to change their vote after casting
+  # Default: true
+  # config.allow_recast = true
+
+  # Allow multiple votes from the same voter on the same item
+  # Default: false
+  # config.allow_duplicate_votes = false
+
+  # Allow a model to vote on itself (if it's both voter and voteable)
+  # Default: false
+  # config.allow_self_vote = false
+
+  # Automatically maintain counter cache columns on voteables
+  # Requires: votes_count, votes_total, upvotes_count, downvotes_count columns
+  # Default: true
+  # config.counter_cache = true
+
+  # Broadcast vote changes via Turbo Streams
+  # Default: true
+  # config.turbo_broadcasts = true
+
+  # Use ActionCable for real-time updates
+  # Default: true
+  # config.action_cable = true
+
+  # Default ranking algorithm for voteables
+  # Options: :wilson_score, :reddit_hot, :hacker_news, :simple
+  # Default: :wilson_score
+  # config.default_ranking = :wilson_score
+
+  # Gravity parameter for Reddit Hot and Hacker News algorithms
+  # Higher values = faster decay
+  # Default: 1.8
+  # config.hot_ranking_gravity = 1.8
+end