still_life 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8dc100759230e82f493b0bae7e3c6fc600f854ef6ff77a858037e92a662aaa7
+  data.tar.gz: f432cd88652963f9ffa70a249aa1554d3d0ce37ab5742d84538bcaebdca185e7
+SHA512:
+  metadata.gz: 9cdcef43678b79532a812b2bd4d9006ad63fd75b27ed28ddf606bd7ff20e77f1860fb1dd3e13be8dd2f297d4ef140b4eaa7f69b2adf60f3e7c72c02ee6afb725
+  data.tar.gz: 812976cf80fa3b687dd11a3bafcc4642462544019726ad61fd96dc5ed9110724f6ef886b6d3016b09ea9bc35360c866c8ea4c5d60e365056168e1f4e64df8b48

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+Gemfile.*.lock
+log/
+*.sqlite3
+/test/dummy_app/tmp/cache/
+/test/dummy_app/tmp/html/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in still_life.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Akira Matsuda
+
+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,152 @@
+# still_life
+
+## What's This?
+
+still_life is a testing framework enhancements for test-unit, minitest, RSpec, and Capybara that records all HTML response body texts that are rendered during E2E or unit test executions.
+
+
+## So What?
+
+You can compare actually rendered HTML results before and after any app updates.
+
+
+## For What?
+
+By comparing all these HTML files that are processed before and after any kind of code change, you can make sure that you did not (or you did) introduce any new user-facing incompatibilities.
+This may greatly help you for example, refactoring your app, replacing external libraries, or upgrading libraries.
+My personal use case that made me gemifying still_life was that I wanted to make sure that [my own template engine](https://github.com/amatsuda/himl) renders the same HTML as the one that I was using.
+
+But indeed, the real sweet spot of this tiny library is IMO "Rails upgrade".
+In fact, The first original version of this tool was implemented as an RSpec monkeypatch while we were upgrading a huge Rails application from Rails 2 to Rails 3.
+
+
+## Installation
+
+Bundle `still_life` gem to your Rails app's `:test` environment.
+
+```ruby
+gem 'still_life', group: :test
+```
+
+
+## Usage
+
+Run tests with an envvar `STILL_LIFE`. Then still_life creates some HTML files under `tmp/html/#{ENV['STILL_LIFE']}/` directory.
+Each .html file is named from the location in your test code where the request was made.
+
+For instance, if you run the tests against a simple scaffold app, the generated files will be like this:
+
+```sh
+% STILL_LIFE=rails52 rails test:system test
+% tree tmp/html
+tmp/html
+└── rails52
+    └── test
+        ├── controllers
+        │   ├── users_controller_test.rb-14.html
+        │   ├── users_controller_test.rb-20.html
+        │   ├── users_controller_test.rb-27.html
+        │   ├── users_controller_test.rb-32.html
+        │   ├── users_controller_test.rb-37.html
+        │   ├── users_controller_test.rb-43.html
+        │   └── users_controller_test.rb-9.html
+        └── system
+            ├── users_test.rb-14.html
+            ├── users_test.rb-18.html
+            ├── users_test.rb-21.html
+            ├── users_test.rb-25.html
+            ├── users_test.rb-26.html
+            ├── users_test.rb-29.html
+            ├── users_test.rb-32.html
+            ├── users_test.rb-36.html
+            ├── users_test.rb-37.html
+            └── users_test.rb-9.html
+
+4 directories, 17 files
+```
+
+And each file content is just an HTML.
+```html
+% cat tmp/html/rails52/test/system/users_test.rb-18.html
+<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head>
+    <title>StillLifeTest</title>
+    
+    
+
+    <link rel="stylesheet" media="all" href="/assets/application-35729bfbaf9967f119234595ed222f7ab14859f304ab0acc5451afb387f637fa.css" data-turbolinks-track="reload" />
+    <script src="/assets/application-3c2e77f06bf9a01c87fc8ca44294f3d3879d89483d83b66a13a89fc07412dd59.js" data-turbolinks-track="reload"></script>
+  </head>
+
+  <body>
+    <p id="notice">User was successfully created.</p>
+
+<p>
+  <strong>Name:</strong>
+  MyString
+</p>
+
+<a href="/users/980190963/edit">Edit</a> |
+<a href="/users">Back</a>
+
+  
+
+</body></html>
+```
+
+
+## Usage Scenario
+
+Consider you have a well-tested Rails 5.2 app, and you want to upgrade its Rails version to 6.0 without introducing any user-facing incompatibilities.
+Then the workflow will be as follows:
+
+### 1. Draw a still_life with the 5.2 app
+
+```sh
+% STILL_LIFE=rails52 rails test:system test
+```
+
+### 2. Do the upgrade job
+
+```sh
+% bundle u
+% rails app:update
+```
+and push some more commits...
+
+### 3. Draw another still_life with the 6.0 app
+
+```sh
+% STILL_LIFE=rails60 rails test:system test
+```
+
+### 4. Compare the results, and make sure there's no unexpected diffs
+
+```sh
+% diff -r tmp/html/rails52 tmp/html/rails60
+```
+
+
+## Notes
+### Random Values
+
+If your response includes some kind of random values, the test results may change between each test runs.
+In such case, maybe you could specify a random seed, or mock the random source in your app, or `grep -v` is always your friend.
+
+
+## TODOs / Known Issues
+- The Capybara monkeypatch sometimes fails to get the `page.body` due to Capybara timing problem
+- Support older versions of Rails, Capybara, and Ruby
+
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/amatsuda/still_life.
+
+
+## Credit
+
+The original idea of this library was implemented as a 10 LOC anonymous module by [@hotchpotch](https://github.com/hotchpotch) at Cookpad Inc. back in 2011 as written in [this slide](https://speakerdeck.com/a_matsuda/the-recipe-for-the-worlds-largest-rails-monolith?slide=129).
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb'] - FileList['test/dummy_app/test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "still_life"
+
+# 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/lib/still_life.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'still_life/version'
+require_relative 'still_life/action_dispatch_extension'
+require_relative 'still_life/capybara_extension'
+require_relative 'still_life/railtie'
+
+module StillLife
+  def self.draw(html)
+    location = caller.detect {|c| c =~ /^#{Rails.root}/}.remove(Rails.root.to_s, /:in .*$/).prepend("#{ENV['STILL_LIFE'] || ENV['STILLLIFE']}/")
+
+    if html.present?
+      pathname, i = Rails.root.join("tmp/html/#{location.tr(':', '-')}.html"), 1
+      while pathname.exist?
+        i += 1
+        pathname = Rails.root.join("tmp/html/#{location.tr(':', '-')}_#{i}.html")
+      end
+      pathname.parent.mkpath
+      pathname.write html
+    end
+  end
+end

data/lib/still_life/action_dispatch_extension.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module StillLife
+  module ActionDispatchExtension
+    def get(*args)
+      super(*args).tap do
+        StillLife.draw(response.body)
+      end
+    end
+
+    def post(*args)
+      super(*args).tap do
+        StillLife.draw(response.body)
+      end
+    end
+
+    def put(*args)
+      super(*args).tap do
+        StillLife.draw(response.body)
+      end
+    end
+
+    def patch(*args)
+      super(*args).tap do
+        StillLife.draw(response.body)
+      end
+    end
+
+    def delete(*args)
+      super(*args).tap do
+        StillLife.draw(response.body)
+      end
+    end
+  end
+end

data/lib/still_life/capybara_extension.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module StillLife
+  module CapybaraExtension
+    module ElementExtension
+      def click(*)
+        return super if Thread.current[:_still_life_inside_modal]
+
+        body_was = session.body
+        super.tap do
+          session.find('body')
+          if session.body.present? && (session.body != body_was)
+            StillLife.draw(session.body)
+          end
+        end
+      end
+    end
+
+    module SessionExtension
+      def visit(*)
+        super.tap do
+          if body.present?
+            StillLife.draw(body)
+          end
+        end
+      end
+
+      private def accept_modal(*)
+        Thread.current[:_still_life_inside_modal] = true
+        body_was = body
+        super.tap do
+          if body.present? && (body != body_was)
+            StillLife.draw(body)
+          end
+        end
+      ensure
+        Thread.current[:_still_life_inside_modal] = nil
+      end
+
+      private def dismiss_modal(*)
+        Thread.current[:_still_life_inside_modal] = true
+        body_was = body
+        super.tap do
+          if body.present? && (body != body_was)
+            StillLife.draw(body)
+          end
+        end
+      ensure
+        Thread.current[:_still_life_inside_modal] = nil
+      end
+    end
+
+    def self.included(*)
+      Capybara::Node::Element.prepend ElementExtension
+      Capybara::Session.prepend SessionExtension
+    end
+  end
+end

data/lib/still_life/railtie.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module StillLife
+  class Railtie < Rails::Railtie
+    initializer 'still_life' do
+      if ENV['STILL_LIFE'] || ENV['STILLLIFE']
+        ActiveSupport.on_load :action_dispatch_integration_test do
+          ActionDispatch::Integration::Session.prepend StillLife::ActionDispatchExtension
+        end
+        ActiveSupport.on_load :action_dispatch_system_test_case do
+          ActionDispatch::SystemTestCase.include StillLife::CapybaraExtension
+        end
+
+        begin
+          require 'rspec-rails'
+
+          #TODO maybe we could use some kind of hook instead of directly configuring here?
+          RSpec.configure do |config|
+            # config.prepend StillLife::ActionDispatchExtension, type: :request
+            config.prepend StillLife::ActionDispatchExtension, type: :controller
+            config.include StillLife::CapybaraExtension, type: :feature
+          end
+        rescue LoadError
+        end
+      end
+    end
+  end
+end

data/lib/still_life/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StillLife
+  VERSION = '0.1.0'
+end

data/still_life.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "still_life/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "still_life"
+  spec.version       = StillLife::VERSION
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = 'Test result HTML recorder'
+  spec.description   = 'Test result HTML recorder for capybara, test-unit, minitest, and RSpec'
+  spec.homepage      = 'https://github.com/amatsuda/still_life'
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'test-unit-rails'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: still_life
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rails
+  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: Test result HTML recorder for capybara, test-unit, minitest, and RSpec
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/still_life.rb
+- lib/still_life/action_dispatch_extension.rb
+- lib/still_life/capybara_extension.rb
+- lib/still_life/railtie.rb
+- lib/still_life/version.rb
+- still_life.gemspec
+homepage: https://github.com/amatsuda/still_life
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Test result HTML recorder
+test_files: []