spritely 0.3.2 → 1.0.0

data/spec/spritely/sprockets/preprocessor_spec.rb

@@ -0,0 +1,33 @@
+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(:input) { {
+    data: data,
+    filename: "sprites/foo.png.sprite",
+    metadata: {}
+  } }
+
+  subject(:preprocessor) { Spritely::Sprockets::Preprocessor.new(comments: ["//", ["/*", "*/"]]) }
+
+  it 'saves the processed options as part of the metadata' do
+    preprocessor._call(input)
+
+    expect(input[:metadata][:sprite_directives]).to eq(
+      global: { spacing: '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' }
+      }
+    )
+  end
+
+  describe 'invalid global option' do
+    let(:data) { "//= repeat true" }
+
+    it 'raises an exception' do
+      expect { preprocessor._call(input) }.to raise_error(ArgumentError, "'repeat' is not a valid global option")
+    end
+  end
+end

data/spec/support/rails_app_helpers.rb

@@ -1,3 +1,6 @@
+require 'sprockets/rails/version'
+require 'sprockets/version'
+
 module RailsAppHelpers
   GENERATOR_FLAGS = [
     '--skip-active-record',
@@ -21,7 +24,6 @@ module RailsAppHelpers
               f.write("gem 'sprockets', '#{Sprockets::VERSION}'")
             end
             %x(bundle install)
-            %x(rails generate spritely:install)
             FileUtils.cp_r "#{__dir__}/../fixtures/rails-app/.", "."
             yield
           end
@@ -35,8 +37,7 @@ module RailsAppHelpers
   end
 
   def spite_image_path(sprite_name)
-    # TODO: When Sprockets 2.0 support is dropped (probably when Sprockets 4.0 is released), swap `digest` for `hexdigest`
-    fingerprint = runner(%~puts Rails.application.assets["sprites/#{sprite_name}.png"].digest~)
+    fingerprint = runner(%~puts Rails.application.assets["sprites/#{sprite_name}.png"].hexdigest~)
     "/assets/sprites/application-#{fingerprint.strip}.png"
   end
 
@@ -44,8 +45,6 @@ module RailsAppHelpers
     %x(RAILS_ENV=production rake assets:precompile)
   end
 
-  private
-
   def runner(command)
     %x(rails runner -e development '#{command}')
   end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: spritely
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Robbin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: chunky_png
+  name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: sprockets-rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,35 +109,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -171,20 +171,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/generators/spritely/install_generator.rb
 - lib/spritely.rb
-- lib/spritely/adapters/sprockets_2.rb
-- lib/spritely/adapters/sprockets_3.rb
-- lib/spritely/cache.rb
 - lib/spritely/collection.rb
+- lib/spritely/engine.rb
 - lib/spritely/generators/base.rb
 - lib/spritely/generators/chunky_png.rb
 - lib/spritely/image.rb
 - lib/spritely/image_set.rb
-- lib/spritely/options.rb
 - lib/spritely/sass_functions.rb
 - lib/spritely/sprite_map.rb
-- lib/spritely/sprockets/manifest.rb
+- lib/spritely/sprockets/preprocessor.rb
+- lib/spritely/sprockets/transformer.rb
 - lib/spritely/version.rb
 - spec/fixtures/correct-sprite.png
 - spec/fixtures/rails-app-changes/app/assets/images/application/dropdown-arrow.png
@@ -194,27 +191,23 @@ files:
 - 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/foo/fool.png
+- spec/fixtures/rails-app/app/assets/images/sprites/application.png.sprite
+- spec/fixtures/rails-app/app/assets/images/sprites/foo.png.sprite
 - 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/config/initializers/assets.rb
 - spec/fixtures/test/foo.png
-- spec/generators/spritely/install_generator_spec.rb
 - spec/integration/precompilation_spec.rb
 - spec/integration/stylesheet_spec.rb
 - spec/spec_helper.rb
-- spec/spritely/cache_spec.rb
 - 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/options_spec.rb
 - spec/spritely/sass_functions_spec.rb
 - spec/spritely/sprite_map_spec.rb
-- spec/spritely_spec.rb
+- spec/spritely/sprockets/preprocessor_spec.rb
 - spec/support/rails_app_helpers.rb
-- spec/support/shared_examples.rb
-- spec/support/shared_examples/sprockets_2_sass_functions_helpers.rb
-- spec/support/shared_examples/sprockets_3_sass_functions_helpers.rb
 homepage: https://github.com/agrobbin/spritely
 licenses:
 - MIT
@@ -238,8 +231,8 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Hooks into the Rails asset pipeline to allow you to easily generate sprite
-  maps
+summary: Hooks into the Sprockets asset packaging system to allow you to easily generate
+  sprite maps
 test_files:
 - spec/fixtures/correct-sprite.png
 - spec/fixtures/rails-app/app/assets/images/application/background.png
@@ -247,26 +240,22 @@ test_files:
 - 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/foo/fool.png
+- spec/fixtures/rails-app/app/assets/images/sprites/application.png.sprite
+- spec/fixtures/rails-app/app/assets/images/sprites/foo.png.sprite
 - 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/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/generators/spritely/install_generator_spec.rb
 - spec/integration/precompilation_spec.rb
 - spec/integration/stylesheet_spec.rb
 - spec/spec_helper.rb
-- spec/spritely/cache_spec.rb
 - 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/options_spec.rb
 - spec/spritely/sass_functions_spec.rb
 - spec/spritely/sprite_map_spec.rb
-- spec/spritely_spec.rb
+- spec/spritely/sprockets/preprocessor_spec.rb
 - spec/support/rails_app_helpers.rb
-- spec/support/shared_examples/sprockets_2_sass_functions_helpers.rb
-- spec/support/shared_examples/sprockets_3_sass_functions_helpers.rb
-- spec/support/shared_examples.rb

data/lib/generators/spritely/install_generator.rb

@@ -1,17 +0,0 @@
-require 'rails/generators/base'
-
-module Spritely
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      def create_empty_sprites_folder
-        empty_directory Spritely.relative_folder_path
-        create_file "#{Spritely.relative_folder_path}/.keep"
-      end
-
-      def add_sprites_folder_to_gitignore
-        create_file '.gitignore', skip: true
-        inject_into_file '.gitignore', "\n/#{Spritely.relative_folder_path.join('*.png')}\n", after: /\z/
-      end
-    end
-  end
-end

data/lib/spritely/adapters/sprockets_2.rb

@@ -1,13 +0,0 @@
-module Spritely
-  module Adapters
-    class Sprockets2
-      def reset_cache!(environment, filename)
-        environment.instance_variable_get(:@assets).delete_if { |_, asset| asset.pathname == filename }
-        environment.send(:trail).tap do |trail|
-          trail.instance_variable_get(:@entries).delete(Spritely.directory.to_s)
-          trail.instance_variable_get(:@stats).delete(filename.to_s)
-        end
-      end
-    end
-  end
-end

data/lib/spritely/adapters/sprockets_3.rb

@@ -1,11 +0,0 @@
-module Spritely
-  module Adapters
-    class Sprockets3
-      def reset_cache!(environment, filename)
-        environment.instance_variable_get(:@uris).delete_if { |_, asset| asset.pathname == filename }
-        environment.instance_variable_get(:@entries).delete(Spritely.directory.to_s)
-        environment.instance_variable_get(:@stats).delete(filename.to_s)
-      end
-    end
-  end
-end

data/lib/spritely/cache.rb

@@ -1,51 +0,0 @@
-require 'digest/md5'
-require 'spritely/version'
-
-module Spritely
-  # `Cache` is responsible for generating and fetching the current sprite cache
-  # `value. It is used to determine whether to generate a new sprite map or not.
-  #
-  # Passing in a set of objects that respond to `cache_key` will generate an MD5
-  # hash that can then be stored in the image itself.
-  #
-  # Fetching an existing cache key actually reads the PNG file itself. It scans
-  # the chunks of the PNG until it finds the `cache_key` keyword, returning the
-  # subsequent value found.
-  class Cache < Struct.new(:filename)
-    PNG_SIGNATURE_LENGTH = 8 # http://www.w3.org/TR/PNG/#5PNG-file-signature
-    PNG_INFO_LENGTH = 8 # http://www.w3.org/TR/PNG/#5DataRep
-    PNG_CRC_LENGTH = 4 # Cyclic Redundancy Check (CRC) byte-length; http://www.w3.org/TR/PNG/#5Chunk-layout
-
-    def self.generate(*objects)
-      Digest::MD5.hexdigest(VERSION + objects.collect(&:cache_key).join)
-    end
-
-    def self.busted?(filename, expected_cache_key)
-      new(filename).key != expected_cache_key
-    end
-
-    def key
-      return @key if @key
-
-      File.open(filename) do |file|
-        file.read(PNG_SIGNATURE_LENGTH) # we first have to read the signature to fast-forward the IO#pos
-        until file.eof?
-          each_chunk(file) do |keyword, value|
-            if keyword == 'cache_key'
-              return @key = value
-              break
-            end
-          end
-        end
-      end
-    end
-
-    private
-
-    def each_chunk(file, &block)
-      length = file.read(PNG_INFO_LENGTH).unpack('Na4').first
-      yield *file.read(length).unpack('Z*a*')
-      file.read(PNG_CRC_LENGTH)
-    end
-  end
-end

data/lib/spritely/options.rb

@@ -1,59 +0,0 @@
-require 'active_support/core_ext/hash/deep_merge'
-require 'active_support/core_ext/hash/except'
-require 'active_support/core_ext/hash/keys'
-require 'active_support/core_ext/hash/slice'
-
-module Spritely
-  # Provides a simpler method of querying a particular image's options. Rather
-  # than each `Image` needing to know how to parse the keyword arguments passed
-  # into the `spritely-map` function, this simplifies and de-duplicates the
-  # passed option keys.
-  #
-  #   $application-sprite: spritely-map("application/*.png",
-  #     $arrow-repeat: true,
-  #     $arrow-spacing: 10px,
-  #     $another-image-position: right,
-  #     $spacing: 5px
-  #   );
-  #
-  # The options passed in above will be easily accessible via an instance of
-  # this class.
-  #
-  #   options['arrow'] => {repeat: true, spacing: 10}
-  #   options['another-image'] => {position: 'right', spacing: 5}
-  class Options < Struct.new(:hash)
-    GLOBAL_OPTIONS = ['spacing', 'position']
-
-    def cache_key
-      stripped_hash.to_s
-    end
-
-    def inspect
-      "#<Spritely::Options global_options=#{global_options} options=#{options}>"
-    end
-
-    def [](key)
-      options[key.gsub('-', '_')] || global_options
-    end
-
-    private
-
-    def options
-      @options ||= stripped_hash.except(*GLOBAL_OPTIONS).inject({}) do |h, (key, value)|
-        image, _, option = key.rpartition('_')
-        h[image] ||= global_options.dup
-        h.deep_merge!(image => {option.to_sym => value})
-      end
-    end
-
-    def global_options
-      @global_options ||= stripped_hash.slice(*GLOBAL_OPTIONS).symbolize_keys!
-    end
-
-    def stripped_hash
-      @stripped_hash ||= hash.inject({}) do |h, (key, sass_object)|
-        h.merge!(key => sass_object.value)
-      end
-    end
-  end
-end