escape_escape_escape 1.1.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86100684d36a9aff31d78415463e2a3c357fe646
-  data.tar.gz: 77b8c43cc053204953f747630c7fdd5938034ec5
+  metadata.gz: 475be5e9a0ff5184bf31e21eb5e2af467bd63a24
+  data.tar.gz: 79f586268536dfc6c6c21ffdaf3f3f38a9adfadd
 SHA512:
-  metadata.gz: 7705788caaf5f6c4996b5381c1b3d2e09d390a7ab5a795a0aa8d32ccbcdec772942caf3c433d06aa3145d36244b617f545193657ee8493582011d94b48ffeec5
-  data.tar.gz: 5a4785d7e96190194040cf9d9c7e766b1095ae742327d0e9b3486a1fcdd89e85c19cfb576486b3afad59e6cb7b3350e61ae7ebeb77d35a4568296a9bb0ef02e9
+  metadata.gz: ae1c2d11044288d7d1e0dc4036873247c35e969c35e3f64550ee52c629ca48b0cce081dd2e58fe92af8c8b8f51051ffd77df7c032298aad26c138b6756abc485
+  data.tar.gz: 72561e7f4040d2f2395c61e13c5e6516146014f1d1d2fdb8f630806590a5da5b5f7c478281d3e7bde24fad8f199dceda7395e13f15bc6dcc64250cb30d4a05fa

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.4.1

data/escape_escape_escape.gemspec

@@ -21,16 +21,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "addressable" , "> 2.3.5"
+  spec.add_runtime_dependency "addressable"  , "> 2.3.5"
   spec.add_runtime_dependency "escape_utils" , "> 1.0.0"
-  spec.add_runtime_dependency "unf" , "> 0.1.3"
+  spec.add_runtime_dependency "unf"          , "> 0.1.3"
   spec.add_runtime_dependency "htmlentities" , ">= 4.3.2"
+  spec.add_runtime_dependency "multi_json"   , "> 1.10.0"
+  spec.add_runtime_dependency "oj"           , "> 2.10.1"
 
   spec.add_development_dependency "pry"           , ">= 0.9"
   spec.add_development_dependency "rake"          , ">= 10.3"
   spec.add_development_dependency "bundler"       , ">= 1.5"
   spec.add_development_dependency "bacon"         , ">= 1.0"
   spec.add_development_dependency "Bacon_Colored" , ">= 0.1"
-  spec.add_development_dependency "multi_json"    , ">= 1.10"
   spec.add_development_dependency "sanitize"    , ">= 3.0.1"
 end

data/lib/escape_escape_escape.rb

@@ -22,6 +22,14 @@ require 'cgi' # Don't use URI.escape because it does not escape all invalid char
 require "addressable/uri"
 # ======================
 
+require 'oj'
+require 'multi_json'
+
+Oj.default_options = {:mode=>:strict}
+
+
+
+
 def Escape_Escape_Escape s
   Escape_Escape_Escape.escape(s)
 end
@@ -35,16 +43,20 @@ class Escape_Escape_Escape
 
   CODER              = HTMLEntities.new(:xhtml1)
 
-  Invalid            = Class.new(RuntimeError)
-  Invalid_HREF       = Class.new(RuntimeError)
-
-  Invalid_Type       = Class.new(RuntimeError)
+  Invalid               = Class.new(StandardError)
+  Invalid_HREF          = Class.new(Invalid)
+  Invalid_Relative_HREF = Class.new(Invalid_HREF)
+  Invalid_Type          = Class.new(Invalid)
 
   TAG_PATTERN        = /\A[a-z]([a-z0-9\_]{0,}[a-z]{1,})?\z/i
 
-  VALID_CSS_VALUE    = /\A[a-z0-9\;\-\_\#\ ]+\z/i
-  VALID_CSS_SELECTOR = /\A[a-z0-9\#\:\_\-\.\ ]+\z/i
-  VALID_CSS_ATTR     = /\A[a-z0-9-]+\z/i
+  VALID_CSS_VALUE      = /\A[a-z0-9\;\-\_\#\ ]+\z/i
+  VALID_CSS_SELECTOR   = /\A[a-z0-9\#\:\_\-\.\ ]+\z/i
+  VALID_CSS_ATTR       = /\A[a-z0-9-]+\z/i
+  VALID_CSS_CLASS_NAME = /\A[a-z0-9\_]+\z/i
+
+  VALID_HTML_ID  = /\A[a-z][0-9a-z_]*\z/;
+  VALID_HTML_TAG = /\A[a-z][0-9a-z_]*\z/;
 
   INVALID_FILE_NAME_CHARS = /[^a-z0-9\_\.]{1,}/i
 
@@ -58,9 +70,6 @@ class Escape_Escape_Escape
   NL             = "\n";
   SPACES         = /\ +/;
 
-  VALID_HTML_ID  = /\A[0-9a-z_]+\z/i;
-  VALID_HTML_TAG = /\A[0-9a-z_]+\z/i;
-
   REPEATING_DOTS = /\.{1,}/
 
   # === MULTI_CONTROL_CHARS: ==================================
@@ -197,6 +206,14 @@ class Escape_Escape_Escape
       end
     end
 
+    def relative_href raw_str
+      str = Escape_Escape_Escape.decode_html href(raw_str)
+      uri = URI.parse(str)
+      fail( Invalid_Relative_HREF, "Is not relative: #{str}" ) if uri.scheme
+
+      Escape_Escape_Escape.html str
+    end
+
     # ===============================================
     # HTML
     # ===============================================
@@ -222,6 +239,11 @@ class Escape_Escape_Escape
       EOF
     }
 
+    def css_class_name val
+      return val if val.is_a?(String) && val[VALID_CSS_CLASS_NAME]
+      fail(Invalid, "CSS class name: #{val.inspect}")
+    end
+
     # ===============================================
     # A better alternative than "Rack::Utils.escape_html". Escapes
     # various characters (including '&', '<', '>', and both quotation mark types)
@@ -231,10 +253,32 @@ class Escape_Escape_Escape
     # Text has to be UTF-8 before encoding, according to HTMLEntities gem.
     # Therefore, all text is run through <plaintext> before encoding.
     # ===============================================
-    def html( raw_text )
+    def html raw_text
       EscapeUtils.escape_html(decode_html(raw_text))
     end # === def html
 
+    def html_tag raw_o
+      case raw_o
+      when String, Symbol
+        str = raw_o.to_s.downcase
+        return str.to_sym if str[VALID_HTML_TAG]
+        raise Invalid, "Invalid chars: #{raw_o.inspect}"
+      else
+        fail TypeError, "Not a String or Symbol: #{raw_o.inspect}"
+      end
+    end
+
+    def html_id raw_o
+      case raw_o
+      when String, Symbol
+        str = raw_o.to_s.downcase
+        return str.to_sym if str[VALID_HTML_ID]
+        raise Invalid, "Invalid chars: #{raw_o.inspect}"
+      else
+        fail TypeError, "Not a String or Symbol: #{raw_o.inspect}"
+      end
+    end
+
     def escape o, method_name = :html
       if o.kind_of? Hash
         return(
@@ -253,6 +297,24 @@ class Escape_Escape_Escape
       fail Invalid, "Not a String, Number, Array, or Hash"
     end # === def
 
+    def json_encode o
+      case o
+      when Array
+        Oj.dump(o, mode: :strict)
+      else
+        fail Invalid, "Not an Array: #{o.inspect}"
+      end
+    end
+
+    def json_decode o
+      case o
+      when String
+        Oj.strict_load clean_utf8(o)
+      else
+        fail Invalid, "Not a String: #{o.inspect}"
+      end
+    end
+
   end # === class self ===
 
 end # === class Escape_Escape_Escape ===

data/specs/as_ruby/0003-css_class_name.rb

@@ -0,0 +1,24 @@
+
+
+it     'raises Invalid if has invalid chars:'
+input  'k k'
+raises Escape_Escape_Escape::Invalid, /k k/
+
+
+it     'raises Invalid if has invalid chars:'
+input  'k&k'
+raises Escape_Escape_Escape::Invalid, /k&k/
+
+
+it      'returns String if valid:'
+input   'my_name'
+output  'my_name'
+
+
+it       'raises Invalid if it contains a dash:'
+input    'my-name'
+raises   Escape_Escape_Escape::Invalid, /my-name/
+
+
+
+

data/specs/as_ruby/0005-html_id.rb

@@ -0,0 +1,40 @@
+
+
+it     'raises Invalid if it has invalid chars:'
+input  'a*'
+raises Escape_Escape_Escape::Invalid, /a\*/
+
+
+it      'returns a Symbol if a String is passed:'
+input   'a'
+output  :a
+
+
+it      'returns a Symbol if a Symbol is passed:'
+input   :a
+output  :a
+
+
+it      'downcases if passed a String:'
+input   'My_Id'
+output  :my_id
+
+
+it      'downcases if passed a Symbol:'
+input   :My_Id
+output  :my_id
+
+
+it       'raises Invalid if it begins with a number'
+input    '0a'
+raises    Escape_Escape_Escape::Invalid, /0a/
+
+
+it        'raises Invalid if it contains a dash'
+input     'my-id'
+raises    Escape_Escape_Escape::Invalid, /my-id/
+
+
+
+
+

data/specs/as_ruby/0005-html_tag.rb

@@ -0,0 +1,43 @@
+
+
+
+it     "raises Invalid if tag has invalid chars:"
+input  "a("
+raises Escape_Escape_Escape::Invalid, /a\(/
+
+
+it      "raises Invalid if tag starts w/ Numeric:"
+input   '9a'
+raises  Escape_Escape_Escape::Invalid, /9a/
+
+
+it      "allows numbers:"
+input   :a9
+output  :a9
+
+
+it      "allows underscores:"
+input   :a_a
+output  :a_a
+
+
+it      "downcases the tag:"
+input   "DiV"
+output  :div
+
+it      "downcases the tag:"
+input   :DiV
+output  :div
+
+
+it      "returns a Symbol if passed a Symbol:"
+input   :footer
+output  :footer
+
+
+it      "returns a Symbol if passed a String:"
+input   'footeR'
+output  :footer
+
+
+

data/specs/as_ruby/0021-relative_href.rb

@@ -0,0 +1,24 @@
+
+
+it     "raises Invalid_HREF if it has a javascript scheme:"
+input  "javascript://something"
+raises Escape_Escape_Escape::Invalid_HREF, /javascript/
+
+
+it     "raises Invalid_Relative_HREF if it has a http scheme:"
+input  "http://www.google.com"
+raises Escape_Escape_Escape::Invalid_Relative_HREF, /google/
+
+
+it     "returns string if it is relative:"
+input  "/file.jpg"
+output "/file.jpg"
+
+
+it     "returns string if it is relative:"
+input  "file/file/file.jpg"
+output "file/file/file.jpg"
+
+it     "escapes slashes:"
+input  "file/file.jpg"
+output "file/file.jpg"

data/specs/as_ruby/0050-json_decode.rb

@@ -0,0 +1,19 @@
+
+it     'strips unprintable chars'
+input  %^["a\u2029\u2028b"]^
+output ["ab"]
+
+
+it     'raises Oj::ParseError if invalid JSON:'
+input   'a'
+raises Oj::ParseError, /unexpected character/
+
+
+it     'raises Invalid if not a String:'
+input  1
+raises Escape_Escape_Escape::Invalid, /1/
+
+
+it     'uses :strict_load'
+input  Oj.dump(Object.new, :mode=>:object)
+output({"^o" => "Object"})

data/specs/as_ruby/0051-json_encode.rb

@@ -0,0 +1,19 @@
+
+it     'raises TypeError if it encounters an unallowed Object'
+input  [Object.new]
+raises TypeError, /Failed to dump Object Object/
+
+
+it     'raises Invalid if not an Array:'
+input( {'a'=>'hello'} )
+raises Escape_Escape_Escape::Invalid, /Not an Array/
+
+
+it     'raises Invalid if not an Array:'
+input  'a'
+raises Escape_Escape_Escape::Invalid, /Not an Array/
+
+
+it     'raises Invalid if not an Array:'
+input  1
+raises Escape_Escape_Escape::Invalid, /Not an Array: 1/

data/specs/escape_escape_escape.rb

@@ -46,11 +46,11 @@ class It_Dsl
 
     def << t
       if !args.empty?
-        fail "Unknown values pending for: #{tests.last[:describe]}: #{args.inspect}, #{o.inspect}"
+        fail "Unknown values pending for: #{tests.last[:describe]}: #{args.inspect}"
       end
 
       t[:it] = if t[:it].strip[/:\z/]
-                    "#{t[:it]} #{t[:input]}"
+                    "#{t[:it]} #{t[:input].inspect}"
                   else
                     t[:it]
                   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: escape_escape_escape
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.1
 platform: ruby
 authors:
 - da99
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.3.2
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.10.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
@@ -181,12 +195,18 @@ files:
 - specs/as_ruby/0001-html.rb
 - specs/as_ruby/0002-decode_html.rb
 - specs/as_ruby/0003-css_attr.rb
+- specs/as_ruby/0003-css_class_name.rb
 - specs/as_ruby/0003-css_selector.rb
 - specs/as_ruby/0003-css_value.rb
 - specs/as_ruby/0004-==.rb
+- specs/as_ruby/0005-html_id.rb
+- specs/as_ruby/0005-html_tag.rb
 - specs/as_ruby/0020-href.rb
+- specs/as_ruby/0021-relative_href.rb
 - specs/as_ruby/0030-clean_utf8.rb
 - specs/as_ruby/0040-escape.rb
+- specs/as_ruby/0050-json_decode.rb
+- specs/as_ruby/0051-json_encode.rb
 - specs/escape_escape_escape.rb
 - specs/lib/helpers.rb
 homepage: https://github.com/da99/escape_escape_escape