1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
== Add an `acts_as_yaffle` method to ActiveRecord ==
A common pattern in plugins is to add a method called `acts_as_something` to models. In this case, you want to write a method called `acts_as_yaffle` that adds a `squawk` method to your models.
To keep things clean, create a new test file called 'acts_as_yaffle_test.rb' in your plugin's test directory and require your test helper.
[source, ruby]
------------------------------------------------------
# File: vendor/plugins/yaffle/test/acts_as_yaffle_test.rb
require File.dirname(__FILE__) + '/test_helper.rb'
class Hickwall < ActiveRecord::Base
acts_as_yaffle
end
class ActsAsYaffleTest < Test::Unit::TestCase
end
------------------------------------------------------
[source, ruby]
------------------------------------------------------
# File: vendor/plugins/lib/acts_as_yaffle.rb
module Yaffle
end
------------------------------------------------------
One of the most common plugin patterns for `acts_as_yaffle` plugins is to structure your file like so:
[source, ruby]
------------------------------------------------------
module Yaffle
def self.included(base)
base.send :extend, ClassMethods
end
module ClassMethods
# any method placed here will apply to classes, like Hickwall
def acts_as_something
send :include, InstanceMethods
end
end
module InstanceMethods
# any method placed here will apply to instaces, like @hickwall
end
end
------------------------------------------------------
With structure you can easily separate the methods that will be used for the class (like `Hickwall.some_method`) and the instance (like `@hickwell.some_method`).
Let's add class method named `acts_as_yaffle` - testing it out first. You already defined the ActiveRecord models in your test helper, so if you run tests now they will fail.
Back in your `acts_as_yaffle` file, update ClassMethods like so:
[source, ruby]
------------------------------------------------------
module ClassMethods
def acts_as_yaffle(options = {})
send :include, InstanceMethods
end
end
------------------------------------------------------
Now that test should pass. Since your plugin is going to work with field names, you need to allow people to define the field names, in case there is a naming conflict. You can write a few simple tests for this:
[source, ruby]
------------------------------------------------------
# File: vendor/plugins/yaffle/test/acts_as_yaffle_test.rb
require File.dirname(__FILE__) + '/test_helper.rb'
class ActsAsYaffleTest < Test::Unit::TestCase
def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
assert_equal "last_squawk", Hickwall.yaffle_text_field
end
def test_a_hickwalls_yaffle_date_field_should_be_last_squawked_at
assert_equal "last_squawked_at", Hickwall.yaffle_date_field
end
def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
assert_equal "last_tweet", Wickwall.yaffle_text_field
end
def test_a_wickwalls_yaffle_date_field_should_be_last_tweeted_at
assert_equal "last_tweeted_at", Wickwall.yaffle_date_field
end
end
------------------------------------------------------
To make these tests pass, you could modify your `acts_as_yaffle` file like so:
[source, ruby]
------------------------------------------------------
# File: vendor/plugins/yaffle/lib/acts_as_yaffle.rb
module Yaffle
def self.included(base)
base.send :extend, ClassMethods
end
module ClassMethods
def acts_as_yaffle(options = {})
cattr_accessor :yaffle_text_field, :yaffle_date_field
self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
self.yaffle_date_field = (options[:yaffle_date_field] || :last_squawked_at).to_s
send :include, InstanceMethods
end
end
module InstanceMethods
end
end
------------------------------------------------------
Now you can add tests for the instance methods, and the instance method itself:
[source, ruby]
------------------------------------------------------
# File: vendor/plugins/yaffle/test/acts_as_yaffle_test.rb
require File.dirname(__FILE__) + '/test_helper.rb'
class ActsAsYaffleTest < Test::Unit::TestCase
def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
assert_equal "last_squawk", Hickwall.yaffle_text_field
end
def test_a_hickwalls_yaffle_date_field_should_be_last_squawked_at
assert_equal "last_squawked_at", Hickwall.yaffle_date_field
end
def test_a_wickwalls_yaffle_text_field_should_be_last_squawk
assert_equal "last_tweet", Wickwall.yaffle_text_field
end
def test_a_wickwalls_yaffle_date_field_should_be_last_squawked_at
assert_equal "last_tweeted_at", Wickwall.yaffle_date_field
end
def test_hickwalls_squawk_should_populate_last_squawk
hickwall = Hickwall.new
hickwall.squawk("Hello World")
assert_equal "squawk! Hello World", hickwall.last_squawk
end
def test_hickwalls_squawk_should_populate_last_squawked_at
hickwall = Hickwall.new
hickwall.squawk("Hello World")
assert_equal Date.today, hickwall.last_squawked_at
end
def test_wickwalls_squawk_should_populate_last_tweet
wickwall = Wickwall.new
wickwall.squawk("Hello World")
assert_equal "squawk! Hello World", wickwall.last_tweet
end
def test_wickwalls_squawk_should_populate_last_tweeted_at
wickwall = Wickwall.new
wickwall.squawk("Hello World")
assert_equal Date.today, wickwall.last_tweeted_at
end
end
------------------------------------------------------
[source, ruby]
------------------------------------------------------
# File: vendor/plugins/yaffle/lib/acts_as_yaffle.rb
module Yaffle
def self.included(base)
base.send :extend, ClassMethods
end
module ClassMethods
def acts_as_yaffle(options = {})
cattr_accessor :yaffle_text_field, :yaffle_date_field
self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
self.yaffle_date_field = (options[:yaffle_date_field] || :last_squawked_at).to_s
send :include, InstanceMethods
end
end
module InstanceMethods
def squawk(string)
write_attribute(self.class.yaffle_text_field, string.to_squawk)
write_attribute(self.class.yaffle_date_field, Date.today)
end
end
end
------------------------------------------------------
Note the use of `write_attribute` to write to the field in model.
|
