dripdrop 0.6.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,28 +1,26 @@
1
1
  require 'spec_helper'
2
2
 
3
3
  describe "nodelets" do
4
+ class SpecialNodelet < DripDrop::Node::Nodelet
5
+ def action
6
+ route :worker1, :zmq_pull, distributor_output.address, :connect
7
+ route :worker2, :zmq_pull, distributor_output.address, :connect
8
+ end
9
+ end
10
+
4
11
  before(:all) do
5
12
  nodelets = {}
6
13
 
14
+
7
15
  @node = run_reactor do
8
- routes_for :distributor do
9
- route :output, :zmq_push, rand_addr, :bind
10
- end
11
- routes_for :worker_cluster do
12
- route :worker1, :zmq_pull, distributor_output.address, :connect
13
- route :worker2, :zmq_pull, distributor_output.address, :connect
14
- end
15
-
16
- nodelet :distributor do |d|
17
- nodelets[:distributor] = d
16
+ nodelet :distributor do |nlet|
17
+ nlet.route :output, :zmq_push, rand_addr, :bind
18
18
  end
19
19
 
20
- nodelet :worker_cluster do |wc|
21
- nodelets[:worker_cluster] = wc
22
- end
20
+ nodelet :worker_cluster, SpecialNodelet
23
21
  end
24
22
 
25
- @nodelets = nodelets
23
+ @nodelets = @node.nodelets
26
24
  end
27
25
 
28
26
  it "should create the nodelets" do
@@ -31,7 +29,7 @@ describe "nodelets" do
31
29
 
32
30
  it "should pass a DripDrop::Node::Nodelet to the block" do
33
31
  @nodelets.values.each do |nlet|
34
- nlet.should be_instance_of(DripDrop::Node::Nodelet)
32
+ nlet.should be_kind_of(DripDrop::Node::Nodelet)
35
33
  end
36
34
  end
37
35
 
@@ -43,6 +41,18 @@ describe "nodelets" do
43
41
  end
44
42
  end
45
43
 
44
+ it "should use the class SpecialNodelet for the nodelet assigned that" do
45
+ @nodelets[:worker_cluster].should be_a(SpecialNodelet)
46
+ end
47
+
48
+ it "should return a DripDrop::Handler for short routes" do
49
+ @nodelets[:distributor].send(:output).should be_a(DripDrop::BaseHandler)
50
+ end
51
+
52
+ it "should return a DripDrop::Handler for long routes" do
53
+ @nodelets[:distributor].send(:distributor_output).should be_a(DripDrop::BaseHandler)
54
+ end
55
+
46
56
  it "should define prefix-less versions of nodelet specific routes" do
47
57
  {
48
58
  @nodelets[:worker_cluster] => {:worker1 => :worker_cluster_worker1,
@@ -53,12 +53,12 @@ describe "routing" do
53
53
  :worker_cluster_worker2 => {:class => DripDrop::ZMQPullHandler, :socket_ctype => :connect}
54
54
  }
55
55
  @node = run_reactor do
56
- routes_for :distributor do
57
- route :output, :zmq_push, rand_addr, :bind
56
+ nodelet :distributor do |nlet|
57
+ nlet.route :output, :zmq_push, rand_addr, :bind
58
58
  end
59
- routes_for :worker_cluster do
60
- route :worker1, :zmq_pull, distributor_output.address, :connect
61
- route :worker2, :zmq_pull, distributor_output.address, :connect
59
+ nodelet :worker_cluster do |nlet|
60
+ nlet.route :worker1, :zmq_pull, distributor_output.address, :connect
61
+ nlet.route :worker2, :zmq_pull, distributor_output.address, :connect
62
62
  end
63
63
  end
64
64
  end
@@ -24,7 +24,7 @@ describe "websockets" do
24
24
  conn.send_message(message)
25
25
  end.on_close do |conn|
26
26
  close_occured = true
27
- end.on_error do |conn|
27
+ end.on_error do |reason,conn|
28
28
  error_occured = true
29
29
  end
30
30
 
data/spec/node_spec.rb CHANGED
@@ -1,15 +1,7 @@
1
1
  require 'spec_helper'
2
2
 
3
3
  describe DripDrop::Node do
4
- describe "initialization" do
5
- before(:all) do
6
- @ddn = DripDrop::Node.new {
7
- zmq_subscribe(rand_addr,:bind) #Keeps ZMQMachine Happy
8
- }
9
- @ddn.start
10
- sleep 1
11
- end
12
-
4
+ shared_examples_for "all initialization methods" do
13
5
  it "should start EventMachine" do
14
6
  EM.reactor_running?.should be_true
15
7
  end
@@ -19,11 +11,49 @@ describe DripDrop::Node do
19
11
  @ddn.zm_reactor.running?.should be_true
20
12
  end
21
13
 
22
- after do
23
- @ddn.stop rescue nil
14
+ it "should run the block" do
15
+ @reactor_ran.should be_true
24
16
  end
25
17
  end
18
+
19
+ #These tests break all subsequent ones,
20
+ #so require a special flag to test them
21
+ if ENV['DRIPDROP_INITSPEC'] == 'true'
22
+ describe "initialization with a block" do
23
+ before(:all) do
24
+ reactor_ran = false
25
+ @ddn = DripDrop::Node.new do
26
+ reactor_ran = true
27
+ end
28
+ @ddn.start
29
+ sleep 1
30
+
31
+ @reactor_ran = reactor_ran
32
+ end
33
+
34
+ it_should_behave_like "all initialization methods"
35
+ end
26
36
 
37
+ describe "initialization as a class" do
38
+ before(:all) do
39
+ class InitializationTest < DripDrop::Node
40
+ attr_accessor :reactor_ran
41
+ def action
42
+ @reactor_ran = true
43
+ end
44
+ end
45
+
46
+ @ddn = InitializationTest.new
47
+ @ddn.start
48
+ sleep 1
49
+
50
+ @reactor_ran = @ddn.reactor_ran
51
+ end
52
+
53
+ it_should_behave_like "all initialization methods"
54
+ end
55
+ end
56
+
27
57
  describe "shutdown" do
28
58
  before do
29
59
  @ddn = DripDrop::Node.new {
@@ -43,4 +73,18 @@ describe DripDrop::Node do
43
73
  @ddn.zm_reactor.running?.should be_false
44
74
  end
45
75
  end
76
+
77
+ describe "exceptions in EM reactor" do
78
+ class TestException < StandardError; end
79
+
80
+ it "should rescue exceptions in the EM reactor" do
81
+ expectations = an_instance_of(TestException)
82
+ reactor = run_reactor do
83
+ self.should_receive(:error_handler).with(expectations)
84
+ EM.next_tick do
85
+ raise TestException, "foo"
86
+ end
87
+ end
88
+ end
89
+ end
46
90
  end
data/spec/spec_helper.rb CHANGED
@@ -8,7 +8,7 @@ def rand_addr(scheme='tcp')
8
8
  "#{scheme}://127.0.0.1:#{rand(10_000) + 20_000}"
9
9
  end
10
10
 
11
- def run_reactor(time=0.1,opts={},&block)
11
+ def run_reactor(time=0.2,opts={},&block)
12
12
  ddn = DripDrop::Node.new(opts,&block)
13
13
  ddn.start
14
14
  sleep time
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dripdrop
3
3
  version: !ruby/object:Gem::Version
4
- hash: 7
4
+ hash: 1
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
- - 6
9
- - 0
10
- version: 0.6.0
8
+ - 7
9
+ - 1
10
+ version: 0.7.1
11
11
  platform: ruby
12
12
  authors:
13
13
  - Andrew Cholakian
@@ -15,7 +15,7 @@ autorequire:
15
15
  bindir: bin
16
16
  cert_chain: []
17
17
 
18
- date: 2010-12-17 00:00:00 -08:00
18
+ date: 2011-01-30 00:00:00 -08:00
19
19
  default_executable:
20
20
  dependencies:
21
21
  - !ruby/object:Gem::Dependency
@@ -136,21 +136,14 @@ files:
136
136
  - dripdrop.gemspec
137
137
  - example/agent_test.rb
138
138
  - example/combined.rb
139
+ - example/complex/README
140
+ - example/complex/client.rb
141
+ - example/complex/server.rb
142
+ - example/complex/service.rb
143
+ - example/complex/websocket.rb
139
144
  - example/http.rb
140
145
  - example/pubsub.rb
141
146
  - example/pushpull.rb
142
- - example/stats_app/core.rb
143
- - example/stats_app/public/.sass-cache/b48b4299d80c05f528daf63fe51d85e5e3c10d98/stats.scssc
144
- - example/stats_app/public/backbone.js
145
- - example/stats_app/public/build_templates.rb
146
- - example/stats_app/public/json2.js
147
- - example/stats_app/public/protovis-r3.2.js
148
- - example/stats_app/public/stats.css
149
- - example/stats_app/public/stats.haml
150
- - example/stats_app/public/stats.html
151
- - example/stats_app/public/stats.js
152
- - example/stats_app/public/stats.scss
153
- - example/stats_app/public/underscore.js
154
147
  - example/subclass.rb
155
148
  - example/xreq_xrep.rb
156
149
  - js/dripdrop.html
@@ -211,13 +204,13 @@ signing_key:
211
204
  specification_version: 3
212
205
  summary: Evented framework for ZeroMQ and EventMachine Apps.
213
206
  test_files:
214
- - spec/gimite-websocket.rb
215
- - spec/message_spec.rb
216
207
  - spec/node_spec.rb
217
208
  - spec/spec_helper.rb
218
- - spec/node/http_spec.rb
209
+ - spec/gimite-websocket.rb
210
+ - spec/message_spec.rb
219
211
  - spec/node/nodelet_spec.rb
220
- - spec/node/routing_spec.rb
221
- - spec/node/websocket_spec.rb
222
212
  - spec/node/zmq_pushpull_spec.rb
223
213
  - spec/node/zmq_xrepxreq_spec.rb
214
+ - spec/node/routing_spec.rb
215
+ - spec/node/websocket_spec.rb
216
+ - spec/node/http_spec.rb
@@ -1,113 +0,0 @@
1
- require 'dripdrop'
2
- Thread.abort_on_exception = true #Always a good idea in multithreaded apps.
3
-
4
- # This demo app is an message stats application
5
- # It receives stats data via either HTTP or ZMQ directly, aggregates,
6
- # and keeps track of data.
7
- DripDrop::Node.new do
8
- routes_for :agg do
9
- route :input, :zmq_subscribe, 'tcp://127.0.0.1:2200', :bind
10
- route :output, :zmq_publish, 'tcp://127.0.0.1:2201', :bind
11
- route :input_http, :http_server, 'http://127.0.0.1:8082'
12
- end
13
-
14
- routes_for :counter do
15
- route :input, :zmq_subscribe, agg_output.address, :connect
16
- route :query, :zmq_xrep, 'tcp://127.0.0.1:2203', :bind
17
- route :query_http, :http_server, 'tcp://0.0.0.0:8081'
18
- end
19
-
20
- routes_for :tracer do
21
- route :input, :zmq_subscribe, agg_output.address, :connect, :topic_filter => /^ip_trace_req$/
22
- route :output, :zmq_publish, 'tcp://127.0.0.1:2204', :bind
23
- end
24
-
25
- routes_for :ws_stream do
26
- route :tracer_input, :zmq_subscribe, agg_output.address, :connect
27
- route :agg_input, :zmq_subscribe, tracer_output.address, :connect
28
- route :client, :websocket, 'ws://127.0.0.1:2202'
29
- end
30
-
31
- routes_for :heartbeat do
32
- route :output, :zmq_publish, agg_input.address, :connect
33
- end
34
-
35
- nodelet :agg do |agg|
36
- agg.input.on_recv do |message|
37
- agg.output.send_message(message)
38
- end
39
-
40
- agg.input.on_recv do |message|
41
- agg.output.send_message(message)
42
- end
43
-
44
- agg.input_http.on_recv do |message,response,env|
45
- response.send_message(:name => 'ack')
46
- agg.output.send_message(message)
47
- end
48
- end
49
-
50
- nodelet :counter do |cntr|
51
- stats = {:total => 0, :name_counts => Hash.new(0) }
52
-
53
- cntr.input.on_recv do |message|
54
- stats[:total] += 1
55
- stats[:name_counts][message.name] += 1
56
- end
57
-
58
- cntr.query.on_recv do |message,ids,seq|
59
- cntr.query.send_message({:name => 'stats', :body => @stats}, ids, seq)
60
- end
61
-
62
- cntr.query_http.on_recv do |message,response|
63
- response.send_message(:name => 'stats', :body => @stats)
64
- end
65
- end
66
-
67
- nodelet :tracer do |tracer|
68
- tracer_memo = {}
69
-
70
- ip_regexp = /\A(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\Z/
71
- tracer.input.on_recv do |message|
72
- puts "TRACE #{message.body.inspect}"
73
-
74
- ip = message.body['ip']
75
- puts "IP #{message.inspect}"
76
- if ip =~ ip_regexp
77
- memoized_res = tracer_memo[ip]
78
- if memoized_res
79
- tracer.output.send_message(:name => 'ip_route', :body => {:ip => ip, :route => memoized_res})
80
- else
81
- EM.system("/usr/sbin/traceroute -w 4 #{ip}") do |output,status|
82
- route = output.split("\n")[1..-1].map {|l| l.split(/ /)[3] }.select {|a| a != '*'}
83
- tracer_memo[ip] = route
84
- tracer.output.send_message(:name => 'ip_route', :body => {:ip => ip, :route => route})
85
- end
86
- end
87
- end
88
- end
89
- end
90
-
91
- nodelet :ws_stream do |wss|
92
- [wss.tracer_input, wss.agg_input].each do |input|
93
- input.on_recv do |message|
94
- send_internal(:wss, message)
95
- end
96
- end
97
-
98
- wss.client.on_open do |ws|
99
- recv_internal(:wss, ws.signature) do |message|
100
- ws.send_message(message)
101
- end
102
- end.on_recv do |message,ws|
103
- end.on_close do |ws|
104
- end.on_error do |ws|
105
- end
106
- end
107
-
108
- nodelet :heartbeat do |hbeat|
109
- zm_reactor.periodical_timer(1000) do
110
- hbeat.output.send_message(:name => 'heartbeat/tick', :body => Time.now.to_i)
111
- end
112
- end
113
- end.start! #Start the reactor and block until complete
@@ -1,16 +0,0 @@
1
- (function(){var f;f=typeof exports!=="undefined"?exports:this.Backbone={};f.VERSION="0.2.0";var e=this._;if(!e&&typeof require!=="undefined")e=require("underscore")._;var h=this.jQuery;f.emulateHttp=false;f.Events={bind:function(a,b){this._callbacks||(this._callbacks={});(this._callbacks[a]||(this._callbacks[a]=[])).push(b);return this},unbind:function(a,b){var c;if(a){if(c=this._callbacks)if(b){c=c[a];if(!c)return this;for(var d=0,g=c.length;d<g;d++)if(b===c[d]){c.splice(d,1);break}}else c[a]=[]}else this._callbacks=
2
- {};return this},trigger:function(a){var b,c,d,g;if(!(c=this._callbacks))return this;if(b=c[a]){d=0;for(g=b.length;d<g;d++)b[d].apply(this,Array.prototype.slice.call(arguments,1))}if(b=c.all){d=0;for(g=b.length;d<g;d++)b[d].apply(this,arguments)}return this}};f.Model=function(a){this.attributes={};this.cid=e.uniqueId("c");this.set(a||{},{silent:true});this._previousAttributes=e.clone(this.attributes);this.initialize&&this.initialize(a)};e.extend(f.Model.prototype,f.Events,{_previousAttributes:null,
3
- _changed:false,toJSON:function(){return e.clone(this.attributes)},get:function(a){return this.attributes[a]},set:function(a,b){b||(b={});if(!a)return this;if(a.attributes)a=a.attributes;var c=this.attributes;if(this.validate){var d=this.validate(a);if(d){b.error?b.error(this,d):this.trigger("error",this,d);return false}}if("id"in a)this.id=a.id;for(var g in a){d=a[g];if(d==="")d=null;if(!e.isEqual(c[g],d)){c[g]=d;if(!b.silent){this._changed=true;this.trigger("change:"+g,this,d)}}}!b.silent&&this._changed&&
4
- this.change();return this},unset:function(a,b){b||(b={});var c=this.attributes[a];delete this.attributes[a];if(!b.silent){this._changed=true;this.trigger("change:"+a,this);this.change()}return c},fetch:function(a){a||(a={});var b=this,c=a.error&&e.bind(a.error,null,b);f.sync("read",this,function(d){if(!b.set(b.parse(d),a))return false;a.success&&a.success(b,d)},c);return this},save:function(a,b){a||(a={});b||(b={});if(!this.set(a,b))return false;var c=this,d=b.error&&e.bind(b.error,null,c),g=this.isNew()?
5
- "create":"update";f.sync(g,this,function(i){if(!c.set(c.parse(i),b))return false;b.success&&b.success(c,i)},d);return this},destroy:function(a){a||(a={});var b=this,c=a.error&&e.bind(a.error,null,b);f.sync("delete",this,function(d){b.collection&&b.collection.remove(b);a.success&&a.success(b,d)},c);return this},url:function(){var a=j(this.collection);if(this.isNew())return a;return a+"/"+this.id},parse:function(a){return a},clone:function(){return new this.constructor(this)},isNew:function(){return!this.id},
6
- change:function(){this.trigger("change",this);this._previousAttributes=e.clone(this.attributes);this._changed=false},hasChanged:function(a){if(a)return this._previousAttributes[a]!=this.attributes[a];return this._changed},changedAttributes:function(a){a||(a=this.attributes);var b=this._previousAttributes,c=false,d;for(d in a)if(!e.isEqual(b[d],a[d])){c=c||{};c[d]=a[d]}return c},previous:function(a){if(!a||!this._previousAttributes)return null;return this._previousAttributes[a]},previousAttributes:function(){return e.clone(this._previousAttributes)}});
7
- f.Collection=function(a,b){b||(b={});if(b.comparator){this.comparator=b.comparator;delete b.comparator}this._boundOnModelEvent=e.bind(this._onModelEvent,this);this._reset();a&&this.refresh(a,{silent:true});this.initialize&&this.initialize(a,b)};e.extend(f.Collection.prototype,f.Events,{model:f.Model,toJSON:function(){return this.map(function(a){return a.toJSON()})},add:function(a,b){if(e.isArray(a))for(var c=0,d=a.length;c<d;c++)this._add(a[c],b);else this._add(a,b);return this},remove:function(a,
8
- b){if(e.isArray(a))for(var c=0,d=a.length;c<d;c++)this._remove(a[c],b);else this._remove(a,b);return this},get:function(a){return a&&this._byId[a.id!=null?a.id:a]},getByCid:function(a){return a&&this._byCid[a.cid||a]},at:function(a){return this.models[a]},sort:function(a){a||(a={});if(!this.comparator)throw Error("Cannot sort a set without a comparator");this.models=this.sortBy(this.comparator);a.silent||this.trigger("refresh",this);return this},pluck:function(a){return e.map(this.models,function(b){return b.get(a)})},
9
- refresh:function(a,b){a||(a=[]);b||(b={});this._reset();this.add(a,{silent:true});b.silent||this.trigger("refresh",this);return this},fetch:function(a){a||(a={});var b=this,c=a.error&&e.bind(a.error,null,b);f.sync("read",this,function(d){b.refresh(b.parse(d));a.success&&a.success(b,d)},c);return this},create:function(a,b){b||(b={});a instanceof f.Model||(a=new this.model(a));var c=a.collection=this;return a.save(null,{success:function(d,g){c.add(d);b.success&&b.success(d,g)},error:b.error})},parse:function(a){return a},
10
- chain:function(){return e(this.models).chain()},_reset:function(){this.length=0;this.models=[];this._byId={};this._byCid={}},_add:function(a,b){b||(b={});a instanceof f.Model||(a=new this.model(a));var c=this.getByCid(a);if(c)throw Error(["Can't add the same model to a set twice",c.id]);this._byId[a.id]=a;this._byCid[a.cid]=a;a.collection=this;this.models.splice(this.comparator?this.sortedIndex(a,this.comparator):this.length,0,a);a.bind("all",this._boundOnModelEvent);this.length++;b.silent||this.trigger("add",
11
- a);return a},_remove:function(a,b){b||(b={});a=this.getByCid(a);if(!a)return null;delete this._byId[a.id];delete this._byCid[a.cid];delete a.collection;this.models.splice(this.indexOf(a),1);a.unbind("all",this._boundOnModelEvent);this.length--;b.silent||this.trigger("remove",a);return a},_onModelEvent:function(a,b){if(a==="change:id"){delete this._byId[b.previous("id")];this._byId[b.id]=b}this.trigger.apply(this,arguments)}});e.each(["forEach","each","map","reduce","reduceRight","find","detect","filter",
12
- "select","reject","every","all","some","any","include","invoke","max","min","sortBy","sortedIndex","toArray","size","first","rest","last","without","indexOf","lastIndexOf","isEmpty"],function(a){f.Collection.prototype[a]=function(){return e[a].apply(e,[this.models].concat(e.toArray(arguments)))}});f.View=function(a){this._configure(a||{});this._ensureElement();this.delegateEvents();this.initialize&&this.initialize(a)};var k=function(a){return h(a,this.el)},l=/^(\w+)\s*(.*)$/;e.extend(f.View.prototype,
13
- {tagName:"div",$:k,jQuery:k,render:function(){return this},make:function(a,b,c){a=document.createElement(a);b&&h(a).attr(b);c&&h(a).html(c);return a},delegateEvents:function(a){if(!(a||(a=this.events)))return this;h(this.el).unbind();for(var b in a){var c=a[b],d=b.match(l),g=d[1];d=d[2];c=e.bind(this[c],this);d===""?h(this.el).bind(g,c):h(this.el).delegate(d,g,c)}return this},_configure:function(a){if(this.options)a=e.extend({},this.options,a);if(a.model)this.model=a.model;if(a.collection)this.collection=
14
- a.collection;if(a.el)this.el=a.el;if(a.id)this.id=a.id;if(a.className)this.className=a.className;if(a.tagName)this.tagName=a.tagName;this.options=a},_ensureElement:function(){if(!this.el){var a={};if(this.id)a.id=this.id;if(this.className)a.className=this.className;this.el=this.make(this.tagName,a)}}});var n=f.Model.extend=f.Collection.extend=f.View.extend=function(a,b){var c=m(this,a,b);c.extend=n;return c},o={create:"POST",update:"PUT","delete":"DELETE",read:"GET"};f.sync=function(a,b,c,d){var g=
15
- a==="create"||a==="update"?{model:JSON.stringify(b)}:{};a=o[a];if(f.emulateHttp&&(a==="PUT"||a==="DELETE")){g._method=a;a="POST"}h.ajax({url:j(b),type:a,data:g,dataType:"json",success:c,error:d})};var m=function(a,b,c){var d;d=b.hasOwnProperty("constructor")?b.constructor:function(){return a.apply(this,arguments)};var g=function(){};g.prototype=a.prototype;d.prototype=new g;e.extend(d.prototype,b);c&&e.extend(d,c);return d.prototype.constructor=d},j=function(a){if(!(a&&a.url))throw Error("A 'url' property or function must be specified");
16
- return e.isFunction(a.url)?a.url():a.url}})();
@@ -1,5 +0,0 @@
1
- #!/usr/bin/env ruby
2
- #Compile the HAML and SASS templates
3
-
4
- `haml stats.haml > stats.html`
5
- `sass stats.scss > stats.css`
@@ -1,482 +0,0 @@
1
- /*
2
- http://www.JSON.org/json2.js
3
- 2010-08-25
4
-
5
- Public Domain.
6
-
7
- NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
8
-
9
- See http://www.JSON.org/js.html
10
-
11
-
12
- This code should be minified before deployment.
13
- See http://javascript.crockford.com/jsmin.html
14
-
15
- USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
16
- NOT CONTROL.
17
-
18
-
19
- This file creates a global JSON object containing two methods: stringify
20
- and parse.
21
-
22
- JSON.stringify(value, replacer, space)
23
- value any JavaScript value, usually an object or array.
24
-
25
- replacer an optional parameter that determines how object
26
- values are stringified for objects. It can be a
27
- function or an array of strings.
28
-
29
- space an optional parameter that specifies the indentation
30
- of nested structures. If it is omitted, the text will
31
- be packed without extra whitespace. If it is a number,
32
- it will specify the number of spaces to indent at each
33
- level. If it is a string (such as '\t' or '&nbsp;'),
34
- it contains the characters used to indent at each level.
35
-
36
- This method produces a JSON text from a JavaScript value.
37
-
38
- When an object value is found, if the object contains a toJSON
39
- method, its toJSON method will be called and the result will be
40
- stringified. A toJSON method does not serialize: it returns the
41
- value represented by the name/value pair that should be serialized,
42
- or undefined if nothing should be serialized. The toJSON method
43
- will be passed the key associated with the value, and this will be
44
- bound to the value
45
-
46
- For example, this would serialize Dates as ISO strings.
47
-
48
- Date.prototype.toJSON = function (key) {
49
- function f(n) {
50
- // Format integers to have at least two digits.
51
- return n < 10 ? '0' + n : n;
52
- }
53
-
54
- return this.getUTCFullYear() + '-' +
55
- f(this.getUTCMonth() + 1) + '-' +
56
- f(this.getUTCDate()) + 'T' +
57
- f(this.getUTCHours()) + ':' +
58
- f(this.getUTCMinutes()) + ':' +
59
- f(this.getUTCSeconds()) + 'Z';
60
- };
61
-
62
- You can provide an optional replacer method. It will be passed the
63
- key and value of each member, with this bound to the containing
64
- object. The value that is returned from your method will be
65
- serialized. If your method returns undefined, then the member will
66
- be excluded from the serialization.
67
-
68
- If the replacer parameter is an array of strings, then it will be
69
- used to select the members to be serialized. It filters the results
70
- such that only members with keys listed in the replacer array are
71
- stringified.
72
-
73
- Values that do not have JSON representations, such as undefined or
74
- functions, will not be serialized. Such values in objects will be
75
- dropped; in arrays they will be replaced with null. You can use
76
- a replacer function to replace those with JSON values.
77
- JSON.stringify(undefined) returns undefined.
78
-
79
- The optional space parameter produces a stringification of the
80
- value that is filled with line breaks and indentation to make it
81
- easier to read.
82
-
83
- If the space parameter is a non-empty string, then that string will
84
- be used for indentation. If the space parameter is a number, then
85
- the indentation will be that many spaces.
86
-
87
- Example:
88
-
89
- text = JSON.stringify(['e', {pluribus: 'unum'}]);
90
- // text is '["e",{"pluribus":"unum"}]'
91
-
92
-
93
- text = JSON.stringify(['e', {pluribus: 'unum'}], null, '\t');
94
- // text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'
95
-
96
- text = JSON.stringify([new Date()], function (key, value) {
97
- return this[key] instanceof Date ?
98
- 'Date(' + this[key] + ')' : value;
99
- });
100
- // text is '["Date(---current time---)"]'
101
-
102
-
103
- JSON.parse(text, reviver)
104
- This method parses a JSON text to produce an object or array.
105
- It can throw a SyntaxError exception.
106
-
107
- The optional reviver parameter is a function that can filter and
108
- transform the results. It receives each of the keys and values,
109
- and its return value is used instead of the original value.
110
- If it returns what it received, then the structure is not modified.
111
- If it returns undefined then the member is deleted.
112
-
113
- Example:
114
-
115
- // Parse the text. Values that look like ISO date strings will
116
- // be converted to Date objects.
117
-
118
- myData = JSON.parse(text, function (key, value) {
119
- var a;
120
- if (typeof value === 'string') {
121
- a =
122
- /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
123
- if (a) {
124
- return new Date(Date.UTC(+a[1], +a[2] - 1, +a[3], +a[4],
125
- +a[5], +a[6]));
126
- }
127
- }
128
- return value;
129
- });
130
-
131
- myData = JSON.parse('["Date(09/09/2001)"]', function (key, value) {
132
- var d;
133
- if (typeof value === 'string' &&
134
- value.slice(0, 5) === 'Date(' &&
135
- value.slice(-1) === ')') {
136
- d = new Date(value.slice(5, -1));
137
- if (d) {
138
- return d;
139
- }
140
- }
141
- return value;
142
- });
143
-
144
-
145
- This is a reference implementation. You are free to copy, modify, or
146
- redistribute.
147
- */
148
-
149
- /*jslint evil: true, strict: false */
150
-
151
- /*members "", "\b", "\t", "\n", "\f", "\r", "\"", JSON, "\\", apply,
152
- call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
153
- getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
154
- lastIndex, length, parse, prototype, push, replace, slice, stringify,
155
- test, toJSON, toString, valueOf
156
- */
157
-
158
-
159
- // Create a JSON object only if one does not already exist. We create the
160
- // methods in a closure to avoid creating global variables.
161
-
162
- if (!this.JSON) {
163
- this.JSON = {};
164
- }
165
-
166
- (function () {
167
-
168
- function f(n) {
169
- // Format integers to have at least two digits.
170
- return n < 10 ? '0' + n : n;
171
- }
172
-
173
- if (typeof Date.prototype.toJSON !== 'function') {
174
-
175
- Date.prototype.toJSON = function (key) {
176
-
177
- return isFinite(this.valueOf()) ?
178
- this.getUTCFullYear() + '-' +
179
- f(this.getUTCMonth() + 1) + '-' +
180
- f(this.getUTCDate()) + 'T' +
181
- f(this.getUTCHours()) + ':' +
182
- f(this.getUTCMinutes()) + ':' +
183
- f(this.getUTCSeconds()) + 'Z' : null;
184
- };
185
-
186
- String.prototype.toJSON =
187
- Number.prototype.toJSON =
188
- Boolean.prototype.toJSON = function (key) {
189
- return this.valueOf();
190
- };
191
- }
192
-
193
- var cx = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
194
- escapable = /[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
195
- gap,
196
- indent,
197
- meta = { // table of character substitutions
198
- '\b': '\\b',
199
- '\t': '\\t',
200
- '\n': '\\n',
201
- '\f': '\\f',
202
- '\r': '\\r',
203
- '"' : '\\"',
204
- '\\': '\\\\'
205
- },
206
- rep;
207
-
208
-
209
- function quote(string) {
210
-
211
- // If the string contains no control characters, no quote characters, and no
212
- // backslash characters, then we can safely slap some quotes around it.
213
- // Otherwise we must also replace the offending characters with safe escape
214
- // sequences.
215
-
216
- escapable.lastIndex = 0;
217
- return escapable.test(string) ?
218
- '"' + string.replace(escapable, function (a) {
219
- var c = meta[a];
220
- return typeof c === 'string' ? c :
221
- '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
222
- }) + '"' :
223
- '"' + string + '"';
224
- }
225
-
226
-
227
- function str(key, holder) {
228
-
229
- // Produce a string from holder[key].
230
-
231
- var i, // The loop counter.
232
- k, // The member key.
233
- v, // The member value.
234
- length,
235
- mind = gap,
236
- partial,
237
- value = holder[key];
238
-
239
- // If the value has a toJSON method, call it to obtain a replacement value.
240
-
241
- if (value && typeof value === 'object' &&
242
- typeof value.toJSON === 'function') {
243
- value = value.toJSON(key);
244
- }
245
-
246
- // If we were called with a replacer function, then call the replacer to
247
- // obtain a replacement value.
248
-
249
- if (typeof rep === 'function') {
250
- value = rep.call(holder, key, value);
251
- }
252
-
253
- // What happens next depends on the value's type.
254
-
255
- switch (typeof value) {
256
- case 'string':
257
- return quote(value);
258
-
259
- case 'number':
260
-
261
- // JSON numbers must be finite. Encode non-finite numbers as null.
262
-
263
- return isFinite(value) ? String(value) : 'null';
264
-
265
- case 'boolean':
266
- case 'null':
267
-
268
- // If the value is a boolean or null, convert it to a string. Note:
269
- // typeof null does not produce 'null'. The case is included here in
270
- // the remote chance that this gets fixed someday.
271
-
272
- return String(value);
273
-
274
- // If the type is 'object', we might be dealing with an object or an array or
275
- // null.
276
-
277
- case 'object':
278
-
279
- // Due to a specification blunder in ECMAScript, typeof null is 'object',
280
- // so watch out for that case.
281
-
282
- if (!value) {
283
- return 'null';
284
- }
285
-
286
- // Make an array to hold the partial results of stringifying this object value.
287
-
288
- gap += indent;
289
- partial = [];
290
-
291
- // Is the value an array?
292
-
293
- if (Object.prototype.toString.apply(value) === '[object Array]') {
294
-
295
- // The value is an array. Stringify every element. Use null as a placeholder
296
- // for non-JSON values.
297
-
298
- length = value.length;
299
- for (i = 0; i < length; i += 1) {
300
- partial[i] = str(i, value) || 'null';
301
- }
302
-
303
- // Join all of the elements together, separated with commas, and wrap them in
304
- // brackets.
305
-
306
- v = partial.length === 0 ? '[]' :
307
- gap ? '[\n' + gap +
308
- partial.join(',\n' + gap) + '\n' +
309
- mind + ']' :
310
- '[' + partial.join(',') + ']';
311
- gap = mind;
312
- return v;
313
- }
314
-
315
- // If the replacer is an array, use it to select the members to be stringified.
316
-
317
- if (rep && typeof rep === 'object') {
318
- length = rep.length;
319
- for (i = 0; i < length; i += 1) {
320
- k = rep[i];
321
- if (typeof k === 'string') {
322
- v = str(k, value);
323
- if (v) {
324
- partial.push(quote(k) + (gap ? ': ' : ':') + v);
325
- }
326
- }
327
- }
328
- } else {
329
-
330
- // Otherwise, iterate through all of the keys in the object.
331
-
332
- for (k in value) {
333
- if (Object.hasOwnProperty.call(value, k)) {
334
- v = str(k, value);
335
- if (v) {
336
- partial.push(quote(k) + (gap ? ': ' : ':') + v);
337
- }
338
- }
339
- }
340
- }
341
-
342
- // Join all of the member texts together, separated with commas,
343
- // and wrap them in braces.
344
-
345
- v = partial.length === 0 ? '{}' :
346
- gap ? '{\n' + gap + partial.join(',\n' + gap) + '\n' +
347
- mind + '}' : '{' + partial.join(',') + '}';
348
- gap = mind;
349
- return v;
350
- }
351
- }
352
-
353
- // If the JSON object does not yet have a stringify method, give it one.
354
-
355
- if (typeof JSON.stringify !== 'function') {
356
- JSON.stringify = function (value, replacer, space) {
357
-
358
- // The stringify method takes a value and an optional replacer, and an optional
359
- // space parameter, and returns a JSON text. The replacer can be a function
360
- // that can replace values, or an array of strings that will select the keys.
361
- // A default replacer method can be provided. Use of the space parameter can
362
- // produce text that is more easily readable.
363
-
364
- var i;
365
- gap = '';
366
- indent = '';
367
-
368
- // If the space parameter is a number, make an indent string containing that
369
- // many spaces.
370
-
371
- if (typeof space === 'number') {
372
- for (i = 0; i < space; i += 1) {
373
- indent += ' ';
374
- }
375
-
376
- // If the space parameter is a string, it will be used as the indent string.
377
-
378
- } else if (typeof space === 'string') {
379
- indent = space;
380
- }
381
-
382
- // If there is a replacer, it must be a function or an array.
383
- // Otherwise, throw an error.
384
-
385
- rep = replacer;
386
- if (replacer && typeof replacer !== 'function' &&
387
- (typeof replacer !== 'object' ||
388
- typeof replacer.length !== 'number')) {
389
- throw new Error('JSON.stringify');
390
- }
391
-
392
- // Make a fake root object containing our value under the key of ''.
393
- // Return the result of stringifying the value.
394
-
395
- return str('', {'': value});
396
- };
397
- }
398
-
399
-
400
- // If the JSON object does not yet have a parse method, give it one.
401
-
402
- if (typeof JSON.parse !== 'function') {
403
- JSON.parse = function (text, reviver) {
404
-
405
- // The parse method takes a text and an optional reviver function, and returns
406
- // a JavaScript value if the text is a valid JSON text.
407
-
408
- var j;
409
-
410
- function walk(holder, key) {
411
-
412
- // The walk method is used to recursively walk the resulting structure so
413
- // that modifications can be made.
414
-
415
- var k, v, value = holder[key];
416
- if (value && typeof value === 'object') {
417
- for (k in value) {
418
- if (Object.hasOwnProperty.call(value, k)) {
419
- v = walk(value, k);
420
- if (v !== undefined) {
421
- value[k] = v;
422
- } else {
423
- delete value[k];
424
- }
425
- }
426
- }
427
- }
428
- return reviver.call(holder, key, value);
429
- }
430
-
431
-
432
- // Parsing happens in four stages. In the first stage, we replace certain
433
- // Unicode characters with escape sequences. JavaScript handles many characters
434
- // incorrectly, either silently deleting them, or treating them as line endings.
435
-
436
- text = String(text);
437
- cx.lastIndex = 0;
438
- if (cx.test(text)) {
439
- text = text.replace(cx, function (a) {
440
- return '\\u' +
441
- ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
442
- });
443
- }
444
-
445
- // In the second stage, we run the text against regular expressions that look
446
- // for non-JSON patterns. We are especially concerned with '()' and 'new'
447
- // because they can cause invocation, and '=' because it can cause mutation.
448
- // But just to be safe, we want to reject all unexpected forms.
449
-
450
- // We split the second stage into 4 regexp operations in order to work around
451
- // crippling inefficiencies in IE's and Safari's regexp engines. First we
452
- // replace the JSON backslash pairs with '@' (a non-JSON character). Second, we
453
- // replace all simple value tokens with ']' characters. Third, we delete all
454
- // open brackets that follow a colon or comma or that begin the text. Finally,
455
- // we look to see that the remaining characters are only whitespace or ']' or
456
- // ',' or ':' or '{' or '}'. If that is so, then the text is safe for eval.
457
-
458
- if (/^[\],:{}\s]*$/
459
- .test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, '@')
460
- .replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']')
461
- .replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) {
462
-
463
- // In the third stage we use the eval function to compile the text into a
464
- // JavaScript structure. The '{' operator is subject to a syntactic ambiguity
465
- // in JavaScript: it can begin a block or an object literal. We wrap the text
466
- // in parens to eliminate the ambiguity.
467
-
468
- j = eval('(' + text + ')');
469
-
470
- // In the optional fourth stage, we recursively walk the new structure, passing
471
- // each name/value pair to a reviver function for possible transformation.
472
-
473
- return typeof reviver === 'function' ?
474
- walk({'': j}, '') : j;
475
- }
476
-
477
- // If the text is not JSON parseable, then a SyntaxError is thrown.
478
-
479
- throw new SyntaxError('JSON.parse');
480
- };
481
- }
482
- }());