pageflow-linkmap-page 1.5.0 → 2.0.0

data/spec/helpers/pageflow/linkmap_page/areas_helper_spec.rb

@@ -22,44 +22,107 @@ module Pageflow
           expect(html).to have_selector('div a[href]')
         end
 
-        it 'renders hover image canvas inside linkmap areas' do
+        it 'renders hover image inside linkmap areas' do
           entry = create(:entry)
           configuration = {'linkmap_areas' => [{}], 'hover_image_id' => 5}
 
           html = helper.linkmap_areas_div(entry, configuration)
 
-          expect(html).to have_selector('a canvas.hover_image')
+          expect(html).to have_selector('a div[class~="image_panorama_5"]')
         end
 
-        it 'sets data-mask-id attribute if area has mask_perma_id' do
+        it 'renders masked hover image inside masked linkmap areas' do
           entry = create(:entry)
-          configuration = {'linkmap_areas' => [{'mask_perma_id' => '1:2'}]}
+          color_map_file = create(:color_map_file)
+          masked_image_file = create(:masked_image_file)
+          configuration = {
+            'linkmap_areas' => [{'mask_perma_id' => "#{color_map_file.id}:aaa"}],
+            'hover_image_id' => 5,
+            'linkmap_color_map_file_id' => color_map_file.id,
+            'linkmap_masked_hover_image_id' => masked_image_file.id
+          }
 
           html = helper.linkmap_areas_div(entry, configuration)
 
-          expect(html).to have_selector('a[data-mask-id="1:2"]')
+          image_class = "pageflow_linkmap_page_masked_image_file_aaa_#{masked_image_file.id}"
+          expect(html).to have_selector("a div[class~=#{image_class}]")
         end
 
-        it 'does not set data-mask-id attribute if background type is hover_video' do
+        it 'only uses masked hover image if area is masked' do
           entry = create(:entry)
+          masked_image_file = create(:masked_image_file)
           configuration = {
-            'linkmap_areas' => [{'mask_perma_id' => '1:2'}],
-            'background_type' => 'hover_video'
+            'linkmap_areas' => [{}],
+            'hover_image_id' => 5,
+            'linkmap_masked_hover_image_id' => masked_image_file.id
           }
 
           html = helper.linkmap_areas_div(entry, configuration)
 
-          expect(html).not_to have_selector('a[data-mask-id]')
+          expect(html).to have_selector('a div[class~="image_panorama_5"]')
         end
 
-        it 'renders attribute with url template for mask sprite' do
+        it 'does not use masked hover image if area mask perma id references other image' do
           entry = create(:entry)
-          configuration = {}
+          masked_image_file = create(:masked_image_file)
+          color_map_file = create(:color_map_file)
+          other_id = color_map_file.id + 1
+          configuration = {
+            'linkmap_areas' => [{'mask_perma_id' => "#{other_id}:aaa"}],
+            'hover_image_id' => 5,
+            'linkmap_masked_hover_image_id' => masked_image_file.id
+          }
+
+          html = helper.linkmap_areas_div(entry, configuration)
+
+          expect(html).to have_selector('a div[class~="image_panorama_5"]')
+        end
+
+        it 'renders visited image inside linkmap areas' do
+          entry = create(:entry)
+          configuration = {'linkmap_areas' => [{}], 'visited_image_id' => 5}
+
+          html = helper.linkmap_areas_div(entry, configuration)
+
+          expect(html).to have_selector('a div[class~="image_panorama_5"]')
+        end
+
+        it 'renders masked visited image inside masked linkmap areas' do
+          entry = create(:entry)
+          color_map_file = create(:color_map_file)
+          masked_image_file = create(:masked_image_file)
+          configuration = {
+            'linkmap_areas' => [{'mask_perma_id' => "#{color_map_file.id}:aaa"}],
+            'hover_image_id' => 5,
+            'linkmap_color_map_file_id' => color_map_file.id,
+            'linkmap_masked_visited_image_id' => masked_image_file.id
+          }
+
+          html = helper.linkmap_areas_div(entry, configuration)
+
+          image_class = "pageflow_linkmap_page_masked_image_file_aaa_#{masked_image_file.id}"
+          expect(html).to have_selector("a div[class~='#{image_class}']")
+        end
+
+        it 'sets data-mask-perma-id attribute if area has mask_perma_id' do
+          entry = create(:entry)
+          configuration = {'linkmap_areas' => [{'mask_perma_id' => '1:aaa'}]}
+
+          html = helper.linkmap_areas_div(entry, configuration)
+
+          expect(html).to have_selector('a[data-mask-perma-id="1:aaa"]')
+        end
+
+        it 'does not set data-mask-perma-id attribute if background type is hover_video' do
+          entry = create(:entry)
+          configuration = {
+            'linkmap_areas' => [{'mask_perma_id' => '1:aaa'}],
+            'background_type' => 'hover_video'
+          }
 
           html = helper.linkmap_areas_div(entry, configuration)
 
-          url_matcher = 'attachments/:id_partition/original'
-          expect(html).to have_selector("div[data-mask-sprite-url-template*='#{url_matcher}']")
+          expect(html).not_to have_selector('a[data-mask-perma-id]')
         end
       end
 

data/spec/integration/masked_image_file_type_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+require 'pageflow/lint'
+
+module Pageflow
+  module LinkmapPage
+    Pageflow::Lint.file_type(:masked_image_file,
+                             create_file_type: -> { LinkmapPage.masked_image_file_type },
+                             create_file: -> { create(:masked_image_file) })
+
+    Pageflow::Lint.file_type(:color_map_file,
+                             create_file_type: -> { LinkmapPage.color_map_file_type },
+                             create_file: -> { create(:color_map_file) })
+  end
+end

data/spec/models/pageflow/linkmap_page/color_map_file_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+module Pageflow
+  module LinkmapPage
+    describe ColorMapFile, inline_resque: true do
+      let(:red_from_palette) { 'f65b57' }
+      let(:green_from_palette) { '69a77b' }
+
+      describe 'process' do
+        it 'remaps colors to fixed palette' do
+          image_file = create(:image_file, :red_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.processed_attachment)
+            .to have_color(red_from_palette).at(left: 0, top: 0)
+        end
+
+        it 'removes dots and shapes that are smaller than 3x3' do
+          image_file = create(:image_file, :dots_and_lines_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.present_colors.size).to eq(1)
+        end
+
+        it 'handles black the same as transparency' do
+          image_file = create(:image_file, :green_and_black_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.present_colors.size).to eq(1)
+        end
+
+        it 'stores colors used in remapped image' do
+          image_file = create(:image_file, :red_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.present_colors).to eql([red_from_palette])
+        end
+
+        it 'stores width and height of resized image' do
+          image_file = create(:image_file, :color_map_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.width).to eq(20)
+          expect(color_map_file.height).to eq(10)
+        end
+
+        it 'stores bounding boxes of colors' do
+          image_file = create(:image_file, :color_map_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.bounding_box_for_color(red_from_palette))
+            .to eql(left: 0,
+                    top: 0,
+                    width: color_map_file.width / 2,
+                    height: color_map_file.height / 5 * 2)
+
+          expect(color_map_file.bounding_box_for_color(green_from_palette))
+            .to eql(left: color_map_file.width / 2,
+                    top: 0,
+                    width: color_map_file.width / 2,
+                    height: color_map_file.height)
+        end
+
+        let(:pixel_where_sprite_is_green)       { {left: 0, top: 0} }
+        let(:pixel_where_sprite_is_red)         { {right: 0, top: 0} }
+        let(:pixel_where_sprite_is_transparent) { {right: 0, bottom: 0} }
+
+        it 'creates sprite with color components sorted by color name' do
+          image_file = create(:image_file, :color_map_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.attachment.styles[:sprite])
+            .to have_color(green_from_palette).at(pixel_where_sprite_is_green)
+          expect(color_map_file.attachment.styles[:sprite])
+            .to have_color(red_from_palette).at(pixel_where_sprite_is_red)
+          expect(color_map_file.attachment.styles[:sprite])
+            .to have_color(:transparent).at(pixel_where_sprite_is_transparent)
+        end
+
+        it 'sets processing progress' do
+          image_file = create(:image_file, :color_map_fixture)
+          color_map_file = create(:color_map_file, source_image_file: image_file)
+
+          color_map_file.process
+          color_map_file.reload
+
+          expect(color_map_file.processing_progress).to eq(100)
+        end
+      end
+    end
+  end
+end

data/spec/models/pageflow/linkmap_page/masked_image_file_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+module Pageflow
+  module LinkmapPage
+    describe MaskedImageFile, inline_resque: true do
+      let :color_map_file do
+        color_map_image_file = create(:image_file, :color_map_fixture)
+
+        create(:color_map_file,
+               :processed,
+               source_image_file: color_map_image_file)
+      end
+
+      let(:pixel_where_color_map_is_red)         { {left: 0, top: 0} }
+      let(:pixel_where_color_map_is_green)       { {right: 0, top: 0} }
+      let(:pixel_where_color_map_is_transparent) { {left: 0, bottom: 1} }
+
+      let(:red_from_color_map_palette)   { 'f65b57' }
+      let(:green_from_color_map_palette) { '69a77b' }
+
+      let :transparent_source_image_file do
+        create(:image_file, :transparent_fixture)
+      end
+
+      let :single_color_source_image_file do
+        create(:image_file, :red_fixture)
+      end
+
+      let(:color_of_source_image) { '#ff0000' }
+
+      describe 'process' do
+        it 'creates images for each color in color map masked to the area of that color' do
+          masked_image_file = create(:masked_image_file,
+                                     color_map_file: color_map_file,
+                                     source_image_file: single_color_source_image_file)
+
+          masked_image_file.process
+          masked_image_file.reload
+
+          expect(masked_image_file.for_color(red_from_color_map_palette))
+            .to have_color(color_of_source_image).at(pixel_where_color_map_is_red)
+
+          expect(masked_image_file.for_color(green_from_color_map_palette))
+            .to have_color(color_of_source_image).at(pixel_where_color_map_is_green)
+        end
+
+        it 'leaves other parts of the image transparent' do
+          masked_image_file = create(:masked_image_file,
+                                     color_map_file: color_map_file,
+                                     source_image_file: single_color_source_image_file)
+
+          masked_image_file.process
+          masked_image_file.reload
+
+          expect(masked_image_file.for_color(red_from_color_map_palette))
+            .to have_color(:transparent).at(pixel_where_color_map_is_green)
+
+          expect(masked_image_file.for_color(red_from_color_map_palette))
+            .to have_color(:transparent).at(pixel_where_color_map_is_transparent)
+        end
+
+        it 'leaves transparent areas of source image transparent' do
+          masked_image_file = create(:masked_image_file,
+                                     color_map_file: color_map_file,
+                                     source_image_file: transparent_source_image_file)
+
+          masked_image_file.process
+          masked_image_file.reload
+
+          expect(masked_image_file.for_color(red_from_color_map_palette))
+            .to have_color(:transparent).at(pixel_where_color_map_is_red)
+        end
+
+        it 'updates processing progress' do
+          masked_image_file = create(:masked_image_file,
+                                     color_map_file: color_map_file,
+                                     source_image_file: single_color_source_image_file)
+
+          masked_image_file.process
+          masked_image_file.reload
+
+          expect(masked_image_file.processing_progress).to eq(100)
+        end
+      end
+    end
+  end
+end

data/spec/pageflow/linkmap_page/paperclip_processors/colors_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Pageflow
+  module LinkmapPage
+    module PaperclipProcessors
+      describe Colors::ConvertOutput do
+        describe '.parse_unique_colors' do
+          it 'parses hex colors from output' do
+            output = <<-OUTPUT.unindent
+              # ImageMagick pixel enumeration: 3,1,255,srgba
+              0,0: (246,91,87,1)  #F65B57  srgba(246,91,87,1)
+              1,0: (105,167,123,1)  #69A77B  srgba(105,167,123,1)
+              2,0: (0,0,0,0)  #00000000  none
+            OUTPUT
+
+            result = Colors::ConvertOutput.parse_unique_colors(output)
+
+            expect(result).to eq(%w(69a77b f65b57))
+          end
+        end
+
+        describe '.parse_trim' do
+          it 'parses trimmed dimensions' do
+            output = <<-OUTPUT.unindent
+              file.png PNG 724x665 1920x1080+606+210 8-bit sRGB 0.010u 0:00.00
+            OUTPUT
+
+            result = Colors::ConvertOutput.parse_trim(output)
+
+            expect(result).to eq(left: 606, top: 210, width: 724, height: 665)
+          end
+
+          it 'handles empty image output correctly' do
+            output = <<-OUTPUT.unindent
+              file.png PNG 1x1 1920x1080-1-1 8-bit sRGB 0.010u 0:00.00
+            OUTPUT
+
+            result = Colors::ConvertOutput.parse_trim(output)
+
+            expect(result).to eq(left: 0, top: 0, width: 0, height: 0)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pageflow/linkmap_page/progress_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+module Pageflow
+  module LinkmapPage
+    describe Progress do
+      it 'reports percentage values after each step' do
+        reported_values = []
+        progress = Progress.new(steps: 4) do |percent|
+          reported_values << percent
+        end
+
+        4.times { progress.step }
+
+        expect(reported_values).to eq([25, 50, 75, 100])
+      end
+
+      it 'supports dividing a step into sub steps' do
+        reported_values = []
+        progress = Progress.new(steps: 2) do |percent|
+          reported_values << percent
+        end
+
+        progress.divide(steps: 4) do |p|
+          4.times { p.step }
+        end
+        progress.divide(steps: 2) do |p|
+          2.times { p.step }
+        end
+
+        expect(reported_values).to eq([12.5, 25, 37.5, 50, 75, 100])
+      end
+
+      it 'supports mixing normal and divided steps' do
+        reported_values = []
+        progress = Progress.new(steps: 3) do |percent|
+          reported_values << percent.round(1)
+        end
+
+        progress.step
+        progress.divide(steps: 2) do |p|
+          2.times { p.step }
+        end
+        progress.step
+
+        expect(reported_values).to eq([33.3, 50, 66.7, 100])
+      end
+
+      it 'calling step to often is ignored' do
+        reported_values = []
+        progress = Progress.new(steps: 2) do |percent|
+          reported_values << percent
+        end
+
+        progress.step
+        progress.step
+        progress.step
+
+        expect(reported_values).to eq([50, 100])
+      end
+
+      it 'calling divide when no step is left is ignored' do
+        reported_values = []
+        progress = Progress.new(steps: 2) do |percent|
+          reported_values << percent
+        end
+
+        progress.step
+        progress.step
+        progress.divide(steps: 2) do |p|
+          p.step
+          p.step
+        end
+
+        expect(reported_values).to eq([50, 100])
+      end
+
+      it 'ignores calls to step if total steps is 0' do
+        reported_values = []
+        progress = Progress.new(steps: 0) do |percent|
+          reported_values << percent
+        end
+
+        progress.step
+        progress.step
+        progress.step
+
+        expect(reported_values).to eq([])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 ENV['RAILS_ENV'] ||= 'test'
 ENV['PAGEFLOW_PLUGIN_ENGINE'] = 'pageflow_linkmap_page'
 
