css_sprites 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 420263174925e0ebdcc84dd97df633d5b7a184d1
+  data.tar.gz: 1fdd26c70c6fb297a03e412bb2874c4e0741a986
+SHA512:
+  metadata.gz: c8a7bb7a49fffea8ae5665ae2b6f43d0aa85f0fcc55ddcbdd06db8aac36038031e83bf8aaabdaad3f667fa42dffa806f5bde50c1141cd8bdfc30e89765328c1e
+  data.tar.gz: c3c33e11b0334b38702339daf50f312e63f4fcec54eaa11dac013c3e66c14f5ed2b46dc09d902c0592add6de6cae5ffe8496a6732e612c42d8421b08d24d283e

data/.gitignore

@@ -0,0 +1,37 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.idea
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sprites.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Angelika Tyborska
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# Sprites
+
+Sprites finds all png files in the input directory, merges them together into a single PNG file and generates a CSS stylesheet for the output image. 
+
+## Prerequisites
+
+**ImageMagick** Version 6.4.9 or later. You can get ImageMagick from [www.imagemagick.org](http://www.imagemagick.org).
+
+Or, if you're on Mac OS X and using Homebrew, you can install it by typing:
+
+```bash
+$ brew install imagemagick
+```
+
+And if you're using Ubuntu:
+
+```bash
+$ apt-get imagemagick
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'css_sprites'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself:
+```bash
+$ gem install css_sprites
+```
+
+## Usage
+
+In your Ruby app:
+
+```ruby
+require 'css_sprites'
+CSSSprites.generate_sprite(path_to_images, options_hash)
+```
+
+Or from the command line:
+
+```bash
+$ css_sprites path/to/images
+```
+
+### Options
+
+Option | Type | Default | Description
+------ | ---- | ------- | -----------
+:stacking | :horizontal or :vertical | :horizontal | How to order images in the sprite
+:output | string | input directory's parent's path | Where to save the generated files
+:name | string | input directory's name | A name for the generated files
+
+
+### Examples with options
+In your Ruby app:
+
+```ruby
+options = {
+    stacking: :vertical,
+    name: 'so_awesome',
+    output: 'my_awesome_icons_output'
+}
+CSSSprites.generate_sprite('my_awesome_icons', options)
+```
+
+From the command line:
+
+```bash
+$ css_sprites --stacking vertical --name so_awesome --output my_awesome_icons_output my_awesome_icons
+```
+
+For more details:
+
+```bash
+$ css_sprites --help
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/css_sprites

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'css_sprites'
+require 'css_sprites/cli'
+
+cli = CSSSprites::CLI.new(ARGV)
+cli.parse!

data/css_sprites.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'css_sprites/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "css_sprites"
+  spec.version       = CSSSprites::VERSION
+  spec.authors       = ["Angelika Tyborska"]
+  spec.email         = ["atyborska93@gmail.com"]
+  spec.summary       = %q{Merges many PNG images into a single image and generates a CSS stylesheet}
+  spec.homepage      = "https://github.com/angelikatyborska/css_sprites"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4.0"
+  spec.add_runtime_dependency "rmagick", "~> 2.15.4"
+end

data/lib/css_sprites/cli.rb

@@ -0,0 +1,78 @@
+require 'optparse'
+
+class CSSSprites::CLI
+  def initialize(args)
+    @args = args
+    @options = {}
+  end
+
+  def parse!
+    opts = OptionParser.new(&method(:set_options))
+    opts.parse!(@args)
+    path = ARGV[0]
+
+    if path
+      begin
+        output = CSSSprites.generate_sprite(path, @options)
+        $stdout.puts "Files saved to #{ output }"
+      rescue ArgumentError => error
+        $stdout.puts error.message
+      end
+    else
+      $stderr.puts opts.banner
+    end
+  end
+
+  private
+
+  def set_options(opts)
+    opts.banner = <<END
+Usage: sprites [options] input_dir
+
+Description:
+  Merges png files from the input directory into one png file and generates an adequate stylesheet.
+END
+
+    opts.on(
+      '-s',
+      '--stacking TYPE',
+      'Image stacking orientation. Can be horizontal (default) or vertical.'
+    ) do |stacking|
+      @options[:stacking] = stacking.to_sym || :horizontal
+    end
+
+    opts.on(
+      '-n',
+      '--name FILENAME',
+      'The name for the generated css and png files. Uses input directory name if no name given.'
+    ) do |name|
+      @options[:name] = name
+    end
+
+    opts.on(
+      '-o',
+      '--output PATH',
+      'The path to the directory to which generated files should be saved. Uses input directory\'s path if no path given.'
+    ) do |output|
+      @options[:output] = output
+    end
+
+    opts.on_tail(
+      '-h',
+      '--help',
+      'Show this message'
+    ) do
+      puts opts
+      exit
+    end
+
+    opts.on_tail(
+      '-v',
+      '--version',
+      'Show version'
+    ) do
+      puts "Sprites #{ CSSSprites::VERSION }"
+      exit
+    end
+  end
+end

data/lib/css_sprites/image_grid.rb

@@ -0,0 +1,88 @@
+class CSSSprites::ImageGrid
+  def initialize(images, options = {})
+    @images = images
+    @name = options.fetch(:name, 'untitled')
+    @stacking = options.fetch(:stacking, :horizontal)
+
+    arrange_images!
+  end
+
+  def total_width
+    row_widths = @grid.map.with_index { |row, index| image_x_offset(index, row.size) }
+    row_widths.max
+  end
+
+  def total_height
+    image_y_offset(total_rows)
+  end
+
+  def name
+    @name
+  end
+
+  def image_name(row, column)
+    File.basename(@grid[row][column][:filename], '.*')
+  end
+
+  def image_x_offset(row, column)
+    return 0 if column == 0 || @images.empty?
+
+    @grid[row][0..(column - 1)].inject(0) do |sum, image|
+      sum += image[:image].columns
+    end
+  end
+
+  def image_y_offset(row, column = 0)
+    return 0 if row == 0 || @images.empty?
+
+    row_heights = @grid[0..(row - 1)].map do |row|
+      row.map { |image| image[:image].rows }.max
+    end
+
+    row_heights.inject(0, :+)
+  end
+
+  def to_image
+    return nil if @images.empty?
+
+    image_grid = Magick::Image.new(total_width, total_height) { self.background_color = 'transparent' }
+
+    each_with_index do |image, n, k|
+      image_grid = image_grid.composite(image, image_x_offset(n, k), image_y_offset(n), Magick::OverCompositeOp)
+    end
+
+    image_grid
+  end
+
+  def each_with_index(&block)
+    @grid.each.with_index do |row, n|
+      row.each.with_index do |image, k|
+        block.call(image[:image], n, k)
+      end
+    end
+  end
+
+  private
+
+  def arrange_images!
+    @grid = [[]]
+
+    if @stacking == :horizontal
+      @images.each do |image|
+        @grid[0] << image
+      end
+    else
+      @images.each_with_index do |image, index|
+        @grid[index] = [image]
+      end
+    end
+
+    def total_rows
+      @grid.size
+    end
+
+    def total_columns
+      @grid.map { |row| row.size }.max
+    end
+  end
+end

data/lib/css_sprites/sprite.rb

@@ -0,0 +1,48 @@
+class CSSSprites::Sprite
+  def initialize(path, options = {})
+    validate_path(path)
+
+    options[:name] ||= File.basename(path)
+
+    @name = options[:name]
+    @images = load_images(path)
+
+    @image_grid = CSSSprites::ImageGrid.new(@images, options)
+    @stylesheet = CSSSprites::SpriteStylesheet.new(@image_grid)
+  end
+
+  def name
+    @name
+  end
+
+  def image
+    @image_grid.to_image
+  end
+
+  def stylesheet
+    @stylesheet.to_s
+  end
+
+  private
+
+  def validate_path(path)
+    fail ArgumentError, "Directory #{ path } does not exist" unless Dir.exists?(path)
+    fail ArgumentError, "You do not have reading permissions for directory #{ path }" unless File.readable?(path)
+  end
+
+  def load_images(path)
+    image_filenames = Dir.entries(path).select { |filename| filename =~ /.*\.png/ }
+
+    fail ArgumentError, "Directory #{ path } contains no png files" if image_filenames.empty?
+
+    image_filenames.each_with_object([]) do |filename, images|
+      filepath = "#{ path }/#{ filename }"
+      fail ArgumentError, "You do not have reading permissions for file #{ filename }" unless File.readable?(filepath)
+
+      images << {
+        filename: "#{filename}",
+        image: Magick::ImageList.new(filepath)
+      }
+    end
+  end
+end

data/lib/css_sprites/sprite_stylesheet.rb

@@ -0,0 +1,94 @@
+class CSSSprites::SpriteStylesheet
+  INDENT                 = '  '
+  INVALID_CSS_NAME_CHARS = /\W/
+
+  def initialize(image_grid)
+    @image_grid = image_grid
+  end
+
+  def to_s
+    style = ''
+
+    rule_blocks.each do |block|
+      style << "\n" unless rule_blocks[0] == block
+      style << "#{ block[:selector] } {\n"
+      style << "#{ declarations_to_s(block[:declarations]) }"
+      style << "}\n"
+    end
+
+    style
+  end
+
+  private
+
+  def rule_blocks
+    rules = [
+      {
+        selector: ".#{ base_class }",
+        declarations: base_declarations
+      }
+    ]
+
+    @image_grid.each_with_index do |image, row, column|
+      rules << {
+        selector: ".#{ base_class }.#{ image_class(row, column) }",
+        declarations: declarations_for_image(image, row, column)
+      }
+    end
+
+    rules
+  end
+
+  def declarations_to_s(declarations)
+    declarations_to_s = ''
+
+    declarations.each do |declaration|
+      declarations_to_s << "#{ INDENT }#{ declaration[:property] }: #{ declaration[:value] };\n"
+    end
+
+    declarations_to_s
+  end
+
+  def base_class
+    @image_grid.name.gsub(INVALID_CSS_NAME_CHARS, '-')
+  end
+
+  def image_class(row, column)
+    "#{ base_class }-#{ @image_grid.image_name(row, column).gsub(INVALID_CSS_NAME_CHARS, '-') }"
+  end
+
+  def base_declarations
+    [
+      {
+        property: 'display',
+        value: 'inline-block'
+      },
+      {
+        property: 'background',
+        value: "url('#{ base_class }.png') no-repeat"
+      }
+    ]
+  end
+
+  def declarations_for_image(image, row, column)
+    [
+      {
+        property: 'width',
+        value: "#{ with_px(image.columns) }"
+      },
+      {
+        property: 'height',
+        value: "#{ with_px(image.rows) }"
+      },
+      {
+        property: 'background-position',
+        value: "#{ with_px(-1 * @image_grid.image_x_offset(row, column)) } #{ with_px(-1 * @image_grid.image_y_offset(row)) }"
+      },
+    ]
+  end
+
+  def with_px(value)
+    unit = 'px' unless value == 0
+    "#{ value }#{ unit }"
+  end
+end

data/lib/css_sprites/version.rb

@@ -0,0 +1,3 @@
+module CSSSprites
+  VERSION = '0.1.0'
+end

data/lib/css_sprites.rb

@@ -0,0 +1,25 @@
+require 'css_sprites/version'
+require 'css_sprites/image_grid'
+require 'css_sprites/sprite_stylesheet'
+require 'css_sprites/sprite'
+require 'rmagick'
+
+module CSSSprites
+  # Generates a sprite from all PNG files in the directory specified by +path+.
+  # Saves a PNG file and a CSS file in the specified directory's parent directory.
+  # Returns the path to the directory to which those files were saved to.
+  def self.generate_sprite(path, options = {})
+    output_path = options[:output] || File.dirname(path)
+
+    fail ArgumentError, "Directory #{ output_path } does not exist" unless Dir.exists?(output_path)
+    fail ArgumentError, "You have no writing permissions for directory #{ output_path }" unless File.writable?(output_path)
+
+    sprite = Sprite.new(path, options)
+
+    output_file = "#{ output_path }/#{ sprite.name }"
+    sprite.image.write("#{ output_file }.png")
+    File.write("#{ output_file }.css", sprite.stylesheet)
+
+    File.realpath(output_path)
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: css_sprites
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Angelika Tyborska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+description: 
+email:
+- atyborska93@gmail.com
+executables:
+- css_sprites
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/css_sprites
+- css_sprites.gemspec
+- lib/css_sprites.rb
+- lib/css_sprites/cli.rb
+- lib/css_sprites/image_grid.rb
+- lib/css_sprites/sprite.rb
+- lib/css_sprites/sprite_stylesheet.rb
+- lib/css_sprites/version.rb
+homepage: https://github.com/angelikatyborska/css_sprites
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Merges many PNG images into a single image and generates a CSS stylesheet
+test_files: []