spriteful 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b4afd4331ff36f10f6b759ac9f0e4bcf896d9b0
-  data.tar.gz: fa28b01a1fc02c7d0760ad30009d560eeca3eefe
+  metadata.gz: f6cf5f6f9da3adc2537eedce271cdf44121395d5
+  data.tar.gz: 7986af3aacb58098b2ffd059631529f9d7446e71
 SHA512:
-  metadata.gz: 29d488e6bb8db434a4cde7806ef4fe8c70c68014a3b24c134434d45ca8e4621a4d9b68f9b639003d48841b7f6b21fdffb49149345fc499b3ca64c6ba1509f8a1
-  data.tar.gz: fc40aa9a782002afa88bdaaa056a9629219b21f160223a18622d71b9c8b4788687a862655a522c3ff112f70e39af1da1e512af287b76a593548b7d5960d6c81c
+  metadata.gz: 6e30d010efaa8b3167dfabf53f4aeba3e76fcab957b644418d7a70abc180b744dcd5c3d066b951925088c34d116889ea940d4fec9cf39dddafa11cf924127bf6
+  data.tar.gz: 056140c5247449b352b092d5fbfe57da6e2cfb8c27f5cbdd3d85ef42dc11f353d2dc17bc8fc5e0bebee0d606bdcdd199790072414ce2be24d776335091c000ad

data/README.md

@@ -55,6 +55,22 @@ spriteful images/icons -f scss
 }
 ```
 
+You can also choose to genete the code using
+[Mixin Directives](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#mixins).
+
+```bash
+spriteful images/icons -f scss --mixin
+# create  icons.png
+# copy    icons.scss
+```
+
+```scss
+// in your SCSS code...
+.button {
+  @include icons-sprite-new;
+}
+```
+
 ### Multiple sprites
 
 You can deal with multiple sprites in a single run. If `images/icons` has a set of images for one
@@ -100,6 +116,7 @@ you need to add a new source to an existing sprite.
 * `--destination` (`-d`) - Directory to save the generated image(s).
 * `--rails` (`-r`) - Forces rails specific settings, see [Spriteful and Rails](#spriteful-and-rails) for more info.
 * `--format` (`-f`) - Format to generate the sprite(s) stylesheet(s). Either "css" or "scss".
+* `--mixin` - Choose to use the Mixin Directives instead of Placeholder Selector.
 * `--horizontal` - Changes the sprite orientation to horizontal, since all sprites are combined vertically by default.
 * `--save` - Saves the provided arguments for later use.
 * `--spacing` - Add some spacing between the images in the sprite.

data/lib/spriteful/cli.rb

@@ -13,6 +13,7 @@ module Spriteful
     class_option :destination, aliases: '-d', banner: 'DESTINATION_DIR', type: :string, desc: 'Destination directory to save the combined image(s).', default: Dir.pwd
     class_option :root, aliases: '-r', banner: 'ROOT_DIR', type: :string, desc: 'Root folder from where your static files will be served.'
 
+    class_option :mixin, type: :boolean, desc: 'Choose to use the Mixin Directives instead of Placeholder Selectors.'
     class_option :rails, type: :boolean, desc: 'Follow default conventions for a Rails application with the Asset Pipeline.'
     class_option :horizontal, type: :boolean, desc: 'Change the sprite orientation to "horizontal".'
     class_option :save, type: :boolean, desc: 'Save the supplied arguments to ".spritefulrc".'
@@ -79,7 +80,8 @@ module Spriteful
       {
         root: options.root,
         format: options.format,
-        rails: options.rails?
+        rails: options.rails?,
+        mixin: options.mixin?
       }
     end
 

data/lib/spriteful/stylesheet.rb

@@ -20,6 +20,7 @@ module Spriteful
     # destination   - the directory where the Stylesheet will be created.
     # options       - additional Hash of options.
     #                 :format - the Stylesheet format.
+    #                 :mixin  - Use mixins instead of Placeholder selector in the SCSS format.
     #                 :rails  - A flag to generate Asset Pipeline compatible Stylesheets.
     def initialize(sprite, destination, options = {})
       @sprite = sprite
@@ -29,7 +30,8 @@ module Spriteful
         @root = Pathname.new(File.expand_path(options[:root]))
       end
       @format = options[:format]
-      @rails = options.fetch(:rails) { false }
+      @mixin = options.fetch(:mixin, false)
+      @rails = options.fetch(:rails, false)
 
       @path = @destination.join(name)
     end
@@ -55,11 +57,26 @@ module Spriteful
 
     protected
 
-    # Internal: returns the 'rails ' flag.
+    # Internal: returns the 'rails' flag.
     def rails?
       @rails
     end
 
+    # Internal: returns the 'mixin' flag.
+    def mixin?
+      @mixin
+    end
+
+    # Internal: select the extension prefix for the SCSS selector.
+    def extension_prefix
+      mixin? ? '@mixin ' : '%'
+    end
+
+    # Internal: select the extension strategy for the SCSS selector.
+    def extension_strategy
+      mixin? ? '@include ' : '@extend %'
+    end
+
     # Internal: defines the file extension to be used with
     # Rails applications, since we need to account for the ERB
     # preprocessing of plain CSS files.

data/lib/spriteful/stylesheets/template.scss.erb

@@ -1,15 +1,20 @@
 // ============================================================================
 // This Stylesheet was generated by the 'spriteful' gem.
+<%- if mixin? -%>
+// Below there are several [Mixin Directives]
+// (http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#mixins)
+<%- else -%>
 // Below there are several [Placeholder Selectors]
 // (http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#placeholder_selectors_)
+<%- end -%>
 // to use the '<%= sprite.name %>' sprite on your SCSS code, as in:
 //
 // .my-thing {
-//   @extend %<%= class_name_for(sprite) %>-sprite-<%= class_name_for(sprite.images.first) %>;
+//   <%= extension_strategy %><%= class_name_for(sprite) %>-sprite-<%= class_name_for(sprite.images.first) %>;
 //   // Your styles here.
 // }
 
-%<%= class_name_for(sprite) %>-sprite {
+<%= extension_prefix %><%= class_name_for(sprite) %>-sprite {
   <%- if rails? -%>
   background-image: image-url('<%= image_url(sprite) %>');
   <%- else -%>
@@ -18,8 +23,8 @@
   background-repeat: no-repeat;
 }
 <% sprite.each_image do |image| %>
-%<%= class_name_for(sprite) %>-sprite-<%= class_name_for(image) %> {
-  @extend %<%= class_name_for(sprite) %>-sprite;
+<%= extension_prefix %><%= class_name_for(sprite) %>-sprite-<%= class_name_for(image) %> {
+  <%= extension_strategy %><%= class_name_for(sprite) %>-sprite;
   background-position: <%= image.left %>px <%= image.top %>px;
 }
 <% end %>

data/spec/sprite_spec.rb

@@ -92,12 +92,26 @@ describe Spriteful::Sprite do
       expect(red.left).to eq(0)
     end
 
+    it 'accounts the spacing option when setting the "left" attribute of each image on a horizontal sprite' do
+      sprite = Spriteful::Sprite.new(source, destination, spacing: 10, horizontal: true)
+      blue, red = sprite.images.to_a
+
+      expect(blue.top).to eq(0)
+      expect(blue.left).to eq(0)
+
+      expect(red.top).to eq(0)
+      expect(red.left).to eq(-20)
+    end
+
     it 'accounts the spacing option when setting the "top" attribute of each image' do
       sprite = Spriteful::Sprite.new(source, destination, spacing: 10)
       blue, red = sprite.images.to_a
 
       expect(blue.top).to eq(0)
+      expect(blue.left).to eq(0)
+
       expect(red.top).to eq(-20)
+      expect(red.left).to eq(0)
     end
   end
 end

data/spec/stylesheet_spec.rb

@@ -24,5 +24,16 @@ describe Spriteful::Stylesheet do
       expect(output).to match(/%simple-sprite-blue \{/)
       expect(output).to match(/%simple-sprite-red \{/)
     end
+
+    it 'renders the SCSS format using mixin' do
+      sprite = Spriteful::Sprite.new(source, destination)
+      stylesheet = Spriteful::Stylesheet.new(sprite, destination, format: 'scss', mixin: true)
+      output = stylesheet.render
+
+      expect(output).to match(/@mixin simple-sprite \{/)
+      expect(output).to match(/@mixin simple-sprite-blue \{/)
+      expect(output).to match(/@include simple-sprite;/)
+      expect(output).to match(/@mixin simple-sprite-red \{/)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spriteful
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-28 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor