gnawrnip 0.1.2 → 0.1.3

data/README.md

@@ -7,6 +7,11 @@ Gnawrnip is a [TurnipFormatter](https://github.com/gongo/turnip_formatter) Add-o
 [![Code Climate](https://codeclimate.com/github/gongo/gnawrnip.png)](https://codeclimate.com/github/gongo/gnawrnip)
 [![Dependency Status](https://gemnasium.com/gongo/gnawrnip.png)](https://gemnasium.com/gongo/gnawrnip)
 
+## IMPORTANT!
+
+This project is currently in development (frequent releases).
+So it have potential for massive refactorings (that could be API breaking).
+
 
 ## Requirements
 
@@ -45,26 +50,25 @@ 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
+  c.publisher_driver = :js
+  c.make_animation   = true
+  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.
+* `publisher_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'
         ```
+* `make_animation` (Boolean) Whether to make animation GIF. (Default: true)
 * `frame_interval` (Integer) A time (millisecond) between each image in an animation. Default is `1000` (1sec)
+    * This option is enabled only when the `make_animation = true`.
 * `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`.
+    * This option is enabled only when the `publisher_driver = :rmagick`.
 
 As example, see [example/spec/spec_helper.rb](https://github.com/gongo/gnawrnip/tree/master/example/spec/spec_helper.rb) .
 

data/example/spec/spec_helper.rb

@@ -21,10 +21,10 @@ Capybara.default_driver = :poltergeist
 Capybara.javascript_driver = :selenium
 
 Gnawrnip.configure do |c|
-  c.photographer_driver = :js
-  #c.photographer_driver = :rmagick
+  # c.publisher_driver = :js
+  c.publisher_driver = :rmagick
   c.frame_interval = 1000 # milliseconds
   c.frame_size = [640, 360] # width, height
+  c.make_animation = false
 end
 
-Gnawrnip.ready!

data/lib/gnawrnip/ext/capybara/session.rb

@@ -10,7 +10,7 @@ module Capybara
       alias_method "after_hook_#{method}".to_sym, method
 
       define_method method do |*args, &block|
-        Gnawrnip::Animation.add_frame
+        Gnawrnip.photographer.take_shot
         send("after_hook_#{method}", *args, &block)
       end
     end

data/lib/gnawrnip/photographer.rb

@@ -1,22 +1,25 @@
-require 'tempfile'
-require 'base64'
+require 'gnawrnip/screenshot'
 
 module Gnawrnip
-  module Photographer
-    def animation(paths)
-      raise NotImplementedError
+  class Photographer
+    def take_shot
+      frames << Screenshot.take
     end
 
-    def single(path)
-      image_tag(image_base64(path))
+    def reset!
+      frames.clear
     end
 
-    def image_base64(path)
-      Base64.strict_encode64(File.read(path))
+    #
+    # Close tempfiles.
+    #
+    def discard!
+      frames.each(&:close!)
+      reset!
     end
 
-    def image_tag(data, format = :png)
-      '<img src="data:image/' + format.to_s + ';base64,' + data + '"/>'
+    def frames
+      @frames ||= []
     end
   end
 end

data/lib/gnawrnip/{js/photographer.rb → publisher/js.rb}

@@ -1,12 +1,14 @@
-require 'gnawrnip/photographer'
+require 'gnawrnip/publisher'
 require 'turnip_formatter/template'
 
-module Gnawrnip::JS
-  class Photographer
-    include Gnawrnip::Photographer
+module Gnawrnip
+  module Publisher
+    class JS
+      include Gnawrnip::Publisher
 
-    def animation(images)
-      images.map { |img| single(img) }.join
+      def animation(images)
+        images.map { |img| single(img) }.join
+      end
     end
   end
 end

data/lib/gnawrnip/publisher/rmagick.rb

@@ -0,0 +1,47 @@
+require 'gnawrnip/publisher'
+
+module Gnawrnip
+  module Publisher
+    class RMagick
+      include Gnawrnip::Publisher
+
+      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
+
+      private
+
+      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
+end

data/lib/gnawrnip/publisher.rb

@@ -0,0 +1,21 @@
+require 'base64'
+
+module Gnawrnip
+  module Publisher
+    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/rspec.rb

@@ -1,16 +1,22 @@
 require 'rspec'
-require 'tempfile'
-require 'base64'
 
 RSpec.configure do |config|
+  config.before(:all) do
+    Gnawrnip.ready!
+  end
+
   config.before(:each, turnip: true) do
-    Gnawrnip::Animation.reset!
+    Gnawrnip.photographer.reset!
+    example.metadata[:gnawrnip] = {}
   end
 
   config.after(:each, turnip: true) do
     if example.exception
-      example.metadata[:gnawrnip] = {}
-      example.metadata[:gnawrnip][:screenshot] = Gnawrnip::Animation.frames.compact
+      Gnawrnip.photographer.take_shot
+      screenshots = Gnawrnip.photographer.frames.compact
+      example.metadata[:gnawrnip][:screenshot] = screenshots
+    else
+      Gnawrnip.photographer.discard!
     end
   end
 end

data/lib/gnawrnip/step_screenshot.rb

@@ -21,13 +21,13 @@ module Gnawrnip
 
       def animation_image(paths)
         text = '<div class="screenshot animation">'
-        text += Gnawrnip.photographer.animation(paths)
+        text += Gnawrnip.publisher.animation(paths)
         text + '</div>'
       end
 
       def single_image(path)
         text = '<div class="screenshot">'
-        text += Gnawrnip.photographer.single(path)
+        text += Gnawrnip.publisher.single(path)
         text + '</div>'
       end
     end

data/lib/gnawrnip/version.rb

@@ -1,3 +1,3 @@
 module Gnawrnip
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/gnawrnip.rb

@@ -1,40 +1,48 @@
 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'
+require 'gnawrnip/photographer'
+require 'gnawrnip/step_screenshot'
 
 module Gnawrnip
   class << self
-    attr_accessor :photographer_driver
+    attr_accessor :publisher_driver
     attr_accessor :frame_interval
     attr_accessor :frame_size
+    attr_accessor :make_animation
 
     def configure
       yield self
     end
 
     def ready!
-      photographer # Try to load driver library.
+      require 'gnawrnip/ext/capybara/session' if animation?
+      publisher
+    end
+
+    def animation?
+      make_animation
     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
+      @photographer ||= Gnawrnip::Photographer.new
+    end
+
+    def publisher
+      @publisher ||= case publisher_driver
+                     when :rmagick
+                       require 'gnawrnip/publisher/rmagick'
+                       @publisher = Publisher::RMagick.new
+                     else # :js
+                       require 'gnawrnip/publisher/js'
+                       @publisher = Publisher::JS.new
+                     end
     end
   end
 end
 
 Gnawrnip.configure do |c|
-  c.photographer_driver = :js
-  c.frame_interval = 1000
-  c.frame_size = nil
+  c.publisher_driver = :js
+  c.frame_interval   = 1000
+  c.frame_size       = nil
+  c.make_animation   = true
 end

data/spec/gnawrnip/photographer_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'gnawrnip/photographer'
+
+module Gnawrnip
+  describe Photographer do
+    let(:photographer) do
+      Photographer.new
+    end
+
+    before do
+      photographer.reset!
+      photographer.take_shot
+      photographer.take_shot
+    end
+
+    describe '.add_frame' do
+      subject { photographer.frames }
+      it { should have(2).elements }
+    end
+
+    describe '.reset!' do
+      before { photographer.reset! }
+      subject { photographer.frames }
+      it { should be_empty }
+    end
+  end
+end

data/spec/gnawrnip/publisher/rmagick.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'gnawrnip/publisher/rmagick'
+require 'RMagick'
+
+module Gnawrnip
+  module Publisher
+    describe RMagick do
+      let(:photographer) { RMagick.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
+end

data/spec/gnawrnip/rspec_spec.rb

@@ -16,7 +16,7 @@ module Gnawrnip
     end
 
     before do
-      Gnawrnip::Animation.stub(:frames) { ['aiueo', nil, 'lllll'] }
+      Gnawrnip.photographer.stub(:frames) { ['aiueo', nil, 'lllll'] }
     end
 
     context '"turnip" spec group' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnawrnip
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -145,18 +145,18 @@ files:
 - example/web.rb
 - gnawrnip.gemspec
 - 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/publisher.rb
+- lib/gnawrnip/publisher/js.rb
+- lib/gnawrnip/publisher/rmagick.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/photographer_spec.rb
+- spec/gnawrnip/publisher/rmagick.rb
 - spec/gnawrnip/rspec_spec.rb
 - spec/gnawrnip/screenshot_spec.rb
 - spec/gnawrnip/step_screenshot_spec.rb
@@ -174,12 +174,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2586147401268872003
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2586147401268872003
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -187,8 +193,8 @@ signing_key:
 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/photographer_spec.rb
+- spec/gnawrnip/publisher/rmagick.rb
 - spec/gnawrnip/rspec_spec.rb
 - spec/gnawrnip/screenshot_spec.rb
 - spec/gnawrnip/step_screenshot_spec.rb

data/lib/gnawrnip/animation.rb

@@ -1,21 +0,0 @@
-require 'gnawrnip/screenshot'
-require 'base64'
-
-module Gnawrnip
-  class Animation
-    class << self
-      def reset!
-        frames.clear
-      end
-
-      def frames
-        @frames ||= []
-      end
-
-      def add_frame
-        image = Screenshot.take
-        frames << image
-      end
-    end
-  end
-end

data/lib/gnawrnip/rmagick/photographer.rb

@@ -1,43 +0,0 @@
-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/spec/gnawrnip/animation_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-require 'gnawrnip/animation'
-
-module Gnawrnip
-  describe Animation do
-    before do
-      Animation.reset!
-      Animation.add_frame
-      Animation.add_frame
-    end
-
-    describe '.add_frame' do
-      subject { Animation.frames }
-      it { should have(2).elements }
-    end
-
-    describe '.reset!' do
-      before { Animation.reset! }
-      subject { Animation.frames }
-      it { should be_empty }
-    end
-  end
-end

data/spec/gnawrnip/rmagick/photographer_spec.rb

@@ -1,54 +0,0 @@
-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