museo 0.1.0

data/lib/museo/formatter.rb

@@ -0,0 +1,49 @@
+module Museo
+  class Formatter
+    def initialize(options = {})
+      @indent = options.delete(:indent) || "  ".freeze
+    end
+
+    def format(object, indent_level = 0)
+      case object
+      when Hash
+        format_hash(object, indent_level)
+      when Array
+        format_array(object, indent_level)
+      else
+        format_value(object)
+      end
+    end
+
+    private
+
+    def format_hash(hash, indent_level)
+      [
+        "{",
+        hash.map do |key, value|
+          "#{@indent * (indent_level + 1)}#{format(key)} => #{format(value, indent_level + 1)},"
+        end,
+        "#{@indent * indent_level}}",
+      ].join("\n")
+    end
+
+    def format_array(array, indent_level)
+      [
+        "[",
+        array.map do |value|
+          "#{@indent * (indent_level + 1)}#{format(value, indent_level + 1)},"
+        end,
+        "#{@indent * indent_level}]",
+      ].join("\n")
+    end
+
+    def format_value(value)
+      case value
+      when Symbol
+        value.inspect
+      else
+        value.to_s
+      end
+    end
+  end
+end

data/lib/museo/minitest_integration.rb

@@ -0,0 +1,33 @@
+module Museo
+  module MinitestIntegration
+    include TestIntegration
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def snapshot(description)
+        test "snapshot: #{description}" do
+          begin
+            _museo_setup
+
+            instance_eval(&Proc.new)
+
+            assert_snapshot
+          ensure
+            _museo_teardown
+          end
+        end
+      end
+    end
+
+    def assert_snapshot
+      assert_equal(
+        Snapshot::Minitest.new(self).body,
+        Snapshot.sanitize_response(response.body),
+        "Snapshot did not match",
+      )
+    end
+  end
+end

data/lib/museo/rspec_integration.rb

@@ -0,0 +1,33 @@
+module Museo
+  module RspecIntegration
+    include TestIntegration
+
+    def self.included(base)
+      base.render_views
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def snapshot(description)
+        it "matches snapshot: #{description}" do |example|
+          begin
+            _museo_setup
+
+            instance_exec(example, &Proc.new)
+
+            expect_matching_snapshot(example)
+          ensure
+            _museo_teardown
+          end
+        end
+      end
+    end
+
+    def expect_matching_snapshot(example)
+      expect(Snapshot::Rspec.new(self, example.metadata).body).to(
+        eq(Snapshot.sanitize_response(response.body)),
+        "Snapshot did not match",
+      )
+    end
+  end
+end

data/lib/museo/snapshot/minitest.rb

@@ -0,0 +1,13 @@
+module Museo
+  class Snapshot
+    class Minitest < Snapshot
+      def initialize(test_case)
+        super(
+          klass: test_case.class,
+          test_name: test_case.name,
+          response: test_case.response,
+        )
+      end
+    end
+  end
+end

data/lib/museo/snapshot/rspec.rb

@@ -0,0 +1,13 @@
+module Museo
+  class Snapshot
+    class Rspec < Snapshot
+      def initialize(example, metadata)
+        super(
+          klass: metadata[:described_class],
+          test_name: metadata[:description],
+          response: example.response,
+        )
+      end
+    end
+  end
+end

data/lib/museo/snapshot.rb

@@ -0,0 +1,63 @@
+require "fileutils"
+require_relative "snapshot/rspec"
+require_relative "snapshot/minitest"
+
+module Museo
+  class Snapshot
+    class GenerationDisabledError < StandardError; end
+
+    class << self
+      def sanitize_response(body)
+        body.gsub(/:0x[a-fA-F0-9]{4,}/, ":0xXXXXXX")
+      end
+    end
+
+    def initialize(klass:, test_name:, response:)
+      @class_name = klass.to_s
+      @test_name = test_name
+      @response = response
+
+      generate unless exists?
+    end
+
+    def body
+      exists? ? File.read(path) : nil
+    end
+
+    private
+
+    def exists?
+      File.exist?(path)
+    end
+
+    def folder
+      Museo.pathname(@class_name)
+    end
+
+    def file_name
+      "#{Museo.clean_name(@test_name)}.snapshot"
+    end
+
+    def path
+      Museo.rails_root.join(folder, file_name)
+    end
+
+    def sanitized_response
+      self.class.sanitize_response(@response.body.to_s)
+    end
+
+    def generate
+      if Museo.configuration.generation_disabled
+        fail GenerationDisabledError,
+             "Can't generate snapshots in a CI environment. " \
+             "Please generate snapshots locally first"
+      end
+
+      FileUtils.mkdir_p(folder)
+
+      File.open(path, "wb") { |f| f.print sanitized_response }
+
+      puts "Updated snapshot for #{file_name.inspect}"
+    end
+  end
+end

