figtree 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6b5da9f31e285ace11997fa8066b4fb9926ad3a
-  data.tar.gz: 1c11bdf776b084922e35c782e9737d3275f32ddd
+  metadata.gz: 027349cba07d928b55c539c415a8677994c2ad4f
+  data.tar.gz: 2f16fbdf432e44763f6d07fee7d56f31a96f1b72
 SHA512:
-  metadata.gz: b515887114e72ca380c854619e5596e2027d7f120c372ff1c2e48b03d35a6bcd50cfa792dac15c435ac7a7639844bab810b95a7813bba4bbffc2e722653c80b6
-  data.tar.gz: 7ccf9fb5da3a512f019c37652ed680f64b502beee938974a560a7b2c25dd5e8bfd1a6a8d414787e3df354a17038d3a705907c61c9709da6b5e64c465372e5c75
+  metadata.gz: 70cd81c1f602ddb2b8e845958ad005592c663abb8fe5d7b85a69a4db618fea5408b11312013484ec49cd42595f3495869c30a3bf48483acf8af352eab220e0d1
+  data.tar.gz: 3cc856774fb2130c8152e24e25e63b2f5561a9eea951fccffeb2f906c9d752072a3e1e06fc260b43a761c06a3e032810e802eac0389b701eda69119ba6bfb5bf

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+- Version 0.0.1: initial set up
+- Version 0.0.2: some bug fixes, overrides
+- Version 1.0.0: moving away from #load_conifg to just #new
+- Version 1.0.1: refactoring in IniConfig
+- Version 1.2.0: adding support for pre-group comments and ip addresses

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    figtree (1.0.0)
+    figtree (1.2.0)
       parslet (~> 1.7)
       wannabe_bool (~> 0.2)
 

data/lib/figtree/ip_rules.rb

@@ -0,0 +1,85 @@
+# from https://github.com/kschiess/parslet/blob/master/example/ip_address.rb
+module Figtree
+	# Must be used in concert with IPv4
+	module IPv6
+		include Parslet
+
+		rule(:colon) { str(':') }
+		rule(:dcolon) { colon >> colon }
+
+		# h16 :
+		def h16r(times)
+			(h16 >> colon).repeat(times, times)
+		end
+
+		# : h16
+		def h16l(times)
+			(colon >> h16).repeat(0,times)
+		end
+
+		# A 128-bit IPv6 address is divided into eight 16-bit pieces. Each piece is
+		# represented numerically in case-insensitive hexadecimal, using one to four
+		# hexadecimal digits (leading zeroes are permitted). The eight encoded
+		# pieces are given most-significant first, separated by colon characters.
+		# Optionally, the least-significant two pieces may instead be represented in
+		# IPv4 address textual format. A sequence of one or more consecutive
+		# zero-valued 16-bit pieces within the address may be elided, omitting all
+		# their digits and leaving exactly two consecutive colons in their place to
+		# mark the elision.
+		rule(:ipv6) {
+			(
+				(
+					h16r(6) |
+					dcolon >> h16r(5) |
+					h16.maybe >> dcolon >> h16r(4) |
+					(h16 >> h16l(1)).maybe >> dcolon >> h16r(3) |
+					(h16 >> h16l(2)).maybe >> dcolon >> h16r(2) |
+					(h16 >> h16l(3)).maybe >> dcolon >> h16r(1) |
+					(h16 >> h16l(4)).maybe >> dcolon
+				) >> ls32 |
+				(h16 >> h16l(5)).maybe >> dcolon >> h16 |
+				(h16 >> h16l(6)).maybe >> dcolon
+			).as(:ipv6)
+		}
+
+		rule(:h16) {
+			hexdigit.repeat(1,4)
+		}
+
+		rule(:ls32) {
+			(h16 >> colon >> h16) |
+			ipv4
+		}
+
+		rule(:hexdigit) {
+			digit | match("[a-fA-F]")
+		}
+	end
+
+	module IPv4
+		include Parslet
+
+		# A host identified by an IPv4 literal address is represented in
+		# dotted-decimal notation (a sequence of four decimal numbers in the range 0
+		# to 255, separated by "."), as described in [RFC1123] by reference to
+		# [RFC0952].  Note that other forms of dotted notation may be interpreted on
+		# some platforms, as described in Section 7.4, but only the dotted-decimal
+		# form of four octets is allowed by this grammar.
+		rule(:ipv4) {
+			(dec_octet >> str('.') >> dec_octet >> str('.') >>
+			 dec_octet >> str('.') >> dec_octet).as(:ipv4)
+		}
+
+		rule(:dec_octet) {
+			str('25') >> match("[0-5]") |
+			str('2') >> match("[0-4]") >> digit |
+			str('1') >> digit >> digit |
+			match('[1-9]') >> digit |
+			digit
+		}
+
+		rule(:digit) {
+			match('[0-9]')
+		}
+	end
+end

