sass-color-extractor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ae7876428c5d2897a0c21f5b1f37cf6d38f3490
+  data.tar.gz: 97f934a0f414ee53a57147b7f0991ef9a6b9bbfd
+SHA512:
+  metadata.gz: 4171c3fa02c80048691c2f78eca6fae93a2e38cbdfdb723efd7c5bcda22a7794a05dbb4139a3fd2ae0f8996183ff7d1f47e2c8ba1701ffe857b35f8d47a41865
+  data.tar.gz: cbfce2cc399e3c1fee7bb9164f281a1b6de4e370918d660dfcb28234cc08db06d9991b494c02209cec5865f83ae992e6936335c58d323cbde336a16a8dcfc990

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~
+\.\#*
+.sass-cache

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Mr Rogers
+
+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,62 @@
+# SassColorExtractor
+
+This dirt simple Gem uses the Sass ruby library to read your `colors.scss` file and give you back
+a list of color names and their actual colors which can be used to generate a nice color palette page in a
+Rails app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sass_color_extractor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sass_color_extractor
+
+## Usage
+
+You should extract your color variables into their own file (which you would then `@import` as necessary
+in your scss/sass files.  Once you have that, you can get a map of color names to their hex color like so:
+
+
+```
+
+scss_file = "/path/to/my/colors.scss"
+pp SassColorExtractor.parse_colors(scss_file)
+
+```
+
+For a more concrete example, given this `colors.scss` file
+
+```
+/* My Colors File */
+$black: #000;
+$white: #ffffff;
+$light_gray: darken($white, 20%);
+$dark_gray: lighten($black, 20%);
+```
+
+You'd get a hash in ruby like this:
+```
+{
+  "black"=>"000",
+  "white"=>"ffffff",
+  "light_gray"=>"cccccc",
+  "dark_gray"=>"333333"
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rcode5/sass_color_extractor/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 a new Pull Request

data/Rakefile

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

data/lib/sass_color_extractor.rb

@@ -0,0 +1,5 @@
+require "sass_color_extractor/version"
+require "sass_color_extractor/variable_evaluator"
+require "sass_color_extractor/base"
+module SassColorExtractor
+end

data/lib/sass_color_extractor/base.rb

@@ -0,0 +1,20 @@
+module SassColorExtractor
+  class Base
+    DEFAULT_SYNTAX = :scss
+
+    def self.parse_colors(sass_file)
+      syntax = guess_syntax(sass_file)
+      engine = Sass::Engine.for_file(sass_file, syntax: syntax)
+      colors = VariableEvaluator.visit(engine.to_tree).compact.reject{|entry| entry.flatten.empty?}
+      Hash[colors.map{|name, color| [ name, color.to_s.gsub(/^#/,'') ]}]
+    end
+
+    class << self
+      private
+      def guess_syntax(file)
+        guess = File.extname(file)[-1..1].to_sym
+        [:sass, :scss].include?(guess) ? guess : DEFAULT_SYNTAX
+      end
+    end
+  end
+end

data/lib/sass_color_extractor/variable_evaluator.rb

@@ -0,0 +1,15 @@
+require 'sass'
+module SassColorExtractor
+  class VariableEvaluator < Sass::Tree::Visitors::Base
+    def visit_variable(node)
+      @environment ||= Sass::Environment.new
+      begin
+        val = node.expr.perform(@environment)
+      rescue Sass::SyntaxError
+        val = node.expr
+      end
+      @environment.set_local_var(node.name, val)
+      [node.name, node.expr.perform(@environment)]
+    end
+  end
+end

data/lib/sass_color_extractor/version.rb

@@ -0,0 +1,3 @@
+module SassColorExtractor
+  VERSION = "0.1.0"
+end

data/sass_color_extractor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sass_color_extractor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sass-color-extractor"
+  spec.version       = SassColorExtractor::VERSION
+  spec.authors       = ["Mr Rogers"]
+  spec.email         = ["jon@rcode5.com"]
+  spec.summary       = %q{Extract colors from Sass/Scss in ruby - can be used to generate a nice palette for a Rails app.}
+  #spec.description  = ""
+  spec.homepage      = "https://github.com/rcode5/sass_color_extractor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "sass", "~> 3.4"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/spec/fixtures/test_colors.sass

@@ -0,0 +1,14 @@
+/* whatever */
+$black: #000
+$white: #ffffff
+$red: #ff0000
+$yellr: #fc2
+$light_yellr: lighten($yellr, 20%)
+$dark_yellr: darken($yellr, 10%)
+
+@mixin this
+  color: whatever
+.style
+  overflow:hidden
+
+// empty line and comment line

data/spec/fixtures/test_colors.scss

@@ -0,0 +1,14 @@
+/* whatever */
+   $black: #000;
+$white: #ffffff;
+   $red: #ff0000;
+   $yellr: #fc2;
+
+
+$light_yellr: lighten($yellr, 20%);
+$dark_yellr: darken($yellr, 10%);
+
+@mixin this { color: whatever; }
+.style { overflow:hidden; }
+
+// empty line and comment line

data/spec/sass_color_extractor_base_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe SassColorExtractor::Base do
+  FIXTURE_PATH = "spec/fixtures"
+  describe ".parse_colors" do
+
+    context "given a Sass file" do
+      let(:file) { File.expand_path( File.join(FIXTURE_PATH, "test_colors.sass") ) }
+      it 'returns a list of the parsed colors' do
+        colors = described_class.parse_colors(file)
+        expect(colors).to eql({
+                                "black" => "000",
+                                "white" => "ffffff",
+                                "red" => "ff0000",
+                                "yellr" => "fc2",
+                                "light_yellr" => "ffe488",
+                                "dark_yellr" => "eeb700"
+                              })
+      end
+    end
+
+    context "given an Scss file" do
+      let(:file) { File.expand_path( File.join(FIXTURE_PATH, "test_colors.scss") ) }
+      it "returns a list of the parsed colors" do
+        colors = described_class.parse_colors(file)
+        expect(colors).to eql({
+                                "black" => "000",
+                                "white" => "ffffff",
+                                "red" => "ff0000",
+                                "yellr" => "fc2",
+                                "light_yellr" => "ffe488",
+                                "dark_yellr" => "eeb700"
+                              })
+      end
+    end
+
+  end
+end

data/spec/sass_color_extractor_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe SassColorExtractor do
+
+  it "has a version" do
+    expect(SassColorExtractor::VERSION).to_not be_nil
+    expect(SassColorExtractor::VERSION).to_not be_empty
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require_relative "../lib/sass_color_extractor.rb"

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sass-color-extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mr Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- jon@rcode5.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sass_color_extractor.rb
+- lib/sass_color_extractor/base.rb
+- lib/sass_color_extractor/variable_evaluator.rb
+- lib/sass_color_extractor/version.rb
+- sass_color_extractor.gemspec
+- spec/fixtures/test_colors.sass
+- spec/fixtures/test_colors.scss
+- spec/sass_color_extractor_base_spec.rb
+- spec/sass_color_extractor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rcode5/sass_color_extractor
+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.2
+signing_key: 
+specification_version: 4
+summary: Extract colors from Sass/Scss in ruby - can be used to generate a nice palette
+  for a Rails app.
+test_files:
+- spec/fixtures/test_colors.sass
+- spec/fixtures/test_colors.scss
+- spec/sass_color_extractor_base_spec.rb
+- spec/sass_color_extractor_spec.rb
+- spec/spec_helper.rb