jini 1.1.5 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cb24e4c751e1f13a8bf330035a607e88f50ad4bd9bfa88716bae22ec9c626b8
-  data.tar.gz: 8566642f48c9b868b601aef9311a0894982da11ee27f01bc4390b0708169d788
+  metadata.gz: '0682d203672579b1d46fdb710ca9a3d43741cd464b22e4f4bf593b6b923eb17b'
+  data.tar.gz: 060a615af5fd80421f244696723cef10e719cf34e6ed89dc89d5f2f900767e39
 SHA512:
-  metadata.gz: 7b86628c45f695f62b67687a90f1e1baa9147a0557303051ec7c5637d0862071c463964657203ac1729c259921a00b3c912c958d56da5f428934ec5fcc121c7d
-  data.tar.gz: 191a9dac94b2f19f89d86d1bfc12aa8e0beebe1a13be6953283e5b5f884ea1614b8b837120f975d381a4f2dc9c9626b3263d737269f3cf712f8df1cc184f2739
+  metadata.gz: f9d5eecff4e6d44060bf49dbcf929887d316a3d9119a81b3bd141ee03296478209bf506f49c9fe3f3130dd891ad8bddf62c1ab27191de3f38a28afc931abe56d
+  data.tar.gz: 4c5937f0ca445df51871d7937096f083c01de586b7bc9d33a11c899f78bbc465ce0fb141344eb020160b2933546d2bd78091bc4abcc1252b1f2f8ab9917fbffd

data/README.md

@@ -3,7 +3,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/jini.svg)](https://badge.fury.io/rb/jini)
 
-The class [`Jini`](https://www.rubydoc.info/gems/jini/1.1.5/Jini) helps you build a XPATH.
+The class [`Jini`](https://www.rubydoc.info/gems/jini/1.2.5/Jini) helps you build a XPATH.
 
 ```ruby
 require 'jini'
@@ -17,7 +17,7 @@ xpath = Jini
 puts(xpath) # -> xpath: /parent[@key="value"]
 ```
 
-The full list of methods is [here](https://www.rubydoc.info/gems/jini/1.1.5).
+The full list of methods is [here](https://www.rubydoc.info/gems/jini/1.2.5).
 
 Install it:
 

data/jini.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=2.6.8'
   s.name = 'jini'
-  s.version = '1.1.5'
+  s.version = '1.2.5'
   s.license = 'MIT'
   s.summary = 'Simple Immutable Ruby XPATH Builder'
   s.description = 'Class Jini helps you build a XPATH and then modify its parts via a simple fluent interface.'

data/lib/jini.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # (The MIT License)
 #
 # Copyright (c) 2022 Ivanchuk Ivan
@@ -40,6 +38,9 @@ class Jini
   # When path not valid
   class InvalidPath < StandardError; end
 
+  # When method not found
+  class UnsupportedOperation < StandardError; end
+
   # Makes new object.
   # By default it creates an empty path and you can ignore the head parameter.
   # @param head [String]
@@ -58,6 +59,68 @@ class Jini
     @head.to_s
   end
 
+  class << self
+    # From.
+    # Creates new Jini object from XPATH.
+    #
+    # @param [String] xpath
+    # @raise [InvalidPath] when XPATH is invalid
+    # @return [Jini] object
+    def from(xpath)
+      raise InvalidPath, 'XPATH isn\'t valid' unless xpath_match?(xpath)
+      Jini.new(xpath)
+    end
+
+    private
+
+    # This regex matches general case of XPATH.
+    # @param xpath [String]
+    # @return [Boolean] matching regex
+    def xpath_match?(xpath)
+      xpath.match?(xpath_regex)
+    end
+
+    def prefix_regex
+      %r{^/?}
+    end
+
+    def tag_regex
+      /([a-zA-Z0-9]+:)?[a-zA-Z0-9]+/
+    end
+
+    def bracket_regex
+      /(\[[^\[\]]*\])/
+    end
+
+    def attr_regex
+      /@\w+=[^\]]+/
+    end
+
+    def or_regex
+      /(\|)/
+    end
+
+    def namespace_regex
+      /([a-zA-Z0-9]+:)?[a-zA-Z0-9]+/
+    end
+
+    def sub_xpath_regex
+      /#{namespace_regex}#{bracket_regex}*(#{attr_regex})*/
+    end
+
+    def or_sub_xpath_regex
+      /#{or_regex}#{namespace_regex}#{bracket_regex}*(#{attr_regex})*/
+    end
+
+    def xpath_regex
+      %r{\A#{prefix_regex}#{namespace_regex}(/#{sub_xpath_regex})*#{or_sub_xpath_regex}*(/#{sub_xpath_regex})*\Z}
+    end
+  end
+
+  def ==(other)
+    self.class == other.class && to_s == other.to_s
+  end
+
   # Additional node for xpath.
   # @param node [String] the node
   # @return [Jini] object with additional node
@@ -237,7 +300,7 @@ class Jini
 
   # @param node [String] node for check
   def space_check(node)
-    raise InvalidPath, "Nodes can't contain spaces: #{node} – contain space." if valid? node
+    raise InvalidPath, "Nodes can't contain spaces: #{node} – contain space." if valid_node? node
   end
 
   # Regex: '[' or ']' or '@' or '//'.
@@ -250,7 +313,7 @@ class Jini
   # Regex: '[' or ']' or '@' or '=' or '<' or '>'.
   # @param node [String] node for check
   # @return [Boolean] matching regex
-  def valid?(node)
+  def valid_node?(node)
     !node.match(/[|]|@|=|>|</) && node.include?(' ')
   end
 
@@ -264,4 +327,12 @@ class Jini
   def purge_head(token)
     @head.gsub(token, '')
   end
+
+  def method_missing(method_name, *_args)
+    raise UnsupportedOperation, "The method #{method_name} was not found!"
+  end
+
+  def respond_to_missing?(_method_name, _include_private = false)
+    true
+  end
 end

data/test/jini_test.rb

@@ -283,6 +283,14 @@ class JiniTest < Minitest::Test
   end
 
   def test_nodes
+    nodes = Jini.new(PARENT)
+          .add_node(CHILD)
+          .add_attr('key', 'value')
+          .add_node('under_attr')
+          .add_nodes('many')
+          .at(3)
+          .nodes
+    assert_includes(nodes, 'under_attr')
     assert_equal(
       [].append(
         'parent',
@@ -290,13 +298,7 @@ class JiniTest < Minitest::Test
         'under_attr',
         'many[3]'
       ),
-      Jini.new(PARENT)
-          .add_node(CHILD)
-          .add_attr('key', 'value')
-          .add_node('under_attr')
-          .add_nodes('many')
-          .at(3)
-          .nodes
+      nodes
     )
   end
 
@@ -329,5 +331,26 @@ class JiniTest < Minitest::Test
           .to_s
     )
   end
+
+  def test_from_xpath_success
+    x = '/parent/child[@toy="plane"]'
+    jini = Jini.new('/parent').add_node(CHILD).add_attr('toy', 'plane')
+    assert_nothing_raised do
+      Jini.from x
+      Jini.from jini.to_s
+    end
+    assert_equal Jini.from(x), Jini.from(jini.to_s)
+  end
+
+  def test_from_xpath_fails
+    assert_raises(Jini::InvalidPath) { Jini.from '/parent/chld[' }
+    assert_raises(Jini::InvalidPath) { Jini.from '' }
+  end
+
+  def test_method_missing_fails
+    assert_raises(Jini::UnsupportedOpertaion) do
+      Jini.new.bark
+    end
+  end
 end
 # rubocop:enable Metrics/ClassLength

data/test/test_helper.rb

@@ -24,6 +24,14 @@ $stdout.sync = true
 
 require 'simplecov'
 
+module Minitest
+  module Assertions
+    def assert_nothing_raised(*)
+      yield
+    end
+  end
+end
+
 SimpleCov.start
 if ENV['CI'] == 'true'
   require 'codecov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jini
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.5
 platform: ruby
 authors:
 - Ivan Ivanchuck