editorconfig 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e98dc00d0f7381091b9a6e113edd9daeb81c17a
-  data.tar.gz: e3e6ce431efd27f8923ac24b62db91b8cf308cd5
+  metadata.gz: 64a6b74e60347b7f0f46844b74d685a4cd137dab
+  data.tar.gz: 5f46d8b91c90c9b6c5a6fe92cf46445f88cd20ab
 SHA512:
-  metadata.gz: eb431952375d5514474e35274db0e3ef24050774c7052a2c677ce1e5a8aef1010c91c90f67de603f9dc2e8fdd9be294ff5951da2e85ef4b3d42377466ea19813
-  data.tar.gz: 5fd815440431dac67177cf84443e78362cf5581d58663b9ebbb80575243f15dab116b6fd24c1cfb5126409286baf34c3296be35b1600c65a76a4e703f51746e1
+  metadata.gz: cc966a7f53f0e581f1ebc4eaadcf8e391681d592ee323b42628cf17995a11e833aee2d53773411941c543eef931d4ab53c17a3e0f47be0435ab46178de00e2cf
+  data.tar.gz: 7f0db69b7e53300db3d2fc095ec7cb6fa6cb5eb9d8d4288b18d0cc2e3b2ba5d18ca817a4d4b596e8792a865d4944c0619aff42c6103e41d3f79272b75548bcca

data/lib/editor_config.rb

@@ -1,8 +1,12 @@
 require "editor_config/version"
 
 module EditorConfig
+  # Public: Default config basename.
   CONFIG_FILENAME = ".editorconfig".freeze
 
+  # Public: Universal property names.
+  #
+  # https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
   INDENT_STYLE             = "indent_style".freeze
   INDENT_SIZE              = "indent_size".freeze
   TAB_WIDTH                = "tab_width".freeze
@@ -12,22 +16,38 @@ module EditorConfig
   INSERT_FINAL_NEWLINE     = "insert_final_newline".freeze
   MAX_LINE_LENGTH          = "max_line_length".freeze
 
+  # Public: Possible boolean values.
+  #
+  # https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
   TRUE  = "true".freeze
   FALSE = "false".freeze
 
+  # Public: Possible indent style values.
+  #
+  # https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#indent_style
   SPACE = "space".freeze
   TAB   = "tab".freeze
 
+  # Public: Possible EOL values.
+  #
+  # https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#end_of_line
   CR   = "cr".freeze
   LF   = "lf".freeze
   CRLF = "crlf".freeze
 
+  # Public: Possible charset values.
+  #
+  # https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#charset
   LATIN1    = "latin1".freeze
   UTF_8     = "utf-8".freeze
   UTF_8_BOM = "utf-8-bom".freeze
   UTF_16BE  = "utf-16be".freeze
   UTF_16LE  = "utf-16le".freeze
 
+  # Internal: Default filename to use if path is too long or has too many
+  # components.
+  DEFAULT_FILENAME = "filename".freeze
+
   # Internal: Maximum number of bytes to read per line. Lines over this limit
   # will be truncated.
   MAX_LINE = 200
@@ -40,69 +60,60 @@ module EditorConfig
   # will be truncated.
   MAX_PROPERTY_NAME = 500
 
-  # Public: Parse a `.editorconfig` from a string.
-  #
-  # io - a String containing the contents of a `.editorconfig` file.
-  #
-  # Returns a hash of sections from the config file. Each section will be a
-  # hash of key/value pairs for that section. The only top-level key that
-  # won't have a Hash value is "root" which if it exists will be set to
-  # `true`.
+  # Internal: Maximum byte length of filename path. Paths over this limit will
+  # default to global "*" properties.
+  MAX_FILENAME = 4096
+
+  # Internal: Maximum number of directories a filename can have. Paths this
+  # deep will default to global "*" properties.
+  MAX_FILENAME_COMPONENTS = 25
+
+  # Public: Parse the contents of an `.editorconfig`.
   #
-  # Possible key/value pairs for sections are as follows:
-  #   "indent_style"             - :tab, :space or nil.
-  #   "indent_size"              - :tab, an integer between 1-64, or nil.
-  #   "tab_width"                - an integer between 1-64, or nil.
-  #   "end_of_line"              - :lf, :cr, :crlf or nil.
-  #   "charset"                  - "latin1", "utf-8", "utf-8-bom", "utf-16be",
-  #                                "utf-16le" or nil.
-  #   "trim_trailing_whitespace" - true, false or nil.
-  #   "insert_final_newline"     - true, false or nil.
+  # io - An IO or String with the raw contents of an `.editorconfig` file.
   #
-  # If either of these keys exist but the value is nil, the key existed in the
-  # editorconfig but it's value was invalid or not supported.
+  # Returns a tuple of a parsed Hash of information and a boolean flag if the
+  # file was marked as "root". The hash contains string keys of each section
+  # of the config file.
   #
   # An example hash would look like this:
   # {
-  #   "root" => true,
   #   "*.rb" => {
-  #     "indent_style" => :space
-  #     "indent_size" => 2,
+  #     "indent_style" => "space",
+  #     "indent_size" => "2",
   #     "charset" => "utf-8"
   #   }
   # }
+  #
   def self.parse(io, version: SPEC_VERSION)
-    # if !io.force_encoding("UTF-8").valid_encoding?
-    #   raise ArgumentError, "editorconfig syntax must be valid UTF-8"
-    # end
-
-    root = false
-    out_hash = {}
+    config, root = {}, false
     last_section = nil
 
     io.each_line do |line|
-      case line.chomp
-      when /\Aroot(\s+)?\=(\s+)?true\Z/
+      line = line.sub(/\s+(;|#).+$/, "").chomp
+      case line
+      when /\Aroot(\s+)?\=(\s+)?true\Z/i
         root = true
-      when /\A\[(?<name>.+)\]\Z/
+      when /\A\s*\[(?<name>.+)\]\s*\Z/
         # section marker
         last_section = Regexp.last_match[:name][0, MAX_SECTION_NAME]
-        out_hash[last_section] = {}
-      when /\A(?<name>[[:word:]]+)(\s+)?\=(\s+)?(?<value>.+)\Z/
+        config[last_section] ||= {}
+      when /\A\s*(?<name>[[:word:]]+)\s*(\=|:)\s*(?<value>.+)\s*\Z/
         match = Regexp.last_match
-        name, value = match[:name][0, MAX_PROPERTY_NAME], match[:value]
-
-        if last_section
-          out_hash[last_section][name] = value
-        else
-          out_hash[name] = value
-        end
+        name, value = match[:name][0, MAX_PROPERTY_NAME].strip, match[:value].strip
+        config[last_section][name] = value if last_section
       end
     end
 
-    return out_hash, root
+    return config, root
   end
 
+  # Public: Normalize known universal properties.
+  #
+  # config  - Hash configuration
+  # version - String spec version
+  #
+  # Returns new preprocessed Hash.
   def self.preprocess(config, version: SPEC_VERSION)
     config = config.reduce({}) { |h, (k, v)| h[k.downcase] = v; h }
 
@@ -138,29 +149,108 @@ module EditorConfig
     config
   end
 
+  # Internal: Temporary replacement constants used within fnmatch.
+  FNMATCH_ESCAPED_LBRACE = "FNMATCH-ESCAPED-LBRACE".freeze
+  FNMATCH_ESCAPED_RBRACE = "FNMATCH-ESCAPED-RBRACE".freeze
+
+  # Public: Test shell pattern against a path.
+  #
+  # Modeled after editorconfig/fnmatch.py.
+  #   https://github.com/editorconfig/editorconfig-core-py/blob/master/editorconfig/fnmatch.py
+  #
+  # pattern - String shell pattern
+  # path    - String pathname
+  #
+  # Returns true if path matches pattern, otherwise false.
   def self.fnmatch?(pattern, path)
     flags = File::FNM_PATHNAME | File::FNM_EXTGLOB
-    File.fnmatch?(pattern, path, flags) ||
-      File.fnmatch?(pattern, File.basename(path), flags)
+    pattern = pattern.dup
+
+    pattern.gsub!(/(\{\w*\})/) {
+      $1.gsub("{", FNMATCH_ESCAPED_LBRACE).gsub("}", FNMATCH_ESCAPED_RBRACE)
+    }
+    pattern.gsub!(/(\{[^}]+$)/) {
+      $1.gsub("{", FNMATCH_ESCAPED_LBRACE)
+    }
+    pattern.gsub!(/^([^\{]+\})/) {
+      $1.gsub("}", FNMATCH_ESCAPED_RBRACE)
+    }
+
+    pattern.gsub!(/(\{(.*)\})/) {
+      bracket = $1
+      inner = $2
+
+      if inner =~ /^(\d+)\.\.(\d+)$/
+        "{#{($1.to_i..$2.to_i).to_a.join(",")}}"
+      elsif inner.include?(",")
+        bracket
+      else
+        "#{FNMATCH_ESCAPED_LBRACE}#{inner}#{FNMATCH_ESCAPED_RBRACE}"
+      end
+    }
+
+    pattern.gsub!(FNMATCH_ESCAPED_LBRACE, "\\{")
+    pattern.gsub!(FNMATCH_ESCAPED_RBRACE, "\\}")
+
+    pattern.gsub!(/\[(.*\/.*)\]/) {
+      "\\[#{$1}\\]"
+    }
+
+    patterns = []
+
+    # Expand "**" to match over path separators
+    # TODO: Optimize the number of patterns we need
+    patterns << pattern.gsub(/\/\*\*/, "/**/*")
+    patterns << pattern.gsub(/\/\*\*/, "")
+    patterns << pattern.gsub(/\*\*/, "**/*")
+    patterns << pattern.gsub(/\*\*/, "/**/*")
+
+    patterns.any? { |p| File.fnmatch?(p, path, flags) }
   end
 
+  # Public: Load EditorConfig with a custom loader implementation.
+  #
+  # path   - String filename on file system
+  # config - Basename of config to search for (default: .editorconfig)
+  #
+  # loader block
+  #   config_path - String "path/to/.editorconfig" to attempt to read from
+  #
+  # Returns Hash of String properties and values.
   def self.load(path, config: CONFIG_FILENAME, version: SPEC_VERSION)
     hash = {}
 
-    traverse(path).each do |subpath|
+    # Use default filename if path is too long
+    path = DEFAULT_FILENAME if path.length > MAX_FILENAME
+
+    components = traverse(path)
+
+    # Use default filename if path has too many directories
+    path = DEFAULT_FILENAME if components.length > MAX_FILENAME_COMPONENTS
+
+    components.each do |subpath|
       config_path = subpath == "" ? config : "#{subpath}/#{config}"
       config_data = yield config_path
       next unless config_data
 
-      ini, root = parse(config_data, version: version)
+      sections, root = parse(config_data, version: version)
+      section_properties = {}
 
-      ini.each do |pattern, properties|
-        matcher = subpath == "" ? pattern : "#{subpath}/#{pattern}"
-        if fnmatch?(matcher, path)
-          hash = properties.merge(hash)
+      sections.each do |section, properties|
+        if section.include?("/")
+          section = section[1..-1] if section[0] == "/"
+          pattern = subpath == "" ? section : "#{subpath}/#{section}"
+        else
+          pattern = "**/#{section}"
+        end
+
+        if fnmatch?(pattern, path)
+          section_properties.merge!(properties)
         end
       end
 
+      hash = section_properties.merge(hash)
+
       if root
         break
       end
@@ -169,6 +259,11 @@ module EditorConfig
     hash
   end
 
+  # Internal: Generate subpaths for given path walking upwards to the root.
+  #
+  # path - String pathname
+  #
+  # Returns an Array of String paths.
   def self.traverse(path)
     paths = []
     parts = path.split("/", -1)
@@ -189,6 +284,15 @@ module EditorConfig
     paths
   end
 
+  # Public: Load EditorConfig for a specific file.
+  #
+  # Starts at filename and walks up each directory gathering any .editorconfig
+  # files until it reaches a config marked as "root".
+  #
+  # path   - String filename on file system
+  # config - Basename of config to search for (default: .editorconfig)
+  #
+  # Returns Hash of String properties and values.
   def self.load_file(*args)
     EditorConfig.load(*args) do |path|
       File.read(path) if File.exist?(path)

data/lib/editor_config/version.rb

@@ -1,4 +1,4 @@
 module EditorConfig
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
   SPEC_VERSION = "0.9.1"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: editorconfig
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
-dependencies: []
+date: 2015-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
 description: 
 email: 
 executables: []
@@ -19,7 +47,7 @@ files:
 - lib/editor_config.rb
 - lib/editor_config/version.rb
 - lib/editorconfig.rb
-homepage: 
+homepage: https://github.com/editorconfig/editorconfig-core-ruby
 licenses:
 - MIT
 metadata: {}