data/lib/museo/test_integration.rb

@@ -0,0 +1,51 @@
+module Museo
+  module TestIntegration
+    def _museo_setup
+      _add_snapshot_helper_methods
+      _redefine_render_with_snapshot_layout
+    end
+
+    def _museo_teardown
+      _remove_snapshot_helper_methods
+    end
+
+    def _add_snapshot_helper_methods
+      @controller.class.helper do
+        Museo.configuration.stubbed_methods.each do |method_name, callable|
+          alias_method("_original_#{method_name}", method_name) if method_defined?(method_name)
+
+          define_method(method_name) do |*args, &block|
+            output = callable.respond_to?(:call) ? instance_exec(*args, block, &callable) : callable
+
+            [
+              "<!--",
+              "Stubbed method call: #{method_name}",
+              Museo.configuration.formatter.format(output),
+              "-->",
+              "",
+            ].join("\n").html_safe
+          end
+        end
+      end
+    end
+
+    def _remove_snapshot_helper_methods
+      @controller.class.helper do
+        Museo.configuration.stubbed_methods.each do |method_name, _callable|
+          remove_method method_name
+
+          if method_defined?("_original_#{method_name}")
+            alias_method method_name, "_original_#{method_name}"
+          end
+        end
+      end
+    end
+
+    def _redefine_render_with_snapshot_layout
+      @controller.define_singleton_method(:render) do |*args|
+        options = args.length > 1 ? args.last : {}
+        super(*args[1..-2], options.merge(layout: "museo/snapshot"))
+      end
+    end
+  end
+end

data/lib/museo/version.rb

@@ -0,0 +1,3 @@
+module Museo
+  VERSION = "0.1.0"
+end

data/lib/museo.rb

@@ -0,0 +1,68 @@
+require "rails"
+require "museo/version"
+require "museo/formatter"
+require "museo/snapshot"
+require "museo/test_integration"
+require "museo/minitest_integration"
+require "museo/rspec_integration"
+require "museo/engine"
+
+module Museo
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def rails_root
+      @rails_root ||= Rails::Application.find_root(Dir.pwd)
+    end
+
+    def clean_name(name)
+      if name
+        name.gsub("::", "/").gsub(/[^0-9a-z\/]+/i, "_")
+      else
+        ""
+      end
+    end
+
+    def pathname(class_name = "")
+      test_directory = Museo.configuration.rspec ? "spec" : "test"
+
+      Museo.rails_root.join(test_directory, "snapshots", clean_name(class_name))
+    end
+
+    def clear_configuration!
+      @configuration = Configuration.new
+    end
+  end
+
+  class Configuration
+    attr_accessor :formatter
+    attr_accessor :rspec
+    attr_accessor :generation_disabled
+
+    def initialize
+      @formatter = Museo::Formatter.new
+      @rspec = false
+      @generation_disabled = !!ENV["CI"]
+    end
+
+    def stubbed_methods
+      @stubbed_methods ||= {}
+    end
+
+    def stub(name, value = nil)
+      value = block_given? ? Proc.new : value
+
+      stubbed_methods[name] = value
+    end
+
+    def clear_stubs!
+      @stubbed_methods = {}
+    end
+  end
+end

data/lib/tasks/museo_tasks.rake

@@ -0,0 +1 @@
+# rake tasks

data/museo.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "museo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "museo"
+  spec.version       = Museo::VERSION
+  spec.authors       = ["Daniel Ma"]
+  spec.email         = ["drailskid@yahoo.com"]
+
+  spec.summary       = %(Snapshot testing for Rails views)
+  spec.description   = %(Provide snapshot testing utilities for Rails views)
+  spec.homepage      = "https://github.com/danielma/museo"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4", "< 5.1"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "rubocop", "~> 0.42"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "awesome_print"
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: museo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Ma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: guard-minitest
+  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: pry
+  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: awesome_print
+  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: Provide snapshot testing utilities for Rails views
+email:
+- drailskid@yahoo.com
+executables:
+- museo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- app/views/layouts/museo/snapshot.html.erb
+- bin/console
+- bin/setup
+- exe/museo
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_4.gemfile.lock
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_5.gemfile.lock
+- lib/museo.rb
+- lib/museo/cli.rb
+- lib/museo/engine.rb
+- lib/museo/formatter.rb
+- lib/museo/minitest_integration.rb
+- lib/museo/rspec_integration.rb
+- lib/museo/snapshot.rb
+- lib/museo/snapshot/minitest.rb
+- lib/museo/snapshot/rspec.rb
+- lib/museo/test_integration.rb
+- lib/museo/version.rb
+- lib/tasks/museo_tasks.rake
+- museo.gemspec
+homepage: https://github.com/danielma/museo
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Snapshot testing for Rails views
+test_files: []