culturecode_stagehand 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd8d168cfca3a30f6904f1f84fc27d7eec96d5d5
-  data.tar.gz: 4ae03b6e5e13aed6c1d13d85e5dc2fe3470dec26
+  metadata.gz: 631cfae3a83514e2678436cf359e33af77f49234
+  data.tar.gz: 40ad332a8e324c076e8cbff79d678657db0d58a6
 SHA512:
-  metadata.gz: cb78f8ebdb79f4b9441cf79ecf81577428efe58a90cfd664f6f8ed5716c5b2984098fb3575c8d25859c06b728d4c53140ba006a510bec5bfdb65fbd16f81e097
-  data.tar.gz: 18f250b45b7f14dc3437c6121766c1215b8aeaf1b5b84225990732962ce70483621880d04278503cfb2b73d43bb44d2dff7621c12bd02127391dd1f0dcd1b3e1
+  metadata.gz: a52cace12d2485973e0443c2a44eee10a4c2df86f4c429b1db29ea3b8a7f2b9fb7830e325594016ea2e6851b95d2f54c37094dc85d2d750e91d896190015a66b
+  data.tar.gz: 05c33366d9c63aecce718f89a442bef8119b895f1bdd42066d81f738a46e7d0d89a6d6011125c398adff0e9c04737d8a4f21e836f5378ca48ed048c6cf9ec358

data/lib/stagehand/auditor/checklist_visualizer.rb

@@ -0,0 +1,84 @@
+require 'graphviz'
+
+module Stagehand
+  module Auditor
+    class ChecklistVisualizer
+      def initialize(checklist, show_all_commits: false)
+        entries = checklist.affected_entries.select(&:commit_id)
+
+        @graph = GraphViz.new( :G, :type => :graph );
+        @commits = Hash.new {|hash, commit_id| hash[commit_id] = Stagehand::Staging::CommitEntry.find(commit_id) }
+        nodes = Hash.new
+        edges = []
+
+        # Detect edges
+        entries.group_by(&:key).each_value do |entries|
+          entries.combination(2).each do |entry_a, entry_b|
+            current_edge = [entry_a, entry_b]
+            next if edges.detect {|edge| edge.sort == current_edge.sort }
+            next if same_node?(entry_a, entry_b)
+            next if same_subject?(entry_a, entry_b)
+            edges << current_edge
+          end
+        end
+
+        # Create Subgraph nodes for commits with connections to other subjects
+        entries = edges.flatten.uniq unless show_all_commits
+        entries.group_by {|entry| commit_subject(entry) }.each do |subject, entries|
+          subgraph = create_subgraph(subject, @graph)
+          entries.each do |entry|
+            nodes[entry] = create_node(entry, subgraph)
+          end
+        end
+
+        # Create edges
+        edges.each do |entry_a, entry_b|
+          create_edge(nodes[entry_a], nodes[entry_b], :label => edge_label(entry_a, entry_b))
+        end
+      end
+
+      def output(file_name, format: File.extname(file_name)[1..-1])
+        @graph.output(format => file_name)
+        File.open(file_name)
+      end
+
+      private
+
+      def create_subgraph(subject, graph)
+        graph.add_graph("cluster_#{subject}", :label => subject, :style => :filled, :color => :lightgrey)
+      end
+
+      def create_edge(node_a, node_b, options = {})
+        @graph.add_edges(node_a, node_b, options.reverse_merge(:color => :red, :fontcolor => :red))
+      end
+
+      def create_node(entry, graph)
+        graph.add_nodes(node_name(entry), :shape => :rect, :style => :filled, :fillcolor => :white)
+      end
+
+      def edge_label(entry_a, entry_b)
+        pretty_key(entry_a)
+      end
+
+      def same_node?(entry_a, entry_b)
+        node_name(entry_a) == node_name(entry_b)
+      end
+
+      def same_subject?(entry_a, entry_b)
+        commit_subject(entry_a) == commit_subject(entry_b)
+      end
+
+      def commit_subject(entry)
+        pretty_key(@commits[entry.commit_id])
+      end
+
+      def node_name(entry)
+        "Commit #{entry.commit_id}"
+      end
+
+      def pretty_key(entry)
+        "#{entry.table_name.classify} #{entry.record_id}"
+      end
+    end
+  end
+end

data/lib/stagehand/auditor.rb

@@ -1,3 +1,5 @@
+require 'stagehand/auditor/checklist_visualizer'
+
 module Stagehand
   module Auditor
     extend self
@@ -64,6 +66,14 @@ module Stagehand
       return output
     end
 
+    def visualize(subject, output_file_name, options = {})
+      visualize_checklist(Staging::Checklist.new(subject), output_file_name, options)
+    end
+
+    def visualize_checklist(checklist, output_file_name, options = {})
+      ChecklistVisualizer.new(checklist, options).output(output_file_name)
+    end
+
     private
 
     # Incomplete End Operation that are not the last entry in their session

data/lib/stagehand/staging/commit.rb

@@ -5,13 +5,13 @@ module Stagehand
         CommitEntry.start_operations.pluck(:id).collect {|id| find(id) }
       end
 
-      def self.capture(subject_record = nil, &block)
+      def self.capture(subject_record = nil, except: [], &block)
         start_operation = start_commit(subject_record)
         init_session!(start_operation)
         block.call(start_operation)
-        return end_commit(start_operation)
+        return end_commit(start_operation, except)
       rescue => e
-        end_commit(start_operation)
+        end_commit(start_operation, except)
         raise(e)
       end
 
@@ -45,13 +45,12 @@ module Stagehand
 
       # Sets the commit_id on all the entries between the start and end op.
       # Returns the commit object for those entries
-      def self.end_commit(start_operation)
+      def self.end_commit(start_operation, except)
         end_operation = CommitEntry.end_operations.create(:session => start_operation.session)
 
-        CommitEntry
-          .where(:id => start_operation.id..end_operation.id)
-          .where(:session => start_operation.session)
-          .update_all(:commit_id => start_operation.id)
+        scope = CommitEntry.where(:id => start_operation.id..end_operation.id, :session => start_operation.session)
+        scope = scope.where('table_name NOT IN (?) OR table_name IS NULL', except) if except.present?
+        scope.update_all(:commit_id => start_operation.id)
 
         return new(start_operation.id)
       end

data/lib/stagehand/staging/controller.rb

@@ -9,8 +9,8 @@ module Stagehand
       end
 
       # Creates a stagehand commit to log database changes associated with the given record
-      def stage_changes(subject_record = nil, &block)
-        Staging::Commit.capture(subject_record, &block)
+      def stage_changes(*args, &block)
+        Staging::Commit.capture(*args, &block)
       end
 
       # Syncs the given record and all affected records to the production database

data/lib/stagehand/version.rb

@@ -1,3 +1,3 @@
 module Stagehand
-  VERSION = "0.10.2"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: culturecode_stagehand
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Nicholas Jakobsen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +83,7 @@ files:
 - lib/stagehand.rb
 - lib/stagehand/active_record_extensions.rb
 - lib/stagehand/auditor.rb
+- lib/stagehand/auditor/checklist_visualizer.rb
 - lib/stagehand/cache.rb
 - lib/stagehand/configuration.rb
 - lib/stagehand/connection_adapter_extensions.rb
@@ -109,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simplify the management of a sandbox database that can sync content to a