feedfilter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4e6f33ca3e35338b0d1e32d81fda9b4fef4bf18
-  data.tar.gz: 89b6850ef5738a0c092d9abb33e976e403dea277
+  metadata.gz: 81bab08453558167699203ea2a2ee6159a0fbaae
+  data.tar.gz: 83d6db5270e1ee8d8444b8334b96d364faba4bfe
 SHA512:
-  metadata.gz: 259ab66f191ae4f1ce880d760cdecc2c891b3dfa5e5f47f8f98c37e35b135e71381e2d21d77a6a043ba2a6316405c6fe1dc7faf4c71865dd2221cadcd8eae196
-  data.tar.gz: fc9b241d1fe969884fb1a7436e7dd97034858395c29dade025094824dafaba16e06710b7ff9aa6f35b44e4be5bfb8513f4951aff0afe7f614f5a8e15cc970e8c
+  metadata.gz: 59cd7df83d51380bfc8aa9bb524b086d05c24137f83dd1be29b89db9be885c1366b0fea95a4e132e0b251a169c37ba662a42fc89fbaff6bcc20524c0c402634b
+  data.tar.gz: 11ce28d9351a39e2e9a5ad736f7594194ebf7a07fc8417b240418871d3b96ef3487655f684e23fcdc69df08b6e88d28459026bf31f052c3f7c4f8b2260ac3d51

data/Manifest.txt

@@ -2,5 +2,13 @@ HISTORY.md
 Manifest.txt
 README.md
 Rakefile
+config/feedburner.txt
+config/feedflare.txt
 lib/feedfilter.rb
+lib/feedfilter/ads.rb
+lib/feedfilter/block_reader.rb
 lib/feedfilter/version.rb
+test/helper.rb
+test/test_ads.rb
+test/test_ads_all.rb
+test/test_block_reader.rb

data/config/feedburner.txt

@@ -0,0 +1,21 @@
+####################################
+# feedburner text pattern (regex)
+#
+#  pattern (regex)
+#  ---
+#  test1
+#  ---
+#  test2
+#  ---
+#  etc.
+
+
+<img[^>]*?
+  src=("|')(:?http:)?//feeds\.feedburner\.com/~r/[^>]+?\1
+  .*?>
+
+---
+
+<img src="//feeds.feedburner.com/~r/Rubyflow/~4/1wUDnBztAJY" height="1" width="1" alt=""/>
+
+

data/config/feedflare.txt

@@ -0,0 +1,17 @@
+###################################
+# feedflare text pattern (regex)
+
+<div[^>]*?
+  class=("|')feedflare\1
+  [^>]*?>
+    .*?
+<\/div>
+
+---
+
+<div class="feedflare">
+ <a href="http://feeds.feedburner.com/~ff/Rubyflow?a=1wUDnBztAJY:fzqBvTOGB9M:3H-1DwQop_U">
+   <img src="http://feeds.feedburner.com/~ff/Rubyflow?i=1wUDnBztAJY:fzqBvTOGB9M:3H-1DwQop_U" border="0"></img>
+ </a>
+</div>
+

data/lib/feedfilter.rb

@@ -6,14 +6,16 @@
 
 # 3rd party gems/libs
 
-require 'logutils'
+require 'textutils'
 
 # our own code
 
 require 'feedfilter/version'  # let it always go first
 require 'feedfilter/ads'
 
+require 'feedfilter/block_reader'   ## todo/fix: move to textutils!!!!
 
 
 # say hello
 puts FeedFilter.banner     if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)
+

data/lib/feedfilter/ads.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+
+module FeedFilter
+
+
+class AdsFilters
+
+  include LogUtils::Logging
+
+  def initialize
+    @filters=[]
+
+    names=[
+      'feedburner',
+      'feedflare'
+    ]
+
+    names.each do |name|
+      logger.debug "  add ads filter #{name}"
+
+      b = BlockReader.from_file( "#{FeedFilter.root}/config/#{name}.txt").read
+      ## Note: replace newline and space in string for regex (w/o spaces)
+      ## Note: add multiline option and ignore case
+      regexp = Regexp.new( b[0].gsub( /[\n ]/, '' ), Regexp::MULTILINE|Regexp::IGNORECASE )
+      @filters << [name, regexp]
+    end
+  end
+
+  def filter( text )
+    @filters.each do |f|
+      name     = f[0]
+      pattern  = f[1]
+      
+      text = text.gsub( pattern ) do |m|
+        # Note: m - match is just a regular string
+        ##  double check if it's true also if regex contains capture groups ???
+        puts "strip #{name}:"
+        pp m
+        ''
+      end
+    end # each filter
+    text
+  end  # filter
+
+end # AdsFilters
+
+
+  def self.strip_ads( text )  
+    @@ads_filters ||= FeedFilter::AdsFilters.new
+    @@ads_filters.filter( text )
+  end
+
+
+  module AdsFilter
+    def strip_ads( text )
+      FeedFilter.strip_ads( text )
+    end
+  end # module AdsFilter
+
+end # module FeedFitler
+

data/lib/feedfilter/block_reader.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+####
+## todo: move to textutils for re(use) ?????
+
+class BlockReader
+
+  include LogUtils::Logging
+
+  def self.from_file( path )
+    ## nb: assume/enfore utf-8 encoding (with or without BOM - byte order mark)
+    ## - see textutils/utils.rb
+   text = File.read_utf8( path )
+   self.from_string( text )
+  end
+
+  def self.from_string( text )
+    self.new( text )
+  end
+
+  def initialize( text )
+    @text = text
+  end
+
+  def read
+    ## note returns an array of (line) strings e.g.
+    ## [
+    ##  "line1\nline2",         ## -- block1
+    ##  "line1\nline2\nline3"   ## -- block2
+    ## ]
+
+    blocks = []
+    buf = ""
+
+    @text.each_line do |line|
+       # comments allow:
+       # 1) ##### (shell/ruby style)
+       if line =~ /^\s*#/ 
+          # skip komments and do NOT copy to result (keep comments secret!)
+         logger.debug 'skipping comment line'
+         next
+       end
+
+#       if line =~ /^\s*$/
+#         # kommentar oder leerzeile überspringen
+#         logger.debug 'skipping blank line'
+#         next
+#       end
+
+       # pass 2) remove leading and trailing whitespace
+       line = line.strip
+
+       if line =~ /^-{3,}$/   ## three or more lines
+         logger.debug 'block separator'
+         blocks << buf.strip   ## note: strip leading and trailing whitespace
+         buf = ""
+       else
+         buf << "#{line}\n"
+       end
+    end # each lines
+
+    blocks << buf.strip ## note: strip leading and trailing whitespace
+    blocks
+  end # method read
+
+end # class BlockReader
+

data/lib/feedfilter/version.rb

@@ -3,7 +3,7 @@
 module FeedFilter
 
   MAJOR = 0
-  MINOR = 2
+  MINOR = 3
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/helper.rb

@@ -0,0 +1,14 @@
+## $:.unshift(File.dirname(__FILE__))
+
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+
+require 'feedfilter'
+
+LogUtils::Logger.root.level = :debug
+

data/test/test_ads.rb

@@ -11,19 +11,28 @@ class TestAds < MiniTest::Test
 
   include FeedFilter::AdsFilter
 
+
   def test_feedflare_ads
-     text = read_snippet( 'feedflare.html' )
+     text =<<EOS
+<div class="feedflare">
+ <a href="http://feeds.feedburner.com/~ff/Rubyflow?a=1wUDnBztAJY:fzqBvTOGB9M:3H-1DwQop_U">
+   <img src="http://feeds.feedburner.com/~ff/Rubyflow?i=1wUDnBztAJY:fzqBvTOGB9M:3H-1DwQop_U" border="0"></img>
+ </a>
+</div>
+EOS
      text = strip_ads( text ).strip
 
      assert_equal '', text
   end
 
+
   def test_feedburner_bugs
-     text = read_snippet( 'feedburner.html' )
+     text =<<EOS
+<img src="//feeds.feedburner.com/~r/Rubyflow/~4/1wUDnBztAJY" height="1" width="1" alt=""/>
+EOS
      text = strip_ads( text ).strip
 
      assert_equal '', text
   end
 
-
 end # class TestAds

data/test/test_ads_all.rb

@@ -0,0 +1,29 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_ads_all.rb
+#  or better
+#     rake test
+
+require 'helper'
+
+
+class TestAdsAll < MiniTest::Test
+
+  def test_all
+    names=[
+      'feedburner',
+      'feedflare'
+    ]
+
+    names.each do |name|
+      b = BlockReader.from_file( "#{FeedFilter.root}/config/#{name}.txt").read
+      ## Note: replace newline and space in string for regex (w/o spaces)
+      ## Note: add multiline option and ignore case
+      regexp = Regexp.new( b[0].gsub( /[\n ]/, '' ), Regexp::MULTILINE|Regexp::IGNORECASE )
+      test1  = b[1]
+
+      assert_equal '', test1.gsub( regexp, '' ).strip
+    end
+  end
+
+end # class TestAdsAll

data/test/test_block_reader.rb

@@ -0,0 +1,25 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_block_reader.rb
+#  or better
+#     rake test
+
+require 'helper'
+
+
+class TestBlockReader < MiniTest::Test
+
+  def test_feedburner
+     blocks = BlockReader.from_file( "#{FeedFilter.root}/config/feedburner.txt" ).read
+
+     ## note: regex - use %q - do NOT escape \. or \1 etc.
+     pattern = %q{<img[^>]*?src=("|')(:?http:)?//feeds\.feedburner\.com/~r/[^>]+?\1.*?>}
+
+     test1   = %q{<img src="//feeds.feedburner.com/~r/Rubyflow/~4/1wUDnBztAJY" height="1" width="1" alt=""/>}
+
+     assert_equal 2, blocks.size
+     assert_equal pattern, blocks[0].gsub( /[\n ]/, '' )  ## note: need to remove newlines and spaces
+     assert_equal test1,   blocks[1]
+  end
+
+end # class TestBlockReader

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedfilter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -60,15 +60,24 @@ extra_rdoc_files:
 - HISTORY.md
 - Manifest.txt
 - README.md
+- config/feedburner.txt
+- config/feedflare.txt
 files:
 - ".gemtest"
 - HISTORY.md
 - Manifest.txt
 - README.md
 - Rakefile
+- config/feedburner.txt
+- config/feedflare.txt
 - lib/feedfilter.rb
+- lib/feedfilter/ads.rb
+- lib/feedfilter/block_reader.rb
 - lib/feedfilter/version.rb
+- test/helper.rb
 - test/test_ads.rb
+- test/test_ads_all.rb
+- test/test_block_reader.rb
 homepage: https://github.com/feedreader/feed.filter
 licenses:
 - Public Domain
@@ -96,4 +105,6 @@ signing_key:
 specification_version: 4
 summary: feedfilter - feed filter and rules for easy (re)use
 test_files:
+- test/test_ads_all.rb
 - test/test_ads.rb
+- test/test_block_reader.rb