html_surgeon 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 184ce38f2ca801e35b52003637cdba997487557c
-  data.tar.gz: 23741ef09a0cf4e12150171fcbb93417c86ceef2
+  metadata.gz: 94d817ba0e3871c050f1d56fd80034cfc389562c
+  data.tar.gz: aca28c4bcc429fd9e7ea1294c3f81896f641cda2
 SHA512:
-  metadata.gz: e567d65954530da7c2f33c562f0890813280b7274d68978d6419552aa933fe49e4cac1d5e5110ac454c99c1393381fade85b73d374750e96e92ebc96f7d8cc38
-  data.tar.gz: a25d072d6c15964317a440e5857d24f60ced9ce620b87acfd5f5f48af3b82c507daa8a4edb3c2382fb8078669a6123e2c1d608d3ff34537386ff80ee0a311a25
+  metadata.gz: ebe07e4c500cdaa9b95b852abb1e3b894eb3805c6ebfa9fac34fa0a56d34f3488700a025ac3f0cb1a5df1d6f194634b9724afea8c9769a09428148ea7219e8e1
+  data.tar.gz: c348f793ae6186dceb2f00db9269b45a0477d1e816b2084b672eb431b09d6d8e8a7d3147cff48ecb34bfc55ce35f12ec854ee6d28756eafb8f4bb068bcb3035e

data/README.md

@@ -110,7 +110,7 @@ If we have enabled audit, we'll get the changes applied to an element in an data
 It will store, in JSON, an array with all the changes.
 
 ```ruby
-surgeon = HtmlService.for(GIVEN_HTML)
+surgeon = HtmlService.for(GIVEN_HTML, audit: true)
 surgeon.css('.lol').replace_tag_name('span').add_css_class('hey').run
 surgeon.html # =>
 # <div>
@@ -123,7 +123,7 @@ surgeon.html # =>
 #             <li>2</li>
 #         </ul>
 #     </div>
-# </div># 
+# </div>
 ```
 
 the attribute's value (formatted) is:
@@ -178,7 +178,24 @@ surgeon.css('div.to-be-changed').replace_name_tag('article')
 surgeon.css('div.to-be-changed').add_css_class('applied-some-stuff')
 ```
 
+## Rollback
+
+the surgen can be used to revert any audited rollback. We can select what changes to rollback based on:
 
+- `change_set`: The change_set UUID
+- `changed_at`: The change timestamp
+- `changed_from`: All changes which timestamp is more recent than the given time
+
+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 
+```
 
 ## Installation
 
@@ -207,3 +224,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/eturino/html_surgeon.
 
+
+## CHANGESET
+
+### v 0.2.0
+- added `rollback support

data/html_surgeon.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'oj'
   spec.add_dependency 'oj_mimic_json'
+  spec.add_dependency 'naught'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'

data/lib/html_surgeon/auditor.rb

@@ -0,0 +1,49 @@
+module HtmlSurgeon
+  class Auditor
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+    end
+
+    def add_change(change_definition)
+      changes << change_definition
+    end
+
+    def apply(change_list = nil)
+      change_list ||= changes
+      if change_list.empty?
+        node.xpath(".//@#{DATA_CHANGE_AUDIT_ATTRIBUTE}").remove
+      else
+        node[DATA_CHANGE_AUDIT_ATTRIBUTE] = Oj.dump change_list
+      end
+    end
+
+    def changes
+      @changes ||= load_changes_from_node
+    end
+
+    private
+
+    def load_changes_from_node
+      current = node[DATA_CHANGE_AUDIT_ATTRIBUTE].presence
+      return [] unless current
+
+      Oj.load current, symbol_keys: true
+    end
+
+    NullAuditor = Naught.build do
+      def initialize(*)
+        super
+      end
+
+      def add_change(change_definition)
+        false
+      end
+
+      def apply
+        false
+      end
+    end
+  end
+end

data/lib/html_surgeon/change.rb

@@ -1,50 +1,37 @@
 module HtmlSurgeon
 
   class Change
-    DATA_CHANGE_AUDIT_ATTRIBUTE = 'data-surgeon-audit'.freeze
+    def self.inherited(klass)
+      Changes.add_change_class(klass)
+    end
 
     attr_reader :change_set
+    delegate :audit?, to: :change_set
+    delegate :uuid, :run_time, to: :change_set, prefix: true
 
     def initialize(change_set:)
       @change_set = change_set
     end
 
-    delegate :audit?, to: :change_set
-    delegate :uuid, :run_time, to: :change_set, prefix: true
+    def apply(node)
+      auditor = auditor_class.new(node)
 
-    def apply(element)
-      prepare_audit_change(element) if audit?
-
-      apply_in element
-
-      apply_audit_change(element) if audit?
+      auditor.add_change(audit_data(node))
+      apply_in node
+      auditor.apply
 
       self
     end
 
+    def auditor_class
+      audit? ? Auditor : Auditor::NullAuditor
+    end
+
     def log
       raise AbstractMethodError, "a lazy developer has not implemented this method in #{self.class}"
     end
 
     private
-
-    def prepare_audit_change(element)
-      @audit_data = audit_data(element)
-    end
-
-    def apply_audit_change(element)
-      current = current_audit_data(element)
-      current << @audit_data
-      element[DATA_CHANGE_AUDIT_ATTRIBUTE] = Oj.dump current
-    end
-
-    def current_audit_data(element)
-      current = element[DATA_CHANGE_AUDIT_ATTRIBUTE].presence
-      return [] unless current
-
-      Oj.load current
-    end
-
     def basic_audit_data
       {
         change_set: change_set_uuid,
@@ -52,11 +39,11 @@ module HtmlSurgeon
       }
     end
 
-    def audit_data(element)
+    def audit_data(node)
       raise AbstractMethodError, "a lazy developer has not implemented this method in #{self.class}"
     end
 
-    def apply_in(_element)
+    def apply_in(_node)
       raise AbstractMethodError, "a lazy developer has not implemented this method in #{self.class}"
     end
 

data/lib/html_surgeon/change_set.rb

@@ -3,12 +3,24 @@ module HtmlSurgeon
   class ChangeSet
     attr_reader :node_set, :base, :change_list, :uuid, :run_time
 
+    def self.create(node_set, base)
+      new_class.new node_set, base
+    end
+
+    def self.new_class
+      Class.new(ChangeSet) do
+        Changes.change_classes.each do |klass|
+          include klass::ChangeSetMethods
+        end
+      end
+    end
+
     def initialize(node_set, base)
       @node_set    = node_set
       @base        = base
       @change_list = []
-      @uuid     = SecureRandom.uuid
-      @run_time = nil
+      @uuid        = SecureRandom.uuid
+      @run_time    = nil
     end
 
     delegate :audit?, :html, to: :base
@@ -18,8 +30,8 @@ module HtmlSurgeon
     def run
       @run_time = Time.now.utc
 
-      node_set.each do |element|
-        apply_on_element(element)
+      node_set.each do |node|
+        apply_on_node(node)
       end
 
       self
@@ -31,21 +43,16 @@ module HtmlSurgeon
 
     # CHANGES
 
-    def replace_tag_name(new_tag_name)
-      change_list << Changes::ReplaceTagName.new(change_set: self, new_tag_name: new_tag_name)
-      self
-    end
+    private
 
-    def add_css_class(css_class)
-      change_list << Changes::AddCssClass.new(change_set: self, css_class: css_class)
+    def chain_add_change(change)
+      change_list << change
       self
     end
 
-    private
-
-    def apply_on_element(element)
+    def apply_on_node(node)
       change_list.each do |change|
-        change.apply(element)
+        change.apply(node)
       end
     end
   end

data/lib/html_surgeon/changes/add_css_class.rb

@@ -1,9 +1,13 @@
 module HtmlSurgeon
   module Changes
     class AddCssClass < Change
-      attr_reader :css_class
+      AUDIT_TYPE = :add_css_class
+
       CLASS_ATTRIBUTE = 'class'.freeze
       CLASS_SEPARATOR = ' '.freeze
+      CLASS_XPATH     = './/@class'
+
+      attr_reader :css_class
 
       def initialize(css_class:, **other)
         @css_class = css_class
@@ -16,24 +20,53 @@ module HtmlSurgeon
       end
 
       private
-      def apply_in(element)
-        classes = element_classes element
-        classes << css_class
-        element.set_attribute(CLASS_ATTRIBUTE, classes.join(CLASS_SEPARATOR))
+      def apply_in(node)
+        self.class.add_class_to_node css_class, node
       end
 
-      def audit_data(element)
-        basic_audit_data.merge type:           :add_css_class,
-                               existed_before: had_class?(element),
+      def audit_data(node)
+        basic_audit_data.merge type:           AUDIT_TYPE,
+                               existed_before: self.class.had_class?(node, css_class),
                                class:          css_class
       end
 
-      def element_classes(element)
-        element.get_attribute(CLASS_ATTRIBUTE).to_s.split(CLASS_SEPARATOR)
+      def self.add_class_to_node(css_class, node)
+        classes = node_classes node
+        classes << css_class unless classes.include? css_class
+        set_classes_in_node(classes, node)
+      end
+
+      def self.remove_class_to_node(css_class, node)
+        classes = node_classes node
+        classes.delete css_class
+        if classes.empty?
+          node.xpath(CLASS_XPATH).remove
+        else
+          set_classes_in_node(classes, node)
+        end
+      end
+
+      def self.set_classes_in_node(classes, node)
+        node.set_attribute(CLASS_ATTRIBUTE, classes.join(CLASS_SEPARATOR))
+      end
+
+      def self.node_classes(node)
+        node.get_attribute(CLASS_ATTRIBUTE).to_s.split(CLASS_SEPARATOR)
+      end
+
+      def self.had_class?(node, css_class)
+        node_classes(node).include? css_class
+      end
+
+      def self.revert(node, change_definition)
+        return if change_definition[:existed_before]
+        remove_class_to_node(change_definition[:class], node)
       end
 
-      def had_class?(element)
-        element_classes(element).include? css_class
+      module ChangeSetMethods
+        def add_css_class(css_class)
+          chain_add_change Changes::AddCssClass.new(change_set: self, css_class: css_class)
+        end
       end
     end
   end

data/lib/html_surgeon/changes/replace_tag_name.rb

@@ -1,6 +1,8 @@
 module HtmlSurgeon
   module Changes
     class ReplaceTagName < Change
+      AUDIT_TYPE = :replace_tag_name
+
       attr_reader :new_tag_name
 
       def initialize(new_tag_name:, **other)
@@ -14,15 +16,25 @@ module HtmlSurgeon
       end
 
       private
-      def apply_in(element)
-        element.name = new_tag_name
+      def apply_in(node)
+        node.name = new_tag_name
       end
 
-      def audit_data(element)
-        basic_audit_data.merge type: :replace_tag_name,
-                               old:  element.name,
+      def audit_data(node)
+        basic_audit_data.merge type: AUDIT_TYPE,
+                               old:  node.name,
                                new:  new_tag_name
       end
+
+      def self.revert(node, change_definition)
+        node.name = change_definition[:old]
+      end
+
+      module ChangeSetMethods
+        def replace_tag_name(new_tag_name)
+          chain_add_change Changes::ReplaceTagName.new(change_set: self, new_tag_name: new_tag_name)
+        end
+      end
     end
   end
 end

data/lib/html_surgeon/changes.rb

@@ -0,0 +1,16 @@
+module HtmlSurgeon
+  module Changes
+    def self.change_classes
+      @change_classes ||= []
+    end
+
+    def self.add_change_class(klass)
+      change_classes << klass
+    end
+
+    def self.change_class_by_type(type)
+      type = type.to_s
+      change_classes.find { |klass| klass::AUDIT_TYPE.to_s == type }
+    end
+  end
+end

data/lib/html_surgeon/node_reverser.rb

@@ -0,0 +1,79 @@
+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

data/lib/html_surgeon/service.rb

@@ -18,7 +18,15 @@ module HtmlSurgeon
 
     def css(css_selector)
       node_set = doc.css(css_selector)
-      ChangeSet.new(node_set, self)
+      ChangeSet.create(node_set, self)
+    end
+
+    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
+      end
+
+      self
     end
 
     private

data/lib/html_surgeon/version.rb

@@ -1,3 +1,3 @@
 module HtmlSurgeon
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/html_surgeon.rb

@@ -1,15 +1,22 @@
+require 'naught'
+require 'oj'
 require 'oj_mimic_json'
 require 'nokogiri'
 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/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'
 
 module HtmlSurgeon
+  DATA_CHANGE_AUDIT_ATTRIBUTE = 'data-surgeon-audit'.freeze
+
   def self.for(html_string, **options)
     Service.new html_string, **options
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_surgeon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: naught
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,10 +140,13 @@ files:
 - html_surgeon.gemspec
 - lib/html_surgeon.rb
 - lib/html_surgeon/abstract_method_error.rb
+- lib/html_surgeon/auditor.rb
 - lib/html_surgeon/change.rb
 - lib/html_surgeon/change_set.rb
+- 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_reverser.rb
 - lib/html_surgeon/service.rb
 - lib/html_surgeon/version.rb
 homepage: https://github.com/eturino/html_surgeon