color_parser 0.0.2 → 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87fb5246ee611764195e313bb830a0b6a857e843248edb939a9eb88bc4864942
+  data.tar.gz: 06747e256d940da5ecc6c33dd7ec2b8be38737a14bc7addf3b560fe4401a0f59
+SHA512:
+  metadata.gz: 2ff0fbc960fde8b9d9e31e8a0cc65c0b106af820d27aaf41199301129a17683cbd7baebfe85dd492f8fda91029a3d84111f83f8977aa3416fde2081f12406ebf
+  data.tar.gz: 1abfe0694f4121e473501ac9ad8da90362a6b350c8b50e24af464f8733bdc6c63a0acbd988566362a35c5f2abf6a1a6a08a9255fb6aba59b7e02bbbf32bdb093

data/.gitignore

@@ -4,6 +4,7 @@
 .bundle
 .config
 .yardoc
+.rspec
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -16,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/color_parser/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')           { "spec" }
+end
+

data/README.md

@@ -1,43 +1,34 @@
 ## ColorParser
 
-The ColorParser gem provides a simple way to parse the colors from an html page or CSS file. It works with both local and remote resources. 
+The ColorParser gem provides a simple way to parse the colors from an HTML page. 
+It scans both the HTML and CSS to find all colors and sort them by frequency 
+used. 
 
 ## Example
 
+Get colors on a given webpage
+
 ```ruby
-page = ColorParser::Page.new("http://sportspyder.com/")
+page = ColorParser::Page.new("http://google.com/")
 colors = page.colors
+=> {"ffffff"=>5, "c9d7f1"=>1, "0000cc"=>2, "dd8e27"=>1, "990000"=>1, 
+    "3366cc"=>3, "000000"=>2, "1111cc"=>5, "cccccc"=>2, "551a8b"=>1}
+
+colors = page.colors_by_frequency
+=> ["ffffff", "1111cc", "3366cc", "000000", "cccccc", 
+    "0000cc", "dd8e27", "c9d7f1", "990000", "551a8b"]
 ```
 
 ## Installation
 
-```
-gem install color_parser
-```
-```
+To install ColorParser, add the gem to your Gemfile: 
+
+```ruby
 gem "color_parser"
 ```
 
 ## LICENSE
 
-(The MIT License)
-
-Copyright © 2012 [Derek DeVries](https://github.com/devrieda/)
-
-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.
+Copyright (c) 2013 Derek DeVries
 
-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.
+Released under the [MIT License](http://www.opensource.org/licenses/MIT)

data/Rakefile

@@ -1,10 +1,22 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'rake/testtask'
 
-Rake::TestTask.new do |t|
-  t.libs << 'lib/color_parser'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+namespace :spec do
+  desc 'Run unit specs only'
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.pattern    = 'spec'
+    task.rspec_opts = '--tag "~live"'
+  end
+
+  desc 'Run acceptance specs only'
+  RSpec::Core::RakeTask.new(:acceptance) do |task|
+    task.pattern    = 'spec'
+    task.rspec_opts = '--tag "live"'
+  end
 end
-task :default => :test
+
+task :default => :spec

data/color_parser.gemspec

@@ -6,7 +6,7 @@ require 'color_parser/version'
 Gem::Specification.new do |gem|
   gem.name          = "color_parser"
   gem.version       = ColorParser::VERSION
-  gem.summary       = %q{Color Parser finds the colors on a given webpage}
+  gem.summary       = %q{Finds colors on a given webpage}
   gem.description   = gem.summary
 
   gem.required_ruby_version = '>= 1.9.3'
@@ -20,7 +20,15 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+  
+  gem.add_runtime_dependency("stylesheet",       "~> 0.1.7")
+  gem.add_runtime_dependency("color_conversion", "~> 0.1.0")
 
-  gem.add_runtime_dependency("nokogiri", "~> 1.5")
   gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec", "~> 2.9")
+
+  # guard
+  gem.add_development_dependency("guard", "~> 1.7")
+  gem.add_development_dependency("guard-rspec", "~> 2.5")
+  gem.add_development_dependency("rb-fsevent", "~> 0.9")
 end

data/lib/color_parser.rb

@@ -1,142 +1,11 @@
-require 'net/http'
 require 'uri'
-require 'nokogiri'
+require 'stylesheet'
+require 'color_conversion'
 
+require 'color_parser/errors'
 require 'color_parser/version'
 require 'color_parser/page'
 require 'color_parser/stylesheet'
-require 'color_parser/image'
 
 module ColorParser
-
-  # Build url of an asset based on the relative/absolute url
-  def self.parse_asset(doc_url, asset_url)
-    doc_host,   doc_path,   doc_query   = self.parse_url(doc_url)
-    asset_host, asset_path, asset_query = self.parse_url(asset_url)
-
-    # absolute path
-    host, path, query = if asset_url.include?("http")
-      [asset_host, asset_path, asset_query]
-
-    # root relative
-    elsif asset_url[0,1] == "/"
-      [doc_host, asset_path, asset_query]
-
-    # relative
-    else
-      path = File.expand_path("#{doc_path.gsub(/[^\/]*$/, "")}#{asset_path}", "/")
-      [doc_host, path, asset_query]
-    end
-
-    "http://#{host}#{path}#{"?"+query if query}"
-  end
-
-  # parse url parts
-  def self.parse_url(url)
-    begin
-      uri = URI.parse(url.strip)
-    rescue URI::InvalidURIError
-      uri = URI.parse(URI.escape(url.strip))
-    end
-
-    [uri.host, (uri.path != "" ? uri.path : "/"), uri.query]
-  end
-
-
-  # Request
-
-  def self.request=(request)
-    @request = request
-  end
-
-  def self.request
-    @request ||= Request.new
-  end
-  
-  # Request an asset
-  #
-  class Request    
-    @@last_request = Time.now
-
-    # default throttle requests 1 per sec
-    def initialize(params={})
-      @throttle = params[:throttle] || 1
-    end
-
-    def get(url)
-      throttle
-
-      begin
-        uri = URI.parse(url.strip)
-      rescue URI::InvalidURIError
-        uri = URI.parse(URI.escape(url.strip))
-      end
-
-      response = get_response(uri)
-
-      # redirect
-      @prev_redirect ||= ""
-      if response.header['location']
-        # make sure we're not in an infinite loop
-        if response.header['location'] == @prev_redirect
-          raise HTTPError, "Recursive redirect: #{@prev_redirect}"
-        end
-        @prev_redirect = response.header['location']
-
-        return get(response.header['location'])
-      end
-      
-      # bad req
-      if response.to_s.index 'Bad Request' || response.nil?
-        raise HTTPError, "invalid HTTP request #{url}" 
-      end
-      
-      response = fix_encoding(response)
-      response.body
-    end
-
-    def user_agent
-      "ColorParser Mozilla/5.0 (Windows; U; Windows NT 5.1; de; rv:1.8.0.7) Gecko/20060909 Firefox/1.5.0.7"
-    end
-
-
-    private
-
-    # Use charset in content-type, default to UTF-8 if absent
-    # 
-    # text/html; charset=UTF-8
-    # - or -
-    # text/html; charset=iso-8859-1
-    # - or - 
-    # text/html    
-    def fix_encoding(response)
-      charset = if response.header["Content-Type"].to_s.include?("charset")
-        response.header["Content-Type"].split(";")[1].split("=")[1]
-      else
-        "UTF-8"
-      end
-
-      response.body.force_encoding(charset.upcase).encode("UTF-8")
-      response
-    end
-
-    # build http request object
-    def get_response(uri)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.open_timeout = 15
-      http.read_timeout = 30
-
-      request = Net::HTTP::Get.new(uri.request_uri)
-      request["User-Agent"] = user_agent
-
-      http.request(request)
-    end
-
-    # throttle requests to 1 per sec
-    def throttle
-      sleep @throttle if @@last_request + @throttle > Time.now
-      @@last_request = Time.now
-    end
-  end
-
 end

data/lib/color_parser/errors.rb

@@ -0,0 +1,3 @@
+module ColorParser
+  class Error < StandardError; end
+end

data/lib/color_parser/page.rb

@@ -1,14 +1,19 @@
 module ColorParser
   # a webpage
   class Page
-    attr_reader :url, :host, :path, :query, :text, :doc
+    attr_reader :url, :text
 
     def initialize(url)
-      @url = url
-      @host, @path, @query = ColorParser.parse_url(url)
+      @style_document = self.class.style_document.new(url)
 
-      @text ||= ColorParser.request.get(url)
-      @doc  ||= Nokogiri::HTML(@text)
+      @url  = @style_document.location.href
+      @text = @style_document.text
+    end
+
+    def stylesheets
+      @stylesheets ||= @style_document.style_sheets.map do |style_sheet|
+        Stylesheet.new(style_sheet)
+      end
     end
 
     def colors
@@ -28,61 +33,13 @@ module ColorParser
       colors.sort {|a,b| b[1]<=>a[1] }.map {|clr| clr.first }
     end
 
-    def images
-      @images ||= inline_images + stylesheet_images
-    end
 
-    def stylesheets
-      @stylesheets ||= inline_styles + external_styles
+    def self.style_document
+      @style_document ||= ::Stylesheet::Document
     end
 
-
-    private
-
-    # find all inline styles and build new stylesheet from them
-    def inline_styles
-      doc.css("style").map do |style|
-        Stylesheet.new(text: style.inner_html, 
-                       type: "inline", 
-                       url:  "http://#{host}#{path}")
-      end
-    end
-
-    def external_styles
-      styles = []
-
-      doc.css("link[rel='stylesheet']").each do |style|
-        next unless href = style["href"]
-
-        asset_url = ColorParser.parse_asset(url, href)
-        next unless text = ColorParser.request.get(asset_url)
-
-        css = Stylesheet.new(text: text, 
-                             type: "external", 
-                             url:  asset_url)
-        styles << css
-      end
-
-      styles
-    end
-
-    def inline_images
-      images = []
-
-      doc.css("img").map do |image|
-        next unless src = image["src"]
-        next unless src.match(/gif|jpg|jpeg|png|bmp/)
-
-        asset_url = ColorParser.parse_asset(url, src)
-        images << Image.new(asset_url)
-      end
-
-      images
-    end
-
-    def stylesheet_images
-      [stylesheets.map {|style| style.images }].flatten
+    def self.style_document=(style_document)
+      @style_document = style_document
     end
   end
-
 end

data/lib/color_parser/stylesheet.rb

@@ -1,32 +1,9 @@
 module ColorParser
-  # a set of css selectors
-  class Stylesheet
-    TEXT_COLORS = {
-      aqua:    "00ffff", black:  "000000", blue:  "0000ff",
-      fuchsia: "ff00ff", gray:   "808080", green: "008000",
-      lime:    "00ff00", maroon: "800000", navy:  "000080",
-      olive:   "808000", purple: "800080", red:   "ff0000",
-      silver:  "c0c0c0", teal:   "008080", white: "ffffff",
-      yellow:  "ffff00"
-    }
 
-    attr_reader :url, :type, :host, :path, :query, :text
+  class Stylesheet
     
-    def initialize(options)
-      @type  = options[:type]
-      @text  = options[:text]
-      @url   = options[:url]
-
-      @host, @path, @query = ColorParser.parse_url(url)
-    end
-
-    def name
-      path.split("/").last
-    end
-
-    # get imported stylesheets
-    def stylesheets
-      @stylesheets ||= imported_stylesheets
+    def initialize(style_sheet)
+      @style_sheet = style_sheet
     end
 
     # gst list of colors from styles
@@ -37,87 +14,44 @@ module ColorParser
     def bg_colors
       @bg_colors ||= parse_colors(bg_properties)
     end
-
+    
     def text_colors
       @text_colors ||= parse_colors(text_properties)
     end
-
+    
     def border_colors
       @border_colors ||= parse_colors(border_properties)
     end
 
-
-    def images
-      images = []
-
-      image_properties.each do |key, value|
-        if value.include?("url") && match = value.match(/url\(['"]?([^'")]+)/)
-          asset_url = ColorParser.parse_asset(url, match[1])
-          images << Image.new(asset_url)
-        end
-      end
-
-      images
-    end
-
-
-    # groups of css selectors (including imported styles)
-    def selectors
-      selectors = {}
-
-      text.scan(/([^\s\}]+)[\s]*?\{(.*?)\}/m).each do |match|
-        selector, rule = match
-        selectors[selector] ||= []
-        selectors[selector] << rule.strip 
-      end
-
-      # imported styles
-      stylesheets.each do |style| 
-        style.selectors.each do |selector, rule| 
-          selectors[selector] ||= []
-          selectors[selector] += rule
+    def rules
+      rules = {}
+      
+      ([@style_sheet] + style_sheets).each do |css|
+        css.style_rules.each do |rule|
+          rules[rule.selector_text] ||= {}
+          rules[rule.selector_text].merge!(rule.style.declarations)
         end
       end
 
-      selectors
+      rules
     end
 
     # split up selectors into properties, and return property key/value pairs
     def properties
       properties = []
 
-      selectors.each do |selector, rules| 
-        rules.each do |rule|
-          rule.split(";").each do |property| 
-            props = property.split(":", 2).map {|v| v.strip }
-            properties << props if props.size == 2
-          end
-        end
+      rules.values.each do |declarations|
+        declarations.each {|property, value| properties << [property, value] }
       end
-
+      
       properties
     end
 
-
     private
 
-    def imported_stylesheets
-      return [] unless text.include?("@import")
-
-      styles = []
-      text.scan(/@import(?:\surl|\s)(.*?)[;\n]+/).each do |style|
-        style_path = style.first.gsub(/['"\(\);]/, "")
-
-        asset_url = ColorParser.parse_asset(url, style_path)
-        next unless text = ColorParser.request.get(asset_url)
-
-        css = Stylesheet.new(text: text, 
-                             type: "imported", 
-                             url:  asset_url)
-        styles << css
-      end
-
-      styles
+    # get imported stylesheets
+    def style_sheets
+      @style_sheets ||= @style_sheet.import_rules.map {|rule| rule.style_sheet }
     end
 
     # find properties that might have a color
@@ -128,7 +62,7 @@ module ColorParser
          "border-left-color", "color", "outline-color"].include?(key)
       end
     end
-    
+
     # properties with bg colors
     def bg_properties 
       color_properties.select {|key, value| key.include?("background") }
@@ -146,52 +80,22 @@ module ColorParser
       end
     end
 
-    # find properties that might have an image
-    def image_properties
-      color_properties.select {|key, value| key.include?("background") }
-    end
-
     def parse_colors(property_list)
       colors = {}
-
-      property_list.each do |key, value|
-        # hex
-        hex = if matches = value.match(/#([0-9a-f]{3,6})/i)
-          normalize_hex(matches[1])
-
-        # rgb/rgba
-        elsif matches = value.match(/rgba?\((\d{1,3}[,\s]+\d{1,3}[,\s]+\d{1,3})/)
-          rgb_to_hex(matches[1])
-
-        # textual
-        elsif matches = value.match(/(#{TEXT_COLORS.map {|k,v| k }.join("|")})/)
-          text_to_hex(matches[1])
+      property_list.each do |key, value| 
+        color = nil
+        value.gsub(/\s?,\s?/, ",").split(" ").each do |part|
+          color ||= ColorConversion::Color.new(part) rescue nil
         end
+        next unless color
 
-        next unless hex
-
+        hex = color.hex.gsub("#", "")
         colors[hex] ? colors[hex] += 1 : colors[hex] = 1
       end
 
       # sort by colors with most occurrances
       colors
     end
-
-    # convert rgb to hex
-    def rgb_to_hex(rgb)
-      r, g, b = rgb.split(",").map {|color| color.strip }
-      "%02x" % r + "%02x" % g + "%02x" % b
-    end
-
-    # find hex for textual color
-    def text_to_hex(color)
-      TEXT_COLORS[color.intern]
-    end
-    
-    # convert 3 digit hex to 6
-    def normalize_hex(hex)
-      (hex.length == 3 ? hex[0,1]*2 + hex[1,1]*2 + hex[2,1]*2: hex).downcase
-    end
-
+  
   end
 end