artwork 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e51d5060c17f4737eda437c0f9ce39f16d0ae83
-  data.tar.gz: da1b48d509a9ddc8809f8a1f750fbf25d9f9c388
+  metadata.gz: eea1f0b27e394aabf472e48645693cb62f95df54
+  data.tar.gz: 493fdce70015ab3c194a9502542e43f08f3f8da8
 SHA512:
-  metadata.gz: 4db0e6456851055b2c9e952ffe8d57c368978425bc4d5e909436f6e6f59055c5fb28414f0ede41835883f0867ccfcbf30125d603e15097e99ebe287575a7c9a1
-  data.tar.gz: 7e1b104e52d173e01e9c1abe5deba6b574f7a22779070fd8918260513f27bbcec87714d457970648f4799283544023244da91336868496c21a04a04c44cc65d1
+  metadata.gz: 939897e270a6b5f0354763b544be4d9bd991c96021c3d0bc8921f749f9eb42e9830bf54cff7e31086dbedabf8b151a1dd59ff677c9607c8016ae63c20f803aed
+  data.tar.gz: 097fd8418344ae6ee63f5bc49e20e81b92d805381b57f8a484fd2f51b958e07733303b7ad1997490b8d7ecfcf9ae816f7c10b19468eaf85f80878a63f50658cc

data/README.md

@@ -101,6 +101,39 @@ the `artwork_tag` view helper. Example:
     <%= artwork_tag @film, :board, :'1440x', :image => {:class => 'poster'} %>
     <%= artwork_tag @gallery, :cover, :'900x' %>
 
+## Thumb Selection Algorithm
+
+The following criteria are taken into account for picking up the appropriate
+thumb name:
+
+- The `default_resolution` specified in the Artwork configuration file.
+- The current resolition, approximated to the nearest largest supported
+  resolution.
+- Whether or not the screen is retina.
+- The width of the requested thumb size (e.g. `400` for `400x300_crop`).
+- The label of the requested thumb (e.g. `crop` for `400x300_crop`); the label
+  will be ignored, if it is not specified, e.g. for `400x300` or `400x`. The
+  label will be locked to a blank one if the request is for a thumb like this:
+  `400x300_`.
+- The aspect ratio of the requested thumb (e.g. `4/3` for `400x300_crop`); the
+  aspect ratio will be ignored if there is no height specified in the requested
+  thumb, e.g. for a request like `400x_crop`.
+
+For a thumb to be returned as matching, all of the following must be true:
+
+- It must me the smallest thumb which is still larger than the requested width,
+  scaled for the current resolution.
+- If the requested thumb has a label (including a blank one, like in `400x_`),
+  the thumb must match the requested label.
+- If the requested thumb specifies an aspect ratio, the matching thumb must
+  have the same aspect ratio, rounded to the second decimal. If no aspect ratio
+  is specified in the request, aspect ratio checks will not be performed.
+- If the current device is a retina device, a retina thumb will be preferred.
+  If no retuna thumb exists, a non-retina one will be selected.
+
+If no such thumb exist, the largest one will match.
+
+
 ## Contributing
 
 1. [Fork it](https://github.com/mitio/artwork/fork)

data/lib/artwork/model.rb

@@ -9,14 +9,17 @@ module Artwork
       if desired_thumb.compatible?
         desired_size = desired_thumb.width / ratio_for_current_resolution
 
-        thumbs = attachment_styles_for(attachment_name) \
-          .map { |thumb_name| Thumbnail.new(thumb_name) } \
+        thumbs = attachment_styles_for(attachment_name).map { |thumb_name| Thumbnail.new(thumb_name) }
+
+        thumbs = thumbs \
           .select(&:compatible?) \
           .reject(&:retina?) \
+          .select { |thumb| desired_thumb.label.nil? or desired_thumb.label == thumb.label.to_s } \
+          .select { |thumb| desired_thumb.aspect_ratio.nil? or desired_thumb.same_aspect_ratio_with?(thumb) } \
           .sort
 
         thumbs.each do |thumb|
-          if desired_size <= thumb.width and thumb.label == desired_thumb.label
+          if desired_size <= thumb.width
             matching_thumb_name = thumb.name
             break
           end
@@ -25,6 +28,7 @@ module Artwork
         # If we did not find any matching attachment definitions,
         # the desired size is probably larger than all of our thumb widths,
         # So pick the last (largest) one we have.
+        return nil if thumbs.empty?
         matching_thumb_name ||= thumbs.last.name
       end
 

data/lib/artwork/thumbnail.rb

@@ -2,20 +2,26 @@ module Artwork
   class Thumbnail
     include Comparable
 
-    NAME_PATTERN = /^(\d+)x(\w*?)(_2x)?$/i.freeze
+    NAME_PATTERN = /^(\d+)x(\d+)?((?!_2x)_\w*?)?(_2x)?$/i.freeze
 
     attr :name
     attr :width
+    attr :height
     attr :label
+    attr :aspect_ratio
 
     def initialize(name)
       @name = name.to_s
 
       if match = @name.match(NAME_PATTERN)
         @width       = match[1].to_i
-        @label       = match[2].to_s.gsub(/^_|_$/, '')
-        @retina_flag = match[3]
+        @height      = match[2].to_i
+        @label       = match[3] ? match[3].gsub(/^_|_$/, '') : nil
+        @retina_flag = match[4]
       end
+
+      @height = nil if @height == 0
+      @aspect_ratio = @width.to_f / @height if @height
     end
 
     def compatible?
@@ -26,6 +32,12 @@ module Artwork
       @retina_flag == '_2x'
     end
 
+    def same_aspect_ratio_with?(other_thumb)
+      return unless aspect_ratio and other_thumb.aspect_ratio
+
+      (0.0..0.1).include? (aspect_ratio - other_thumb.aspect_ratio).abs
+    end
+
     def <=>(other_thumb)
       width <=> other_thumb.width
     end
@@ -33,6 +45,7 @@ module Artwork
     def eq(other)
       name    == other.name and \
       width   == other.width and \
+      height  == other.height and \
       label   == other.label and \
       retina? == other.retina?
     end

data/lib/artwork/version.rb

@@ -1,3 +1,3 @@
 module Artwork
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/spec/artwork/model_spec.rb

@@ -23,6 +23,9 @@ module Artwork
             :'320x500_2x'         => '640x1000>',
             :'320x500_crop'       => '320x500#',
             :'320x500_crop_2x'    => '640x1000#',
+            :'400x500'            => '400x500>',
+            :'400x500_2x'         => '800x1000>',
+            :'320x_'              => '320x>',
             :unsupported          => '100x100>'
           },
         },
@@ -46,6 +49,9 @@ module Artwork
           :'320x500_2x',
           :'320x500_crop',
           :'320x500_crop_2x',
+          :'400x500',
+          :'400x500_2x',
+          :'320x_',
           :unsupported,
         ]
       end
@@ -137,7 +143,8 @@ module Artwork
       end
 
       it 'picks the nearest non-retina size to our desizred size' do
-        expect_thumb '400x', :'640x'
+        expect_thumb '390x', :'400x500'
+        expect_thumb '420x', :'640x'
       end
 
       it 'picks the largest available size if requesting a too large thumb' do
@@ -154,16 +161,34 @@ module Artwork
         expect_thumb '200x_some_label', :'320x_some_label'
       end
 
-      it 'distinguishes thumbs by the supplied numerical label, as a vertical height' do
-        expect_thumb :'200x500', :'320x500'
+      it 'considers the aspect ratio of the desired thumb' do
+        expect_thumb '320x499', :'320x500'
+        expect_thumb '319x498', :'320x500'
         Artwork.load_2x_images = true
-        expect_thumb :'200x500', :'320x500_2x'
+        expect_thumb '319x498', :'320x500_2x'
+        expect_thumb '319x498_crop', :'320x500_crop_2x'
+        Artwork.load_2x_images = false
+        expect_thumb '319x498_crop', :'320x500_crop'
       end
 
-      it 'distinguishes thumbs by the supplied numerical label ignoring retina flags' do
-        expect_thumb :'200x500_2x', :'320x500'
+      it 'returns the largest thumb with the requested label if no other suitable sizes are found' do
+        expect_thumb '20000x_crop', :'320x500_crop'
         Artwork.load_2x_images = true
-        expect_thumb :'200x500_2x', :'320x500_2x'
+        expect_thumb '20000x_crop', :'320x500_crop_2x'
+      end
+
+      it 'returns the largest thumb with the requested aspect ratio if no other suitable sizes are found' do
+        expect_thumb '8000x10000', :'400x500'
+        Artwork.load_2x_images = true
+        expect_thumb '8000x10000', :'400x500_2x'
+      end
+
+      it 'returns nil if no thumbnail matches the requested aspect ratio' do
+        expect_thumb '319x200', nil
+      end
+
+      it 'returns nil if no thumbnail matches the requested label' do
+        expect_thumb '319x_nonexistant_label', nil
       end
     end
   end

data/spec/artwork/thumbnail_spec.rb

@@ -5,20 +5,23 @@ module Artwork
     expected_defaults = {:compatible? => true}
 
     examples = {
-      :'320x'               => {:width => 320,  :retina? => false, :label => ''},
-      :'320x_2x'            => {:width => 320,  :retina? => true,  :label => ''},
-      :'640x_2x'            => {:width => 640,  :retina? => true,  :label => ''},
-      :'640x'               => {:width => 640,  :retina? => false, :label => ''},
-      :'1280x'              => {:width => 1280, :retina? => false, :label => ''},
-      :'1280x_2x'           => {:width => 1280, :retina? => true,  :label => ''},
-      :'2000x'              => {:width => 2000, :retina? => false, :label => ''},
-      :'1500x_2x'           => {:width => 1500, :retina? => true,  :label => ''},
-      :'320x_some_label'    => {:width => 320,  :retina? => false, :label => 'some_label'},
-      :'320x_some_label_2x' => {:width => 320,  :retina? => true,  :label => 'some_label'},
-      :'320x500'            => {:width => 320,  :retina? => false, :label => '500'},
-      :'320x500_2x'         => {:width => 320,  :retina? => true,  :label => '500'},
-      :'320x500_crop'       => {:width => 320,  :retina? => false, :label => '500_crop'},
-      :'320x500_crop_2x'    => {:width => 320,  :retina? => true,  :label => '500_crop'},
+      :'320x'               => {:width => 320,  :height => nil, :retina? => false, :label => nil},
+      :'320x_2x'            => {:width => 320,  :height => nil, :retina? => true,  :label => nil},
+      :'640x_2x'            => {:width => 640,  :height => nil, :retina? => true,  :label => nil},
+      :'640x'               => {:width => 640,  :height => nil, :retina? => false, :label => nil},
+      :'1280x'              => {:width => 1280, :height => nil, :retina? => false, :label => nil},
+      :'1280x_2x'           => {:width => 1280, :height => nil, :retina? => true,  :label => nil},
+      :'2000x'              => {:width => 2000, :height => nil, :retina? => false, :label => nil},
+      :'1500x_2x'           => {:width => 1500, :height => nil, :retina? => true,  :label => nil},
+      :'320x_some_label'    => {:width => 320,  :height => nil, :retina? => false, :label => 'some_label'},
+      :'320x_some_label_2x' => {:width => 320,  :height => nil, :retina? => true,  :label => 'some_label'},
+      :'320x500'            => {:width => 320,  :height => 500, :retina? => false, :label => nil},
+      :'320x500_2x'         => {:width => 320,  :height => 500, :retina? => true,  :label => nil},
+      :'320x500_crop'       => {:width => 320,  :height => 500, :retina? => false, :label => 'crop'},
+      :'320x500_crop_2x'    => {:width => 320,  :height => 500, :retina? => true,  :label => 'crop'},
+      :'320x_'              => {:width => 320,  :height => nil, :retina? => false, :label => ''},
+      :'320x500_'           => {:width => 320,  :height => 500, :retina? => false, :label => ''},
+      :'320x500__2x'        => {:width => 320,  :height => 500, :retina? => true,  :label => ''},
       :unsupported          => {:compatible? => false},
       'unsupported_thumb'   => {:compatible? => false},
     }
@@ -39,18 +42,54 @@ module Artwork
     end
 
     describe '#eq' do
-      it 'is true for different objects with the same width, label and retina flag' do
+      it 'is true for different objects with the same width, height, label and retina flag' do
         expect(Thumbnail.new(:'1200x500_crop_2x')).to eq Thumbnail.new('1200x500_crop_2x')
         expect(Thumbnail.new(:'1200x_2x')).to eq Thumbnail.new('1200x_2x')
         expect(Thumbnail.new(:'1200x')).to eq Thumbnail.new('1200x')
         expect(Thumbnail.new(:'1200x_black_and_white')).to eq Thumbnail.new('1200x_black_and_white')
       end
 
-      it 'is false for different objects if any of the width, label or retina flag differ' do
+      it 'is false for different objects if any of the width, height, label or retina flag differ' do
         expect(Thumbnail.new(:'1200x500_crop_2x')).not_to eq Thumbnail.new('1200x500_crop')
         expect(Thumbnail.new(:'1200x500_crop_2x')).not_to eq Thumbnail.new('1200x500crop_2x')
         expect(Thumbnail.new(:'1200x500_crop_2x')).not_to eq Thumbnail.new('1201x500_crop_2x')
         expect(Thumbnail.new(:'1200x500_crop_2x')).not_to eq Thumbnail.new('1500x')
+        expect(Thumbnail.new(:'1200x500_crop_2x')).not_to eq Thumbnail.new('1200x400_crop_2x')
+      end
+    end
+
+    describe '#aspect_ratio' do
+      it 'is nil if height is not present or is zero' do
+        expect(Thumbnail.new('400x_label_2x').aspect_ratio).to be_nil
+        expect(Thumbnail.new('400x_2x').aspect_ratio).to be_nil
+        expect(Thumbnail.new('400x_').aspect_ratio).to be_nil
+        expect(Thumbnail.new('400x').aspect_ratio).to be_nil
+        expect(Thumbnail.new('400x0').aspect_ratio).to be_nil
+      end
+
+      it 'is calculated as a decimal when both a width and a height are present' do
+        expect(Thumbnail.new('400x300').aspect_ratio).to be_within(0.1).of(1.33)
+        expect(Thumbnail.new('1600x900').aspect_ratio).to be_within(0.1).of(1.78)
+        expect(Thumbnail.new('1600x900_with_label').aspect_ratio).to be_within(0.1).of(1.78)
+        expect(Thumbnail.new('1600x900_with_label_2x').aspect_ratio).to be_within(0.1).of(1.78)
+      end
+    end
+
+    describe '#same_aspect_ratio_with?' do
+      it 'returns nil if either thumbs have no clear height' do
+        expect(Thumbnail.new('400x300').same_aspect_ratio_with?(Thumbnail.new('400x'))).to be_nil
+        expect(Thumbnail.new('400x0').same_aspect_ratio_with?(Thumbnail.new('400x300'))).to be_nil
+      end
+
+      it 'returns true if thumbs have aspect ratios within 0.1 of one another' do
+        expect(Thumbnail.new('400x300').same_aspect_ratio_with?(Thumbnail.new('400x300'))).to be true
+        expect(Thumbnail.new('400x300').same_aspect_ratio_with?(Thumbnail.new('1600x1200_with_label_2x'))).to be true
+        expect(Thumbnail.new('400x300').same_aspect_ratio_with?(Thumbnail.new('400x301'))).to be true
+      end
+
+      it 'returns false if thumbs have different aspect ratios not within 0.1 of one another' do
+        expect(Thumbnail.new('400x300').same_aspect_ratio_with?(Thumbnail.new('400x200'))).to be false
+        expect(Thumbnail.new('400x300').same_aspect_ratio_with?(Thumbnail.new('5x10'))).to be false
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artwork
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Dimitar Dimitrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler