furi 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9c81dc7acc1ab6c12a180cf8722a10e4bad93b8
-  data.tar.gz: 88787eb5df40194b9373c14375e94523cb9a0191
+  metadata.gz: e47171efdec80d8610e7dea95a1eed17876ea14b
+  data.tar.gz: 33a2e11ef018c0d5c9d6695ced7c15e9f3dd3fb4
 SHA512:
-  metadata.gz: 92ae36c027f8f38d9c9617595b6aedade9db5b7f652021660a3502813e63ba6b4062669fed3b1ba7c7d01846a0ab0251ff77752ca7f47a15e3d8482353743ad2
-  data.tar.gz: 8e756624ec091e58981ed3c1d8c0e998b22168fef6c1a1b0e41cf31a3d39037efad32fb9a62fe725322c7efa65600fcff8824efbc321b0bd79d7af95ca327b13
+  metadata.gz: 7e0c644b931d878b69b6d902aad0772aefa16a5ff4066db3bab871912dbe1e0b4ed91b41d4fb1b921ddfe36119f60293081e6b924cab8747865c1aa1451d3ebe
+  data.tar.gz: 1bbc865cbe5551b416a28243260e01e01409b600f32fd83b8b3a3da320cc7f9f6ce1bdc82363d92a1b8dd1941de99356e38a4d2903a57ad2f8ef956db4a22f23

data/README.md

@@ -29,21 +29,34 @@ Here are basic:
 ### Utility Methods
 
 
+Parsing the URI fragments:
+
 ``` ruby
 Furi.host("http://gusiev.com") # => "gusiev.com"
 Furi.port("http://gusiev.com") # => nil
 Furi.port!("http://gusiev.com") # => 80
+```
 
+Updating the URI parts:
+
+```
 Furi.update("http://gusiev.com", protocol: '') # => "//gusiev.com"
 Furi.update("http://gusiev.com?source=google", query: {email: "a@b.com"}) 
     # => "http://gusiev.com?source=google&email=a@b.com"
 Furi.replace("http://gusiev.com?source=google", query: {email: "a@b.com"}) 
     # => "http://gusiev.com?email=a@b.com"
 
+Furi.defaults("http://gusiev.com", subdomain: 'www') # => "http://www.gusiev.com"
+Furi.defaults("http://blog.gusiev.com", subdomain: 'www') # => "http://blog.gusiev.com"
+
+```
+
+Building an URI from initial parts:
+
+``` ruby
+
 Furi.build(protocol: '//', host: 'gusiev.com', path: '/assets/application.js') 
     # => "//gusiev.com/assets/application.js"
-
-Furi.defaults("http://gusiev.com", subdomain: 'www') # => "http://www.gusiev.com"
 ```
 
 ### Working with Object
@@ -93,13 +106,13 @@ uri.merge_query(person: {email: 'a@b.com'})
     /      __|___   __|__    ______|______   |  _________|__________     ____|____   |
    /      /      \ /     \  /             \ / \/                    \   /         \ / \
    http://username:zhongguo@www.example.com:80/hello/world/article.html?name=bogdan#info
-    \_/                     \_/  \___/  \_/    \__________/ \       \_/
-     |                       |     |     |           |       \       |
-  protocol             subdomain   | domainzone  directory    \  extension
-                                   |     |                     \_____/  
-                             domainname  /                        |     
-                                    \___/                     filename 
-                                      |                                 
+    \_/                     \_/  \___/  \_/    \__________/\     /  \_/
+     |                       |     |     |           |      \___/    |
+  protocol             subdomain   | domainzone  directory    |   extension
+                                   |     |                 filename  |       
+                             domainname  /                     \_____/       
+                                    \___/                         |          
+                                      |                          file                       
                                     domain                   
 ```
 
@@ -110,9 +123,8 @@ Giving credit...
 
 ## TODO
 
-* rfc3986 validation
-* mailto protocol
-* escaping in path
+* Improve URI.join algorithm to match the one used in Addressible library
+* Implement filename
 
 ## Contributing
 

data/lib/furi.rb

@@ -14,7 +14,7 @@ module Furi
   COMBINED_PARTS = [
     :hostinfo, :userinfo, :authority, :ssl, :domain, :domainname,
     :domainzone, :request, :location, :query,
-    :extension, :filename
+    :directory, :extension, :file
   ]
   PARTS = ESSENTIAL_PARTS + COMBINED_PARTS
 
@@ -152,7 +152,7 @@ module Furi
         QueryToken.parse(p)
       end
     else
-      raise ArgumentError, "Can not parse #{query.inspect} query tokens"
+      raise QueryParseError, "can not parse #{query.inspect} query tokens"
     end
   end
 
@@ -175,7 +175,16 @@ module Furi
     end.reduce(:join)
   end
 
-  class FormattingError < StandardError
+  class Error < StandardError
+  end
+
+  class FormattingError < Error
+  end
+
+  class ParseError < Error
+  end
+
+  class QueryParseError < Error
   end
 
   protected
@@ -195,13 +204,13 @@ module Furi
       result
     when Array
       if namespace.nil? || namespace.empty?
-        raise ArgumentError, "Can not serialize Array without namespace"
+        raise FormattingError, "Can not serialize Array without namespace"
       end
 
       namespace = "#{namespace}[]"
       query.map do |item|
         if item.is_a?(Array)
-          raise ArgumentError, "Can not serialize #{item.inspect} as element of an Array"
+          raise FormattingError, "Can not serialize #{item.inspect} as element of an Array"
         end
         serialize_tokens(item, namespace)
       end
@@ -227,14 +236,14 @@ module Furi
     elsif after == "[]"
       current ||= []
       unless current.is_a?(Array)
-        raise TypeError, "expected Array (got #{current.class}) for param `#{namespace}'"
+        raise QueryParseError, "expected Array (got #{current.class}) for param `#{namespace}'"
       end
       current << value
     elsif after =~ %r(^\[\]\[([^\[\]]+)\]$) || after =~ %r(^\[\](.+)$)
       child_key = $1
       current ||= []
       unless current.is_a?(Array)
-        raise TypeError, "expected Array (got #{current.class}) for param `#{namespace}'"
+        raise QueryParseError, "expected Array (got #{current.class}) for param `#{namespace}'"
       end
       if current.last.is_a?(Hash) && !current.last.key?(child_key)
         parse_query_token(current.last, child_key, value)
@@ -244,7 +253,7 @@ module Furi
     else
       current ||= {}
       unless current.is_a?(Hash)
-        raise TypeError, "expected Hash (got #{current.class}) for param `#{namespace}'"
+        raise QueryParseError, "expected Hash (got #{current.class}) for param `#{namespace}'"
       end
       current = parse_query_token(current, after, value)
     end

data/lib/furi/query_token.rb

@@ -20,7 +20,7 @@ module Furi
     end
 
     def self.raise_parse_error(token)
-      raise ArgumentError, "Can not parse query token #{token.inspect}"
+      raise QueryParseError, "Can not parse query token #{token.inspect}"
     end
 
     def initialize(name, value)
@@ -40,8 +40,8 @@ module Furi
 
     def to_s
       encoded_key = ::URI.encode_www_form_component(name.to_s)
-      
-      !value.nil? ? 
+
+      !value.nil? ?
         "#{encoded_key}=#{::URI.encode_www_form_component(value.to_s)}" :
         encoded_key
     end

data/lib/furi/uri.rb

@@ -25,7 +25,7 @@ module Furi
       when ::URI::Generic
         parse_uri_string(argument.to_s)
       else
-        raise ArgumentError, "wrong Uri argument"
+        raise ParseError, "wrong Uri argument"
       end
     end
 
@@ -77,7 +77,7 @@ module Furi
         self.query_tokens += Furi.query_tokens(query)
       when nil
       else
-        raise ArgumentError, "#{query.inspect} can not be merged"
+        raise QueryParseError, "#{query.inspect} can not be merged"
       end
     end
 
@@ -244,7 +244,7 @@ module Furi
         @query = value
       when nil
       else
-        raise ArgumentError, 'Query can only be Hash or String'
+        raise QueryParseError, 'Query can only be Hash or String'
       end
     end
 
@@ -312,14 +312,14 @@ module Furi
 
     def directory=(string)
       string ||= "/"
-      if filename && string !~ %r{/\z}
+      if file && string !~ %r{/\z}
         string += '/'
       end
-      self.path = string + filename.to_s
+      self.path = string + file.to_s
     end
 
     def extension
-      return nil unless filename
+      return nil unless file
       file_tokens.size > 1 ? file_tokens.last : nil
     end
 
@@ -327,7 +327,7 @@ module Furi
       tokens = file_tokens
       case tokens.size
       when 0
-        raise Furi::FormattingError, "can not assign extension when there is no filename"
+        raise Furi::FormattingError, "can not assign extension when there is no file"
       when 1
         tokens.push(string)
       else
@@ -337,10 +337,10 @@ module Furi
           tokens.pop
         end
       end
-      self.filename = tokens.join(".")
+      self.file = tokens.join(".")
     end
 
-    def filename=(name)
+    def file=(name)
       unless name
         return unless path
       else
@@ -395,13 +395,13 @@ module Furi
       self.protocol = find_protocol_for_ssl(ssl)
     end
 
-    def filename
+    def file
       result = path_tokens.last
       result == "" ? nil : result
     end
 
-    def filename!
-      filename || ''
+    def file!
+      file || ''
     end
 
     def default_web_port?
@@ -486,7 +486,7 @@ module Furi
     protected
 
     def file_tokens
-      filename ? filename.split('.') : []
+      file ? file.split('.') : []
     end
 
     def query_level?

data/lib/furi/version.rb

@@ -1,3 +1,3 @@
 module Furi
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/furi_spec.rb

@@ -90,7 +90,7 @@ describe Furi do
 
         resource: '/articles/index.html?a=1&b=2#header',
         path: "/articles/index.html",
-        filename: 'index.html',
+        file: 'index.html',
         extension: 'html',
         query_string: "a=1&b=2",
         query_tokens: [['a', '1'], ['b', '2']],
@@ -139,7 +139,7 @@ describe Furi do
         resource: '/posts/index.html?a=b#zz',
         request: '/posts/index.html?a=b',
         location: 'http://gusiev.com',
-        filename: 'index.html',
+        file: 'index.html',
         extension: 'html',
       )
     end
@@ -161,8 +161,8 @@ describe Furi do
       expect("/posts/").to have_parts(
         path: '/posts/',
         directory: '/posts',
-        filename: nil,
-        'filename!' =>  '',
+        file: nil,
+        'file!' =>  '',
         extension: nil,
         home_page?: false,
       )
@@ -396,14 +396,14 @@ describe Furi do
       expect(Furi.replace("/articles/index?a=b", directory: '/posts')).to eq('/posts/index?a=b')
       expect(Furi.replace("/articles/index.html?a=b", directory: '/posts/')).to eq('/posts/index.html?a=b')
     end
-    it "replace filename" do
-      expect(Furi.replace("gusiev.com", filename: 'article')).to eq('gusiev.com/article')
-      expect(Furi.replace("gusiev.com/", filename: 'article')).to eq('gusiev.com/article')
-      expect(Furi.replace("gusiev.com/article1#header", filename: '/article2')).to eq('gusiev.com/article2#header')
-      expect(Furi.replace("gusiev.com/article#header", filename: nil)).to eq('gusiev.com/#header')
-      expect(Furi.replace("gusiev.com/articles/article1?a=b", filename: 'article2')).to eq('gusiev.com/articles/article2?a=b')
-      expect(Furi.replace("/articles/article1?a=b", filename: '/article2')).to eq('/articles/article2?a=b')
-      expect(Furi.replace("/articles/article1.xml?a=b", filename: 'article2.html')).to eq('/articles/article2.html?a=b')
+    it "replace file" do
+      expect(Furi.replace("gusiev.com", file: 'article')).to eq('gusiev.com/article')
+      expect(Furi.replace("gusiev.com/", file: 'article')).to eq('gusiev.com/article')
+      expect(Furi.replace("gusiev.com/article1#header", file: '/article2')).to eq('gusiev.com/article2#header')
+      expect(Furi.replace("gusiev.com/article#header", file: nil)).to eq('gusiev.com/#header')
+      expect(Furi.replace("gusiev.com/articles/article1?a=b", file: 'article2')).to eq('gusiev.com/articles/article2?a=b')
+      expect(Furi.replace("/articles/article1?a=b", file: '/article2')).to eq('/articles/article2?a=b')
+      expect(Furi.replace("/articles/article1.xml?a=b", file: 'article2.html')).to eq('/articles/article2.html?a=b')
     end
     it "replace extension" do
       expect(->{
@@ -554,6 +554,21 @@ describe Furi do
       expect(Furi.defaults("//gusiev.com", query_string: 'b=2')).to eq('//gusiev.com?b=2')
       expect(Furi.defaults("//gusiev.com?a=1&b=2", query: '?a=3')).to eq('//gusiev.com?a=1&b=2')
     end
+    it "should set file" do
+      expect(Furi.defaults("gusiev.com?a=1", file: 'index.html')).to eq('gusiev.com/index.html?a=1')
+      expect(Furi.defaults("gusiev.com/posts?a=1", file: 'index.html')).to eq('gusiev.com/posts?a=1')
+      expect(Furi.defaults("gusiev.com/posts/?a=1", file: 'index.html')).to eq('gusiev.com/posts/index.html?a=1')
+      expect(Furi.defaults("gusiev.com/posts/?a=1", file: 'index.html')).to eq('gusiev.com/posts/index.html?a=1')
+    end
+    it "should set extension" do
+      expect {
+        Furi.defaults("gusiev.com?a=1", extension: 'html')
+      }.to raise_error(Furi::FormattingError)
+      expect(Furi.defaults("gusiev.com?a=1", file: 'index.html', extension: 'html')).to eq('gusiev.com/index.html?a=1')
+      expect(Furi.defaults("gusiev.com/posts?a=1", extension: 'html')).to eq('gusiev.com/posts.html?a=1')
+      #expect(Furi.defaults("gusiev.com/posts/?a=1", file: 'index.html')).to eq('gusiev.com/posts/index.html?a=1')
+      #expect(Furi.defaults("gusiev.com/posts/?a=1", file: 'index.html')).to eq('gusiev.com/posts/index.html?a=1')
+    end
   end
 
   describe "#==" do
@@ -623,10 +638,10 @@ describe Furi do
       expect(a: [1,{c: 2, b: 3}, 4]).to serialize_as(["a[]=1", "a[][c]=2", "a[][b]=3", "a[]=4"])
       expect(->{
         Furi.serialize([1,2])
-      }).to raise_error(ArgumentError)
+      }).to raise_error(Furi::FormattingError)
       expect(->{
         Furi.serialize(a: [1,[2]])
-      }).to raise_error(ArgumentError)
+      }).to raise_error(Furi::FormattingError)
 
 
       params = { b:{ c:3, d:[4,5], e:{ x:[6], y:7, z:[8,9] }}};
@@ -722,13 +737,13 @@ describe Furi do
       should eq "x" => {"y" => [{"z" => "1", "w" => "a"}, {"z" => "2", "w" => "3"}]}
 
     lambda { Furi.parse_query("x[y]=1&x[y]z=2") }.
-      should raise_error(TypeError,  "expected Hash (got String) for param `y'")
+      should raise_error(Furi::QueryParseError,  "expected Hash (got String) for param `y'")
 
     lambda { Furi.parse_query("x[y]=1&x[]=1") }.
-      should raise_error(TypeError, /expected Array \(got [^)]*\) for param `x'/)
+      should raise_error(Furi::QueryParseError, /expected Array \(got [^)]*\) for param `x'/)
 
     lambda { Furi.parse_query("x[y]=1&x[y][][w]=2") }.
-      should raise_error(TypeError, "expected Array (got String) for param `y'")
+      should raise_error(Furi::QueryParseError, "expected Array (got String) for param `y'")
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: furi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler