enolib 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b0463dcfa44839c7fecdb048f3678504d0616264bb71e3fe8ada2f97b9b8130
-  data.tar.gz: f4c541da00922054b230d6ff35860bfa49832fc24b064b52948ebb09d90da5e5
+  metadata.gz: 3b651313a82b9c6405bbd7153ee2950b72d1f62730591c4db46c4a63f8394096
+  data.tar.gz: 88bd6529c910af0cfdd1494a32201bab3080bce5ad1292431f0b277cfe693365
 SHA512:
-  metadata.gz: 237cf74c59338475dfc4f0b8f4d8e5e5c7ced6aa57a41c9afb2a88d442d0c478e3459eadb956407d2f05109c6177cf9458d8e3c38e7fd489741d7774945f6b88
-  data.tar.gz: cd1266e224fbf84ef250dbbd71c65196a2d0d31eb9ef8ed1b6c0a903fc1b00f222966317b8e5c18e3d197b2c0dc9132253f4102634a0708a0d08ee034f136f53
+  metadata.gz: b35969b8426c82b861d7ce6f318fd18dacfa29a1c8d287dc1c657612697984912bf4f89f772cc825f69758e9514f821bad6891a935b1a69d78f711839a08672f
+  data.tar.gz: 57cf90bb8901c0f0fd0d437a8aa1e2ebdbd307c020f95b2051351badb2b9660030634594c78a8639a46262a3df1a490c4eb8d81200dc116d2ff5dfce8fe3e946

data/README.md

@@ -39,14 +39,4 @@ puts document.field('Greeting').required_string_value  #=> 'Hello World!'
 
 ## Documentation
 
-Until available please use the javascript or python documentation at [eno-lang.org/enolib](https://eno-lang.org/enolib/) and replace all shown syntax with the ruby equivalent (ie. different case for the most part) - except for language specifics the API is exactly the same for all implementations.
-
-## Beta notice
-
-enolib is currently in beta, if you encounter any issues please report them in the issue tracker - thank you for your help!
-
-## Compatibility notice
-
-enolib supports the not yet completely ratified [final specification](https://github.com/eno-lang/eno/tree/master/rfcs-final-spec) for eno. You are encouraged to use it in your projects already, thereby helping us to gather insights on whether there are any remaining flaws in the proposed final specifications (you're very welcome to report such issues if you encounter them).
-
-From a practical point of view there are not likely any major changes ahead.  Unless you build your application around edge cases of the exotic language features you should be perfectly safe and future-proof.
+Available at [eno-lang.org/enolib](https://eno-lang.org/enolib/).

data/lib/enolib/elements/element.rb

@@ -2,6 +2,19 @@
 
 module Enolib
   class Element < SectionElement
+    def to_document
+      unless @instruction[:type] == :document
+        raise Errors::Validation.unexpected_element_type(@context, nil, @instruction, 'expected_document')
+      end
+
+      unless instance_variable_defined?(:@section)
+        @section = Section.new(@context, @instruction)
+        @yielded = :section
+      end
+
+      @section
+    end
+
     def to_fieldset_entry
       unless instance_variable_defined?(:@fieldset_entry)
         unless @instruction[:type] == :fieldset_entry
@@ -27,6 +40,23 @@ module Enolib
       @list_item
     end
 
+    def to_s
+      "#<Enolib::Element key=#{_key} yields=#{_yields}>"
+    end
+
+    def to_section
+      unless instance_variable_defined?(:@section)
+        unless @instruction[:type] == :section || @instruction[:type] == :document
+          raise Errors::Validation.unexpected_element_type(@context, nil, @instruction, 'expected_section')
+        end
+
+        @section = Section.new(@context, @instruction)
+        @yielded = :section
+      end
+
+      @section
+    end
+
     def yields_fieldset_entry?
       @instruction[:type] == :fieldset_entry
     end
@@ -35,8 +65,9 @@ module Enolib
       @instruction[:type] == :list_item
     end
 
-    def to_s
-      "#<Enolib::Element key=#{@instruction[:key]}>"
+    def yields_section?
+      @instruction[:type] == :section ||
+      @instruction[:type] == :document
     end
   end
 end

data/lib/enolib/elements/element_base.rb

@@ -52,6 +52,10 @@ module Enolib
       end
     end
 
+    # TODO: All implementations - this could be called on the document (?),
+    # via both element and section, most likely triggering erratic behavior
+    # because the error->selection chain does not handle the missing key range?
+    # (Also being able to call it and doing so does not make sense in the first place)
     def key_error(message = nil)
       if block_given?
         message = yield(_key)
@@ -131,11 +135,10 @@ module Enolib
     end
 
     def _key
-      if @instruction[:type] == :list_item
-        @instruction[:parent][:key]
-      else
-        @instruction[:key]
-      end
+      return nil if @instruction[:type] == :document
+      return @instruction[:parent][:key] if @instruction[:type] == :list_item
+
+      @instruction[:key]
     end
   end
 end

data/lib/enolib/elements/section_element.rb

@@ -85,6 +85,10 @@ module Enolib
       @list
     end
 
+    def to_s
+      "#<Enolib::SectionElement key=#{_key} yields=#{_yields}>"
+    end
+
     def to_section
       unless instance_variable_defined?(:@section)
         unless @instruction[:type] == :section
@@ -134,8 +138,14 @@ module Enolib
       @instruction[:type] == :section
     end
 
-    def to_s
-      "#<Enolib::SectionElement key=#{@instruction[:key]}>"
+    private
+
+    def _yields
+      if @instruction[:type] == :empty_element
+          return "#{PRETTY_TYPES[:empty_element]},#{PRETTY_TYPES[:field]},#{PRETTY_TYPES[:fieldset]},#{PRETTY_TYPES[:list]}"
+      end
+
+      PRETTY_TYPES[@instruction[:type]]
     end
   end
 end

data/lib/enolib/lookup.rb

@@ -67,7 +67,17 @@ def check_fieldset_by_line(fieldset, line)
 
   fieldset[:entries].each do |entry|
     return { element: entry, instruction: entry } if line == entry[:line]
-    return { element: fieldset, instruction: nil } if line < entry[:line]
+
+    if line < entry[:line]
+      if entry.has_key?(:comments) && line >= entry[:comments][0][:line]
+        return {
+          element: entry,
+          instruction: entry[:comments].find { |comment| line == comment[:line] }
+        }
+      end
+
+      return { element: fieldset, instruction: nil }
+    end
 
     match_in_entry = check_field_by_line(entry, line)
 
@@ -82,7 +92,17 @@ def check_fieldset_by_index(fieldset, index)
                       index <= fieldset[:entries].last[:ranges][:line][RANGE_END]
 
   fieldset[:entries].each do |entry|
-    return { element: fieldset, instruction: nil } if index < entry[:ranges][:line][RANGE_BEGIN]
+    if index < entry[:ranges][:line][RANGE_BEGIN]
+      if entry.has_key?(:comments) && index >= entry[:comments][0][:ranges][:line][RANGE_BEGIN]
+        return {
+          element: entry,
+          instruction: entry[:comments].find { |comment| index <= comment[:ranges][:line][RANGE_END] }
+        }
+      end
+
+      return { element: fieldset, instruction: nil }
+    end
+
     return { element: entry, instruction: entry } if index <= entry[:ranges][:line][RANGE_END]
 
     match_in_entry = check_field_by_index(entry, index)
@@ -98,7 +118,17 @@ def check_list_by_line(list, line)
 
   list[:items].each do |item|
     return { element: item, instruction: item } if line == item[:line]
-    return { element: list, instruction: nil } if line < item[:line]
+
+    if line < item[:line]
+      if item.has_key?(:comments) && line >= item[:comments][0][:line]
+        return {
+          element: item,
+          instruction: item[:comments].find { |comment| line == comment[:line] }
+        }
+      end
+
+      return { element: list, instruction: nil }
+    end
 
     match_in_item = check_field_by_line(item, line)
 
@@ -113,7 +143,17 @@ def check_list_by_index(list, index)
                       index > list[:items].last[:ranges][:line][RANGE_END]
 
   list[:items].each do |item|
-    return { element: list, instruction: nil } if index < item[:ranges][:line][RANGE_BEGIN]
+    if index < item[:ranges][:line][RANGE_BEGIN]
+      if item.has_key?(:comments) && index >= item[:comments][0][:ranges][:line][RANGE_BEGIN]
+        return {
+          element: item,
+          instruction: item[:comments].find { |comment| index <= comment[:ranges][:line][RANGE_END] }
+        }
+      end
+
+      return { element: list, instruction: nil }
+    end
+
     return { element: item, instruction: item } if index <= item[:ranges][:line][RANGE_END]
 
     match_in_item = check_field_by_index(item, index)
@@ -124,6 +164,17 @@ end
 
 def check_in_section_by_line(section, line)
   section[:elements].reverse_each do |element|
+    if element.has_key?(:comments)
+      next if line < element[:comments][0][:line]
+
+      if line <= element[:comments][-1][:line]
+        return {
+          element: element,
+          instruction: element[:comments].find { |comment| line == comment[:line] }
+        }
+      end
+    end
+
     next if element[:line] > line
 
     return { element: element, instruction: element } if element[:line] == line
@@ -155,6 +206,17 @@ end
 
 def check_in_section_by_index(section, index)
   section[:elements].reverse_each do |element|
+    if element.has_key?(:comments)
+      next if index < element[:comments][0][:ranges][:line][RANGE_BEGIN]
+
+      if index <= element[:comments][-1][:ranges][:line][RANGE_END]
+        return {
+          element: element,
+          instruction: element[:comments].find { |comment| index <= comment[:ranges][:line][RANGE_END] }
+        }
+      end
+    end
+
     next if index < element[:ranges][:line][RANGE_BEGIN]
 
     return { element: element, instruction: element } if index <= element[:ranges][:line][RANGE_END]
@@ -211,7 +273,14 @@ module Enolib
     instruction = match[:instruction]
 
     unless instruction
-      instruction = context.meta.find { |candidate| candidate[:line] == line }
+      if index
+        instruction = context.meta.find do |candidate|
+          index >= candidate[:ranges][:line][RANGE_BEGIN] && index <= candidate[:ranges][:line][RANGE_END]
+        end
+      else
+        instruction = context.meta.find { |candidate| candidate[:line] == line }
+      end
+
       return result unless instruction
     end
 

data/lib/enolib/messages/de.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-#  GENERATED ON 2019-04-10T13:57:55 - DO NOT EDIT MANUALLY
+#  GENERATED ON 2019-05-29T07:40:09 - DO NOT EDIT MANUALLY
 
 module Enolib
   module Messages
     module De
       CONTENT_HEADER = 'Inhalt'
+      EXPECTED_DOCUMENT = 'Das Dokument wurde erwartet.'
       EXPECTED_EMPTY = 'Ein leeres Element wurde erwartet.'
       EXPECTED_FIELD = 'Ein Feld wurde erwartet.'
       EXPECTED_FIELDS = 'Nur Felder wurden erwartet.'

data/lib/enolib/messages/en.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-#  GENERATED ON 2019-04-10T13:57:55 - DO NOT EDIT MANUALLY
+#  GENERATED ON 2019-05-29T07:40:09 - DO NOT EDIT MANUALLY
 
 module Enolib
   module Messages
     module En
       CONTENT_HEADER = 'Content'
+      EXPECTED_DOCUMENT = 'The document was expected.'
       EXPECTED_EMPTY = 'An empty element was expected.'
       EXPECTED_FIELD = 'A field was expected.'
       EXPECTED_FIELDS = 'Only fields were expected.'

data/lib/enolib/messages/es.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-#  GENERATED ON 2019-04-10T13:57:55 - DO NOT EDIT MANUALLY
+#  GENERATED ON 2019-05-29T07:40:09 - DO NOT EDIT MANUALLY
 
 module Enolib
   module Messages
     module Es
       CONTENT_HEADER = 'Contenido'
+      EXPECTED_DOCUMENT = 'Se esperaba el documento.'
       EXPECTED_EMPTY = 'Se esperaba un elemento vacío.'
       EXPECTED_FIELD = 'Se esperaba una casilla.'
       EXPECTED_FIELDS = 'Solo se esperaban casillas.'

data/lib/enolib/register.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-# TODO: Safe-guard against conflicting loader names (e.g. previous definition or native library function conflict)
-
 module Enolib
   def self.register(definitions)
     definitions.each do |name, loader|
+      if name == :string
+        raise ArgumentError, "You cannot register 'string' as a type/loader with enolib as this conflicts with the native string type accessors."
+      end
+
       ElementBase.send(:define_method, "#{name}_key") { key(loader) }
       ElementBase.send(:define_method, "optional_#{name}_comment") { optional_comment(loader) }
       ElementBase.send(:define_method, "required_#{name}_comment") { required_comment(loader) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enolib
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Simon Repp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep-cover
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rspec-cheki
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.68.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.68.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 description: The cross-language eno standard library
 email: simon@fdpl.io
 executables: []