tinge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3e3a1dbcb9e3a4b6bd326da7909c3150902f40f
+  data.tar.gz: 3bf57f7b92c8dd2db1a7fbfe19b0fb63574ec94e
+SHA512:
+  metadata.gz: 4bc966be5b8d77f9eb35d5c3de5b5bbf6311e35089a8ebc4aced94abab6aa8ced2329acb4413c8382408a25f9551a4bad431f526cd465bc81abf3566fb0d8eed
+  data.tar.gz: e0a0526a3f1aa00bf862c0dfe596950b58d6dd029d8c2919f9c761f790321d75becad2f208a96e393d46e91ec561daf42a66c1c1acae3cb428df8ef2a79a1a6e

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 tinge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+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,68 @@
+# Tinge
+
+Extract color information from CSS/SCSS files (for various formats).
+
+## Usage
+
+You can see usage information by running `tinge help`.
+
+Currently the only available operation is extracting color variable
+assignments from SCSS files and outputting them to various formats:
+
+ * ASE (Adobe Swatch Exchange)
+ * SCSS (but with all variable assignments and functions resolved)
+ * JSON
+ * Ruby
+ * YAML
+
+This command is executed as `tinge vars`, although since it's the
+default, `vars` can be omitted (as is in the examples below):
+
+As an example, using this simple SCSS file:
+
+```
+$ cat colors.scss
+$white: white;
+$gray: darken($white, 85%);
+$orange: #fab444;
+```
+
+We can get the final (resolved) SCSS:
+
+```
+$ tinge colors.scss
+$gray: #262626;
+$orange: #fab444;
+$white: #ffffff;
+```
+
+Convert it to a JSON object suitable for use in JavaScript:
+
+```
+$ tinge -f json colors.scss
+{"white":"#ffffff","gray":"#262626","orange":"#fab444"}
+```
+
+Output it as YAML (and note `tinge` accepts stdin, too):
+
+```
+$ cat colors.scss | tinge -f yml
+---
+gray: "#262626"
+orange: "#fab444"
+white: "#ffffff"
+```
+
+We can also create an ASE file (note `--output`/`-o` is required):
+
+```
+$ tinge -f ase colors.scss -o colors.ase
+```
+
+## Contributing
+
+1. Fork it: http://github.com/bruce/tinge/fork
+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/bin/tinge

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require "tinge"
+
+Tinge::CLI.start(ARGV)

data/lib/tinge.rb

@@ -0,0 +1,15 @@
+require "thor"
+require "sass"
+
+require "tinge/version"
+
+module Tinge
+  autoload :CLI,        "tinge/cli"
+  autoload :Color,      "tinge/color"
+  autoload :Formatters, "tinge/formatters"
+  autoload :Parser,     "tinge/parser"
+  autoload :Reporters,  "tinge/reporters"
+  autoload :Sighting,   "tinge/sighting"
+end
+
+require "tinge/ext/sass"

data/lib/tinge/cli.rb

@@ -0,0 +1,35 @@
+require "pp"
+
+module Tinge
+
+  class CLI < Thor
+
+    default_command :vars
+
+    method_option :format,   aliases: %w(-f), default: 'scss', enum: Formatters.valid
+    method_option :output,   aliases: %w(-o), description: "Output to filename"
+
+    desc "vars [FILENAME, ...]", "Find and resolve color variable assignments in SCSS"
+    def vars(*filenames)
+      result = Parser.parse(read(filenames))
+      formatter = Formatters.find(options[:format])
+      if formatter.require_filename? && !options[:output]
+        abort "Must provide an output filename for format #{options[:format]}"
+      end
+      reporter  = Reporters.find(:variables)
+      formatter.new(reporter.new(result, formatter), options[:output]).render
+    end
+
+    private
+
+    def read(filenames = [])
+      if filenames.any?
+        filenames.map { |f| File.read(f) }.join("\n")
+      else
+        STDIN.read
+      end
+    end
+
+  end
+
+end

data/lib/tinge/color.rb

@@ -0,0 +1,19 @@
+module Tinge
+
+  class Color
+
+    def initialize(text)
+      @text = text
+    end
+
+    def add_sighting(node, parent = nil)
+      sightings << Sighting.new(self, node, parent)
+    end
+
+    def sightings
+      @sightings ||= []
+    end
+
+  end
+
+end

data/lib/tinge/ext/sass.rb

@@ -0,0 +1,29 @@
+module Sass
+  module Tree
+    class VariableNode < Node
+      def self.visit_method
+        :visit_and_save_variable
+      end
+    end
+    module Visitors
+      class Perform < Base
+
+        class << self
+          attr_accessor :tinge_parser
+        end
+
+        def visit_and_save_variable(node)
+          var = @environment.var(node.name)
+          return [] if node.guarded && var && !var.null?
+          val = node.expr.perform(@environment)
+          @environment.set_var(node.name, val)
+          if self.class.tinge_parser
+            self.class.tinge_parser.set_var(node.name, val)
+          end
+          []
+        end
+      end
+    end
+  end
+
+end

data/lib/tinge/formatters.rb

@@ -0,0 +1,34 @@
+module Tinge
+  module Formatters
+
+    class MissingFormatterError < RuntimeError; end
+
+    def self.find(format)
+      formatter = formatters[format.to_sym]
+      if formatter
+        formatter
+      else
+        raise MissingFormatterError, format.to_s
+      end
+    end
+
+    def self.valid
+      formatters.keys.map(&:to_s)
+    end
+
+    def self.add(format, formatter)
+      formatters[format.to_sym] = formatter
+    end
+
+    def self.formatters
+      @formatters ||= {}
+    end
+
+    require "tinge/formatters/formatter"
+    require "tinge/formatters/ase_formatter"
+    require "tinge/formatters/json_formatter"
+    require "tinge/formatters/ruby_formatter"
+    require "tinge/formatters/scss_formatter"
+    require "tinge/formatters/yaml_formatter"
+  end
+end

data/lib/tinge/formatters/ase_formatter.rb

@@ -0,0 +1,39 @@
+module Tinge
+  module Formatters
+
+    class ASEFormatter < Formatter
+
+      handles :ase
+
+      dependency 'ase'
+
+      def self.stringify_colors?
+        false
+      end
+
+      def self.require_filename?
+        true
+      end
+
+      def render
+        doc = ASE.new
+
+        palette = ASE::Palette.new("Colors")
+        @reporter.data.each do |name, color|
+          palette.add name, ase_color(color)
+        end
+        doc << palette
+        doc.to_file(@filename)
+      end
+
+      private
+
+      # Note: Alpha is not supported
+      def ase_color(color)
+        ASE::Color::RGB.new(color.red, color.green, color.blue)
+      end
+
+    end
+
+  end
+end

data/lib/tinge/formatters/formatter.rb

@@ -0,0 +1,56 @@
+module Tinge
+  module Formatters
+
+    class Formatter
+
+      def self.handles(*formats)
+        formats.each do |format|
+          Formatters.add(format, self)
+        end
+      end
+
+      def self.dependency(name, filename = name)
+        dependencies[name] = filename
+      end
+
+      def self.dependencies
+        @dependencies ||= {}
+      end
+
+      def self.stringify_colors?
+        true
+      end
+
+      def self.require_filename?
+        false
+      end
+
+      def initialize(reporter, filename = nil)
+        require_dependencies
+        @reporter = reporter
+        @filename = filename
+      end
+
+      private
+
+      def output(text)
+        if @filename
+          File.open(@filename, 'w') { |f| f.write text }
+        else
+          puts text
+        end
+      end
+
+      def require_dependencies
+        self.class.dependencies.each do |name, filename|
+          begin
+            require filename
+          rescue LoadError
+            raise LoadError, "Please install '#{name}' for this format"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/tinge/formatters/json_formatter.rb

@@ -0,0 +1,17 @@
+module Tinge
+  module Formatters
+
+    class JSONFormatter < Formatter
+
+      handles :json
+
+      dependency 'multi_json'
+
+      def render
+        output MultiJson.dump(@reporter.data)
+      end
+
+    end
+
+  end
+end

data/lib/tinge/formatters/ruby_formatter.rb

@@ -0,0 +1,15 @@
+module Tinge
+  module Formatters
+
+    class RubyFormatter < Formatter
+
+      handles :ruby
+
+      def render
+        output @reporter.data.inspect
+      end
+
+    end
+
+  end
+end

data/lib/tinge/formatters/scss_formatter.rb

@@ -0,0 +1,19 @@
+module Tinge
+  module Formatters
+
+    class ScssFormatter < Formatter
+
+      handles :scss
+
+      def render
+        lines = []
+        @reporter.data.sort.each do |name, value|
+          lines << "$#{name}: #{value};"
+        end
+        output lines.join("\n")
+      end
+
+    end
+
+  end
+end

data/lib/tinge/formatters/yaml_formatter.rb

@@ -0,0 +1,17 @@
+module Tinge
+  module Formatters
+
+    class YamlFormatter < Formatter
+
+      handles :yaml, :yml
+
+      dependency 'yaml'
+
+      def render
+        output YAML.dump(Hash[@reporter.data.sort])
+      end
+
+    end
+
+  end
+end

data/lib/tinge/parser.rb

@@ -0,0 +1,78 @@
+module Tinge
+
+  class Parser
+
+    class Result < Hash
+
+      def vars
+        @vars ||= {}
+      end
+
+    end
+
+    def self.parse(text)
+      new(text).tap { |parser|
+        parser.run
+      }.result
+    end
+
+    def initialize(text)
+      @text = text
+    end
+
+    def set_var(name, value)
+      result.vars[name] = value
+    end
+
+    def document
+      parse_document unless @document
+      @document
+    end
+
+    def parse_document
+      Sass::Tree::Visitors::Perform.tinge_parser = self
+      @engine = Sass::Engine.new(@text, syntax: :scss)
+      @document = @engine.to_tree
+      @engine.render
+    end
+
+    def run
+      visit(document)
+    end
+
+    def result
+      @result ||= Result.new
+    end
+
+    def visit(node, parent = nil)
+      if node.is_a?(Sass::Tree::PropNode) || node.is_a?(Sass::Tree::VariableNode)
+        extract(node, parent)
+      end
+      node.each do |child|
+        visit(child, node) unless child == node
+      end
+    end
+
+    def extract(node, parent = nil)
+      colors(node).each do |color|
+        result[color] ||= Color.new(color)
+        result[color].add_sighting(node, parent)
+      end
+    end
+
+    def colors(node)
+      case node
+      when Sass::Tree::PropNode
+        node.value.inspect.scan(/(#[0-9a-f]+|(?:hsl|rgb)a?\([^\)]+\))/).flatten
+      when Sass::Tree::VariableNode
+        if node.expr.is_a?(Sass::Script::Color)
+          [node.expr.to_s]
+        else
+          []
+        end
+      end
+    end
+
+  end
+
+end

data/lib/tinge/reporters.rb

@@ -0,0 +1,30 @@
+module Tinge
+  module Reporters
+
+    class MissingReporterError < RuntimeError; end
+
+    def self.find(style)
+      reporter = reporters[style.to_sym]
+      if reporter
+        reporter
+      else
+        raise MissingReporterError, style.to_s
+      end
+    end
+
+    def self.valid
+      reporters.keys.map(&:to_s)
+    end
+
+    def self.add(style, reporter)
+      reporters[style.to_sym] = reporter
+    end
+
+    def self.reporters
+      @reporters ||= {}
+    end
+
+    require "tinge/reporters/reporter"
+    require "tinge/reporters/variables_reporter"
+  end
+end

data/lib/tinge/reporters/reporter.rb

@@ -0,0 +1,17 @@
+module Tinge
+  module Reporters
+
+    class Reporter
+
+      def self.handles(format)
+        Reporters.add(format, self)
+      end
+
+      def initialize(result, formatter)
+        @result = result
+        @formatter = formatter
+      end
+
+    end
+  end
+end

data/lib/tinge/reporters/variables_reporter.rb

@@ -0,0 +1,27 @@
+module Tinge
+  module Reporters
+
+    class VariablesReporter < Reporter
+
+      handles :variables
+
+      def data
+        @data ||= generate_data
+      end
+
+      private
+
+      def generate_data
+        if @formatter.stringify_colors?
+          @result.vars.each_with_object({}) { |(k, v), obj|
+            obj[k] = v.inspect # Sass::Script::Color#inspect
+          }
+        else
+          @result.vars
+        end
+      end
+
+    end
+
+  end
+end

data/lib/tinge/sighting.rb

@@ -0,0 +1,14 @@
+module Tinge
+
+  class Sighting
+
+    attr_reader :color, :node, :parent
+    def initialize(color, node, parent = nil)
+      @color  = color
+      @node   = node
+      @parent = parent
+    end
+
+  end
+
+end

data/lib/tinge/version.rb

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

data/tinge.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tinge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tinge"
+  spec.version       = Tinge::VERSION
+  spec.authors       = ["Bruce Williams", "Lynn Wallenstein"]
+  spec.email         = ["brwcodes@gmail.com"]
+  spec.summary       = %q{Extract color information into various formats from CSS/SCSS files.}
+  spec.homepage      = "http://github.com/bruce/tinge"
+  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_dependency "thor"
+  spec.add_dependency "sass", "~> 3.3.0.rc.2"
+  spec.add_dependency "ase"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: tinge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruce Williams
+- Lynn Wallenstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: 3.3.0.rc.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0.rc.2
+- !ruby/object:Gem::Dependency
+  name: ase
+  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: multi_json
+  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: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 
+email:
+- brwcodes@gmail.com
+executables:
+- tinge
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tinge
+- lib/tinge.rb
+- lib/tinge/cli.rb
+- lib/tinge/color.rb
+- lib/tinge/ext/sass.rb
+- lib/tinge/formatters.rb
+- lib/tinge/formatters/ase_formatter.rb
+- lib/tinge/formatters/formatter.rb
+- lib/tinge/formatters/json_formatter.rb
+- lib/tinge/formatters/ruby_formatter.rb
+- lib/tinge/formatters/scss_formatter.rb
+- lib/tinge/formatters/yaml_formatter.rb
+- lib/tinge/parser.rb
+- lib/tinge/reporters.rb
+- lib/tinge/reporters/reporter.rb
+- lib/tinge/reporters/variables_reporter.rb
+- lib/tinge/sighting.rb
+- lib/tinge/version.rb
+- tinge.gemspec
+homepage: http://github.com/bruce/tinge
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Extract color information into various formats from CSS/SCSS files.
+test_files: []