css_parser 1.4.10 → 1.5.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b445faf1396f058086f3ec3654d5ebb4a2d1157
-  data.tar.gz: 2c8b069bfff50b3e5072ba4912d52aff2ec813ee
+  metadata.gz: 842917dce4f3455e696297fb182f1b1783ac3a5a
+  data.tar.gz: ef48928b85b441a68fe9b10e3947643f90a147ec
 SHA512:
-  metadata.gz: 95c649943ddeb1d61395107986d97d594354654647d13453c41c7cee0d2bffeb6645320e2084a56609131f29721f3f7ddb538ed2c068af43770e48947b1fee40
-  data.tar.gz: ed26582b08c72abf29c10c8f6a45d28c5d8a12cadbaf9dd3096ff96f719251b0334d73ad68b1cb56fc3e489d184fbe53d3bc7cd24fd595d93e4f76f94b1b6250
+  metadata.gz: 01d11dfbc01781b5ca23598800f53062211f0d7b06074683720ca11354d85d7ea2e9cb2624bfc97265e6ee89ee3c28edb95d02361512a1407c77bd9c8b54d381
+  data.tar.gz: 194c4de30884cc386108ffee89cd1c0426ce4ae2bcfb467515c3fc1ff19dd387680a19306c7ace0f24854adef85846f0eeeca8a01651602c3e744a38cf72ca61

data/lib/css_parser/parser.rb

@@ -36,7 +36,8 @@ module CssParser
     def initialize(options = {})
       @options = {:absolute_paths => false,
                   :import => true,
-                  :io_exceptions => true}.merge(options)
+                  :io_exceptions => true,
+                  :capture_offsets => false}.merge(options)
 
       # array of RuleSets
       @rules = []
@@ -117,7 +118,7 @@ module CssParser
       options[:media_types] = [options[:media_types]].flatten.collect { |mt| CssParser.sanitize_media_query(mt)}
       options[:only_media_types] = [options[:only_media_types]].flatten.collect { |mt| CssParser.sanitize_media_query(mt)}
 
-      block = cleanup_block(block)
+      block = cleanup_block(block, options)
 
       if options[:base_uri] and @options[:absolute_paths]
         block = CssParser.convert_uris(block, options[:base_uri])
