figtree 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1233d1fd9829365dc29dc2ed44b73634c7c4cfa6
-  data.tar.gz: 44fba04a7b4c08a88f1c4d20e0464d0d25643ab8
+  metadata.gz: 63e43d9d640143445c0baa5ce76f59f481866607
+  data.tar.gz: b4c3ccea33953ee1838e753143359692b4ffed8a
 SHA512:
-  metadata.gz: f0ff4a80575eeea798dfe2a2adeee750f614428d866f160a3bb4f7cae001f797e9aedf671496102b18b67738f2f29e4464d2ee02d4a6882759ec852b30355c13
-  data.tar.gz: d5c9d8a28065b65c74a976a47e5a67215418fa8ba8437a289db1f83a12b08355c9ca7f00596cf29709873af0c31537c049dba6d97fa2526443545c38bf36a5d6
+  metadata.gz: 2f32e3781ea27fd6dbe637585e2d5da867f0f7a3dfe7650c5a10321ead9637760f083ef58aeece560d2146d7ca4aeb8093b061df3fc3374e9030b97766e2d91a
+  data.tar.gz: 91d3553cf4acbc18dfd38bdf687583cdfd77dc7ced185618c52d1ac04d87436059c63f792959a5a759a7468d3727d55f78d6344356c4fe6159e0d6c2c2c015d2

data/Gemfile.lock

@@ -2,15 +2,24 @@ PATH
   remote: .
   specs:
     figtree (0.0.1)
