remodel-h-r19 0.2.4
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +2 -0
- data/LICENSE +20 -0
- data/README.md +96 -0
- data/Rakefile +27 -0
- data/VERSION +1 -0
- data/bin/redis-monitor.rb +25 -0
- data/docs/docco.css +185 -0
- data/docs/remodel.html +269 -0
- data/example/book.rb +13 -0
- data/lib/remodel-h.rb +69 -0
- data/lib/remodel/entity.rb +202 -0
- data/lib/remodel/has_many.rb +71 -0
- data/lib/remodel/mapper.rb +29 -0
- data/remodel-h.gemspec +73 -0
- data/test/helper.rb +13 -0
- data/test/test_entity.rb +297 -0
- data/test/test_entity_delete.rb +45 -0
- data/test/test_many_to_many.rb +77 -0
- data/test/test_many_to_one.rb +107 -0
- data/test/test_mappers.rb +67 -0
- data/test/test_monkeypatches.rb +30 -0
- data/test/test_one_to_many.rb +96 -0
- data/test/test_one_to_one.rb +57 -0
- metadata +98 -0
data/.gitignore
ADDED
data/LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
Copyright (c) 2010 Tim Lossen -- http://tim.lossen.de
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
4
|
+
a copy of this software and associated documentation files (the
|
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
9
|
+
the following conditions:
|
|
10
|
+
|
|
11
|
+
The above copyright notice and this permission notice shall be
|
|
12
|
+
included in all copies or substantial portions of the Software.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# remodel your storage layer
|
|
2
|
+
|
|
3
|
+
use [redis](http://github.com/antirez/redis) instead of mysql to store your application data.
|
|
4
|
+
|
|
5
|
+
remodel (= redis model) is an ActiveRecord-like mapping layer which offers familiar syntax
|
|
6
|
+
like `has_many`, `has_one` etc. to build your domain model in ruby.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
## why redis?
|
|
10
|
+
|
|
11
|
+
redis offers in-memory read and write performance — on the order of 10K to 100K
|
|
12
|
+
operations per second, comparable to [memcached](http://memcached.org/) — plus asynchronous
|
|
13
|
+
persistence to disk. for example, on my macbook (2 ghz):
|
|
14
|
+
|
|
15
|
+
$ redis-benchmark -d 100 -r 10000 -q
|
|
16
|
+
SET: 13864.27 requests per second
|
|
17
|
+
GET: 18152.17 requests per second
|
|
18
|
+
INCR: 17006.80 requests per second
|
|
19
|
+
LPUSH: 17243.99 requests per second
|
|
20
|
+
LPOP: 18706.54 requests per second
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
## how to get started
|
|
25
|
+
|
|
26
|
+
1. install [redis](http://github.com/antirez/redis) and ezras excellent
|
|
27
|
+
[redis-rb](http://github.com/ezmobius/redis-rb) ruby client:
|
|
28
|
+
|
|
29
|
+
$ brew install redis
|
|
30
|
+
$ gem install redis
|
|
31
|
+
|
|
32
|
+
2. start redis:
|
|
33
|
+
|
|
34
|
+
$ ./redis-server
|
|
35
|
+
|
|
36
|
+
3. now the tests should run successfully:
|
|
37
|
+
|
|
38
|
+
$ rake
|
|
39
|
+
Started
|
|
40
|
+
.......................................................................................
|
|
41
|
+
Finished in 0.072304 seconds.
|
|
42
|
+
87 tests, 138 assertions, 0 failures, 0 errors
|
|
43
|
+
|
|
44
|
+
## example
|
|
45
|
+
|
|
46
|
+
define your domain model [like this](http://github.com/tlossen/remodel/blob/master/example/book.rb):
|
|
47
|
+
|
|
48
|
+
class Book < Remodel::Entity
|
|
49
|
+
has_many :chapters, :class => 'Chapter', :reverse => :book
|
|
50
|
+
property :title, :class => 'String'
|
|
51
|
+
property :year, :class => 'Integer'
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
class Chapter < Remodel::Entity
|
|
55
|
+
has_one :book, :class => Book, :reverse => :chapters
|
|
56
|
+
property :title, :class => String
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
now you can do:
|
|
60
|
+
|
|
61
|
+
>> require 'example/book'
|
|
62
|
+
=> true
|
|
63
|
+
>> book = Book.create :title => 'Moby Dick', :year => 1851
|
|
64
|
+
=> #<Book(b:3) title: "Moby Dick", year: 1851>
|
|
65
|
+
>> chapter = book.chapters.create :title => 'Ishmael'
|
|
66
|
+
=> #<Chapter(c:4) title: "Ishmael">
|
|
67
|
+
>> chapter.book
|
|
68
|
+
=> #<Book(b:3) title: "Moby Dick", year: 1851>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
## inspired by
|
|
72
|
+
|
|
73
|
+
* [how to redis](http://www.paperplanes.de/2009/10/30/how_to_redis.html)
|
|
74
|
+
— good overview of different mapping options by [mattmatt](http://github.com/mattmatt).
|
|
75
|
+
* [hurl](http://github.com/defunkt/hurl) — basically
|
|
76
|
+
defunkts [Hurl::Model](http://github.com/defunkt/hurl/blob/master/models/model.rb) is what i started with.
|
|
77
|
+
* [ohm](http://github.com/soveran/ohm) — object-hash mapping for redis.
|
|
78
|
+
somewhat similar, but instead of serializing to json, stores each attribute under a separate key.
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
## todo
|
|
82
|
+
|
|
83
|
+
* better docs
|
|
84
|
+
* `find_by`
|
|
85
|
+
* make serializer (json, messagepack, marshal ...) configurable
|
|
86
|
+
* benchmarks
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## status
|
|
90
|
+
|
|
91
|
+
still pretty alpha — play around at your own risk :)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
## license
|
|
95
|
+
|
|
96
|
+
[MIT](http://github.com/tlossen/remodel/raw/master/LICENSE), baby!
|
data/Rakefile
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
require 'rubygems'
|
|
2
|
+
require 'rake'
|
|
3
|
+
|
|
4
|
+
begin
|
|
5
|
+
require 'jeweler'
|
|
6
|
+
Jeweler::Tasks.new do |gem|
|
|
7
|
+
gem.name = "remodel-h-r19"
|
|
8
|
+
gem.summary = "ruby 1.9.2 remodel variant which uses hashes"
|
|
9
|
+
gem.description = "persist your objects to redis hashes."
|
|
10
|
+
gem.email = "tim@lossen.de"
|
|
11
|
+
gem.homepage = "http://github.com/tlossen/remodel"
|
|
12
|
+
gem.authors = ["Tim Lossen"]
|
|
13
|
+
gem.files.include('lib/**/*.rb')
|
|
14
|
+
end
|
|
15
|
+
Jeweler::GemcutterTasks.new
|
|
16
|
+
rescue LoadError
|
|
17
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
require 'rake/testtask'
|
|
21
|
+
Rake::TestTask.new(:test) do |test|
|
|
22
|
+
test.libs << 'lib' << 'test'
|
|
23
|
+
test.pattern = 'test/**/test_*.rb'
|
|
24
|
+
test.verbose = true
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
task :default => :test
|
data/VERSION
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
0.2.4
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
# http://gist.github.com/267149 (mathias meyer)
|
|
4
|
+
|
|
5
|
+
require 'socket'
|
|
6
|
+
host = ARGV[0] || 'localhost'
|
|
7
|
+
port = ARGV[1] || '6379'
|
|
8
|
+
|
|
9
|
+
trap(:INT) {
|
|
10
|
+
exit
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
puts "Connecting to #{host}:#{port}"
|
|
14
|
+
begin
|
|
15
|
+
sock = TCPSocket.new(host, port)
|
|
16
|
+
sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
|
|
17
|
+
|
|
18
|
+
sock.write("monitor\r\n")
|
|
19
|
+
|
|
20
|
+
while line = sock.gets
|
|
21
|
+
puts line
|
|
22
|
+
end
|
|
23
|
+
rescue Errno::ECONNREFUSED
|
|
24
|
+
puts "Connection refused"
|
|
25
|
+
end
|
data/docs/docco.css
ADDED
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
/*--------------------- Layout and Typography ----------------------------*/
|
|
2
|
+
body {
|
|
3
|
+
font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
|
|
4
|
+
font-size: 16px;
|
|
5
|
+
line-height: 24px;
|
|
6
|
+
color: #252519;
|
|
7
|
+
margin: 0; padding: 0;
|
|
8
|
+
}
|
|
9
|
+
a {
|
|
10
|
+
color: #261a3b;
|
|
11
|
+
}
|
|
12
|
+
a:visited {
|
|
13
|
+
color: #261a3b;
|
|
14
|
+
}
|
|
15
|
+
p {
|
|
16
|
+
margin: 0 0 15px 0;
|
|
17
|
+
}
|
|
18
|
+
h1, h2, h3, h4, h5, h6 {
|
|
19
|
+
margin: 40px 0 15px 0;
|
|
20
|
+
}
|
|
21
|
+
h3, h4, h5, h6 {
|
|
22
|
+
margin-top: 20px;
|
|
23
|
+
}
|
|
24
|
+
#container {
|
|
25
|
+
position: relative;
|
|
26
|
+
}
|
|
27
|
+
#background {
|
|
28
|
+
position: fixed;
|
|
29
|
+
top: 0; left: 580px; right: 0; bottom: 0;
|
|
30
|
+
background: #f5f5ff;
|
|
31
|
+
border-left: 1px solid #e5e5ee;
|
|
32
|
+
z-index: -1;
|
|
33
|
+
}
|
|
34
|
+
#jump_to, #jump_page {
|
|
35
|
+
background: white;
|
|
36
|
+
-webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
|
|
37
|
+
-webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
|
|
38
|
+
font: 10px Arial;
|
|
39
|
+
text-transform: uppercase;
|
|
40
|
+
cursor: pointer;
|
|
41
|
+
text-align: right;
|
|
42
|
+
}
|
|
43
|
+
#jump_to, #jump_wrapper {
|
|
44
|
+
position: fixed;
|
|
45
|
+
right: 0; top: 0;
|
|
46
|
+
padding: 5px 10px;
|
|
47
|
+
}
|
|
48
|
+
#jump_wrapper {
|
|
49
|
+
padding: 0;
|
|
50
|
+
display: none;
|
|
51
|
+
}
|
|
52
|
+
#jump_to:hover #jump_wrapper {
|
|
53
|
+
display: block;
|
|
54
|
+
}
|
|
55
|
+
#jump_page {
|
|
56
|
+
padding: 5px 0 3px;
|
|
57
|
+
margin: 0 0 25px 25px;
|
|
58
|
+
}
|
|
59
|
+
#jump_page .source {
|
|
60
|
+
display: block;
|
|
61
|
+
padding: 5px 10px;
|
|
62
|
+
text-decoration: none;
|
|
63
|
+
border-top: 1px solid #eee;
|
|
64
|
+
}
|
|
65
|
+
#jump_page .source:hover {
|
|
66
|
+
background: #f5f5ff;
|
|
67
|
+
}
|
|
68
|
+
#jump_page .source:first-child {
|
|
69
|
+
}
|
|
70
|
+
table td {
|
|
71
|
+
border: 0;
|
|
72
|
+
outline: 0;
|
|
73
|
+
}
|
|
74
|
+
td.docs, th.docs {
|
|
75
|
+
max-width: 500px;
|
|
76
|
+
min-width: 500px;
|
|
77
|
+
min-height: 5px;
|
|
78
|
+
padding: 10px 25px 1px 50px;
|
|
79
|
+
vertical-align: top;
|
|
80
|
+
text-align: left;
|
|
81
|
+
}
|
|
82
|
+
.docs pre {
|
|
83
|
+
margin: 15px 0 15px;
|
|
84
|
+
padding-left: 15px;
|
|
85
|
+
}
|
|
86
|
+
.docs p tt, .docs p code {
|
|
87
|
+
background: #f8f8ff;
|
|
88
|
+
border: 1px solid #dedede;
|
|
89
|
+
font-size: 12px;
|
|
90
|
+
padding: 0 0.2em;
|
|
91
|
+
}
|
|
92
|
+
.octowrap {
|
|
93
|
+
position: relative;
|
|
94
|
+
}
|
|
95
|
+
.octothorpe {
|
|
96
|
+
font: 12px Arial;
|
|
97
|
+
text-decoration: none;
|
|
98
|
+
color: #454545;
|
|
99
|
+
position: absolute;
|
|
100
|
+
top: 3px; left: -20px;
|
|
101
|
+
padding: 1px 2px;
|
|
102
|
+
opacity: 0;
|
|
103
|
+
-webkit-transition: opacity 0.2s linear;
|
|
104
|
+
}
|
|
105
|
+
td.docs:hover .octothorpe {
|
|
106
|
+
opacity: 1;
|
|
107
|
+
}
|
|
108
|
+
td.code, th.code {
|
|
109
|
+
padding: 14px 15px 16px 50px;
|
|
110
|
+
width: 100%;
|
|
111
|
+
vertical-align: top;
|
|
112
|
+
background: #f5f5ff;
|
|
113
|
+
border-left: 1px solid #e5e5ee;
|
|
114
|
+
}
|
|
115
|
+
pre, tt, code {
|
|
116
|
+
font-size: 12px; line-height: 18px;
|
|
117
|
+
font-family: Monaco, Consolas, "Lucida Console", monospace;
|
|
118
|
+
margin: 0; padding: 0;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
/*---------------------- Syntax Highlighting -----------------------------*/
|
|
123
|
+
td.linenos { background-color: #f0f0f0; padding-right: 10px; }
|
|
124
|
+
span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
|
|
125
|
+
body .hll { background-color: #ffffcc }
|
|
126
|
+
body .c { color: #408080; font-style: italic } /* Comment */
|
|
127
|
+
/*body .err { border: 1px solid #FF0000 } /* Error */
|
|
128
|
+
body .k { color: #954121 } /* Keyword */
|
|
129
|
+
body .o { color: #666666 } /* Operator */
|
|
130
|
+
body .cm { color: #408080; font-style: italic } /* Comment.Multiline */
|
|
131
|
+
body .cp { color: #BC7A00 } /* Comment.Preproc */
|
|
132
|
+
body .c1 { color: #408080; font-style: italic } /* Comment.Single */
|
|
133
|
+
body .cs { color: #408080; font-style: italic } /* Comment.Special */
|
|
134
|
+
body .gd { color: #A00000 } /* Generic.Deleted */
|
|
135
|
+
body .ge { font-style: italic } /* Generic.Emph */
|
|
136
|
+
body .gr { color: #FF0000 } /* Generic.Error */
|
|
137
|
+
body .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
|
138
|
+
body .gi { color: #00A000 } /* Generic.Inserted */
|
|
139
|
+
body .go { color: #808080 } /* Generic.Output */
|
|
140
|
+
body .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
|
|
141
|
+
body .gs { font-weight: bold } /* Generic.Strong */
|
|
142
|
+
body .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
|
143
|
+
body .gt { color: #0040D0 } /* Generic.Traceback */
|
|
144
|
+
body .kc { color: #954121 } /* Keyword.Constant */
|
|
145
|
+
body .kd { color: #954121; font-weight: bold } /* Keyword.Declaration */
|
|
146
|
+
body .kn { color: #954121; font-weight: bold } /* Keyword.Namespace */
|
|
147
|
+
body .kp { color: #954121 } /* Keyword.Pseudo */
|
|
148
|
+
body .kr { color: #954121; font-weight: bold } /* Keyword.Reserved */
|
|
149
|
+
body .kt { color: #B00040 } /* Keyword.Type */
|
|
150
|
+
body .m { color: #666666 } /* Literal.Number */
|
|
151
|
+
body .s { color: #219161 } /* Literal.String */
|
|
152
|
+
body .na { color: #7D9029 } /* Name.Attribute */
|
|
153
|
+
body .nb { color: #954121 } /* Name.Builtin */
|
|
154
|
+
body .nc { color: #0000FF; font-weight: bold } /* Name.Class */
|
|
155
|
+
body .no { color: #880000 } /* Name.Constant */
|
|
156
|
+
body .nd { color: #AA22FF } /* Name.Decorator */
|
|
157
|
+
body .ni { color: #999999; font-weight: bold } /* Name.Entity */
|
|
158
|
+
body .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
|
|
159
|
+
body .nf { color: #0000FF } /* Name.Function */
|
|
160
|
+
body .nl { color: #A0A000 } /* Name.Label */
|
|
161
|
+
body .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
|
|
162
|
+
body .nt { color: #954121; font-weight: bold } /* Name.Tag */
|
|
163
|
+
body .nv { color: #19469D } /* Name.Variable */
|
|
164
|
+
body .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
|
|
165
|
+
body .w { color: #bbbbbb } /* Text.Whitespace */
|
|
166
|
+
body .mf { color: #666666 } /* Literal.Number.Float */
|
|
167
|
+
body .mh { color: #666666 } /* Literal.Number.Hex */
|
|
168
|
+
body .mi { color: #666666 } /* Literal.Number.Integer */
|
|
169
|
+
body .mo { color: #666666 } /* Literal.Number.Oct */
|
|
170
|
+
body .sb { color: #219161 } /* Literal.String.Backtick */
|
|
171
|
+
body .sc { color: #219161 } /* Literal.String.Char */
|
|
172
|
+
body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */
|
|
173
|
+
body .s2 { color: #219161 } /* Literal.String.Double */
|
|
174
|
+
body .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
|
|
175
|
+
body .sh { color: #219161 } /* Literal.String.Heredoc */
|
|
176
|
+
body .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
|
|
177
|
+
body .sx { color: #954121 } /* Literal.String.Other */
|
|
178
|
+
body .sr { color: #BB6688 } /* Literal.String.Regex */
|
|
179
|
+
body .s1 { color: #219161 } /* Literal.String.Single */
|
|
180
|
+
body .ss { color: #19469D } /* Literal.String.Symbol */
|
|
181
|
+
body .bp { color: #954121 } /* Name.Builtin.Pseudo */
|
|
182
|
+
body .vc { color: #19469D } /* Name.Variable.Class */
|
|
183
|
+
body .vg { color: #19469D } /* Name.Variable.Global */
|
|
184
|
+
body .vi { color: #19469D } /* Name.Variable.Instance */
|
|
185
|
+
body .il { color: #666666 } /* Literal.Number.Integer.Long */
|
data/docs/remodel.html
ADDED
|
@@ -0,0 +1,269 @@
|
|
|
1
|
+
<!DOCTYPE html> <html> <head> <title>remodel.rb</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> remodel.rb </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-1">#</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nb">require</span> <span class="s1">'rubygems'</span>
|
|
2
|
+
<span class="nb">require</span> <span class="s1">'redis'</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-2">#</a> </div> <p>Use the superfast <a href="http://github.com/brianmario/yajl-ruby">YAJL</a> lib to parse <a href="http://json.org/">JSON</a>, if available.</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">begin</span>
|
|
3
|
+
<span class="nb">require</span> <span class="s1">'yajl/json_gem'</span>
|
|
4
|
+
<span class="k">rescue</span> <span class="no">LoadError</span>
|
|
5
|
+
<span class="nb">require</span> <span class="s1">'json'</span>
|
|
6
|
+
<span class="k">end</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-3">#</a> </div> <h3>Monkey patches</h3> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-4">#</a> </div> <p>Define <code>Boolean</code> as the superclass of <code>true</code> and <code>false</code>.</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">module</span> <span class="nn">Boolean</span><span class="p">;</span> <span class="k">end</span>
|
|
7
|
+
<span class="kp">true</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="no">Boolean</span><span class="p">)</span>
|
|
8
|
+
<span class="kp">false</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="no">Boolean</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-5">#</a> </div> <p>Find the <code>Class</code> object for a given class name, which can be a <code>String</code> or <code>Symbol</code> (or <code>Class</code>).</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">def</span> <span class="nc">Class</span><span class="o">.</span><span class="nf">[]</span><span class="p">(</span><span class="n">clazz</span><span class="p">)</span>
|
|
9
|
+
<span class="k">return</span> <span class="n">clazz</span> <span class="k">if</span> <span class="n">clazz</span><span class="o">.</span><span class="n">nil?</span> <span class="ow">or</span> <span class="n">clazz</span><span class="o">.</span><span class="n">is_a?</span><span class="p">(</span><span class="no">Class</span><span class="p">)</span>
|
|
10
|
+
<span class="n">clazz</span><span class="o">.</span><span class="n">to_s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'::'</span><span class="p">)</span><span class="o">.</span><span class="n">inject</span><span class="p">(</span><span class="no">Kernel</span><span class="p">)</span> <span class="p">{</span> <span class="o">|</span><span class="n">mod</span><span class="p">,</span> <span class="nb">name</span><span class="o">|</span> <span class="n">mod</span><span class="o">.</span><span class="n">const_get</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span> <span class="p">}</span>
|
|
11
|
+
<span class="k">end</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-6">#</a> </div> <h3>Remodel</h3> </td> <td class="code"> <div class="highlight"><pre><span class="k">module</span> <span class="nn">Remodel</span>
|
|
12
|
+
</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-7">#</a> </div> <p>By default, we expect to find the redis server on <code>localhost:6379</code> —
|
|
13
|
+
otherwise you will have to set <code>Remodel.redis</code> to a suitably initialized redis client.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">redis</span>
|
|
14
|
+
<span class="vi">@redis</span> <span class="o">||=</span> <span class="no">Redis</span><span class="o">.</span><span class="n">new</span>
|
|
15
|
+
<span class="k">end</span>
|
|
16
|
+
|
|
17
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">redis</span><span class="o">=</span><span class="p">(</span><span class="n">redis</span><span class="p">)</span>
|
|
18
|
+
<span class="vi">@redis</span> <span class="o">=</span> <span class="n">redis</span>
|
|
19
|
+
<span class="k">end</span></pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-8">#</a> </div> <p>Custom errors</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">class</span> <span class="nc">Error</span> <span class="o"><</span> <span class="o">::</span><span class="no">StandardError</span><span class="p">;</span> <span class="k">end</span>
|
|
20
|
+
<span class="k">class</span> <span class="nc">EntityNotFound</span> <span class="o"><</span> <span class="no">Error</span><span class="p">;</span> <span class="k">end</span>
|
|
21
|
+
<span class="k">class</span> <span class="nc">EntityNotSaved</span> <span class="o"><</span> <span class="no">Error</span><span class="p">;</span> <span class="k">end</span>
|
|
22
|
+
<span class="k">class</span> <span class="nc">InvalidKeyPrefix</span> <span class="o"><</span> <span class="no">Error</span><span class="p">;</span> <span class="k">end</span>
|
|
23
|
+
<span class="k">class</span> <span class="nc">InvalidType</span> <span class="o"><</span> <span class="no">Error</span><span class="p">;</span> <span class="k">end</span>
|
|
24
|
+
</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-9">#</a> </div> <h3>Mapper</h3> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-10">#</a> </div> <p>A mapper converts a given value into a native JSON value —
|
|
25
|
+
<em>nil</em>, <em>true</em>, <em>false</em>, <em>Number</em>, <em>String</em>, <em>Hash</em>, <em>Array</em> — via <code>pack</code>,
|
|
26
|
+
and back again via <code>unpack</code>.</p>
|
|
27
|
+
|
|
28
|
+
<p>Without any arguments, <code>Mapper.new</code> returns the identity mapper, which maps every value into itself.
|
|
29
|
+
If <code>clazz</code> is set, the mapper rejects any value which is not of the given type.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">class</span> <span class="nc">Mapper</span>
|
|
30
|
+
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">clazz</span> <span class="o">=</span> <span class="kp">nil</span><span class="p">,</span> <span class="n">pack_method</span> <span class="o">=</span> <span class="kp">nil</span><span class="p">,</span> <span class="n">unpack_method</span> <span class="o">=</span> <span class="kp">nil</span><span class="p">)</span>
|
|
31
|
+
<span class="vi">@clazz</span> <span class="o">=</span> <span class="n">clazz</span>
|
|
32
|
+
<span class="vi">@pack_method</span> <span class="o">=</span> <span class="n">pack_method</span>
|
|
33
|
+
<span class="vi">@unpack_method</span> <span class="o">=</span> <span class="n">unpack_method</span>
|
|
34
|
+
<span class="k">end</span>
|
|
35
|
+
|
|
36
|
+
<span class="k">def</span> <span class="nf">pack</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
37
|
+
<span class="k">return</span> <span class="kp">nil</span> <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">nil?</span>
|
|
38
|
+
<span class="k">raise</span><span class="p">(</span><span class="no">InvalidType</span><span class="p">,</span> <span class="s2">"</span><span class="si">#{</span><span class="n">value</span><span class="o">.</span><span class="n">inspect</span><span class="si">}</span><span class="s2"> is not a </span><span class="si">#{</span><span class="vi">@clazz</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> <span class="k">if</span> <span class="vi">@clazz</span> <span class="o">&&</span> <span class="o">!</span><span class="n">value</span><span class="o">.</span><span class="n">is_a?</span><span class="p">(</span><span class="vi">@clazz</span><span class="p">)</span>
|
|
39
|
+
<span class="vi">@pack_method</span> <span class="p">?</span> <span class="n">value</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="vi">@pack_method</span><span class="p">)</span> <span class="p">:</span> <span class="n">value</span>
|
|
40
|
+
<span class="k">end</span>
|
|
41
|
+
|
|
42
|
+
<span class="k">def</span> <span class="nf">unpack</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
43
|
+
<span class="k">return</span> <span class="kp">nil</span> <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">nil?</span>
|
|
44
|
+
<span class="vi">@unpack_method</span> <span class="p">?</span> <span class="vi">@clazz</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="vi">@unpack_method</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="p">:</span> <span class="n">value</span>
|
|
45
|
+
<span class="k">end</span>
|
|
46
|
+
<span class="k">end</span></pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-11">#</a> </div> <p>So let's define some handy mappers for common types, and a way to look them up.
|
|
47
|
+
If no mapper is defined for a given class, the identity mapper is used.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">mapper_by_class</span>
|
|
48
|
+
<span class="vi">@mapper_by_class</span> <span class="o">||=</span> <span class="no">Hash</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">)</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span>
|
|
49
|
+
<span class="no">Boolean</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Boolean</span><span class="p">),</span>
|
|
50
|
+
<span class="nb">String</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">String</span><span class="p">),</span>
|
|
51
|
+
<span class="nb">Integer</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">Integer</span><span class="p">),</span>
|
|
52
|
+
<span class="nb">Float</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">Float</span><span class="p">),</span>
|
|
53
|
+
<span class="nb">Array</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">Array</span><span class="p">),</span>
|
|
54
|
+
<span class="no">Hash</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Hash</span><span class="p">),</span>
|
|
55
|
+
<span class="no">Date</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Date</span><span class="p">,</span> <span class="ss">:to_s</span><span class="p">,</span> <span class="ss">:parse</span><span class="p">),</span>
|
|
56
|
+
<span class="no">Time</span> <span class="o">=></span> <span class="no">Mapper</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="no">Time</span><span class="p">,</span> <span class="ss">:to_i</span><span class="p">,</span> <span class="ss">:at</span><span class="p">)</span>
|
|
57
|
+
<span class="p">)</span>
|
|
58
|
+
<span class="k">end</span>
|
|
59
|
+
|
|
60
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">mapper_for</span><span class="p">(</span><span class="n">clazz</span><span class="p">)</span>
|
|
61
|
+
<span class="n">mapper_by_class</span><span class="o">[</span><span class="no">Class</span><span class="o">[</span><span class="n">clazz</span><span class="o">]]</span>
|
|
62
|
+
<span class="k">end</span></pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-12">#</a> </div> <h3>HasMany</h3> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-13">#</a> </div> <p>Represents the many-end of a many-to-one or many-to-many association.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">class</span> <span class="nc">HasMany</span> <span class="o"><</span> <span class="nb">Array</span>
|
|
63
|
+
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">this</span><span class="p">,</span> <span class="n">clazz</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">reverse</span> <span class="o">=</span> <span class="kp">nil</span><span class="p">)</span>
|
|
64
|
+
<span class="k">super</span> <span class="n">_fetch</span><span class="p">(</span><span class="n">clazz</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
|
|
65
|
+
<span class="vi">@this</span><span class="p">,</span> <span class="vi">@clazz</span><span class="p">,</span> <span class="vi">@key</span><span class="p">,</span> <span class="vi">@reverse</span> <span class="o">=</span> <span class="n">this</span><span class="p">,</span> <span class="n">clazz</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">reverse</span>
|
|
66
|
+
<span class="k">end</span>
|
|
67
|
+
|
|
68
|
+
<span class="k">def</span> <span class="nf">create</span><span class="p">(</span><span class="n">attributes</span> <span class="o">=</span> <span class="p">{})</span>
|
|
69
|
+
<span class="n">add</span><span class="p">(</span><span class="vi">@clazz</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">attributes</span><span class="p">))</span>
|
|
70
|
+
<span class="k">end</span>
|
|
71
|
+
|
|
72
|
+
<span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
|
|
73
|
+
<span class="n">_add_to_reverse_association_of</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span> <span class="k">if</span> <span class="vi">@reverse</span>
|
|
74
|
+
<span class="n">_add</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
|
|
75
|
+
<span class="k">end</span>
|
|
76
|
+
|
|
77
|
+
<span class="kp">private</span>
|
|
78
|
+
|
|
79
|
+
<span class="k">def</span> <span class="nf">_add</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
|
|
80
|
+
<span class="nb">self</span> <span class="o"><<</span> <span class="n">entity</span>
|
|
81
|
+
<span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">rpush</span><span class="p">(</span><span class="vi">@key</span><span class="p">,</span> <span class="n">entity</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
|
|
82
|
+
<span class="n">entity</span>
|
|
83
|
+
<span class="k">end</span>
|
|
84
|
+
|
|
85
|
+
<span class="k">def</span> <span class="nf">_remove</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
|
|
86
|
+
<span class="n">delete_if</span> <span class="p">{</span> <span class="o">|</span><span class="n">x</span><span class="o">|</span> <span class="n">x</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">entity</span><span class="o">.</span><span class="n">key</span> <span class="p">}</span>
|
|
87
|
+
<span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">lrem</span><span class="p">(</span><span class="vi">@key</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">entity</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
|
|
88
|
+
<span class="k">end</span>
|
|
89
|
+
|
|
90
|
+
<span class="k">def</span> <span class="nf">_add_to_reverse_association_of</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
|
|
91
|
+
<span class="k">if</span> <span class="n">entity</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="vi">@reverse</span><span class="p">)</span><span class="o">.</span><span class="n">is_a?</span> <span class="no">HasMany</span>
|
|
92
|
+
<span class="n">entity</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="vi">@reverse</span><span class="p">)</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="ss">:_add</span><span class="p">,</span> <span class="vi">@this</span><span class="p">)</span>
|
|
93
|
+
<span class="k">else</span>
|
|
94
|
+
<span class="n">entity</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s2">"_</span><span class="si">#{</span><span class="vi">@reverse</span><span class="si">}</span><span class="s2">="</span><span class="p">,</span> <span class="vi">@this</span><span class="p">)</span>
|
|
95
|
+
<span class="k">end</span>
|
|
96
|
+
<span class="k">end</span>
|
|
97
|
+
|
|
98
|
+
<span class="k">def</span> <span class="nf">_fetch</span><span class="p">(</span><span class="n">clazz</span><span class="p">,</span> <span class="n">key</span><span class="p">)</span>
|
|
99
|
+
<span class="n">keys</span> <span class="o">=</span> <span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">lrange</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
|
|
100
|
+
<span class="n">values</span> <span class="o">=</span> <span class="n">keys</span><span class="o">.</span><span class="n">empty?</span> <span class="p">?</span> <span class="o">[]</span> <span class="p">:</span> <span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span>
|
|
101
|
+
<span class="n">keys</span><span class="o">.</span><span class="n">zip</span><span class="p">(</span><span class="n">values</span><span class="p">)</span><span class="o">.</span><span class="n">map</span> <span class="k">do</span> <span class="o">|</span><span class="n">key</span><span class="p">,</span> <span class="n">json</span><span class="o">|</span>
|
|
102
|
+
<span class="n">clazz</span><span class="o">.</span><span class="n">restore</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">json</span><span class="p">)</span> <span class="k">if</span> <span class="n">json</span>
|
|
103
|
+
<span class="k">end</span><span class="o">.</span><span class="n">compact</span>
|
|
104
|
+
<span class="k">end</span>
|
|
105
|
+
<span class="k">end</span>
|
|
106
|
+
</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-14">#</a> </div> <h3>Entity</h3> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-15">#</a> </div> <p>The superclass of all persistent remodel entities.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">class</span> <span class="nc">Entity</span>
|
|
107
|
+
<span class="kp">attr_accessor</span> <span class="ss">:key</span>
|
|
108
|
+
|
|
109
|
+
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">attributes</span> <span class="o">=</span> <span class="p">{},</span> <span class="n">key</span> <span class="o">=</span> <span class="kp">nil</span><span class="p">)</span>
|
|
110
|
+
<span class="vi">@attributes</span> <span class="o">=</span> <span class="p">{}</span>
|
|
111
|
+
<span class="vi">@key</span> <span class="o">=</span> <span class="n">key</span>
|
|
112
|
+
<span class="n">attributes</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="nb">name</span><span class="p">,</span> <span class="n">value</span><span class="o">|</span>
|
|
113
|
+
<span class="nb">send</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="k">if</span> <span class="nb">respond_to?</span> <span class="s2">"</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span>
|
|
114
|
+
<span class="k">end</span>
|
|
115
|
+
<span class="k">end</span>
|
|
116
|
+
|
|
117
|
+
<span class="k">def</span> <span class="nf">save</span>
|
|
118
|
+
<span class="vi">@key</span> <span class="o">=</span> <span class="nb">self</span><span class="o">.</span><span class="n">class</span><span class="o">.</span><span class="n">next_key</span> <span class="k">unless</span> <span class="vi">@key</span>
|
|
119
|
+
<span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="vi">@key</span><span class="p">,</span> <span class="n">to_json</span><span class="p">)</span>
|
|
120
|
+
<span class="nb">self</span>
|
|
121
|
+
<span class="k">end</span>
|
|
122
|
+
|
|
123
|
+
<span class="k">def</span> <span class="nf">reload</span>
|
|
124
|
+
<span class="k">raise</span> <span class="no">EntityNotSaved</span> <span class="k">unless</span> <span class="vi">@key</span>
|
|
125
|
+
<span class="kp">initialize</span><span class="p">(</span><span class="nb">self</span><span class="o">.</span><span class="n">class</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="nb">self</span><span class="o">.</span><span class="n">class</span><span class="o">.</span><span class="n">fetch</span><span class="p">(</span><span class="vi">@key</span><span class="p">)),</span> <span class="vi">@key</span><span class="p">)</span>
|
|
126
|
+
<span class="nb">instance_variables</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">var</span><span class="o">|</span>
|
|
127
|
+
<span class="n">remove_instance_variable</span><span class="p">(</span><span class="n">var</span><span class="p">)</span> <span class="k">if</span> <span class="n">var</span> <span class="o">=~</span> <span class="sr">/^@association_/</span>
|
|
128
|
+
<span class="k">end</span>
|
|
129
|
+
<span class="nb">self</span>
|
|
130
|
+
<span class="k">end</span>
|
|
131
|
+
|
|
132
|
+
<span class="k">def</span> <span class="nf">to_json</span>
|
|
133
|
+
<span class="no">JSON</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="nb">self</span><span class="o">.</span><span class="n">class</span><span class="o">.</span><span class="n">pack</span><span class="p">(</span><span class="vi">@attributes</span><span class="p">))</span>
|
|
134
|
+
<span class="k">end</span>
|
|
135
|
+
|
|
136
|
+
<span class="k">def</span> <span class="nf">inspect</span>
|
|
137
|
+
<span class="n">properties</span> <span class="o">=</span> <span class="vi">@attributes</span><span class="o">.</span><span class="n">map</span> <span class="p">{</span> <span class="o">|</span><span class="nb">name</span><span class="p">,</span> <span class="n">value</span><span class="o">|</span> <span class="s2">"</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">: </span><span class="si">#{</span><span class="n">value</span><span class="o">.</span><span class="n">inspect</span><span class="si">}</span><span class="s2">"</span> <span class="p">}</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">', '</span><span class="p">)</span>
|
|
138
|
+
<span class="s2">"</span><span class="se">\#</span><span class="s2"><</span><span class="si">#{</span><span class="nb">self</span><span class="o">.</span><span class="n">class</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">(</span><span class="si">#{</span><span class="n">key</span><span class="si">}</span><span class="s2">) </span><span class="si">#{</span><span class="n">properties</span><span class="si">}</span><span class="s2">>"</span>
|
|
139
|
+
<span class="k">end</span>
|
|
140
|
+
|
|
141
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">create</span><span class="p">(</span><span class="n">attributes</span> <span class="o">=</span> <span class="p">{})</span>
|
|
142
|
+
<span class="kp">new</span><span class="p">(</span><span class="n">attributes</span><span class="p">)</span><span class="o">.</span><span class="n">save</span>
|
|
143
|
+
<span class="k">end</span>
|
|
144
|
+
|
|
145
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">find</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
|
146
|
+
<span class="n">restore</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">fetch</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
|
|
147
|
+
<span class="k">end</span>
|
|
148
|
+
|
|
149
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">restore</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">json</span><span class="p">)</span>
|
|
150
|
+
<span class="kp">new</span><span class="p">(</span><span class="n">parse</span><span class="p">(</span><span class="n">json</span><span class="p">),</span> <span class="n">key</span><span class="p">)</span>
|
|
151
|
+
<span class="k">end</span>
|
|
152
|
+
</pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-16">#</a> </div> <h3>DSL for subclasses</h3> </td> <td class="code"> <div class="highlight"><pre> <span class="kp">protected</span>
|
|
153
|
+
|
|
154
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">set_key_prefix</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span>
|
|
155
|
+
<span class="k">raise</span><span class="p">(</span><span class="no">InvalidKeyPrefix</span><span class="p">,</span> <span class="n">prefix</span><span class="p">)</span> <span class="k">unless</span> <span class="n">prefix</span> <span class="o">=~</span> <span class="sr">/^[a-z]+$/</span>
|
|
156
|
+
<span class="vi">@key_prefix</span> <span class="o">=</span> <span class="n">prefix</span>
|
|
157
|
+
<span class="k">end</span>
|
|
158
|
+
|
|
159
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">property</span><span class="p">(</span><span class="nb">name</span><span class="p">,</span> <span class="n">options</span> <span class="o">=</span> <span class="p">{})</span>
|
|
160
|
+
<span class="nb">name</span> <span class="o">=</span> <span class="nb">name</span><span class="o">.</span><span class="n">to_sym</span>
|
|
161
|
+
<span class="n">mapper</span><span class="o">[</span><span class="nb">name</span><span class="o">]</span> <span class="o">=</span> <span class="no">Remodel</span><span class="o">.</span><span class="n">mapper_for</span><span class="p">(</span><span class="n">options</span><span class="o">[</span><span class="ss">:class</span><span class="o">]</span><span class="p">)</span>
|
|
162
|
+
<span class="n">define_method</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span> <span class="p">{</span> <span class="vi">@attributes</span><span class="o">[</span><span class="nb">name</span><span class="o">]</span> <span class="p">}</span>
|
|
163
|
+
<span class="n">define_method</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span><span class="p">)</span> <span class="p">{</span> <span class="o">|</span><span class="n">value</span><span class="o">|</span> <span class="vi">@attributes</span><span class="o">[</span><span class="nb">name</span><span class="o">]</span> <span class="o">=</span> <span class="n">value</span> <span class="p">}</span>
|
|
164
|
+
<span class="k">end</span>
|
|
165
|
+
|
|
166
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">has_many</span><span class="p">(</span><span class="nb">name</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
|
|
167
|
+
<span class="n">var</span> <span class="o">=</span> <span class="s2">"@association_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">"</span><span class="o">.</span><span class="n">to_sym</span>
|
|
168
|
+
|
|
169
|
+
<span class="n">define_method</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span> <span class="k">do</span>
|
|
170
|
+
<span class="k">if</span> <span class="n">instance_variable_defined?</span> <span class="n">var</span>
|
|
171
|
+
<span class="nb">instance_variable_get</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
|
|
172
|
+
<span class="k">else</span>
|
|
173
|
+
<span class="n">clazz</span> <span class="o">=</span> <span class="no">Class</span><span class="o">[</span><span class="n">options</span><span class="o">[</span><span class="ss">:class</span><span class="o">]]</span>
|
|
174
|
+
<span class="nb">instance_variable_set</span><span class="p">(</span><span class="n">var</span><span class="p">,</span> <span class="no">HasMany</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">self</span><span class="p">,</span> <span class="n">clazz</span><span class="p">,</span> <span class="s2">"</span><span class="si">#{</span><span class="n">key</span><span class="si">}</span><span class="s2">:</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">options</span><span class="o">[</span><span class="ss">:reverse</span><span class="o">]</span><span class="p">))</span>
|
|
175
|
+
<span class="k">end</span>
|
|
176
|
+
<span class="k">end</span>
|
|
177
|
+
<span class="k">end</span>
|
|
178
|
+
|
|
179
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">has_one</span><span class="p">(</span><span class="nb">name</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
|
|
180
|
+
<span class="n">var</span> <span class="o">=</span> <span class="s2">"@association_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">"</span><span class="o">.</span><span class="n">to_sym</span>
|
|
181
|
+
|
|
182
|
+
<span class="n">define_method</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span> <span class="k">do</span>
|
|
183
|
+
<span class="k">if</span> <span class="n">instance_variable_defined?</span> <span class="n">var</span>
|
|
184
|
+
<span class="nb">instance_variable_get</span><span class="p">(</span><span class="n">var</span><span class="p">)</span>
|
|
185
|
+
<span class="k">else</span>
|
|
186
|
+
<span class="n">clazz</span> <span class="o">=</span> <span class="no">Class</span><span class="o">[</span><span class="n">options</span><span class="o">[</span><span class="ss">:class</span><span class="o">]]</span>
|
|
187
|
+
<span class="n">value_key</span> <span class="o">=</span> <span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="n">key</span><span class="si">}</span><span class="s2">:</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
188
|
+
<span class="nb">instance_variable_set</span><span class="p">(</span><span class="n">var</span><span class="p">,</span> <span class="n">clazz</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">value_key</span><span class="p">))</span> <span class="k">if</span> <span class="n">value_key</span>
|
|
189
|
+
<span class="k">end</span>
|
|
190
|
+
<span class="k">end</span>
|
|
191
|
+
|
|
192
|
+
<span class="n">define_method</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">value</span><span class="o">|</span>
|
|
193
|
+
<span class="nb">send</span><span class="p">(</span><span class="s2">"_reverse_association_of_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="k">if</span> <span class="n">options</span><span class="o">[</span><span class="ss">:reverse</span><span class="o">]</span>
|
|
194
|
+
<span class="nb">send</span><span class="p">(</span><span class="s2">"_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
|
|
195
|
+
<span class="k">end</span>
|
|
196
|
+
|
|
197
|
+
<span class="n">define_method</span><span class="p">(</span><span class="s2">"_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">value</span><span class="o">|</span>
|
|
198
|
+
<span class="k">if</span> <span class="n">value</span>
|
|
199
|
+
<span class="nb">instance_variable_set</span><span class="p">(</span><span class="n">var</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
|
|
200
|
+
<span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="n">key</span><span class="si">}</span><span class="s2">:</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">value</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
|
|
201
|
+
<span class="k">else</span>
|
|
202
|
+
<span class="n">remove_instance_variable</span><span class="p">(</span><span class="n">var</span><span class="p">)</span> <span class="k">if</span> <span class="n">instance_variable_defined?</span> <span class="n">var</span>
|
|
203
|
+
<span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">del</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="n">key</span><span class="si">}</span><span class="s2">:</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
204
|
+
<span class="k">end</span>
|
|
205
|
+
<span class="k">end</span><span class="p">;</span> <span class="kp">private</span> <span class="s2">"_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span>
|
|
206
|
+
|
|
207
|
+
<span class="k">if</span> <span class="n">options</span><span class="o">[</span><span class="ss">:reverse</span><span class="o">]</span>
|
|
208
|
+
<span class="n">define_method</span><span class="p">(</span><span class="s2">"_reverse_association_of_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">value</span><span class="o">|</span>
|
|
209
|
+
<span class="k">if</span> <span class="n">value</span>
|
|
210
|
+
<span class="n">association</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="n">options</span><span class="o">[</span><span class="ss">:reverse</span><span class="o">]</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
211
|
+
<span class="k">if</span> <span class="n">association</span><span class="o">.</span><span class="n">is_a?</span> <span class="no">HasMany</span>
|
|
212
|
+
<span class="n">association</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s2">"_add"</span><span class="p">,</span> <span class="nb">self</span><span class="p">)</span>
|
|
213
|
+
<span class="k">else</span>
|
|
214
|
+
<span class="n">value</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s2">"_</span><span class="si">#{</span><span class="n">options</span><span class="o">[</span><span class="ss">:reverse</span><span class="o">]</span><span class="si">}</span><span class="s2">="</span><span class="p">,</span> <span class="nb">self</span><span class="p">)</span>
|
|
215
|
+
<span class="k">end</span>
|
|
216
|
+
<span class="k">else</span>
|
|
217
|
+
<span class="k">if</span> <span class="n">old_value</span> <span class="o">=</span> <span class="nb">send</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
|
|
218
|
+
<span class="n">association</span> <span class="o">=</span> <span class="n">old_value</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="n">options</span><span class="o">[</span><span class="ss">:reverse</span><span class="o">]</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
219
|
+
<span class="k">if</span> <span class="n">association</span><span class="o">.</span><span class="n">is_a?</span> <span class="no">HasMany</span>
|
|
220
|
+
<span class="n">association</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s2">"_remove"</span><span class="p">,</span> <span class="nb">self</span><span class="p">)</span>
|
|
221
|
+
<span class="k">else</span>
|
|
222
|
+
<span class="n">old_value</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s2">"_</span><span class="si">#{</span><span class="n">options</span><span class="o">[</span><span class="ss">:reverse</span><span class="o">]</span><span class="si">}</span><span class="s2">="</span><span class="p">,</span> <span class="kp">nil</span><span class="p">)</span>
|
|
223
|
+
<span class="k">end</span>
|
|
224
|
+
<span class="k">end</span>
|
|
225
|
+
<span class="k">end</span>
|
|
226
|
+
<span class="k">end</span><span class="p">;</span> <span class="kp">private</span> <span class="s2">"_reverse_association_of_</span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2">="</span>
|
|
227
|
+
<span class="k">end</span>
|
|
228
|
+
<span class="k">end</span>
|
|
229
|
+
</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-17">#</a> </div> <h3>Helper methods</h3> </td> <td class="code"> <div class="highlight"><pre> <span class="kp">private</span>
|
|
230
|
+
|
|
231
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">fetch</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
|
232
|
+
<span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="o">||</span> <span class="k">raise</span><span class="p">(</span><span class="no">EntityNotFound</span><span class="p">,</span> <span class="s2">"no </span><span class="si">#{</span><span class="nb">name</span><span class="si">}</span><span class="s2"> with key </span><span class="si">#{</span><span class="n">key</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
233
|
+
<span class="k">end</span>
|
|
234
|
+
</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-18">#</a> </div> <p>Each entity has its own counter to generate a sequence of keys.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">next_key</span>
|
|
235
|
+
<span class="n">counter</span> <span class="o">=</span> <span class="no">Remodel</span><span class="o">.</span><span class="n">redis</span><span class="o">.</span><span class="n">incr</span><span class="p">(</span><span class="s2">"</span><span class="si">#{</span><span class="n">key_prefix</span><span class="si">}</span><span class="s2">:seq"</span><span class="p">)</span>
|
|
236
|
+
<span class="s2">"</span><span class="si">#{</span><span class="n">key_prefix</span><span class="si">}</span><span class="s2">:</span><span class="si">#{</span><span class="n">counter</span><span class="si">}</span><span class="s2">"</span>
|
|
237
|
+
<span class="k">end</span>
|
|
238
|
+
</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-19">#</a> </div> <p>Default key prefix is the first letter of the class name, in lowercase.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">key_prefix</span>
|
|
239
|
+
<span class="vi">@key_prefix</span> <span class="o">||=</span> <span class="nb">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'::'</span><span class="p">)</span><span class="o">.</span><span class="n">last</span><span class="o">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="o">].</span><span class="n">downcase</span>
|
|
240
|
+
<span class="k">end</span>
|
|
241
|
+
|
|
242
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">parse</span><span class="p">(</span><span class="n">json</span><span class="p">)</span>
|
|
243
|
+
<span class="n">unpack</span><span class="p">(</span><span class="no">JSON</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">json</span><span class="p">))</span>
|
|
244
|
+
<span class="k">end</span>
|
|
245
|
+
|
|
246
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">pack</span><span class="p">(</span><span class="n">attributes</span><span class="p">)</span>
|
|
247
|
+
<span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
|
|
248
|
+
<span class="n">attributes</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="nb">name</span><span class="p">,</span> <span class="n">value</span><span class="o">|</span>
|
|
249
|
+
<span class="n">result</span><span class="o">[</span><span class="nb">name</span><span class="o">]</span> <span class="o">=</span> <span class="n">mapper</span><span class="o">[</span><span class="nb">name</span><span class="o">].</span><span class="n">pack</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
250
|
+
<span class="k">end</span>
|
|
251
|
+
<span class="n">result</span>
|
|
252
|
+
<span class="k">end</span>
|
|
253
|
+
|
|
254
|
+
<span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">unpack</span><span class="p">(</span><span class="n">attributes</span><span class="p">)</span>
|
|
255
|
+
<span class="n">result</span> <span class="o">=</span> <span class="p">{}</span>
|
|
256
|
+
<span class="n">attributes</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="nb">name</span><span class="p">,</span> <span class="n">value</span><span class="o">|</span>
|
|
257
|
+
<span class="nb">name</span> <span class="o">=</span> <span class="nb">name</span><span class="o">.</span><span class="n">to_sym</span>
|
|
258
|
+
<span class="n">result</span><span class="o">[</span><span class="nb">name</span><span class="o">]</span> <span class="o">=</span> <span class="n">mapper</span><span class="o">[</span><span class="nb">name</span><span class="o">].</span><span class="n">unpack</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
259
|
+
<span class="k">end</span>
|
|
260
|
+
<span class="n">result</span>
|
|
261
|
+
<span class="k">end</span>
|
|
262
|
+
</pre></div> </td> </tr> <tr id="section-20"> <td class="docs"> <div class="octowrap"> <a class="octothorpe" href="#section-20">#</a> </div> <p>Lazy init</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">mapper</span>
|
|
263
|
+
<span class="vi">@mapper</span> <span class="o">||=</span> <span class="p">{}</span>
|
|
264
|
+
<span class="k">end</span>
|
|
265
|
+
<span class="k">end</span>
|
|
266
|
+
|
|
267
|
+
<span class="k">end</span>
|
|
268
|
+
|
|
269
|
+
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
|