hscrubber 0.0.2 → 0.0.3

data/.document

@@ -1,4 +1,4 @@
-README.rdoc
+README.md
 lib/**/*.rb
 bin/*
 LICENSE

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in priehlazx.gemspec
+# Specify your gem's dependencies in hscrubber.gemspec
 gemspec

data/README.en.md

@@ -0,0 +1,85 @@
+# HScrubber
+
+HScrubber is HTML reha engine, and it allows filtering an input flow according to the special reha template that is formed as YAML-document.
+
+# Reha
+## Description of reha filter
+
+Reha is set up as an YAML-document. The allowed in an output flow HTML tags is described at the top level of the document. The following level described allowed attributes of the specified tag, and also rule keys that controls the tag and ots containment. The keys, and its values are the following:
+
+ * '_' declares that the containment of the tag will be cleaned up, if it matches to the specified rule;
+
+ * '-' a tag will be removed, if its containment matches to the specified rule;
+
+ * '^' containment of a tag will be added to containment of the parent tag, if containment of the tag matches to the specified rule, or if the rule isn't defined;
+
+ * '%' sets the attributes order in the output file. The attributes is writing via comma.
+
+The keys are ranged according to priority their analysing. The '@' symbol necessarily outruns each of the keys.
+
+## Sample
+
+Sample reha template is described as follows:
+
+    ---
+    html:
+    body:
+    p:
+    i:
+      @-: ^[.,:;!?\s]*$
+    font:
+      face:
+      size:
+      @%: size,face
+      @-: ^\s+$
+      @_: ^[.,:!?#]+$
+    span:
+      @^:
+      @-: ^[.,:;!?\s]*$
+    
+Descriptions:
+
+Tag 'i' hasn't allowable attributes, so them will be removed from an output stream. In case, the tag containment meets a remove rule, the tag will be absent in the output;
+
+
+    <i id="i_id">Text</i> -> <i>Text</i>
+    <font>Text<i>?</i></font> -> <font>Text</font>
+
+Allowable attributes for the 'font' tag are 'face', and 'size'. In case, if the tag containment meets a remove rule, the tag will be absent in the output, and if meets a cleanup rule, the containment will be purged, and the attributes will be ordered as 'size', and then 'face';
+
+    <font size="5" color="blue">Text</font> -> <font size="5">Text</font>
+    <i>Text<font>  </font></i> -> <i>Text</i>
+    <i>Text<font>??</font></i> -> <i>Text<font></font></i>
+    <font face="Arial" size="5">Text</font> -> <font size="5" face="Arial">Text</font>
+
+Tag 'span' hasn't allowable attributes, so them will be removed from an output stream. In case, the tag containment meets a remove rule, the tag will be absent in the output as it is. In other cases, its containment will be added to a parent tag.
+
+    <span id="span_id">Text</span> -> <span>Text</span>
+    <i>Text<span>?</span></i> -> <i>Text</i>
+
+## Usage
+There are 2 ways to use the package in ruby applications.
+
+### Using the class instance method
+Make a class instance, passing a reha to its initialize function. The reha must be loaded as a String, or an IO class. Then filter a HTML:
+
+    рѣха = IO.read('.рѣха.yml.sample')
+    hs = HScrubber.new(рѣха)
+
+    html = IO.read('sample.html').gsub(/\r/, '')
+    new_html = hs.scrub_html(html)
+
+    puts html
+
+### Using the class method
+Thou art able to filter the HTML-document without a class instance creation. Do as follows:
+
+    рѣха = IO.read('.рѣха.yml.sample')
+    html = IO.read('sample.html').gsub(/\r/, '')
+    new_html = HScrubber.scrub_html(html, рѣха)
+
+    puts html
+
+# Copyright
+Copyright (c) 2011 Malo Skrylevo. See LICENSE for details.
+

data/README.md

@@ -1,37 +1,25 @@
-# HScrubber
+# Урѣзчикъ (HScrubber)
 
 HScrubber есть движокъ для прорѣшиванія HTML-документа. Онъ позволяетъ процѣдить содержимое входного потока очистивъ его отъ ненужныхъ предмѣтовъ на основѣ рѣхи, являющейся YAML-документомъ, по опредѣлённымъ правиламъ состаленнымъ.
 
-HScrubber is HTML reha engine, and it allows filtering an input flow according to the special reha template that is formed as YAML-document.
-
-# Рѣха (Reha)
-## Объясненіе рѣхи (Description of reha filter)
+# Рѣха
+## Объясненіе рѣхи
 
 Рѣха задаётся въ видѣ YAML-документа. На самомъ верхнемъ уровнѣ описываются мѣты (HTML tags), допустимыя въ выходномъ документѣ. Слѣдующій уровень задаётъ допустимыя свойства (attributes) для опредѣлённой мѣты, а также ключи, управляющія мѣтою и её содержимымъ. Возможныя ключи и их значенія суть такія:
 
- * '%' содержимое мѣты будетъ очищено, если оно подпадаетъ подъ заданное въ значеніи ключа правило;
+ * '_' содержимое мѣты будетъ очищено, если оно подпадаетъ подъ заданное въ значеніи ключа правило;
 
  * '-' мѣта удаляется въ томъ случаѣ, если её содержимое подпадаетъ подъ заданное въ значеніи ключа правило;
 
- * '^' содержимое мѣты добавляется къ содержимому родителькой мѣты въ томъ случаѣ, если содержимое сей мѣты подпадаетъ подъ правило, или если правило не задано.
-
-Ключи здѣ расположены въ порядкѣ первичности ихъ провѣрки. Каджый изъ нихъ обязательно предваряется символомъ '@'
-
-Reha is set up as an YAML-document. The allowed in an output flow HTML tags is described at the top level of the document. The following level described allowed attributes of the specified tag, and also rule keys that controls the tag and ots containment. The keys, and its values are the following:
+ * '^' содержимое мѣты добавляется къ содержимому родителькой мѣты въ томъ случаѣ, если содержимое сей мѣты подпадаетъ подъ правило, или если правило не задано;
 
- * '%' declares that the containment of the tag will be cleaned up, if it matches to the specified rule;
+ * '%' задаётъ порядокъ слѣдованія ключей мѣты въ выходномъ файлѣ. Ключи пишутся черезъ запятую.
 
- * '-' a tag will be removed, if its containment matches to the specified rule;
-
- * '^' containment of a tag will be added to containment of the parent tag, if containment of the tag matches to the specified rule, or if the rule isn't defined.
-
-The keys are ranged according to priority their analysing. The '@' symbol necessarily outruns each of the keys.
+Ключи здѣ расположены въ порядкѣ первичности ихъ провѣрки. Каджый изъ нихъ обязательно предваряется символомъ '@'
 
-## Примѣръ (Sample)
+## Примѣръ
 Примѣрный шаблонъ файла рѣхи представленъ нижѣ:
 
-Sample reha template is described as follows:
-
     ---
     html:
     body:
@@ -41,8 +29,9 @@ Sample reha template is described as follows:
     font:
       face:
       size:
+      @%: size,face
       @-: ^\s+$
-      @%: ^[.,:!?#]+$
+      @_: ^[.,:!?#]+$
     span:
       @^:
       @-: ^[.,:;!?\s]*$
@@ -54,33 +43,24 @@ Sample reha template is described as follows:
     <i id="i_id">Text</i> -> <i>Text</i>
     <font>Text<i>?</i></font> -> <font>Text</font>
 
-Допустимыми ключами для мѣты 'font' являются 'face' и 'size'. Въ случаѣ, если содержимое мѣты удовлѣтворяетъ правилу удаления, на выходѣ сія мѣта будетъ отсутствовать, а если правилу очищенія, то её содержимое станетъ порожнимъ. Примѣры:
+Допустимыми ключами для мѣты 'font' являются 'face' и 'size'. Въ случаѣ, если содержимое мѣты удовлѣтворяетъ правилу удаления, на выходѣ сія мѣта будетъ отсутствовать, а если правилу очищенія, то её содержимое станетъ порожнимъ, ключи будутъ расположены въ порядкѣ size, face. Примѣры:
 
     <font size="5" color="blue">Text</font> -> <font size="5">Text</font>
     <i>Text<font>  </font></i> -> <i>Text</i>
     <i>Text<font>??</font></i> -> <i>Text<font></font></i>
+    <font face="Arial" size="5">Text</font> -> <font size="5" face="Arial">Text</font>
 
 Допустимыя ключи для мѣты 'span' отсутствуютъ, и въ случаѣ ихъ обнаруженія въ входномъ потокѣ они будутъ вырѣзаны изъ него. Если содержимое мѣты удовлѣтворяетъ правилу удаления, на выходѣ сія мѣта будетъ отсутствовать какъ таковая. Въ остальныхъ же случаяхъ её содержимое будетъ добавлено къ мѣтѣ родительской. Примѣры:
 
     <span id="span_id">Text</span> -> <span>Text</span>
     <i>Text<span>?</span></i> -> <i>Text</i>
 
-Descriptions:
+## Использованіе
+Суть 2 способа использованія пакета въ ruby-приложеніяхъ.
 
-Tag 'i' hasn't allowable attributes, so them will be removed from an output stream. In case, the tag containment meets a remove rule, the tag will be absent in the output;
-
-Allowable attributes for the 'font' tag are 'face', and 'size'. In case, if the tag containment meets a remove rule, the tag will be absent in the output, and if meets a cleanup rule, the containment will be purged;
-
-Tag 'span' hasn't allowable attributes, so them will be removed from an output stream. In case, the tag containment meets a remove rule, the tag will be absent in the output as it is. In other cases, its containment will be added to a parent tag.
-
-## Использованіе (Usage)
-Суть 2 способа испозованія пакета въ ruby-приложеніяхъ.
-
-### Используя методъ экземпляра класса (Using the class instance method)
+### Используя методъ экземпляра класса
 Создай экземпляръ класса, передавъ конструктору рѣху загруженную въ видѣ строки или IO-класса, а затѣмъ прорѣши HTML-документъ:
 
-Make a class instance, passing a reha to its initialize function. The reha must be loaded as a String, or an IO class. Then filter a HTML:
-
     рѣха = IO.read('.рѣха.yml.sample')
     hs = HScrubber.new(рѣха)
 
@@ -89,22 +69,15 @@ Make a class instance, passing a reha to its initialize function. The reha must
 
     puts html
 
-### Используя методъ класса (Using the class method)
+### Используя методъ класса
 Можно прорѣшить HTML-документъ и не создавая экземпляръ класса. Тогда дѣлай такъ:
 
-We able to filter the HTML-document without a class instance creation. Do as follows:
-
     рѣха = IO.read('.рѣха.yml.sample')
     html = IO.read('sample.html').gsub(/\r/, '')
     new_html = HScrubber.scrub_html(html, рѣха)
 
     puts html
 
-# Права (Copyright)
-
-Авторскія и исключительныя права (а) 2011 Малъ Скрылевъ
-Зри LICENSE за подробностями.
-
-Copyright (c) 2011 Malo Skrylevo
-See LICENSE for details.
+# Права
 
+Авторскія и исключительныя права (а) 2011 Малъ Скрылевъ. Зри LICENSE за подробностями.

data/hscrubber.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = '>= 1.6.0'
 
+  s.add_dependency 'rdoba', ">= 0.1"
   s.add_dependency 'hpricot', ">= 0.8.4"
 
   s.add_development_dependency("bundler", ">= 1.0.0")

data/lib/hscrubber.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/ruby -KU
 # encoding: utf-8
 
+require 'rdoba/hashorder'
 require 'yaml'
 require 'hpricot'
 require 'hscrubber/version'
@@ -82,7 +83,7 @@ class HScrubber
       changed
   end
 
-  def self.scrub_remove_by_rule(elem, verility)
+  def self.process_specials(elem, verility)
       changed = nil
       repeat = true
 
@@ -111,6 +112,8 @@ class HScrubber
 				  repeat = true; changed = true
 			      end
 			  end
+		      when '@%'
+			  (sub.raw_attributes.order = value.split(',').map do |x| x.strip end) if value
 		      when '@^'
 			  inner = sub.inner_html.gsub(/(\r\n|\n)/,' ')
 			  unless value and self.fix(inner) !~ /#{value}/
@@ -123,8 +126,8 @@ class HScrubber
 				  repeat = true; changed = true
 			      end
 			  end
-		      when '@%'
-			  # replace elem if match to re
+		      when '@_'
+			  # clear elem if match to re
 			  inner = sub.inner_html.gsub(/(\r\n|\n)/,' ')
 			  if self.fix(inner) =~ /#{value}/
 			      new = Hpricot::Text.new("\x1F")
@@ -163,58 +166,10 @@ class HScrubber
       changed
   end
 
-  def self.scrub_replace_by_rule(elem, verility)
-      changed = nil
-      repeat = true
-
-      res = []
-
-      elem.children.each do |sub|
-	  repeat = false
-	  sub_ch = nil
-	  case sub.class.to_s
-	  when 'Hpricot::Elem'
-	      if sub.children and verility.key? sub.name
-		  strip_tags = []
-		  verility[sub.name].each do |key, value|
-		      # TODO match value to as regexp to attr value
-		      case key
-		      when '@%'
-			  # replace elem if match to re
-			  inner = sub.inner_html.gsub(/(\r\n|\n)/,' ')
-			  if self.fix(inner) =~ /#{value}/
-			      new = Hpricot::Text.new("\x1F")
-			      new.parent = sub
-			      sub.children.replace [ new ]
-			      changed = true
-			  end
-		      end
-		  end if verility[sub.name]
-	      else
-		  repeat = true; changed = true
-	      end
-	  when 'Hpricot::Text'
-	  else
-	      repeat = true; changed = true
-	  end if sub.parent == elem
-	  if not repeat
-	      if sub_ch
-		  res.concat sub_ch
-	      else
-		  res << sub
-	      end
-	  end
-      end if elem.children and not elem.children.empty?
-
-      elem.children.replace res
-
-      changed
-  end
-
   def self.scrub_elem(elem, verility)
       while (
 	  self.scrub_children(elem, verility) ||
-	  self.scrub_remove_by_rule(elem, verility) ||
+	  self.process_specials(elem, verility) ||
 	  self.scrub_follower(elem) ||
 	  self.scrub_special(elem))
       end

data/lib/hscrubber/version.rb

@@ -1,3 +1,3 @@
 class HScrubber
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,129 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hscrubber
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
-- !binary |
-  0JzQsNC70Yog0KHQutGA0YvQu9GR0LLRiiAoTWFsbyBTa3J5bGV2byk=
-
+authors:
+- Малъ Скрылёвъ (Malo Skrylevo)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-05 00:00:00 +04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
+date: 2011-05-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoba
+  requirement: &69581990 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *69581990
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &69624550 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 55
-        segments: 
-        - 0
-        - 8
-        - 4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.8.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *69624550
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &69624320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *69624320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &69624090 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 2
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *69624090
 description: hscrubber is HTML scrubber based on a HTML reha filter
-email: 
+email:
 - 3aHyga@gmail.com
-executables: 
+executables:
 - hscrub
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
+- .rspec
 - CHANGES.md
 - Gemfile
 - LICENSE
+- README.en.md
 - README.md
 - Rakefile
 - bin/hscrub
 - hscrubber.gemspec
 - lib/hscrubber.rb
 - lib/hscrubber/version.rb
-has_rdoc: true
 homepage: https://github.com/3aHyga/hscrubber
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 15
-      segments: 
-      - 1
-      - 6
-      - 0
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.6.0
 requirements: []
-
 rubyforge_project: hscrubber
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: hscrubber is HTML scrubber
 test_files: []
-