-      parslet
+      parslet (~> 1.7)
+      wannabe_bool (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     blankslate (3.1.3)
+    coderay (1.1.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
+    method_source (0.8.2)
     parslet (1.7.1)
       blankslate (>= 2.0, <= 4.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -24,13 +33,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    wannabe_bool (0.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   figtree!
-  rspec (>= 3.0.0)
+  pry
+  rspec (~> 3.0, >= 3.0.0)
+  simplecov (~> 0.10)
 
 BUNDLED WITH
    1.10.6

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alex Moore - Niemi
+
+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

@@ -1,6 +1,8 @@
-# Figtree
+# Figtree 🌳
 ## about
-A parser and transformer for loading `.ini` files into Ruby dot notation accessible objects. `.ini` is not a standardized format. But the parser and transformer are easy to extend, unlike regex. :)
+A parser and transformer for loading `.ini` files into Ruby dot notation accessible objects. `.ini` is not a standardized format. But the parser and transformer are easy to extend, unlike regex. :) And it's at 100% LOC coverage.
+
+If the `.ini` file is invalid, an error will be raised, with the line and char position of the error. If you extend this gem to have more rules, and one of those rules fails to transform, you will have an error raised.
 
 ## performance
 A typical `.ini` file takes slightly less than 0.02s to be parsed, transformed, and loaded.
@@ -13,16 +15,28 @@ A typical `.ini` file takes slightly less than 0.02s to be parsed, transformed,
     config = Figtree.load_config('spec/support/settings.conf')
     config.common.basic_size_limit
     => 26214400
+    # also good
+    config[:common]["paid_users_size_limit"]
+    => 2147483648
+    # also also good :)
+    config.common[:paid_users_size_limit]
+    => 2147483648
+    # and overrides? we got overrides
+    overridden_config = Figtree.load_config('spec/support/settings.conf', [:production])
+    config.ftp.path
+    => "/tmp/"
+    overridden_config.ftp.path
+    => "/srv/var/tmp/"
 
-# development
-## installation
+## development
+### installation
 `bundle install`
 
-## tests
+### tests
 `rspec spec/`
 
-### TODO
-- refactor marked TODO listings in files (mostly refactoring to generic)
-- allow indifferent access? (not just dot notation but allow hash access)
-- add more unit test coverage to Transformer
-- seems like Parslet doesn't have a `TransformFailed` error format, worth adding one?
+#### TODO
+- give char/line position of transformer failures
+- change method signature from Module.class_method to just IniConfig.new(IOObject) ?
+- change override to be single symbol rather than array (do we ever need multiples?)
+- refactor marked TODO listings in files (mostly refactoring to generic in Transformer)

data/figtree.gemspec

@@ -2,11 +2,12 @@ $:.push File.expand_path("../lib", __FILE__)
 require "figtree/version"
 
 Gem::Specification.new do |gem|
-  gem.name    = 'figtree'
-  gem.version = Figtree::VERSION
-  gem.date    = Date.today.to_s
+  gem.name     = 'figtree'
+  gem.version  = Figtree::VERSION
+  gem.date     = Date.today.to_s
+  gem.licenses = ['MIT']
 
-  gem.summary = "A parser and transformer for loading `.ini` files into Ruby dot notation accessible objects."
+  gem.summary     = "A parser and transformer for loading `.ini` files into Ruby dot notation accessible objects."
   gem.description = "See README.md"
 
   gem.authors  = ['Alex Moore-Niemi']
@@ -14,7 +15,10 @@ Gem::Specification.new do |gem|
   gem.homepage = 'https://github.com/mooreniemi/figtree'
 
   gem.add_runtime_dependency 'parslet', '~> 1.7'
+  gem.add_runtime_dependency 'wannabe_bool', '~> 0.2'
   gem.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  gem.add_development_dependency 'simplecov', '~> 0.10'
+  gem.add_development_dependency 'pry', '~> 0.10'
 
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/figtree/ini_config.rb

@@ -1,10 +1,7 @@
 require 'ostruct'
 module Figtree
   class IniConfig < OpenStruct
-    def initialize(array = [])
-      # TODO move the reduction to #load_config
-      # TODO then this class can be a shell
-      super(array.reduce({}, :merge))
-    end
+  end
+  class Subgroup < OpenStruct
   end
 end

data/lib/figtree/transformer.rb

@@ -1,64 +1,66 @@
 require 'parslet'
 require 'ostruct'
+require 'wannabe_bool'
 
 module Figtree
-  # once you have an AST, you can do type transformations
+  # a transformer takes a parsed, valid AST and applies rules, usually
+  # in a context free manner
   class Transformer < Parslet::Transform
-    attr_accessor :overrides
-
-    def initialize(overrides = [], &block)
-      @overrides = overrides
-      super(&block)
-    end
-
     # TODO these could largely be consolidated with some rearrangement
-    # TODO subtree is considered too flexible, switch to simple(:x)?
-    rule(:snake_case_key => simple(:key), :number => subtree(:value)) do
+    # 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), :array => subtree(:value)) do
+    rule(:snake_case_key => simple(:key), :string => simple(:value)) do
       {
-        key.to_sym => Array(value)
+        key.to_sym => String(value)
       }
     end
-    rule(:snake_case_key => simple(:key), :string => subtree(:value)) do
+    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
       {
-        # Boolean(value) fails
-        key.to_sym => String(value)
+        key.to_sym => String(value).to_b
       }
     end
-    rule(:snake_case_key => simple(:key), :file_path => subtree(:value)) do
+    rule(:snake_case_key => simple(:key), :array => simple(:value)) do
       {
-        key.to_sym => String(value)
+        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
+
+    # 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(:a),
-      :optional_key => subtree(:b),
-      :file_path => subtree(:c)
+      :key_to_be_overridden => subtree(:overridden_key),
+      :optional_key => subtree(:overriding_key),
+      :file_path => subtree(:new_file_path),
     ) do
-      if !@overrides.nil? && @overrides.include?(b[:snake_case_key])
+      if overrides.include?(overriding_key[:snake_case_key].to_sym)
         {
-          a[:snake_case_key] => String(c)
+          overridden_key[:snake_case_key] => String(new_file_path)
         }
       else
         {
         }
       end
     end
-    rule(:group => subtree(:group_members)) do
-      group_title = group_members[0][:group_title].to_sym
-      group_values = OpenStruct.new(group_members[1..-1].reduce({}, :merge))
-      {
-        group_title => group_values
-      }
-    end
   end
 end

data/lib/figtree/version.rb

@@ -1,3 +1,3 @@
 module Figtree
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/figtree.rb

@@ -4,13 +4,14 @@ require 'figtree/ini_config'
 
 module Figtree
   def self.load_config(file_path, overrides=[])
+    parsed_subgroups = figgy_transform(
+      figgy_parse(
+        File.read(file_path)
+      ),
+      overrides
+    )
     IniConfig.new(
-      figgy_transform(
-        figgy_parse(
-          File.read(file_path)
-        ),
-        overrides
-      )
+      parsed_subgroups.reduce({}, :merge!)
     )
   end
 
@@ -18,13 +19,21 @@ module Figtree
   def self.figgy_parse(str)
     Parser.new.parse(str)
   rescue Parslet::ParseFailed => failure
-    puts failure.cause.ascii_tree
+    STDERR.puts "\nInvalid ini file.\n" +
+      "Error: #{failure.cause.ascii_tree}" +
+      "Please correct the file and retry."
+      raise
   end
 
   def self.figgy_transform(tree, overrides = [])
-    Transformer.new(overrides).apply(tree)
-  rescue
-    puts 'failed transform'
-    {} # returning hash just to preserve stack trace
+    Transformer.new.apply(tree, overrides: overrides)
+  rescue => e
+    STDERR.puts "\nInvalid transformation rule.\n" +
+      "Error: #{e}" +
+      "Please correct your transformer rule and retry."
+    raise TransformFailed
+  end
+
+  class TransformFailed < Exception
   end
 end

data/spec/figtree/transformer_spec.rb

@@ -2,17 +2,57 @@ require 'spec_helper'
 
 module Figtree
   describe Transformer do
-    let(:tree) do
-      Parser.new.parse("[common]\nbasic_size_limit = 26214400\n")
+    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
-    it 'can apply an int type conversion' do
-      expect(Transformer.new.apply(tree)).to eq(
-        [
-          {
-            common: OpenStruct.new({basic_size_limit: 26214400})
-          }
-        ]
-      )
+    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, overrides: [:production])).to eq(
+          [
+            {
+              http: Subgroup.new(path: '/srv/var/tmp/')
+            }
+          ]
+        )
+      end
     end
   end
 end

data/spec/figtree_spec.rb

@@ -6,7 +6,7 @@ describe Figtree do
   describe '#load_config' do
     let(:settings_path) { 'spec/support/settings.conf' }
     let(:common) do
-      OpenStruct.new(
+      Figtree::Subgroup.new(
         :basic_size_limit => 26214400,
         :student_size_limit => 52428800,
         :paid_users_size_limit => 2147483648,
@@ -15,11 +15,11 @@ describe Figtree do
     end
 
     let(:common_with_override) do
-      OpenStruct.new(
+      Figtree::Subgroup.new(
         :basic_size_limit => 26214400,
         :student_size_limit => 52428800,
         :paid_users_size_limit => 2147483648,
-        :path => "/srv/var/tmp/",
+        :path => "/srv/tmp/",
       )
     end
 
@@ -27,7 +27,7 @@ describe Figtree do
       Figtree::IniConfig.new(
         [
           {
-            common: OpenStruct.new(
+            common: Figtree::Subgroup.new(
               {
                 :basic_size_limit => 26214400,
                 :student_size_limit=> 52428800,
@@ -37,24 +37,24 @@ describe Figtree do
             )
           },
           {
-            ftp: OpenStruct.new(
+            ftp: Figtree::Subgroup.new(
               {
                 :name => "hello there, ftp uploading",
                 :path => "/tmp/",
-                :enabled => "no"
+                :enabled => false
               }
             )
           },
           {
-            http: OpenStruct.new(
+            http: Figtree::Subgroup.new(
               {
                 :name => "http uploading",
                 :path => "/tmp/",
-                :params => ["array,of,values"]
+                :params => ["array", "of", "values"]
               }
             )
           }
-        ]
+        ].reduce({}, :merge!)
       )
     end
 
@@ -69,12 +69,29 @@ describe Figtree do
       expect(Figtree.load_config(settings_path)).to eq(the_whole_kebab)
     end
 
-    it 'can parse the whole ini file quickly' do
-      expect(
-        Benchmark.realtime do
-          Figtree.load_config(settings_path)
-        end
-      ).to be < 0.02
+    context "performance" do
+      it 'can parse the whole ini file quickly' do
+        expect(
+          Benchmark.realtime do
+            Figtree.load_config(settings_path)
+          end
+        ).to be < 0.014
+      end
+    end
+
+    context "invalid ini file" do
+      let(:unparseable_config) { 'spec/support/unparseable_settings.conf' }
+      let(:untransformable_config) { 'spec/support/untransformable_settings.conf' }
+      it 'throws ParseFailed if unparseable' do
+        expect { Figtree.load_config(unparseable_config) }.
+          to raise_error(Parslet::ParseFailed)
+      end
+      it 'throws TransformFailed if untransformable' do
+        allow_any_instance_of(String).to receive(:to_b).
+          and_raise(StandardError)
+        expect { Figtree.load_config(untransformable_config) }.
+          to raise_error(Figtree::TransformFailed)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,19 @@
 require 'bundler/setup'
 Bundler.setup
 
+require 'pry'
 require 'ostruct'
 require 'parslet'
 require 'parslet/rig/rspec'
 
+require 'simplecov'
+SimpleCov.start
+
 Dir[File.join(File.dirname(__FILE__), "..", "lib" , "**.rb")].each do |file|
   require file
 end
 
 RSpec.configure do |config|
+  # quiet output from figtree_spec invalid ini context
+  config.before { allow($stderr).to receive(:puts) }
 end

data/spec/support/unparseable_settings.conf

@@ -0,0 +1,4 @@
+common]
+basic_size_limit: 26214400
+student_size_limit is 52428800
+paid_users_size_limit 2147483648

data/spec/support/untransformable_settings.conf

@@ -0,0 +1,2 @@
+[heading]
+enabled = no

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: figtree
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Moore-Niemi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2015-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: wannabe_bool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +58,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: See README.md
 email: moore.niemi@gmail.com
 executables: []
@@ -54,6 +96,7 @@ files:
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- MIT-LICENSE
 - README.md
 - figtree.gemspec
 - lib/figtree.rb
@@ -66,8 +109,11 @@ files:
 - spec/figtree_spec.rb
 - spec/spec_helper.rb
 - spec/support/settings.conf
+- spec/support/unparseable_settings.conf
+- spec/support/untransformable_settings.conf
 homepage: https://github.com/mooreniemi/figtree
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -96,4 +142,6 @@ test_files:
 - spec/figtree_spec.rb
 - spec/spec_helper.rb
 - spec/support/settings.conf
+- spec/support/unparseable_settings.conf
+- spec/support/untransformable_settings.conf
 has_rdoc: