spritely 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae40c9a7ce9d7836c6b37b3b3ccc626b65145525
-  data.tar.gz: 5749341869e454dfc773f11bc5bfb56a46b8c26c
+SHA256:
+  metadata.gz: 31b8d97d90ad2aff2af8f2a9b70e8498af3d33a84479f73d5fe55ce60bf169a0
+  data.tar.gz: 971bc7f7712fe8a0be34964a546cd15797d7a30f3daaae0989e3e996dd3aa3b8
 SHA512:
-  metadata.gz: f7ff4dff485cc7469d0aeecf8d403a392318993adb7bbd33d30f50c850b7dd4c56bbac761b5818861469a675550bfb2c9a34ffa85678e3e88941660a9fccebd5
-  data.tar.gz: 1d159336eaaaa280286f94b87bcc029a58bf1d61af3faf44d060975eee901490178eb0c6d45785902ccf18809497d90a01734bea77766938eaa538cb9d6f93be
+  metadata.gz: 4b6b3aef9dda6a35f3d09f6201ae3c117908464cd9de1e218dfc8edeb9654db4d8a9df624571db66def425cd8b072a9e244a911f266d5271cddaf8eeabab026e
+  data.tar.gz: 6dee0e5c12f995690e50eaeee5f761e75169732cc7857f08daf08fe1f8de1afbc4b927e12c7692cb461a79c0e9c5880a928e712f3dec19a5130993df123d4385

data/lib/spritely.rb

@@ -2,12 +2,20 @@ require 'sprockets'
 require 'spritely/sass_functions'
 require 'spritely/sprockets/preprocessor'
 require 'spritely/sprockets/transformer'
+require 'logger'
 
 if defined?(::Rails::Engine)
   require 'spritely/engine'
 end
 
 module Spritely
+  def self.logger
+    @logger ||= if defined?(::Rails.logger) && ::Rails.logger
+      ::Rails.logger
+    else
+      Logger.new($stderr)
+    end
+  end
 end
 
 ::Sprockets.register_mime_type 'text/sprite', extensions: ['.png.sprite']

data/lib/spritely/image_set.rb

@@ -24,11 +24,15 @@ module Spritely
     end
 
     def outer_height
-      height + spacing
+      spacing_above + height + spacing_below
     end
 
-    def spacing
-      options[:spacing].to_i
+    def spacing_above
+      options[:spacing_above].to_i
+    end
+
+    def spacing_below
+      (options[:spacing_below] || options[:spacing]).to_i
     end
 
     def repeated?
@@ -60,7 +64,7 @@ module Spritely
 
     def add_image!(left_position)
       images << Image.new(data).tap do |image|
-        image.top = top
+        image.top = top + spacing_above
         image.left = left_position
       end
     end

data/lib/spritely/sprockets/preprocessor.rb

@@ -6,23 +6,24 @@ module Spritely
     #
     #   //= directory foo/bar
     #   //= repeat arrow true
-    #   //= spacing arrow 10
+    #   //= spacing-below arrow 10
     #   //= position another-image right
-    #   //= spacing 5
+    #   //= spacing-above 5
+    #   //= spacing-below 5
     #
     # To this:
     #
     #   {
     #     directory: 'foo/bar',
-    #     global: { spacing: 5 },
+    #     global: { spacing_above: '5', spacing_below: '5' },
     #     images: {
-    #       'arrow' => { repeat: 'true', spacing: '10' },
-    #       'another-image' => { position: 'right', spacing: '5' }
+    #       'arrow' => { repeat: 'true', spacing_above: '10', spacing_below: '5' },
+    #       'another-image' => { position: 'right', spacing_above: '5', spacing_below: '5' }
     #     }
     #   }
     class Preprocessor < ::Sprockets::DirectiveProcessor
-      GLOBAL_DIRECTIVES = %w(position spacing).freeze
-      IMAGE_DIRECTIVES = %w(repeat position spacing).freeze
+      GLOBAL_DIRECTIVES = %w(position spacing spacing-above spacing-below).freeze
+      IMAGE_DIRECTIVES = %w(repeat position spacing spacing-above spacing-below).freeze
 
       def _call(input)
         @sprite_directives = { directory: nil, global: {}, images: {} }
@@ -51,14 +52,18 @@ module Spritely
       private
 
       def process_image_option(directive, image, value)
+        check_if_deprecated_directive(directive)
+
         @sprite_directives[:images][image] ||= {}
-        @sprite_directives[:images][image][directive.to_sym] = value
+        @sprite_directives[:images][image][directive.tr('-', '_').to_sym] = value
       end
 
       def process_global_option(directive, value)
         raise ArgumentError, "'#{directive}' is not a valid global option" unless GLOBAL_DIRECTIVES.include?(directive)
 
-        @sprite_directives[:global][directive.to_sym] = value
+        check_if_deprecated_directive(directive)
+
+        @sprite_directives[:global][directive.tr('-', '_').to_sym] = value
       end
 
       def merge_global_options!
@@ -66,6 +71,12 @@ module Spritely
           options.merge!(@sprite_directives[:global]) { |key, left, right| left }
         end
       end
+
+      def check_if_deprecated_directive(directive)
+        if directive == 'spacing'
+          Spritely.logger.warn "The `spacing` directive is deprecated and has been replaced by `spacing-below`. It will be removed in Spritely 3.0. (called from #{@filename})"
+        end
+      end
     end
   end
 end

data/lib/spritely/version.rb

@@ -1,3 +1,3 @@
 module Spritely
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/fixtures/rails-app/app/assets/images/sprites/application.png.sprite

@@ -1,5 +1,6 @@
 //= repeat background true
-//= spacing football 100
-//= spacing mario 10
+//= spacing-above football 10
+//= spacing-below football 100
+//= spacing-below mario 10
 //= position mario right
-//= spacing 5
+//= spacing-below 5

data/spec/fixtures/rails-app/app/assets/images/sprites/foo.png.sprite

@@ -1 +1 @@
-//= spacing 5
+//= spacing-below 5

data/spec/integration/stylesheet_spec.rb

