spec_views 1.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf7bc86e0273d8a6c9f07835a90f1a142585672b2a4b274686f40699ddd26ec7
-  data.tar.gz: 96167d907e224df18c9d41190e31f00546c41bf4812fbe0f896bf50bb1ea51e9
+  metadata.gz: 42a03f1d324852c51d56e4afdadadcc00e6449954917f396599df6c4568176d0
+  data.tar.gz: 466b8bddc2f1c78bed3bbe57370b26bc87f71ecf38e2476ccc46fa4237a5410a
 SHA512:
-  metadata.gz: 804a01e51bf028bc19a86626493736cee085e9151aafba1b3158e4500a97b1082c7324e84de8994940831da2a4ea84d78fbc5d19393489c8afb5b18a5d626513
-  data.tar.gz: 15d1e2a4c2ecebd4652a30ce9b7455b6f74a276697d35abccda2dc317a34512b9541a616b21d5c4647bb0ced3ab816518a44f0569965dc1ce9d19a5f4b460ddd
+  metadata.gz: 48a9730de38ccc7927d852015fcb7c051e783a8a603cb665df17095a45799e882a1cc276d09b31177a2bc7ee93c8c86a455e5d0f24314e80ad19b77adcb36860
+  data.tar.gz: a837bcd14d1e95707830291dbd621c41bef508c3fc858854bc22c6142aee2170b24d29f991c055b457da173db0b6a94e0920aaeef87cca13b5d4f13724393238

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();
+	}
+}