gnawrnip 0.1.0 → 0.1.1

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gnawrnip.gemspec
 gemspec
 
-group :test do
+group :example do
   gem 'poltergeist'
   gem 'selenium-webdriver'
   gem 'sinatra'

data/README.md

@@ -1,6 +1,6 @@
 # Gnawrnip
 
-Gnawrnip is a [TurnipFormatter](https://github.com/gongo/turnip_formatter) Add-on that provides put a screen shot to report use [Capybara](https://github.com/jnicklas/capybara)
+Gnawrnip is a [TurnipFormatter](https://github.com/gongo/turnip_formatter) Add-on that provides put a screenshot (like animation gif) to report use [Capybara](https://github.com/jnicklas/capybara)
 
 [![Build Status](https://travis-ci.org/gongo/gnawrnip.png?branch=master)](https://travis-ci.org/gongo/gnawrnip)
 [![Coverage Status](https://coveralls.io/repos/gongo/gnawrnip/badge.png?branch=master)](https://coveralls.io/r/gongo/gnawrnip)
@@ -16,6 +16,7 @@ Gnawrnip is a [TurnipFormatter](https://github.com/gongo/turnip_formatter) Add-o
 * RubyGems
     * capybara `~> 2.1.0`
     * turnip_formatter
+    * rmagick ( **optional** )
 
 ## Installation
 
@@ -31,18 +32,41 @@ Or install it yourself as:
 
     $ gem install gnawrnip
 
-## Usage
+## Setup
 
-Edit the `.rspec` file in your project directory (create it if doesn't exist), and add the following line:
+In your test setup file add:
 
-    -r turnip
-    -r turnip/capybara
-    -r gnawrnip
+    require 'gnawrnip'
+    Gnawrnip.ready!
 
-And run this command.
+## Customization
 
-    $ rspec --format RSpecTurnipFormatter --out report.html
+You can do to customize a screenshot.
 
+```ruby
+Gnawrnip.configure do |c|
+  c.photographer_driver = :js
+  c.frame_interval = 1000 # milliseconds
+  c.frame_size = [640, 360] # width, height
+end
+
+Gnawrnip.ready!
+```
+
+`Gnawrnip.readty!` must be issued after `Gnawrnip.configure` in setup file.
+
+* `photographer_driver` (Symbol) A driver that make screenshot like animation GIF.
+    * `:js`: use jQuery and image files. **The size of the report file tends to be large this driver**
+    * `:rmagick`: Make pure animation GIF using [RMagick](http://rmagick.rubyforge.org/). This driver is requires Gem `rmagick`. Add this line to your application's Gemfile:
+
+        ```
+        gem 'rmagick'
+        ```
+* `frame_interval` (Integer) A time (millisecond) between each image in an animation. Default is `1000` (1sec)
+* `frame_size` (Array) A size of screenshot (width, height). Default is `nil` (`nil` means that use `Capybara.current_driver.browser` size) .
+    * This option is enabled only when the `photographer_driver = :rmagick`.
+
+As example, see [example/spec/spec_helper.rb](https://github.com/gongo/gnawrnip/tree/master/example/spec/spec_helper.rb) .
 
 ## Example
 

data/example/.rspec

@@ -1,4 +1,4 @@
 --colour
 -r turnip
 -r turnip/capybara
--r gnawrnip
+

data/example/spec/spec_helper.rb

@@ -3,8 +3,9 @@ require 'turnip_formatter'
 require 'rspec/expectations'
 require 'capybara'
 require 'turnip/capybara'
-require 'gnawrnip'
 require 'capybara/poltergeist'
+require 'selenium-webdriver'
+require 'gnawrnip'
 
 # Load turnip steps
 Dir.glob(File.dirname(__FILE__) + "/steps/**/*steps.rb") { |f| load f, true }
@@ -19,3 +20,11 @@ Capybara.app = Sinatra::Application.new
 Capybara.default_driver = :poltergeist
 Capybara.javascript_driver = :selenium
 
+Gnawrnip.configure do |c|
+  c.photographer_driver = :js
+  #c.photographer_driver = :rmagick
+  c.frame_interval = 1000 # milliseconds
+  c.frame_size = [640, 360] # width, height
+end
+
+Gnawrnip.ready!

data/gnawrnip.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rmagick'
 end

data/lib/gnawrnip/js/photographer.rb

@@ -0,0 +1,26 @@
+require 'gnawrnip/photographer'
+require 'turnip_formatter/template'
+
+module Gnawrnip::JS
+  class Photographer
+    include Gnawrnip::Photographer
+
+    def animation(images)
+      images.map { |img| single(img) }.join
+    end
+  end
+end
+
+TurnipFormatter::Template.add_js(<<-EOS)
+  $('.screenshot.animation').each(function() {
+      var imgs = $(this).children('img');
+      var frame = 0;
+
+      imgs.hide();
+      setInterval(function() {
+          imgs.hide();
+          imgs.eq(frame).show();
+          frame = (++frame % imgs.length);
+      }, #{Gnawrnip.frame_interval.to_s});
+  });
+EOS

data/lib/gnawrnip/photographer.rb

@@ -0,0 +1,22 @@
+require 'tempfile'
+require 'base64'
+
+module Gnawrnip
+  module Photographer
+    def animation(paths)
+      raise NotImplementedError
+    end
+
+    def single(path)
+      image_tag(image_base64(path))
+    end
+
+    def image_base64(path)
+      Base64.strict_encode64(File.read(path))
+    end
+
+    def image_tag(data, format = :png)
+      '<img src="data:image/' + format.to_s + ';base64,' + data + '"/>'
+    end
+  end
+end

data/lib/gnawrnip/rmagick/photographer.rb

@@ -0,0 +1,43 @@
+require 'gnawrnip/photographer'
+
+module Gnawrnip::RMagick
+  class Photographer
+    include Gnawrnip::Photographer
+
+    def initialize
+      Kernel.require 'RMagick'
+    rescue LoadError => e
+      if e.message =~ /cannot load.*RMagick/
+        raise LoadError, "Please install the gem and add `gem 'rmagick'` to your Gemfile if you are using bundler."
+      else
+        raise e
+      end
+    end
+
+    def animation(images)
+      creator = photo_creator(images)
+      tempfile = Tempfile.new(['gnawrnip', '.gif'])
+      creator.write(tempfile.path)
+
+      image_tag(image_base64(tempfile.path), :gif)
+    end
+
+    def single(image)
+      animation([image])
+    end
+
+    def photo_creator(images)
+      paths = images.map(&:path)
+      photos = ::Magick::ImageList.new(*paths)
+
+      photos.delay = Gnawrnip.frame_interval / 10.0
+      unless Gnawrnip.frame_size.nil?
+        photos.each do |p|
+          p.scale!(*Gnawrnip.frame_size)
+        end
+      end
+
+      photos
+    end
+  end
+end

data/lib/gnawrnip/screenshot.rb

@@ -1,4 +1,5 @@
 require 'tempfile'
+require 'time'
 require 'capybara'
 
 module Gnawrnip
@@ -8,17 +9,34 @@ module Gnawrnip
       #
       # Screenshot of current capybara session
       #
+      # When browser is still loading page, raise follow exception (maybe...)
+      #
+      #   Selenium::WebDriver::Error::UnknownError:
+      #     Could not take screenshot of current page - TypeError: c is null
+      #
+      # So, to retry during +wait_second+ seconds.
+      #
       # @example
       #   image = Gnawrnip::Screenshot.take
       #
-      # @return  [String]  Base64-encoded image of screenshot
       #
-      def take
-        tempfile = Tempfile.new(['gnawrnip', '.png'])
-        session.save_screenshot(tempfile.path)
-        image = Base64.strict_encode64(tempfile.read)
-        tempfile.close
-        image
+      # @param   [Fixnum]  wait_second  Second to repeat the retry
+      # @return  [Tempfile]  Image file of screenshot
+      #
+      def take(wait_second = Capybara.default_wait_time)
+        start_time = Time.now
+
+        begin
+          tempfile = Tempfile.new(['gnawrnip', '.png'])
+          session.save_screenshot(tempfile.path)
+          tempfile
+        rescue Capybara::NotSupportedByDriverError => e
+          raise e
+        rescue => e
+          raise e if (Time.now - start_time) >= wait_second
+          sleep(0.3)
+          retry
+        end
       end
 
       private

data/lib/gnawrnip/step_screenshot.rb

@@ -11,36 +11,24 @@ module Gnawrnip
       def build(png_base64_list)
         case png_base64_list.length
         when 0
-          description_no_screenshot
+          ''
         when 1
-          still_image(png_base64_list.first)
+          single_image(png_base64_list.first)
         else
           animation_image(png_base64_list)
         end
       end
 
-      def description_no_screenshot
-        @no_screenshot ||= description_frame(:no_screenshot)
-        still_image(@no_screenshot)
-      end
-
-      def animation_image(images)
+      def animation_image(paths)
         text = '<div class="screenshot animation">'
-        text += images.map { |data| img_tag(data) }.join
+        text += Gnawrnip.photographer.animation(paths)
         text + '</div>'
       end
 
-      def still_image(data)
-        '<div class="screenshot">' + img_tag(data) + '</div>'
-      end
-
-      def img_tag(data)
-        '<img src="data:image/png;base64,' + data + '"/>'
-      end
-
-      def description_frame(scene)
-        path = File.dirname(__FILE__) + "/#{scene.to_s}.png"
-        Base64.strict_encode64(File.read(path))
+      def single_image(path)
+        text = '<div class="screenshot">'
+        text += Gnawrnip.photographer.single(path)
+        text + '</div>'
       end
     end
   end
@@ -52,7 +40,7 @@ module TurnipFormatter
         ul.steps {
             div.screenshot {
                > img {
-                 width: 90%;
+                 max-width: 90%;
                  border: 2px solid black;
                }
            }
@@ -60,22 +48,6 @@ module TurnipFormatter
     }
   EOS
 
-  Template.add_js(<<-EOS)
-    $(function() {
-        $('.screenshot.animation').each(function() {
-            var imgs = $(this).children('img');
-            var frame = 0;
-
-            imgs.hide();
-            setInterval(function() {
-                imgs.hide();
-                imgs.eq(frame).show();
-                frame = (++frame % imgs.length);
-            }, 1000);
-        });
-    });
-  EOS
-
   Step::Failure.add_template Gnawrnip::StepScreenshot do
     example.metadata[:gnawrnip][:screenshot] || []
   end

data/lib/gnawrnip/version.rb

@@ -1,3 +1,3 @@
 module Gnawrnip
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/gnawrnip.rb

@@ -1,9 +1,40 @@
 require "gnawrnip/version"
+require 'gnawrnip/rmagick/photographer'
+require 'gnawrnip/ext/capybara/session'
+require 'gnawrnip/animation'
+require 'gnawrnip/screenshot'
+require 'gnawrnip/step_screenshot'
+require 'gnawrnip/rspec'
 
 module Gnawrnip
-  require 'gnawrnip/ext/capybara/session'
-  require 'gnawrnip/animation'
-  require 'gnawrnip/screenshot'
-  require 'gnawrnip/step_screenshot'
-  require 'gnawrnip/rspec'
+  class << self
+    attr_accessor :photographer_driver
+    attr_accessor :frame_interval
+    attr_accessor :frame_size
+
+    def configure
+      yield self
+    end
+
+    def ready!
+      photographer # Try to load driver library.
+    end
+
+    def photographer
+      @photographer ||= case photographer_driver
+                        when :rmagick
+                          require 'gnawrnip/rmagick/photographer'
+                          @photographer = RMagick::Photographer.new
+                        else # :js
+                          require 'gnawrnip/js/photographer'
+                          @photographer = JS::Photographer.new
+                        end
+    end
+  end
+end
+
+Gnawrnip.configure do |c|
+  c.photographer_driver = :js
+  c.frame_interval = 1000
+  c.frame_size = nil
 end

data/spec/gnawrnip/rmagick/photographer_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'gnawrnip/rmagick/photographer'
+require 'RMagick'
+
+module Gnawrnip::RMagick
+  describe Photographer do
+    let(:photographer) { Photographer.new }
+
+    describe '.new' do
+      subject { lambda { photographer } }
+
+      context 'cannot load rmagick' do
+        before do
+          error = LoadError.new("LoadError: cannot load such file -- RMagick")
+          Kernel.stub(:require).and_raise(error)
+        end
+
+        it { should raise_error LoadError, /gem 'rmagick'/ }
+      end
+
+      context 'cannot load other library' do
+        before do
+          error = LoadError.new("LoadError: cannot load such file -- samurai")
+          Kernel.stub(:require).and_raise(error)
+        end
+
+        it { should raise_error LoadError, /such file -- samurai/ }
+      end
+    end
+
+    describe '#animation' do
+      let(:screenshot_list) {
+        [GnawrnipTest.image('hoge'), GnawrnipTest.image('fuga')]
+      }
+
+      let(:creator) {
+        d = double
+        d.stub(:write) { |path| File.write(path, d.data) }
+        d
+      }
+
+      context 'exists image files' do
+        before do
+          photographer.stub(:photo_creator) do |args|
+            creator.stub(:data).and_return(args.map(&:read).join)
+          end.and_return(creator)
+        end
+
+        subject { photographer.animation(screenshot_list) }
+        it { should eq '<img src="data:image/gif;base64,aG9nZWZ1Z2E="/>' }
+      end
+    end
+  end
+end

data/spec/gnawrnip/screenshot_spec.rb

@@ -4,10 +4,46 @@ require 'gnawrnip/screenshot'
 module Gnawrnip
   describe Screenshot do
     describe '.take' do
-      subject { Screenshot.take }
+      subject { Screenshot.take.read }
 
       # see GnawrnipTestSession::save_screenshot
-      it { should == "c2NyZWVuc2hvdA==" }
+      it { should == "screenshot" }
+
+      context 'not support save_screenshot' do
+        before do
+          GnawrnipTest::Session.any_instance.stub(:save_screenshot) do
+            raise Capybara::NotSupportedByDriverError
+          end
+        end
+
+        subject { lambda { Screenshot.take } }
+        it { should raise_error Capybara::NotSupportedByDriverError }
+      end
+
+      context 'raise unknown error' do
+        before do
+          GnawrnipTest::Session.any_instance.stub(:save_screenshot) do
+            raise Timeout::Error
+          end
+        end
+
+        context 'timeout' do
+          before do
+            now = Time.now
+            Time.stub(:now).and_return(now, now + 3)
+          end
+
+          subject do
+            lambda {
+              Capybara.using_wait_time 2 do
+                Screenshot.take
+              end
+            }
+          end
+
+          it { should raise_error Timeout::Error }
+        end
+      end
     end
   end
 end

data/spec/gnawrnip/step_screenshot_spec.rb

@@ -3,9 +3,7 @@ require 'gnawrnip/step_screenshot'
 
 module Gnawrnip
   describe StepScreenshot do
-    let :template do
-      StepScreenshot
-    end
+    let(:template) { StepScreenshot }
 
     it 'exists failure step template' do
       expect(TurnipFormatter::Step::Failure.templates).to have_key template
@@ -15,29 +13,37 @@ module Gnawrnip
       subject { template.build(data_list) }
 
       context 'has multiple data' do
-        let(:data_list) { ['aiueo', '12345', 'abcde'] }
-        it {
+        let(:data_list) do
+          [
+            GnawrnipTest.image('aiueo'),
+            GnawrnipTest.image('12345'),
+            GnawrnipTest.image('abcde')
+          ]
+        end
+
+        it 'should get image tag and source that base64 encoded' do
+          data1 = Base64.strict_encode64('aiueo')
+          data2 = Base64.strict_encode64('12345')
+          data3 = Base64.strict_encode64('abcde')
           should include '<div class="screenshot animation">'
-          should include '<img src="data:image/png;base64,aiueo"/>'
-          should include '<img src="data:image/png;base64,12345"/>'
-          should include '<img src="data:image/png;base64,abcde"/></div>'
-        }
+          should include '<img src="data:image/png;base64,' + data1 + '"/>'
+          should include '<img src="data:image/png;base64,' + data2 + '"/>'
+          should include '<img src="data:image/png;base64,' + data3 + '"/></div>'
+        end
       end
 
       context 'has single data' do
-        let(:data_list) { ['aiueo'] }
+        let(:data_list) { [GnawrnipTest.image('aiueo')] }
         it {
+          data = Base64.strict_encode64('aiueo')
           should include '<div class="screenshot">'
-          should include '<img src="data:image/png;base64,aiueo"/></div>'
+          should include '<img src="data:image/png;base64,' + data + '"/></div>'
         }
       end
 
       context 'has no data' do
         let(:data_list) { [] }
-        it {
-          should include '<div class="screenshot">'
-          should include '<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAhQ'
-        }
+        it { should eq '' }
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,23 +1,34 @@
+require 'tempfile'
+require 'capybara'
+
 require 'coveralls'
 Coveralls.wear!
 
 require 'gnawrnip'
-require 'capybara'
 
-class GnawrnipTestSession
-  def save_screenshot(file_path)
-    File.open(file_path, 'w') do |fp|
-      fp.print 'screenshot'
-    end
+module GnawrnipTest
+  def self.image(data)
+    tempfile = Tempfile.new('gnarwnip_test')
+    tempfile.write(data)
+    tempfile.rewind
+    tempfile
   end
 
-  def method_missing(name, *args, &block)
-    # nooooooop
+  class Session
+    def save_screenshot(file_path)
+      File.open(file_path, 'w') do |fp|
+        fp.print 'screenshot'
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      # nooooooop
+    end
   end
 end
 
 module Capybara
   def self.current_session
-    GnawrnipTestSession.new
+    GnawrnipTest::Session.new
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnawrnip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -107,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gnawrnip is a TurnipFormatter Add-on that provides put a screen shot
   to report use Capybara
 email:
@@ -131,12 +147,16 @@ files:
 - lib/gnawrnip.rb
 - lib/gnawrnip/animation.rb
 - lib/gnawrnip/ext/capybara/session.rb
+- lib/gnawrnip/js/photographer.rb
 - lib/gnawrnip/no_screenshot.png
+- lib/gnawrnip/photographer.rb
+- lib/gnawrnip/rmagick/photographer.rb
 - lib/gnawrnip/rspec.rb
 - lib/gnawrnip/screenshot.rb
 - lib/gnawrnip/step_screenshot.rb
 - lib/gnawrnip/version.rb
 - spec/gnawrnip/animation_spec.rb
+- spec/gnawrnip/rmagick/photographer_spec.rb
 - spec/gnawrnip/rspec_spec.rb
 - spec/gnawrnip/screenshot_spec.rb
 - spec/gnawrnip/step_screenshot_spec.rb
@@ -168,6 +188,7 @@ specification_version: 3
 summary: Add-on for TurnipFormatter with Capybara
 test_files:
 - spec/gnawrnip/animation_spec.rb
+- spec/gnawrnip/rmagick/photographer_spec.rb
 - spec/gnawrnip/rspec_spec.rb
 - spec/gnawrnip/screenshot_spec.rb
 - spec/gnawrnip/step_screenshot_spec.rb