rspec_fixtures 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f1f2d6588eaf7ebb37981b9f5aa5e55dd85fad0
-  data.tar.gz: 4b4987f63e870117de3c36b8362d78ddd88ac96f
+  metadata.gz: 48ef174e72d1e605f279b0d5ae0eedbf5b596fef
+  data.tar.gz: 075e93191e3acbf083ddf892cb6a1a46caba54b2
 SHA512:
-  metadata.gz: 783f4e3c8625d4bb2592e9b2df79a87363176f38ed147b413067206c853106b244a8dfbeab18c1cf65abd016af0dd76a5d4492e96e4ca0c418183384ff4aafba
-  data.tar.gz: 5d38f2e562d12c44ccce09df8ec13678cacee5a1bbc06bb5698372a8fbc61c13c122a8537d74089a29d43c8800e2133cbb0c43b0d060f81d95ef4034d6357c32
+  metadata.gz: 51fed96a9aca2abec950e09ddc47e6c9429f690ea4ab0f7e9864773aac82ed614b45bcd002842828fb6c31031efca6757cf151394c43e7202b80445d0731c15e
+  data.tar.gz: 9373abab432d93d9f8d823c7cbb77a21352ee94d5041e53e4fe23913bcc9fa4a84dbce932280a43cd2227a658637ebf3c1a082cd2c6cd9170043054d0f8266b2

data/README.md

@@ -3,9 +3,19 @@ RSpec Fixtures
 
 [![Gem](https://img.shields.io/gem/v/rspec_fixtures.svg?style=flat-square)](https://rubygems.org/gems/rspec_fixtures)
 [![Travis](https://img.shields.io/travis/DannyBen/rspec_fixtures.svg?style=flat-square)](https://travis-ci.org/DannyBen/rspec_fixtures)
-[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/rspec_fixtures.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/rspec_fixtures)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/DannyBen/rspec_fixtures.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/rspec_fixtures)
+[![Issues](https://img.shields.io/codeclimate/issues/github/DannyBen/rspec_fixtures.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/rspec_fixtures)
 [![Gemnasium](https://img.shields.io/gemnasium/DannyBen/rspec_fixtures.svg?style=flat-square)](https://gemnasium.com/DannyBen/rspec_fixtures)
 
+---
+
+RSpec Fixtures allows you to interactively review and approve testable
+content.
+
+![Demo](/demo.gif)
+
+---
+
 
 Install
 --------------------------------------------------
@@ -21,3 +31,72 @@ gem 'rspec_fixtures'
 ```
 
 
+Usage
+--------------------------------------------------
+
+Require the gem in your spec helper:
+
+```ruby
+# spec/spec_helper.rb
+require 'rspec_fixtures'
+```
+
+And use any of the matchers in your specs.
+
+```ruby
+describe 'ls' do
+  it "works" do
+    expect(`ls`).to match_fixture('ls_fixture')
+  end
+end
+```
+
+Matchers
+--------------------------------------------------
+
+### `match_fixture`
+
+Compare a string with a pre-approved fixture.
+
+```ruby
+expect('some string').to match_fixture('fixture_filename')
+```
+
+### `output_fixture`
+
+Compare an output (stdout or stderr) with a pre-approved fixture.
+
+```ruby
+expect{ puts "hello" }.to output_fixture('fixture_filename')
+expect{ puts "hello" }.to output_fixture('fixture_filename').to_stdout
+expect{ $stderr.puts "hello" }.to output_fixture('fixture_filename').to_stderr
+
+# The first two are the same, as the default stream is stdout.
+```
+
+
+Configuration
+--------------------------------------------------
+
+### `interactive_fixtures`
+
+By default, interactive approvals are enabled in any environment that 
+does not define the `CI` environment variable. You can change this by
+adding this to your `spec_helper`
+
+```ruby
+RSpec.configure do |config|
+  config.interactive_fixtures = false # or any logic
+end
+```
+
+### `fixtures_path`
+
+By default, fixtures are stored in `spec/fixtures`. To change the path,
+add this to your `spec_helper`.
+
+```ruby
+RSpec.configure do |config|
+  config.fixtures_path = 'spec/anywhere/else'
+end
+```

data/lib/rspec_fixtures.rb

@@ -1,5 +1,10 @@
 require 'rspec_fixtures/version'
 require 'rspec_fixtures/colors'
+
+require 'rspec_fixtures/stream_capturer'
+require 'rspec_fixtures/approval_handler'
+require 'rspec_fixtures/matchers/base'
 require 'rspec_fixtures/matchers/match_fixture'
-require 'rspec_fixtures/rspec_config'
+require 'rspec_fixtures/matchers/output_fixture'
 
+require 'rspec_fixtures/rspec_config'

data/lib/rspec_fixtures/approval_handler.rb

@@ -0,0 +1,31 @@
+module RSpecFixtures
+  class ApprovalHandler
+    include Colors
+
+    def run(expected, actual, fixture_file)
+      puts "%{blue}--- Approval Needed ---%{reset}\n" % colors
+      if expected.empty?
+        puts actual
+      else
+        puts "--- New (Actual) ------%{reset}\n#{actual}" % colors
+        puts "--- Old (Fixture) -----%{reset}\n#{expected}" % colors
+      end
+      print "%{blue}--- Approve? (y/N): --> %{reset}" % colors
+      
+      if get_user_answer == "y"
+        puts "%{green}Approved%{reset}" % colors
+        File.write fixture_file, actual
+        true
+      else
+        puts "%{red}Not Approved%{reset}" % colors
+        false
+      end
+    end
+
+    private
+
+    def get_user_answer
+      $stdin.getch
+    end
+  end
+end

data/lib/rspec_fixtures/matchers/base.rb

@@ -0,0 +1,55 @@
+module RSpecFixtures
+  module Matchers
+
+    class Base
+      attr_reader :fixture_name, :actual
+
+      def initialize(fixture_name=nil)
+        @fixture_name = fixture_name
+      end
+
+      def matches?(actual)
+        @actual = actual
+        false
+      end
+
+      def expected
+        @expected ||= expected!
+      end
+
+      def failure_message
+        "expected #{actual}\nto match #{expected}"
+      end
+
+      def diffable?
+        true
+      end
+
+      def interactive?
+        RSpec.configuration.interactive_fixtures
+      end
+
+      def fixtures_dir
+        RSpec.configuration.fixtures_path
+      end
+
+      def fixture_file
+        "#{fixtures_dir}/#{fixture_name}"
+      end
+      
+      protected
+
+      def approve_fixture
+        approval_handler = ApprovalHandler.new
+        approval_handler.run expected, actual, fixture_file
+      end
+
+      def expected!
+        Dir.mkdir fixtures_dir unless Dir.exist? fixtures_dir
+        File.write fixture_file, nil unless File.exist? fixture_file
+        File.read fixture_file
+      end
+    end
+
+  end
+end

data/lib/rspec_fixtures/matchers/match_fixture.rb

@@ -4,15 +4,7 @@ module RSpecFixtures
       MatchFixture.new expected
     end
     
-    class MatchFixture
-      include Colors
-
-      attr_reader :fixture_name, :actual
-
-      def initialize(fixture_name=nil)
-        @fixture_name = fixture_name
-      end
-
+    class MatchFixture < Base
       def matches?(actual)
         @actual = actual
         if actual == expected or !interactive?
@@ -21,58 +13,7 @@ module RSpecFixtures
           approve_fixture
         end
       end
-
-      def expected
-        @expected ||= expected!
-      end
-
-      def failure_message
-        "expected #{actual}\nto match #{expected}"
-      end
-
-      def diffable?
-        true
-      end
-
-      private
-
-      def interactive?
-        RSpec.configuration.interactive_fixtures
-      end
-
-      def fixtures_dir
-        RSpec.configuration.fixtures_path
-      end
-
-      def fixture_file
-        "#{fixtures_dir}/#{fixture_name}"
-      end
-
-      def approve_fixture
-        puts "%{blue}--- Approval Needed ---%{reset}\n" % colors
-        if expected.empty?
-          puts actual
-        else
-          puts "--- New (Actual) ------%{reset}\n#{actual}" % colors
-          puts "--- Old (Fixture) -----%{reset}\n#{expected}" % colors
-        end
-        print "%{blue}--- Approve? (y/N): --> %{reset}" % colors
-        
-        if $stdin.getch == "y"
-          puts "%{green}Approved%{reset}" % colors
-          File.write fixture_file, actual
-          true
-        else
-          puts "%{red}Not Approved%{reset}" % colors
-          actual == expected
-        end
-      end
-
-      def expected!
-        Dir.mkdir fixtures_dir unless Dir.exist? fixtures_dir
-        File.write fixture_file, nil unless File.exist? fixture_file
-        File.read fixture_file
-      end
     end
+    
   end
 end

data/lib/rspec_fixtures/matchers/output_fixture.rb

@@ -0,0 +1,39 @@
+module RSpecFixtures
+  module Matchers
+    def output_fixture(expected)
+      OutputFixture.new expected
+    end
+    
+    class OutputFixture < Base
+      def matches?(block)
+        return false unless block.is_a? Proc
+        @actual = stream_capturer.capture block
+
+        if actual == expected or !interactive?
+          actual == expected
+        else
+          approve_fixture
+        end
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def to_stdout
+        @stream_capturer = CaptureStdout
+        self
+      end
+
+      def to_stderr
+        @stream_capturer = CaptureStderr
+        self
+      end
+
+      def stream_capturer
+        @stream_capturer ||= CaptureStdout
+      end
+
+    end
+  end
+end

data/lib/rspec_fixtures/stream_capturer.rb

@@ -0,0 +1,33 @@
+module RSpecFixtures
+  # These methods are borrowed from rspec's built in matchers
+  # https://github.com/rspec/rspec-expectations/blob/add9b271ecb1d65f7da5bc8a9dd8c64d81d92303/lib/rspec/matchers/built_in/output.rb
+  module CaptureStdout
+    def self.capture(block)
+      captured_stream = StringIO.new
+
+      original_stream = $stdout
+      $stdout = captured_stream
+
+      block.call
+
+      captured_stream.string
+    ensure
+      $stdout = original_stream
+    end
+  end
+
+  module CaptureStderr
+    def self.capture(block)
+      captured_stream = StringIO.new
+
+      original_stream = $stderr
+      $stderr = captured_stream
+
+      block.call
+
+      captured_stream.string
+    ensure
+      $stderr = original_stream
+    end
+  end
+end

data/lib/rspec_fixtures/version.rb

@@ -1,3 +1,3 @@
 module RSpecFixtures
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_fixtures
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -102,9 +102,13 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/rspec_fixtures.rb
+- lib/rspec_fixtures/approval_handler.rb
 - lib/rspec_fixtures/colors.rb
+- lib/rspec_fixtures/matchers/base.rb
 - lib/rspec_fixtures/matchers/match_fixture.rb
+- lib/rspec_fixtures/matchers/output_fixture.rb
 - lib/rspec_fixtures/rspec_config.rb
+- lib/rspec_fixtures/stream_capturer.rb
 - lib/rspec_fixtures/version.rb
 homepage: https://github.com/DannyBen/rspec_fixtures
 licenses: