linner 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 621f08f92c5f1e07d56b8bdef6826837958e39a1
-  data.tar.gz: 3fa21218b588ab55d3bc9cd1f144b87663b20a2a
+  metadata.gz: f40ea1d47371f91db7d8a653f4b8e30b7e2748d4
+  data.tar.gz: 422e0dbbc14c7420296ae953b08a89ac2d1a88c4
 SHA512:
-  metadata.gz: 89898c38996e5c0fe23eec69eba7bb722232d1beef0200c95a93d89c9e2efa9ee59f180fcb7bd9403bd03b60dc139728468f40b32e25f3e26949432d54620c3c
-  data.tar.gz: 52183c4e3d0d9d16011490a59cc64863e1576532a1a71a7ecc9b07c7deec2909339257edebd9af0e79d8c42881d008eea0756e74d06f482c2dbeedc12660d8ec
+  metadata.gz: c9cbf841d6560337ced7e9fcd4577464e49e5aaa77ad1ba06c8911bbfabcb9afd05dcda48d372a5047dddeeb46a04289d577739a5924f2e9712624775bfc3041
+  data.tar.gz: b3f075eb30fb16b459d0ad0ec702cf7a2d8fbbfcc8f3e71a04faa3e23b1534a229660a2558bfe1e43ab0d5e13da71f2112916827f81d5a03487008645c3ac0db

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.6.0
+  - add sprites support
+
 v0.5.1
   - support handlebars partials. templates start with "_" will be treaded as partials/
 

data/README.md

@@ -16,7 +16,8 @@ Linner is a full-featured HTML5 application assembler.
 * Supports Modular Javascript, All your code will be wrapped by `cmd`.
 * Supports `concat` code by `config file` not `directive processor`.
 * Supports `copy` code from `src` to `dest`.
-* Supports `precompile` Javascript Templates from `src` to `desc`
+* Supports `precompile` Javascript Templates from `src` to `desc`.
+* Supports `sprite` PNG images from `src` to `desc`.
 * Supports Real-time `concat` by `$ linner watch`.
 * Supports `compress` by `$ linner build`.
 * Supports `LiveReload` with [LiveReload Chrome Extention](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei).

data/docs/config.md

@@ -53,6 +53,8 @@ the default configuration defines four groups: `scripts`, `styles`, `images` and
 
 `precompile` defines precompile strategy of javascript templates for Linner. The `Dir.glob` of `value` will be concat to `key`
 
+`sprite` defines sprite strategy of images for Linner. The `Dir.glob` of `value` will be sprite to `key`
+
 `order` defines the order of this group files, and It's very useful when you `concat` your files. for example:
 
 ```yaml
@@ -64,6 +66,22 @@ order:
 
 In the above example, if a group contains 5 files, `vendor/jquery-1.10.2.js` will be the first, and `vendor/underscore.js` will be the last file.
 
+## `sprites`
+
+`sprites` defines application sprite stategy. `sprites` support pseudo class of css, if your file's basename end with `_active`, the generated css will be `.active`. if your file's basename end with `_hover`, the generated css will be `:hover`, eg: `arrow_hover.png` will be `.selector-arrow:hover { ... }`
+
+Example:
+
+```yaml
+sprites:
+  # sprite image output path
+  path: "/images/"
+  # css selector
+  selector: ".icon-"
+  # css url background: url(/images/icon.png)
+  url: "http://s3.amazonaws.com/"
+```
+
 ## `modules`
 
 `modules` defines application module strategy, The default wrapper is `cmd`.

data/lib/linner.rb

@@ -5,6 +5,7 @@ require "linner/command"
 require "linner/asset"
 require "linner/cache"
 require "linner/helper"
+require "linner/sprite"
 require "linner/bundler"
 require "linner/reactor"
 require "linner/wrapper"
@@ -68,6 +69,7 @@ module Linner
   def perform(*asset)
     env.groups.each do |config|
       precompile(config) if config["precompile"]
+      sprite(config) if config["sprite"]
     end
     env.groups.each do |config|
       copy(config) if config["copy"]
@@ -106,6 +108,14 @@ module Linner
     end
   end
 
+  def sprite(config)
+    config["sprite"].each do |dest, pattern|
+      matches = Dir.glob(pattern).sort_by(&:downcase)
+      next if matches.select { |p| cache.miss? p }.empty?
+      paint_sprite(dest, matches)
+    end
+  end
+
   def revision
     dump_manifest
     [env.revision].flatten.each do |rev|
@@ -115,6 +125,27 @@ module Linner
     end
   end
 
+  def paint_sprite(dest, images)
+    images = images.map do |path|
+      ImageProxy.new(path, ChunkyPNG::Image.from_file(path))
+    end
+    sprite = Sprite.new(images).pack!
+    map = ChunkyPNG::Image.new(sprite.root[:w], sprite.root[:h], ChunkyPNG::Color::TRANSPARENT)
+
+    sprite.images.each do |image|
+      map.compose!(image.image, image.left, image.top)
+    end
+
+    name = File.basename(dest).sub(/[^.]+\z/, "png")
+    path = File.join(env.public_folder, env.sprites["path"], File.basename(dest).sub(/[^.]+\z/, "png"))
+    FileUtils.mkdir_p File.dirname(path)
+    map.save path
+
+    asset = Asset.new(File.join env.public_folder, dest)
+    asset.content = sprite.generate_style(env.sprites, name)
+    asset.write
+  end
+
   def write_template(dest, child_assets)
     asset = Asset.new(File.join env.public_folder, dest)
     content = child_assets.inject("") {|s, m| s << cache[m].content}

data/lib/linner/environment.rb

@@ -35,6 +35,10 @@ module Linner
       @env["bundles"] || []
     end
 
+    def sprites
+      @env["sprites"] || {}
+    end
+
     def modules_ignored
       Dir.glob(@env["modules"]["ignored"])
     end

data/lib/linner/sprite.rb

@@ -0,0 +1,124 @@
+module Linner
+  ImageProxy = Struct.new(:path, :image, :top, :left) do
+    def width
+      image.width
+    end
+
+    def height
+      image.height
+    end
+  end
+
+  class Sprite
+
+    attr_accessor :root, :images
+
+    def initialize(images)
+      @images = images.sort do |a, b|
+        diff = [b.width, b.height].max <=> [a.width, a.height].max
+        diff = [b.width, b.height].min <=> [a.width, a.height].min if diff.zero?
+        diff = b.height <=> a.height if diff.zero?
+        diff = b.width <=> a.width if diff.zero?
+        diff
+      end
+
+      @root = { :x => 0, :y => 0, :w => @images.first.width, :h => @images.first.height}
+    end
+
+    def pack!
+      @images.each do |image|
+        if block = find_block(@root, image)
+          place_image(block, image)
+          split_block(block, image)
+        else
+          @root = expand_root(@root, image)
+          redo
+        end
+      end
+      self
+    end
+
+    def generate_style(config, name)
+      selector = config["selector"] || ".icon-"
+      @images.inject("") do |style, image|
+        logical_path = Asset.new(image.path).logical_path
+        selector_with_pseudo_class = logical_path.chomp(File.extname(logical_path))
+          .gsub("/", "-")
+          .gsub("_active", ".active")
+          .gsub("_hover", ":hover")
+          .gsub("_", "-")
+        style <<
+"#{selector}#{selector_with_pseudo_class} {
+  width: #{image.width}px;
+  height: #{image.height}px;
+  background: url(#{File.join config['url'], name}) -#{image.left}px -#{image.top}px no-repeat;
+}
+"
+      end
+    end
+
+    private
+    def find_block(root, image)
+      if root[:used]
+        find_block(root[:right], image) || find_block(root[:down], image)
+      elsif (image.width <= root[:w]) && (image.height <= root[:h])
+        root
+      end
+    end
+
+    def place_image(block, image)
+      image.top = block[:y]
+      image.left = block[:x]
+    end
+
+    def split_block(block, image)
+      block[:used] = true
+      block[:down] = {:x => block[:x], :y => block[:y] + image.width, :w => block[:w], :h => block[:h] - image.height}
+      block[:right] = {:x => block[:x] + image.width, :y => block[:y], :w => block[:w] - image.width, :h => image.height}
+    end
+
+    def expand_root(root, image)
+      can_expand_down  = (image.width <= root[:w])
+      can_expand_right = (image.height <= root[:h])
+
+      should_expand_down  = can_expand_down  && (root[:w] >= (root[:h] + image.height))
+      should_expand_right = can_expand_right && (root[:h] >= (root[:w] + image.width))
+
+      if should_expand_right
+        expand_right(root, image.width)
+      elsif should_expand_down
+        expand_down(root, image.height)
+      elsif can_expand_right
+        expand_right(root, image.width)
+      elsif can_expand_down
+        expand_down(root, image.height)
+      else
+        raise RuntimeError, "Crashed!"
+      end
+    end
+
+    def expand_right(root, width)
+      Hash[
+        :used  => true,
+        :x     => 0,
+        :y     => 0,
+        :w     => root[:w] + width,
+        :h     => root[:h],
+        :down  => root,
+        :right => { :x => root[:w], :y => 0, :w => width, :h => root[:h] }
+      ]
+    end
+
+    def expand_down(root, height)
+      Hash[
+        :used  => true,
+        :x     => 0,
+        :y     => 0,
+        :w     => root[:w],
+        :h     => root[:h] + height,
+        :down  => { :x => 0, :y => root[:h], :w => root[:w], :h => height },
+        :right => root
+      ]
+    end
+  end # Sprite
+end # Linner

data/lib/linner/templates/app/styles/app.scss

@@ -0,0 +1 @@
+@import "icons";

data/lib/linner/templates/app/views/index.html

@@ -12,7 +12,7 @@
         <!--[if lt IE 7]>
             <p class="browsehappy">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</p>
         <![endif]-->
-
+        <div class="icon-logo"></div>
         <script src="/scripts/vendor.js"></script>
         <script src="/scripts/app.js"></script>
         <script src="/scripts/templates.js"></script>

data/lib/linner/templates/config.yml

@@ -2,38 +2,50 @@ paths:
   public: "public"
 groups:
   scripts:
+    paths:
+      - app/scripts
     concat:
       "/scripts/app.js": "app/**/*.{js,coffee}"
       "/scripts/vendor.js": "vendor/**/*.{js,coffee}"
     order:
-      - "vendor/jquery-1.10.2.js"
-      - "..."
-      - "app/scripts/app.coffee"
+      - vendor/jquery-1.10.2.js
+      - ...
+      - app/scripts/app.coffee
   styles:
+    paths:
+      - app/styles
     concat:
       "/styles/app.css": "app/styles/**/[a-z]*.{css,scss,sass}"
   images:
-    copy:
-      "/images/": "app/images/**/*.{png,gif}"
+    paths:
+      - app/images
+    sprite:
+      "../app/images/icons.scss": "app/images/**/*.png"
   views:
+    paths:
+      - app/views
     copy:
       "/": "app/views/**/*.html"
   templates:
     paths:
-      - "app/templates"
+      - app/templates
     precompile:
       "/scripts/templates.js": "app/templates/**/*.hbs"
 modules:
-  wrapper: "cmd"
-  ignored: "vendor/**/*"
-  definition: "/scripts/app.js"
-revision: "index.html"
+  wrapper: cmd
+  ignored: vendor/**/*
+  definition: /scripts/app.js
+sprites:
+  url: /images/
+  path: /images/
+  selector: .icon-
+revision: index.html
 notification: true
 bundles:
-  "jquery.js":
-    version: "1.10.2"
-    url: "http://code.jquery.com/jquery-1.10.2.js"
-  "handlebars.js":
-    version: "1.0.0"
-    url: "https://raw.github.com/wycats/handlebars.js/1.0.0/dist/handlebars.runtime.js"
+  jquery.js:
+    version: 1.10.2
+    url: http://code.jquery.com/jquery-1.10.2.js
+  handlebars.js:
+    version: 1.0.0
+    url: https://raw.github.com/wycats/handlebars.js/1.0.0/dist/handlebars.runtime.js
 

data/lib/linner/version.rb

@@ -1,3 +1,3 @@
 module Linner
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/linner/sprites_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Sprite do
+  before(:all) do
+    MockImage = Struct.new :width, :height, :top, :left
+    @sprites = Environment.new(root.join "config.yml").sprites
+    image0 = MockImage.new 2, 3
+    image1 = MockImage.new 5, 3
+    image2 = MockImage.new 6, 2
+    image3 = MockImage.new 2, 24
+    image4 = MockImage.new 1, 3
+    @images = [image0, image1, image2, image3, image4]
+  end
+
+  it "should be an empty hash" do
+    @sprites.should eql(Hash.new)
+  end
+
+  it "should be fit in blocks" do
+    sprites = Sprite.new(@images)
+    sprites.pack!
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linner
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Saito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reel
@@ -263,10 +263,12 @@ files:
 - lib/linner/helper.rb
 - lib/linner/notifier.rb
 - lib/linner/reactor.rb
+- lib/linner/sprite.rb
 - lib/linner/template.rb
 - lib/linner/templates/app/images/.gitkeep
+- lib/linner/templates/app/images/logo.png
 - lib/linner/templates/app/scripts/app.coffee
-- lib/linner/templates/app/styles/app.sass
+- lib/linner/templates/app/styles/app.scss
 - lib/linner/templates/app/templates/welcome.hbs
 - lib/linner/templates/app/views/index.html
 - lib/linner/templates/bin/server
@@ -283,6 +285,7 @@ files:
 - spec/linner/bundler_spec.rb
 - spec/linner/environment_spec.rb
 - spec/linner/helper_spec.rb
+- spec/linner/sprites_spec.rb
 - spec/linner/template_spec.rb
 - spec/linner/wrapper_spec.rb
 - spec/spec_helper.rb
@@ -309,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: HTML5 Application Assembler
@@ -320,7 +323,7 @@ test_files:
 - spec/linner/bundler_spec.rb
 - spec/linner/environment_spec.rb
 - spec/linner/helper_spec.rb
+- spec/linner/sprites_spec.rb
 - spec/linner/template_spec.rb
 - spec/linner/wrapper_spec.rb
 - spec/spec_helper.rb
-has_rdoc: