html_surgeon 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: baa39a17d913698e40c9bf2a0aa01b2602c79b25
-  data.tar.gz: ba53b5ec29bd03823da8f285ed6e4b2da755d19f
+  metadata.gz: 34619a8d9e7430b304e686b0a3dbdfb3d02ea140
+  data.tar.gz: 672e8ff3f2e8f2fecb3b9121ab8a54d870175d40
 SHA512:
-  metadata.gz: 7286686df9036e954a598cbc59a6820dad71eca8b9ce64ea9e3088447868bf99193a1e2f27a64d880c44f169b7e21a309bf4adfcb43d01ef544ab7802cbc937e
-  data.tar.gz: cb951074c45b144d7cda13ea2408b6f970f709741c2fe952a4cf14d8e22d93788897c8117f87876ac5278b689fd1743548c2e4de6f4ea4b406393bc8cac5281f
+  metadata.gz: ef23b46708e249599fe9d28924f4ff7b2566fc5c01c55e055ff791d6680f1ef6355102ed278010bdcedcf4461814ae9c2b7629f1289c75fb8b1224f35e2e8c02
+  data.tar.gz: 79e27faa58ffaf5aff691105ba67433eaf6d31d26105010eed840e42f049b9a98b2e8f3ff7e60c4a441b67741fd2815c8fb0384f78f946a5ca4a176e9c0b14ad

data/README.md

@@ -210,10 +210,17 @@ We can also revert all audited changes.
 ```ruby
 surgeon = HtmlSurgeon.for(GIVEN_HTML) 
 
-surgeon.rollback.html # => returns the html with all events reverted 
-surgeon.rollback(change_set: uuid).html # => returns the html with only the given change set reverted
-surgeon.rollback(changed_at: changed_at).html  # => returns the html with only the change set with timestamp reverted
-surgeon.rollback(changed_from: changed_from).html # => returns the html with any change sets with a timestamp more recent than `changed_from` reverted 
+surgeon.rollback # => Integer with number of changes reverted
+surgeon.html # => returns the html with all events reverted 
+
+surgeon.rollback(change_set: uuid) # => Integer with number of changes reverted
+surgeon.html # => returns the html with only the given change set reverted
+
+surgeon.rollback(changed_at: changed_at) # => Integer with number of changes reverted
+surgeon.html  # => returns the html with only the change set with timestamp reverted
+
+surgeon.rollback(changed_from: changed_from) # => Integer with number of changes reverted
+surgeon.html # => returns the html with any change sets with a timestamp more recent than `changed_from` reverted 
 ```
 
 ## Clear Audit trail
@@ -222,7 +229,8 @@ we can clear all audit from the given html with the `clear_audit` method.
 
 ```ruby
 surgeon = HtmlSurgeon.for(GIVEN_HTML)
-surgeon.clear_audit.html # => returns the html with all audit html attributes removed
+surgeon.clear_audit # => returns an Integer with the number of changes
+surgeon.html # => returns the html with all audit html attributes removed
 ```
 
 ## Helper Methods
@@ -262,6 +270,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/eturin
 ## CHANGESET
 
 
+### v0.6.0
+
+- *WARNING: BREAKING API CHANGE*: now `rollback` and `clear_audit` return the number of changes performed
+
 ### v0.5.2
 
 - added `changed_nodes` and `changed_nodes_size` to Change Set

data/lib/html_surgeon/node_services/audit_cleaner.rb

@@ -0,0 +1,25 @@
+module HtmlSurgeon
+  module NodeServices
+    class AuditCleaner
+      attr_reader :node
+
+      def initialize(node:)
+        @node = node
+      end
+
+      def call
+        write_empty_changes_list
+        1 # always count as 1 change
+      end
+
+      private
+      def write_empty_changes_list
+        auditor.apply []
+      end
+
+      def auditor
+        @auditor ||= Auditor.new node
+      end
+    end
+  end
+end

data/lib/html_surgeon/node_services/reverser.rb

@@ -0,0 +1,83 @@
+module HtmlSurgeon
+  module NodeServices
+    class Reverser
+      attr_reader :node, :change_set, :changed_at, :changed_from
+
+      def initialize(node:, change_set: nil, changed_at: nil, changed_from: nil)
+        @node         = node
+        @change_set   = change_set
+        @changed_at   = changed_at
+        @changed_from = changed_from
+      end
+
+      def call
+        changes_to_revert.each do |change_definition|
+          revert_change change_definition
+        end
+
+        write_remaining_changes
+
+        changes_to_revert.size
+      end
+
+      private
+
+      def revert_change(change_definition)
+        klass = Changes.change_class_by_type change_definition[:type]
+        klass.revert(node, change_definition)
+      end
+
+      def write_remaining_changes
+        auditor.apply remaining_changes
+      end
+
+      def changes
+        auditor.changes
+      end
+
+      def remaining_changes
+        changes - changes_to_revert
+      end
+
+      def changes_to_revert
+        @changes_to_revert ||= load_changes_to_revert
+      end
+
+      def auditor
+        @auditor ||= Auditor.new node
+      end
+
+      def load_changes_to_revert
+        changes.dup.tap do |rev_changes|
+          remove_by_change_set(rev_changes)
+          remove_by_changed_at(rev_changes)
+          remove_by_changed_from(rev_changes)
+        end
+      end
+
+      def remove_by_changed_from(rev_changes)
+        return unless changed_from.present?
+
+        changed_from_time = changed_from.to_time.utc
+        rev_changes.reject! do |change|
+          change[:changed_at].to_time.utc < changed_from_time
+        end
+      end
+
+      def remove_by_changed_at(rev_changes)
+        return unless changed_at.present?
+
+        changed_at_time = changed_at.to_time.utc
+        rev_changes.reject! do |change|
+          change[:changed_at].to_time.utc != changed_at_time
+        end
+      end
+
+      def remove_by_change_set(rev_changes)
+        return unless change_set.present?
+
+        rev_changes.reject! { |change| change[:change_set] != change_set }
+      end
+    end
+  end
+end

data/lib/html_surgeon/service.rb

@@ -26,20 +26,22 @@ module HtmlSurgeon
       ChangeSet.create(node_set, self)
     end
 
+    # returns the number of changes performed
     def rollback(change_set: nil, changed_at: nil, changed_from: nil)
-      doc.css("[#{DATA_CHANGE_AUDIT_ATTRIBUTE}]").each do |node|
-        NodeReverser.new(node: node, change_set: change_set, changed_at: changed_at, changed_from: changed_from).call
+      doc.css("[#{DATA_CHANGE_AUDIT_ATTRIBUTE}]").reduce(0) do |sum, node|
+        reverser = NodeServices::Reverser.new node:         node,
+                                    change_set:   change_set,
+                                    changed_at:   changed_at,
+                                    changed_from: changed_from
+        sum + reverser.call
       end
-
-      self
     end
 
     def clear_audit
-      doc.css("[#{DATA_CHANGE_AUDIT_ATTRIBUTE}]").each do |node|
-        NodeAuditCleaner.new(node: node).call
+      doc.css("[#{DATA_CHANGE_AUDIT_ATTRIBUTE}]").reduce(0) do |sum, node|
+        cleaner = NodeServices::AuditCleaner.new node: node
+        sum + cleaner.call
       end
-
-      self
     end
 
     private

data/lib/html_surgeon/version.rb

@@ -1,3 +1,3 @@
 module HtmlSurgeon
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/lib/html_surgeon.rb

@@ -6,14 +6,14 @@ require 'active_support/all'
 require 'html_surgeon/version'
 require 'html_surgeon/abstract_method_error'
 require 'html_surgeon/auditor'
-require 'html_surgeon/node_reverser'
-require 'html_surgeon/node_audit_cleaner'
 require 'html_surgeon/service'
 require 'html_surgeon/change_set'
 require 'html_surgeon/change'
 require 'html_surgeon/changes'
 require 'html_surgeon/changes/add_css_class'
 require 'html_surgeon/changes/replace_tag_name'
+require 'html_surgeon/node_services/audit_cleaner'
+require 'html_surgeon/node_services/reverser'
 
 module HtmlSurgeon
   DATA_CHANGE_AUDIT_ATTRIBUTE = 'data-surgeon-audit'.freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_surgeon
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -146,8 +146,8 @@ files:
 - lib/html_surgeon/changes.rb
 - lib/html_surgeon/changes/add_css_class.rb
 - lib/html_surgeon/changes/replace_tag_name.rb
-- lib/html_surgeon/node_audit_cleaner.rb
-- lib/html_surgeon/node_reverser.rb
+- lib/html_surgeon/node_services/audit_cleaner.rb
+- lib/html_surgeon/node_services/reverser.rb
 - lib/html_surgeon/service.rb
 - lib/html_surgeon/version.rb
 homepage: https://github.com/eturino/html_surgeon

data/lib/html_surgeon/node_audit_cleaner.rb

@@ -1,22 +0,0 @@
-module HtmlSurgeon
-  class NodeAuditCleaner
-    attr_reader :node
-
-    def initialize(node:)
-      @node = node
-    end
-
-    def call
-      write_empty_changes_list
-    end
-
-    private
-    def write_empty_changes_list
-      auditor.apply []
-    end
-
-    def auditor
-      @auditor ||= Auditor.new node
-    end
-  end
-end

data/lib/html_surgeon/node_reverser.rb

@@ -1,79 +0,0 @@
-module HtmlSurgeon
-  class NodeReverser
-    attr_reader :node, :change_set, :changed_at, :changed_from
-
-    def initialize(node:, change_set: nil, changed_at: nil, changed_from: nil)
-      @node         = node
-      @change_set   = change_set
-      @changed_at   = changed_at
-      @changed_from = changed_from
-    end
-
-    def call
-      changes_to_revert.each do |change_definition|
-        revert_change change_definition
-      end
-
-      write_remaining_changes
-    end
-
-    private
-
-    def revert_change(change_definition)
-      klass = Changes.change_class_by_type change_definition[:type]
-      klass.revert(node, change_definition)
-    end
-
-    def write_remaining_changes
-      auditor.apply remaining_changes
-    end
-
-    def changes
-      auditor.changes
-    end
-
-    def remaining_changes
-      changes - changes_to_revert
-    end
-
-    def changes_to_revert
-      @changes_to_revert ||= load_changes_to_revert
-    end
-
-    def auditor
-      @auditor ||= Auditor.new node
-    end
-
-    def load_changes_to_revert
-      changes.dup.tap do |rev_changes|
-        remove_by_change_set(rev_changes)
-        remove_by_changed_at(rev_changes)
-        remove_by_changed_from(rev_changes)
-      end
-    end
-
-    def remove_by_changed_from(rev_changes)
-      return unless changed_from.present?
-
-      changed_from_time = changed_from.to_time.utc
-      rev_changes.reject! do |change|
-        change[:changed_at].to_time.utc < changed_from_time
-      end
-    end
-
-    def remove_by_changed_at(rev_changes)
-      return unless changed_at.present?
-
-      changed_at_time = changed_at.to_time.utc
-      rev_changes.reject! do |change|
-        change[:changed_at].to_time.utc != changed_at_time
-      end
-    end
-
-    def remove_by_change_set(rev_changes)
-      return unless change_set.present?
-
-      rev_changes.reject! { |change| change[:change_set] != change_set }
-    end
-  end
-end