jini 0.0.1 → 0.0.2

data/lib/jini.rb

@@ -1,5 +1,27 @@
 # frozen_string_literal: true
 
+# (The MIT License)
+#
+# Copyright (c) 2022-2022 Ivanchuk Ivan
+#
+# 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.
+
 # It's a simple XPATH builder.
 # require 'jini'
 # xpath = Jini.new('body')
@@ -10,41 +32,97 @@ class Jini
   # When path not valid
   class InvalidPath < StandardError; end
 
+  # @param head [String] with head of your xpath
   def initialize(head = '')
     @head = head
   end
 
   # Convert it to a string.
+  # @return [String] xpath as string
   def to_s
     @head.to_s
   end
 
   # Additional node for xpath.
+  # @param node [String] node
+  # @return [Jini] object
   def add_path(node)
     Jini.new("#{@head}/#{node}")
   end
 
   # Additional attribute for xpath.
+  # [@key="value"]
+  # @param key [String] name of attr
+  # @param value [String] value of attr
+  # @return [Jini] object
   def add_attr(key, value)
     Jini.new("#{@head}[@#{key}=\"#{value}\"]")
   end
 
+  # Adds an @value to xpath
+  # @param value [String] with value attr
+  # @return [Jini] object
   def all_attr(value)
     Jini.new("#{@head}@#{value}")
   end
 
   # Xpath with all elements.
+  # Addition a *** to xpath
+  # @return [Jini] object
   def all
-    Jini.new(add_path('*').to_s)
+    raise InvalidPath, 'You cannot add all tag after attr!' if @head[-1].eql?(']')
+    Jini.new(add_path('*').to_s) unless @head[-1].eql?(']')
   end
 
   # Xpath with all named elements.
+  # Addition _//node_ to xpath
+  # @param node [String] name of node
+  # @return [Jini] object
   def add_all(node)
     Jini.new("#{@head}//#{node}")
   end
 
   # Access by index.
+  # Addition _[index]_ to xpath
+  # @param position [Integer] number
+  # @return [Jini] object
   def at(position)
     Jini.new("#{@head}[#{position}]")
   end
+
+  # Replace all _/_ to _::_ symbols
+  # if path doesn't contain invalid symbols for selection
+  # @return [Jini] selection
+  def selection
+    if @head.include?('[') || @head.include?(']') || @head.include?('@')
+      raise InvalidPath, 'Cannot select, path contains bad symbols'
+    end
+    Jini.new(@head.gsub('/', '::').to_s)
+  end
+
+  # Removes node by name
+  # @param node [String] name of node for removal
+  # @return [Jini] without a node
+  def remove_path(node)
+    copy = @head
+    Jini.new(copy.gsub("/#{node}", ''))
+  end
+
+  # Removes attr by name
+  # before:
+  # /parent/child[@k="v"]
+  # .remove_attr('k')
+  # after:
+  # /parent/child
+  # @param [String] name of attr
+  # @return [Jini] without an attr
+  def remove_attr(name)
+    Jini.new(
+      @head
+        .gsub(
+          /(\[@|#{name}="[^"]+"|[]+|])/,
+          ''
+        )
+    )
+  end
 end

data/test/jini_test.rb

@@ -1,22 +1,86 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2022-2022 Ivanchuk Ivan
+#
+# 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.
+
 require_relative '../lib/jini'
 require 'minitest/autorun'
-require 'minitest/reporters'
+require_relative 'test_helper'
+
+# Jini test.
+# Author:: Ivan Ivanchuk (clicker.heroes.acg@gmail.com)
+# Copyright:: Copyright (c) 2022-2022 Ivan Ivanchuck
+# License:: MIT
+class JiniTest < Minitest::Test
+  def test_add_path_and_at_success
+    assert_equal(
+      '/parent/child[1]',
+      Jini.new
+        .add_path('parent')
+        .add_path('child')
+        .at(1)
+        .to_s
+    )
+  end
+
+  def test_add_attr_success
+    assert_equal(
+      '/node[@key="value"]',
+      Jini.new
+        .add_path('node')
+        .add_attr('key', 'value')
+        .to_s
+    )
+  end
 
-class JiniTest < Minitest::Unit
-  def setup
-    # Do nothing
+  def test_all_success
+    assert_equal(
+      '/parent/child/*',
+      Jini.new
+          .add_path('parent')
+          .add_path('child')
+          .all
+          .to_s
+    )
   end
 
-  def teardown
-    # Do nothing
+  def test_all_fail
+    assert_raises do
+      Jini.new
+          .add_path('parent')
+          .add_attr('key', 'value')
+          .all
+    end
   end
 
-  def test
-    xpath = Jini
-      .new
-      .add_path('parent')
-      .add_path('child')
-      .at(1)
-    assert_equal('/parent/child[1]', xpath.to_s)
+  def test_remove_attr_success
+    assert_equal(
+      '/home/batya',
+      Jini.new
+          .add_path('home')
+          .add_path('batya')
+          .add_attr('drunk', 'very')
+          .remove_attr('drunk')
+          .to_s
+    )
   end
 end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2022-2022 Ivan Ivanchuk
+#
+# 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 NONINFINGEMENT. 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.
+
+$stdout.sync = true
+
+require 'simplecov'
+
+SimpleCov.start
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jini
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ivan Ivanchuck
@@ -63,13 +63,34 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
 - Gemfile
 - README.md
+- doc/Jini.html
+- doc/Jini/InvalidPath.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - jini.gemspec
 - jini.iml
 - lib/jini.rb
-- lib/main.rb
 - test/jini_test.rb
+- test/test_helper.rb
 homepage: https://github.com/l3r8yJ/jini
 licenses:
 - MIT

data/lib/main.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'jini'
-
-def test
-  xpath = Jini.new('head')
-            .add_path('parent') # addition a path node
-            .add_path('child') # addition a path node
-            .add_attr('key', 'value')
-  print xpath.to_s
-end
-
-test