-require 'factory_girl_rails'
+require 'unindent'
 
 require 'pageflow/support'
 Pageflow::Dummy.setup
@@ -17,4 +17,8 @@ RSpec.configure do |config|
   config.use_transactional_fixtures = true
   config.infer_base_class_for_anonymous_controllers = false
   config.order = "random"
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
 end

data/spec/support/config/devise.rb

@@ -1,10 +1,3 @@
 RSpec.configure do |config|
-  module DeviseTestHelpersWithScope
-    def sign_in(user)
-      super(:user, user)
-    end
-  end
-
-  config.include Devise::TestHelpers, type: :controller
-  config.include DeviseTestHelpersWithScope, type: :controller
+  config.include Devise::Test::ControllerHelpers, type: :controller
 end

data/spec/support/config/{factory_girl.rb → factory_bot.rb}

@@ -1,12 +1,14 @@
+require 'factory_bot_rails'
+
 RSpec.configure do |config|
-  # Allow to use build and create methods without FactoryGirl prefix.
-  config.include FactoryGirl::Syntax::Methods
+  # Allow to use build and create methods without FactoryBot prefix.
+  config.include FactoryBot::Syntax::Methods
 
   # Make sure factories are up to date when using spring. Skip in CI
   # since reloading causes factories to be excluded in test coverage.
   unless ENV['CI']
     config.before(:all) do
-      FactoryGirl.reload
+      FactoryBot.reload
     end
   end
 end

data/spec/support/config/resque.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before(:each, inline_resque: true) do
+    Resque.inline = true
+  end
+
+  config.after(:each, inline_resque: true) do
+    Resque.inline = false
+  end
+end

data/spec/support/matchers/have_color.rb

@@ -0,0 +1,34 @@
+require 'chunky_png'
+
+RSpec::Matchers.define :have_color do |expected_color|
+  expected_color =
+    if expected_color == :transparent
+      ChunkyPNG::Color.parse('#00000000')
+    else
+      ChunkyPNG::Color.parse(expected_color)
+    end
+
+  match do |attachment|
+    actual_color(attachment) == expected_color
+  end
+
+  failure_message do |attachment|
+    "expected image to have pixel with color #{ChunkyPNG::Color.to_hex(expected_color)} " \
+      "at #{@position}, but found #{ChunkyPNG::Color.to_hex(actual_color(attachment))}."
+  end
+
+  chain :at do |position|
+    @position = position
+  end
+
+  def actual_color(attachment)
+    @actual_color ||= Pageflow::LinkmapPage::PaperclipTempfile.for(attachment) do |path|
+      image = ChunkyPNG::Image.from_file(path)
+
+      x = @position.fetch(:left) { image.width - 1 - @position[:right] }
+      y = @position.fetch(:top) { image.height - 1 - @position[:bottom] }
+
+      ChunkyPNG::Color.parse(image[x, y])
+    end
+  end
+end