capybara-differ 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a8bb2815f0d0de7e7f8ddea216f6a1bbac9059a
+  data.tar.gz: 7f959782fef98cca25a13be7fe89467538e621ca
+SHA512:
+  metadata.gz: ddd8d05d4c08a3c7881470b291a4ca68e27f08835e45bdb92c595852b51b49b3152fd6be1d1ea5e1cbac6bd40839e295424a388cf699207b79185347f7359af2
+  data.tar.gz: 05e759136e5b7324d93ba81c2b02649d172c8f060d6f0aeeef89a4b66a023bbd45139fb00d447580a69c6f1215cbe6fc2c3bbb4ff6e8d4228613a26d4f1fab64

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capybara-differ.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kazuho Yamaguchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Capybara::Differ
+
+Print the diff of snapshots with Capybara.
+This will help refactoring of views.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-differ'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-differ
+
+## Usage
+
+In your system test(feature spec)
+
+```
+page.check_page('name_of_snapshot', selector: 'table')
+```
+
+You can get the diff from the history of `Capybara:Session#save_page`.
+
+In this example(when you add class to table header),  
+you will see the diff of latest snapshot and the first snapshot in _tmp/capybara/name_of_snapshot/_ .
+
+```
+       <th class="id">
+         ID
+       </th>
+-      <th class="name">
++      <th class="name foo">
+         Name
+       </th>
+```
+
+You can reset the target snapshot by removing files in _tmp/capybara/name_of_snapshot/_ .  
+Or remove the directory of snapshots.
+
+## TODO
+
+- Add an option to compare with the previous snapshot
+- Add an option to suppress log
+- Others
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kyamaguchi/capybara-differ.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara-differ"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara-differ.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capybara-differ/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-differ"
+  spec.version       = Capybara::Differ::VERSION
+  spec.authors       = ["Kazuho Yamaguchi"]
+  spec.email         = ["kzh.yap@gmail.com"]
+
+  spec.summary       = %q{Snapshot pages and display diff to help refactoring.}
+  spec.description   = %q{Snapshot pages and display diff to help refactoring.}
+  spec.homepage      = "https://github.com/kyamaguchi/capybara-differ"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capybara"
+  spec.add_dependency "selenium-webdriver"
+  spec.add_dependency "htmlbeautifier"
+  spec.add_dependency "diffy"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/capybara-differ.rb

@@ -0,0 +1,66 @@
+require 'byebug'
+require 'htmlbeautifier'
+require 'diffy'
+require 'capybara'
+require "capybara-differ/version"
+
+module Capybara
+  module Differ
+
+    class Comparator
+      def initialize(old_file_path, new_file_path, options = {})
+        @old_file_path = old_file_path
+        @new_file_path = new_file_path
+        @options = options
+      end
+
+      def compare
+        if @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)
+      end
+
+      def beautified_html(file)
+        raise ArgumentError, "#{file} not found" unless File.exist?(file)
+        doc = Nokogiri.HTML(File.read(file))
+
+        # Add line breaks to get diff by elements
+        doc.traverse do |x|
+          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)
+      end
+
+      private
+
+      def target_selector
+        @options.fetch(:selector, nil)
+      end
+    end
+
+    def check_page(name, options = {})
+      filename = File.join(name, Time.now.strftime('%Y%m%d%H%M%S') + '.html')
+      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
+
+      comparator = Capybara::Differ::Comparator.new(old_html_path, new_html_path, options)
+      if (result = comparator.compare).strip.size > 0
+        puts result
+      else
+        puts "No difference on '#{name}' snapshots"
+      end
+    end
+  end
+end
+
+Capybara::Session.send(:include, Capybara::Differ)

data/lib/capybara-differ/version.rb

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

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: capybara-differ
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuho Yamaguchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: selenium-webdriver
+  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: htmlbeautifier
+  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: diffy
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Snapshot pages and display diff to help refactoring.
+email:
+- kzh.yap@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara-differ.gemspec
+- lib/capybara-differ.rb
+- lib/capybara-differ/version.rb
+homepage: https://github.com/kyamaguchi/capybara-differ
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Snapshot pages and display diff to help refactoring.
+test_files: []