dynamic-sprites 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e66fb4237da83f5be891b1d055a33a7db84ed1e
+  data.tar.gz: accd4811e105cffdd89760e68b256fbd1e2e192c
+SHA512:
+  metadata.gz: 6578afb03c296b402be255ce957df3fe68efe74e8bcd8a7e624279b6df5e69aef27fdaf28d549da7b12c15e16b5e257c530b591422c768f11083055e0fad32a0
+  data.tar.gz: 4bf1e72083d3b38223cc21b0877ff85c6d8dce45bf6809dd9a5d510817d4d3acd576c359f6aff14e556d9717fb5efe210496a5cdf0625831de4c86a19d1209a4

data/bin/dynamic-sprites

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.push File.expand_path("../lib", File.dirname(__FILE__)) # add sprite factory library to load path
+
+require 'dynamic-sprites'
+require 'optparse'
+
+options   = { layout: 'vertical', selector: 'img.sprite' }
+op        = OptionParser.new
+op.banner = <<-eos
+#{DynamicSprites::DESCRIPTION}
+
+Usage: dynamic-sprites <command> [PATH] [options]
+
+Available commands:
+    init:     generates sass mixin, you can pass your own path as an option
+    generate: generates sprite, you must enter relative or absolute path to source images
+
+eos
+
+op.on("-h", "--help") do
+  puts op.to_s
+  exit!
+end
+
+op.on("-v", "--version") do
+  puts DynamicSprites::VERSION
+  exit!
+end
+
+layout_help       = "specify layout orientation   ( horizontal, vertical, packed )"
+selector_help     = "specify custom selector to use ( default: 'img.sprite' )"
+output_help       = "specify output location for generated image ( default: <sources folder>.png )"
+
+op.on("--layout       [ORIENTATION]", layout_help)       {|value| options[:layout]       = value }
+op.on("--selector     [SELECTOR]",    selector_help)     {|value| options[:selector]     = value }
+op.on("--output       [PATH]",        output_help)       {|value| options[:output]       = value }
+op.on("--layout       [ORIENTATION]", layout_help)       {|value| options[:layout]       = value }
+
+begin
+  op.parse!(ARGV)
+  command = ARGV[0]
+  path = ARGV[1]
+  if command.nil?
+    raise "You must pass command (init, generate)\nUsage: dynamic-sprites <command> [PATH] [options]"
+  elsif command == 'generate' and path.nil?
+    raise "Generate command requires path to source images\nUsage: dynamic-sprites generate <PATH> [options]"
+  end
+  ARGV.clear
+  DynamicSprites.run!(command, path, options)
+rescue Exception => ex
+  puts ex.message
+  exit!
+end

data/dynamic-sprites.sass

@@ -0,0 +1,42 @@
+// Generates sass code for responsive sprites.
+//
+// sprite_url  - String containing url to sprite image.
+// images - Collection of strings, which represents images from sprites, each of them will generate separate class. Order must be preserved as in sprite
+// image_height - Percentage height of image within sprite, (100% / ($number_of_images - 1))
+// width - Element width
+// padding_bottom - Padding bottom replaces height in its functionality.
+//
+// Examples
+//
+//   .social img
+//     dynamic-sprite('/images/social.png', ('facebook', 'linkedin'))
+//
+// Returns sass for element and it's subclasses, for each image in sprite respectively.
+@mixin dynamic-sprite($sprite_url, $images: (), $image_height : 100%, $width: 100%, $padding_bottom: 100%)
+  padding-bottom: $padding_bottom
+  width: $width
+  height: 0
+  background-repeat: no-repeat
+  background-image: url($sprite_url)
+  background-size: 100%
+
+  @for $i from 1 through length($images)
+    $image: nth($images, $i)
+
+    &.#{$image}
+      background-position: 0 $image_height * ($i - 1)
+
+// Generates sass code for horizontal responsive sprites, everything works similar to vertical version.
+@mixin dynamic-sprite-horizontal($sprite_url, $images: (), $image_width : 100%, $width: 100%, $padding_bottom: 100%)
+  padding-bottom: $padding_bottom
+  width: $width
+  height: 0
+  background-repeat: no-repeat
+  background-image: url($sprite_url)
+  background-size: 100% * length($images)
+
+  @for $i from 1 through length($images)
+    $image: nth($images, $i)
+
+    &.#{$image}
+      background-position: $image_width * ($i - 1) 0

