rblines 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22cf08f778fdfeb780fa865d66f160b79f77370a45fed45dec205eb767559903
+  data.tar.gz: 993997a366cafa54ab7635eb5902ca6b122bf3704ff260ef0d3088c592b9792c
+SHA512:
+  metadata.gz: a54dd686a0799c6520706b4ba25fe79d7e7d8e94484cda6fd0d14de022f4fe01fd5d78dca1505d031fadc6475a1e73990497299f7900dc0b72ce1e221ad2ea4b
+  data.tar.gz: 7357638628ff3cf9be0a465e8839a4202d2456f5e69fda76ed4219d75be274a1727cc11edb5c793aeced7c632c6e614385c985c11eb025db251297ad27269e33

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require:
+  - standard
+  - rubocop-performance
+
+inherit_gem:
+  standard: config/base.yml
+  standard-performance: config/base.yml
+  standard-custom: config/base.yml

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-05
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rblines.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    rblines (0.1.0)
+      diff-lcs (~> 1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.29.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rblines!
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kadu Diógenes
+
+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.

data/README.md

@@ -0,0 +1,83 @@
+# Rblines
+
+Rblines is a Ruby clone of the [Redlines](https://github.com/houfu/redlines) Python package. It produces a Markdown text showing the differences between two strings/text. The changes are represented with strike-throughs and underlines, which looks similar to Microsoft Word's track changes. This method of showing changes is more familiar to lawyers and is more compact for long series of characters.
+
+## Example
+
+Given an original string:
+
+    The quick brown fox jumps over the lazy dog.
+
+And the string to be tested with:
+
+    The quick brown fox walks past the lazy dog.
+
+The library gives a result of:
+
+    The quick brown fox <del>jumps over </del><ins>walks past </ins>the lazy dog.
+
+Which is rendered like this:
+
+The quick brown fox <del>jumps over </del><ins>walks past </ins>the lazy dog.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rblines
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rblines
+
+## Usage
+
+The library contains one class: `Rblines::Redlines`, which is used to compare text.
+
+```ruby
+test = Rblines::Redlines.new(
+    "The quick brown fox jumps over the lazy dog.",
+    "The quick brown fox walks past the lazy dog.",
+    markdown_style: "none"
+)
+test.output_markdown == "The quick brown fox <del>jumps over </del><ins>walks past </ins>the lazy dog."
+# => True
+```
+
+Alternatively, you can create Redline with the text to be tested, and compare several times to see the results.
+
+```ruby
+test = Rblines::Redlines.new("The quick brown fox jumps over the lazy dog.", markdown_style: "none")
+test.compare("The quick brown fox walks past the lazy dog.") == "The quick brown fox <del>jumps over </del><ins>walks past </ins>the lazy dog."
+# => True
+
+test.compare("The quick brown fox jumps over the dog.") == "The quick brown fox jumps over the <del>lazy </del>dog."
+# => True
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Know Issues
+
+The original [Redlines](https://github.com/houfu/redlines) uses the `SequenceMatcher` from [difflib](https://github.com/python/cpython/blob/main/Lib/difflib.py). This handles the diff a bit different from the gem [diff-lcs](https://github.com/halostatue/diff-lcs) that we are using in this project. So in the spec `handles different number of paragraphs correctly` we changed the expected output a bit:
+
+```ruby
+# changed the expected output from:
+expected_md = "Happy Saturday, \n\nThank you for reaching <del>out, have </del><ins>out. Have </ins>a good <del>weekend \n\nBest, ¶ Sophia</del><ins>weekend. \n\nSophia.</ins>"
+# to:
+expected_md = "Happy Saturday, \n\nThank you for reaching <del>out, have </del><ins>out. Have </ins>a good <del>weekend </del><ins>weekend. </ins>\n\n<del>Best, </del><ins>Sophia.</ins><del>¶ Sophia</del>"
+```
+
+We think that the Redlines output is better, but until we find a better way to handle this, we will keep the current output, that is also not that bad.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kdiogenes/rblines.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/rblines/redlines.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require "strscan"
+require "diff/lcs"
+
+# This regular expression matches a group of characters that can include any character except for parentheses
+# and whitespace characters (which include spaces, tabs, and line breaks) or any character
+# that is a parenthesis or punctuation mark (.?!-).
+# The group can also include any whitespace characters that follow these characters.
+# Breaking it down further:
+# - ( and ) indicate a capturing group
+# - (?: ) is a non-capturing group, meaning it matches the pattern but doesn't capture the matched text
+# - [^()\s]+ matches one or more characters that are not parentheses or whitespace characters
+# - | indicates an alternative pattern
+# - [().?!-] matches any character that is a parenthesis or punctuation mark (.?!-)
+# - \s* matches zero or more whitespace characters (spaces, tabs, or line breaks) that follow the previous pattern.
+TOKENIZER = /((?:[^()\s]+|[().?!-])\s*)/
+
+# This pattern matches one or more newline characters `\n`, and any spaces between them.
+# It is used to split the text into paragraphs.
+# - (?:\n *) is a non-capturing group that must start with a \n and be followed by zero or more spaces.
+# - ((?:\n *)+) is the previous non-capturing group repeated one or more times.
+PARAGRAPH_PATTERN = /((?:\n *)+)/
+
+SPACE_PATTERN = /(\s+)/
+
+# Tokenizes the text based on the TOKENIZER pattern.
+#
+# @param text [String] the text to be tokenized
+# @return [Array<String>] an array of tokenized words
+def tokenize_text(text)
+  text.scan(TOKENIZER).flatten
+end
+
+# Splits a string into a list of paragraphs. One or more `\n` splits the paragraphs.
+# For example, if the text is "Hello\nWorld\nThis is a test", the result will be:
+# ['Hello', 'World', 'This is a test']
+#
+# @param text [String] the text to split
+# @return [Array<String>] a list of paragraphs
+def split_paragraphs(text)
+  text.split(PARAGRAPH_PATTERN)
+    .map(&:strip)
+    .reject(&:empty?)
+end
+
+# Split paragraphs and concatenate them. Then add a character '¶' between paragraphs.
+# For example, if the text is "Hello\nWorld\nThis is a test", the result will be:
+# "Hello¶World¶This is a test"
+#
+# @param text [String] the text to split
+# @return [String] a string with paragraphs separated by '¶'
+def concatenate_paragraphs_and_add_chr182(text)
+  split_paragraphs(text).join(" ¶ ")
+end
+
+module Rblines
+  # The Redlines class is used to compare two texts and generate a markdown output highlighting the differences between
+  # them.
+  #
+  # @example
+  #   redlines = Rblines::Redlines.new("source text", "test text")
+  #   result = redlines.output_markdown
+  class Redlines
+    MD_STYLES = {
+      "none" => {"ins" => %w[ins ins], "del" => %w[del del]},
+      "red" => {
+        "ins" => ['span style="color:red;font-weight:700;"', "span"],
+        "del" => ['span style="color:red;font-weight:700;text-decoration:line-through;"', "span"]
+      }
+    }.freeze
+
+    attr_accessor :options
+    attr_reader :source, :test
+
+    def source=(value)
+      @source = value
+      @seq1 = tokenize_text(concatenate_paragraphs_and_add_chr182(value))
+    end
+
+    def test=(value)
+      @test = value
+      @seq2 = tokenize_text(concatenate_paragraphs_and_add_chr182(value))
+    end
+
+    def initialize(source, test = nil, **options)
+      self.source = source
+      self.options = options
+      self.test = test if test
+    end
+
+    def opcodes
+      raise "No test string was provided when the function was called, or during initialisation." if @seq2.nil?
+
+      Diff::LCS.sdiff(@seq1, @seq2)
+    end
+
+    def output_markdown
+      result = []
+      style = MD_STYLES[options[:markdown_style] || "red"]
+      grouped_opcodes = opcodes.chunk_while { |a, b| a.action == b.action }.to_a
+
+      grouped_opcodes.each do |group|
+        group_action = group[0].action
+        case group_action
+        when "="
+          handle_equal_action(result, group)
+        when "+"
+          handle_add_action(result, group, style)
+        when "-"
+          handle_delete_action(result, group, style)
+        when "!"
+          handle_replace_action(result, group, style)
+        end
+      end
+
+      result.join
+    end
+
+    def handle_equal_action(result, group)
+      result.push(group.map(&:old_element).join.gsub("¶ ", "\n\n"))
+    end
+
+    def handle_add_action(result, group, md_styles)
+      temp_str = group.map(&:new_element).join.split("¶ ")
+      temp_str.each { |split| result.push("<#{md_styles["ins"][0]}>#{split}</#{md_styles["ins"][1]}>", "\n\n") }
+      result.pop if temp_str.length.positive?
+    end
+
+    def handle_delete_action(result, group, md_styles)
+      result.push("<#{md_styles["del"][0]}>#{group.map(&:old_element).join}</#{md_styles["del"][1]}>")
+    end
+
+    def handle_replace_action(result, group, md_styles)
+      result.push("<#{md_styles["del"][0]}>#{group.map(&:old_element).join}</#{md_styles["del"][1]}>")
+      temp_str = group.map(&:new_element).join.split("¶ ")
+      temp_str.each { |split| result.push("<#{md_styles["ins"][0]}>#{split}</#{md_styles["ins"][1]}>", "\n\n") }
+      result.pop if temp_str.length.positive?
+    end
+
+    def compare(test = nil, output = "markdown", options = {})
+      self.test = test if test
+      raise "No test string was provided when the function was called, or during initialisation." if self.test.nil?
+
+      self.options.merge!(options)
+
+      return unless output == "markdown"
+
+      output_markdown
+    end
+  end
+end

data/lib/rblines/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rblines
+  VERSION = "0.1.0"
+end

data/lib/rblines.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "rblines/version"
+require_relative "rblines/redlines"
+
+module Rblines
+  class Error < StandardError; end
+end

data/sig/rblines.rbs

@@ -0,0 +1,4 @@
+module Rblines
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: rblines
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kadu Diógenes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+description: Rblines produces a Markdown text showing the differences between two
+  strings/text. Clone of https://github.com/houfu/redlines.
+email:
+- kadu@fnix.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".standard.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rblines.rb
+- lib/rblines/redlines.rb
+- lib/rblines/version.rb
+- sig/rblines.rbs
+homepage: https://github.com/kdiogenes/rblines
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kdiogenes/rblines
+  source_code_uri: https://github.com/kdiogenes/rblines
+  changelog_uri: https://github.com/kdiogenes/rblines/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Rblines produces a Markdown text showing the differences between two strings/text.
+  Clone of https://github.com/houfu/redlines.
+test_files: []