data/lib/figtree/parser.rb

@@ -1,21 +1,29 @@
 require 'parslet'
+require 'figtree/ip_rules'
 
 module Figtree
   # ConFIG into a Tree :)
   class Parser < Parslet::Parser
+    include IPv4
+    include IPv6
+
     rule(:eof) { any.absent? }
     rule(:group_title) { match('[a-zA-Z]').repeat(1) }
-    rule(:newline)  { match("\\n").repeat(1) >> match("\\r").maybe }
-    rule(:space) { match('\s').repeat(0) }
+    rule(:space) { match("\s").repeat(0) }
+    rule(:newline) { match("\n") >> match("\r").maybe }
+
     rule(:grouper) do
+      newline.maybe >>
       str('[') >>
       group_title.as(:group_title) >>
       str(']')
     end
 
     rule(:comment) do
-      str(';') >>
-      (newline.absent? >> any).repeat
+      # comments go uncaptured
+      (str(';') >>
+       (newline.absent? >> any).repeat) >>
+      newline.maybe
     end
 
     rule(:string) do
@@ -25,6 +33,7 @@ module Figtree
     end
 
     rule(:boolean) do
+      # expand this check
       (str('no') | str('yes')).as(:boolean)
     end
 
@@ -32,6 +41,10 @@ module Figtree
       match('[0-9]').repeat(1).as(:number)
     end
 
