crazy_harry 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTcyY2M3ZDU3ODY3NmZhMjI5YmQzNTViOGJkNDU3OWZhNWZhZGRlMQ==
+  data.tar.gz: !binary |-
+    MjcyMDFmOWI4NzMxY2RiNzhlYjNlZWQzOGUzNWE3MzdhYmU5Y2MzOA==
+SHA512:
+  metadata.gz: !binary |-
+    MjlhYjM5NjUyYWE1NDg2YzM1MGUwYjdiMzcxNTZhZWMzYTQzZjczNDUzMDdl
+    ZWVhZjMyYzdmYjRkNjBkMjJiYjFmNzdlOTliMzZiYzlhMzg0Mjg4MDQ0OWZm
+    MjZjODQyZjkwZTQ5MWY2NTMxNTU2NjQyMDRkM2JlOTc1MDM2OTI=
+  data.tar.gz: !binary |-
+    ZWUxMTEzN2ExYTIxMmI5YTVhMTViNjRjMzExMmVlODY5YWYwZjlhZjIxYzk3
+    OGU2MGU1NDg4NTQwMTdhMzEzNzQ3MzYyOTc4YjY4MTAyOThlOTU4YjQxNzYy
+    MWYwZjk0NGViMTljODkyM2M0ODEyOWM0YTBlOWRhYzExMjgzNzA=

data/README.md

@@ -34,7 +34,7 @@ CrazyHarry wraps up a number these tasks in a simple DSL, while adding commands
 
 ## Default Actions
 
-It automatically removes blank tags, converts `<br \>` tags to wrapped
+It automatically removes blank tags, converts `<br />` tags to wrapped
 paragraphs and de-dupes content.  
 
 ## Chaining
@@ -107,6 +107,22 @@ only works for li tag for now.**
 
     CrazyHarry.fragment('<li>Flying list tag</li>').foster!.to_s
 
+will return:
+
+    <ul><li>Flying list tag</li></ul>
+
+## Truncating
+
+The `.truncate!` command will truncate input preserving HTML tags.
+
+    CrazyHarry.fragment( '<p>Long <b>text goes here</b></p>' ).truncate!(3)
+
+will return
+
+    <p>Long <b>text goes</b>…</p>
+
+It accepts hash of options and passes it to [HTML_Truncator](https://github.com/nono/HTML-Truncator). It returns self and can be chained with other commands.
+
 ## Known Issues/TODO
 
   * De-duping does not take account of whitespace.  So, `<p>Some Content</p>` and `<p>Some Content </p>` will not be treated as duplicates.

data/crazy_harry.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'guard-rspec', '>=1.0.1'
   s.add_development_dependency 'simplecov',   '>=0.6.4'
 
-  s.add_runtime_dependency 'loofah',          '>=1.2.1'
+  s.add_runtime_dependency 'loofah',          '~>1'
   s.add_runtime_dependency 'nokogiri',        '>=1.5.5'
+
+  s.add_dependency 'html_truncator',          '~>0.3'
 end

data/lib/crazy_harry/base.rb

@@ -5,6 +5,7 @@ module CrazyHarry
     include CrazyHarry::Redact
     include CrazyHarry::Translate
     include CrazyHarry::Foster
+    include CrazyHarry::Truncate
 
     attr_accessor :fragment, :scope, :steps, :text
 

data/lib/crazy_harry/truncate.rb

@@ -0,0 +1,10 @@
+require 'html_truncator'
+module CrazyHarry
+  module Truncate
+    def truncate!(count, opts = {})
+      truncated = HTML_Truncator.truncate(self.fragment.to_s, count, opts)
+      self.fragment = Loofah.fragment(truncated)
+      self
+    end
+  end
+end

data/lib/crazy_harry/version.rb

@@ -1,3 +1,3 @@
 module CrazyHarry
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/crazy_harry.rb

@@ -1,6 +1,6 @@
 require 'loofah'
 
-%w(default foster change redact translate base version).each do |load_lib|
+%w(default foster change redact translate truncate base version).each do |load_lib|
   require_relative "crazy_harry/#{load_lib}"
 end
 

data/spec/integration/crazy_harry_spec.rb

@@ -5,11 +5,12 @@ describe CrazyHarry do
   let(:harry) { CrazyHarry }
 
   it "should allow method chaining" do
-    harry.fragment('<script>STEAL COOKIE!</script><em>Place</em><p>Lodging</p><b>Location:</b>')
+    harry.fragment('<script>STEAL COOKIE!</script><em>Place</em><p>Lodging</p><b>Location:</b> Warsaw')
       .redact!( unsafe: true, tags: 'em' )
       .change!( from: 'b', to: 'h3' )
+      .truncate!(3, ellipsis: '...')
       .translate!( from_text: 'Lodging', to_text: 'Hotel', add_attributes: { class: 'partner' } )
-      .to_s.should == 'Place <p class="partner">Hotel</p><h3 class="partner">Location:</h3>'
+      .to_s.should == 'Place <p class="partner">Hotel</p><h3 class="partner">Location:</h3>...'
   end
 
   it "should not care about the chain order" do
@@ -17,6 +18,7 @@ describe CrazyHarry do
       .translate!( from_text: 'Lodging', to_text: 'Hotel', add_attributes: { class: 'partner' } )
       .redact!( unsafe: true, tags: 'em' )
       .change!( from: 'b', to: 'h3' )
+      .truncate!(3)
       .to_s.should == 'Place <p class="partner">Hotel</p><h3 class="partner">Location:</h3>'
   end
 

data/spec/lib/crazy_harry_spec.rb

@@ -75,10 +75,7 @@ describe CrazyHarry do
         harry.fragment('<h3>Here</h3><p>Yep, here.</p><h3>Here</h3><p>Here again.</p>').to_s.should == '<h3>Here</h3><p>Yep, here.</p><p>Here again.</p>'
       end
 
-      it "should de-dupe if the only content difference is whitespace" do
-        pending "Too complicated for the first cut."
-      end
-
+      it "should de-dupe if the only content difference is whitespace"
     end
 
     context 'with default br processing overridden' do

data/spec/lib/truncate_spec.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe CrazyHarry::Truncate do
+  let(:harry){ CrazyHarry }
+
+  it "truncate by number of words" do
+    harry.fragment('<p>text goes here</p>').truncate!(2).to_s.should == '<p>text goes…</p>'
+  end
+
+  it "closes html tags properly" do
+    harry.fragment('<p>text <b>goes here</b></p>').truncate!(2).to_s.should == '<p>text <b>goes</b>…</p>'
+  end
+
+  it "passes extra options to HTML_Truncator" do
+    harry.fragment('<p>text goes here</p>').truncate!(10, length_in_chars: true, ellipsis: ' (...)').to_s
+      .should == '<p>text goes (...)</p>'
+  end
+end

metadata

@@ -1,82 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: crazy_harry
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - TA Tyree
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2155892060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *2155892060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2155891280 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *2155891280
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2155890600 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :development
   prerelease: false
-  version_requirements: *2155890600
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2155889820 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.6.4
   type: :development
   prerelease: false
-  version_requirements: *2155889820
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: loofah
-  requirement: &2155889320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '1'
   type: :runtime
   prerelease: false
-  version_requirements: *2155889320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2155888760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.5.5
   type: :runtime
   prerelease: false
-  version_requirements: *2155888760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+- !ruby/object:Gem::Dependency
+  name: html_truncator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: CrazyHarry is a high-level html fragment sanitiser/cleaner based on Loofah.
 email:
 - todd.tyree@lonelyplanet.co.uk
@@ -98,6 +129,7 @@ files:
 - lib/crazy_harry/foster.rb
 - lib/crazy_harry/redact.rb
 - lib/crazy_harry/translate.rb
+- lib/crazy_harry/truncate.rb
 - lib/crazy_harry/version.rb
 - rvmrc.example
 - spec/fixtures/golden_nugget.html
@@ -108,30 +140,30 @@ files:
 - spec/lib/foster_spec.rb
 - spec/lib/redact_spec.rb
 - spec/lib/translate_spec.rb
+- spec/lib/truncate_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/lonelyplanet/crazy_harry
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: crazy_harry
-rubygems_version: 1.8.10
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A High level HTML fragment sanitizer.
 test_files:
 - spec/fixtures/golden_nugget.html
@@ -142,4 +174,5 @@ test_files:
 - spec/lib/foster_spec.rb
 - spec/lib/redact_spec.rb
 - spec/lib/translate_spec.rb
+- spec/lib/truncate_spec.rb
 - spec/spec_helper.rb