slim-grunt-helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66aac7b8f9dd3c5fe219e1be98ad6b3663020782
+  data.tar.gz: 8925791b026acd526ff6252f3300f9d218bc2b4e
+SHA512:
+  metadata.gz: 1554c2ce726454148dcef5cb19ee9456cd4d5eddf669fd68c9e7ce9b9f55a8a1d002f58e71085d18c54e756b91fc31671e45dbbbdc47b5e10212d837fe44bc69
+  data.tar.gz: f1f583ebf185b6335c4f1729e5ee9a3c098e819bd3ace0450b8d61c3d0a1a27d3d2cc69611f76e3b9a84723272b752dacba066e66815bebb22b074c8bf3e5d57

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Fire-Dragon-DoL
+
+MIT License
+
+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,74 @@
+# SlimGruntHelpers
+
+This gem injects a set of helpers in Ruby global namespace (or not, depending on
+how you require the gem) which will help you when setting up a pipeline with
+[Grunt](http://gruntjs.com/) and [Slim](https://github.com/slim-template/slim) template language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slim-grunt-helpers', '~> 0.0.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slim-grunt-helpers
+
+## Usage
+
+The easiest way is to just use bundler and so `Bundle.require(:default)`, which will inject code in
+global namespace (notice that in any case every method is prefixed with **sg_**).  
+Otherwise, if you don't want to pollute your global namespace you can change your Gemfile configuration into:
+
+```ruby
+gem 'slim-grunt-helpers', require: ['slim-grunt-helpers/helpers']
+```
+
+And you'll need to `include SlimGruntHelpers::Helpers` in some place to have methods available.
+
+## Available helpers
+
+Right now, only a few helpers are available, I'll add others in future.
+
+#### sg\_enclose\_newline
+
+Takes a `block` as an argument, just encloses the block in `\n#{ block }\n`
+
+#### sg\_usemin\_css / sg\_usemin\_js
+
+These two methods behave in the same way. The purpose is to use them with the very helpful
+[grunt-usemin](https://github.com/yeoman/grunt-usemin) plugin which however requires some new lines here and
+there which are boring to type directly in Slim. The usage is simple:
+
+```ruby
+== sg_usemin_css('application.css', alt: '.tmp') do |usemin|
+  - usemin << 'styles/bootstrap.css'
+  - usemin << 'styles/main.css', 'data-customattr' => 'customdata'
+```
+
+The first argument is required, and it's the `path` :
+
+```html
+<!-- build:<type>(alternate search path) <path> -->
+```
+
+The `:alt` argument is optional and it's the `alternate search path`.  
+An object `usemin` will be yielded to the block which has only one method: **&lt;&lt;**.  
+This method requires first argument which is path to your css file (http path) and the second argument is a
+hash of options which are appended as attributes to the link tag. Notice that on `link` tag,
+`rel="stylesheet"` is automatically appended (and can be overwritten by specifying a `rel` key in options).  
+Additionally, notice that attributes with `nil` or `false` as value are not set (so you can remove `rel`), while those with `true` are set but without value and without `=""`.
+
+## 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/Rakefile

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

data/lib/slim-grunt-helpers.rb

@@ -0,0 +1,7 @@
+require 'slim-grunt-helpers/version'
+require 'slim-grunt-helpers/helpers'
+
+module SlimGruntHelpers
+end
+
+include SlimGruntHelpers::Helpers

data/lib/slim-grunt-helpers/helpers.rb

@@ -0,0 +1,49 @@
+# Required so that if you include only the helpers file, version is still there
+require 'slim-grunt-helpers/version'
+require 'slim-grunt-helpers/models'
+
+module SlimGruntHelpers
+
+  module Helpers
+
+    def sg_enclose_newline
+      %Q{\n#{ yield }\n}
+    end
+
+    # Options:
+    # - `alt` which allows to set alternate paths which usemin should look into
+    def sg_usemin_css(path, options={})
+      usemin  = SlimGruntHelpers::Models::UseminCss.new
+      options = { alt: nil }.merge!(options)
+
+      alt = ''
+      alt = "(#{ options[:alt] })" unless options[:alt].nil?
+
+      text  = "\n<!-- build:css#{ alt } #{ path } -->\n"
+      yield(usemin)
+      usemin.each do |link|
+        text << "#{ link }\n"
+      end
+      text << "\n<!-- endbuild -->"
+    end
+
+    # Options:
+    # - `alt` which allows to set alternate paths which usemin should look into
+    def sg_usemin_js(path, options={})
+      usemin  = SlimGruntHelpers::Models::UseminJs.new
+      options = { alt: nil }.merge!(options)
+
+      alt = ''
+      alt = "(#{ options[:alt] })" unless options[:alt].nil?
+
+      text  = "\n<!-- build:js#{ alt } #{ path } -->\n"
+      yield(usemin)
+      usemin.each do |link|
+        text << "#{ link }\n"
+      end
+      text << "\n<!-- endbuild -->"
+    end
+    
+  end
+
+end

data/lib/slim-grunt-helpers/models.rb

@@ -0,0 +1,3 @@
+require 'slim-grunt-helpers/models/usemin'
+require 'slim-grunt-helpers/models/usemin_css'
+require 'slim-grunt-helpers/models/usemin_js'

data/lib/slim-grunt-helpers/models/usemin.rb

@@ -0,0 +1,35 @@
+module SlimGruntHelpers
+
+  module Models
+
+    class Usemin
+
+      BASE_OPTIONS = {}.freeze
+
+      def initialize
+        @links = []
+      end
+
+      def <<(path, options={})
+        @links << { path: path, options: base_options.merge(options) }
+      end
+
+      def each
+        @links.each { |link| yield(transform_link(link)) }
+      end
+
+      def base_options
+        BASE_OPTIONS
+      end
+
+      protected
+
+        def transform_link(link)
+          raise NotImplementedError, 'This method must be implemented in child classes'
+        end
+
+    end
+
+  end
+
+end

data/lib/slim-grunt-helpers/models/usemin_css.rb

@@ -0,0 +1,31 @@
+require 'slim-grunt-helpers/models/usemin'
+
+module SlimGruntHelpers
+
+  module Models
+
+    class UseminCss < Usemin
+
+      BASE_OPTIONS = { rel: 'stylesheet' }.freeze
+
+      protected
+
+        def transform_link(link)
+          text  = %Q{<link href="#{ link[:path] }"}
+          link[:options].each do |key, value|
+            if value == true
+              text << %Q{ #{ key }}
+            elsif value
+              text << %Q{ #{ key }="#{ value }"}
+            end
+          end
+          text << ' />'
+
+          text
+        end
+
+    end
+
+  end
+
+end

data/lib/slim-grunt-helpers/models/usemin_js.rb

@@ -0,0 +1,31 @@
+require 'slim-grunt-helpers/models/usemin'
+
+module SlimGruntHelpers
+
+  module Models
+
+    class UseminJs < Usemin
+
+      BASE_OPTIONS = {}.freeze
+
+      protected
+
+        def transform_link(link)
+          text  = %Q{<script src="#{ link[:path] }"}
+          link[:options].each do |key, value|
+            if value == true
+              text << %Q{ #{ key }}
+            elsif value
+              text << %Q{ #{ key }="#{ value }"}
+            end
+          end
+          text << '></script>'
+
+          text
+        end
+
+    end
+
+  end
+
+end

data/lib/slim-grunt-helpers/version.rb

@@ -0,0 +1,3 @@
+module SlimGruntHelpers
+  VERSION = "0.0.1"
+end

data/slim_grunt_helpers.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slim-grunt-helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slim-grunt-helpers"
+  spec.version       = SlimGruntHelpers::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = ["francesco.belladonna@gmail.com"]
+  spec.description   = %q{Small set of helpers that can be used in slim templates}
+  spec.summary       = %q{Small set of helpers that can be used in slim templates}
+  spec.homepage      = "https://github.com/Fire-Dragon-DoL/slim-grunt-helpers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: slim-grunt-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Small set of helpers that can be used in slim templates
+email:
+- francesco.belladonna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slim-grunt-helpers.rb
+- lib/slim-grunt-helpers/helpers.rb
+- lib/slim-grunt-helpers/models.rb
+- lib/slim-grunt-helpers/models/usemin.rb
+- lib/slim-grunt-helpers/models/usemin_css.rb
+- lib/slim-grunt-helpers/models/usemin_js.rb
+- lib/slim-grunt-helpers/version.rb
+- slim_grunt_helpers.gemspec
+homepage: https://github.com/Fire-Dragon-DoL/slim-grunt-helpers
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Small set of helpers that can be used in slim templates
+test_files: []