card-mod-history 0.11.0

data/set/all/history/last.rb

@@ -0,0 +1,98 @@
+def acted_at
+  last_act.acted_at
+end
+
+def revised_at
+  (last_action && (act = last_action.act) && act.acted_at) || Time.zone.now
+end
+
+def last_change_on field, opts={}
+  action_id = extract_action_id(opts[:before] || opts[:not_after])
+
+  # If there is only one action then there are no entries in the changes table,
+  # so we can't do a sql search but the changes are accessible via the action.
+  if no_last_change? action_id, opts[:before]
+    nil
+  elsif create_action_last_change? action_id
+    create_action&.change field
+  else
+    last_change_from_action_id action_id, field, opts
+  end
+end
+
+def no_last_change? action_id, before
+  before && action_id == create_action.id
+end
+
+def create_action_last_change? action_id
+  action_id == create_action&.id || (!action_id && create_action&.sole?)
+end
+
+def last_change_from_action_id action_id, field, opts
+  Change.joins(:action).where(
+    last_change_sql_conditions(opts),
+    card_id: id,
+    action_id: action_id,
+    field: Card::Change.field_index(field)
+  ).order(:id).last
+end
+
+def last_change_sql_conditions opts
+  cond = "card_actions.card_id = :card_id AND field = :field"
+  cond += " AND (draft is not true)" unless opts[:including_drafts]
+  operator = "<" if opts[:before]
+  operator = "<=" if opts[:not_after]
+  cond += " AND card_action_id #{operator} :action_id" if operator
+  cond
+end
+
+def last_action_id
+  last_action&.id
+end
+
+def last_action
+  actions.where("id IS NOT NULL").last
+end
+
+def last_content_action
+  last_change_on(:db_content)&.action
+end
+
+def last_content_action_id
+  last_change_on(:db_content)&.card_action_id
+end
+
+def last_actor
+  last_act.actor
+end
+
+def last_act
+  @last_act ||=
+    if (action = last_action)
+      last_act_on_self = acts.last
+      act_of_last_action = action.act
+      return act_of_last_action unless last_act_on_self
+      return last_act_on_self unless act_of_last_action
+
+      return last_act_on_self if act_of_last_action == last_act_on_self
+
+      if last_act_on_self.acted_at > act_of_last_action.acted_at
+        last_act_on_self
+      else
+        act_of_last_action
+      end
+    end
+end
+
+def previous_action action_id
+  return unless action_id
+
+  action_index = actions.find_index { |a| a.id == action_id }
+  all_actions[action_index - 1] if action_index.to_i.nonzero?
+end
+
+private
+
+def extract_action_id action_arg
+  action_arg.is_a?(Card::Action) ? action_arg.id : action_arg
+end

data/set/all/history/revision.rb

@@ -0,0 +1,65 @@
+def revision action, before_action=false
+  # a "revision" refers to the state of all tracked fields
+  # at the time of a given action
+  action = Card::Action.fetch(action) if action.is_a? Integer
+  return unless action
+
+  if before_action
+    revision_before_action action
+  else
+    revision_attributes action
+  end
+end
+
+def revision_attributes action
+  Card::Change::TRACKED_FIELDS.each_with_object({}) do |field, attr_changes|
+    last_change = action.change(field) || last_change_on(field, not_after: action)
+    attr_changes[field.to_sym] = (last_change ? last_change.value : self[field])
+  end
+end
+
+def revision_before_action action
+  if (prev_action = action.previous_action)
+    revision prev_action
+  else
+    { trash: true }
+  end
+end
+
+def rollback_request?
+  history? && actions_to_revert.any?
+end
+
+def process_revert_actions revert_actions=nil
+  revert_actions ||= actions_to_revert
+  update_args = { subcards: {} }
+  reverting_to_previous = Env.params["revert_to"] == "previous"
+  revert_actions.each do |action|
+    merge_revert_action! action, update_args, reverting_to_previous
+  end
+  update_args
+end
+
+def actions_to_revert
+  if (act_id = Env.params["revert_act"])
+    Act.find(act_id).actions
+  else
+    explicit_actions_to_revert
+  end
+end
+
+def explicit_actions_to_revert
+  Array.wrap(Env.params["revert_actions"]).map do |a_id|
+    Action.fetch(a_id) || nil
+  end.compact
+end
+
+def merge_revert_action! action, update_args, reverting_to_previous
+  rev = action.card.revision(action, reverting_to_previous)
+  rev.delete :name unless rev[:name] # handles null name field in compound cards
+  if action.card_id == id
+    update_args.merge! rev
+  else
+    update_args[:subcards][action.card.name] = rev
+  end
+end

data/set/all/history/selected.rb

