card-mod-history 0.11.0

data/lib/card/change.rb

@@ -0,0 +1,70 @@
+# -*- encoding : utf-8 -*-
+require 'activerecord-import'
+
+class Card
+  # A _change_ is an alteration to a card's name, type, content, or trash state.
+  # Together, {Act acts}, {Action actions}, and {Change changes} comprise a
+  # comprehensive {Card card} history tracking system.
+  #
+  # For example, if a given web submission changes both the name and type of
+  # card, that would be recorded as one {Action action} with two
+  # {Change changes}.
+  #
+  # A {Change} records:
+  #
+  # * the _field_ changed
+  # * the new _value_ of that field
+  # * the {Action action} of which the change is part
+  #
+  class Change < ApplicationRecord
+    belongs_to :action, foreign_key: :card_action_id,
+                        inverse_of: :card_changes
+
+    # lists the database fields for which changes are recorded
+    TRACKED_FIELDS = %w[name type_id db_content trash left_id right_id].freeze
+
+    class << self
+      # delete all {Change changes} not associated with an {Action action}
+      # (janitorial)
+      def delete_actionless
+        joins(
+          "LEFT JOIN card_actions "\
+          "ON card_changes.card_action_id = card_actions.id "
+        ).where(
+          "card_actions.id is null"
+        ).pluck_in_batches(:id) do |group_ids|
+          # used to be .delete_all here, but that was failing on large dbs
+          Rails.logger.info "deleting batch of changes"
+          where("id in (#{group_ids.join ','})").delete_all
+        end
+      end
+
+      # Change fields are recorded as integers. #field_index looks up the
+      # integer associated with a given field name.
+      # @param value [String, Symbol]
+      # @return [Integer]
+      def field_index value
+        value.is_a?(Integer) ? value : TRACKED_FIELDS.index(value.to_s)
+      end
+
+      # look up changes based on field name
+      # @param value [String, Symbol]
+      # @return [Change]
+      def find_by_field_name value
+        find_by_field field_index(value)
+      end
+    end
+
+    # set field value (integer)
+    # @param value [String, Symbol]
+    def field= value
+      write_attribute(:field, TRACKED_FIELDS.index(value.to_s))
+    end
+
+    # retrieve field name
+    # @return [String]
+    def field
+      TRACKED_FIELDS[read_attribute(:field)]
+    end
+  end
+end

data/set/all/history.rb

@@ -0,0 +1,109 @@
+event :update_ancestor_timestamps, :integrate do
+  ids = history_ancestor_ids
+  return unless ids.present?
+  Card.where(id: ids).update_all(updater_id: Auth.current_id, updated_at: Time.now)
+  ids.map { |anc_id| Card.expire anc_id.cardname }
+end
+
+# track history (acts, actions, changes) on this card
+def history?
+  true
+end
+
+# all cards whose acts are considered part of this card's history
+def history_card_ids
+  nestee_ids << id
+end
+
+# all cards who are considered updated if this card's was updated
+def history_parent_ids
+  nester_ids
+end
+
+def history_ancestor_ids recursion_level=0
+  return [] if recursion_level > 5
+
+  ids = history_parent_ids +
+    history_parent_ids.map { |id| Card[id].history_ancestor_ids(recursion_level + 1) }
+  ids.flatten
+end
+
+# ~~FIXME~~: optimize (no need to instantiate all actions and changes!)
+# Nothing is instantiated here. ActiveRecord is much smarter than you think.
+# Methods like #empty? and #size make sql queries if their receivers are not already
+# loaded -pk
+def first_change?
+  # = update or delete
+  @current_action.action_type != :create && action_count == 2 &&
+    create_action.card_changes.empty?
+end
+
+def first_create?
+  @current_action.action_type == :create && action_count == 1
+end
+
+def action_count
+  Card::Action.where(card_id: @current_action.card_id).count
+end
+
+# card has account that is responsible for prior acts
+def has_edits?
+  Card::Act.where(actor_id: id).where("card_id IS NOT NULL").present?
+end
+
+def changed_fields
+  Card::Change::TRACKED_FIELDS & (changed_attribute_names_to_save | saved_changes.keys)
+end
+
+def nestee_ids
+  requiring_id { @nestee_ids ||= nesting_ids(:referee_id, :referer_id) }
+end
+
+def nester_ids
+  requiring_id { @nester_ids ||= nesting_ids(:referer_id, :referee_id) }
+end
+
+def diff_args
+  { diff_format: :text }
+end
+
+# Delete all changes and old actions and make the last action the create action
+# (that way the changes for that action will be created with the first update)
+def make_last_action_the_initial_action
+  delete_all_changes
+  old_actions.delete_all
+  last_action.update! action_type: :create
+end
+
+def clear_history
+  delete_all_changes
+  delete_old_actions
+end
+
+def delete_old_actions
+  old_actions.delete_all
+end
+
+def delete_all_changes
+  Card::Change.where(card_action_id: all_action_ids).delete_all
+end
+
+def save_content_draft content
+  super
+  acts.create do |act|
+    act.ar_actions.build(draft: true, card_id: id, action_type: :update)
+       .card_changes.build(field: :db_content, value: content)
+  end
+end
+
+private
+
+def nesting_ids return_field, where_field
+  Card::Reference.select(return_field).distinct.where(
+    ref_type: "I", where_field => id
+  ).pluck(return_field).compact
+end
+
+def requiring_id
+  id ? yield : (return [])
+end