+    rule(:ip_address) do
+      (ipv4 | ipv6).as(:ip_address)
+    end
+
     rule(:array) do
       (match('[a-zA-Z]').repeat(1) >>
        (str(',') >>
@@ -59,7 +72,16 @@ module Figtree
       space >>
       str("=") >>
       space >>
-      (number | boolean | array | snake_case_key | file_path | string)
+      # this ordering matters
+      # we are roughly moving from more
+      # to less specific
+      (ip_address |
+       number |
+       boolean |
+       array |
+       snake_case_key |
+       file_path |
+       string)
     end
 
     rule(:override_assignment) do
@@ -86,6 +108,12 @@ module Figtree
       repeat.maybe
     end
 
-    root(:group)
+    rule(:comment_or_group) do
+      comment.maybe >>
+      newline.maybe >>
+      group.maybe
+    end
+
+    root(:comment_or_group)
   end
 end

data/lib/figtree/transformer.rb

@@ -1,66 +1,74 @@
 require 'parslet'
 require 'ostruct'
+require 'ipaddr'
 require 'wannabe_bool'
 
 module Figtree
-  # a transformer takes a parsed, valid AST and applies rules, usually
-  # in a context free manner
-  class Transformer < Parslet::Transform
-    # TODO these could largely be consolidated with some rearrangement
-    # these are all type conversions
-    rule(:snake_case_key => simple(:key), :number => simple(:value)) do
-      {
-        key.to_sym => Integer(value)
-      }
-    end
-    rule(:snake_case_key => simple(:key), :string => simple(:value)) do
-      {
-        key.to_sym => String(value)
-      }
-    end
-    rule(:snake_case_key => simple(:key), :file_path => simple(:value)) do
-      {
-        key.to_sym => String(value)
-      }
-    end
-    # depends on wannabe_bool refining String class
-    rule(:snake_case_key => simple(:key), :boolean => simple(:value)) do
-      {
-        key.to_sym => String(value).to_b
-      }
-    end
-    rule(:snake_case_key => simple(:key), :array => simple(:value)) do
-      {
-        key.to_sym => String(value).split(",")
-      }
-    end
+	# a transformer takes a parsed, valid AST and applies rules, usually
+	# in a context free manner
+	class Transformer < Parslet::Transform
+		# TODO these could largely be consolidated with some rearrangement
+		# these are all type conversions
+		rule(:snake_case_key => simple(:key), :number => simple(:value)) do
+			{
+				key.to_sym => Integer(value)
+			}
+		end
+		rule(:snake_case_key => simple(:key), :string => simple(:value)) do
+			{
+				key.to_sym => String(value)
+			}
+		end
+		rule(:snake_case_key => simple(:key), :file_path => simple(:value)) do
+			{
+				key.to_sym => String(value)
+			}
+		end
+		# depends on wannabe_bool refining String class
+		rule(:snake_case_key => simple(:key), :boolean => simple(:value)) do
+			{
+				key.to_sym => String(value).to_b
+			}
+		end
+		rule(:snake_case_key => simple(:key), :array => simple(:value)) do
+			{
+				key.to_sym => String(value).split(",")
+			}
+		end
 
-    # ini files are trees of a fixed height, if the file handle is the root
-    # subgroups are its children, and subgroup members are the next level of children
-    rule(:group => subtree(:group_members)) do
-      group_title = group_members[0][:group_title].to_sym
-      group_values = Subgroup.new(group_members[1..-1].reduce({}, :merge!))
-      {
-        group_title => group_values
-      }
-    end
+		rule(:snake_case_key => simple(:key), :ip_address => subtree(:value)) do
+			# right now we're not distinguishing what kind of ip it is
+			{
+				key.to_sym => IPAddr.new((value.values.first.to_s))
+			}
+		end
 
-    # where does overrides come from? an argument into #apply on
-    # Transformer, that allows an additional capture outside the AST
-    # to be added to the context of the transform
-    rule(
-      :key_to_be_overridden => subtree(:overridden_key),
-      :optional_key => subtree(:overriding_key),
-      :file_path => subtree(:new_file_path),
-    ) do
-      if override.to_sym == overriding_key[:snake_case_key].to_sym
-        {
-          overridden_key[:snake_case_key] => String(new_file_path)
-        }
-      else
-        {
-        }
-      end
-    end
-  end
+		# ini files are trees of a fixed height, if the file handle is the root
+		# subgroups are its children, and subgroup members are the next level of children
+		rule(:group => subtree(:group_members)) do
+			group_title = group_members[0][:group_title].to_sym
+			group_values = Subgroup.new(group_members[1..-1].reduce({}, :merge!))
+			{
+				group_title => group_values
+			}
+		end
+
+		# where does overrides come from? an argument into #apply on
+		# Transformer, that allows an additional capture outside the AST
+		# to be added to the context of the transform
+		rule(
+			:key_to_be_overridden => subtree(:overridden_key),
+			:optional_key => subtree(:overriding_key),
+			:file_path => subtree(:new_file_path),
+		) do
+			if override.to_sym == overriding_key[:snake_case_key].to_sym
+				{
+					overridden_key[:snake_case_key] => String(new_file_path)
+				}
+			else
+				{
+				}
+			end
+		end
+	end
 end

data/lib/figtree/version.rb

@@ -1,3 +1,5 @@
 module Figtree
-  VERSION = "1.0.1"
+	# for reference see
+	# http://guides.rubygems.org/patterns/#semantic-versioning
+  VERSION = "1.2.0"
 end

data/spec/figtree/parser_spec.rb

@@ -10,7 +10,13 @@ module Figtree
       expect(parser.grouper).to parse('[common]')
     end
     it 'can parse comments' do
-      expect(parser.comment).to parse('; This is a comment\n')
+      expect(parser.comment).to parse("; This is a comment\n")
+      expect(parser.comment).to parse("; last modified 1 April 2001 by John Doe\n")
+      comment_first = File.open('spec/support/wiki_example.ini', &:readline)
+      expect(parser.comment).to parse(comment_first)
+    end
+    it 'can parse comments then groups' do
+      expect(parser.comment_or_group).to parse("; comment\n[groop]\nassignment = present")
     end
     it 'can parse snake_case keys' do
       expect(parser.snake_case_key).to parse('basic_size_limit')
@@ -29,6 +35,13 @@ module Figtree
     it 'can parse numbers' do
       expect(parser.number).to parse("26214400")
     end
+    it 'can parse ip addresses' do
+      expect(parser.ip_address).to parse("FE80:0000:0000:0000:0202:B3FF:FE1E:8329")
+      expect(parser.ip_address).to parse('111.222.3.4')
+			expect(parser.ip_address).to parse('192.0.2.62')
+      expect(parser.ip_address).to_not parse('f11.222.3.4')
+      expect(parser.ip_address).to_not parse('111.222.3')
+    end
     it 'can parse booleans flexibly' do
       expect(parser.boolean).to parse("no")
       expect(parser.boolean).to parse("yes")

data/spec/figtree/transformer_spec.rb

@@ -1,58 +1,70 @@
 require 'spec_helper'
 
 module Figtree
-  describe Transformer do
-    context "can do type conversion" do
-      let(:int_tree) do
-        Parser.new.parse("[common]\nbasic_size_limit = 26214400\n")
-      end
-      let(:arr_tree) do
-        Parser.new.parse("[http]\nparams = array,of,values\n")
-      end
-      let(:bool_tree) do
-        Parser.new.parse("[ftp]\nenabled = no\n")
-      end
-      it 'can apply an int type conversion' do
-        expect(Transformer.new.apply(int_tree)).to eq(
-          [
-            {
-              common: Subgroup.new({basic_size_limit: 26214400})
-            }
-          ]
-        )
-      end
-      it 'can apply an array type conversion' do
-        expect(Transformer.new.apply(arr_tree)).to eq(
-          [
-            {
-              http: Subgroup.new(params: ["array", "of", "values"])
-            }
-          ]
-        )
-      end
-      it 'can apply a bool type conversion' do
-        expect(Transformer.new.apply(bool_tree)).to eq(
-          [
-            {
-              ftp: Subgroup.new(enabled: false)
-            }
-          ]
-        )
-      end
-    end
-    context "overrides by angle brackets" do
-      let(:override_tree) do
-        Parser.new.parse("[http]\npath = /srv/\npath<production> = /srv/var/tmp/\n")
-      end
-      it 'can apply an override' do
-        expect(Transformer.new.apply(override_tree, override: :production)).to eq(
-          [
-            {
-              http: Subgroup.new(path: '/srv/var/tmp/')
-            }
-          ]
-        )
-      end
-    end
-  end
+	describe Transformer do
+		context "can do type conversion" do
+			let(:int_tree) do
+				Parser.new.parse("[common]\nbasic_size_limit = 26214400\n")
+			end
+			let(:arr_tree) do
+				Parser.new.parse("[http]\nparams = array,of,values\n")
+			end
+			let(:bool_tree) do
+				Parser.new.parse("[ftp]\nenabled = no\n")
+			end
+			let(:ip_tree) do
+				Parser.new.parse("[database]\nserver=192.0.2.62")
+			end
+			it 'can apply an int type conversion' do
+				expect(Transformer.new.apply(int_tree)).to eq(
+					[
+						{
+							common: Subgroup.new({basic_size_limit: 26214400})
+						}
+					]
+				)
+			end
+			it 'can apply an array type conversion' do
+				expect(Transformer.new.apply(arr_tree)).to eq(
+					[
+						{
+							http: Subgroup.new(params: ["array", "of", "values"])
+						}
+					]
+				)
+			end
+			it 'can apply a bool type conversion' do
+				expect(Transformer.new.apply(bool_tree)).to eq(
+					[
+						{
+							ftp: Subgroup.new(enabled: false)
+						}
+					]
+				)
+			end
+			it 'it can apply an ip address type conversion' do
+				expect(Transformer.new.apply(ip_tree)).to eq(
+					[
+						{
+							database: Subgroup.new(server: IPAddr.new("192.0.2.62"))
+						}
+					]
+				)
+			end
+		end
+		context "overrides by angle brackets" do
+			let(:override_tree) do
+				Parser.new.parse("[http]\npath = /srv/\npath<production> = /srv/var/tmp/\n")
+			end
+			it 'can apply an override' do
+				expect(Transformer.new.apply(override_tree, override: :production)).to eq(
+					[
+						{
+							http: Subgroup.new(path: '/srv/var/tmp/')
+						}
+					]
+				)
+			end
+		end
+	end
 end

data/spec/figtree_spec.rb

@@ -69,13 +69,19 @@ describe Figtree do
       expect(Figtree::IniConfig.new(settings_path)).to eq(the_whole_kebab)
     end
 
+    it 'can parse the wiki example' do
+			wiki_example = Figtree::IniConfig.new('spec/support/wiki_example.ini')
+      expect(wiki_example.database.server).to_not be_nil
+    end
+
     context "performance" do
       it 'can parse the whole ini file quickly' do
         expect(
           Benchmark.realtime do
             Figtree::IniConfig.new(settings_path)
           end
-        ).to be < 0.014
+        ).to be < 0.025
+				# without ip_address parsing this was under 0.014 :(
       end
     end
 

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'pry'
 require 'ostruct'
 require 'parslet'
 require 'parslet/rig/rspec'
+require 'parslet/convenience'
 
 require 'simplecov'
 SimpleCov.start

data/spec/support/wiki_example.ini

@@ -0,0 +1,10 @@
+; last modified 1 April 2001 by John Doe
+[owner]
+name="John Doe"
+organization="Acme Widgets Inc."
+
+[database]
+; use IP address in case network name resolution is not working
+server=192.0.2.62
+port=143
+file="payroll.dat"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: figtree
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex Moore-Niemi
@@ -94,6 +94,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -101,6 +102,7 @@ files:
 - figtree.gemspec
 - lib/figtree.rb
 - lib/figtree/ini_config.rb
+- lib/figtree/ip_rules.rb
 - lib/figtree/parser.rb
 - lib/figtree/transformer.rb
 - lib/figtree/version.rb
@@ -111,6 +113,7 @@ files:
 - spec/support/settings.conf
 - spec/support/unparseable_settings.conf
 - spec/support/untransformable_settings.conf
+- spec/support/wiki_example.ini
 homepage: https://github.com/mooreniemi/figtree
 licenses:
 - MIT
@@ -144,4 +147,5 @@ test_files:
 - spec/support/settings.conf
 - spec/support/unparseable_settings.conf
 - spec/support/untransformable_settings.conf
+- spec/support/wiki_example.ini
 has_rdoc: