gnawrnip 0.1.3 → 0.2.0

data/.gitignore

@@ -18,3 +18,5 @@ tmp
 vendor
 example/vendor
 example/report.html
+.sass-cache
+example/.sass-cache

data/README.md

@@ -21,7 +21,6 @@ So it have potential for massive refactorings (that could be API breaking).
 * RubyGems
     * capybara `~> 2.1.0`
     * turnip_formatter
-    * rmagick ( **optional** )
 
 ## Installation
 
@@ -50,25 +49,29 @@ You can do to customize a screenshot.
 
 ```ruby
 Gnawrnip.configure do |c|
-  c.publisher_driver = :js
-  c.make_animation   = true
-  c.frame_interval   = 1000 # milliseconds
-  c.frame_size       = [640, 360] # width, height
+  c.frame_interval = 1000 # milliseconds
+  c.make_animation = true
+  c.max_frame_size = 1024 # pixel
 end
 ```
 
-* `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 `publisher_driver = :rmagick`.
+* `max_frame_size` (Integer) Maximum size that use to resize of image.
+    * If given, it resize the image to fit to this value.
+    * Ignored if this value is greater than original width and height.
+    * Example:
+
+      ```
+         original: 640x480
+       this value: 300
+          result : 300x225
+
+         original: 480x640
+       this value: 400
+          result : 300x400
+      ```
 
 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,7 @@ Capybara.default_driver = :poltergeist
 Capybara.javascript_driver = :selenium
 
 Gnawrnip.configure do |c|
-  # c.publisher_driver = :js
-  c.publisher_driver = :rmagick
   c.frame_interval = 1000 # milliseconds
-  c.frame_size = [640, 360] # width, height
-  c.make_animation = false
+  c.make_animation = true
+  c.max_frame_size = 1024 # pixel
 end
-

data/gnawrnip.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'capybara', "~> 2.1"
-  spec.add_dependency 'turnip_formatter', '~> 0.2.2'
+  spec.add_dependency 'turnip_formatter', '~> 0.2.8'
+  spec.add_dependency 'oily_png'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'rmagick'
 end

data/lib/gnawrnip/publisher.rb

@@ -1,21 +1,30 @@
 require 'base64'
 
 module Gnawrnip
-  module Publisher
+  class Publisher
+
+    #
+    # @params [Array]  paths  Array of screenshot image filename
+    #
     def animation(paths)
-      raise NotImplementedError
+      paths.map { |path| image_tag(path) }.join
     end
 
+    #
+    # @params [string]  path  Screenshot image filename
+    #
     def single(path)
-      image_tag(image_base64(path))
+      image_tag(path)
     end
 
-    def image_base64(path)
-      Base64.strict_encode64(File.read(path))
-    end
+    private
 
-    def image_tag(data, format = :png)
-      '<img src="data:image/' + format.to_s + ';base64,' + data + '"/>'
-    end
+      def image_tag(path, format = :png)
+        %Q|<img src="data:image/#{format.to_s};base64,#{image_base64(path)}"/>|
+      end
+
+      def image_base64(path)
+        Base64.strict_encode64(File.read(path))
+      end
   end
 end

data/lib/gnawrnip/screenshot.rb

@@ -29,6 +29,7 @@ module Gnawrnip
         begin
           tempfile = Tempfile.new(['gnawrnip', '.png'])
           session.save_screenshot(tempfile.path)
+          resize(tempfile.path) if need_resize?
           tempfile
         rescue Capybara::NotSupportedByDriverError => e
           raise e
@@ -41,9 +42,46 @@ module Gnawrnip
 
       private
 
-      def session
-        Capybara.current_session
-      end
+        def session
+          Capybara.current_session
+        end
+
+        def need_resize?
+          !Gnawrnip.max_frame_size.nil?
+        end
+
+        def resize(path)
+          require 'oily_png'
+
+          image = OilyPNG::Canvas.from_file(path)
+          new_width, new_height = calculate_new_size(image.width, image.height)
+
+          image.resample_bilinear!(new_width, new_height)
+          image.save(path)
+        end
+
+        #
+        # Return new frame size (width and height).
+        # This size is keeping original aspect ratio.
+        #
+        # @return  [Array]  New width and height size. [width, height]
+        #
+        def calculate_new_size(width, height)
+          ratio  = width / height
+          target = Gnawrnip.max_frame_size
+
+          return [width, height] if target > [width, height].max
+
+          if ratio < 0
+            new_width  = target * ratio
+            new_height = target
+          else
+            new_width  = target
+            new_height = target / ratio
+          end
+
+          return [new_width, new_height]
+        end
     end
   end
 end

data/lib/gnawrnip/step_screenshot.rb

@@ -6,7 +6,7 @@ module Gnawrnip
   module StepScreenshot
     class << self
       #
-      # @param  [Array]  png_base64_list  array of base64 encoded image
+      # @param  [Array] png_base64_list  array of base64 encoded image
       #
       def build(png_base64_list)
         case png_base64_list.length
@@ -20,9 +20,22 @@ module Gnawrnip
       end
 
       def animation_image(paths)
-        text = '<div class="screenshot animation">'
+        text = <<-EOS
+          <div class="screenshot animation">
+              <div class="nav">
+                  <div class="pager"></div>
+                  <div class="manipulate">
+                      <span class="play selected">&#9654;</span>
+                      <span class="stop">&#9632;</span>
+                  </div>
+              </div>
+              <div class="slides">
+        EOS
         text += Gnawrnip.publisher.animation(paths)
-        text + '</div>'
+        text + <<-EOS
+              </div>
+          </div>
+        EOS
       end
 
       def single_image(path)
@@ -35,16 +48,93 @@ module Gnawrnip
 end
 
 module TurnipFormatter
+  Template.add_js_file('http://cdnjs.cloudflare.com/ajax/libs/jquery.cycle2/20130801/jquery.cycle2.min.js')
+
+  Template.add_js(<<-EOS)
+    $(function() {
+        $('.screenshot.animation').each(function() {
+            var slide = $(this).find('.slides').cycle({
+                timeout: 1000,
+                autoHeight: "container",
+                pager: $(this).find('div.nav .pager')
+            });
+
+            var nav = $(this).find('div.nav');
+            var playButton = nav.find('.play');
+            var stopButton = nav.find('.stop');
+
+            var coloringOfStopped = function() {
+                playButton.removeClass("selected");
+                stopButton.addClass("selected");
+            };
+
+            var coloringOfPlaying = function() {
+                playButton.addClass("selected");
+                stopButton.removeClass("selected");
+            };
+
+            playButton.click(function() { slide.cycle('resume'); });
+            stopButton.click(function() { slide.cycle('pause'); });
+
+            slide.on('cycle-pager-activated', function(event, opts) {
+                slide.cycle('pause');
+            });
+
+            slide.on('cycle-paused', function(event, opts) {
+                coloringOfStopped();
+            });
+
+            slide.on('cycle-resumed', function(event, opts) {
+                coloringOfPlaying();
+            });
+        });
+    });
+  EOS
+
   Template.add_scss(<<-EOS)
     div#steps-statistics section.scenario {
         ul.steps {
             div.screenshot {
-               > img {
+               img {
                  max-width: 90%;
                  border: 2px solid black;
                }
-           }
-       }
+            }
+
+            div.screenshot.animation {
+                > div.nav {
+                    text-align: center;
+
+                    .pager {
+                        margin-left: auto;
+                        margin-right: auto;
+
+                        span {
+                            font-size: 50px;
+                            display: inline;
+                            color: #999999;
+                            cursor: pointer;
+
+                            &.cycle-pager-active {
+                                color: red;
+                            }
+                        }
+                    }
+
+                    .manipulate {
+                        span {
+                            color: black;
+                            font-size: 30px;
+                            cursor: pointer;
+
+                            &.selected {
+                                color: red;
+                            }
+                        }
+                    }
+                }
+            }
+        }
     }
   EOS
 

data/lib/gnawrnip/version.rb

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

data/lib/gnawrnip.rb

@@ -1,22 +1,43 @@
 require "gnawrnip/version"
 require 'gnawrnip/rspec'
 require 'gnawrnip/photographer'
-require 'gnawrnip/step_screenshot'
+require 'gnawrnip/publisher'
 
 module Gnawrnip
   class << self
-    attr_accessor :publisher_driver
+    #
+    # [Integer] Time (millisecond) between each image in animation
+    #
     attr_accessor :frame_interval
-    attr_accessor :frame_size
+
+    #
+    # [Boolean] Whether to make animation GIF
+    #
     attr_accessor :make_animation
 
+    #
+    # [Integer] Maximum size that use to resize of image.
+    #           If given, it resize the image to fit to this value.
+    #           Ignored if this value is greater than original width and height.
+    #
+    #           Example:
+    #                   original: 640x480
+    #                 this value: 300
+    #                    result : 300x225
+    #
+    #                   original: 480x640
+    #                 this value: 400
+    #                    result : 300x400
+    #
+    attr_accessor :max_frame_size
+
     def configure
       yield self
     end
 
     def ready!
       require 'gnawrnip/ext/capybara/session' if animation?
-      publisher
+      require 'gnawrnip/step_screenshot'
     end
 
     def animation?
@@ -24,25 +45,21 @@ module Gnawrnip
     end
 
     def photographer
-      @photographer ||= Gnawrnip::Photographer.new
+      @photographer ||= 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
+      @publisher ||= Publisher.new
+    end
+
+    def publisher_driver=(driver)
+      warn "DEPRECATED: `publisher_driver` option is deprecated (not used)."
     end
   end
 end
 
 Gnawrnip.configure do |c|
-  c.publisher_driver = :js
-  c.frame_interval   = 1000
-  c.frame_size       = nil
-  c.make_animation   = true
+  c.frame_interval = 1000
+  c.make_animation = true
+  c.max_frame_size = nil
 end

data/spec/gnawrnip/screenshot_spec.rb

@@ -6,8 +6,24 @@ module Gnawrnip
     describe '.take' do
       subject { Screenshot.take.read }
 
-      # see GnawrnipTestSession::save_screenshot
-      it { should == "screenshot" }
+      context 'No given max frame size' do
+        before do
+          Screenshot.stub(:need_resize?) { false }
+          Screenshot.should_not_receive(:resize)
+        end
+
+        # see GnawrnipTestSession::save_screenshot
+        it { should == "screenshot" }
+      end
+
+      context 'No given max frame size' do
+        before do
+          Screenshot.stub(:need_resize?) { true }
+          Screenshot.should_receive(:resize)
+        end
+
+        it { should == "screenshot" }
+      end
 
       context 'not support save_screenshot' do
         before do

data/spec/gnawrnip/step_screenshot_spec.rb

@@ -28,7 +28,8 @@ module Gnawrnip
           should include '<div class="screenshot animation">'
           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>'
+          should include '<img src="data:image/png;base64,' + data3 + '"/>'
+          should include '<div class="nav">'
         end
       end
 
@@ -38,6 +39,7 @@ module Gnawrnip
           data = Base64.strict_encode64('aiueo')
           should include '<div class="screenshot">'
           should include '<img src="data:image/png;base64,' + data + '"/></div>'
+          should_not include '<div class="nav">'
         }
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnawrnip
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,41 +42,41 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.8
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: oily_png
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rmagick
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -149,14 +149,11 @@ files:
 - lib/gnawrnip/no_screenshot.png
 - lib/gnawrnip/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/photographer_spec.rb
-- spec/gnawrnip/publisher/rmagick.rb
 - spec/gnawrnip/rspec_spec.rb
 - spec/gnawrnip/screenshot_spec.rb
 - spec/gnawrnip/step_screenshot_spec.rb
@@ -176,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2586147401268872003
+      hash: 270195121
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -185,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2586147401268872003
+      hash: 270195121
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -194,7 +191,6 @@ specification_version: 3
 summary: Add-on for TurnipFormatter with Capybara
 test_files:
 - 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/publisher/js.rb

@@ -1,30 +0,0 @@
-require 'gnawrnip/publisher'
-require 'turnip_formatter/template'
-
-module Gnawrnip
-  module Publisher
-    class JS
-      include Gnawrnip::Publisher
-
-      def animation(images)
-        images.map { |img| single(img) }.join
-      end
-    end
-  end
-end
-
-TurnipFormatter::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);
-        }, #{Gnawrnip.frame_interval.to_s});
-    });
-  });
-EOS

data/lib/gnawrnip/publisher/rmagick.rb

@@ -1,47 +0,0 @@
-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/spec/gnawrnip/publisher/rmagick.rb

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