iolite 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (57) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +24 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +5 -0
  5. data/Gemfile +4 -0
  6. data/LICENSE.txt +22 -0
  7. data/README.md +70 -0
  8. data/Rakefile +7 -0
  9. data/docs/iolite.md +278 -0
  10. data/example/array.rb +17 -0
  11. data/example/fizzbuzz.rb +15 -0
  12. data/example/hash.rb +14 -0
  13. data/example/minimal_implement.rb +42 -0
  14. data/example/simple.rb +46 -0
  15. data/example/to_lazy.rb +37 -0
  16. data/iolite.gemspec +24 -0
  17. data/lib/iolite.rb +14 -0
  18. data/lib/iolite/adaptor.rb +2 -0
  19. data/lib/iolite/adaptor/all.rb +22 -0
  20. data/lib/iolite/adaptor/apply.rb +10 -0
  21. data/lib/iolite/adaptor/bind.rb +9 -0
  22. data/lib/iolite/adaptor/callable.rb +7 -0
  23. data/lib/iolite/adaptor/define_send_original_methods.rb +12 -0
  24. data/lib/iolite/adaptor/method_missing.rb +10 -0
  25. data/lib/iolite/adaptor/operators.rb +26 -0
  26. data/lib/iolite/adaptor/send.rb +11 -0
  27. data/lib/iolite/adaptor/to_lazy.rb +11 -0
  28. data/lib/iolite/adaptor/to_proc.rb +10 -0
  29. data/lib/iolite/adaptored/array.rb +12 -0
  30. data/lib/iolite/adaptored/hash.rb +14 -0
  31. data/lib/iolite/adaptored/iolite_lazy_with_hash.rb +7 -0
  32. data/lib/iolite/adaptored/object_with_to_lazy.rb +5 -0
  33. data/lib/iolite/adaptored/proc.rb +5 -0
  34. data/lib/iolite/adaptored/string.rb +21 -0
  35. data/lib/iolite/functinal.rb +4 -0
  36. data/lib/iolite/functinal/bind.rb +12 -0
  37. data/lib/iolite/functinal/define_iolite_functinal_send_method.rb +9 -0
  38. data/lib/iolite/functinal/invoke.rb +11 -0
  39. data/lib/iolite/functinal/send.rb +13 -0
  40. data/lib/iolite/lazy.rb +40 -0
  41. data/lib/iolite/placeholders.rb +30 -0
  42. data/lib/iolite/refinements.rb +6 -0
  43. data/lib/iolite/refinements/array.rb +16 -0
  44. data/lib/iolite/refinements/hash.rb +18 -0
  45. data/lib/iolite/refinements/object_with_to_lazy.rb +9 -0
  46. data/lib/iolite/refinements/proc.rb +9 -0
  47. data/lib/iolite/refinements/string.rb +26 -0
  48. data/lib/iolite/statement.rb +3 -0
  49. data/lib/iolite/statement/if.rb +48 -0
  50. data/lib/iolite/statement/if_else.rb +11 -0
  51. data/lib/iolite/version.rb +3 -0
  52. data/spec/iolite_adaptored_spec.rb +101 -0
  53. data/spec/iolite_functinal_spec.rb +87 -0
  54. data/spec/iolite_lazy_spec.rb +92 -0
  55. data/spec/iolite_spec.rb +212 -0
  56. data/spec/spec_helper.rb +2 -0
  57. metadata +146 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f8bdc1d07b8278aae627184301b8ccbdca18c586
4
+ data.tar.gz: 7988f1205a24e40ed0a4ab0943d74775464a21c7
5
+ SHA512:
6
+ metadata.gz: 0c81d0be5cbda84687152fd2c1d58148bea44a1e0049e0a4efd43025786fb8813a9a50f339ec0b4d3e848ec8bb69898fdef8005976ef46d2505119cff0854044
7
+ data.tar.gz: 2f94fba7d27a8e0e2e998b5fb8ddfdc1575468cebe04b37051afa70d89db273190581386f861a2b394c1f486b5dc34d81e78cd16e7b29730f56a720c0782cb24
data/.gitignore ADDED
@@ -0,0 +1,24 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ *.bundle
19
+ *.so
20
+ *.o
21
+ *.a
22
+ mkmf.log
23
+ test
24
+ _lib
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.0
4
+ - 2.0.0
5
+ - 1.9.3
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in iolite.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2015 manga_osyo
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,70 @@
1
+ [![Build Status](https://travis-ci.org/osyo-manga/gem-iolite.svg?branch=master)](https://travis-ci.org/osyo-manga/gem-iolite)
2
+
3
+ # Iolite
4
+
5
+ TODO: Write a gem description
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ gem 'iolite'
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install iolite
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ require "iolite"
25
+
26
+
27
+ #######################################
28
+ # Using block
29
+ #######################################
30
+
31
+ p (1..5).map { |it| it + 3 }
32
+ # => [4, 5, 6, 7, 8]
33
+
34
+ p (1..5).inject { |memo, item| memo + item }
35
+ # => 15
36
+
37
+ p ["homu", "mami", "an"].inject(0) { |memo, item| memo + item.length }
38
+ # => 10
39
+
40
+ p [{name: :homu}, {name: :mami}].map { |it| it[:name] }
41
+ # => [:homu, :mami]
42
+
43
+
44
+ #######################################
45
+ # Using iolite
46
+ #######################################
47
+
48
+ # using arg1, arg2...
49
+ include Iolite::Placeholders
50
+
51
+ p (1..5).map &arg1 + 3
52
+ # => [4, 5, 6, 7, 8]
53
+
54
+ p (1..5).inject &arg1 + arg2
55
+ # => 15
56
+
57
+ p ["homu", "mami", "an"].inject 0, &arg1 + arg2.length
58
+ # => 10
59
+
60
+ p [{name: :homu}, {name: :mami}].map &arg1[:name]
61
+ # => [:homu, :mami]
62
+ ```
63
+
64
+ ## Contributing
65
+
66
+ 1. Fork it ( https://github.com/osyo-manga/gem-iolite )
67
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
68
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
69
+ 4. Push to the branch (`git push origin my-new-feature`)
70
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,7 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
7
+
data/docs/iolite.md ADDED
@@ -0,0 +1,278 @@
1
+ # iotelite
2
+
3
+ ## これは何?
4
+
5
+ 式を遅延評価するためのライブラリです。
6
+ ブロックで行う処理を抽象化し、コードを簡略化することを目的としています。
7
+ ちなみにライブラリ名である iolite(アイオライト)は菫青石から取っています。
8
+
9
+ ## イントロダクション
10
+
11
+ さて、Ruby ではブロック付きメソッド呼び出しを行うことが多いです。
12
+
13
+ ```ruby
14
+ ["homu", "mami", "mado"].map { |it| it.capitalize }
15
+ # => ["Homu", "Mami", "Mado"]
16
+ ```
17
+
18
+ しかし、上記のようにブロックを使用すると it を2回書く必要が出てきてちょっと手間ですね。
19
+ これは 以下のように Symbol#to_proc を利用するように書き換える事が可能です。
20
+
21
+ ```ruby
22
+ ["homu", "mami", "mado"].map &:capitalize
23
+ # => ["Homu", "Mami", "Mado"]
24
+ ```
25
+
26
+ これでブロックを記述することなく map を使用する事ができました。
27
+ では、次のようなコードはどうでしょうか。
28
+
29
+ ```ruby
30
+ ["homu", "mami", "mado"].select{ |it| it =~ /^m/ }
31
+ # => ["mami", "mado"]
32
+
33
+ [{ name: "homu" }, { name: "mami" }, { name: "mado" }].map { |it| it[:name] }
34
+ # => ["homu", "mami", "mado"]
35
+ ```
36
+
37
+ 上記のように呼び出したいメソッドに対して引数を渡したい場合はどうしてもブロックで記述する必要が出てきます。
38
+ このような場合に iolite を使用することですっきりとした記述をすることができます。
39
+
40
+ ```ruby
41
+ # iolite を使って書いてみる
42
+ # arg1 は第一引数に置き換わり評価される
43
+ ["homu", "mami", "mado"].select &arg1 =~ /^m/
44
+ # => ["mami", "mado"]
45
+
46
+ [{ name: "homu" }, { name: "mami" }, { name: "mado" }].map &arg1[:name]
47
+ # => ["homu", "mami", "mado"]
48
+ ```
49
+
50
+ ## 導入
51
+
52
+ #### install
53
+
54
+ ```shell
55
+ $ gem install iolite
56
+ ```
57
+
58
+ #### require
59
+
60
+ ```ruby
61
+ require "iolite"
62
+ ```
63
+
64
+ ## 簡単な使い方
65
+
66
+ iolite ではプレースホルダを使用して、式から遅延評価を行うオブジェクトを定義します。
67
+ プレースホルダは arg1, arg2, ...argN と定義されており、それぞれの引数番目の値に置き換わり評価されます。
68
+
69
+ ```ruby
70
+ # プレースホルダは module Iolite::Placeholders で定義されている
71
+ include Iolite::Placeholders
72
+
73
+ # arg1 は第一引数を返す
74
+ arg1.call(1, 2)
75
+ # => 1
76
+
77
+ # arg1 は第二引数を返す
78
+ arg2.call(1, 2)
79
+ # => 2
80
+ ```
81
+
82
+ このプレースホルダからメソッドを呼び出すと、そのメソッドを遅延評価するオブジェクトを返します。
83
+
84
+ ```ruby
85
+ # 第一引数に対して #capitalize メソッドを呼び出すオブジェクトを返す
86
+ capitalize_ = arg1.capitalize
87
+
88
+ capitalize_.call("homu")
89
+ # => "Homu"
90
+ capitalize_.call("an")
91
+ # => "An"
92
+
93
+ # メソッドの引数に対してプレースホルダを渡すこともできる
94
+ plus = arg1 + arg2
95
+ # plus = arg1.+(arg2)
96
+
97
+ plus.call(1, 2)
98
+ # => 3
99
+ ```
100
+
101
+ 次のようにメソッドチェーンやネストしてプレースホルダを使用することもできます。
102
+
103
+ ```ruby
104
+ # 連続してメソッドを呼び出すこともできる
105
+ length_ = arg1.to_s(4).length
106
+ length_.call(:homu)
107
+ # => 4
108
+ length_.call(42)
109
+ # => 2
110
+
111
+ # ネストして呼び出すことも可能
112
+ f = arg1[arg2].length + arg1[arg3]
113
+ f.call({ :name => "homu", :age => 13 }, :name, :age)
114
+ # => 17
115
+ ```
116
+
117
+
118
+ ### ブロックに渡す
119
+
120
+ & をつけることでブロックに渡すことができます。
121
+
122
+ ```ruby
123
+ ["homu", "mami", "mado"].select &arg1 =~ /^m/
124
+ # => ["mami", "mado"]
125
+ [:homu, :mami, :mado].inject 0, &arg1 + arg2.to_s.length
126
+ # => 12
127
+ ```
128
+
129
+
130
+ ## Iolite::Lazy < BasicObject (class)
131
+
132
+ Iolite::Lazy は遅延評価を行うためのオブジェクトです。
133
+ プレースホルダなどはこのオブジェクトのラッパになります。
134
+
135
+ ```ruby
136
+ f = Iolite::Lazy.new { |a, b| a + b }
137
+ p f.call(1, 2)
138
+ # => 10
139
+ ```
140
+
141
+ これは次のようにメソッド呼び出しを遅延評価する事ができます。
142
+
143
+ ```ruby
144
+ twice = Iolite::Lazy.new { |a| a + a }
145
+ twice.call(2)
146
+ # => 4
147
+
148
+ # 演算子を遅延評価
149
+ twice_plus3 = (twice + 3)
150
+ twice_plus3.call(1) # to twice.call(1) + 3
151
+ # => 5
152
+
153
+ # メソッド呼び出しを遅延評価
154
+ upcase_ = twice.upcase
155
+ upcase_.call("homu") # to twice.call("homu").upcase
156
+ # => "HOMUHOMU"
157
+ ```
158
+
159
+ また、このクラスは BasicObject を継承していることに注意してください。
160
+
161
+ #### Iolite::Lazy#initialize &block
162
+
163
+ 遅延評価を行うブロックを渡してオブジェクトを作成します。
164
+ このブロックは `#call` の呼び出し時に評価されます。
165
+
166
+ #### Iolite::Lazy#call(*args)
167
+
168
+ 初期化時に渡したブロックを評価します。
169
+
170
+
171
+ #### Iolite::Lazy#send(name, *args)
172
+
173
+ name という名前のメソッドを遅延評価します。
174
+ 遅延評価した結果に対して `#send(name, *args)` を呼び出す Iolite::Lazy を返します。
175
+
176
+ ```ruby
177
+ it = Iolite::Lazy.new { |it| it }
178
+ it.send(:length).call("homu") # to { |it| it }.call("homu").length
179
+ ```
180
+
181
+ #### Iolite::Lazy#method_missing(name, *args)
182
+
183
+ `Iolite::Lazy#send(name, *args)` を返します。
184
+ Iolite::Lazy で定義されていないメソッドであれば `#send` を使用することなくメソッドを遅延評価することができます。
185
+
186
+ #### Iolite::Lazy#to_proc
187
+
188
+ `#call` を呼び出す Proc を返します。
189
+ これにより & を着けてブロックに渡すことができます。
190
+
191
+ ```ruby
192
+ it = Iolite::Lazy.new { |it| it }
193
+ ["homu", "mami", "mado"].map &it.capitalize
194
+ # => ["Homu", "Mami", "Mado"]
195
+
196
+ ["homu", "mami", "mado"].select &it =~ /^m/
197
+ # => ["mami", "mado"]
198
+ ```
199
+
200
+ ## プレースホルダ
201
+
202
+ プレースホルダは任意の引数値に対して遅延評価を行うために使用します。
203
+ プレースホルダは arg1 〜 arg10 まで定義されており、argN 番目の引数に対応します。
204
+ これは module Iolite::Placeholders で定義されています。
205
+
206
+ ```ruby
207
+ include Iolite::Placeholders
208
+
209
+ arg1.call(1, 2)
210
+ # => 1
211
+
212
+ arg2.call(1, 2)
213
+ # => 1
214
+ ```
215
+
216
+ このプレースホルダは Iolite::Lazy オブジェクトなので Iolite::Lazy と同様に遅延評価を行うことができます。
217
+
218
+
219
+ ```ruby
220
+ include Iolite::Placeholders
221
+
222
+ (arg1 + arg2).call(1, 2)
223
+ # => 3
224
+
225
+ arg1.to_s.length.call(:homu)
226
+ # => 4
227
+
228
+ ["homu", "mami", "mado"].select(&arg1 =~ /^m/).map &arg1.capitalize
229
+ # => ["Mami", "Mado"]
230
+
231
+ (1..5).map &arg1.to_s(2)
232
+ # => ["1", "10", "11", "100", "101"]
233
+
234
+ [:homu, :mami, :an].select &arg1.to_s.length > 3
235
+ # => [:homu, :mami]
236
+ ```
237
+
238
+ ## Object#to_lazy
239
+
240
+ `Object#to_lazy` は自身を遅延評価するオブジェクト(Iolite::Lazy オブジェクト)として返すメソッドです。
241
+ `Object#to_lazy` を使用したい場合は refinements が使える環境であれば、
242
+
243
+ ```ruby
244
+ using Iolite::Refinements::ObjectWithToLazy
245
+ ```
246
+
247
+ refinements が使えない、もしくは直接 Object を拡張したい場合は
248
+
249
+ ```ruby
250
+ require "iolite/adaptored/object_with_to_lazy"
251
+ ```
252
+
253
+ することで利用することができます。
254
+
255
+
256
+ #### Example
257
+
258
+ ```ruby
259
+ # (1..Float::INFINITY) を遅延評価する
260
+ lazy_list = (1..Float::INFINITY).to_lazy
261
+ twice_list = lazy_list.first(arg1).map(&arg1 * 2)
262
+
263
+ p twice_list.call(5)
264
+ # => [2, 4, 6, 8, 10]
265
+ p twice_list.call(10)
266
+ # => [2, 4, 6, 8, 10, 12, 14, 16, 18, 20]
267
+
268
+ ["homu", "mami", "mado"].each &to_lazy.printf("%s:%s, ", arg1, arg1)
269
+ # => homu:homu, mami:mami, mado:mado,
270
+
271
+ a = { :name => "mami", :age => 13 }
272
+ b = { :name => "mami" }
273
+ a.reject &arg2 == b.to_lazy[arg1]
274
+ # => { :age => 13 }
275
+ ```
276
+
277
+
278
+
data/example/array.rb ADDED
@@ -0,0 +1,17 @@
1
+ require "iolite"
2
+
3
+ # Use require
4
+ # define Array#to_proc
5
+ require "iolite/adaptored/array"
6
+
7
+ include Iolite::Placeholders
8
+
9
+ p [1, arg1, 2, arg1 + arg2].to_proc.call(1, 2)
10
+ # => [1, 1, 2, 3]
11
+
12
+ p [1, 2, 3].map &[arg1, arg1 ,arg1]
13
+ # => [[1, 1, 1], [2, 2, 2], [3, 3, 3]]
14
+
15
+ p [1, 2, 3].map &((1..3).map &arg1.to_l + 3)
16
+ # => [[4, 4, 4], [5, 5, 5], [6, 6, 6]]
17
+