aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_view/helpers/ajax_helper.rb
blob: 18b4c4991fa682e7f7dea5400fea677267a3561e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
57
58
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
module ActionView
  module Helpers
    module AjaxHelper
      include UrlHelper

      def extract_remote_attributes!(options)
        attributes = options.delete(:html) || {}

        attributes.merge!(extract_update_attributes!(options))
        attributes.merge!(extract_request_attributes!(options))
        attributes["data-js-type"] = options.delete(:js_type) || "remote"

        attributes
      end

      def remote_form_for(record_or_name_or_array, *args, &proc)
        options = args.extract_options!
        object_name = extract_object_name_for_form!(args, options, record_or_name_or_array)

        concat(form_remote_tag(options))
        fields_for(object_name, *(args << options), &proc)
        concat('</form>'.html_safe!)
      end
      alias_method :form_remote_for, :remote_form_for

      def form_remote_tag(options = {}, &block)
        attributes = {}
        attributes.merge!(extract_remote_attributes!(options))
        attributes.merge!(options)

        url = attributes.delete("data-url")
        form_tag(attributes.delete(:action) || url, attributes, &block)
      end

      def link_to_remote(name, url, options = {})
        attributes = {}
        attributes.merge!(extract_remote_attributes!(options))
        attributes.merge!(options)

        html["data-update-position"] = options.delete(:position)
        html["data-method"]          = options.delete(:method)
        html["data-remote"]          = "true"
        
        html.merge!(options)

        url = url_for(url) if url.is_a?(Hash)
        link_to(name, url, attributes)
      end

      def button_to_remote(name, options = {}, html_options = {})
        attributes = html_options.merge!(:type => "button")
        attributes.merge!(extract_remote_attributes!(options))

        tag(:input, attributes)
      end

      def submit_to_remote(name, value, options = {})
        html_options = options.delete(:html) || {}
        html_options.merge!(:name => name, :value => value, :type => "submit")

        attributes = extract_remote_attributes!(options)
        attributes.merge!(html_options)

        tag(:input, attributes)
      end

      def periodically_call_remote(options = {})
        attributes = extract_observer_attributes!(options)
        attributes["data-js-type"] = "periodical_executer"

        script_decorator(attributes)
      end

      #TODO: Should name change to a css query? - BR
      def observe_field(name, options = {})
        options[:observed] = name
        attributes = extract_observer_attributes!(options)
        attributes["data-js-type"] = "field_observer"

        script_decorator(attributes)
      end

      def observe_field(name, options = {})
        if options[:url]
          options[:url] = options[:url].is_a?(Hash) ? url_for(options[:url]) : options[:url]
        end
        
        if options[:frequency]
          case options[:frequency]
            when 0
              options.delete(:frequency)
            else
              options[:frequency] = options[:frequency].to_i
          end
        end

        if options[:with]
          if options[:with] !~ /[\{=(.]/
            options[:with] = "'#{options[:with]}=' + encodeURIComponent(value)"
          else
            options[:with] ||= 'value' unless options[:function]
          end
        end

        if options[:function]
          statements = options[:function] # || remote_function(options) # TODO: Need to implement remote function - BR
          options[:function] = JSFunction.new(statements, "element", "value")
        end

        options[:name] = name

        <<-SCRIPT
        <script type="application/json" data-rails-type="observe_field">
        //<![CDATA[
          #{options.to_json}
        // ]]>
        </script>
        SCRIPT
      end

      # TODO: Move to javascript helpers - BR
      class JSFunction
        def initialize(statements, *arguments)
          @statements, @arguments = statements, arguments
        end

        def as_json(options = nil)
          "function(#{@arguments.join(", ")}) {#{@statements}}"
        end
      end

      module Rails2Compatibility
        def set_callbacks(options, html)
          [:complete, :failure, :success, :interactive, :loaded, :loading].each do |type|
            html["data-#{type}-code"]  = options.delete(type.to_sym)
          end

          options.each do |option, value|
            if option.is_a?(Integer)
              html["data-#{option}-code"] = options.delete(option)
            end
          end
        end
        
        def link_to_remote(name, url, options = nil)
          if !options && url.is_a?(Hash) && url.key?(:url)
            url, options = url.delete(:url), url
          end
          set_callbacks(options, options[:html] ||= {})
          
          super
        end
        
        def button_to_remote(name, options = {}, html_options = {})
          set_callbacks(options, html_options)
          super
        end
      end

      private

      def extract_request_attributes!(options)
        attributes = {}
        attributes["data-method"] = options.delete(:method)

        url = options.delete(:url)
        attributes["data-url"] = url.is_a?(Hash) ? url_for(url) : url

        #TODO: Remove all references to prototype - BR
        if options.delete(:form)
          attributes["data-parameters"] = 'Form.serialize(this)'
        elsif submit = options.delete(:submit)
          attributes["data-parameters"] = "Form.serialize('#{submit}')"
        elsif with = options.delete(:with)
          if with !~ /[\{=(.]/
            attributes["data-with"] = "'#{with}=' + encodeURIComponent(value)"
          else
            attributes["data-with"] = with
          end
        end

        purge_unused_attributes!(attributes)
      end

      def extract_update_attributes!(options)
        attributes = {}
        update = options.delete(:update)
        if update.is_a?(Hash)
          attributes["data-update-success"] = update[:success]
          attributes["data-update-failure"] = update[:failure]
        else
          attributes["data-update-success"] = update
        end
        attributes["data-update-position"] = options.delete(:position)

        purge_unused_attributes!(attributes)
      end

      def extract_observer_attributes!(options)
        attributes = extract_remote_attributes!(options)
        attributes["data-observed"] = options.delete(:observed)

        callback = options.delete(:function)
        frequency = options.delete(:frequency)
        if callback
          attributes["data-observer-code"] = create_js_function(callback, "element", "value")
        end
        if frequency && frequency != 0
          attributes["data-frequency"] = frequency.to_i
        end

        purge_unused_attributes!(attributes)
      end

      def purge_unused_attributes!(attributes)
        attributes.delete_if {|key, value| value.nil? }
        attributes
      end

      def create_js_function(statements, *arguments)
        "function(#{arguments.join(", ")}) {#{statements}}"
      end

    end
  end
end