spritely 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a37a86c16713d282bc5d617faa6ce4bc2652d66c
-  data.tar.gz: 82a0dddc10e04adb99a4525d15c1ecbb4ae0ab6f
+  metadata.gz: b1afa4634c2ebe161a2557ad31168f308f4fd4de
+  data.tar.gz: 176498f2a2579987e8c8ac4c12cc960e1ceba4b5
 SHA512:
-  metadata.gz: ac584c201e6875fd894a8f568e3063e627f637de133d834d2d750e35db16c9532ba8c295623db08f1150629bbb6e96f6d40490daaa75fc4a0f602dcd44b510f8
-  data.tar.gz: a7a3991b7318105394797151922c890d31b7674bc328e5e33d4b840d24f11312f11bc1650696deb75cbcd21d7fa01def0c8e47ddb6d019166ee174efc01d9717
+  metadata.gz: 95d85bb25e1761b8223f6fc2bc2aeb50a9e3c8f7cb91e15842b5f767d7b8545fe330dfdec6f39b9919107d82b83ccae1eee973863f15a47dbad28f74aae8d78a
+  data.tar.gz: 6709371eaedb1db506fa2ab023f197e978e477f0017a1100e3f2337663b64c86c32e39250109cd3b91fedfce315259dd060b14c045202051f6245fc3cf70ecc5

data/lib/spritely.rb

@@ -1,38 +1,15 @@
-require 'sass'
-require 'sprockets/rails/version'
-require 'sprockets/railtie'
-require 'sprockets/version'
+require 'sprockets'
 require 'spritely/sass_functions'
-require 'spritely/sprockets/manifest'
-require 'spritely/adapters/sprockets_2'
-require 'spritely/adapters/sprockets_3'
+require 'spritely/sprockets/preprocessor'
+require 'spritely/sprockets/transformer'
 
-module Spritely
-  def self.environment
-    if sprockets_rails_version == 3
-      ::Rails.application.assets || ::Sprockets::Railtie.build_environment(::Rails.application)
-    else
-      ::Rails.application.assets
-    end
-  end
-
-  def self.directory
-    ::Rails.root.join(relative_folder_path)
-  end
-
-  def self.relative_folder_path
-    Pathname.new(File.join('app', 'assets', 'images', 'sprites'))
-  end
-
-  def self.sprockets_version
-    Gem::Version.new(::Sprockets::VERSION).segments.first
-  end
-
-  def self.sprockets_rails_version
-    Gem::Version.new(::Sprockets::Rails::VERSION).segments.first
-  end
+if defined?(::Rails::Engine)
+  require 'spritely/engine'
+end
 
-  def self.sprockets_adapter
-    Adapters.const_get("Sprockets#{sprockets_version}").new
-  end
+module Spritely
 end
+
+::Sprockets.register_mime_type 'text/sprite', extensions: ['.png.sprite']
+::Sprockets.register_preprocessor 'text/sprite', Spritely::Sprockets::Preprocessor.new(comments: ["//", ["/*", "*/"]])
+::Sprockets.register_transformer 'text/sprite', 'image/png', Spritely::Sprockets::Transformer

data/lib/spritely/collection.rb

@@ -21,6 +21,7 @@ module Spritely
     def cache_key
       files.collect { |file| Digest::MD5.file(file) }.join
     end
+    alias_method :to_s, :cache_key
 
     # Returns the width of the to-be-generated sprite image. When none of the
     # images repeat, it is simply the max width of all images in the sprite.
@@ -29,17 +30,13 @@ module Spritely
     # multiple is then multiplied by the minimum multiple that will result in a
     # value greater than or equal to the max width of all images in the sprite.
     def width
-      return @width if @width
-
-      max_width = image_sets.collect(&:width).max
-      if image_sets.none?(&:repeated?)
-        @width = max_width
+      @width ||= if image_sets.none?(&:repeated?)
+        max_width
       else
