figtree 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63e43d9d640143445c0baa5ce76f59f481866607
-  data.tar.gz: b4c3ccea33953ee1838e753143359692b4ffed8a
+  metadata.gz: 011a21ea2c8dfbe34b870ef195349235aa1effa3
+  data.tar.gz: 0835b757e33b0b33b30640fe95de3deaedae8f9d
 SHA512:
-  metadata.gz: 2f32e3781ea27fd6dbe637585e2d5da867f0f7a3dfe7650c5a10321ead9637760f083ef58aeece560d2146d7ca4aeb8093b061df3fc3374e9030b97766e2d91a
-  data.tar.gz: 91d3553cf4acbc18dfd38bdf687583cdfd77dc7ced185618c52d1ac04d87436059c63f792959a5a759a7468d3727d55f78d6344356c4fe6159e0d6c2c2c015d2
+  metadata.gz: 38e21385476ad11e06a20553893c11271086056959d4613022b123bc64ecdf44653f79824ff611305c89655a75e3cbf1d1ac83b3017fb962823db7c9ded00a80
+  data.tar.gz: 86199767fdb013c40f4e9c769e394e76c98234b5e32fec12800507fcbee22ab6fd2e0e093bdfdb774ea78866274140fc31ea556021c2ba29118e7f2122c64e89

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    figtree (0.0.1)
+    figtree (1.0.0)
       parslet (~> 1.7)
       wannabe_bool (~> 0.2)
 
@@ -46,7 +46,7 @@ PLATFORMS
 
 DEPENDENCIES
   figtree!
-  pry
+  pry (~> 0.10)
   rspec (~> 3.0, >= 3.0.0)
   simplecov (~> 0.10)
 

data/README.md

@@ -1,18 +1,32 @@
-# Figtree 🌳
+                  %%%,%%%%%%%
+                   ,'%% \\-*%%%%%%%
+             ;%%%%%*%   _%%%%"
+              ,%%%       \(_.*%%%%.
+              % *%%, ,%%%%*(    '
+            %^     ,*%%% )\|,%%*%,_
+                 *%    \/ #).-"*%%*
+                     _.) ,/ *%,
+             _________/)#(_____________
+#### art by [b'ger](http://ascii.co.uk/art/tree)
+
+# 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. :) 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.
 
+## disambiguation
+Looking for the graphical viewer of phyllogenic trees? You want this other [Figtree](http://tree.bio.ed.ac.uk/software/figtree/).
+
 ## performance
-A typical `.ini` file takes slightly less than 0.02s to be parsed, transformed, and loaded.
+A typical `.ini` file takes slightly less than 0.02s to be parsed, transformed, and loaded. Currently, the whole `.ini` file is read into memory at once. The assumption being these files should not typically be too big. But future minor versions might move to line by line ingestion.
 
 ## installation
 `gem install figtree`
 
 ## usage
     require 'figtree'
-    config = Figtree.load_config('spec/support/settings.conf')
+    config = Figtree::IniConfig.new('spec/support/settings.conf')
     config.common.basic_size_limit
     => 26214400
     # also good
@@ -22,7 +36,7 @@ A typical `.ini` file takes slightly less than 0.02s to be parsed, transformed,
     config.common[:paid_users_size_limit]
     => 2147483648
     # and overrides? we got overrides
-    overridden_config = Figtree.load_config('spec/support/settings.conf', [:production])
+    overridden_config = Figtree::IniConfig.new('spec/support/settings.conf', :production)
     config.ftp.path
     => "/tmp/"
     overridden_config.ftp.path
@@ -36,7 +50,6 @@ A typical `.ini` file takes slightly less than 0.02s to be parsed, transformed,
 `rspec spec/`
 
 #### TODO
+- move way from needing to parse whole file at once? (move to `IO.foreach` ?)
 - 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/lib/figtree.rb

@@ -1,39 +1,3 @@
 require 'figtree/parser'
 require 'figtree/transformer'
 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(
-      parsed_subgroups.reduce({}, :merge!)
-    )
-  end
-
-  private
-  def self.figgy_parse(str)
-    Parser.new.parse(str)
-  rescue Parslet::ParseFailed => failure
-    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.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/lib/figtree/ini_config.rb

@@ -1,7 +1,46 @@
 require 'ostruct'
 module Figtree
   class IniConfig < OpenStruct
+    def initialize(ini, override = :none)
+      # cheat to allow a parsed hash in
+      if ini.is_a?(Hash)
+        parsed_subgroups = ini
+      else
+        parsed_subgroups = figgy_transform(
+          figgy_parse(
+            File.read(ini)
+          ),
+          override
+        ).reduce({}, :merge!)
+      end
+      super(
+        parsed_subgroups
+      )
+    end
+
+    private
+    def figgy_parse(str)
+      Parser.new.parse(str)
+    rescue Parslet::ParseFailed => failure
+      STDERR.puts "\nInvalid ini file.\n" +
+        "Error: #{failure.cause.ascii_tree}" +
+        "Please correct the file and retry."
+        raise
+    end
+
+    def figgy_transform(tree, override)
+      Transformer.new.apply(tree, override: override)
+    rescue => e
+      STDERR.puts "\nInvalid transformation rule.\n" +
+        "Error: #{e}" +
+        "Please correct your transformer rule and retry."
+        raise TransformFailed
+    end
   end
+
   class Subgroup < OpenStruct
   end
+
+  class TransformFailed < Exception
+  end
 end

data/lib/figtree/transformer.rb

@@ -53,7 +53,7 @@ module Figtree
       :optional_key => subtree(:overriding_key),
       :file_path => subtree(:new_file_path),
     ) do
-      if overrides.include?(overriding_key[:snake_case_key].to_sym)
+      if override.to_sym == overriding_key[:snake_case_key].to_sym
         {
           overridden_key[:snake_case_key] => String(new_file_path)
         }

data/lib/figtree/version.rb

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

data/spec/figtree/transformer_spec.rb

@@ -45,7 +45,7 @@ module Figtree
         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(
+        expect(Transformer.new.apply(override_tree, override: :production)).to eq(
           [
             {
               http: Subgroup.new(path: '/srv/var/tmp/')

data/spec/figtree_spec.rb

@@ -59,21 +59,21 @@ describe Figtree do
     end
 
     it 'can parse a group and provide dot notation access' do
-      expect(Figtree.load_config(settings_path).common).to eq(common)
+      expect(Figtree::IniConfig.new(settings_path).common).to eq(common)
     end
     it 'can parse the overrides correctly' do
-      expect(Figtree.load_config(settings_path, [:itscript]).common).
+      expect(Figtree::IniConfig.new(settings_path, :itscript).common).
         to eq(common_with_override)
     end
     it 'can parse the whole Kebab without any misunderstandings' do
-      expect(Figtree.load_config(settings_path)).to eq(the_whole_kebab)
+      expect(Figtree::IniConfig.new(settings_path)).to eq(the_whole_kebab)
     end
 
     context "performance" do
       it 'can parse the whole ini file quickly' do
         expect(
           Benchmark.realtime do
-            Figtree.load_config(settings_path)
+            Figtree::IniConfig.new(settings_path)
           end
         ).to be < 0.014
       end
@@ -83,13 +83,13 @@ describe Figtree 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) }.
+        expect { Figtree::IniConfig.new(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) }.
+        expect { Figtree::IniConfig.new(untransformable_config) }.
           to raise_error(Figtree::TransformFailed)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: figtree
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Moore-Niemi