truncato 0.7.0 → 0.7.1

data/README.md

@@ -22,6 +22,7 @@ The configuration options are:
 * `max_length`: The size, in characters, to truncate (`30` by default)
 * `tail`: The string to append when the truncation occurs ('...' by default)
 * `count_tags`: Boolean value indicating whether tags size should be considered when truncating (`true` by default)
+* `filtered_attributes`: Array of attribute names that will be removed from the output. This allows you to make the truncated string shorter by excluding the content of attributes you can discard in some given context, e.g HTML `style` attribute.
 
 ## Performance
 

data/VERSION

@@ -1,2 +1,2 @@
-0.7.0
+0.7.1
 

data/lib/truncato/truncated_sax_document.rb

@@ -1,5 +1,5 @@
 class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
-  attr_reader :truncated_string, :max_length, :max_length_reached, :tail, :count_tags
+  attr_reader :truncated_string, :max_length, :max_length_reached, :tail, :count_tags, :filtered_attributes
 
   def initialize(options)
     init_from_options(options)
@@ -13,7 +13,7 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
   def start_element name, attributes
     return if @max_length_reached
     @closing_tags.push name
-    append_to_truncated_string opening_tag(name), overriden_tag_length
+    append_to_truncated_string opening_tag(name, attributes), overriden_tag_length
   end
 
   def characters decoded_string
@@ -39,6 +39,7 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
     @max_length = options[:max_length]
     @count_tags = options [:count_tags]
     @tail = options[:tail]
+    @filtered_attributes = options[:filtered_attributes] || []
   end
 
   def append_to_truncated_string string, overriden_length=nil
@@ -46,8 +47,19 @@ class TruncatedSaxDocument < Nokogiri::XML::SAX::Document
     increase_estimated_length(overriden_length || string.length)
   end
 
-  def opening_tag name
-    "<#{name}>"
+  def opening_tag name, attributes
+    attributes_string = attributes_to_string(attributes)
+    "<#{name}#{attributes_string}>"
+  end
+
+  def attributes_to_string(attributes)
+    return "" if attributes.empty?
+    attributes_string = attributes.inject(' ') do |string, attribute|
+      key, value = attribute
+      next string  if @filtered_attributes.include?(key)
+      string << "#{key}='#{value}' "
+    end
+    attributes_string.rstrip
   end
 
   def closing_tag name

data/lib/truncato/truncato.rb

@@ -2,7 +2,8 @@ module Truncato
   DEFAULT_OPTIONS = {
       max_length: 30,
       count_tags: true,
-      tail: "..."
+      tail: "...",
+      filtered_attributes: []
   }
 
   # Truncates the source XML string and returns the result
@@ -12,6 +13,7 @@ module Truncato
   # @option user_options [Integer] :max_length Maximum length
   # @option user_options [String] :tail text to append when the truncation occurs
   # @option user_options [Boolean] :count_tags `true` for counting tags for truncation, `false` for not counting them
+  # @option user_options [Array<String>] :filtered_attributes Array of names of attributes that should be excluded in the resulting truncated string. This allows you to make the truncated string shorter by excluding the content of attributes you can discard in some given context, e.g HTML `style` attribute.
   # @return [String] the truncated string
   def self.truncate source, user_options={}
     options = DEFAULT_OPTIONS.merge(user_options)

data/spec/truncato/truncato_spec.rb

@@ -7,7 +7,7 @@ describe "Truncato" do
     it_should_truncate "no html text with longer length", with: {max_length: 4}, source: "some", expected: "some"
   end
 
-  describe "html strings" do
+  describe "html tags structure" do
     it_should_truncate "html text with a tag (counting tags)", with: {max_length: 4}, source: "<p>some text</p>", expected: "<p>s...</p>"
 
     it_should_truncate "html text with a tag (not counting tags)", with: {max_length: 4, count_tags: false}, source: "<p>some text</p>", expected: "<p>some...</p>"
@@ -29,5 +29,32 @@ describe "Truncato" do
                        expected: "<p>&gt;s...</p>"
   end
 
+  describe "html attributes" do
+    it_should_truncate "html text with 1 attributes", with: {max_length: 3, count_tags: false},
+                       source: "<p attr1='1'>some text</p>",
+                       expected: "<p attr1='1'>som...</p>"
+
+    it_should_truncate "html text with 1 attributes counting its size", with: {max_length: 16, count_tags: true},
+                       source: "<p attr1='1'>some text</p>",
+                       expected: "<p attr1='1'>som...</p>"
+
+    it_should_truncate "html text with 2 attributes", with: {max_length: 3, count_tags: false},
+                       source: "<p attr1='1' attr2='2'>some text</p>",
+                       expected: "<p attr1='1' attr2='2'>som...</p>"
+
+    it_should_truncate "html text with attributes in nested tags", with: {max_length: 4, count_tags: false},
+                       source: "<div><p attr1='1'>some text</p></div>",
+                       expected: "<div><p attr1='1'>some...</p></div>"
+
+    it_should_truncate "html text with 2 attributes filtering one of them", with: {max_length: 3, count_tags: false, filtered_attributes: ['attr2']},
+                       source: "<p attr1='1' attr2='2'>some text</p>",
+                       expected: "<p attr1='1'>som...</p>"
+
+    it_should_truncate "html text with 2 attributes filtering all of them", with: {max_length: 3, count_tags: false, filtered_attributes: ['attr1', 'attr2']},
+                       source: "<p attr1='1' attr2='2'>some text</p>",
+                       expected: "<p>som...</p>"
+  end
+
+
 end
 

data/truncato.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "truncato"
-  s.version = "0.7.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jorge Manrubia"]
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.files = [
     ".rvmrc",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -52,6 +51,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
     else
       s.add_dependency(%q<truncato>, [">= 0"])
       s.add_dependency(%q<nokogiri>, ["~> 1.5.5"])
@@ -60,6 +61,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     end
   else
     s.add_dependency(%q<truncato>, [">= 0"])
@@ -69,6 +72,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<bundler>, ["~> 1.2.1"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: truncato
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -123,6 +123,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 description: Ruby tool for truncating HTML strings keeping a valid HTML markup
 email: jorge.manrubia@gmail.com
 executables: []
@@ -133,7 +165,6 @@ extra_rdoc_files:
 files:
 - .rvmrc
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -163,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3596249890284373376
+      hash: -4062483884007899469
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/Gemfile.lock

@@ -1,43 +0,0 @@
-PATH
-  remote: .
-  specs:
-    truncato (0.7.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    html_truncator (0.3.0)
-      nokogiri (~> 1.4)
-    htmlentities (4.3.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.5)
-    nokogiri (1.5.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.2.1)
-  html_truncator
-  htmlentities (~> 4.3.1)
-  jeweler (~> 1.8.4)
-  nokogiri (~> 1.5.5)
-  rspec (~> 2.11.0)
-  truncato!