html_surgeon 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34619a8d9e7430b304e686b0a3dbdfb3d02ea140
-  data.tar.gz: 672e8ff3f2e8f2fecb3b9121ab8a54d870175d40
+  metadata.gz: a5cc452a219671d16b9eb20cac5a1163b99771ae
+  data.tar.gz: b38ec70aa5f76edee83f9ca0a37871cdf7dbd455
 SHA512:
-  metadata.gz: ef23b46708e249599fe9d28924f4ff7b2566fc5c01c55e055ff791d6680f1ef6355102ed278010bdcedcf4461814ae9c2b7629f1289c75fb8b1224f35e2e8c02
-  data.tar.gz: 79e27faa58ffaf5aff691105ba67433eaf6d31d26105010eed840e42f049b9a98b2e8f3ff7e60c4a441b67741fd2815c8fb0384f78f946a5ca4a176e9c0b14ad
+  metadata.gz: a2929310917817e2405d1432568f00e87e195d818e98ea3bc6143ce117674e9bc0e6a4b6d89b783168ba5f47e30a165ba42e692eb90856e82e7e7dd63dc77f62
+  data.tar.gz: 255c2c883ee2e9a901109aa622f830c0c58b64a9d178c90cc174b57dd3f99bc7561475db5d6c40d4b0dc24b84525bc596e83dfdefde5d98604b14bd580445eae

data/README.md

@@ -123,7 +123,7 @@ surgeon.css('.lol').replace_tag_name('span').add_css_class('hey').run
 surgeon.html # =>
 # <div>
 #     <h1>Something</h1>
-#     <span id="1" class="lol to-be-changed hey" data-surgeon-audit='[{"change_set":"830e96dc-fa07-40ce-8968-ea5c55ec4b84","changed_at":"2015-07-02T12:52:43.874Z","type":"replace_tag_name","old":"div","new":"span"},{"change_set":"830e96dc-fa07-40ce-8968-ea5c55ec4b84","changed_at":"2015-07-02T12:52:43.874Z","type":"add_css_class","existed_before":false,"class":"hey"}]'>1</span>
+#     <span id="1" class="lol to-be-changed hey" data-surgeon-audit='[{"change_set":"830e96dc-fa07-40ce-8968-ea5c55ec4b84","changed_at":"2015-07-02T12:52:43.874Z","type":"replace_tag_name","old":"div","new":"span"},{"change_set":"830e96dc-fa07-40ce-8968-ea5c55ec4b84","changed_at":"2015-07-02T12:52:43.874Z","type":"add_css_class","class":"hey"}]'>1</span>
 #     <span>Other</span>
 #     <div id="2" class="another to-be-changed">
 #         <ul>
@@ -149,7 +149,6 @@ the attribute's value (formatted) is:
     "change_set":"830e96dc-fa07-40ce-8968-ea5c55ec4b84",
     "changed_at":"2015-07-02T12:52:43.874Z",
     "type":"add_css_class",
-    "existed_before":false,
     "class":"hey"
   }
 ]
@@ -197,6 +196,12 @@ surgeon.css('div.to-be-changed').replace_tag_name('article')
 surgeon.css('div.to-be-changed').add_css_class('applied-some-stuff')
 ```
 
+### Remove Attribute
+
+```ruby
+surgeon.css('div.to-be-changed').remove_attribute('style')
+```
+
 ## Rollback
 
 the surgeon can be used to revert any audited rollback. We can select what changes to rollback based on:
@@ -270,6 +275,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/eturin
 ## CHANGESET
 
 
+### v0.7.0
+
+- added `remove_attribute` change.
+- changes will be skipped if not needed on that node (will not do anything, nor be added to the audit).
+
 ### v0.6.0
 
 - *WARNING: BREAKING API CHANGE*: now `rollback` and `clear_audit` return the number of changes performed

data/lib/html_surgeon.rb

@@ -11,6 +11,7 @@ require 'html_surgeon/change_set'
 require 'html_surgeon/change'
 require 'html_surgeon/changes'
 require 'html_surgeon/changes/add_css_class'
+require 'html_surgeon/changes/remove_attribute'
 require 'html_surgeon/changes/replace_tag_name'
 require 'html_surgeon/node_services/audit_cleaner'
 require 'html_surgeon/node_services/reverser'

data/lib/html_surgeon/change.rb

@@ -14,13 +14,19 @@ module HtmlSurgeon
     end
 
     def apply(node)
+      return false unless applicable?(node)
+
       auditor = auditor_class.new(node)
 
       auditor.add_change(audit_data(node))
       apply_in node
       auditor.apply
 
-      self
+      true
+    end
+
+    def applicable?(_node)
+      raise AbstractMethodError, "a lazy developer has not implemented this method in #{self.class}"
     end
 
     def auditor_class
@@ -39,7 +45,7 @@ module HtmlSurgeon
       }
     end
 
-    def audit_data(node)
+    def audit_data(_node)
       raise AbstractMethodError, "a lazy developer has not implemented this method in #{self.class}"
     end
 

data/lib/html_surgeon/change_set.rb

@@ -84,14 +84,16 @@ module HtmlSurgeon
         end
       end
 
-      do_apply_on_node(node)
-      changed_nodes << node
+      applied = do_apply_on_node(node)
+      changed_nodes << node if applied
     end
 
     def do_apply_on_node(node)
-      change_list.each do |change|
+      map = change_list.map do |change|
         change.apply(node)
       end
+
+      map.any? { |result| !!result }
     end
   end
 end

data/lib/html_surgeon/changes/add_css_class.rb

@@ -5,7 +5,7 @@ module HtmlSurgeon
 
       CLASS_ATTRIBUTE = 'class'.freeze
       CLASS_SEPARATOR = ' '.freeze
-      CLASS_XPATH     = './/@class'
+      CLASS_XPATH     = './/@class'.freeze
 
       attr_reader :css_class
 
@@ -20,33 +20,36 @@ module HtmlSurgeon
       end
 
       private
+      def applicable?(node)
+        !self.class.has_class? node, css_class
+      end
+
       def apply_in(node)
-        self.class.add_class_to_node css_class, node
+        self.class.add_class_to_node node, css_class
       end
 
-      def audit_data(node)
-        basic_audit_data.merge type:           AUDIT_TYPE,
-                               existed_before: self.class.has_class?(node, css_class),
-                               class:          css_class
+      def audit_data(_node)
+        basic_audit_data.merge type:  AUDIT_TYPE,
+                               class: css_class
       end
 
-      def self.add_class_to_node(css_class, node)
+      def self.add_class_to_node(node, css_class)
         classes = node_classes node
         classes << css_class unless classes.include? css_class
-        set_classes_in_node(classes, node)
+        set_classes_in_node(node, classes)
       end
 
-      def self.remove_class_to_node(css_class, node)
+      def self.remove_class_to_node(node, css_class)
         classes = node_classes node
         classes.delete css_class
         if classes.empty?
           node.xpath(CLASS_XPATH).remove
         else
-          set_classes_in_node(classes, node)
+          set_classes_in_node(node, classes)
         end
       end
 
-      def self.set_classes_in_node(classes, node)
+      def self.set_classes_in_node(node, classes)
         node.set_attribute(CLASS_ATTRIBUTE, classes.join(CLASS_SEPARATOR))
       end
 
@@ -59,8 +62,7 @@ module HtmlSurgeon
       end
 
       def self.revert(node, change_definition)
-        return if change_definition[:existed_before]
-        remove_class_to_node(change_definition[:class], node)
+        remove_class_to_node(node, change_definition[:class])
       end
 
       module ChangeSetMethods

data/lib/html_surgeon/changes/remove_attribute.rb

@@ -0,0 +1,60 @@
+module HtmlSurgeon
+  module Changes
+    class RemoveAttribute < Change
+      AUDIT_TYPE = :remove_attribute
+
+      attr_reader :attribute
+
+      def initialize(attribute:, **other)
+        @attribute = attribute
+
+        super **other
+      end
+
+      def log
+        "remove attribute #{attribute}"
+      end
+
+      private
+      def applicable?(node)
+        self.class.has_attribute?(node, attribute)
+      end
+
+      def apply_in(node)
+        self.class.remove_attribute node, attribute
+      end
+
+      def audit_data(node)
+        basic_audit_data.merge type:      AUDIT_TYPE,
+                               attribute: attribute,
+                               value:     self.class.attribute_in_node(node, attribute)
+      end
+
+      def self.remove_attribute(node, attribute)
+        node.xpath(".//@#{attribute}").remove
+      end
+
+      def self.set_attribute_in_node(node, attribute, value)
+        node.set_attribute(attribute, value)
+      end
+
+      def self.has_attribute?(node, attribute)
+        node.has_attribute?(attribute) && attribute_in_node(node, attribute).present?
+      end
+
+      def self.attribute_in_node(node, attribute)
+        node.get_attribute(attribute).to_s
+      end
+
+      def self.revert(node, change_definition)
+        set_attribute_in_node(node, change_definition[:attribute], change_definition[:value])
+      end
+
+      module ChangeSetMethods
+        def remove_attribute(attribute)
+          chain_add_change Changes::RemoveAttribute.new(change_set: self, attribute: attribute)
+        end
+      end
+    end
+  end
+end

data/lib/html_surgeon/changes/replace_tag_name.rb

@@ -16,6 +16,11 @@ module HtmlSurgeon
       end
 
       private
+
+      def applicable?(node)
+        node.name.to_s != new_tag_name.to_s
+      end
+
       def apply_in(node)
         node.name = new_tag_name
       end

data/lib/html_surgeon/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html_surgeon
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -145,6 +145,7 @@ files:
 - lib/html_surgeon/change_set.rb
 - lib/html_surgeon/changes.rb
 - lib/html_surgeon/changes/add_css_class.rb
+- lib/html_surgeon/changes/remove_attribute.rb
 - lib/html_surgeon/changes/replace_tag_name.rb
 - lib/html_surgeon/node_services/audit_cleaner.rb
 - lib/html_surgeon/node_services/reverser.rb