Class: URL

Inherits:
Object show all
Includes:
ReactiveTags
Defined in:
lib/volt/models/url.rb

Overview

The url class handles parsing and updating the url

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ReactiveTags

included, #reactive_method_tag

Constructor Details

#initialize(router = nil) ⇒ URL

Returns a new instance of URL.



9
10
11
12
 
# File 'lib/volt/models/url.rb', line 9

def initialize(router=nil)
  @router = router
  @params = Model.new({}, persistor: Persistors::Params)
end

Instance Attribute Details

#host ⇒ Object (readonly)

TODO: we need to make it so change events only trigger on changes



6
7
8
 
# File 'lib/volt/models/url.rb', line 6

def host
  @host
end

#params ⇒ Object (readonly)

TODO: we need to make it so change events only trigger on changes



6
7
8
 
# File 'lib/volt/models/url.rb', line 6

def params
  @params
end

#path ⇒ Object (readonly)

TODO: we need to make it so change events only trigger on changes



6
7
8
 
# File 'lib/volt/models/url.rb', line 6

def path
  @path
end

#port ⇒ Object (readonly)

TODO: we need to make it so change events only trigger on changes



6
7
8
 
# File 'lib/volt/models/url.rb', line 6

def port
  @port
end

#query ⇒ Object (readonly)

TODO: we need to make it so change events only trigger on changes



6
7
8
 
# File 'lib/volt/models/url.rb', line 6

def query
  @query
end

#router ⇒ Object

Returns the value of attribute router.



7
8
9
 
# File 'lib/volt/models/url.rb', line 7

def router
  @router
end

#scheme ⇒ Object (readonly)

TODO: we need to make it so change events only trigger on changes



6
7
8
 
# File 'lib/volt/models/url.rb', line 6

def scheme
  @scheme
end

Instance Method Details

#full_url ⇒ Object

Full url rebuilds the url from it’s constituent parts



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/volt/models/url.rb', line 59

def full_url
  if @port
    host_with_port = "#{@host}:#{@port}"
  else
    host_with_port = @host
  end

  path, params = @router.params_to_url(@params.deep_cur.to_h)

  new_url = "#{@scheme}://#{host_with_port}#{(path || @path).chomp('/')}"

  unless params.empty?
    new_url += '?'
    query_parts = []
    nested_params_hash(params).each_pair do |key,value|
      value = value.cur
      # remove the _ from the front
      value = `encodeURI(value)`
      query_parts << "#{key}=#{value}"
    end

    new_url += query_parts.join('&')
  end

  new_url += '#' + @fragment if @fragment

  return new_url
end

#parse(url) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/volt/models/url.rb', line 19

def parse(url)
  if url[0] == '#'
    # url only updates fragment
    @fragment = url[1..-1]
    update!
  else
    host = `document.location.host`
    protocol = `document.location.protocol`

    if url !~ /[:]\/\//
      # Add the host for local urls
      url = protocol + "//#{host}" + url
    else
      # Make sure its on the same protocol and host, otherwise its external.
      if url !~ /#{protocol}\/\/#{host}/
        # Different host, don't process
        return false
      end
    end

    matcher = url.match(/^(#{protocol[0..-2]})[:]\/\/([^\/]+)(.*)$/)
    @scheme = matcher[1]
    @host, @port = matcher[2].split(':')
    @port ||= 80

    @path = matcher[3]
    @path, @fragment = @path.split('#', 2)
    @path, @query = @path.split('?', 2)

    assign_query_hash_to_params
  end

  scroll

  trigger_for_methods!('changed', :path)

  return true
end

#scroll ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/volt/models/url.rb', line 105

def scroll
  if Volt.client?
    if @fragment
      # Scroll to anchor via http://www.w3.org/html/wg/drafts/html/master/browsers.html#scroll-to-fragid
      %x{
        var anchor = $('#' + this.fragment);
        if (anchor.length == 0) {
          anchor = $('*[name="' + this.fragment + '"]:first');
        }
        if (anchor && anchor.length > 0) {
          console.log('scroll to: ', anchor.offset().top);
          $(document.body).scrollTop(anchor.offset().top);
        }
      }
    else
      # Scroll to the top by default
      `$(document.body).scrollTop(0);`
    end
  end
end

#update! ⇒ Object

Called when the state has changed and the url in the browser should be updated Called when an attribute changes to update the url



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/volt/models/url.rb', line 91

def update!
  if Volt.client?
    new_url = full_url()

    # Push the new url if pushState is supported
    # TODO: add fragment fallback
    %x{
      if (document.location.href != new_url && history && history.pushState) {
        history.pushState(null, null, new_url);
      }
    }
  end
end