biola_wcms_components 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bdbcd07d32850d019054bc9cd87a61382666834
-  data.tar.gz: abfe1ee56c0b317ad0b38d9ab972c30c898545e9
+  metadata.gz: 64707a51133721274a2d1442ff6c3bedcaa1cbc5
+  data.tar.gz: 595b3c6481b8b71436e1abd48406543a6e0bec26
 SHA512:
-  metadata.gz: 15c789d5a03dc04223015c2bf62d3961d2c804b9cc444668b107ced5d0f6714ac5173a80dd27e1ae1bc99a4fed785c87604b130056799039361f2eed58edcea3
-  data.tar.gz: eba8635a02a359d07a6e8d01f509c11ae207e770ad458e0d6e277356e231d1bceeeee32028e3d701fcf99014a78771aac592fad601d9ea9092f371f18276cd98
+  metadata.gz: 51605effdefc964f3070b01ee305995b7af9eb392cb6e0c8c4498deb73181a6b68ae8b287ab34f1f72812815b82f3a63a0e3a7352cb44e48d82e97cea7c5f2ab
+  data.tar.gz: 2ce7582ef2f4a1930c3963b611e4497753573c82e67bbda611077fdf3bec681287e2e924d05e7d64b9f189e2162a3f9118a63adf55b34197ad2eae964bc73c34

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ### Master (unreleased)
 
+### 0.19.0
+
+* Added Changes class for history tracking
+
 ### 0.18.1
 
 * Updating site nav to let you set the text for the menu dropdown.

data/app/assets/javascripts/components/list/expandable_item.js.coffee

@@ -0,0 +1,33 @@
+$(document).ready ->
+  # Each bullet point that has more than 100 chars is initially shortened
+  #  and can be expanded.
+  showChar = 100
+  ellipsestext = '...'
+  moretext = 'more'
+  lesstext = 'less'
+
+  onClickMoreLink = (event) ->
+    link = $(event.target)
+
+    if link.hasClass('less')
+      link.removeClass 'less'
+      link.html moretext
+    else
+      link.addClass 'less'
+      link.html lesstext
+
+    link.parent().prev().toggle()
+    link.prev().toggle()
+    # Prevent the page from scrolling to the top.
+    false
+
+
+  $('.expandable_item').each ->
+    content = $(this).html()
+    if content.length > showChar
+      c = content.substr(0, showChar)
+      h = content.substr(showChar)
+      html = c + '<span class="moreellipses">' + ellipsestext + '&nbsp;</span><span class="morecontent"><span>' + h + '</span>&nbsp;&nbsp;<a href="" class="morelink">' + moretext + '</a></span>'
+      $(this).html html
+
+  $('.expandable_item .morelink').click onClickMoreLink

data/app/assets/javascripts/components/list/expandable_list.js.coffee

@@ -0,0 +1,27 @@
+
+$(document).ready ->
+  # Used in Changes. For each recorded change if there is more than two changed fields
+  #  hide all but the first two and provide a link to show the rest.
+  onClickMoreLink = (event) ->
+    link = $(event.target)
+    # Show all the list items
+    link.siblings('li').show()
+    # Hide the show more link
+    link.hide()
+    # Prevent the page from scrolling to the top
+    false
+
+  $('ul.expandable_list').each ->
+    ul = $(this)
+    lis = ul.children('li')
+    # If there are more than two list items
+    if lis.length > 2
+      # Show only the first two initially
+      lis.slice(2).hide()
+
+      # Create a link
+      show_more_link = $('<a class="show_more_link" href="#">Expand</a>')
+      # Add a click event to the link
+      show_more_link.click(onClickMoreLink)
+      # Add the link to the DOM
+      ul.append(show_more_link)

data/app/assets/stylesheets/biola-wcms-components.css.scss

@@ -13,4 +13,5 @@
 @import "./components/alerts/*";
 @import "./components/buttons/*";
 @import "./components/forms/*";
+@import "./components/list/*";
 @import "./components/navigation/*";

data/app/assets/stylesheets/components/list/_expandable_item.scss

@@ -0,0 +1,9 @@
+.expandable_item {
+  a.morelink {
+      text-decoration:none;
+      outline: none;
+  }
+  .morecontent span {
+      display: none;
+  }
+}

data/app/controllers/wcms_components/changes_controller.rb

@@ -0,0 +1,118 @@
+class WcmsComponents::ChangesController < ApplicationController
+
+  before_filter :set_change, only: [:undo, :undo_destroy]
+  before_filter :pundit_authorize
+
+  def index
+    @changes = policy_scope(Change)
+    @changes = @changes.where(association_chain: {'$elemMatch' => {name: params[:klass].classify}})
+
+    # Filter Values
+    @available_users = User.find(@changes.distinct(:modifier_id))
+
+    @changes = @changes.where(modifier_id: params[:user_id]) if params[:user_id].present?
+    @changes = @changes.where(action: params[:action_taken]) if params[:action_taken].present?
+    @changes = @changes.by_last_change(params[:last_change]) if params[:last_change].present?
+
+    @changes = @changes.desc(:updated_at)
+    @changes = @changes.page(params[:page]).per(25)
+  end
+
+  def object_index
+    # Retrieve object of who's history you are desiring after.
+    @object = params[:klass].safe_constantize.find(params[:id])
+    @changes = []
+    @available_users = []
+    object_history = @object.history_tracks # TODO: this seems to not be pulling the embedded document history
+    @available_users += User.find(object_history.distinct(:modifier_id)) if object_history
+
+    # Apply the filters -- if there are no results then it will be as an empty array
+    @changes += set_filters(object_history)
+
+    # Retrieve applicable nested object histories defined in the respective publishers settings
+    fetch_nested_histories(@object) do |histories|
+      if histories.present?
+        @available_users += User.find(histories.distinct(:modifier_id))
+        @changes += set_filters(histories)
+      end
+    end
+
+    @available_users.uniq!
+
+    @changes.sort!{ |a,b| b.created_at <=> a.created_at }
+  end
+
+  def undo
+    set_modifier
+
+    if @change.undo! current_user
+      if @change.action == 'create'
+        flash[:info] = "Change was successfully reversed. <a href=wcms_components/changes/#{Change.last.id}/undo_destroy>Undo</a>"
+      else
+        flash[:info] = "Change was successfully reversed."
+      end
+    else
+      flash[:error] = "Something went wrong. Please try again."
+    end
+
+    # Ensure that the object wasn't just undone into nonexistence.
+    #  For the time being referenced documents will not be able to be undone as
+    #  we have no way to redirect back to the owning object.
+    @parent = params[:owning_class].safe_constantize
+    if @parent.where(id: params[:owning_id]).present?
+      redirect_to @parent.find(params[:owning_id])
+    else
+      redirect_to @parent
+    end
+  end
+
+  def undo_destroy
+    # Undo destory at the moment is only available in flash notices after destroy is completed.
+    #  Because of this the modifier for the change will be set as the last known object modifier.
+    #  This could cause issues so we may want to find a way to set it since mongoid history wont.
+    if @change.undo!
+      flash[:info] = "#{@change.original[:title]} has been successfully recreated."
+    else
+      flash[:error] = "Something went wrong. Please try again."
+    end
+    redirect_to :back
+  end
+
+  private
+  # Mongoid history for some reason is refraining from setting modifier on undo! so this will set it manually
+  #  if the parent object is present.
+  def set_modifier
+    if @change.trackable_root.present?
+      @change.trackable_root.modifier = current_user
+    end
+  end
+
+  def set_filters(changes)
+    changes = changes.where(modifier_id: params[:user_id]) if params[:user_id].present?
+    changes = changes.where(action: params[:action_taken]) if params[:action_taken].present?
+    changes = changes.by_last_change(params[:last_change]) if params[:last_change].present?
+    changes
+  end
+
+  def fetch_nested_histories(object, &block)
+    # Trackable relations is an array of nested (e.g. has_many/belongs_to) relationships (e.g. ["attachments", "concentrations"])
+    #  for a given class. Embedded documents are handled by Mongoid History.
+    if relations = Settings.trackable_relations[params[:klass]]
+
+      # Getting all the related objects for each relationship.
+      all_related_objects = relations.map{ |rels| object.send(rels) }.flatten.compact
+
+      # Passing the histories as a parameter to the block defined in object_index
+      all_related_objects.each { |related_object| block.call(related_object.history_tracks) }
+    end
+  end
+
+  def set_change
+    @change = Change.find(params[:id])
+  end
+
+  def pundit_authorize
+    authorize (@change || Change)
+  end
+
+end

data/app/policies/change_policy.rb

@@ -0,0 +1,22 @@
+class ChangePolicy < ApplicationPolicy
+  class Scope < ApplicationPolicy
+    attr_reader :user, :scope
+    def initialize(user, scope)
+      @user = user
+      @scope = scope
+    end
+    def resolve
+      scope.all
+    end
+  end
+
+  def undo?
+    user.admin?
+  end
+  alias :undo_destroy? :undo?
+
+  def index?
+    true
+  end
+  alias :object_index? :index?
+end

data/app/views/wcms_components/alerts/_message_list.html.slim

@@ -5,4 +5,4 @@
         .alert class=alert_class(msg[:type]) data-type=msg[:type]
           a.close data-dismiss="alert" href="#" ×
           i> class=alert_icon(msg[:type])
-          = msg[:message]
+          = msg[:message].html_safe

data/app/views/wcms_components/changes/_change_index.html.slim

@@ -0,0 +1,28 @@
+.container.page
+  h3 = "#{params[:klass].titleize} changes"
+  .page-header
+    ul.nav.nav-pills.pull-left
+      = nav_pill_header 'Options'
+      - if @available_users.present?
+        = nav_pill_dropdown 'User', :user do
+          - @available_users.each do |user|
+            = nav_list_link user, :user_id, user.id
+      = nav_pill_dropdown 'Action', :action_taken do
+        = nav_list_link 'Create', :action_taken, 'create'
+        = nav_list_link 'Update', :action_taken, 'update'
+        = nav_list_link 'Destroy', :action_taken, 'destroy'
+      = nav_pill_dropdown 'Last Changed', :last_change do
+        = nav_list_link 'Today', :last_change, Date.today
+        = nav_list_link 'Yesterday', :last_change, 1.day.ago.to_date
+        = nav_list_link "Last #{1.week.ago.strftime('%A')}", :last_change, 1.week.ago.to_date
+        = nav_list_link 1.month.ago.strftime('%B %e'), :last_change, 1.month.ago.to_date
+    .clearfix
+
+  - if @changes.empty?
+    .alert.alert-warning
+      = fa_icon 'warning', text: "No changes were found"
+  - else
+    = render 'changes'
+
+  - unless params[:action] == 'object_index'
+    .text-center = paginate @changes

data/app/views/wcms_components/changes/_changes.html.slim

@@ -0,0 +1,51 @@
+.change_history
+  .table-responsive style="overflow: scroll;"
+    table.table.table-striped
+      thead
+      tr
+        th
+        th.col-xs-2 Action
+        th.col-xs-2 User
+        th.col-xs-2 Created
+        th.col-xs-6 Changes
+
+      tbody
+        - @changes.each do |change|
+          tr
+            td
+              - if change.action == 'destroy' && (change.trackable_root.present? || change.trackable.present?)
+                = link_to fa_icon('undo'), '#', data: { confirm: "This change has already been reversed and the object currently exists" }
+              - else
+                = link_to fa_icon('undo'), undo_wcms_components_change_path(change, owning_class: params[:klass], owning_id: params[:id]), data: { confirm: "Are you sure that you want to undo this change?" }
+            td
+              - if change.action.present?
+                = "#{change.action == 'destroy' ? 'Destroyed' : change.action.try(:humanize).to_s + 'd'} #{change.association_chain.last[:name].titleize}"
+            td = change.modifier.try(:to_s)
+            td = change.created_at.to_s(:long_ordinal)
+            td
+
+              ul.changes.expandable_list
+                / if the change belongs to a tracked child object display the title of the child object so that we know which it is
+                - if (change.association_chain.last[:name] != params[:klass]) && change.trackable.present?
+                  strong = "#{change.association_chain.last[:name].titleize} Title: #{change.trackable.to_s}"
+                - elsif params[:action] != 'object_index'
+                  strong = "Title: #{change.trackable.to_s}"
+                
+                - (change.tracked_edits[:add]||[]).each do |k,v|
+                  li.remove.expandable_item = "Added field #{k} value #{v}"
+
+                - (change.tracked_edits[:modify]||[]).each do |k,v|
+                  li.modify.expandable_item = "Changed field #{k} from #{v[:from]} to #{v[:to]}"
+
+                - (change.tracked_edits[:array]||[]).each do |k,v|
+                  li.modify.expandable_item
+                    - if v[:remove].nil?
+                      = "Changed field #{k} by adding #{v[:add]}"
+                    - elsif v[:add].nil?
+                      = "Changed field #{k} by removing #{v[:remove]}"
+                    - else
+                      = "Changed field #{k} by adding #{v[:add]} and removing #{v[:remove]}"
+
+                - (change.tracked_edits[:remove]||[]).each do |k,v|
+                  li.remove.expandable_item = "Removed field #{k} (was previously #{v})"
+                  

data/app/views/wcms_components/changes/index.html.slim

@@ -0,0 +1,3 @@
+= render 'change_index'
+- content_for :site_nav_right do
+  = link_to 'Back', [params[:klass].underscore.pluralize], class: "top-nav-link"

data/app/views/wcms_components/changes/object_index.html.slim

@@ -0,0 +1,3 @@
+= render 'change_index'
+- content_for :site_nav_right do
+  = link_to 'Back', [@object], class: "top-nav-link"

data/app/views/wcms_components/navigation/_site_nav.html.slim

@@ -45,4 +45,14 @@ ruby:
 
     - crumbs.each do |crumb|
       i class='fa fa-angle-right'
-      = link_to crumb[:body], crumb[:url], class: 'top-nav-link'
+      - if crumb[:body] == "Changes"
+        = link_to crumb[:body], '#', class: 'top-nav-link'
+      - else
+        = link_to crumb[:body], crumb[:url], class: 'top-nav-link'
+
+    / Example:
+    / - content_for :site_nav_right do
+    /   = link_to 'History', wcms_components_changes_path(klass: 'page_editions'), class: "top-nav-link"
+    - if content_for?(:site_nav_right)
+      #site_nav_right.pull-right
+        = yield(:site_nav_right)

data/biola_wcms_components.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "ace-rails-ap",         "~> 3.0"
-  spec.add_dependency "buweb_content_models", ">= 0.82"
+  spec.add_dependency "buweb_content_models", ">= 1.7"
   spec.add_dependency "coffee-rails",         ">= 4.0"
   spec.add_dependency "chronic_ping",         "~> 0.4"
   spec.add_dependency "jquery-ui-rails"

data/config/routes.rb

@@ -4,8 +4,14 @@ Rails.application.routes.draw do
     resources :embedded_images, only: [:create], defaults: { format: 'json' }
     resources :people, only: [:index], defaults: { format: 'json' }
     resources :tags, only: [:index], defaults: { format: 'json' }
+    resources :changes, only: :index do
+      get :object_index, on: :collection
+      get :undo, on: :member
+      get :undo_destroy, on: :member
+    end
   end
 
+
   # this is just a convenience to create a named route to rack-cas' logout
   get '/logout' => -> env { [200, { 'Content-Type' => 'text/html' }, ['Rack::CAS should have caught this']] }, as: :logout
 

data/lib/biola_wcms_components/version.rb

@@ -1,3 +1,3 @@
 module BiolaWcmsComponents
-  VERSION = "0.18.1"
+  VERSION = "0.19.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: biola_wcms_components
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Ryan Hall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-16 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ace-rails-ap
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.82'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
@@ -172,9 +172,10 @@ files:
 - app/assets/javascripts/components/forms/presentation_data_editor.js.coffee
 - app/assets/javascripts/components/forms/tag_input.js.coffee
 - app/assets/javascripts/components/forms/yaml_editor.js.coffee
+- app/assets/javascripts/components/list/expandable_item.js.coffee
+- app/assets/javascripts/components/list/expandable_list.js.coffee
 - app/assets/javascripts/configuration/file_uploader.js.coffee
 - app/assets/javascripts/configuration/setup_redactor.js.coffee
-- app/assets/stylesheets/_mixins.scss
 - app/assets/stylesheets/_settings.scss
 - app/assets/stylesheets/_utilities.scss
 - app/assets/stylesheets/biola-wcms-components.css.scss
@@ -183,18 +184,26 @@ files:
 - app/assets/stylesheets/components/forms/_person_lookup.scss
 - app/assets/stylesheets/components/forms/_presentation_data_editor.scss
 - app/assets/stylesheets/components/forms/_tag_input.scss
+- app/assets/stylesheets/components/list/_expandable_item.scss
 - app/assets/stylesheets/components/navigation/_footer.scss
+- app/assets/stylesheets/components/navigation/_mixins.scss
 - app/assets/stylesheets/components/navigation/_page_nav.scss
 - app/assets/stylesheets/components/navigation/_site_nav.scss
 - app/controllers/wcms_application_controller.rb
+- app/controllers/wcms_components/changes_controller.rb
 - app/controllers/wcms_components/embedded_images_controller.rb
 - app/controllers/wcms_components/people_controller.rb
 - app/controllers/wcms_components/tags_controller.rb
 - app/helpers/wcms_components/alerts_helper.rb
 - app/helpers/wcms_components/component_helper.rb
 - app/helpers/wcms_components/navigation_helper.rb
+- app/policies/change_policy.rb
 - app/views/wcms_components/alerts/_impersonation.html.slim
 - app/views/wcms_components/alerts/_message_list.html.slim
+- app/views/wcms_components/changes/_change_index.html.slim
+- app/views/wcms_components/changes/_changes.html.slim
+- app/views/wcms_components/changes/index.html.slim
+- app/views/wcms_components/changes/object_index.html.slim
 - app/views/wcms_components/forms/_data_template_picker.html.slim
 - app/views/wcms_components/forms/_date.html.slim
 - app/views/wcms_components/forms/_datetime.html.slim
@@ -254,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Reusable UX components for use in or WCMS projects