uri_encoding 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5f8aae210a6dd4c612344e0df46f05def7de411
-  data.tar.gz: 83c0d50dc3d711b5a422f8b676f919e70f2709ba
+  metadata.gz: 864c1bfccc6eaa73163f8a0b9647b90588dd7712
+  data.tar.gz: 5b3d86dcaa63bf612b9897a3de75ef5af5291b6a
 SHA512:
-  metadata.gz: d6cdbc41a611966f2f9d56fb3713bea5422ac87fc2955c8ca945c2fd4953dbc20a45fcb91f935bf0c565c44be40b933106b8267d1e0004a68f5ac82d42884e11
-  data.tar.gz: f17f755131eba4bf92dbe60cfe31d004cb2296600923752b90c9c522366e7ba42d94d3f4ebee663447d10d67b1cb6be03137c029d43bf9d52a0589c577c0a8b8
+  metadata.gz: 990a727a76729c3657a62b4f99b9b12e9007e0ec7dd9426f9f22232c530742d60ee717367f5318cfe56f4bda72ded98eceeda83f2c4e36c20eb988df21200b03
+  data.tar.gz: d85897b11abf01cd6ab16b4ac6116d3e20f721b918de6ef56577c9ef73d31c69b6245479471b97dbe76aeb93e2ab4b0b4310eabced788290de72ed0afb7044f6

data/README.md

@@ -1,9 +1,10 @@
 # UriEncoding
 
+[![Gem Version](https://badge.fury.io/rb/uri_encoding.svg)](http://badge.fury.io/rb/uri_encoding)
 [![Build Status](https://travis-ci.org/s-osa/uri_encoding.svg?branch=master)](https://travis-ci.org/s-osa/uri_encoding)
 [![Coverage Status](https://coveralls.io/repos/s-osa/uri_encoding/badge.png?branch=master)](https://coveralls.io/r/s-osa/uri_encoding?branch=master)
 
-TODO: Write a gem description
+Simple utility for URI encoding(URL encoding, percent encoding).
 
 ## Installation
 
@@ -18,10 +19,31 @@ And then execute:
 Or install it yourself as:
 
     $ gem install uri_encoding
-
+    
 ## Usage
 
-TODO: Write usage instructions here
+### Basic
+
+```ruby
+UriEncoding.encode("Aa1!?_%") #=> "Aa1!?_%25"
+UriEncoding.decode("Aa1!?_%25") #=> "Aa1!?_%"
+```
+
+### Optional
+
+`UriEncoding.encode` receives exceptions for encoding.
+
+```ruby
+UriEncoding.encode("Aa1!?_%", []) #=> "%41%61%31%21%3F%5F%25"
+UriEncoding.encode("Aa1!?_%", UriEncoding::UnreservedCharacters) #=> "Aa1%21%3F_%25"
+```
+
+`UriEncoding.decode` receives decoded string encoding.
+
+```ruby
+string = UriEncoding.decode("%82%A0%82%A2%82%A4", Encoding::Windows_31J) #=> "あいう"
+string.encoding #=> #<Encoding:Windows-31J>
+```
 
 ## Contributing
 

data/lib/uri_encoding/decoder.rb

@@ -2,10 +2,10 @@ module UriEncoding
   class Decoder
     EncodedCharRegexp = /^%([0-9A-Fa-f]{2})$/
 
-    def decode(str)
-      encoded_chars = split_encoded_string(str)
-      decoded_chars = encoded_chars.map{|c| decode_char(c) }
-      decoded_chars.join
+    def decode(str, encoding=nil)
+      single_byte_expressions = split_encoded_string(str)
+      bytes_string = single_byte_expressions.map{|e| convert_to_byte(e) }.join
+      bytes_string.force_encoding(encoding || str.encoding)
     end
 
     private
@@ -20,8 +20,8 @@ module UriEncoding
       arr
     end
 
-    def decode_char(char)
-      char =~ EncodedCharRegexp ?  Integer("0x#{$1}").chr : char
+    def convert_to_byte(exp)
+      exp =~ EncodedCharRegexp ?  Integer("0x#{$1}").chr : exp
     end
   end
 end

data/lib/uri_encoding/version.rb

@@ -1,3 +1,3 @@
 module UriEncoding
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/support/mappings.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 def default_mappings
   {
     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" => "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
@@ -42,6 +44,9 @@ def default_mappings
     "{" => "%7B",
     "|" => "%7C",
     "}" => "%7D",
+
+    # multibyte character
+    "あいう" => "%E3%81%82%E3%81%84%E3%81%86",
   }
 end
 
@@ -89,5 +94,19 @@ def everything_escaped_mappings
     "{" => "%7B",
     "|" => "%7C",
     "}" => "%7D",
+
+    # multibyte character
+    "あいう" => "%E3%81%82%E3%81%84%E3%81%86",
+    "あいう".encode(Encoding::Windows_31J) => "%82%A0%82%A2%82%A4".encode(Encoding::Windows_31J),
   }
 end
+
+def multibyte_mappings
+  [
+    {
+      source: "あいう".encode(Encoding::Windows_31J),
+      encoded: "%82%A0%82%A2%82%A4",
+      encoding: Encoding::Windows_31J
+    },
+  ]
+end

data/spec/uri_encoding/decoder_spec.rb

@@ -28,5 +28,14 @@ describe UriEncoding::Decoder do
         end
       end
     end
+
+    context "with encoding argument" do
+      multibyte_mappings.each do |mapping|
+        describe "#{mapping[:encoded]} as #{mapping[:encoding]}" do
+          subject{ decoder.decode(mapping[:encoded], mapping[:encoding]) }
+          it{ is_expected.to eq(mapping[:source]) }
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uri_encoding
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - OSA Shunsuke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler