kvn 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 487ee8d85ce8eac0225f08b86d21dd815aff1f09
-  data.tar.gz: 3eb23b598b95eab8155d6a3aaabfb8a1f16766c5
+  metadata.gz: 832c9ff0fe7496bfe3c6f5a93cc7b959e8889cb2
+  data.tar.gz: 05dd1ba7428b883dc2fe7669ae70fa180f14c383
 SHA512:
-  metadata.gz: 87ed111e0c4a50bcce9a9220e76c42b94ca1146ffed4d956914d26342ee041efb037e7050e9195fad1776cec93b191137174cd493451852ec656a378aedc80eb
-  data.tar.gz: 88e51aa82458c196d912d80c4f705d3403cb3991e0b75e50948ea2d6a6375ce7b6a1037d0bb8e77378d9debfab4214f25c5416401aeab06221b5e3af82479257
+  metadata.gz: 2ec2564e05c43f19bd5897d58cf7bda7392817ce7bcb738e44abec846deccc332893d292565b9855605385462383d7309164ee52729f3060ccd7808cdfbbf28c
+  data.tar.gz: 2f00b76e616acf6177ca67558004c89545fb9adb0a616fac958f3eabc9c28db556ac626cb36bc563bc02f12fb0d37dffa6ec2d5d7f09c4fcdd7e3b176fd9a761

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kvn (0.1.0)
+    kvn (0.2.0)
       lex (= 0.1.0)
 
 GEM
@@ -11,25 +11,18 @@ GEM
       debug_inspector (>= 0.0.1)
     byebug (8.2.2)
     coderay (1.1.1)
-    coveralls (0.8.10)
+    coveralls (0.8.13)
       json (~> 1.8)
-      rest-client (>= 1.6.8, < 2)
       simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
       tins (~> 1.6.0)
     debug_inspector (0.0.2)
     docile (1.1.5)
-    domain_name (0.5.20160128)
-      unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
     interception (0.5)
     json (1.8.3)
     lex (0.1.0)
     method_source (0.8.2)
-    mime-types (2.99.1)
-    netrc (0.11.0)
     os (0.9.6)
     pry (0.10.3)
       coderay (~> 1.1.0)
@@ -51,10 +44,6 @@ GEM
       pry-rescue
       pry-stack_explorer
     rake (10.5.0)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
     simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
@@ -65,9 +54,6 @@ GEM
       tins (~> 1.0)
     thor (0.19.1)
     tins (1.6.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,47 @@
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-145-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Code Status](http://img.shields.io/codeclimate/github/hopsoft/kvn.svg?style=flat)](https://codeclimate.com/github/hopsoft/kvn)
+[![Dependency Status](http://img.shields.io/gemnasium/hopsoft/kvn.svg?style=flat)](https://gemnasium.com/hopsoft/kvn)
+[![Build Status](http://img.shields.io/travis/hopsoft/kvn.svg?style=flat)](https://travis-ci.org/hopsoft/kvn)
+[![Coverage Status](https://img.shields.io/coveralls/hopsoft/kvn.svg?style=flat)](https://coveralls.io/r/hopsoft/kvn?branch=master)
+[![Downloads](http://img.shields.io/gem/dt/kvn.svg?style=flat)](http://rubygems.org/gems/kvn)
+
 # KVN (kevin)
 
-A [KVN](https://github.com/hopsoft/bighorn#kvn) parser.
+## Key/Value Notation
+
+Similar to JSON but more limited in scope.
+Can be used to represent basic key/value data structures as (human readable) strings.
+
+Useful when working with limited storage options
+to capture additional (human readable) data in a single field.
+
+## Rules
+
+* Data structures should be flat (i.e. 1 level deep, no nesting)
+* Keys & values are limited to primitive types
+
+  * String
+  * Numeric
+  * Boolean
+  * Null
+
+* Colons & semicolons are prohibited in keys & values
+* Keys are sorted alphabetically
+
+## Examples
+
+### Convert a Hash to a KVN string
+
+```ruby
+data = { d: "example with whitespace", a: true, c: "example", b: 1, e: nil }
+Kvn::Converter.new(data).convert
+# => "a:true; b:1; c:example; d:example with whitespace; e:null;"
+```
+
+### Parse a KVN string into a Hash
 
+```ruby
+value = "a:true; b:1; c:example; d:example with whitespace; e:null;"
+Kvn::Parser.new(value).parse
+# => {"a"=>true, "b"=>1, "c"=>"example", "d"=>"example with whitespace", "e"=>nil}
+```

data/lib/kvn.rb

@@ -1,34 +1,21 @@
 require "kvn/version"
-require "kvn/illegal_character_error"
+require "kvn/unsupported_hash_error"
+require "kvn/value_lexer"
 require "kvn/lexer"
+require "kvn/converter"
 require "kvn/parser"
 
 module Kvn
-  class << self
-
-    def parse(value)
-      raise ArgumentError.new("Value is not a valid KVN string!") unless valid?(value)
-      pairs = standardize(value).split(";")
-      pairs.each_with_object({}) do |pair, memo|
-        parts = pair.split(":")
-        memo[parts.first] = parts.last
-      end
-    end
-
-    def valid?(value)
-      value = standardize(value)
-      semicolon_count = value.scan(";").size
-      colon_count = value.scan(":").size
-      return false unless semicolon_count > 0
-      return false unless colon_count > 0
-      return false unless semicolon_count == colon_count
-    end
-
-    private
-
-    def standardize(value)
-      value.to_s.strip
-    end
-
-  end
+  SUPPORTED_VALUE_TYPES = [
+    NilClass,
+    TrueClass,
+    FalseClass,
+    Symbol,
+    String,
+    Integer,
+    Fixnum,
+    Bignum,
+    Float,
+    Rational
+  ]
 end

data/lib/kvn/converter.rb

@@ -0,0 +1,38 @@
+module Kvn
+  class Converter
+    attr_reader :value
+
+    def initialize(value)
+      @value = (value ||= {}).to_h rescue {}
+
+      if invalid_values_present?
+        message = "All values must be a supported type! #{Kvn::SUPPORTED_VALUE_TYPES.join ", "}"
+        raise Kvn::UnsupportedHashError.new(message)
+      end
+    end
+
+    def convert
+      value.keys.sort.each_with_object([]) do |key, memo|
+        v = value[key]
+        v = "null" if v.nil?
+        next if v.to_s.strip.empty?
+        memo << "#{key}:#{v};"
+      end.join(" ")
+    end
+
+    private
+
+    def standardize_value(value)
+      value.to_s.strip
+    end
+
+    def value_types
+      value.values.map(&:class).uniq
+    end
+
+    def invalid_values_present?
+      !(value_types - Kvn::SUPPORTED_VALUE_TYPES).empty?
+    end
+
+  end
+end

data/lib/kvn/lexer.rb

@@ -9,14 +9,14 @@ module Kvn
       :PARTDELIM
     )
 
-    rule :KEY, /(\w|\s)+(?=:)/
-    rule :VALUE, /(\w|\s)+(?=;)/
+    rule :KEY, /\w+(?=:)/
+    rule :VALUE, /[\w+(\s|\.)]+(?=;)/
     rule :PAIRDELIM, /;\s*/
     rule :PARTDELIM, /:/
 
     error do |lexer, token|
-      message = "Illegal character in KVN string! #{token.line}:#{token.column} #{token.value}"
-      raise Kvn::IllegalCharacterError.new(message)
+      message = "Illegal character in KVN string! #{token.line}:#{token.column} <#{token.value}>"
+      raise SyntaxError.new(message)
     end
   end
 end

data/lib/kvn/parser.rb

@@ -1,28 +1,56 @@
 module Kvn
   class Parser
+    attr_reader :value
 
-    def parse(value)
-      parsed = {}
+    def initialize(value)
+      @value = value.to_s.strip
+    end
+
+    def parse
       lexer = Kvn::Lexer.new
-      output = lexer.lex(standardize_value(value))
+      output = lexer.lex(value)
+      {}.tap do |parsed|
+        begin
+          key = nil
+          key_found = false
+          value_found = false
+          while output.peek
+            token = output.next
+            if token.name == :KEY
+              key = token.value
+              key_found = true
+              value_found = false
+            end
+
+            if token.name == :VALUE
+              raise SyntaxError.new("Empty key detected for value! <#{token.value}>") unless key_found
+              parsed[key] = parse_value(token.value)
+              value_found = true
+              key_found = false
+            end
 
-      begin
-        key = nil
-        while output.peek
-          token = output.next
-          key = token.value if token.name == :KEY
-          parsed[key] = token.value if token.name == :VALUE
+            if token.name == :PAIRDELIM && !value_found
+              raise SyntaxError.new("Empty value detected for key! <#{key}>")
+            end
+          end
+        rescue StopIteration
         end
-      rescue StopIteration
       end
-
-      parsed
     end
 
     private
 
-    def standardize_value(value)
-      value.to_s.strip
+    def parse_value(value)
+      lexer = Kvn::ValueLexer.new
+      token = lexer.lex(value).next
+      case token.name
+      when :NIL then value = nil
+      when :TRUE then value = true
+      when :FALSE then value = false
+      when :FLOAT then value = value.to_f
+      when :INTEGER then value = value.to_i
+      else value.to_s
+      end
     end
 
   end

data/lib/kvn/unsupported_hash_error.rb

@@ -0,0 +1,4 @@
+module Kvn
+  class UnsupportedHashError < StandardError
+  end
+end

data/lib/kvn/value_lexer.rb

@@ -0,0 +1,21 @@
+require "lex"
+
+module Kvn
+  class ValueLexer < Lex::Lexer
+    tokens(
+      :NIL,
+      :TRUE,
+      :FALSE,
+      :FLOAT,
+      :INTEGER,
+      :STRING
+    )
+
+    rule :NIL, /null/
+    rule :TRUE, /true/
+    rule :FALSE, /false/
+    rule :FLOAT, /\d+\.\d+/
+    rule :INTEGER, /\d+/
+    rule :STRING, /.*/
+  end
+end

data/lib/kvn/version.rb

@@ -1,3 +1,3 @@
 module Kvn
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kvn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathan Hopkins
@@ -93,9 +93,11 @@ files:
 - README.md
 - Rakefile
 - lib/kvn.rb
-- lib/kvn/illegal_character_error.rb
+- lib/kvn/converter.rb
 - lib/kvn/lexer.rb
 - lib/kvn/parser.rb
+- lib/kvn/unsupported_hash_error.rb
+- lib/kvn/value_lexer.rb
 - lib/kvn/version.rb
 homepage: https://github.com/hopsoft/kvn
 licenses:
@@ -120,5 +122,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: KVN (kevin) parser
+summary: KVN key/value notation converter & parser
 test_files: []

data/lib/kvn/illegal_character_error.rb

@@ -1,4 +0,0 @@
-module Kvn
-  class IllegalCharacterError < StandardError
-  end
-end