@@ -139,17 +140,22 @@ module CssParser
 
           import_path = import_rule[0].to_s.gsub(/['"]*/, '').strip
 
+          import_options = { :media_types => media_types }
+          import_options[:capture_offsets] = true if options[:capture_offsets]
+
           if options[:base_uri]
             import_uri = Addressable::URI.parse(options[:base_uri].to_s) + Addressable::URI.parse(import_path)
-            load_uri!(import_uri, options[:base_uri], media_types)
+            import_options[:base_uri] = options[:base_uri]
+            load_uri!(import_uri, import_options)
           elsif options[:base_dir]
-            load_file!(import_path, options[:base_dir], media_types)
+            import_options[:base_dir] = options[:base_dir]
+            load_file!(import_path, import_options)
           end
         end
       end
 
       # Remove @import declarations
-      block.gsub!(RE_AT_IMPORT_RULE, '')
+      block = ignore_pattern(block, RE_AT_IMPORT_RULE, options)
 
       parse_block_into_rule_sets!(block, options)
     end
@@ -162,6 +168,16 @@ module CssParser
       add_rule_set!(rule_set, media_types)
     end
 
+    # Add a CSS rule by setting the +selectors+, +declarations+, +filename+, +offset+ and +media_types+.
+    #
+    # +filename+ can be a string or uri pointing to the file or url location.
+    # +offset+ should be Range object representing the start and end byte locations where the rule was found in the file.
+    # +media_types+ can be a symbol or an array of symbols.
+    def add_rule_with_offsets!(selectors, declarations, filename, offset, media_types = :all)
+      rule_set = OffsetAwareRuleSet.new(filename, offset, selectors, declarations)
+      add_rule_set!(rule_set, media_types)
+    end
+
     # Add a CssParser RuleSet object.
     #
     # +media_types+ can be a symbol or an array of symbols.
@@ -289,9 +305,16 @@ module CssParser
       current_media_query = ''
       current_declarations = ''
 
-      block.scan(/(([\\]{2,})|([\\]?[{}\s"])|(.[^\s"{}\\]*))/).each do |matches|
+      # once we are in a rule, we will use this to store where we started if we are capturing offsets
+      rule_start = nil
+      offset = nil
+
+      block.scan(/(([\\]{2,})|([\\]?[{}\s"])|(.[^\s"{}\\]*))/) do |matches|
         token = matches[0]
 
+        # save the regex offset so that we know where in the file we are
+        offset = Regexp.last_match.offset(0) if options[:capture_offsets]
+
         if token =~ /\A"/ # found un-escaped double quote
           in_string = !in_string
         end
@@ -316,11 +339,18 @@ module CssParser
             in_declarations -= 1
 
             unless current_declarations.strip.empty?
-              add_rule!(current_selectors, current_declarations, current_media_queries)
+              if options[:capture_offsets]
+                add_rule_with_offsets!(current_selectors, current_declarations, options[:filename], (rule_start..offset.last), current_media_queries)
+              else
+                add_rule!(current_selectors, current_declarations, current_media_queries)
+              end
             end
 
             current_selectors = ''
             current_declarations = ''
+
+            # restart our search for selectors and declarations
+            rule_start = nil if options[:capture_offsets]
           end
         elsif token =~ /@media/i
           # found '@media', reset current media_types
@@ -356,11 +386,14 @@ module CssParser
             end
           else
             if token =~ /\{/ and not in_string
-              current_selectors.gsub!(/^[\s]*/, '')
-              current_selectors.gsub!(/[\s]*$/, '')
+              current_selectors.strip!
               in_declarations += 1
             else
+              # if we are in a selector, add the token to the current selectors
               current_selectors += token
+
+              # mark this as the beginning of the selector unless we have already marked it
+              rule_start = offset.first if options[:capture_offsets] && rule_start.nil? && token =~ /^[^\s]+$/
             end
           end
         end
@@ -368,7 +401,11 @@ module CssParser
 
       # check for unclosed braces
       if in_declarations > 0
-        add_rule!(current_selectors, current_declarations, current_media_queries)
+        if options[:capture_offsets]
+          add_rule_with_offsets!(current_selectors, current_declarations, options[:filename], (rule_start..offset.last), current_media_queries)
+        else
+          add_rule!(current_selectors, current_declarations, current_media_queries)
+        end
       end
     end
 
@@ -381,7 +418,6 @@ module CssParser
     # Deprecated: originally accepted three params: `uri`, `base_uri` and `media_types`
     def load_uri!(uri, options = {}, deprecated = nil)
       uri = Addressable::URI.parse(uri) unless uri.respond_to? :scheme
-      #base_uri = nil, media_types = :all, options = {}
 
       opts = {:base_uri => nil, :media_types => :all}
 
@@ -399,6 +435,9 @@ module CssParser
 
       opts[:base_uri] = uri if opts[:base_uri].nil?
 
+      # pass on the uri if we are capturing file offsets
+      opts[:filename] = uri.to_s if opts[:capture_offsets]
+
       src, = read_remote_file(uri) # skip charset
       if src
         add_block!(src, opts)
@@ -406,20 +445,40 @@ module CssParser
     end
 
     # Load a local CSS file.
-    def load_file!(file_name, base_dir = nil, media_types = :all)
-      file_name = File.expand_path(file_name, base_dir)
+    def load_file!(file_name, options = {}, deprecated = nil)
+      opts = {:base_dir => nil, :media_types => :all}
+
+      if options.is_a? Hash
+        opts.merge!(options)
+      else
+        opts[:base_dir] = options if options.is_a? String
+        opts[:media_types] = deprecated if deprecated
+      end
+
+      file_name = File.expand_path(file_name, opts[:base_dir])
       return unless File.readable?(file_name)
       return unless circular_reference_check(file_name)
 
       src = IO.read(file_name)
-      base_dir = File.dirname(file_name)
 
-      add_block!(src, {:media_types => media_types, :base_dir => base_dir})
+      opts[:filename] = file_name if opts[:capture_offsets]
+      opts[:base_dir] = File.dirname(file_name)
+
+      add_block!(src, opts)
     end
 
     # Load a local CSS string.
-    def load_string!(src, base_dir = nil, media_types = :all)
-      add_block!(src, {:media_types => media_types, :base_dir => base_dir})
+    def load_string!(src, options = {}, deprecated = nil)
+      opts = {:base_dir => nil, :media_types => :all}
+
+      if options.is_a? Hash
+        opts.merge!(options)
+      else
+        opts[:base_dir] = options if options.is_a? String
+        opts[:media_types] = deprecated if deprecated
+      end
+
+      add_block!(src, opts)
     end
 
 
@@ -440,20 +499,31 @@ module CssParser
       end
     end
 
+    # Remove a pattern from a given string
+    #
+    # Returns a string.
+    def ignore_pattern(css, regex, options)
+      # if we are capturing file offsets, replace the characters with spaces to retail the original positions
+      return css.gsub(regex) { |m| ' ' * m.length } if options[:capture_offsets]
+
+      # otherwise just strip it out
+      css.gsub(regex, '')
+    end
+
     # Strip comments and clean up blank lines from a block of CSS.
     #
     # Returns a string.
-    def cleanup_block(block) # :nodoc:
+    def cleanup_block(block, options = {}) # :nodoc:
       # Strip CSS comments
-      utf8_block = block.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-      utf8_block.gsub!(STRIP_CSS_COMMENTS_RX, '')
+      utf8_block = block.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: ' ')
+      utf8_block = ignore_pattern(utf8_block, STRIP_CSS_COMMENTS_RX, options)
 
       # Strip HTML comments - they shouldn't really be in here but
       # some people are just crazy...
-      utf8_block.gsub!(STRIP_HTML_COMMENTS_RX, '')
+      utf8_block = ignore_pattern(utf8_block, STRIP_HTML_COMMENTS_RX, options)
 
       # Strip lines containing just whitespace
-      utf8_block.gsub!(/^\s+$/, "")
+      utf8_block.gsub!(/^\s+$/, "") unless options[:capture_offsets]
 
       utf8_block
     end
@@ -483,12 +553,16 @@ module CssParser
 
       src = '', charset = nil
 
-      uri = Addressable::URI.parse(uri.to_s)
       begin
+        uri = Addressable::URI.parse(uri.to_s)
+
         if uri.scheme == 'file'
           # local file
-          fh = open(uri.path, 'rb')
+          path = uri.path
+          path.gsub!(/^\//, '') if Gem.win_platform?
+          fh = open(path, 'rb')
           src = fh.read
+          charset = fh.respond_to?(:charset) ? fh.charset : 'utf-8'
           fh.close
         else
           # remote file
@@ -503,7 +577,7 @@ module CssParser
 
           res = http.get(uri.request_uri, {'User-Agent' => USER_AGENT, 'Accept-Encoding' => 'gzip'})
           src = res.body
-          charset = fh.respond_to?(:charset) ? fh.charset : 'utf-8'
+          charset = res.respond_to?(:charset) ? res.encoding : 'utf-8'
 
           if res.code.to_i >= 400
             @redirect_count = nil

data/lib/css_parser/rule_set.rb

@@ -513,4 +513,19 @@ module CssParser
       @selectors = selectors.split(',').map { |s| s.gsub(/\s+/, ' ').strip }
     end
   end
+
+  class OffsetAwareRuleSet < RuleSet
+
+    # File offset range
+    attr_reader :offset
+
+    # the local or remote location
+    attr_accessor :filename
+
+    def initialize(filename, offset, selectors, block, specificity = nil)
+      super(selectors, block, specificity)
+      @offset = offset
+      @filename = filename
+    end
+  end
 end

data/lib/css_parser/version.rb

@@ -1,3 +1,3 @@
 module CssParser
-  VERSION = "1.4.10".freeze
+  VERSION = "1.5.0.pre".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: css_parser
 version: !ruby/object:Gem::Version
-  version: 1.4.10
+  version: 1.5.0.pre
 platform: ruby
 authors:
 - Alex Dunae
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -51,9 +51,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8