jini 0.1.5 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43186103106cc20b20cb012d5c4a086247e7cfee767ef9c38859fba6167cb6c3
-  data.tar.gz: '02442138ba02d71b2b972cba52a0e465d7681ad8454235d7e03571352db5a0e2'
+  metadata.gz: '0682d203672579b1d46fdb710ca9a3d43741cd464b22e4f4bf593b6b923eb17b'
+  data.tar.gz: 060a615af5fd80421f244696723cef10e719cf34e6ed89dc89d5f2f900767e39
 SHA512:
-  metadata.gz: ba43e479c4127528d445ee02e0331f24efefe519321b542962f07782e009c08dda7fd19246c953d5f1c7879dc82f36781562fe5973520ed001440b3eb23dd3de
-  data.tar.gz: 8ee8c81f0eb1a44123fd9c23cb941808c3e63e19161a31050556123626f9246b38a87fc150bd3a5f5557978b6d7484da68adf1bde1bec2ed73ed5721aa858b6f
+  metadata.gz: f9d5eecff4e6d44060bf49dbcf929887d316a3d9119a81b3bd141ee03296478209bf506f49c9fe3f3130dd891ad8bddf62c1ab27191de3f38a28afc931abe56d
+  data.tar.gz: 4c5937f0ca445df51871d7937096f083c01de586b7bc9d33a11c899f78bbc465ce0fb141344eb020160b2933546d2bd78091bc4abcc1252b1f2f8ab9917fbffd

data/.rubocop.yml

@@ -1,23 +1,45 @@
 AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'assets/**/*'
+    - '**.gemspec'
+    - 'out/**/*'
   DisplayCopNames: true
-  TargetRubyVersion: 2.6.8
-  SuggestExtensions: false
+  TargetRubyVersion: 2.6.0
   NewCops: enable
+  SuggestExtensions: false
 
-Metrics/ClassLength:
-  Exclude:
-    - 'test/*.rb'
+Layout/MultilineOperationIndentation:
+  Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
-Layout/MultilineMethodCallIndentation:
+Naming/MethodParameterName:
+  MinNameLength: 1
+Style/CommandLiteral:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Layout/IndentationWidth:
+  Enabled: false
+Layout/ElseAlignment:
+  Enabled: false
+Layout/EndAlignment:
+  Enabled: false
+Lint/RescueException:
   Enabled: false
-Metrics/AbcSize:
-  Max: 30
 Metrics/MethodLength:
-  Max: 30
+  Max: 50
+Metrics/ClassLength:
+  Max: 200
+Metrics/AbcSize:
+  Max: 60
+Metrics/BlockLength:
+  Max: 100
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
 Metrics/CyclomaticComplexity:
-  Max: 12
+  Max: 11
 Metrics/PerceivedComplexity:
-  Max: 12
-Layout/EndOfLine:
-  EnforcedStyle: lf
+  Max: 11
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -3,6 +3,8 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'rake', '~> 13.0'
+
 group :test do
   gem 'codecov'
   gem 'minitest'

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/0.1.4/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/0.1.4).
+The full list of methods is [here](https://www.rubydoc.info/gems/jini/1.2.5).
 
 Install it:
 
@@ -35,5 +35,5 @@ Pay attention, it is not a parser. The only functionality this gem provides
 is _building_ XPATHs.
 
 ## New features requests
-If you find an error, or you want to add new functionality, simply create a new `Issue`
+If you find an error, or you want to add new functionality, just create a new `Issue`
 and describe what happened, also try to add/fix something and send pull request.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

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 = '0.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
@@ -29,17 +27,20 @@
 #
 # It's a simple XPATH builder.
 # Class is thread safe.
-#
-# require 'jini'
-# xpath = Jini.new('parent')
-#   .add_node('child')
-#   .add_attr('toy', 'plane')
-#   .to_s // parent/child[@toy="plane"]
-#
+# Example:
+#   require 'jini'
+#   xpath = Jini.new('parent')
+#               .add_node('child')
+#               .add_attr('toy', 'plane')
+#               .to_s
+# => 'parent/child[@toy="plane"]
 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
@@ -81,9 +144,9 @@ class Jini
   def replace_node(origin, new)
     Jini.new(
       @head
-          .split('/')
-          .map! { |node| node.eql?(origin) ? new : node }
-          .join('/')
+      .split('/')
+      .map! { |node| node.eql?(origin) ? new : node }
+      .join('/')
     )
   end
 
@@ -91,13 +154,15 @@ class Jini
   # @return nodes as [Array]
   def nodes
     checked = @head
-      .split(%r{(//|/)})
-      .each(&method(:empty_check))
+    .split(%r{(//|/)})
+    .each(&method(:empty_check))
     checked.each { |node| checked.delete node if node.eql?('//') || node.eql?('/') }.to_a
   end
 
   # Addition property in tail.
-  # @example before: '../child', after: '../child/property()'
+  # Example:
+  #   >> Jini.new('node/').property('prop').to_s
+  #   => node/property()
   # @param property [String] to add
   # @return [Jini] with property on tail
   # @since 0.0.1
@@ -129,6 +194,12 @@ class Jini
     Jini.new("#{@head}@#{key}")
   end
 
+  # Just wrap current XPATH into count() function
+  # @return [Jini] wrapped
+  def count
+    Jini.new("count(#{@head})")
+  end
+
   # Removes attr by name.
   # before:
   # '/parent/child [@k="v"]'
@@ -229,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 '//'.
@@ -242,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
 
@@ -256,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

@@ -1,7 +1,3 @@
-# frozen_string_literal: true
-
-# (The MIT License)
-#
 # Copyright (c) 2022 Ivanchuk Ivan
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -26,13 +22,15 @@ require_relative '../lib/jini'
 require 'minitest/autorun'
 require_relative 'test_helper'
 
-# Jini test.
-# Author:: Ivan Ivanchuk (clicker.heroes.acg@gmail.com)
-# Copyright:: Copyright (c) 2022 Ivan Ivanchuck
+# Test for Jini class.
+# Author:: Ivanchuk Ivan (clicker.heroes.acg@gmail.com)
+# Copyright:: Copyright (c) 2022 Ivanchuck Ivan
 # License:: MIT
+# rubocop:disable Metrics/ClassLength
 class JiniTest < Minitest::Test
-  PARENT = 'parent'
-  CHILD = 'child'
+  PARENT = 'parent'.freeze
+  CHILD = 'child'.freeze
+
   def test_add_path_and_at_success
     assert_equal(
       '/parent/child[1]',
@@ -285,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',
@@ -292,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
 
@@ -321,4 +321,36 @@ class JiniTest < Minitest::Test
           .nodes
     end
   end
+
+  def test_count_success
+    assert_equal(
+      'count(parent/child)',
+      Jini.new(PARENT)
+          .add_node(CHILD)
+          .count
+          .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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jini
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.2.5
 platform: ruby
 authors:
 - Ivan Ivanchuck
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -70,6 +70,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - doc/Jini.html
 - doc/Jini/InvalidPath.html
 - doc/_index.html
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Simple Immutable Ruby XPATH Builder