html_surgeon 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6988528869b8d0783dc66a3fc95ac318a39f44f4
-  data.tar.gz: 9b0a847987cf59900c58d88d68edf65a78c5d2cd
+  metadata.gz: ab5cdfb5f4b18b04314af4cb220395841332481e
+  data.tar.gz: 5411f9dd20388ca336f444891a4516e069534dc4
 SHA512:
-  metadata.gz: 9e5ffbded35f90903bc1aaa0af358dd903fa99024f122ff20195b4c91b667d8842136aa31546422ec12ee81d045be4d13d7ac6562c0844e3314ac260778b9ee8
-  data.tar.gz: 8baf36739a718bb7eb98a0208ebb92ef2564a8349492062cb5bac7275252d7449d8802a00c56481c45b711e26a54629f779a88db28b3cbd9ff5ec9e8464dec2d
+  metadata.gz: 1d663853d245a480ad691f8e1218bfca304b9790326909691477cebb4ab5af418a3adb7d4093afda7c4f7439a53bd963acb5fb02613e8fc275712db8dadd40f3
+  data.tar.gz: f27b7bd09a2fbbda7b3f3a04caf76ed8bb7745e3ec8282ae4100f9fb8b5a2adf6628b18999b9cbef40ea9d85e231ce195fdbdea3143d2bfdf2931659ff789d3b

data/README.md

@@ -180,7 +180,7 @@ change_set.run # => nodes skipped if reject callback return truthy or if select
 ### Replace Tag Name
 
 ```ruby
-surgeon.css('div.to-be-changed').replace_name_tag('article')
+surgeon.css('div.to-be-changed').replace_tag_name('article')
 ```
 
 ### Add CSS Class
@@ -191,7 +191,7 @@ 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:
+the surgeon 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
@@ -208,6 +208,21 @@ surgeon.rollback(changed_at: changed_at).html  # => returns the html with only t
 surgeon.rollback(changed_from: changed_from).html # => returns the html with any change sets with a timestamp more recent than `changed_from` reverted 
 ```
 
+## Clear Audit trail
+
+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
+```
+
+## Helper Methods
+
+### `HtmlSurgeon.node_has_css_class?(nokogiri_node, css_class)`
+
+it will return true if the given nokogiri node has that css_class
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -238,6 +253,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/eturin
 
 ## CHANGESET
 
+### v0.5.0
+
+- added `node_has_css_class?` helper method to `HtmlSurgeon`
+- added `clear_audit` to surgeon 
+
 ### v0.4.0
 
 - added `select` and `reject` callbacks to Change Set, based on blocks with `node` as single argument

data/lib/html_surgeon.rb

@@ -7,6 +7,7 @@ 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'
@@ -20,4 +21,10 @@ module HtmlSurgeon
   def self.for(html_string, **options)
     Service.new html_string, **options
   end
+
+  # helper methods
+  def self.node_has_css_class?(nokogiri_node, css_class)
+    Changes::AddCssClass.has_class? nokogiri_node, css_class
+  end
+
 end

data/lib/html_surgeon/changes/add_css_class.rb

@@ -26,7 +26,7 @@ module HtmlSurgeon
 
       def audit_data(node)
         basic_audit_data.merge type:           AUDIT_TYPE,
-                               existed_before: self.class.had_class?(node, css_class),
+                               existed_before: self.class.has_class?(node, css_class),
                                class:          css_class
       end
 
@@ -54,7 +54,7 @@ module HtmlSurgeon
         node.get_attribute(CLASS_ATTRIBUTE).to_s.split(CLASS_SEPARATOR)
       end
 
-      def self.had_class?(node, css_class)
+      def self.has_class?(node, css_class)
         node_classes(node).include? css_class
       end
 

data/lib/html_surgeon/node_audit_cleaner.rb

@@ -0,0 +1,22 @@
+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/service.rb

@@ -34,6 +34,14 @@ module HtmlSurgeon
       self
     end
 
+    def clear_audit
+      doc.css("[#{DATA_CHANGE_AUDIT_ATTRIBUTE}]").each do |node|
+        NodeAuditCleaner.new(node: node).call
+      end
+
+      self
+    end
+
     private
     def doc
       @doc ||= Nokogiri::HTML.fragment @given_html.dup

data/lib/html_surgeon/version.rb

@@ -1,3 +1,3 @@
 module HtmlSurgeon
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_surgeon
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -146,6 +146,7 @@ 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/service.rb
 - lib/html_surgeon/version.rb