rspec-nc 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2b8f93c83bbd95fcf6ee2f1733e04b4d1d16ef3
-  data.tar.gz: 0cd2bc1e3dfaea772e799a6ed05c1b1d4922d9d4
+  metadata.gz: 9f17893a6ec6eca20680fc2d7e19449276eb95d8
+  data.tar.gz: e3d9ee891412465623cc782c8c6e3b976af5ba26
 SHA512:
-  metadata.gz: b1ab0cffb3b17e0067df6414cd75f066492f72a05e6f44b26eda48a7edffdf1c07e3460aecd506b027e9a0f66b422f42bffacd5747ea6c2e993c4ab41173b0cf
-  data.tar.gz: da5a61732c2c259d1b983f648837ab615159f9e1b9ac7f78b8bb8c7f83559588f1463adc9149a580f6ac3d06ec915f9b28f1bccbac0982002585a57b29c2ea4c
+  metadata.gz: 0c883b6b56523daa87605815575282e953384f8b7e066d8ed93c4fab507caf31bfb9d7a7305210f8e3c0e892d889fe78e92d0ae7ff6d67fda87daf4a226b32de
+  data.tar.gz: 2e2a2781669641e82219f60663658e38dff1caf58f328c636f6cb1f6de24ae8f3073b1d59813ef9565027296ffbb78c495aa71b8a71f398c54b464cebd55fa50

data/.travis.yml

@@ -1,4 +1 @@
-gemfile:
-  - gemfiles/rspec29.gemfile
-  - gemfiles/rspec3.gemfile
 script: 'bundle exec rake spec'

data/lib/nc.rb

@@ -1,73 +1,25 @@
-require 'rspec/core/formatters/base_text_formatter'
+require 'rspec/core/formatters/base_formatter'
 require 'terminal-notifier'
 
-class Nc < RSpec::Core::Formatters::BaseTextFormatter
-  def self.rspec_3?
-    RSpec::Core::Version::STRING.split('.').first == "3"
-  end
+class Nc < RSpec::Core::Formatters::BaseFormatter
+  SUCCESS_EMOJI = "\u2705"
+  FAILURE_EMOJI = "\u26D4"
 
-  if rspec_3?
-    RSpec::Core::Formatters.register self, :dump_summary
-  end
+  RSpec::Core::Formatters.register self, :dump_summary
 
-  def dump_summary(*args)
-    if self.class.rspec_3?
-      notification = args[0]
-      duration = notification.duration
-      example_count = notification.example_count
-      failure_count = notification.failure_count
-      pending_count = notification.pending_count
+  def dump_summary(notification)
+    body = "Finished in #{notification.formatted_duration}\n#{notification.totals_line}"
+    title = if notification.failure_count > 0
+      "#{FAILURE_EMOJI} #{directory_name}: #{notification.failure_count} failed example#{notification.failure_count == 1 ? nil : 's'}"
     else
-      duration, example_count, failure_count, pending_count = args
+      "#{SUCCESS_EMOJI} #{directory_name}: Success"
     end
-
-    body = []
-    body << "Finished in #{_format_duration duration}"
-    body << _summary_line(example_count, failure_count, pending_count)
-
-    name = File.basename(File.expand_path '.')
-
-    title = if failure_count > 0
-      "\u26D4 #{name}: #{failure_count} failed example#{failure_count == 1 ? nil : 's'}"
-    else
-      "\u2705 #{name}: Success"
-    end
-
-    say title, body.join("\n")
+    TerminalNotifier.notify body, title: title
   end
 
-  def dump_pending(*args); end
-  def dump_failures(*args); end
-  def message(message); end
-
   private
 
-  def say(title, body)
-    TerminalNotifier.notify body, :title => title
+  def directory_name
+    File.basename File.expand_path '.'
   end
-
-  def _format_duration(duration)
-    if respond_to? :format_duration
-      format_duration duration
-    else
-      require 'rspec/core/formatters/helpers' unless Object.const_defined?('RSpec')
-      RSpec::Core::Formatters::Helpers.format_duration duration
-    end
-  end
-
-  def _summary_line(example_count, failure_count, pending_count)
-    if respond_to? :summary_line
-      summary_line(example_count, failure_count, pending_count)
-    else
-      RSpec::Core::Notifications::SummaryNotification.new(
-        nil,
-        SizeResponder.new(example_count),
-        SizeResponder.new(failure_count),
-        SizeResponder.new(pending_count),
-        nil
-      ).totals_line
-    end
-  end
-
-  SizeResponder = Struct.new(:size)
 end

data/lib/nc_fail.rb

@@ -1,18 +1,11 @@
 require 'nc'
 
 class NcFail < Nc
-  if rspec_3?
-    RSpec::Core::Formatters.register self, :example_failed
-  end
-
-  def say(title, body)
-    @failed_examples ||= []
-    return if @failed_examples.size <= 0
-    super
-  end
+  RSpec::Core::Formatters.register self, :dump_summary
 
-  def example_failed(failure)
-    @failed_examples ||= []
-    @failed_examples << failure
+  def dump_summary(notification)
+    if notification.failure_count > 0
+      super
+    end
   end
 end

data/lib/nc_first_fail.rb

@@ -1,23 +1,21 @@
 require 'nc'
 
 class NcFirstFail < Nc
-  if rspec_3?
-    RSpec::Core::Formatters.register self, :example_failed
-  end
+  RSpec::Core::Formatters.register self, :example_failed
 
-  def example_failed(example)
-    # For rspec3
-    example = example.example if example.respond_to?(:example)
-    @failed_examples ||= []
-    if @failed_examples.size == 0
-      name = File.basename(File.expand_path '.')
-      say "\u26D4 #{name}: Failure", "#{example.metadata[:full_description]}\n#{example.exception}"
+  def example_failed(notification)
+    example = notification.example
+    body = "#{example.metadata[:full_description]}\n#{example.exception}"
+    title = "#{FAILURE_EMOJI} #{directory_name}: Failure"
+    unless @failed
+      TerminalNotifier.notify body, title: title
     end
-    @failed_examples << example
+    @failed = true
   end
 
-  def dump_summary(*args)
-    failure_count = self.class.rspec_3? ? args[0].failure_count : args[2]
-    super if failure_count == 0
+  def dump_summary(notification)
+    if notification.failure_count == 0
+      super
+    end
   end
 end

data/rspec-nc.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name = 'rspec-nc'
-  gem.version = '0.2.1'
+  gem.version = '0.3.0'
   gem.authors = ['Odin Dutton']
   gem.email = ['odindutton@gmail.com']
   gem.description = 'https://github.com/twe4ked/rspec-nc'
@@ -10,10 +10,11 @@ Gem::Specification.new do |gem|
   gem.license = 'MIT'
 
   gem.add_dependency 'terminal-notifier', '>= 1.4'
-  gem.add_dependency 'rspec', '>= 2.9'
+  gem.add_dependency 'rspec', '>= 3'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'wwtd'
+  gem.add_development_dependency 'pry'
 
   gem.files = `git ls-files`.split($\)
   gem.test_files = gem.files.grep(%r{^(spec)/})

data/spec/nc_fail_spec.rb

@@ -2,17 +2,29 @@ require 'nc_fail'
 
 describe NcFail do
   let(:formatter) { NcFail.new(StringIO.new) }
+  let(:notification) do
+    instance_double(RSpec::Core::Notifications::SummaryNotification,
+      formatted_duration: double,
+      totals_line: double,
+      failure_count: failure_count,
+    )
+  end
 
-  it 'returns a failing notification' do
-    expect(TerminalNotifier).to receive(:notify)
+  context 'with failing examples' do
+    let(:failure_count) { 1 }
 
-    formatter.instance_variable_set('@failed_examples', [1])
-    formatter.say('title', 'body')
+    it 'sends a failure summary notification' do
+      expect(TerminalNotifier).to receive(:notify)
+      formatter.dump_summary(notification)
+    end
   end
 
-  it 'does not return a success notification when tests are passing' do
-    expect(TerminalNotifier).to_not receive(:notify)
+  context 'with all examples passing' do
+    let(:failure_count) { 0 }
 
-    formatter.say('title', 'body')
+    it 'does not send a notification' do
+      expect(TerminalNotifier).to_not receive(:notify)
+      formatter.dump_summary(notification)
+    end
   end
 end

data/spec/nc_first_fail_spec.rb

@@ -1,86 +1,45 @@
 require 'nc_first_fail'
 
 describe NcFirstFail do
-  let(:formatter) { NcFirstFail.new(StringIO.new) }
+  let(:formatter)   { NcFirstFail.new(StringIO.new) }
   let(:current_dir) { File.basename(File.expand_path '.') }
-  let(:example) { double 'example' }
-  let(:example2) { double 'example2' }
-
-  let(:failure) { "\u26D4" }
-  let(:success) { "\u2705" }
-  let(:exception) { 'exception' }
-  let(:description) { 'description' }
-
-  context 'with RSpec 2' do
-    before do
-      allow(formatter.class).to receive(:rspec_3?).and_return(false)
-    end
-
-    it 'notifies the first failure only' do
-      allow(example).to receive(:metadata).and_return({:full_description => description})
-      allow(example).to receive(:exception).and_return(exception)
-
-      expect(TerminalNotifier).to receive(:notify).with("#{description}\n#{exception}",
-        :title => "#{failure} #{current_dir}: Failure"
-      ).once
-
-      formatter.example_failed(example)
-      formatter.example_failed(example2)
-    end
-
-    it "doesn't notify in the end if there has been any failures" do
-      expect(TerminalNotifier).to_not receive(:notify)
-
-      formatter.dump_summary(0.0001, 2, 1, 0)
-    end
-
-    it 'notifies in the end if there is no failures' do
-      expect(TerminalNotifier).to receive(:notify).with(
-        "Finished in 0.0001 seconds\n2 examples, 0 failures",
-        :title => "#{success} #{current_dir}: Success"
-      )
-
-      formatter.dump_summary(0.0001, 2, 0, 0)
-    end
+  let(:failure_count) { 1 }
+  let(:summary_notification) do
+    instance_double(RSpec::Core::Notifications::SummaryNotification,
+      formatted_duration: '0.0001 seconds',
+      totals_line: '3 examples, 1 failure, 1 pending',
+      failure_count: failure_count,
+    )
+  end
+  let(:failed_example_notification) do
+    instance_double(RSpec::Core::Notifications::FailedExampleNotification,
+      example: double(:example,
+        metadata: {full_description: '_full_description_'},
+        exception: '_exception_',
+      ),
+    )
   end
 
-  context 'with RSpec 3' do
-    let(:notification) do
-      Struct.new(:duration, :example_count, :failure_count, :pending_count).new(0.0001, 3, 1, 1)
-    end
-    let(:success_notification) do
-      Struct.new(:duration, :example_count, :failure_count, :pending_count).new(0.0001, 2, 0, 0)
-    end
-
-    before do
-      allow(formatter.class).to receive(:rspec_3?).and_return(true)
-    end
-
-    it 'notifies the first failure only' do
-      allow(example).to receive(:metadata).and_return({:full_description => description})
-      allow(example).to receive(:exception).and_return(exception)
-
-      expect(TerminalNotifier).to receive(:notify).with("#{description}\n#{exception}",
-        :title => "#{failure} #{current_dir}: Failure"
-      ).once
+  it 'sends a failure notification for the first failure only' do
+    expect(TerminalNotifier).to receive(:notify).with(
+      "_full_description_\n_exception_",
+      title: "#{Nc::FAILURE_EMOJI} #{current_dir}: Failure",
+    )
+    formatter.example_failed failed_example_notification
 
-      formatter.example_failed(double(example: example))
-      formatter.example_failed(double(example: example2))
-    end
+    expect(TerminalNotifier).to_not receive(:notify)
+    formatter.example_failed failed_example_notification
 
-    it "doesn't notify in the end if there has been any failures" do
-      expect(TerminalNotifier).to_not receive(:notify)
+    expect(TerminalNotifier).to_not receive(:notify)
+    formatter.dump_summary summary_notification
+  end
 
-      formatter.dump_summary(notification)
-    end
 
-    it 'notifies in the end if there is no failures' do
-      expect(TerminalNotifier).to receive(:notify).with(
-        "Finished in 0.0001 seconds\n2 examples, 0 failures",
-        :title => "#{success} #{current_dir}: Success"
-      )
+  context 'with all examples passing' do
+    let(:failure_count) { 0 }
 
-      formatter.dump_summary(success_notification)
+    it 'sends a success summary notification' do
+      formatter.dump_summary summary_notification
     end
   end
 end

data/spec/nc_spec.rb

@@ -1,60 +1,41 @@
 require 'nc'
 
-describe Nc do
-  let(:formatter)   { Nc.new(StringIO.new) }
+RSpec.describe Nc do
+  let(:formatter) { Nc.new(StringIO.new) }
   let(:current_dir) { File.basename(File.expand_path '.') }
 
-  # emoji
-  let(:success) { "\u2705" }
-  let(:failure) { "\u26D4" }
-
-  context 'with RSpec 2' do
-    before do
-      allow(formatter.class).to receive(:rspec_3?).and_return(false)
-    end
-
-    it 'returns the summary' do
-      expect(TerminalNotifier).to receive(:notify).with(
-        "Finished in 0.0001 seconds\n3 examples, 1 failure, 1 pending",
-        :title => "#{failure} #{current_dir}: 1 failed example"
+  context 'with failing examples' do
+    let(:notification) do
+      instance_double(RSpec::Core::Notifications::SummaryNotification,
+        formatted_duration: '0.0001 seconds',
+        totals_line: '3 examples, 1 failure, 1 pending',
+        failure_count: 1,
       )
-
-      formatter.dump_summary(0.0001, 3, 1, 1)
     end
 
-    it 'returns a failing notification' do
+    it 'sends a failure summary notification' do
       expect(TerminalNotifier).to receive(:notify).with(
-        "Finished in 0.0001 seconds\n1 example, 1 failure",
-        :title => "#{failure} #{current_dir}: 1 failed example"
-      )
-
-      formatter.dump_summary(0.0001, 1, 1, 0)
-    end
-
-    it 'returns a success notification' do
-      expect(TerminalNotifier).to receive(:notify).with(
-        "Finished in 0.0001 seconds\n1 example, 0 failures",
-        :title => "#{success} #{current_dir}: Success"
+        "Finished in 0.0001 seconds\n3 examples, 1 failure, 1 pending",
+        :title => "#{Nc::FAILURE_EMOJI} #{current_dir}: 1 failed example"
       )
-
-      formatter.dump_summary(0.0001, 1, 0, 0)
+      formatter.dump_summary(notification)
     end
   end
 
-  context 'with RSpec 3' do
-    let(:notification) {
-      Struct.new(:duration, :example_count, :failure_count, :pending_count).new(0.0001, 3, 1, 1)
-    }
-    before do
-      allow(formatter.class).to receive(:rspec_3?).and_return(true)
+  context 'with all examples passing' do
+    let(:notification) do
+      instance_double(RSpec::Core::Notifications::SummaryNotification,
+        formatted_duration: '0.0001 seconds',
+        totals_line: '3 examples, 0 failures, 1 pending',
+        failure_count: 0,
+      )
     end
 
-    it 'shows the summary' do
+    it 'sends a success summary notification' do
       expect(TerminalNotifier).to receive(:notify).with(
-        "Finished in 0.0001 seconds\n3 examples, 1 failure, 1 pending",
-        :title => "#{failure} #{current_dir}: 1 failed example"
+        "Finished in 0.0001 seconds\n3 examples, 0 failures, 1 pending",
+        :title => "#{Nc::SUCCESS_EMOJI} #{current_dir}: Success"
       )
-
       formatter.dump_summary(notification)
     end
   end

data/spec/test.rb

@@ -0,0 +1,21 @@
+# This test isn't part of the actual suite it's to manually test the formatters.
+require 'nc'
+
+RSpec.describe 'to test the gem' do
+  it 'passes' do
+    expect(0).to eq 0
+  end
+
+  it 'fails' do
+    expect(1).to eq 2
+  end
+
+  it 'fails again' do
+    expect(3).to eq 4
+  end
+
+  it 'pending' do
+    pending 'for a reason'
+    expect(5).to eq 6
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-nc
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Odin Dutton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: terminal-notifier
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !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'
 description: https://github.com/twe4ked/rspec-nc
 email:
 - odindutton@gmail.com
@@ -79,8 +93,6 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
-- gemfiles/rspec29.gemfile
-- gemfiles/rspec3.gemfile
 - lib/nc.rb
 - lib/nc_fail.rb
 - lib/nc_first_fail.rb
@@ -88,6 +100,7 @@ files:
 - spec/nc_fail_spec.rb
 - spec/nc_first_fail_spec.rb
 - spec/nc_spec.rb
+- spec/test.rb
 homepage: https://github.com/twe4ked/rspec-nc
 licenses:
 - MIT
@@ -116,3 +129,4 @@ test_files:
 - spec/nc_fail_spec.rb
 - spec/nc_first_fail_spec.rb
 - spec/nc_spec.rb
+- spec/test.rb

data/gemfiles/rspec29.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake'
-gem 'wwtd'
-
-gem 'terminal-notifier', '>= 1.4'
-gem 'rspec', '~> 2.9'

data/gemfiles/rspec3.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rake'
-gem 'wwtd'
-
-gem 'terminal-notifier', '>= 1.4'
-gem 'rspec', '~> 3.0'