@@ -0,0 +1,64 @@
+# if these aren't in a nested module, the methods just overwrite the base
+#  methods, but we need a distinct module so that super will be able to refer to
+# the base methods.
+def content
+  @selected_action_id ? selected_content : super
+end
+
+def content= value
+  @selected_content = nil
+  super
+end
+
+def select_action_by_params params
+  action = nth_action(params[:rev]) || action_from_id(params[:rev_id])
+  return unless action
+
+  select_action action.id
+end
+
+def select_action action_id
+  run_callbacks :select_action do
+    self.selected_action_id = action_id
+  end
+end
+
+def selected_action_id
+  @selected_action_id || (@current_action&.id) || last_action_id
+end
+
+def selected_action_id= action_id
+  @selected_content = nil
+  @selected_action_id = action_id
+end
+
+def selected_action
+  selected_action_id && Action.fetch(selected_action_id)
+end
+
+def selected_content
+  @selected_content ||= content_at_time_of_selected_action || db_content
+end
+
+def content_at_time_of_selected_action
+  lc = last_change_on(:db_content, not_after: @selected_action_id, including_drafts: true)
+  lc&.value
+end
+
+def with_selected_action_id action_id
+  current_action_id = @selected_action_id
+  select_action_id action_id
+  result = yield
+  select_action_id current_action_id
+  result
+end
+
+def select_action_id action_id
+  run_callbacks :select_action do
+    self.selected_action_id = action_id
+  end
+end
+
+def selected_content_action_id
+  @selected_action_id || new_content_action_id || last_content_action_id
+end

data/set/all/history/views.rb

@@ -0,0 +1,35 @@
+# History views
+
+format :html do
+  view :history, cache: :never do
+    frame do
+      class_up "d0-card-body",  "history-slot"
+      acts_layout card.history_acts, :relative, :show
+    end
+  end
+
+  view :act, cache: :never do
+    act_listing act_from_context
+  end
+
+  view :act_legend do
+    bs_layout do
+      row md: [12, 12], lg: [7, 5] do
+        col action_legend
+        col content_legend, class: "text-right"
+      end
+    end
+  end
+
+  view :draft_legend do
+    "#{action_icon(:draft)} unsaved draft"
+  end
+
+  view :action_summary do
+    action_content action_from_context, :summary
+  end
+
+  view :action_expanded do
+    action_content action_from_context, :expanded
+  end
+end

data/set/all/history_bridge.rb

@@ -0,0 +1,65 @@
+format :html do
+  view :creator_credit,
+       wrap: { div: { class: "text-muted creator-credit" } }, cache: :never do
+    return "" unless card.real?
+    "Created by #{nest card.creator, view: :link} "\
+    "#{time_ago_in_words(card.created_at)} ago"
+  end
+
+  view :updated_by, wrap: { div: { class: "text-muted" } } do
+    return "" unless card.id
+    updaters = Card.search(updater_of: { id: card.id })
+    return "" unless updaters.present?
+
+    updaters = updater_links updaters, others_target: Card.fetch(card, :editors)
+    "Updated by #{updaters}"
+  end
+
+  def updater_links updaters, item_view: :link, max_count: 3, others_target: card
+    return "" unless updaters.present?
+
+    total = updaters.size
+    fetch_count = total > max_count ? max_count - 1 : max_count
+
+    reduced = first_card(fetch_count).map { |c| nest c, view: item_view }
+    if total > max_count
+      reduced << link_to_card(others_target, "#{total - fetch_count} others")
+    end
+    reduced.to_sentence
+  end
+
+  def acts_bridge_layout acts, context=:bridge
+    output [
+      _render_creator_credit,
+      act_link_list(acts, context),
+      act_paging(acts, context)
+    ]
+  end
+
+  def act_link_list acts, context
+    items = acts_for_accordion(acts, context) do |act, seq|
+      act_link_list_item act, seq, context
+    end
+    bridge_pills items
+  end
+
+  def act_link_list_item act, seq=nil, _context=nil
+    opts = act_listing_opts_from_params(seq)
+    opts[:slot_class] = "revision-#{act.id} history-slot nav-item"
+    act_renderer(:bridge).new(self, act, opts).bridge_link
+  end
+
+  def act_list_group acts, context, &block
+    list_group acts_for_accordion(acts, context, &block), class: "clear-both"
+  end
+
+  view :bridge_act, cache: :never do
+    opts = act_listing_opts_from_params(nil)
+    act = act_from_context
+    ar = act_renderer(:bridge).new(self, act, opts)
+    class_up "action-list", "my-3"
+    wrap_with_overlay title: ar.overlay_title, slot: breadcrumb_data("History") do
+      act_listing(act, opts[:act_seq], :bridge)
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-history
+version: !ruby/object:Gem::Version
+  version: 0.11.0
+platform: ruby
+authors:
+- Ethan McCutchen
+- Philipp Kühl
+- Gerry Gleason
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.0
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/card/act.rb
+- lib/card/act/act_renderer.rb
+- lib/card/act/act_renderer/absolute_act_renderer.rb
+- lib/card/act/act_renderer/bridge_act_renderer.rb
+- lib/card/act/act_renderer/relative_act_renderer.rb
+- lib/card/action.rb
+- lib/card/action/action_renderer.rb
+- lib/card/action/admin.rb
+- lib/card/action/differ.rb
+- lib/card/change.rb
+- set/all/history.rb
+- set/all/history/act_listing.rb
+- set/all/history/actions.rb
+- set/all/history/acts.rb
+- set/all/history/events.rb
+- set/all/history/last.rb
+- set/all/history/revision.rb
+- set/all/history/selected.rb
+- set/all/history/views.rb
+- set/all/history_bridge.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: history
+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.0.3
+signing_key:
+specification_version: 4
+summary: Revision histories in acts, actions, and changes
+test_files: []