sassy-escape 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODg4ZjMzZjljMzNjYjI4YzhhZjEyMDU2OWE2NmYwMzI1OWI2MjYzYw==
+  data.tar.gz: !binary |-
+    YTg0M2EyZGFlZTM1ODE0M2JmMzQyYTgzMzBiYjUyYzBmNGVlODY1Mg==
+SHA512:
+  metadata.gz: !binary |-
+    YzI3YWRkNTgwNzEwN2UwNWJkOWVhYTVlNjdlNTJlNWI1YTMyM2M3MDk4Mjc0
+    ZTYwYmExZDBhMGZmYzg2ZTcyNDg4ZGNiZGE2NzA0OTY4NjJhNjNjYWIyZWI3
+    NjQ2YTNjOTUxZDA5NmYyMjQ4M2NiODA1MzY1NzZiOTk1ODM1NzQ=
+  data.tar.gz: !binary |-
+    NmJjOWNlNWM3YmM3NTExZWM0NDJiZjMzZjFkMzY3NmYxN2RhMTY4YTU4MzQ5
+    MTE4YTQzMDc2NzkzMjI1Y2RjOGMzNzBmNTg4MjVhNDg4OGI2MjkzMTVjODRj
+    MmRmZmIwNDkyOTc1NjJhM2E2YzRlZDRhMTRiZTZkZjExZDNjMjY=

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+Sassy Escape [![Build Status](https://travis-ci.org/borodean/sassy-escape.svg?branch=develop)](https://travis-ci.org/borodean/sassy-escape)
+============
+
+A Sass wrapper for [cssesc,](http://github.com/mathiasbynens/cssesc) a JavaScript library [for escaping text for use in CSS strings or identifiers.](http://mathiasbynens.be/notes/css-escapes)
+
+`escape($value, $options...)`
+-----------------------------------
+
+This function takes a value and returns an escaped version of the value where any characters that are not printable ASCII symbols are escaped using the shortest possible (but valid) [escape sequences for use in CSS strings or identifiers.](http://mathiasbynens.be/notes/css-escapes)
+
+```scss
+body::after {
+  content: escape('Ich ♥ Bücher');
+}
+
+// Becomes this:
+body::after {
+  content: 'Ich \2665  B\FC cher';
+}
+```
+
+By default, `escape` returns a string that can be used as part of a CSS string. If the target is a CSS identifier rather than a CSS string, use the `$is-identifier: true` setting.
+
+```scss
+.#{ unquote(escape('123a2b', $is-identifier: true)) } {
+  color: red;
+}
+
+// Becomes this:
+.\31 23ab {
+  color: red;
+}
+```
+
+The optional keyword arguments accept the exact options which JavaScript version [cssesc uses](http://github.com/mathiasbynens/cssesc#api) only converted to the `dasherized-case`:
+
+```scss
+body::after {
+  content: escape('123a2b', $escape-everything: true, $quotes: 'single', $wrap: true);
+}
+```
+
+Installation
+------------
+
+```bash
+gem install sassy-escape
+```
+
+Use with Sass command line
+--------------------------
+
+```bash
+sass -r sassy-escape --watch sass_dir:css_dir
+```
+
+Use with Compass
+----------------
+
+Add the following to your Compass configuration:
+
+```ruby
+require 'sass-escape'
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sassy-escape.rb

@@ -0,0 +1,26 @@
+require "sass"
+require "sassy-escape/version"
+
+module Sass::Script::Functions
+  # Return a string containing the escaped version of the provided data for
+  # use as a CSS identifier
+  def escape(data, options = {})
+    require "cssesc"
+    if data.instance_of? Sass::Script::String
+      string = data.value.to_s
+      type = data.type
+    else
+      string = data.to_s
+      type = :identifier
+    end
+    options.each_pair { |k, v| options[k] = v.value }
+    escaped_string = CSSEsc.escape(string, options)
+    Sass::Script::String.new(escaped_string, type)
+  end
+
+  Sass::Script::Functions.declare :escape, [:data], var_kwargs: true
+end
+
+module SassyEscape
+  VERSION = '0.1.0'
+end

data/lib/sassy-escape/version.rb

@@ -0,0 +1,3 @@
+module SassyEscape
+  VERSION = '1.0.0'
+end

data/sassy-escape.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sassy-escape/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sassy-escape"
+  spec.version       = SassyEscape::VERSION
+  spec.authors       = ["Vadim Borodean"]
+  spec.email         = ["borodean@gmail.com"]
+
+  spec.summary       = "Sass wrapper for a JavaScript library for escaping CSS strings and identifiers"
+  spec.homepage      = "http://github.com/borodean/sassy-escape"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cssesc"
+  spec.add_dependency "sass"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "therubyracer"
+end

data/spec/sassy_escape_spec.rb

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+require "sass"
+require "sassy-escape"
+
+describe Sass::Script::Functions do
+
+  def sass(value)
+    Sass::Script::Parser.parse(value, 0, 0).perform(Sass::Environment.new).to_s
+  end
+
+  describe "#escape" do
+
+    it "escapes strings" do
+      expect(sass(%q{escape('Ich ♥ Bücher')}))
+        .to eq(%q{"Ich \\\\2665  B\\\\FC cher"})
+    end
+
+    it "preverves identifiers" do
+      expect(sass("escape(foo)"))
+        .to eq("foo")
+    end
+
+    it "accepts options" do
+      expect(sass(%q{escape('lolwat"foo\'bar', $escape-everything: true)}))
+        .to eq(%q{"\\\\6C\\\\6F\\\\6C\\\\77\\\\61\\\\74\\\\\\"\\\\66\\\\6F\\\\6F\\\\'\\\\62\\\\61\\\\72"})
+    end
+
+    it "accepts falsy options" do
+      expect(sass(%q{escape('lolwat"foo\'bar', $escape-everything: false)}))
+        .to eq(%q{"lolwat\"foo\\\\'bar"})
+    end
+
+    it "escape numbers" do
+      expect(sass("escape(10px, $is-identifier: true)"))
+        .to eq("\\31 0px")
+    end
+
+    it "properly unquotes" do
+      expect(sass("unquote(escape('+1', $is-identifier: true))"))
+        .to eq("\\+1")
+    end
+
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: sassy-escape
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vadim Borodean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cssesc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  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: 
+email:
+- borodean@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/sassy-escape.rb
+- lib/sassy-escape/version.rb
+- sassy-escape.gemspec
+- spec/sassy_escape_spec.rb
+homepage: http://github.com/borodean/sassy-escape
+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: Sass wrapper for a JavaScript library for escaping CSS strings and identifiers
+test_files:
+- spec/sassy_escape_spec.rb