dm-is-published 0.0.6 → 1.2.0
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.
- data/Gemfile +22 -0
- data/Guardfile +13 -0
- data/{LICENSE → LICENSE.txt} +1 -1
- data/README.rdoc +37 -5
- data/Rakefile +30 -56
- data/VERSION +1 -1
- data/dm-is-published.gemspec +93 -45
- data/docs/apple-touch-icon.png +0 -0
- data/docs/classes/DataMapper.html +81 -0
- data/docs/classes/DataMapper/Is.html +81 -0
- data/docs/classes/DataMapper/Is/Published.html +364 -0
- data/docs/classes/DataMapper/Is/Published/ClassMethods.html +237 -0
- data/docs/classes/DataMapper/Is/Published/InstanceMethods.html +132 -0
- data/docs/classes/DataMapper/Is/Published/ResourceInstanceMethods.html +133 -0
- data/docs/created.rid +4 -0
- data/docs/css/github.css +129 -0
- data/docs/css/main.css +333 -0
- data/docs/css/panel.css +384 -0
- data/docs/css/reset.css +48 -0
- data/docs/favicon.ico +0 -0
- data/docs/files/README_rdoc.html +226 -0
- data/docs/files/lib/dm-is-published_rb.html +84 -0
- data/docs/files/lib/is/published_rb.html +104 -0
- data/docs/i/arrows.png +0 -0
- data/docs/i/results_bg.png +0 -0
- data/docs/i/tree_bg.png +0 -0
- data/docs/index.html +13 -0
- data/docs/js/highlight.pack.js +1 -0
- data/docs/js/jquery-1.3.2.min.js +19 -0
- data/docs/js/jquery-effect.js +593 -0
- data/docs/js/main.js +24 -0
- data/docs/js/navigation.js +142 -0
- data/docs/js/search_index.js +1 -0
- data/docs/js/searchdoc.js +449 -0
- data/docs/js/searcher.js +228 -0
- data/docs/panel/index.html +73 -0
- data/docs/panel/links.html +12 -0
- data/docs/panel/tree.js +1 -0
- data/lib/dm-is-published.rb +3 -7
- data/lib/{dm-is-published/is → is}/published.rb +26 -10
- data/spec/{integration/published_spec.rb → dm-is-published_spec.rb} +48 -11
- data/spec/spec_helper.rb +12 -9
- metadata +264 -95
- data/.gitignore +0 -33
- data/History.rdoc +0 -4
- data/TODO +0 -0
- data/lib/dm-is-published/is/version.rb +0 -7
data/docs/css/panel.css
ADDED
@@ -0,0 +1,384 @@
|
|
1
|
+
/* Panel (begin) */
|
2
|
+
.panel
|
3
|
+
{
|
4
|
+
position: absolute;
|
5
|
+
width: 100%;
|
6
|
+
height: 100%;
|
7
|
+
top: 0;
|
8
|
+
left: 0;
|
9
|
+
background: #FFF;
|
10
|
+
z-index: 2;
|
11
|
+
font-family: "Helvetica Neue", "Arial", sans-serif;
|
12
|
+
//zoom: 1;
|
13
|
+
}
|
14
|
+
|
15
|
+
.panel_tree .results,
|
16
|
+
.panel_results .tree
|
17
|
+
{
|
18
|
+
display: none;
|
19
|
+
}
|
20
|
+
|
21
|
+
/* Header with search box (begin) */
|
22
|
+
.panel .header
|
23
|
+
{
|
24
|
+
width: 100%;
|
25
|
+
height: 29px;
|
26
|
+
border-bottom: 1px solid #666;
|
27
|
+
position: relative;
|
28
|
+
left: 0; top: 0;
|
29
|
+
background: #e8e8e8;
|
30
|
+
}
|
31
|
+
|
32
|
+
.panel .header div
|
33
|
+
{
|
34
|
+
margin: 0 7px;
|
35
|
+
}
|
36
|
+
.panel .header table
|
37
|
+
{
|
38
|
+
height: 29px;
|
39
|
+
width: 100%;
|
40
|
+
}
|
41
|
+
|
42
|
+
.panel .header table td
|
43
|
+
{
|
44
|
+
vertical-align: middle;
|
45
|
+
text-align: middle;
|
46
|
+
}
|
47
|
+
|
48
|
+
.panel .header label
|
49
|
+
{
|
50
|
+
position: absolute;
|
51
|
+
font-size: 12px;
|
52
|
+
line-height: 29px;
|
53
|
+
margin-left: 3px;
|
54
|
+
color: #999;
|
55
|
+
cursor: text;
|
56
|
+
}
|
57
|
+
|
58
|
+
.panel .header table input
|
59
|
+
{
|
60
|
+
width: 100%;
|
61
|
+
box-sizing: border-box;
|
62
|
+
-moz-box-sizing: border-box;
|
63
|
+
-webkit-box-sizing: border-box;
|
64
|
+
display: inline-block;
|
65
|
+
-webkit-appearance: searchfield;
|
66
|
+
height: 22px;
|
67
|
+
//height: auto;
|
68
|
+
}
|
69
|
+
|
70
|
+
/* Header with search box (end) */
|
71
|
+
|
72
|
+
|
73
|
+
/* Results (begin) */
|
74
|
+
.panel .result
|
75
|
+
{
|
76
|
+
position: absolute;
|
77
|
+
top: 30px;
|
78
|
+
bottom: 0;
|
79
|
+
left: 0;
|
80
|
+
width: 100%;
|
81
|
+
//height: expression((this.parentNode.offsetHeight - 31));
|
82
|
+
overflow-y: scroll;
|
83
|
+
overflow-x: hidden;
|
84
|
+
-overflow-y: hidden;
|
85
|
+
background: #EDF3FE url(../i/results_bg.png);
|
86
|
+
z-index: 2;
|
87
|
+
//zoom:1;
|
88
|
+
}
|
89
|
+
|
90
|
+
.panel .result ul
|
91
|
+
{
|
92
|
+
font-size: 0.8em;
|
93
|
+
width: 100%;
|
94
|
+
background: #EDF3FE url(../i/results_bg.png);
|
95
|
+
//zoom:1;
|
96
|
+
}
|
97
|
+
|
98
|
+
.panel .result ul li
|
99
|
+
{
|
100
|
+
height: 46px;
|
101
|
+
-height: 50px;
|
102
|
+
//display: inline;
|
103
|
+
//width: 100%;
|
104
|
+
//zoom: 1;
|
105
|
+
overflow: hidden;
|
106
|
+
padding: 4px 10px 0 10px;
|
107
|
+
cursor: pointer;
|
108
|
+
}
|
109
|
+
|
110
|
+
.panel .result ul li h1
|
111
|
+
{
|
112
|
+
font-size: 13px;
|
113
|
+
font-weight: normal;
|
114
|
+
color: #333;
|
115
|
+
margin-bottom: 2px;
|
116
|
+
white-space: nowrap;
|
117
|
+
}
|
118
|
+
|
119
|
+
.panel .result ul li p
|
120
|
+
{
|
121
|
+
font-size: 11px;
|
122
|
+
color: #333;
|
123
|
+
margin-bottom: 2px;
|
124
|
+
white-space: nowrap;
|
125
|
+
}
|
126
|
+
|
127
|
+
.panel .result ul li h1 i,
|
128
|
+
.panel .result ul li p.snippet
|
129
|
+
{
|
130
|
+
color: #999;
|
131
|
+
}
|
132
|
+
|
133
|
+
.panel .result ul li b
|
134
|
+
{
|
135
|
+
color: #000;
|
136
|
+
}
|
137
|
+
|
138
|
+
.panel .result ul li.current
|
139
|
+
{
|
140
|
+
background: #3875D7;
|
141
|
+
}
|
142
|
+
|
143
|
+
.panel .result ul li.current h1,
|
144
|
+
.panel .result ul li.current p
|
145
|
+
{
|
146
|
+
color: #DDD;
|
147
|
+
}
|
148
|
+
|
149
|
+
.panel .result ul li.current h1 i,
|
150
|
+
.panel .result ul li.current p.snippet
|
151
|
+
{
|
152
|
+
color: #AAA;
|
153
|
+
}
|
154
|
+
|
155
|
+
.panel .result ul li.current b
|
156
|
+
{
|
157
|
+
color: #FFF;
|
158
|
+
}
|
159
|
+
|
160
|
+
|
161
|
+
.panel .result ul li:hover,
|
162
|
+
.panel .result ul li.selected
|
163
|
+
{
|
164
|
+
background: #d0d0d0;
|
165
|
+
}
|
166
|
+
|
167
|
+
.panel .result ul li.current:hover
|
168
|
+
{
|
169
|
+
background: #2965C0;
|
170
|
+
}
|
171
|
+
|
172
|
+
.panel .result ul li .badge
|
173
|
+
{
|
174
|
+
margin-right: 0.4em;
|
175
|
+
margin-left: -0.2em;
|
176
|
+
padding: 0 0.2em;
|
177
|
+
color: #000;
|
178
|
+
border-radius: 3px;
|
179
|
+
}
|
180
|
+
|
181
|
+
.panel .result ul li .badge_1
|
182
|
+
{
|
183
|
+
background: #ACDBF4;
|
184
|
+
}
|
185
|
+
|
186
|
+
.panel .result ul li.current .badge_1
|
187
|
+
{
|
188
|
+
background: #97BFD7;
|
189
|
+
}
|
190
|
+
|
191
|
+
.panel .result ul li .badge_2
|
192
|
+
{
|
193
|
+
background: #ACF3C3;
|
194
|
+
}
|
195
|
+
|
196
|
+
.panel .result ul li.current .badge_2
|
197
|
+
{
|
198
|
+
background: #98D7AC;
|
199
|
+
}
|
200
|
+
|
201
|
+
.panel .result ul li .badge_3
|
202
|
+
{
|
203
|
+
background: #E0F3AC;
|
204
|
+
}
|
205
|
+
|
206
|
+
.panel .result ul li.current .badge_3
|
207
|
+
{
|
208
|
+
background: #C4D798;
|
209
|
+
}
|
210
|
+
|
211
|
+
.panel .result ul li .badge_4
|
212
|
+
{
|
213
|
+
background: #D7CA98;
|
214
|
+
}
|
215
|
+
|
216
|
+
.panel .result ul li.current .badge_4
|
217
|
+
{
|
218
|
+
background: #A6B0AC;
|
219
|
+
}
|
220
|
+
|
221
|
+
.panel .result ul li .badge_5
|
222
|
+
{
|
223
|
+
background: #F3C8AC;
|
224
|
+
}
|
225
|
+
|
226
|
+
.panel .result ul li.current .badge_5
|
227
|
+
{
|
228
|
+
background: #D7B198;
|
229
|
+
}
|
230
|
+
|
231
|
+
.panel .result ul li .badge_6
|
232
|
+
{
|
233
|
+
background: #F3ACC3;
|
234
|
+
}
|
235
|
+
|
236
|
+
.panel .result ul li.current .badge_6
|
237
|
+
{
|
238
|
+
background: #D798AB;
|
239
|
+
}
|
240
|
+
|
241
|
+
/* Results (end) */
|
242
|
+
|
243
|
+
/* Tree (begin) */ /**/
|
244
|
+
.panel .tree
|
245
|
+
{
|
246
|
+
position: absolute;
|
247
|
+
top: 30px;
|
248
|
+
bottom: 0;
|
249
|
+
left: 0;
|
250
|
+
width: 100%;
|
251
|
+
//zoom: 1;
|
252
|
+
//height: expression((this.parentNode.offsetHeight - 31));
|
253
|
+
overflow-y: scroll;
|
254
|
+
overflow-x: hidden;
|
255
|
+
-overflow-y: hidden;
|
256
|
+
background: #EDF3FE url(../i/tree_bg.png);
|
257
|
+
z-index: 30;
|
258
|
+
}
|
259
|
+
|
260
|
+
.panel .tree ul
|
261
|
+
{
|
262
|
+
background: #EDF3FE url(../i/tree_bg.png);
|
263
|
+
}
|
264
|
+
|
265
|
+
.panel .tree li
|
266
|
+
{
|
267
|
+
cursor: pointer;
|
268
|
+
overflow: hidden;
|
269
|
+
//height: 23px;
|
270
|
+
//display: inline;
|
271
|
+
//zoom: 1;
|
272
|
+
//width: 100%;
|
273
|
+
}
|
274
|
+
|
275
|
+
|
276
|
+
.panel .tree li .content
|
277
|
+
{
|
278
|
+
padding-left: 18px;
|
279
|
+
padding-top: 5px;
|
280
|
+
height: 18px;
|
281
|
+
overflow: hidden;
|
282
|
+
position: relative;
|
283
|
+
}
|
284
|
+
|
285
|
+
.panel .tree li .icon
|
286
|
+
{
|
287
|
+
width: 10px;
|
288
|
+
height: 9px;
|
289
|
+
background: url(../i/arrows.png);
|
290
|
+
background-position: 0 -9px;
|
291
|
+
position: absolute;
|
292
|
+
left: 1px;
|
293
|
+
top: 8px;
|
294
|
+
cursor: default;
|
295
|
+
}
|
296
|
+
|
297
|
+
.panel .tree li.closed .icon
|
298
|
+
{
|
299
|
+
background-position: 0 0;
|
300
|
+
}
|
301
|
+
|
302
|
+
.panel .tree ul li h1
|
303
|
+
{
|
304
|
+
font-size: 13px;
|
305
|
+
font-weight: normal;
|
306
|
+
color: #000;
|
307
|
+
margin-bottom: 2px;
|
308
|
+
white-space: nowrap;
|
309
|
+
}
|
310
|
+
|
311
|
+
.panel .tree ul li p
|
312
|
+
{
|
313
|
+
font-size: 11px;
|
314
|
+
color: #666;
|
315
|
+
margin-bottom: 2px;
|
316
|
+
white-space: nowrap;
|
317
|
+
}
|
318
|
+
|
319
|
+
.panel .tree ul li h1 i
|
320
|
+
{
|
321
|
+
color: #999;
|
322
|
+
font-style: normal;
|
323
|
+
}
|
324
|
+
|
325
|
+
.panel .tree ul li.empty
|
326
|
+
{
|
327
|
+
cursor: text;
|
328
|
+
}
|
329
|
+
|
330
|
+
.panel .tree ul li.empty h1,
|
331
|
+
.panel .tree ul li.empty p
|
332
|
+
{
|
333
|
+
color: #666;
|
334
|
+
font-style: italic;
|
335
|
+
}
|
336
|
+
|
337
|
+
.panel .tree ul li.current
|
338
|
+
{
|
339
|
+
background: #3875D7;
|
340
|
+
}
|
341
|
+
|
342
|
+
.panel .tree ul li.current .icon
|
343
|
+
{
|
344
|
+
background-position: -10px -9px;
|
345
|
+
}
|
346
|
+
|
347
|
+
.panel .tree ul li.current.closed .icon
|
348
|
+
{
|
349
|
+
background-position: -10px 0;
|
350
|
+
}
|
351
|
+
|
352
|
+
.panel .tree ul li.current h1
|
353
|
+
{
|
354
|
+
color: #FFF;
|
355
|
+
}
|
356
|
+
|
357
|
+
.panel .tree ul li.current p
|
358
|
+
{
|
359
|
+
color: #CCC;
|
360
|
+
}
|
361
|
+
|
362
|
+
.panel .tree ul li.current.empty h1,
|
363
|
+
.panel .tree ul li.current.empty p
|
364
|
+
{
|
365
|
+
color: #999;
|
366
|
+
}
|
367
|
+
|
368
|
+
.panel .tree ul li:hover
|
369
|
+
{
|
370
|
+
background: #d0d0d0;
|
371
|
+
}
|
372
|
+
|
373
|
+
.panel .tree ul li.current:hover
|
374
|
+
{
|
375
|
+
background: #2965C0;
|
376
|
+
}
|
377
|
+
|
378
|
+
.panel .tree .stopper
|
379
|
+
{
|
380
|
+
display: none;
|
381
|
+
}
|
382
|
+
/* Tree (end) */ /**/
|
383
|
+
|
384
|
+
/* Panel (end) */
|
data/docs/css/reset.css
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
/* http://meyerweb.com/eric/tools/css/reset/ */
|
2
|
+
/* v1.0 | 20080212 */
|
3
|
+
|
4
|
+
html, body, div, span, applet, object, iframe,
|
5
|
+
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
|
6
|
+
a, abbr, acronym, address, big, cite, code,
|
7
|
+
del, dfn, em, font, img, ins, kbd, q, s, samp,
|
8
|
+
small, strike, strong, sub, sup, tt, var,
|
9
|
+
b, u, i, center,
|
10
|
+
dl, dt, dd, ol, ul, li,
|
11
|
+
fieldset, form, label, legend,
|
12
|
+
table, caption, tbody, tfoot, thead, tr, th, td {
|
13
|
+
margin: 0;
|
14
|
+
padding: 0;
|
15
|
+
border: 0;
|
16
|
+
outline: 0;
|
17
|
+
font-size: 100%;
|
18
|
+
vertical-align: baseline;
|
19
|
+
background: transparent;
|
20
|
+
}
|
21
|
+
body {
|
22
|
+
line-height: 1;
|
23
|
+
}
|
24
|
+
ol, ul {
|
25
|
+
list-style: none;
|
26
|
+
}
|
27
|
+
blockquote, q {
|
28
|
+
quotes: none;
|
29
|
+
}
|
30
|
+
blockquote:before, blockquote:after,
|
31
|
+
q:before, q:after {
|
32
|
+
content: '';
|
33
|
+
content: none;
|
34
|
+
}
|
35
|
+
|
36
|
+
/* remember to highlight inserts somehow! */
|
37
|
+
ins {
|
38
|
+
text-decoration: none;
|
39
|
+
}
|
40
|
+
del {
|
41
|
+
text-decoration: line-through;
|
42
|
+
}
|
43
|
+
|
44
|
+
/* tables still need 'cellspacing="0"' in the markup */
|
45
|
+
table {
|
46
|
+
border-collapse: collapse;
|
47
|
+
border-spacing: 0;
|
48
|
+
}
|
data/docs/favicon.ico
ADDED
Binary file
|
@@ -0,0 +1,226 @@
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
+
<head>
|
6
|
+
<title>README.rdoc</title>
|
7
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
8
|
+
<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
|
9
|
+
<link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
|
10
|
+
<link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" />
|
11
|
+
<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
|
12
|
+
<script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
|
13
|
+
<script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
|
14
|
+
<script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
|
15
|
+
|
16
|
+
</head>
|
17
|
+
|
18
|
+
<body>
|
19
|
+
<div class="banner">
|
20
|
+
|
21
|
+
<h1>
|
22
|
+
README.rdoc
|
23
|
+
</h1>
|
24
|
+
<ul class="files">
|
25
|
+
<li>README.rdoc</li>
|
26
|
+
<li>Last modified: 2013-03-11 01:06:17 +0800</li>
|
27
|
+
</ul>
|
28
|
+
</div>
|
29
|
+
|
30
|
+
<div id="bodyContent">
|
31
|
+
<div id="content">
|
32
|
+
|
33
|
+
<div class="description">
|
34
|
+
|
35
|
+
<h1 id="label-dm-is-published">dm-is-published</h1>
|
36
|
+
|
37
|
+
<p>This plugin makes it very easy to add different states to your models, like
|
38
|
+
‘draft’ vs ‘live’. By default it also adds validations of the field value.</p>
|
39
|
+
|
40
|
+
<p>Originally inspired by the Rails plugin <code>acts_as_publishable</code> by
|
41
|
+
<strong>fr.ivolo.us</strong>.</p>
|
42
|
+
|
43
|
+
<h2 id="label-Installation">Installation</h2>
|
44
|
+
|
45
|
+
<pre>$ gem install dm-is-published</pre>
|
46
|
+
|
47
|
+
<p>Or add the gem to your Gemfile, and then run <code>bundle install</code>.</p>
|
48
|
+
|
49
|
+
<pre>gem 'dm-is-published', 'CURRENT_VERSION_NUMBER'</pre>
|
50
|
+
|
51
|
+
<h3 id="label-Dependencies">Dependencies</h3>
|
52
|
+
|
53
|
+
<p>The plugin depends upon the following:</p>
|
54
|
+
<ul><li>
|
55
|
+
<p>dm-mysql-adapter OR dm-sqlite3-adapter ( >= 1.2.0)</p>
|
56
|
+
</li><li>
|
57
|
+
<p>data_mapper ( >= 1.2.0)</p>
|
58
|
+
</li><li>
|
59
|
+
<p>activesupport (>= 3.2.7) - method => Object#blank?</p>
|
60
|
+
</li></ul>
|
61
|
+
|
62
|
+
<h2 id="label-Getting+Started+">Getting Started </h2>
|
63
|
+
|
64
|
+
<p>First of all, for a better understanding of this gem, make sure you study
|
65
|
+
the ‘<code>dm-is-published/spec/dm-is-published_spec.rb</code>’ file.</p>
|
66
|
+
<hr style="height: 2px">
|
67
|
+
|
68
|
+
<p>Require <code>dm-is-published</code> in your app.</p>
|
69
|
+
|
70
|
+
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'data_mapper'</span> <span class="ruby-comment"># must be required first</span>
|
71
|
+
<span class="ruby-identifier">require</span> <span class="ruby-string">'dm-is-published'</span>
|
72
|
+
</pre>
|
73
|
+
|
74
|
+
<p>Lets say we have an Article class, and each Article can have a current
|
75
|
+
state, ie: whether it’s Live, Draft or an Obituary awaiting the death of
|
76
|
+
someone famous (real or rumored)</p>
|
77
|
+
|
78
|
+
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Article</span>
|
79
|
+
<span class="ruby-identifier">include</span> <span class="ruby-constant">DataMapper</span><span class="ruby-operator">::</span><span class="ruby-constant">Resource</span>
|
80
|
+
<span class="ruby-identifier">property</span> :<span class="ruby-identifier">id</span>, <span class="ruby-constant">Serial</span>
|
81
|
+
<span class="ruby-identifier">property</span> :<span class="ruby-identifier">title</span>, <span class="ruby-constant">String</span>
|
82
|
+
<span class="ruby-operator">...</span><span class="ruby-operator"><</span><span class="ruby-identifier">snip</span><span class="ruby-operator">></span>
|
83
|
+
|
84
|
+
<span class="ruby-identifier">is</span> :<span class="ruby-identifier">published</span>
|
85
|
+
|
86
|
+
<span class="ruby-keyword">end</span>
|
87
|
+
</pre>
|
88
|
+
|
89
|
+
<p>Once you have your Article model we can create our Articles just as normal</p>
|
90
|
+
|
91
|
+
<pre class="ruby"><span class="ruby-constant">Article</span>.<span class="ruby-identifier">create</span>(:<span class="ruby-identifier">title</span> =<span class="ruby-operator">></span> <span class="ruby-string">'Example 1'</span>)
|
92
|
+
</pre>
|
93
|
+
|
94
|
+
<p>The instance of <code>Article.get(1)</code> now has the following things
|
95
|
+
for free:</p>
|
96
|
+
<ul><li>
|
97
|
+
<p>a <code>:publish_status</code> attribute with the value
|
98
|
+
<code>'live'</code>. Default choices are <code>[ :live, :draft, :hidden
|
99
|
+
]</code>.</p>
|
100
|
+
</li><li>
|
101
|
+
<p><code>:is_live?, :is_draft? or :is_hidden?</code> methods that returns
|
102
|
+
true/false based upon the state.</p>
|
103
|
+
</li><li>
|
104
|
+
<p><code>:save_as_live</code>, <code>:save_as_draft</code> or
|
105
|
+
<code>:save_as_hidden</code> converts the instance to the state and saves
|
106
|
+
it.</p>
|
107
|
+
</li><li>
|
108
|
+
<p><code>:publishable?</code> method that returns true for models where
|
109
|
+
<code>is :published </code> has been declared, but <strong>false</strong>
|
110
|
+
for those where it has not been declared.</p>
|
111
|
+
</li></ul>
|
112
|
+
|
113
|
+
<p>The Article class also gets a bit of new functionality:</p>
|
114
|
+
|
115
|
+
<pre class="ruby"><span class="ruby-constant">Article</span>.<span class="ruby-identifier">all</span>(:<span class="ruby-identifier">draft</span>) =<span class="ruby-operator">></span> <span class="ruby-identifier">finds</span> <span class="ruby-identifier">all</span> <span class="ruby-constant">Articles</span> <span class="ruby-identifier">with</span> :<span class="ruby-identifier">publish_status</span> = :<span class="ruby-identifier">draft</span>
|
116
|
+
|
117
|
+
<span class="ruby-constant">Article</span>.<span class="ruby-identifier">all</span>(:<span class="ruby-identifier">draft</span>, :<span class="ruby-identifier">author</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@author_joe</span> ) =<span class="ruby-operator">></span> <span class="ruby-identifier">finds</span> <span class="ruby-identifier">all</span> <span class="ruby-constant">Articles</span> <span class="ruby-identifier">with</span> :<span class="ruby-identifier">publish_status</span> = :<span class="ruby-identifier">draft</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">author</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Joe</span>
|
118
|
+
</pre>
|
119
|
+
|
120
|
+
<p>Todo Need to write more documentation here..</p>
|
121
|
+
|
122
|
+
<h2 id="label-Usage+Scenarios">Usage Scenarios</h2>
|
123
|
+
|
124
|
+
<p>In a Blog/Publishing scenario you could use it like this:</p>
|
125
|
+
|
126
|
+
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Article</span>
|
127
|
+
<span class="ruby-operator">...</span><span class="ruby-operator"><</span><span class="ruby-identifier">snip</span><span class="ruby-operator">></span><span class="ruby-operator">...</span>
|
128
|
+
|
129
|
+
<span class="ruby-identifier">is</span> :<span class="ruby-identifier">published</span> <span class="ruby-operator">:</span><span class="ruby-identifier">live</span>, :<span class="ruby-identifier">draft</span>, :<span class="ruby-identifier">hidden</span>
|
130
|
+
|
131
|
+
<span class="ruby-keyword">end</span>
|
132
|
+
</pre>
|
133
|
+
|
134
|
+
<p>Whereas in another scenario - like in a MenuItem model for a Restaurant -
|
135
|
+
you could use it like this:</p>
|
136
|
+
|
137
|
+
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">MenuItem</span>
|
138
|
+
<span class="ruby-operator">...</span><span class="ruby-operator"><</span><span class="ruby-identifier">snip</span><span class="ruby-operator">></span><span class="ruby-operator">...</span>
|
139
|
+
|
140
|
+
<span class="ruby-identifier">is</span> :<span class="ruby-identifier">published</span> <span class="ruby-operator">:</span><span class="ruby-identifier">on</span>, :<span class="ruby-identifier">off</span> <span class="ruby-comment"># the item is either on the menu or not</span>
|
141
|
+
|
142
|
+
<span class="ruby-keyword">end</span>
|
143
|
+
</pre>
|
144
|
+
|
145
|
+
<h2 id="label-RTFM+">RTFM </h2>
|
146
|
+
|
147
|
+
<p>For a better understanding of this gem/plugin, make sure you study the
|
148
|
+
‘<code>dm-is-select/spec/dm-is-select_spec.rb</code>’ file.</p>
|
149
|
+
|
150
|
+
<h2 id="label-Errors+%2F+Bugs">Errors / Bugs</h2>
|
151
|
+
|
152
|
+
<p>If something is not behaving intuitively, it is a bug, and should be
|
153
|
+
reported. Report it here: <a
|
154
|
+
href="http://github.com/kematzy/dm-is-published/issues">github.com/kematzy/dm-is-published/issues</a></p>
|
155
|
+
|
156
|
+
<h2 id="label-Contributing+to+dm-is-published">Contributing to dm-is-published</h2>
|
157
|
+
<ul><li>
|
158
|
+
<p>Check out the latest master to make sure the feature hasn’t been
|
159
|
+
implemented or the bug hasn’t been fixed yet.</p>
|
160
|
+
</li><li>
|
161
|
+
<p>Check out the issue tracker to make sure someone already hasn’t requested
|
162
|
+
it and/or contributed it.</p>
|
163
|
+
</li><li>
|
164
|
+
<p>Fork the project.</p>
|
165
|
+
</li><li>
|
166
|
+
<p>Start a feature/bugfix branch.</p>
|
167
|
+
</li><li>
|
168
|
+
<p>Commit and push until you are happy with your contribution.</p>
|
169
|
+
</li><li>
|
170
|
+
<p>Make sure to add tests for it. This is important so I don’t break it in a
|
171
|
+
future version unintentionally.</p>
|
172
|
+
</li><li>
|
173
|
+
<p>Please try not to mess with the Rakefile, version, or history. If you want
|
174
|
+
to have your own version, or is otherwise necessary, that is fine, but
|
175
|
+
please isolate to its own commit so I can cherry-pick around it.</p>
|
176
|
+
</li></ul>
|
177
|
+
|
178
|
+
<h2 id="label-Copyright">Copyright</h2>
|
179
|
+
|
180
|
+
<p>Copyright © 2009 - 2013 Kematzy.</p>
|
181
|
+
|
182
|
+
<p>Loosely based on the ActsAsPublishable plugin by [<a
|
183
|
+
href="http://fr.ivolo.us/posts/acts-as-publishable">fr.ivolo.us/posts/acts-as-publishable</a>]</p>
|
184
|
+
|
185
|
+
<h2 id="label-Licence">Licence</h2>
|
186
|
+
|
187
|
+
<p>Released under the MIT license.</p>
|
188
|
+
|
189
|
+
</div>
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
<!-- Methods -->
|
222
|
+
</div>
|
223
|
+
|
224
|
+
</div>
|
225
|
+
</body>
|
226
|
+
</html>
|