abbreviato 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5085c8300a7d9a509c4f72e2cb9daf5a3e1d4b87
-  data.tar.gz: eef2da69fa0c5ce8be05f46c6ccdc62e3942ed3f
+SHA256:
+  metadata.gz: e2c3faae5fca5550963dcc873dae508f744c098e67be55be28ca20d38821f051
+  data.tar.gz: 1c5a437b8d174d975f9a047a422c29832120ac9aa1544b9df37f56f422b90f9e
 SHA512:
-  metadata.gz: 9a3d5bdf9ddcd1804697a8904e86189016603f6d4cb9b982989279ec8388c794097fe03baff381c4643bd5388d444fc579e012fd4d87600e298c3e9986d66d9d
-  data.tar.gz: 381c985b43bab367387842aca67c1125fa57d89c02ff11d4b5e537d8865e96fa444fe44176765d224e098f221db9962a972f217454ace9ed0e0a2d6cd5e03ea5
+  metadata.gz: f7b87ac3291fb6afb74056e60e3442b2963e4782240c4cfc3b65c01095446b26936ca6d88d4255d6f750268ea41773d9833b9642f04dfc6f07deef3840715221
+  data.tar.gz: 7eb14d424857d25c063cae759c121c7ef56674dab33e5e21fc55e27912d581848d9e323843141ee3a669c5ec9151a6dd25cf1951a666ba046977b293f4bfaf9d

data/README.md

@@ -1,6 +1,7 @@
 # abbreviato
 
