spec_views 1.1.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7f8a52383504378eddee951cba9a8fc6a47f255da78ed1a130eee0fa814ada
-  data.tar.gz: c8fabfb166786ccb35a9ecb3b195851b04c73bea7b6fe3a0a823a3e72b963469
+  metadata.gz: af819d4fc2aa2487c81eb455030288533b00153f6fde05a5152211734c1625c1
+  data.tar.gz: c3b653db474cd69198cf0ccdd9be78a9c224be98a8802bcb0d4941553081e20c
 SHA512:
-  metadata.gz: 838f2fc2cb3002b3e8b3d8274ba1f1e14ea0d3fcea5d54a6ff6bdf8e9919ab37f1c3f3b8a90594ff1911bb588230d513d78a444b838452f9115120eaf71d8dc8
-  data.tar.gz: f3fb138e0899c4a448fe2b8c3121420b6b86162a6ef3f4b5b9a81fed764e6ca3aad89c311f66381aff4d4b4a5024f87fa5c01010fb92e8621007f80fc2cb1c37
+  metadata.gz: d5e1a78b8fe0cea35ab90985f35eeb512e12c262171a3279c1aead04f754aef40c29adf9e236d58d844a59f36f05fd8fea1f4ec16c6809b97e7f051dc15e978b
+  data.tar.gz: 296860d1ef38ce4136d7a5a61229aa5ece286c9aeaef409d0688eaf801e7e631fe0019bfd91370ebf077a029ecf2d63564d32a08e871ff17f837b2eb5560cb92

data/README.md

@@ -1,5 +1,5 @@
 # SpecViews
-Render views from controller specs for comparision.
+Save views from request and controller specs for comparision.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -13,7 +13,7 @@ And this to RSpec's rails_helper.rb:
 require 'spec_views/support'
 ```
 
-And then execute:
+Then execute:
 ```bash
 $ bundle
 ```
@@ -25,19 +25,125 @@ Ignore some generated files in your .gitignore:
 ```
 
 ## Usage
-Replace selected RSpec `it` methods with `render`:
+Use the `match_html_fixture` matcher in your spec:
+
+```ruby
+RSpec.describe "Articles", type: :request do
+  describe 'GET /articles' do
+    it 'renders the listing' do
+      get articles_path
+      expect(response).to match_html_fixture
+    end
+  end
+end
+```
+
+Run this spec to see it failing. Open SpecView UI [http://localhost:3000/spec_views](http://localhost:3000/spec_views) on Rails development server to accept the new view. When rerunning the spec it compares its rendering with the reference view. Use SpecView UI to review, accept or reject changed views.
+
+### view_sanitizer
+Sometimes it is hard to remove dynamic elements like IDs and times. Use `view_sanitizer.gsub` to replace dynamic strings with fixed ones before comparing and saving the views automatically:
+
+```ruby
+before do
+  view_sanitizer.gsub(%r{(users/)[0-9]+}, '\1ID')
+  view_sanitizer.gsub(/value="[0-9]+"/, 'value="ID"')
+end
+```
+
+`view_sanitizer.gsub` supports the same arguments as `String#gsub` including blocks.
+
+### it_renders
+You can also use the shortcut to skip the matcher and the word "renders" from your description:
+
+```ruby
+RSpec.describe "Articles", type: :request do
+  describe 'GET /articles' do
+    it_renders 'the listing' do
+      get articles_path
+    end
+  end
+end
+```
+
+### Different response status
+By default only status 200 responses are compared. Tell the matcher if your response has another one:
+
+```ruby
+RSpec.describe "Articles", type: :request do
+  describe 'GET /articles' do
+    it 'renders the listing' do
+      get articles_path
+      expect(response).to match_html_fixture.for_status(:not_found) # or 404
+    end
+  end
+end
+```
+
+### PDF matching
+If your request responds with a PDF you can compare it as well:
+
+```ruby
+RSpec.describe "Articles", type: :request do
+  describe 'GET /articles/1/download' do
+    it 'downloads as PDF' do
+      get article_path(1, format: :pdf)
+      expect(response).to match_pdf_fixture
+    end
+  end
+end
+```
+
+### Mailer specs
+Compare HTML mailers. `match_html_fixture` tries to find the HTML part of your mail automatically:
+
+```ruby
+RSpec.describe NotificationsMailer, type: :mailer do
+  describe '#notify' do
+    let(:mail) { NotificationsMailer.signup }
+
+    it 'renders the body' do
+      expect(mail).to match_html_fixture
+    end
+  end
+end
+```
+
+### Feature specs
+Compare pages from feature specs:
+
+```ruby
+RSpec.describe 'Articles', type: :feature do
+  it 'are shown as list' do
+    expect(page).to match_html_fixture
+  end
+end
+```
+
+### Controller specs
+Prefer request specs over controller specs. If you still want to use controller specs enable the `render_views` feature:
 
 ```ruby
 RSpec.describe HomeController, type: :controller do
   describe 'GET #show' do
-    render 'homepage' do
+    render_views
+
+    it 'renders the homepage' do
       get :show
+      expect(response).to match_html_fixture
     end
   end
 end
 ```
 
-Run this spec to see it failing. Open SpecView UI [http://localhost:3000/spec_views](http://localhost:3000/spec_views) on Rails development server to accept the new view. When rerunning the spec it compares its rendering with the reference view. Use SpecView UI to review, accept or reject changed views.
+The `it_renders` shortcuts enables `render_views` automatically.
+
+## Configuration
+Configure SpecView by adding and modifying lines to `config/environments/test.rb` and `config/environments/development.rb`:
+
+```ruby
+config.spec_views.directory = 'spec/fixtures/views'
+config.spec_views.ui_url = 'http://localhost:3000/spec_views'
+```
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,7 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
 load 'rails/tasks/statistics.rake'

data/app/assets/config/spec_views_manifest.js

@@ -0,0 +1 @@
+//= link spec_views/diff.js

data/app/assets/javascripts/spec_views/diff.js

@@ -0,0 +1,60 @@
+//= require spec_views/jsdiff
+
+var a = document.getElementById('diff-champion');
+var b = document.getElementById('diff-challenger');
+var result = document.getElementById('diff-result');
+
+function changed() {
+	var diff = JsDiff[window.diffType](a.textContent, b.textContent);
+	var fragment = document.createDocumentFragment();
+	for (var i=0; i < diff.length; i++) {
+
+		if (diff[i].added && diff[i + 1] && diff[i + 1].removed) {
+			var swap = diff[i];
+			diff[i] = diff[i + 1];
+			diff[i + 1] = swap;
+		}
+
+		var node;
+		if (diff[i].removed) {
+			node = document.createElement('del');
+			node.appendChild(document.createTextNode(diff[i].value));
+		} else if (diff[i].added) {
+			node = document.createElement('ins');
+			node.appendChild(document.createTextNode(diff[i].value));
+		} else {
+			node = document.createTextNode(diff[i].value);
+		}
+		fragment.appendChild(node);
+	}
+
+	result.textContent = '';
+	result.appendChild(fragment);
+}
+
+window.onload = function() {
+	onDiffTypeChange(document.querySelector('#diff-settings [name="diff_type"]:checked'));
+	changed();
+};
+
+a.onpaste = a.onchange =
+b.onpaste = b.onchange = changed;
+
+if ('oninput' in a) {
+	a.oninput = b.oninput = changed;
+} else {
+	a.onkeyup = b.onkeyup = changed;
+}
+
+function onDiffTypeChange(radio) {
+	window.diffType = radio.value;
+	document.title = "Diff " + radio.value.slice(4);
+}
+
+var radio = document.getElementsByName('diff_type');
+for (var i = 0; i < radio.length; i++) {
+	radio[i].onchange = function(e) {
+		onDiffTypeChange(e.target);
+		changed();
+	}
+}