capybara-differ 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a8bb2815f0d0de7e7f8ddea216f6a1bbac9059a
-  data.tar.gz: 7f959782fef98cca25a13be7fe89467538e621ca
+  metadata.gz: a4e1b27115e8f67ca29f21a0e1e05c7efedbd627
+  data.tar.gz: d58903f136fcc969e60043271549dc8168c657a9
 SHA512:
-  metadata.gz: ddd8d05d4c08a3c7881470b291a4ca68e27f08835e45bdb92c595852b51b49b3152fd6be1d1ea5e1cbac6bd40839e295424a388cf699207b79185347f7359af2
-  data.tar.gz: 05e759136e5b7324d93ba81c2b02649d172c8f060d6f0aeeef89a4b66a023bbd45139fb00d447580a69c6f1215cbe6fc2c3bbb4ff6e8d4228613a26d4f1fab64
+  metadata.gz: 97004fa0e5a4244f1d10f6ddb98a80d054f400c9e0e40167a796eb983c79f26f62d7bbfdaaac0a590d8dbe00877c8004fbf75b281e928f8e3ebcbf84cd24c676
+  data.tar.gz: 9311b8cc7da1de5520f0ccd149b4a72c32dd9c872093163f2f2ae6dde68487ae3d335eb214aeaf6c194d67eb9e95bfa43c9368a37c9e8f0885799d34e80bf2b8

data/.gitignore

@@ -14,3 +14,5 @@
 
 Gemfile.lock
 .byebug_history
+
+/spec/fixtures/*/*.html.beauty

data/README.md

@@ -1,8 +1,32 @@
 # Capybara::Differ
 
-Print the diff of snapshots with Capybara.
+[![Gem Version](https://badge.fury.io/rb/capybara-differ.svg)](https://badge.fury.io/rb/capybara-differ)
+[![Build Status](https://travis-ci.org/kyamaguchi/capybara-differ.svg?branch=master)](https://travis-ci.org/kyamaguchi/capybara-differ)
+
+Print the diff of snapshots with Capybara.  
 This will help refactoring of views.
 
+## Idea
+
+The main feature of this library is  **diffing beautified htmls**.
+
+You cannot always get nice diffs with 'git diff' or 'diff' command.  
+But this library gives them.  
+This library try to remove the concerns on diff of whitespaces, linebreaks.
+
+Expected use cases are
+
+* Refactoring views of Rails app
+    * Migration of erb -> haml
+    * Integration with [datagrid](https://github.com/bogdan/datagrid)
+* Tracking sites
+    * visit -> save_page -> check_page
+
+### Dependencies
+
+* https://github.com/samg/diffy
+* https://github.com/threedaymonk/htmlbeautifier
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -45,9 +69,35 @@ you will see the diff of latest snapshot and the first snapshot in _tmp/capybara
 You can reset the target snapshot by removing files in _tmp/capybara/name_of_snapshot/_ .  
 Or remove the directory of snapshots.
 
+### Options
+
+#### Compare with the previous version
+
+By default, the target snapshot is the first version.
+
+You can compare with the previous version with the following option
+
+```
+page.check_page('name_of_snapshot', compare_with: :previous, selector: 'table')
+```
+
+#### Diffy
+
+This library depends on [diffy](https://github.com/samg/diffy)
+You can pass the options for diffy something like 'context'.
+
+```
+page.check_page('name_of_snapshot', selector: 'table', diffy: {context: 3})
+```
+
+And you can change the format of output with diffy with 'format' option. (default :color)
+
+```
+page.check_page('name_of_snapshot', selector: 'table', diffy: {format: :html_simple})
+```
+
 ## TODO
 
-- Add an option to compare with the previous snapshot
 - Add an option to suppress log
 - Others
 

data/lib/capybara-differ/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Differ
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/capybara-differ.rb

@@ -15,14 +15,16 @@ module Capybara
       end
 
       def compare
-        if @old_file_path == @new_file_path
+        if @old_file_path.nil? || @new_file_path.nil? || @old_file_path == @new_file_path
           puts "There is no history of snapshots"
           return ''
         end
-        puts "Comparing two files#{target_selector ? ' with selector [' + target_selector + ']' : ''}\n  #{@old_file_path}\n  #{@new_file_path}"
-        old_html = beautified_html(@old_file_path)
-        new_html = beautified_html(@new_file_path)
-        Diffy::Diff.new(old_html, new_html, context: 2).to_s(:color)
+        puts "Comparing two files" + (target_selector ? " with selector [#{target_selector}]" : '')
+        puts "  #{@old_file_path}\n  #{@new_file_path}" unless diffy_options[:include_diff_info]
+        old_beautified_html_path = beautified_html(@old_file_path)
+        new_beautified_html_path = beautified_html(@new_file_path)
+        diff = Diffy::Diff.new(old_beautified_html_path, new_beautified_html_path, diffy_options.merge(source: 'files'))
+        diff.to_s(diffy_options.fetch(:format, :color))
       end
 
       def beautified_html(file)
@@ -34,8 +36,13 @@ module Capybara
           x.content = "\n#{x.content.strip}\n" if x.text?
         end
 
-        html = target_selector ? doc.css(target_selector).to_html : doc.to_html
-        HtmlBeautifier.beautify(html)
+        node = doc.css(target_selector || default_selector)
+        raise("Couldn't find the selector [#{target_selector}]") if node.empty?
+        beautified_html = HtmlBeautifier.beautify(node.to_html)
+
+        beautified_html_path = file + '.beauty'
+        File.write(beautified_html_path, beautified_html)
+        beautified_html_path
       end
 
       private
@@ -43,6 +50,14 @@ module Capybara
       def target_selector
         @options.fetch(:selector, nil)
       end
+
+      def default_selector
+        'body > *'
+      end
+
+      def diffy_options
+        {context: 2, include_diff_info: true}.merge(@options.fetch(:diffy, {}))
+      end
     end
 
     def check_page(name, options = {})
@@ -50,8 +65,9 @@ module Capybara
       save_page(filename)
 
       base_dir = File.join([Capybara.save_path, name].compact)
-      old_html_path = Dir[File.join(base_dir, '*')].first
-      new_html_path = Dir[File.join(base_dir, '*')].last
+      file_list = Dir[File.join(base_dir, '*.html')]
+      old_html_path = options[:compare_with] == :previous ? file_list[-2] : file_list.first
+      new_html_path = file_list.last
 
       comparator = Capybara::Differ::Comparator.new(old_html_path, new_html_path, options)
       if (result = comparator.compare).strip.size > 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-differ
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kazuho Yamaguchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara