sassy-export 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24ade834a2b95503916be110a53a1216938b4ee0
+  data.tar.gz: a0853c9d487d1bcad0dada0a174332497e6a04ed
+SHA512:
+  metadata.gz: 5eacbc52086517f95edfe3250ba085e0caf00ecb281f6bc25b5190b22224009ee16283e4742d3b5f1e4f0a968f4bce278a8a6b26b08a23d5ed8d2072e745dfec
+  data.tar.gz: 3044db63bf3479a0e44dfc4bbb2d42a2d5b47b046790487bffaecb194351660dae3f7264b2f1cfa4de1a48d087210ed9416eae8f2e60ab346bcc769868e012a9

data/README.md

@@ -0,0 +1,67 @@
+# Sassy Export [![Gem Version](https://badge.fury.io/rb/sassy-export.svg)](http://badge.fury.io/rb/sassy-export)
+
+Sassy Export is a lightweight Sass extension that allows you to export an encoded Sass map into an external JSON file. Use it anyway you like.
+
+## Installation
+
+1. `gem install sassy-export`
+2. Add `require "sassy-export"` to your `config.rb`
+3. Import into your stylesheet with `@import "sassy-export";`
+
+## Documentation
+
+#### Setup
+
+Our file structure,
+```
+root
+├── sass
+│   ├── style.scss
+├── json
+└── config.rb
+```
+
+Sass,
+```scss
+// sass/style.scss
+
+@import "sassy-export";
+
+$map: (
+	hello: world,
+);
+
+///
+/// Convert passed map to json and write to <path>/<filename>.<ext>
+///
+/// @param {String} $path    - Directory path and filename
+/// @param {Map}    $map     - Map to convert to json
+/// @param {Bool}   $pretty  - Pretty print json
+/// @param {Bool}   $debug   - Print debug string with path
+/// @param {Bool}   $use_env - Use ENV["PWD"] for current directory instead of Dir.pwd
+///
+/// @return {String} - Write file to path
+///
+@include sassy-export("json/test.json", $map, true, true, false);
+```
+
+#### Result
+
+New JSON file is created at `json/hello.json` (`$path` is relative to where your `config.rb` is located). Simply calling `@include sassy-export("hello.json", $map)` will write to your working directory.
+```json
+{
+	"hello": "world"
+}
+```
+
+#### Breakdown
+
+The `sassy-export()` mixin takes a `\<directory\>/\<filename\>.\<ext\>` `$path` and a Sass `$map` as arguments. You can export straight to a JavaScript object by using the extension `.js` instead of `.json` for the output `$path`.
+
+There are also optional arguments: `$pretty` which defaults to `false`, but will print pretty JSON (nicely indented) if set to `true`; and `$debug` which will print debug information if set to `true`.
+
+It converts the `$map` into either a JSON map or Javascript object through Ruby, then creates a new directory/file (or updates an existing directory/file), and writes the contents of the JSON string to it.
+
+Contributions are welcome. If you believe that you could improve the small amount of code here, feel free to.
+
+Enjoy.

data/lib/sassy-export/exporter.rb

@@ -0,0 +1,155 @@
+module SassyExport
+  module Exporter
+    BLACK   = "\e[30m"
+    RED     = "\e[31m"
+    GREEN   = "\e[32m"
+    YELLOW  = "\e[33m"
+    BLUE    = "\e[34m"
+    MAGENTA = "\e[35m"
+    CYAN    = "\e[36m"
+    WHITE   = "\e[37m"
+
+    def self.declare(*args)
+      Sass::Script::Functions.declare *args
+    end
+
+    def export(path, map, pretty, debug, use_env)
+      assert_type path, :String, :path
+      assert_type map, :Map, :map
+      assert_type pretty, :Bool, :pretty
+      assert_type debug, :Bool, :debug
+      assert_type use_env, :Bool, :use_env
+
+      pretty  = pretty.to_bool
+      debug   = debug.to_bool
+      use_env = use_env.to_bool
+      path    = unquote(path).to_s
+      root    = use_env ? ENV["PWD"] : Dir.pwd
+      dir     = Pathname.new(root) + path
+      file    = File.basename dir, ".*"
+      ext     = File.extname path
+      message = "#{javascript?(ext) ? "JS" : "JSON"} to #{path}"
+      map     = Sass::Script::Value::Map.new map.value
+      hash    = map_to_h map
+
+      output = if pretty
+        JSON.pretty_generate hash
+      else
+        JSON.generate hash
+      end
+
+      if javascript? ext
+        output = "var #{file} = #{output}"
+      end
+
+      if debug
+        log :debug, %Q{
+file: #{dir}
+map: #{map.inspect}
+hash: #{hash}
+output: #{output}
+}, :blue
+      end
+
+      write_dir Sass::Util.pathname(dir)
+
+      if write_file dir, output
+        log :export, message
+      else
+        message = "could not export #{message}"
+        log :error, message, :red
+      end
+
+      Sass::Script::Value::String.new "exported #{message}"
+    end
+    declare :export, [:path, :map, :pretty, :debug, :use_env]
+
+    private
+
+    def log(action, message, color = :green)
+      puts %Q(#{self.class.const_get(color.to_s.upcase)} #{action.to_s.rjust(8)}\e[0m #{message})
+    end
+
+    def javascript?(ext)
+      ext == ".js"
+    end
+
+    def write_file(path, output)
+      flag = Sass::Util.windows? ? "wb" : "w"
+      begin
+        File.open "#{path}", flag do |file|
+          file.set_encoding output.encoding unless Sass::Util.ruby1_8?
+          file.print output
+        end
+        true
+      rescue
+        false
+      end
+    end
+
+    def write_dir(path)
+      dir = File.dirname path
+
+      unless File.exists?(dir)
+        FileUtils.mkdir_p dir
+        log :create, dir, :yellow
+      end
+    end
+
+    def strip_quotes(value)
+      if value.is_a?(String) || value.is_a?(Sass::Script::Value::String)
+        unquote(value)
+      else
+        value
+      end
+    end
+
+    def list_to_a(array)
+      if array.is_a?(Array)
+        array.map do |l|
+          case l
+          when Sass::Script::Value::Map
+            l = map_to_h(l)
+          when Sass::Script::Value::List
+            l = list_to_a(l)
+          when Sass::Script::Value::Bool
+            l = l.to_bool
+          when Sass::Script::Value::Number
+            l = l.unitless? ? l.value : strip_quotes(l)
+          when Sass::Script::Value::Color
+            l = l.inspect
+          else
+            l = strip_quotes(l)
+          end
+          l
+        end
+      else
+        list_to_a(array.to_a)
+      end
+    end
+
+    def map_to_h(hash)
+      if hash.is_a?(Hash)
+        hash.inject({}) do |h, (k, v)|
+          case v
+          when Sass::Script::Value::Map
+            h[strip_quotes(k)] = map_to_h(v)
+          when Sass::Script::Value::List
+            h[strip_quotes(k)] = list_to_a(v)
+          when Sass::Script::Value::Bool
+            h[strip_quotes(k)] = v.to_bool
+          when Sass::Script::Value::Number
+            h[strip_quotes(k)] = v.unitless? ? v.value : strip_quotes(v)
+          when Sass::Script::Value::Color
+            h[strip_quotes(k)] = v.inspect
+          else
+            h[strip_quotes(k)] = strip_quotes(v)
+          end
+          h
+        end
+      else
+        map_to_h(hash.to_h)
+      end
+    end
+  end
+end

data/lib/sassy-export/version.rb

@@ -0,0 +1,3 @@
+module SassyExport
+  VERSION = "2.0.0"
+end

data/lib/sassy_export.rb

@@ -0,0 +1,20 @@
+require "sass"
+require "json"
+
+require_relative "sassy-export/version"
+require_relative "sassy-export/exporter"
+
+base_directory = File.expand_path File.join(File.dirname(__FILE__), "..")
+sassy_export_stylesheets_path = File.join base_directory, "stylesheets"
+
+if (defined? Compass)
+  Compass::Frameworks.register "sassy-export",
+    :path => base_directory
+else
+  ENV["SASS_PATH"] = [ENV["SASS_PATH"], sassy_export_stylesheets_path]
+    .compact.join File::PATH_SEPARATOR
+end
+
+module SassyExport
+  Sass::Script::Functions.send :include, SassyExport::Exporter
+end

data/stylesheets/_sassy-export.sass

@@ -0,0 +1,18 @@
+///
+/// Convert passed map to json and write to <path>/<filename>.<ext>
+///
+/// @param {String} $path    - Directory path and filename
+/// @param {Map}    $map     - Map to convert to json
+/// @param {Bool}   $pretty  - Pretty print json
+/// @param {Bool}   $debug   - Print debug string with path
+/// @param {Bool}   $use_env - Use ENV["PWD"] for current directory instead of Dir.pwd
+///
+/// @return {String} - Write file to path
+///
+@mixin sassy-export($path, $map, $pretty: false, $debug: false, $use_env: false)
+  @at-root
+    @if $debug
+      /*! #{export($path, $map, $pretty, $debug, $use_env)} */
+    @else
+      %sassy-export
+        /*! #{export($path, $map, $pretty, $debug, $use_env)} */

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sassy-export
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Ezekiel Gabrielse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Sassy Export is a lightweight Sass extension that allows you to export
+  an encoded Sass map into an external JSON file.
+email:
+- ezekg@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sassy-export/exporter.rb
+- lib/sassy-export/version.rb
+- lib/sassy_export.rb
+- stylesheets/_sassy-export.sass
+homepage: https://github.com/ezekg/sassy-export/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- stylesheets
+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: Sassy Export allows you to export a Sass map into an external JSON file.
+test_files: []