data/lib/dynamic-sprites.rb

@@ -0,0 +1,31 @@
+module DynamicSprites
+
+  #----------------------------------------------------------------------------
+
+  VERSION     = "0.0.2"
+  SUMMARY     = "Dynamic sprites mixin in SASS with sprite generator"
+  DESCRIPTION = "Generates sass mixin and combines directory of images into one sprite"
+
+  require 'find'
+  require 'rmagick'
+
+  require_relative 'dynamic-sprites/runner'  # Controller of this module
+  require_relative 'dynamic-sprites/interface'  # User interaction methods
+  require_relative 'dynamic-sprites/generator'  # Sprite generator
+
+  # Initilizes Runner which controls all the magic stuff.
+  #
+  def self.run!(command, path, options = {})
+    Runner.new(command, path, options).run!
+  end
+
+  private
+
+  def self.gem_root
+    File.expand_path '../..', __FILE__
+  end
+
+  def self.mixin_source_path
+    File.join gem_root, 'dynamic-sprites.sass'
+  end
+end

data/lib/dynamic-sprites/generator.rb

@@ -0,0 +1,73 @@
+module DynamicSprites
+  # Generates sprites
+  class Generator
+
+    # Array of file extensions used for creating sprites.
+    #
+    VALID_EXTENSIONS = %w(.png .jpg .jpeg .gif .ico)
+
+    attr :filename
+    attr :layout
+    attr :files
+
+    # Initializer
+    #
+    # filename  - Pathname where generated file should be placed to.
+    # path - Pathname of directory containing source images.
+    # layout - sprite layout name as a String
+    #
+    def initialize(filename, path, layout)
+      @filename = filename
+      @layout = layout
+      @files = Dir.glob(File.join(path, '*')).select { |e| VALID_EXTENSIONS.include?(File.extname(e)) }
+    end
+
+    # Main method for sprites generation
+    #
+    def run!
+      create(filename, load(files), layout)
+    end
+
+    private
+
+    # Converts Array of Filenames into an Array of Magic::Image objects
+    #
+    def load(files)
+      files.map do |filename|
+        image = Magick::Image.read(filename)[0]
+        {
+          :image    => image,
+          :width    => image.columns,
+          :height   => image.rows
+        }
+      end
+    end
+
+    # Generates sprite
+    #
+    def create(filename, images, layout)
+      images_width = images.map{ |i| i[:width] }
+      images_height = images.map{ |i| i[:height] }
+      if layout == 'horizontal'
+        width = images_width.reduce(:+)
+        height = images_height.max
+      else
+        height = images_height.reduce(:+)
+        width = images_width.max
+      end
+      target = Magick::Image.new(width, height)
+      target.opacity = Magick::MaxRGB
+      offset_x = 0
+      offset_y = 0
+      images.each do |image|
+        target.composite!(image[:image], offset_x, offset_y, Magick::SrcOverCompositeOp)
+        if layout == 'horizontal'
+          offset_x += image[:width]
+        else
+          offset_y += image[:height]
+        end
+      end
+      target.write(filename)
+    end
+  end
+end

data/lib/dynamic-sprites/interface.rb

@@ -0,0 +1,64 @@
+module DynamicSprites
+  # User Interaction class
+  #
+  class Interface
+
+    def prompt_directory
+      puts "Where should sass mixin be placed? (e.g. '/home/User/project/app/assets/stylesheets')"
+      prompt
+    end
+
+    def choose_directory(directories)
+      puts "Found more than one possible sass directory. To which one you want to insert sass mixin?"
+      option_number = 1
+      directories.each do |directory|
+        puts "#{option_number}. #{directory}"
+        option_number += 1
+      end
+      puts "#{option_number}. Other"
+      choice = choose(option_number)
+      if choice == option_number
+        puts "Enter directory path: (e.g. '/home/User/project/app/assets/stylesheets')"
+        prompt
+      else
+        directories[choice.to_i - 1]
+      end
+    end
+
+    def generate_mixin_summary(path)
+      puts "Mixin generated in #{path}"
+    end
+
+    def generate_sprite_summary(path)
+      puts "Sprite generated in #{path}"
+    end
+
+    private
+
+    # Choose option by it's index
+    #
+    def choose(limit)
+      puts "Select an option (1-#{limit}):"
+      choice = gets.to_i
+      raise RangeError unless choice.between?(1, limit)
+      choice
+    rescue RangeError
+      puts "Choose correct option (e.g. 1):"
+      retry
+    end
+
+    # Prompt user for specific Pathname
+    #
+    def prompt
+      path = gets
+      raise FileNotFoundError unless File.exist?(path)
+      Pathname.new(path)
+    rescue FileNotFoundError
+      puts "This path does not exist, try again:"
+      retry
+    end
+  end
+end
+
+class FileNotFoundError < StandardError
+end

data/lib/dynamic-sprites/runner.rb

@@ -0,0 +1,76 @@
+module DynamicSprites
+  class Runner
+
+    attr :command
+    attr :path
+    attr :options
+    attr :interface
+
+    def initialize(command, path, options = {})
+      @interface = Interface.new
+      @command = command
+      @path = Pathname.new(path) unless path.nil?
+      @path ||= File.join(sass_directory, 'dynamic-sprites.sass') unless command.nil?
+      @options = options
+      @options[:output] ||= "#{@path}.png"
+    end
+
+    # Runs dynamic-sprites command.
+    #
+    def run!
+      case command
+      when 'init'
+        generate_mixin!
+      when 'generate'
+        generate_sprite!
+      end
+    end
+
+    private
+
+    # Generates mixin in provided path or initializes user interface to determine it otherwise.
+    #
+    def generate_mixin!
+      FileUtils.copy DynamicSprites.mixin_source_path, path
+      interface.generate_mixin_summary(path)
+    end
+
+    # Generates sprite using provided options.
+    #
+    def generate_sprite!
+      Generator.new(options[:output], path, options[:layout]).run!
+      interface.generate_sprite_summary(@options[:output])
+    end
+
+    # Chooses one of possible options of defining sass directory path.
+    #
+    def sass_directory
+      case sass_directories.size
+      when 0
+        interface.prompt_directory
+      when 1
+        sass_directories.first
+      else
+        interface.choose_directory(sass_directories)
+      end
+    end
+
+    # Returns an Array of possible paths to directories of project .sass files.
+    #
+    def sass_directories
+      style_directories = []
+
+      Find.find(Dir.pwd) do |path|
+        next unless FileTest.directory?(path)
+        if File.basename(path).match /sass|style/
+          style_directories << Pathname.new(path)
+        elsif File.basename(path)[0] == ?.
+          Find.prune
+        else
+          next
+        end
+      end
+      style_directories
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: dynamic-sprites
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Maciej Walusiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies: []
+description: Dynamic sprites mixin in SASS with sprite generator.
+email: rabsztok@gmail.com
+executables:
+- dynamic-sprites
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dynamic-sprites.rb
+- lib/dynamic-sprites/runner.rb
+- lib/dynamic-sprites/generator.rb
+- lib/dynamic-sprites/interface.rb
+- dynamic-sprites.sass
+- bin/dynamic-sprites
+homepage: https://github.com/Rabsztok/dynamic-sprites
+licenses:
+- GPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Dynamic sprites
+test_files: []
+has_rdoc: