tdiff 0.3.3 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d61fc5d074be499bc2ae185b6449d10354fe3dfd2dfda2ad1529f246dc1cb39
+  data.tar.gz: 4496f53bef15c4e46d195434458ded3a6f13b65afda56a755d5d3128a3b94463
+SHA512:
+  metadata.gz: 2ab9b88ebc51c447c49c19b8823849d3b8b25f7d3c981bda20c74743415dd8e6062371a67493245160a6d31f004a3e06cf97357c57576c981b6f2a93da7af60d
+  data.tar.gz: 461c9fcc0bd2ad6d48a7801f6f847baadbabe6e55c4b75d3dd50e86400fdab477ecb910a70a8972cd6460261e149c639ae64af3d3b2a111d363cea5a6130a599

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -1,2 +1,3 @@
+Gemfile.lock
 doc/
 pkg/

data/ChangeLog.md

@@ -1,3 +1,12 @@
+### 0.4.0 / 2024-01-24
+
+* Switched to using `require_relative` to improve load-times.
+* Added `# frozen_string_literal: true` to all files.
+
+### 0.3.4 / 2018-06-11
+
+* Fixed shadowed variable warning (@bhollis).
+
 ### 0.3.3 / 2012-05-28
 
 * Require ruby >= 1.8.7.

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.1'
+  
+  gem 'rspec', '~> 3.0'
+
+  gem 'kramdown'
+  gem 'redcarpet',  platform: :mri
+  gem 'yard',       '~> 0.9'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Hal Brodigan
+Copyright (c) 2010-2024 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,7 +2,7 @@
 
 * [Source](https://github.com/postmodern/tdiff)
 * [Issues](https://github.com/postmodern/tdiff/issues)
-* Postmodern (postmodern.mod3 at gmail.com)
+* [Documentation](https://rubydoc.info/gems/tdiff)
 
 ## Description
 
@@ -22,56 +22,62 @@ module.
 
 Diff two HTML documents:
 
-    require 'nokogiri'
-    require 'tdiff'
+```ruby
+require 'nokogiri'
+require 'tdiff'
 
-    class Nokogiri::XML::Node
+class Nokogiri::XML::Node
 
-      include TDiff
+  include TDiff
 
-      def tdiff_equal(node)
-        if (self.text? && node.text?)
-          self.text == node.text
-        elsif (self.respond_to?(:root) && node.respond_to?(:root))
-          self.root.tdiff_equal(node.root)
-        elsif (self.respond_to?(:name) && node.respond_to?(:name))
-          self.name == node.name
-        else
-          false
-        end
-      end
+  def tdiff_equal(node)
+    if (self.text? && node.text?)
+      self.text == node.text
+    elsif (self.respond_to?(:root) && node.respond_to?(:root))
+      self.root.tdiff_equal(node.root)
+    elsif (self.respond_to?(:name) && node.respond_to?(:name))
+      self.name == node.name
+    else
+      false
+    end
+  end
 
-      def tdiff_each_child(node,&block)
-        node.children.each(&block)
-      end
+  def tdiff_each_child(node,&block)
+    node.children.each(&block)
+  end
 
-    end
+end
 
-    doc1 = Nokogiri::HTML('<div><p>one</p> <p>three</p></div>')
-    doc2 = Nokogiri::HTML('<div><p>one</p> <p>two</p> <p>three</p></div>')
+doc1 = Nokogiri::HTML('<div><p>one</p> <p>three</p></div>')
+doc2 = Nokogiri::HTML('<div><p>one</p> <p>two</p> <p>three</p></div>')
 
-    doc1.at('div').tdiff(doc2.at('div')) do |change,node|
-      puts "#{change} #{node.to_html}".ljust(30) + node.parent.path
-    end
+doc1.at('div').tdiff(doc2.at('div')) do |change,node|
+  puts "#{change} #{node.to_html}".ljust(30) + node.parent.path
+end
+```
 
 ### Output
 
-    + <p>one</p>                  /html/body/div
-    +                             /html/body/div
-      <p>one</p>                  /html/body/div
-                                  /html/body/div
-      <p>three</p>                /html/body/div
-    - one                         /html/body/div/p[1]
-    + two                         /html/body/div/p[2]
-      three                       /html/body/div/p[2]
+```
++ <p>one</p>                  /html/body/div
++                             /html/body/div
+  <p>one</p>                  /html/body/div
+                              /html/body/div
+  <p>three</p>                /html/body/div
+- one                         /html/body/div/p[1]
++ two                         /html/body/div/p[2]
+  three                       /html/body/div/p[2]
+```
 
 ## Requirements
 
-* [ruby](http://www.ruby-lang.org/) >= 1.8.7
+* [ruby](http://www.ruby-lang.org/) >= 2.0.0
 
 ## Install
 
-    $ gem install tdiff
+```shell
+$ gem install tdiff
+```
 
 ## Copyright
 

data/Rakefile

@@ -1,36 +1,11 @@
 require 'rubygems'
-require 'rake'
+require 'rubygems/tasks'
+Gem::Tasks.new
 
-begin
-  gem 'rubygems-tasks', '~> 0.1'
-  require 'rubygems/tasks'
-
-  Gem::Tasks.new
-rescue LoadError => e
-  warn e.message
-  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
-end
-
-begin
-  gem 'rspec', '~> 2.4'
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new
-rescue LoadError => e
-  task :spec do
-    abort "Please run `gem install rspec` to install RSpec."
-  end
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 task :test => :spec
 task :default => :spec
 
-begin
-  gem 'yard', '~> 0.7'
-  require 'yard'
-
-  YARD::Rake::YardocTask.new  
-rescue LoadError => e
-  task :yard do
-    abort "Please run `gem install yard` to install YARD."
-  end
-end
+require 'yard'
+YARD::Rake::YardocTask.new  

data/gemspec.yml

@@ -10,9 +10,14 @@ email: postmodern.mod3@gmail.com
 homepage: https://github.com/postmodern/tdiff#readme
 has_yard: true
 
-required_ruby_version: ">= 1.8.7"
+metadata:
+  documentation_uri: https://rubydoc.info/gems/tdiff
+  source_code_uri:   https://github.com/postmodern/tdiff
+  bug_tracker_uri:   https://github.com/postmodern/tdiff/issues
+  changelog_uri:     https://github.com/postmodern/tdiff/blob/main/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
+required_ruby_version: ">= 2.0.0"
 
 development_dependencies:
-  rubygems-tasks: ~> 0.1
-  rspec: ~> 2.4
-  yard: ~> 0.7
+  bundler: ~> 2.0

data/lib/tdiff/tdiff.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # {TDiff} adds the ability to calculate the differences between two tree-like
 # objects. Simply include {TDiff} into the class which represents the tree
@@ -148,7 +150,7 @@ module TDiff
     changes = nil
 
     # recurse down through unchanged nodes
-    unchanged.each { |x,y| x.tdiff_recursive(y,&block) }
+    unchanged.each { |a,b| a.tdiff_recursive(b,&block) }
     unchanged = nil
   end
 end

data/lib/tdiff/unordered.rb

@@ -1,4 +1,6 @@
-require 'tdiff/tdiff'
+# frozen_string_literal: true
+
+require_relative 'tdiff'
 
 module TDiff
   #

data/lib/tdiff/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TDiff
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/lib/tdiff.rb

@@ -1,3 +1,5 @@
-require 'tdiff/tdiff'
-require 'tdiff/unordered'
-require 'tdiff/version'
+# frozen_string_literal: true
+
+require_relative 'tdiff/tdiff'
+require_relative 'tdiff/unordered'
+require_relative 'tdiff/version'

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-gem 'rspec', '~> 2.4'
 require 'rspec'
 
 require 'helpers/trees'

data/spec/tdiff_examples.rb

@@ -5,36 +5,36 @@ shared_examples_for 'TDiff' do |method|
   include Helpers::Trees
 
   it "should tell if two trees are identical" do
-    @tree.send(method,@tree).all? { |change,node|
-      change == ' '
-    }.should == true
+    expect(
+      @tree.send(method,@tree).all? { |change,node| change == ' ' }
+    ).to be true
   end
 
   it "should stop if the root nodes have changed" do
     changes = @tree.send(method,@different_root).to_a
 
-    changes.length.should == 2
+    expect(changes.length).to be 2
 
-    changes[0][0].should == '-'
-    changes[0][1].should == @tree
+    expect(changes[0][0]).to be == '-'
+    expect(changes[0][1]).to be == @tree
 
-    changes[1][0].should == '+'
-    changes[1][1].should == @different_root
+    expect(changes[1][0]).to be == '+'
+    expect(changes[1][1]).to be == @different_root
   end
 
   it "should tell when sub-nodes are added" do
     changes = @tree.send(method,@added).select { |change,node| change == '+' }
 
-    changes.length.should == 1
-    changes[0][0].should == '+'
-    changes[0][1].should == @added.children[0].children[1]
+    expect(changes.length).to be 1
+    expect(changes[0][0]).to be == '+'
+    expect(changes[0][1]).to be == @added.children[0].children[1]
   end
 
   it "should tell when sub-nodes are removed" do
     changes = @tree.send(method,@removed).select { |change,node| change == '-' }
 
-    changes.length.should == 1
-    changes[0][0].should == '-'
-    changes[0][1].should == @tree.children[0].children[1]
+    expect(changes.length).to be 1
+    expect(changes[0][0]).to be == '-'
+    expect(changes[0][1]).to be == @tree.children[0].children[1]
   end
 end

data/spec/tdiff_spec.rb

@@ -11,24 +11,24 @@ describe TDiff do
   it "should detect when the order of children has changed" do
     changes = @tree.tdiff(@changed_order).to_a
 
-    changes.length.should == 6
+    expect(changes.length).to be == 6
 
-    changes[0][0].should == ' '
-    changes[0][1].should == @tree
+    expect(changes[0][0]).to be == ' '
+    expect(changes[0][1]).to be == @tree
 
-    changes[1][0].should == '-'
-    changes[1][1].should == @tree.children[0]
+    expect(changes[1][0]).to be == '-'
+    expect(changes[1][1]).to be == @tree.children[0]
 
-    changes[2][0].should == ' '
-    changes[2][1].should == @tree.children[1]
+    expect(changes[2][0]).to be == ' '
+    expect(changes[2][1]).to be == @tree.children[1]
 
-    changes[3][0].should == '+'
-    changes[3][1].should == @changed_order.children[1]
+    expect(changes[3][0]).to be == '+'
+    expect(changes[3][1]).to be == @changed_order.children[1]
 
-    changes[4][0].should == ' '
-    changes[4][1].should == @tree.children[1].children[0]
+    expect(changes[4][0]).to be == ' '
+    expect(changes[4][1]).to be == @tree.children[1].children[0]
 
-    changes[5][0].should == ' '
-    changes[5][1].should == @tree.children[1].children[1]
+    expect(changes[5][0]).to be == ' '
+    expect(changes[5][1]).to be == @tree.children[1].children[1]
   end
 end

data/spec/unordered_spec.rb

@@ -11,7 +11,7 @@ describe TDiff::Unordered do
       include TDiff::Unordered
     end
 
-    base.should include(TDiff)
+    expect(base).to include(TDiff)
   end
 
   it_should_behave_like 'TDiff', :tdiff_unordered
@@ -21,6 +21,6 @@ describe TDiff::Unordered do
       change != ' '
     end
 
-    changes.should be_empty
+    expect(changes).to be_empty
   end
 end

data/tdiff.gemspec

@@ -7,10 +7,7 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
-
-                  require 'tdiff/version'
+                  require_relative 'lib/tdiff/version'
                   TDiff::VERSION
                 end
 

metadata

@@ -1,64 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tdiff
 version: !ruby/object:Gem::Version
-  version: 0.3.3
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Postmodern
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-05-28 00:00:00.000000000 Z
+date: 2024-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubygems-tasks
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
 description: Calculates the differences between two tree-like structures. Similar
   to Rubys built-in TSort module.
 email: postmodern.mod3@gmail.com
@@ -69,12 +34,14 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
-- .gemtest
-- .gitignore
-- .rspec
-- .yardopts
+- ".document"
+- ".gemtest"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
 - ChangeLog.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -93,26 +60,24 @@ files:
 homepage: https://github.com/postmodern/tdiff#readme
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
 summary: Calculates the differences between two tree-like structures.
 test_files: []