@@ -19,7 +19,7 @@ describe 'Stylesheet generation', :integration do
     it { should include(<<-CSS.strip_heredoc
       #mario {
         background-image: url(#{background_image_url});
-        background-position: -150px -806px;
+        background-position: -150px -816px;
         width: 200px;
         height: 214px; }
     CSS

data/spec/spritely/image_set_spec.rb

@@ -3,7 +3,7 @@ require 'ostruct'
 
 describe Spritely::ImageSet do
   let(:path) { "#{__dir__}/../fixtures/test/foo.png" }
-  let(:options) { {repeat: 'true', spacing: '10', position: 'right'} }
+  let(:options) { {repeat: 'true', spacing_above: '5', spacing_below: '10', position: 'right'} }
 
   subject { Spritely::ImageSet.new(path, options) }
 
@@ -14,8 +14,9 @@ describe Spritely::ImageSet do
   its(:height) { should eq(1) }
   its(:name) { should eq('foo') }
   its(:left) { should eq(0) }
-  its(:spacing) { should eq(10) }
-  its(:outer_height) { should eq(11) }
+  its(:spacing_above) { should eq(5) }
+  its(:spacing_below) { should eq(10) }
+  its(:outer_height) { should eq(16) }
 
   describe '#top' do
     before { subject.top = 123 }
@@ -72,9 +73,9 @@ describe Spritely::ImageSet do
       end
 
       it 'should set the position of the images' do
-        expect(first_image.top).to eq(123)
+        expect(first_image.top).to eq(128)
         expect(first_image.left).to eq(0)
-        expect(second_image.top).to eq(123)
+        expect(second_image.top).to eq(128)
         expect(second_image.left).to eq(1)
       end
 

data/spec/spritely/sprockets/preprocessor_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Spritely::Sprockets::Preprocessor do
-  let(:data) { "//= spacing some-new-image 789\n//= position some-new-image right\n//= repeat another-image true\n//= repeat yet-another-image false\n//= spacing 901\n//= position left" }
+  let(:data) { "//= spacing-below some-new-image 789\n//= position some-new-image right\n//= repeat another-image true\n//= repeat yet-another-image false\n//= spacing-below 901\n//= spacing-above 101\n//= position left" }
   let(:input) { {
     data: data,
     filename: "sprites/foo.png.sprite",
@@ -15,15 +15,27 @@ describe Spritely::Sprockets::Preprocessor do
 
     expect(input[:metadata][:sprite_directives]).to eq(
       directory: nil,
-      global: { spacing: '901', position: 'left' },
+      global: { spacing_above: '101', spacing_below: '901', position: 'left' },
       images: {
-        "some-new-image" => { spacing: '789', position: 'right' },
-        "another-image" => { repeat: 'true', spacing: '901', position: 'left' },
-        "yet-another-image" => { repeat: 'false', spacing: '901', position: 'left' }
+        "some-new-image" => { spacing_above: '101', spacing_below: '789', position: 'right' },
+        "another-image" => { repeat: 'true', spacing_above: '101', spacing_below: '901', position: 'left' },
+        "yet-another-image" => { repeat: 'false', spacing_above: '101', spacing_below: '901', position: 'left' }
       }
     )
   end
 
+  describe 'deprecation warnings' do
+    describe 'spacing directive' do
+      let(:data) { "//= spacing true" }
+
+      it 'warns the user' do
+        deprecation_warning = 'The `spacing` directive is deprecated and has been replaced by `spacing-below`. It will be removed in Spritely 3.0. (called from sprites/foo.png.sprite)'
+
+        expect { preprocessor._call(input) }.to output(Regexp.new(Regexp.escape(deprecation_warning))).to_stderr
+      end
+    end
+  end
+
   describe 'overriding the directory' do
     let(:data) { "//= directory foo/sprites" }
     let(:input) { {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spritely
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Alex Robbin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -235,41 +235,41 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Hooks into the Sprockets asset packaging system to allow you to easily generate
   sprite maps
 test_files:
-- spec/fixtures/correct-empty-sprite.png
-- spec/fixtures/correct-renamed-sprite.png
-- spec/fixtures/correct-sprite.png
+- spec/spec_helper.rb
+- spec/integration/stylesheet_spec.rb
+- spec/integration/precompilation_spec.rb
+- spec/support/rails_app_helpers.rb
 - spec/fixtures/correct-weird-sprite.png
-- spec/fixtures/rails-app/app/assets/images/application/background.png
-- spec/fixtures/rails-app/app/assets/images/application/fool.png
-- spec/fixtures/rails-app/app/assets/images/application/football.png
-- spec/fixtures/rails-app/app/assets/images/application/mario.png
+- spec/fixtures/correct-renamed-sprite.png
+- spec/fixtures/rails-app-changes/app/assets/images/application/dropdown-arrow.png
+- spec/fixtures/rails-app-changes/app/assets/stylesheets/sprites.css.scss
+- spec/fixtures/test/foo.png
 - spec/fixtures/rails-app/app/assets/images/empty/fool.png
 - spec/fixtures/rails-app/app/assets/images/foo/fool.png
-- spec/fixtures/rails-app/app/assets/images/sprites/application.png.sprite
-- spec/fixtures/rails-app/app/assets/images/sprites/empty.png.sprite
 - spec/fixtures/rails-app/app/assets/images/sprites/foo.png.sprite
 - spec/fixtures/rails-app/app/assets/images/sprites/weird.png.sprite
+- spec/fixtures/rails-app/app/assets/images/sprites/application.png.sprite
+- spec/fixtures/rails-app/app/assets/images/sprites/empty.png.sprite
+- spec/fixtures/rails-app/app/assets/images/application/fool.png
+- spec/fixtures/rails-app/app/assets/images/application/background.png
+- spec/fixtures/rails-app/app/assets/images/application/football.png
+- spec/fixtures/rails-app/app/assets/images/application/mario.png
 - spec/fixtures/rails-app/app/assets/images/weird/sprite-images/mario.png
-- spec/fixtures/rails-app/app/assets/stylesheets/sprites.css.scss
 - spec/fixtures/rails-app/app/assets/stylesheets/sprites_2.css.scss
+- spec/fixtures/rails-app/app/assets/stylesheets/sprites.css.scss
 - spec/fixtures/rails-app/config/initializers/assets.rb
-- spec/fixtures/rails-app-changes/app/assets/images/application/dropdown-arrow.png
-- spec/fixtures/rails-app-changes/app/assets/stylesheets/sprites.css.scss
-- spec/fixtures/test/foo.png
-- spec/integration/precompilation_spec.rb
-- spec/integration/stylesheet_spec.rb
-- spec/spec_helper.rb
+- spec/fixtures/correct-sprite.png
+- spec/fixtures/correct-empty-sprite.png
 - spec/spritely/collection_spec.rb
-- spec/spritely/generators/chunky_png_spec.rb
 - spec/spritely/image_set_spec.rb
-- spec/spritely/image_spec.rb
+- spec/spritely/sprockets/preprocessor_spec.rb
 - spec/spritely/sass_functions_spec.rb
+- spec/spritely/image_spec.rb
+- spec/spritely/generators/chunky_png_spec.rb
 - spec/spritely/sprite_map_spec.rb
-- spec/spritely/sprockets/preprocessor_spec.rb
-- spec/support/rails_app_helpers.rb