-        @width = lcm = image_sets.select(&:repeated?).collect(&:width).reduce(:lcm)
-        @width += lcm while @width < max_width
-      end
+        lcm = image_sets.select(&:repeated?).collect(&:width).reduce(:lcm)
 
-      @width
+        lcm * (max_width / lcm.to_f).ceil
+      end
     end
 
     def height
@@ -58,11 +55,15 @@ module Spritely
     private
 
     def image_sets
-      @image_sets ||= files.collect { |file| ImageSet.new(file, options[File.basename(file, ".png")]) }
+      @image_sets ||= files.collect { |file| ImageSet.new(file, options[:images][File.basename(file, ".png")] || options[:global]) }
+    end
+
+    def max_width
+      @max_width ||= image_sets.collect(&:width).max
     end
 
     def heights
-      image_sets.collect(&:outer_height)
+      @heights ||= image_sets.collect(&:outer_height)
     end
   end
 end

data/lib/spritely/engine.rb

@@ -0,0 +1,4 @@
+module Spritely
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/spritely/generators/base.rb

@@ -1,25 +1,9 @@
 module Spritely
   module Generators
     class Base < Struct.new(:sprite_map)
-      def self.create!(sprite_map)
-        new(sprite_map).tap do |generator|
-          generator.build!
-          generator.ensure_directory_exists!
-          generator.save!
-        end
-      end
-
-      def ensure_directory_exists!
-        raise("'#{Spritely.relative_folder_path}' doesn't exist. Run `rails generate spritely:install`.") unless File.exist?(Spritely.directory)
-      end
-
       def build!
         raise NotImplementedError, "#{self.class} must implement #build!"
       end
-
-      def save!
-        raise NotImplementedError, "#{self.class} must implement #save!"
-      end
     end
   end
 end

data/lib/spritely/generators/chunky_png.rb

@@ -9,11 +9,8 @@ module Spritely
           png = ::ChunkyPNG::Image.from_blob(image.data)
           canvas.replace!(png, image.left, image.top)
         end
-      end
 
-      def save!
-        canvas.metadata['cache_key'] = sprite_map.cache_key
-        canvas.save(sprite_map.filename, :fast_rgba)
+        canvas.to_blob(:fast_rgba)
       end
 
       private

data/lib/spritely/image_set.rb

@@ -28,11 +28,11 @@ module Spritely
     end
 
     def spacing
-      options[:spacing] || 0
+      options[:spacing].to_i
     end
 
     def repeated?
-      !!options[:repeat]
+      options[:repeat] == 'true'
     end
 
     def right?

data/lib/spritely/sass_functions.rb

@@ -1,28 +1,17 @@
-require 'spritely/sprite_map'
+require 'sass'
 
 module Spritely
   module SassFunctions
-    def spritely_map(glob, kwargs = {})
-      SpriteMap.create(glob.value, kwargs).tap do |sprite_map|
-        Spritely.sprockets_adapter.reset_cache!(sprockets_environment, sprite_map.filename)
-        sprockets_context.depend_on(Spritely.directory)
-        sprite_map.files.each do |file|
-          sprockets_context.depend_on(file)
-          sprockets_context.depend_on_asset(file)
-        end
-      end
-    end
-
-    ::Sass::Script::Functions.declare :spritely_map, [:glob], var_kwargs: true
+    def spritely_url(sprite_name)
+      sprockets_context.link_asset("sprites/#{sprite_name.value}.png")
 
-    def spritely_url(sprite_map)
-      asset_url(Sass::Script::String.new("sprites/#{sprite_map.name}.png"))
+      asset_url(Sass::Script::String.new("sprites/#{sprite_name.value}.png"))
     end
 
-    ::Sass::Script::Functions.declare :spritely_url, [:sprite_map]
+    ::Sass::Script::Functions.declare :spritely_url, [:sprite_name]
 
