editorconfig 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e1a47db3cdf95e4fc2b97f54136d5446fbeea6c
-  data.tar.gz: b8f33f8d96bc75b140091cf1b5fb3f9552edc687
+  metadata.gz: e9eba3573ace023282386f50a78895b2b637da4b
+  data.tar.gz: 662371a10f2bc6733a13687d19fd6694e9e52c3a
 SHA512:
-  metadata.gz: 2fb9729bf61e957da4e27d7c309e720fea5dd97f549afaee4a519d122a96571d1d71ac65acf2a2f717721ead9759a01c891f12a62f12c25e0916bb3124c843f7
-  data.tar.gz: 425ec22a09d801773e0b13bbf7413dfed3cd9a20176b3a2716610da493f41a0ac1b8d6ad6da1972f3fc00eb4110499acef99c87b5ff58d2f1b268e075ad70763
+  metadata.gz: 93dbc0d4d3f8c583769d7f8d8bc411c41ed8f3ab6a9d9ab81a8ae647d9e75601caabec251c771eeb7a1f3cc328d9d990ca9d0bc494eb3a83af0e2a04f3cb9228
+  data.tar.gz: b49e1c35dc26ea071534e2d02403a003a0251515f9a79fc132fb7d72a543f7ad848109c0626ee163ce8b94217572e85ab064bbbc972d9ea4318d736d037ce830

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2015 GitHub, Inc.
+
+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,107 @@
+# EditorConfig Ruby Core
+
+EditorConfig Ruby Core provides the same functionality as the [EditorConfig C Core](https://github.com/editorconfig/editorconfig-core-c) and [EditorConfig Python Core](https://github.com/editorconfig/editorconfig-core-py) libraries.
+
+## EditorConfig Project
+
+EditorConfig makes it easy to maintain the correct coding style when switching between different text editors and between different projects. The EditorConfig project maintains a file format and plugins for various text editors which allow this file format to be read and used by those editors. For information on the file format and supported text editors, see the [EditorConfig website](http://editorconfig.org>).
+
+## Installation
+
+With RubyGems:
+
+``` sh
+$ gem install editorconfig
+```
+
+## Usage
+
+Loading library module.
+
+``` ruby
+require 'editor_config'
+EditorConfig.parse(File.read(".editorconfig"))
+```
+
+A command line binary is also provided.
+
+```
+$ editorconfig main.c
+charset=utf-8
+insert_final_newline=true
+end_of_line=lf
+tab_width=8
+```
+
+### Load
+
+**File System**
+
+An flattened config can be loaded from the file system with:
+
+``` ruby
+filename = "~/Project/foo/lib/foo.rb"
+config = EditorConfig.load_file(filename)
+
+# config: hash of properties and values
+{
+  "charset" => "utf-8",
+  "indent_style" => "space",
+  "end_of_line" => "lf",
+  "insert_final_newline" => "true"
+}
+```
+
+This API walks up the directory hierarchy gathering all `.editorconfig` files until it reaches a config that defines `root = true`.
+
+**Custom Loader**
+
+A custom loader can be provided to read files from another source rather than the file system.
+
+For an example, you might load files directly from a git repository.
+
+``` ruby
+tree_sha, filename = "348b1ea52f897f313d62c56c2ba785a41f654861", "lib/foo.rb"
+
+config = EditorConfig.load(filename) do |config_path|
+  if blob_sha = `git ls-tree #{tree_sha} #{config_path}`.split(" ")[2]
+    `git cat-file blob #{blob_sha}`
+  end
+end
+```
+
+### Parse
+
+A low-level API for parsing an individual `.editorconfig` file.
+
+A `[config, root]` tuple is returned. The `root` bit is set if a top-level `root = true` is seen. The `config` value is a two dimensional hash mapping section names to property names and values.
+
+``` ruby
+data = File.read(".editorconfig")
+config, root = EditorConfig.parse(data)
+
+# root: if top-most root = true flag is set
+true
+
+# config: hash of sections and properties
+{
+  "*" => {
+    "end_of_line" => "lf",
+    "insert_final_newline" => "true"
+  },
+  "*.{js,py}" => {
+    "charset" => "utf-8"
+  }
+}
+```
+
+
+## Testing
+
+[Cmake](http://www.cmake.org) is required to run the test suite. On OSX, just `brew install cmake`.
+
+Then run the tests with:
+
+``` sh
+$ rake test
+```

data/lib/editor_config/version.rb

@@ -1,4 +1,4 @@
 module EditorConfig
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
   SPEC_VERSION = "0.9.1"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: editorconfig
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-09-10 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: 
@@ -47,6 +47,8 @@ files:
 - lib/editor_config.rb
 - lib/editor_config/version.rb
 - lib/editorconfig.rb
+- README.md
+- LICENSE.md
 homepage: https://github.com/editorconfig/editorconfig-core-ruby
 licenses:
 - MIT
@@ -57,17 +59,17 @@ 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.4.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: EditorConfig core library written in Ruby