xembly 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f023a77c3eafd5c14209b1ecdfe52a0beb9d467
-  data.tar.gz: dd79f3a64463a63e27e70a0ff6e0ab59d8702609
+SHA256:
+  metadata.gz: fc7bc216b94a2958fd5e606eeb05998280317b19294bb243914da4ff0bc88f54
+  data.tar.gz: 7cabfc0600484c9f201b9c188b0b740f36040bfb64c2e0f71a0f5d99f9161882
 SHA512:
-  metadata.gz: 0b07c1a59c84b1a68db7b983baf62a2e0df51fc557725b4e7aceec123b1de2658062bc79e76e5bc3271d0f257239c9e04820dfd2c7a74e510ad6310ca1ff21fa
-  data.tar.gz: 6579da7b021d569cb5e110675763fbd8980cb36f2980f49e86d42e47d404a4232723a79cfa4bb6fa97f127eb410e027bb122199ade26e360fcf2084b1174fcb4
+  metadata.gz: f37de6ab8d6093803de32605df1b014ffb7f181ef6a83f8cea9d2f7204bc9036764d9f457aa99eb84eb443c1e3061469d7455c3b5ccd23e6e1719e43d1ec2015
+  data.tar.gz: 3f24551da450d598e87a1fba24b6341582ecc409733687e1f3e22e6af26554bf3f3a20873bcd509d3bd37d318d2fbb4d1f8a3d186a4e46babced6bea42780d71

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.github/workflows/codecov.yml

@@ -0,0 +1,21 @@
+---
+name: codecov
+on:
+  push:
+    branches:
+      - master
+jobs:
+  codecov:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - run: bundle update
+      - run: bundle exec rake
+      - uses: codecov/codecov-action@v4.0.0-beta.3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: coverage/.resultset.json
+          fail_ci_if_error: true

data/.github/workflows/pdd.yml

@@ -0,0 +1,15 @@
+---
+name: pdd
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  pdd:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -0,0 +1,24 @@
+---
+name: rake
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  rake:
+    name: test
+    strategy:
+      matrix:
+        os: [ubuntu-22.04, macos-12]
+        ruby: [3.3]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle update
+      - run: bundle exec rake

data/.github/workflows/xcop.yml

@@ -0,0 +1,11 @@
+---
+name: xcop
+on:
+  push:
+  pull_request:
+jobs:
+  xcop:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+      - uses: g4s8/xcop-action@master

data/.pdd

@@ -0,0 +1,7 @@
+--source=.
+--verbose
+--exclude target/**/*
+--exclude src/main/resources/images/**/*
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -1,6 +1,18 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'assets/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: '2.5'
+  SuggestExtensions: false
+
 MethodLength:
   Max: 50
 Style/ClassLength:
   Max: 150
 Style/CyclomaticComplexity:
   Max: 20
+Metrics/BlockLength:
+  Max: 30
+Metrics/AbcSize:
+  Max: 30

data/.rultor.yml

@@ -1,28 +1,20 @@
+docker:
+  image: yegor256/rultor-image:1.22.0
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
-  s3cfg: yegor256/home#assets/s3cfg
 install: |
-  sudo apt-get update
-  sudo gem install pdd
+  pdd -f /dev/null
+  bundle install --no-color
 release:
+  pre: false
   script: |-
-    sudo bundle install
-    rake
-    rm -rf *.gem
+    bundle exec rake clean test rubocop copyright
     sed -i "s/1\.0\.snapshot/${tag}/g" lib/xembly/version.rb
     git add lib/xembly/version.rb
     git commit -m "version set to ${tag}"
     gem build xembly.gemspec
     chmod 0600 ../rubygems.yml
     gem push *.gem --config-file ../rubygems.yml
-    sudo gem install xembly
-    pdd --source=$(pwd) --verbose --file=xembly-gem.xml -e=test/** -e=features/** -e=README.md
-    s3cmd --no-progress put xembly-gem.xml --config=../s3cfg s3://pdd.teamed.io/xembly-gem.xml
-  commanders:
-  - yegor256
-architect:
-- yegor256
-- davvd
 merge:
-  commanders: []
-deploy: {}
+  script: |-
+    bundle exec rake clean test rubocop copyright

data/.simplecov

@@ -1,6 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -20,24 +21,21 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'coveralls'
-
-if Gem.win_platform? then
+if Gem.win_platform?
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter
   ]
   SimpleCov.start do
-    add_filter "/test/"
-    add_filter "/features/"
+    add_filter '/test/'
+    add_filter '/features/'
   end
 else
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
+    SimpleCov::Formatter::HTMLFormatter
   ]
   SimpleCov.start do
-    add_filter "/test/"
-    add_filter "/features/"
+    add_filter '/test/'
+    add_filter '/features/'
     minimum_coverage 90
   end
 end

data/Gemfile

@@ -1,6 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -22,3 +23,10 @@
 
 source 'https://rubygems.org'
 gemspec
+gem 'cucumber', '9.1.2', require: false
+gem 'minitest', '5.22.2', require: false
+gem 'rdoc', '6.6.2', require: false
+gem 'rspec-rails', '6.1.1', require: false
+gem 'rubocop', '1.60.2', require: false
+gem 'rubocop-rspec', '2.26.1', require: false
+gem 'simplecov', '0.22.0', require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2016 Yegor Bugayenko
+Copyright (c) 2016-2024 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.md

@@ -1,37 +1,30 @@
-[![Made By Teamed.io](http://img.teamed.io/btn.svg)](http://www.teamed.io)
+<img src="https://www.xembly.org/logo.png" width="64px" height="64px" />
+
 [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/xembly-gem)](http://www.rultor.com/p/yegor256/xembly-gem)
-[![We recommend RubyMine](http://img.teamed.io/rubymine-recommend.svg)](https://www.jetbrains.com/ruby/)
+[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 
-[![Build Status](https://travis-ci.org/yegor256/xembly-gem.svg)](https://travis-ci.org/yegor256/xembly-gem)
-[![Build status](https://ci.appveyor.com/api/projects/status/8e5dsjjemymfg510?svg=true)](https://ci.appveyor.com/project/yegor256/xembly-gem)
 [![Gem Version](https://badge.fury.io/rb/xembly.svg)](http://badge.fury.io/rb/xembly)
-[![Dependency Status](https://gemnasium.com/yegor256/xembly-gem.svg)](https://gemnasium.com/yegor256/xembly-gem)
-[![Code Climate](http://img.shields.io/codeclimate/github/yegor256/xembly-gem.svg)](https://codeclimate.com/github/yegor256/xembly-gem)
-[![Coverage Status](https://img.shields.io/coveralls/yegor256/xembly-gem.svg)](https://coveralls.io/r/yegor256/xembly-gem)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f26349e81b04628d8bf7/maintainability)](https://codeclimate.com/github/yegor256/xembly-gem/maintainability)
+[![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/xembly-gem.svg)](https://codecov.io/github/yegor256/xembly-gem?branch=master)
 
-## Assembly for XML
+Xembly is assembly for XML.
 
 Read this [blog post](http://www.yegor256.com/2014/04/09/xembly-intro.html)
 and check this project: [yegor256/xembly](https://github.com/yegor256/xembly)
 
-## How to Install?
-
-You will need Ruby 2.0+:
+To install, you will need Ruby 2.0+:
 
 ```bash
 $ gem install xembly
 ```
 
-## How to Run?
-
-Run it locally and read its output:
+Then, run it and read its output:
 
 ```bash
 $ xembly --help
 ```
 
-Say, you want to modify an existing XML document, which is
-in file `doc.xml`:
+Say, you want to modify an existing XML document, which is in the file `doc.xml`:
 
 ```xml
 <books>
@@ -53,5 +46,5 @@ $ xembly --xml doc.xml 'XPATH "/books"; ADD "book"; ATTR "isbn", "0201379430"; S
 
 Simple as that!
 
-Full specification of Xembly language is
+The full specification of Xembly language is 
 [here](https://github.com/yegor256/xembly).

data/Rakefile

@@ -1,6 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -33,7 +34,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: [:clean, :test, :features, :rubocop, :copyright]
+task default: %i[clean test features rubocop copyright]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
@@ -65,12 +66,12 @@ Cucumber::Rake::Task.new(:features) do |t|
   Rake::Cleaner.cleanup_files(['coverage'])
   t.profile = 'travis'
 end
-Cucumber::Rake::Task.new(:"features:html") do |t|
+Cucumber::Rake::Task.new(:'features:html') do |t|
   t.profile = 'html_report'
 end
 
 task :copyright do
-  sh "grep -q -r '#{Date.today.strftime('%Y')}' \
+  sh "grep -q -r '2016-#{Date.today.strftime('%Y')}' \
     --include '*.rb' \
     --include '*.txt' \
     --include 'Rakefile' \

data/bin/xembly

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -21,11 +22,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-STDOUT.sync = true
+$stdout.sync = true
 
-require 'xembly'
-require 'xembly/version'
 require 'slop'
+require_relative '../lib/xembly'
+require_relative '../lib/xembly/version'
 
 opts = Slop.parse(ARGV, strict: true, help: true) do |o|
   o.banner = "Usage (#{Xembly::VERSION}): xembly [options] [directives]"
@@ -58,10 +59,10 @@ opts = Slop.parse(ARGV, strict: true, help: true) do |o|
   )
 end
 
-fail '-f is mandatory when using -v' if opts.verbose? && !opts.file?
+raise '-f is mandatory when using -v' if opts.verbose? && !opts.file?
 
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 output = Xembly::Base.new(opts).xml
-file = opts.file? ? File.new(opts[:file], 'w') : STDOUT
+file = opts.file? ? File.new(opts[:file], 'w') : $stdout
 file << output

data/features/step_definitions/steps.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 TechnoPark Corp.
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -21,66 +21,61 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'xembly'
 require 'nokogiri'
 require 'tmpdir'
 require 'slop'
 require 'English'
+require_relative '../../lib/xembly'
 
 Before do
   @cwd = Dir.pwd
   @dir = Dir.mktmpdir('test')
-  FileUtils.mkdir_p(@dir) unless File.exist?(@dir)
+  FileUtils.mkdir_p(@dir)
   Dir.chdir(@dir)
 end
 
 After do
   Dir.chdir(@cwd)
-  FileUtils.rm_rf(@dir) if File.exist?(@dir)
+  FileUtils.rm_rf(@dir)
 end
 
 Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
   FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(file)
-  File.open(file, 'w') do |f|
-    f.write(text.gsub(/\\xFF/, "\xFF"))
-  end
+  File.write(file, text.gsub('\\xFF', 0xff.chr))
 end
 
 Then(/^XML matches "([^"]+)"$/) do |xpath|
-  fail "XML doesn't match \"#{xpath}\":\n#{@xml}" if @xml.xpath(xpath).empty?
+  raise "XML doesn't match \"#{xpath}\":\n#{@xml}" if @xml.xpath(xpath).empty?
 end
 
-When(/^I run bin\/xembly with "([^"]*)"$/) do |arg|
+When(%r{^I run bin/xembly with "([^"]*)"$}) do |arg|
   home = File.join(File.dirname(__FILE__), '../..')
   @stdout = `ruby -I#{home}/lib #{home}/bin/xembly #{arg}`
   @exitstatus = $CHILD_STATUS.exitstatus
 end
 
 Then(/^Stdout contains "([^"]*)"$/) do |txt|
-  unless @stdout.include?(txt)
-    fail "STDOUT doesn't contain '#{txt}':\n#{@stdout}"
-  end
+  raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}" unless @stdout.include?(txt)
 end
 
 Then(/^Stdout is empty$/) do
-  fail "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
+  raise "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
 end
 
 Then(/^XML file "([^"]+)" matches "((?:[^"]|\\")+)"$/) do |file, xpath|
-  fail "File #{file} doesn't exit" unless File.exist?(file)
+  raise "File #{file} doesn't exit" unless File.exist?(file)
+
   xml = Nokogiri::XML.parse(File.read(file))
   xml.remove_namespaces!
-  if xml.xpath(xpath.gsub(/\\"/, '"')).empty?
-    fail "XML file #{file} doesn't match \"#{xpath}\":\n#{xml}"
-  end
+  raise "XML file #{file} doesn't match \"#{xpath}\":\n#{xml}" if xml.xpath(xpath.gsub('\\"', '"')).empty?
 end
 
 Then(/^Exit code is zero$/) do
-  fail "Non-zero exit code #{@exitstatus}" unless @exitstatus == 0
+  raise "Non-zero exit code #{@exitstatus}" unless @exitstatus.zero?
 end
 
 Then(/^Exit code is not zero$/) do
-  fail 'Zero exit code' if @exitstatus == 0
+  raise 'Zero exit code' if @exitstatus.zero?
 end
 
 When(/^I run bash with$/) do |text|

data/features/support/env.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 TechnoPark Corp.
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -22,4 +22,4 @@
 # SOFTWARE.
 
 require 'simplecov'
-require 'xembly'
+require_relative '../../lib/xembly'

data/lib/xembly/add.rb

@@ -1,6 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -20,8 +21,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'xembly'
 require 'nokogiri'
+require_relative '../xembly/base'
 
 module Xembly
   # ADD directive

data/lib/xembly/addif.rb

@@ -1,6 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -20,8 +21,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'xembly'
 require 'nokogiri'
+require_relative '../xembly/base'
 
 module Xembly
   # ADDIF directive
@@ -35,7 +36,7 @@ module Xembly
     def exec(dom, cursor)
       after = []
       cursor.each do |node|
-        if !node.element_children.any? { |e| e.name == @name }
+        if node.element_children.none? { |e| e.name == @name }
           child = Nokogiri::XML::Node.new(@name, dom)
           node.add_child(child)
           after.push(child)

data/lib/xembly/attr.rb

@@ -1,6 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 #
-# Copyright (c) 2016 Yegor Bugayenko
+# Copyright (c) 2016-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -20,7 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'xembly'
+require_relative '../xembly/base'
 
 module Xembly
   # ATTR directive

data/lib/xembly/base.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2016-2024 Yegor Bugayenko
+#
+# 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.
+
+require 'nokogiri'
+require 'logger'
+require 'time'
+
+# Xembly main module.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2016-2024 Yegor Bugayenko
+# License:: MIT
+module Xembly
+  # Get logger.
+  def self.log
+    unless @logger
+      @logger = Logger.new($stdout)
+      @logger.formatter = proc { |severity, _, _, msg|
+        "#{severity}: #{msg.dump}\n"
+      }
+      @logger.level = Logger::ERROR
+    end
+    @logger
+  end
+
+  class << self
+    attr_writer :logger
+  end
+
+  # Code base abstraction
+  class Base
+    # Ctor.
+    # +opts+:: Options
+    def initialize(opts)
+      @opts = opts
+      Xembly.log.level = Logger::INFO if @opts.verbose?
+      Xembly.log.info "my version is #{Xembly::VERSION}"
+      Xembly.log.info "Ruby version is #{RUBY_VERSION} at #{RUBY_PLATFORM}"
+    end
+
+    # Generate XML.
+    def xml
+      if @opts.xml?
+        xml = File.read(@opts[:xml])
+        Xembly.log.info "reading #{@opts[:xml]}"
+      else
+        xml = $stdin.read
+        Xembly.log.info 'reading STDIN'
+      end
+      if @opts.dirs?
+        Xembly.log.info "reading directives from #{@opts[:dirs]}"
+        dirs = File.read(@opts[:dirs])
+      else
+        Xembly.log.info "#{@opts.arguments.length} directives in command line"
+        dirs = @opts.arguments.join
+      end
+      Xembler.new(Directives.new(dirs)).apply(xml).to_xml
+    end
+  end
+end