-    def spritely_position(sprite_map, image_name)
-      image = find_image(sprite_map, image_name)
+    def spritely_position(sprite_name, image_name)
+      image = find_image(sprite_name, image_name)
 
       x = Sass::Script::Number.new(-image.left, image.left == 0 ? [] : ['px'])
       y = Sass::Script::Number.new(-image.top, image.top == 0 ? [] : ['px'])
@@ -30,35 +19,47 @@ module Spritely
       Sass::Script::List.new([x, y], :space)
     end
 
-    ::Sass::Script::Functions.declare :spritely_position, [:sprite_map, :image_name]
+    ::Sass::Script::Functions.declare :spritely_position, [:sprite_name, :image_name]
 
-    def spritely_background(sprite_map, image_name)
-      Sass::Script::List.new([spritely_url(sprite_map), spritely_position(sprite_map, image_name)], :space)
+    def spritely_background(sprite_name, image_name)
+      Sass::Script::List.new([spritely_url(sprite_name), spritely_position(sprite_name, image_name)], :space)
     end
 
-    ::Sass::Script::Functions.declare :spritely_background, [:sprite_map, :image_name]
+    ::Sass::Script::Functions.declare :spritely_background, [:sprite_name, :image_name]
 
-    def spritely_width(sprite_map, image_name)
-      image = find_image(sprite_map, image_name)
+    def spritely_width(sprite_name, image_name)
+      image = find_image(sprite_name, image_name)
 
       Sass::Script::Number.new(image.width, ['px'])
     end
 
-    ::Sass::Script::Functions.declare :spritely_width, [:sprite_map, :image_name]
+    ::Sass::Script::Functions.declare :spritely_width, [:sprite_name, :image_name]
 
-    def spritely_height(sprite_map, image_name)
-      image = find_image(sprite_map, image_name)
+    def spritely_height(sprite_name, image_name)
+      image = find_image(sprite_name, image_name)
 
       Sass::Script::Number.new(image.height, ['px'])
     end
 
-    ::Sass::Script::Functions.declare :spritely_height, [:sprite_map, :image_name]
+    ::Sass::Script::Functions.declare :spritely_height, [:sprite_name, :image_name]
 
     private
 
-    def find_image(sprite_map, image_name)
+    def find_image(sprite_name, image_name)
+      sprockets_context.link_asset("sprites/#{sprite_name.value}.png")
+
+      sprite_map = sprite_maps.fetch(sprite_name.value) do |name|
+        asset = sprockets_environment.find_asset("sprites/#{name}.png.sprite") || raise(Sass::SyntaxError, "No sprite map '#{name}' found.")
+
+        sprite_maps[name] = SpriteMap.new(name, sprockets_environment, asset.metadata[:sprite_directives])
+      end
+
       sprite_map.find(image_name.value) || raise(Sass::SyntaxError, "No image '#{image_name.value}' found in sprite map '#{sprite_map.name}'.")
     end
+
+    def sprite_maps
+      @sprite_maps ||= {}
+    end
   end
 end
 

data/lib/spritely/sprite_map.rb

@@ -1,58 +1,41 @@
 require 'forwardable'
-require 'spritely/options'
-require 'spritely/cache'
+require 'digest/md5'
 require 'spritely/collection'
 require 'spritely/generators/chunky_png'
 
 module Spritely
-  class SpriteMap < Sass::Script::Literal
+  class SpriteMap
     extend Forwardable
 
     def_delegators :collection, :find, :width, :height, :images
 
-    attr_reader :glob, :options
+    attr_reader :name, :glob, :environment, :options
 
-    def self.create(*args)
-      new(*args).tap do |sprite_map|
-        sprite_map.generate! if sprite_map.needs_generation?
-      end
+    def initialize(name, environment, options)
+      @name = name
+      @glob = [name, "*.png"].join("/")
+      @environment = environment
+      @options = options
     end
 
-    def initialize(glob, options = {})
-      @glob = glob
-      @options = Options.new(options)
+    def inspect
+      "#<Spritely::SpriteMap name=#{name} options=#{options}>"
     end
 
     def cache_key
-      @cache_key ||= Cache.generate(options, collection)
-    end
-
-    def inspect
-      "#<Spritely::SpriteMap name=#{name} options=#{options}>"
+      @cache_key ||= Digest::MD5.hexdigest([options, collection].join)
     end
 
     def collection
       @collection ||= Collection.create(files, options)
     end
 
-    def generate!
-      Generators::ChunkyPng.create!(self)
-    end
-
-    def name
-      glob.split('/')[0..-2].join('-')
-    end
-
-    def filename
-      Spritely.directory.join("#{name}.png")
-    end
-
-    def needs_generation?
-      !File.exist?(filename) || Cache.busted?(filename, cache_key)
+    def save!
+      Generators::ChunkyPng.new(self).build!
     end
 
     def files
-      Spritely.environment.paths.flat_map { |path| Dir.glob(File.join(path, glob)) }.sort
+      environment.paths.flat_map { |path| Dir.glob(File.join(path, glob)) }.sort
     end
   end
 end

data/lib/spritely/sprockets/preprocessor.rb

@@ -0,0 +1,65 @@
+require 'sprockets/directive_processor'
+
+module Spritely
+  module Sprockets
+    # Converts Sprockets directives from this:
+    #
+    #   //= repeat arrow true
+    #   //= spacing arrow 10
+    #   //= position another-image right
+    #   //= spacing 5
+    #
+    # To this:
+    #
+    #   {
+    #     global: { spacing: 5 },
+    #     images: {
+    #       'arrow' => { repeat: 'true', spacing: '10' },
+    #       'another-image' => { position: 'right', spacing: '5' }
+    #     }
+    #   }
+    class Preprocessor < ::Sprockets::DirectiveProcessor
+      GLOBAL_DIRECTIVES = %w(position spacing).freeze
+      IMAGE_DIRECTIVES = %w(repeat position spacing).freeze
+
+      def _call(input)
+        @sprite_directives = { global: {}, images: {} }
+
+        super.tap do
+          merge_global_options!
+
+          input[:metadata][:sprite_directives] = @sprite_directives
+        end
+      end
+
+      (GLOBAL_DIRECTIVES + IMAGE_DIRECTIVES).uniq.each do |directive|
+        define_method("process_#{directive}_directive") do |image_or_value, value_or_nil = nil|
+          if value_or_nil
+            process_image_option(directive, image_or_value, value_or_nil)
+          else
+            process_global_option(directive, image_or_value)
+          end
+        end
+      end
+
+      private
+
+      def process_image_option(directive, image, value)
+        @sprite_directives[:images][image] ||= {}
+        @sprite_directives[:images][image][directive.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
+      end
+
+      def merge_global_options!
+        @sprite_directives[:images].each do |image, options|
+          options.merge!(@sprite_directives[:global]) { |key, left, right| left }
+        end
+      end
+    end
+  end
+end

data/lib/spritely/sprockets/transformer.rb

@@ -0,0 +1,43 @@
+require 'spritely/version'
+require 'spritely/sprite_map'
+
+module Spritely
+  module Sprockets
+    class Transformer < Struct.new(:input)
+      def self.call(input)
+        new(input).call
+      end
+
+      def self.cache_key
+        @cache_key ||= "#{name}:#{Spritely::VERSION}".freeze
+      end
+
+      def call
+        data = cache.fetch([self.class.cache_key, input[:name], sprite_map.cache_key]) do
+          sprite_map.files.each do |file|
+            context.depend_on(File.dirname(file))
+            context.link_asset(file)
+          end
+
+          sprite_map.save!
+        end
+
+        context.metadata.merge(data: data)
+      end
+
+      private
+
+      def context
+        @context ||= input[:environment].context_class.new(input)
+      end
+
+      def cache
+        @cache ||= input[:cache]
+      end
+
+      def sprite_map
+        @sprite_map ||= SpriteMap.new(input[:name].remove("sprites/"), input[:environment], input[:metadata][:sprite_directives])
+      end
+    end
+  end
+end