-[![Build Status](https://travis-ci.org/zendesk/abbreviato.svg?branch=master)](https://travis-ci.org/zendesk/abbreviato)
+[![Continuous Integration](https://github.com/zendesk/abbreviato/actions/workflows/actions.yml/badge.svg)](https://github.com/zendesk/abbreviato/actions/workflows/actions.yml)
+[![Security](https://github.com/zendesk/abbreviato/actions/workflows/security.yml/badge.svg)](https://github.com/zendesk/abbreviato/actions/workflows/security.yml)
 [![Gem Version](https://img.shields.io/gem/v/abbreviato.svg)](https://rubygems.org/gems/abbreviato)
 
 *abbreviato* is a Ruby library for truncating HTML strings keeping the markup valid. It is a fork of [jorgemanrubia/truncato](https://github.com/jorgemanrubia/truncato) but focused on truncating to a bytesize, not on a per-character basis.
@@ -47,7 +48,7 @@ rspec spec/abbreviato/abbreviato_spec.rb:357
 ## Running all checks
 
 ```ruby
-bundle exec wwtd
+bundle exec rake spec
 ```
 
 ## Contribute

data/Rakefile

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'wwtd/tasks'
 require 'bundler/gem_tasks'
 require 'bump/tasks'
 
@@ -10,19 +9,11 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-if %w[development test].include?(ENV["RAILS_ENV"] ||= 'development')
-  def run_command(command)
-    result = `#{command}`
-    result.force_encoding('binary')
-    raise "Command #{command} failed: #{result}" unless $?.success?
-
-    result
-  end
-
+if %w[development test].include?(ENV['RAILS_ENV'] ||= 'development')
   require 'bundler/audit/task'
   Bundler::Audit::Task.new
 
-  desc "Analyze for code duplication (large, identical syntax trees) with fuzzy matching."
+  desc 'Analyze for code duplication (large, identical syntax trees) with fuzzy matching.'
   task :flay do
     require 'flay'
     flay = Flay.run(%w[bin config lib script])
@@ -35,23 +26,10 @@ if %w[development test].include?(ENV["RAILS_ENV"] ||= 'development')
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
 
-  task :brakecheck do
-    puts "Running brakecheck..."
-    %w[brakecheck brakeman bundler-audit flay rubocop].each do |gem_name|
-      result = `brakecheck #{gem_name}`
-      result.force_encoding('binary')
-      if $?.success?
-        puts "✔ #{gem_name}"
-      else
-        raise "✘ #{gem_name}'s brakecheck failed: #{result}"
-      end
-    end
-    true
-  end
-
+  desc 'Analyze security vulnerabilities with brakeman'
   task :brakeman do
-    run_command "brakeman --exit-on-warn --exit-on-err --format plain --ensure-latest --table-width 999 --force-scan lib --ignore-config .brakeman.ignore"
+    `brakeman --exit-on-warn --exit-on-err --format plain --ensure-latest --table-width 999 --force-scan lib --ignore-config .brakeman.ignore`
   end
 end
 
-task default: :wwtd
+task default: :spec

data/lib/abbreviato.rb

@@ -1,3 +1,5 @@
-Dir[File.dirname(__FILE__) + '/abbreviato/**/*.rb'].each do |file|
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/abbreviato/**/*.rb"].sort.each do |file|
   require file
 end

data/lib/abbreviato/abbreviato.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Abbreviato
   DEFAULT_OPTIONS = {
-      max_length: 30,
-      tail: '…',
-      fragment: true
+    max_length: 30,
+    tail: '…',
+    fragment: true
   }.freeze
 
   # Truncates the source XML string and returns the truncated XML and a boolean flag indicating
@@ -22,16 +24,28 @@ module Abbreviato
   # @return [[String] the truncated string, [boolean] whether the string was truncated]
   def self.truncate(source = '', user_options = {})
     return [nil, false] if source.nil?
+
     truncated_sax_document = TruncatedSaxDocument.new(DEFAULT_OPTIONS.merge(user_options))
     parser = Nokogiri::HTML::SAX::Parser.new(truncated_sax_document)
     parser.parse(source) { |context| context.replace_entities = false }
 
     if truncated_sax_document.truncated && user_options[:truncate_incomplete_row]
+      parsed_results = [truncated_sax_document.truncated_string.strip, truncated_sax_document.truncated]
+
       html_fragment = Nokogiri::HTML.fragment(truncated_sax_document.truncated_string.strip)
+      return parsed_results if html_fragment.nil?
+
       last_table_in_doc = html_fragment.xpath('.//table').last
-      cols_in_first_row = last_table_in_doc.xpath('.//tr').first.xpath('.//td').length
-      last_table_in_doc.xpath('.//tr').reverse.each do |element|
-        element.remove if element.xpath('.//td').length != cols_in_first_row
+      return parsed_results unless last_table_in_doc
+
+      first_row = last_table_in_doc.xpath('.//tr').first
+      return parsed_results unless first_row
+
+      cols_in_first_row = first_row.xpath('.//td').length
+      return parsed_results unless cols_in_first_row.positive?
+
+      last_table_in_doc.xpath('.//tr').each do |row|
+        row.remove if row.xpath('.//td').length != cols_in_first_row
       end
 
       return [html_fragment.to_html, truncated_sax_document.truncated]

data/lib/abbreviato/truncated_sax_document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require 'nokogiri'
 require 'htmlentities'
 
@@ -9,19 +11,20 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
   VOID_TAGS = %w[area base br col command hr img input keygen link meta param source wbr].freeze
 
   attr_reader :truncated_string,
-    :max_length,
-    :tail,
-    :ignored_levels,
-    :truncated
+              :max_length,
+              :tail,
+              :ignored_levels,
+              :truncated
 
-  def initialize(options)
+  # FIXME: Call super to initialize state of the parent class.
+  def initialize(options) # rubocop:disable Lint/MissingSuper
     @html_coder = HTMLEntities.new
 
     @max_length = options[:max_length]
     @tail = options[:tail] || ''
     @fragment_mode = options[:fragment]
 
-    @truncated_string = ""
+    @truncated_string = ''
     @closing_tags = []
     @estimated_length = 0
     @ignored_levels = 0
@@ -67,13 +70,13 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
     # Use encoded length, so &gt; counts as 4 bytes, not 1 (which is what '>' would give)
     encoded_string = @html_coder.encode(decoded_string, :named)
     string_to_append = if encoded_string.bytesize > remaining_length
-      # This is the line which prevents HTML entities getting truncated - treat them as a single char
-      str = truncate_string(decoded_string)
-      str << tail if remaining_length - str.bytesize >= tail.bytesize
-      str
-    else
-      encoded_string
-    end
+                         # This is the line which prevents HTML entities getting truncated - treat them as a single char
+                         str = truncate_string(decoded_string)
+                         str << tail if remaining_length - str.bytesize >= tail.bytesize
+                         str
+                       else
+                         encoded_string
+                       end
     append_to_truncated_string(string_to_append)
   end
 
@@ -115,7 +118,8 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
     # Note that any remaining end tags get added automatically (in `end_document`) as the document is closed
     return if max_length_reached? || ignorable_tag?(name)
 
-    unless single_tag_element?(name)
+    # FIXME: Style/GuardClause: Use a guard clause (return if single_tag_element?(name)) instead of wrapping the code inside a conditional expression. (https://rubystyle.guide#no-nested-conditionals)
+    unless single_tag_element?(name) # rubocop:disable Style/GuardClause
       @closing_tags.pop
       # Don't count the length when closing a tag - it was accommodated when
       # the tag was opened
@@ -174,7 +178,7 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
     @truncated = true
     truncate_length = remaining_length - tail.bytesize
     truncated_string = ''
-    decoded_string.split('').each do |char|
+    decoded_string.chars.each do |char|
       encoded_char = @html_coder.encode(char)
       break if encoded_char.bytesize > truncate_length
 
@@ -206,6 +210,6 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
   end
 
   def ignore_mode?
-    @ignored_levels > 0
+    @ignored_levels.positive?
   end
 end

data/lib/abbreviato/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Abbreviato
-  VERSION = '0.10.0'.freeze
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abbreviato
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jorge Manrubia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -28,16 +28,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: 1.10.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: 1.10.10
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: brakecheck
+  name: brakeman
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: brakeman
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: flay
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: flay
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,35 +151,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-benchmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-benchmark
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -247,15 +247,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: A tool for efficiently truncating HTML strings to a specific bytesize