data/set/all/history/act_listing.rb

@@ -0,0 +1,124 @@
+ACTS_PER_PAGE = Card.config.acts_per_page
+
+format :html do
+  def act_from_context
+    if (act_id = params["act_id"])
+      Act.find(act_id) || raise(Card::NotFound, "act not found")
+    else
+      card.last_action.act
+    end
+  end
+
+  # used (by history and recent)for rendering act lists with legend and paging
+  #
+  # @param acts [ActiveRecord::Relation] relation that will return acts objects
+  # @param context [Symbol] :relative or :absolute
+  # @param draft_legend [Symbol] :show or :hide
+  def acts_layout acts, context, draft_legend=:hide
+    bs_layout container: false, fluid: false do
+      html _render_act_legend(draft_legend => :draft_legend)
+      row(12) { act_list acts, context }
+      row(12) { act_paging acts, context }
+    end
+  end
+
+  def act_list acts, context
+    act_accordion acts, context do |act, seq|
+      fmt = context == :relative ? self : act.card.format(:html)
+      fmt.act_listing act, seq, context
+    end
+  end
+
+  def act_listing act, seq=nil, context=nil
+    opts = act_listing_opts_from_params(seq)
+    opts[:slot_class] = "revision-#{act.id} history-slot list-group-item"
+    context ||= (params[:act_context] || :absolute).to_sym
+    act_renderer(context).new(self, act, opts).render
+  end
+
+  # TODO: consider putting all these under one top-level param, eg:
+  # act: { seq: X, diff: [show/hide], action_view: Y }
+  def act_listing_opts_from_params seq
+    { act_seq: (seq || params["act_seq"]),
+      action_view: (params["action_view"] || "summary").to_sym,
+      hide_diff: params["hide_diff"].to_s.strip == "true" }
+  end
+
+  def act_accordion acts, context, &block
+    accordion_group acts_for_accordion(acts, context, &block), nil, class: "clear-both"
+  end
+
+  def acts_for_accordion acts, context
+    clean_acts(current_page_acts(acts)).map do |act|
+      with_act_seq(context, acts) do |seq|
+        yield act, seq
+      end
+    end
+  end
+
+  def with_act_seq context, acts
+    yield(context == :absolute ? nil : current_act_seq(acts))
+  end
+
+  def current_act_seq acts
+    @act_seq = @act_seq ? (@act_seq -= 1) : act_list_starting_seq(acts)
+  end
+
+  def clean_acts acts
+    # FIXME: if we get rid of bad act data, this will not be necessary
+    # The current
+    acts.select(&:card)
+  end
+
+  def current_page_acts acts
+    acts.page(acts_page_from_params).per acts_per_page
+  end
+
+  def act_list_starting_seq acts
+    acts.size - (acts_page_from_params - 1) * acts_per_page
+  end
+
+  def acts_per_page
+    @acts_per_page || ACTS_PER_PAGE
+  end
+
+  def acts_page_from_params
+    @acts_page_from_params ||= params["page"].present? ? params["page"].to_i : 1
+  end
+
+  def act_paging acts, context
+    wrap_with :div, class: "slotter btn-sm" do
+      acts = current_page_acts acts
+      opts = { remote: true, theme: "twitter-bootstrap-4" }
+      opts[:total_pages] = 10 if limited_paging? context
+      paginate acts, opts
+    end
+  end
+
+  def limited_paging? context
+    context == :absolute && Act.count > 1000
+  end
+
+  def action_icon action_type, extra_class=nil
+    icon = case action_type
+           when :create then :add_circle
+           when :update then :pencil
+           when :delete then :remove_circle
+           when :draft then :wrench
+           end
+    icon_tag icon, extra_class
+  end
+
+  private
+
+  def act_renderer context
+    case context
+    when :absolute
+      Act::ActRenderer::AbsoluteActRenderer
+    when :bridge
+      Act::ActRenderer::BridgeActRenderer
+    else # relative
+      Act::ActRenderer::RelativeActRenderer
+    end
+  end
+end

data/set/all/history/actions.rb

@@ -0,0 +1,124 @@
+# -*- encoding : utf-8 -*-
+
+def all_action_ids
+  Card::Action.where(card_id: id).pluck :id
+end
+
+def action_from_id action_id
+  return unless action_id.is_a?(Integer) || action_id =~ /^\d+$/
+
+  # if not an integer revision id is probably a mod (e.g. if you request
+  # files/:logo/standard.png)
+  action = Action.fetch action_id
+  return unless action.card_id == id
+
+  action
+end
+
+def old_actions
+  actions.where("id != ?", last_action_id)
+end
+
+def create_action
+  @create_action ||= actions.first
+end
+
+def nth_action index
+  index = index.to_i
+  return unless id && index.positive?
+
+  Action.where("draft is not true AND card_id = #{id}")
+        .order(:id).limit(1).offset(index - 1).first
+end
+
+def new_content_action_id
+  return unless @current_action && current_action_changes_content?
+
+  @current_action.id
+end
+
+def current_action_changes_content?
+  new_card? || @current_action.new_content? || db_content_is_changing?
+end
+
+format :html do
+  def action_from_context
+    if (action_id = voo.action_id || params[:action_id])
+      Action.fetch action_id
+    else
+      card.last_action
+    end
+  end
+
+  def action_content action, view_type
+    return "" unless action.present?
+
+    wrap do
+      [action_content_toggle(action, view_type),
+       content_diff(action, view_type)]
+    end
+  end
+
+  def content_diff action, view_type
+    diff = action.new_content? && content_changes(action, view_type)
+    return "<i>empty</i>" unless diff.present?
+
+    diff
+  end
+
+  def action_content_toggle action, view_type
+    return unless show_action_content_toggle?(action, view_type)
+
+    toggle_action_content_link action, view_type
+  end
+
+  def show_action_content_toggle? action, view_type
+    view_type == :expanded || action.summary_diff_omits_content?
+  end
+
+  def toggle_action_content_link action, view_type
+    other_view_type = view_type == :expanded ? :summary : :expanded
+    css_class = "revision-#{action.card_act_id} float-right"
+    link_to_view "action_#{other_view_type}",
+                 icon_tag(action_arrow_dir(view_type), class: "md-24"),
+                 class: css_class,
+                 path: { action_id: action.id, look_in_trash: true }
+  end
+
+  def action_arrow_dir view_type
+    view_type == :expanded ? :triangle_left : :triangle_right
+  end
+
+  def revert_actions_link link_text, path_args, html_args={}
+    return unless card.ok? :update
+
+    path_args.reverse_merge! action: :update, look_in_trash: true, assign: true,
+                             card: { skip: :validate_renaming }
+    html_args.reverse_merge! remote: true, method: :post, rel: "nofollow", path: path_args
+    add_class html_args, "slotter"
+    link_to link_text, html_args
+  end
+
+  def action_legend
+    types = %i[create update delete]
+    legend = types.map do |action_type|
+      "#{action_icon(action_type)} #{action_type}d"
+    end
+    legend << _render_draft_legend if voo.show?(:draft_legend)
+    "<small>Actions: #{legend.join ' | '}</small>"
+  end
+
+  def content_legend
+    legend = [Card::Content::Diff.render_added_chunk("Additions"),
+              Card::Content::Diff.render_deleted_chunk("Subtractions")]
+    "<small>Content changes: #{legend.join ' | '}</small>"
+  end
+
+  def content_changes action, diff_type, hide_diff=false
+    if hide_diff
+      action.raw_view
+    else
+      action.content_diff diff_type
+    end
+  end
+end

data/set/all/history/acts.rb

@@ -0,0 +1,8 @@
+# all acts with actions on self and on cards included in self (ie, acts shown in history)
+def history_acts
+  @history_acts ||= Act.all_with_actions_on(history_card_ids, true).order id: :desc
+end
+
+def draft_acts
+  drafts.created_by(Card::Auth.current_id).map(&:act)
+end

data/set/all/history/events.rb

@@ -0,0 +1,100 @@
+# must be called on all actions and before :set_name, :process_subcards and
+# :validate_delete_children
+event :assign_action, :initialize, when: :actionable? do
+  act = director.need_act
+  @current_action = Card::Action.create(
+    card_act_id: act.id,
+    action_type: action,
+    draft: (Env.params["draft"] == "true")
+  )
+  if @supercard && @supercard != self
+    @current_action.super_action = @supercard.current_action
+  end
+end
+
+# can we store an action? (can be overridden, eg in files)
+def actionable?
+  history?
+end
+
+event :detect_conflict, :validate, on: :update, when: :edit_conflict? do
+  errors.add :conflict, tr(:error_not_latest_revision)
+end
+
+def edit_conflict?
+  last_action_id_before_edit &&
+    last_action_id_before_edit.to_i != last_action_id &&
+    (la = last_action) &&
+    la.act.actor_id != Auth.current_id
+end
+
+# stores changes in the changes table and assigns them to the current action
+# removes the action if there are no changes
+event :finalize_action, :finalize, when: :finalize_action? do
+  if changed_fields.present?
+    @current_action.update! card_id: id
+
+    # Note: #last_change_on uses the id to sort by date
+    # so the changes for the create changes have to be created before the first change
+    store_card_changes_for_create_action if first_change?
+    store_card_changes unless first_create?
+    # FIXME: a `@current_action.card` call here breaks specs in solid_cache_spec.rb
+  elsif @current_action.card_changes.reload.empty?
+    @current_action.delete
+    @current_action = nil
+  end
+end
+
+# changes for the create action are stored after the first update
+def store_card_changes_for_create_action
+  Card::Action.cache.delete "#{create_action.id}-changes"
+  store_each_history_field create_action.id do |field|
+    attribute_before_act field
+  end
+end
+
+def store_card_changes
+  store_each_history_field @current_action.id, changed_fields do |field|
+    self[field]
+  end
+end
+
+def store_each_history_field action_id, fields=nil
+  fields ||= Card::Change::TRACKED_FIELDS
+  if false # Card::Change.supports_import?
+    # attach.feature fails with this
+    values = fields.map.with_index { |field, index| [index, yield(field), action_id] }
+    Card::Change.import [:field, :value, :card_action_id], values #, validate: false
+  else
+    fields.each do |field|
+      Card::Change.create field: field,
+                          value: yield(field),
+                          card_action_id: action_id
+    end
+  end
+end
+
+def finalize_action?
+  actionable? && current_action
+end
+
+event :rollback_actions, :prepare_to_validate, on: :update, when: :rollback_request? do
+  update_args = process_revert_actions
+  Env.params["revert_actions"] = nil
+  update! update_args
+  clear_drafts
+  abort :success
+end
+
+event :finalize_act, after: :finalize_action, when: :act_card? do
+  Card::Director.act.update! card_id: id
+end
+
+event :remove_empty_act, :integrate_with_delay_final, when: :remove_empty_act? do
+  # Card::Director.act.delete
+  # Card::Director.act = nil
+end
+
+def remove_empty_act?
+  act_card? && Director.act&.ar_actions&.reload&.empty?
+end