simple_memoizer 0.0.1 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +36 -1
  3. data/lib/simple_memoizer.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 5b7c380dc223236e621e2d7b27eb68095025c5fc
4
- data.tar.gz: b622b2dc81e6804a6b4f271bf57095ae7e82c2ac
3
+ metadata.gz: a32f127eaf2d6a20e972da6cbcb89911eeb5eb4c
4
+ data.tar.gz: 4677b553f99863b747853e7f5144022183e0a3a9
5
5
  SHA512:
6
- metadata.gz: 17a9ace0feccb10d1366fd228105d954e13170ba55b2486c9d5a22e96e45619019989f7be60ebf75de841457cf4f51b14ed26b09df93607b4f71dec4a4a36381
7
- data.tar.gz: 212c2309d4e4e3fb8f029b80acc3bccef1761f0127b96f22e96cf6070ed10de97ed1ceb19b6157f7db310be09976e70a16911e5b98ee74f236f95b5f047a9d03
6
+ metadata.gz: b2242d441f2aba9aa89748e459862c3ec64a225381480aba8cb767ca24e7f58d59a1d017f6e1eed4541f7807453490a39063e079a2e6fe3552560180e37ce6bd
7
+ data.tar.gz: 58db4a1d2fbc07635baf29ef35e4950ec4eb7ca56c41d95dae253659d64f8076fc74a4beb4342d357d4c2843c314414086e6ff13da2d1322c1ca75bedf020e14
data/README.md CHANGED
@@ -1,4 +1,39 @@
1
1
  Simple Memoizer
2
2
  =====================
3
3
 
4
- Allows you to memoize simple methods and works only on ruby 2
4
+ Allows you to memoize simple methods and works only on ruby 2.0.
5
+
6
+ ## Usage
7
+ ```ruby
8
+ class Counter
9
+ def increment
10
+ @sum = 1 + @sum.to_i
11
+ end
12
+
13
+ memoize :increment
14
+ end
15
+ ```
16
+ Your method will only be called the first time, the result will be stored and returned on subsequent invocations.
17
+ ```irb
18
+ counter = Counter.new
19
+ => Counter
20
+
21
+ counter.increment
22
+ => 1
23
+
24
+ counter.increment
25
+ => 1
26
+
27
+ counter.increment = 5
28
+ => 5
29
+
30
+ counter.increment
31
+ => 5
32
+ ```
33
+ As you can see, it also provides an assignment operator, so you can override the memoized value :smiley:.
34
+
35
+ ## Background
36
+ SimpleMemoizer uses Module#prepend to add the memoized method before yours in the method lookup path of your class. Your method is called by using 'super', because the class is an ancestor to the prepended module.
37
+
38
+ ### Corolary
39
+ If you override a memoized method in a derived class, you alter the method chain, so the derived method won't be memoized unless you invoke memoize in the derived class as well.
@@ -16,7 +16,7 @@ module SimpleMemoizer
16
16
  end
17
17
 
18
18
  def #{name}=(value)
19
- #{memoized_ivar} = [super(value)]
19
+ #{memoized_ivar} = [value]
20
20
  end
21
21
  EVAL
22
22
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: simple_memoizer
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Máximo Mussini
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-02-25 00:00:00.000000000 Z
11
+ date: 2014-03-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activesupport