compass-ls 0.0.0

data/README.md

@@ -0,0 +1,135 @@
+# compass-ls
+
+A [Compass](http://compass-style.org/) plugin for listing the content of a 
+directory.
+
+## Installation
+
+```bash
+gem install compass-ls
+```
+
+To load the plugin, simply require it at the top of your configuration file:
+
+```ruby
+require 'compass-ls'
+```
+
+Next, import the `_compass-ls.scss` partial into your stylesheets:
+
+```sass
+@import 'compass-ls';
+```
+
+## Function
+
+```sass
+@function x-ls($files, $suffix: true) { 
+    @return ...
+}
+```
+
+### Parameters
+
+#### $files
+
+Type: `String`
+
+The file or glob pattern to match against.
+
+#### $suffix
+
+Type: `Boolean`  
+Default: `true`
+
+Lets you specify whether or not the file extension should be omitted from the 
+returning list items.
+
+### Return
+
+Type: `List`
+
+A comma separated list of file/folder names matching the file pattern.
+
+## Example usage
+
+Given the following folder structure:
+
+```
+.
+├── src
+│   ├── img
+│   │   ├── edit.svg
+│   │   ├── forward.png
+│   │   ├── minus.svg
+│   │   ├── move.png
+│   │   └── plus.svg
+│   └── scss
+└── config.rb
+```
+
+### Example 1: default, sans extension
+
+```sass
+$icons: x-ls('src/img/*');
+$png-icons: x-ls('src/img/*.png');
+$svg-icons: x-ls('src/img/*.svg');
+
+@debug($icons); // edit, forward, minus, move, plus
+@debug($png-icons); // forward, move
+@debug($svg-icons); // edit, minus, plus
+```
+
+### Example 2: with extension
+
+```sass
+$icons: x-ls('src/img/*', false);
+$png-icons: x-ls('src/img/*.png', false);
+$svg-icons: x-ls('src/img/*.svg', false);
+
+@debug($icons); // edit.svg, forward.png, minus.svg, move.png, plus.svg
+@debug($png-icons); // forward.png, move.png
+@debug($svg-icons); // edit.svg, minus.svg, plus.svg
+```
+
+### Example 3: single file
+
+```sass
+$icon: x-ls('src/img/edit.svg');
+
+@debug($icon); // edit
+```
+
+### Example 4: inline svg data-uri
+
+```sass
+$icons: x-ls('src/img/*.svg', false);
+
+@each $icon in $icons {
+    $icon-name: x-ls('src/img/#{$icon}');
+    .#{$icon-name} {
+        background-image: inline-image('#{$icon}');
+    }
+}
+```
+
+### Example 5: using the compass-config plugin
+
+Instead of hardcoding the images path we can use
+[compass-config](https://github.com/stevenbenisek/compass-config) to fetch the 
+`images_path` property from the [Compass configuration](http://compass-style.org/help/tutorials/configuration-reference/#configuration-properties).
+
+```sass
+$images-path: x-config('images_path');
+$icons: x-ls('#{$images-path}/*');
+
+@debug($icons); // edit, forward, minus, move, plus
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/compass-ls.rb

@@ -0,0 +1,19 @@
+# List required gems
+require "compass"
+
+# Register extension and provide location
+extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Compass::Frameworks.register("compass-ls", :path => extension_path)
+
+# Custom SassScript
+module Sass::Script::Functions
+    def x_compass_ls(files, suffix)
+        files = files.value
+        suffix = suffix.value
+        suffix = suffix ? '.*' : ''
+        return Sass::Script::List.new(
+            Dir.glob(files).map! { |x| Sass::Script::String.new(File.basename(x, suffix)) },
+            :comma
+        )
+    end
+end

data/stylesheets/_compass-ls.scss

@@ -0,0 +1,7 @@
+// @param {string} $files
+// @param {boolean} [$suffix]
+// @return {list}
+// @api public
+@function x-ls($files, $suffix: true) {
+    @return x_compass_ls($files, $suffix);
+}

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: compass-ls
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Steven Benisek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+description: A Compass plugin for listing the content of a directory
+email:
+- steven.benisek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/compass-ls.rb
+- stylesheets/_compass-ls.scss
+homepage: https://github.com/stevenbenisek/compass-ls
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A Compass plugin for listing the content of a directory
+test_files: []