notesgrip 0.0.4

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.
@@ -0,0 +1,447 @@
1
+ module Notesgrip
2
+ # ====================================================
3
+ # ================ NotesView Class ===================
4
+ # ====================================================
5
+ class NotesView < GripWrapper
6
+ include DocCollection
7
+
8
+ def AllEntries
9
+ NotesViewEntryCollection.new(@raw_object.AllEntries)
10
+ end
11
+
12
+ def ColumnNames
13
+ #@raw_object.ColumnNames
14
+ raise "ColumnNames() is not work."
15
+ end
16
+
17
+ def Columns
18
+ ret_list = []
19
+ columns = @raw_object.Columns
20
+ return [] unless columns
21
+ columns.each {|raw_column|
22
+ ret_list.push NotesViewColumn.new(raw_column)
23
+ }
24
+ ret_list
25
+ end
26
+
27
+ def Parent
28
+ NotesDatabase.new(@raw_object.Parent)
29
+ end
30
+
31
+ def UniversalID
32
+ @raw_object.UniversalID
33
+ end
34
+
35
+
36
+ def CopyColumn( sourceColumn, destinationIndex=nil )
37
+ #raw_object = toRaw(sourceColumn)
38
+ #raw_viewColumn = @raw_object.CopyColumn(sourceColumn, destinationIndex)
39
+ #raw_viewColumn ? NotesViewColumn.new(raw_viewColumn) : nil
40
+ raise "CopyColumn() is not work."
41
+ end
42
+
43
+ def CreateColumn( position=nil, columnName=nil, formula=nil )
44
+ #raw_viewColumn = @raw_object.CreateColumn( position, columnName, formula )
45
+ #raw_viewColumn ? NotesViewColumn.new(raw_viewColumn) : nil
46
+ raise "CreateColumn() is not work."
47
+ end
48
+
49
+ def CreateViewNav( cacheSize=128 )
50
+ raw_viewNavigator = @raw_object.CreateViewNav( cacheSize )
51
+ raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
52
+ end
53
+
54
+ def CreateViewNavFrom( navigatorObject, cacheSize=128 )
55
+ raw_entry = toRaw(navigatorObject)
56
+ raw_viewNavigator = @raw_object.CreateViewNavFrom( raw_entry, cacheSize)
57
+ raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
58
+ end
59
+
60
+ def CreateViewNavFromAllUnread( username=nil )
61
+ raw_viewNavigator = @raw_object.CreateViewNavFromAllUnread( username )
62
+ raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
63
+ end
64
+
65
+ def CreateViewNavFromCategory( category, cacheSize=128 )
66
+ raw_viewNavigator = @raw_object.CreateViewNavFromCategory( category, cacheSize)
67
+ raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
68
+ end
69
+
70
+ def CreateViewNavFromDescendants( navigatorObject, cacheSize=128 )
71
+ raw_obj = toRaw(navigatorObject)
72
+ raw_viewNavigator = @raw_object.CreateViewNavFromDescendants( raw_obj, cacheSize )
73
+ raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
74
+ end
75
+
76
+ def CreateViewNavMaxLevel( level, cacheSize=128 )
77
+ raw_viewNavigator = @raw_object.CreateViewNavMaxLevel( level, cacheSize )
78
+ raw_viewNavigator ? NotesViewNavigator.new(raw_viewNavigator) : nil
79
+ end
80
+
81
+ def FTSearch( query, maxDocs=0 )
82
+ @raw_object.FTSearch( query, maxDocs )
83
+ end
84
+
85
+ def GetAllDocumentsByKey( keyArray , exactMatch = false )
86
+ raw_docCollection = @raw_object.GetAllDocumentsByKey( keyArray , exactMatch)
87
+ NotesDocumentCollection.new(raw_docCollection)
88
+ end
89
+
90
+ def GetAllEntriesByKey( keyArray , exactMatch=false )
91
+ raw_viewEntryCollection = @raw_object.GetAllEntriesByKey( keyArray , exactMatch)
92
+ NotesViewEntryCollection.new(raw_viewEntryCollection)
93
+ end
94
+
95
+ def GetAllReadEntries( username=nil )
96
+ raw_viewEntryCollection = @raw_object.GetAllReadEntries( username)
97
+ NotesViewEntryCollection.new(raw_viewEntryCollection)
98
+ end
99
+
100
+ def GetAllUnreadEntries( username=nil )
101
+ raw_viewEntryCollection = @raw_object.GetAllUnreadEntries( username)
102
+ NotesViewEntryCollection.new(raw_viewEntryCollection)
103
+ end
104
+
105
+ def GetChild( document )
106
+ raw_doc = toRaw(document)
107
+ raw_respdoc = @raw_object.GetChild(raw_doc)
108
+ raw_respdoc ? NotesDocument.new(raw_rspdoc) : nil
109
+ end
110
+
111
+ def GetColumn( columnNumber )
112
+ #raw_viewColumn = @raw_object.GetColumn(columnNumber)
113
+ #NotesViewColumn.new(raw_viewColumn)
114
+ raise "GetColumn() is not work."
115
+ end
116
+
117
+ def GetDocumentByKey( keyArray, exactMatch=false )
118
+ raw_doc = @raw_object.GetDocumentByKey( keyArray, exactMatch )
119
+ raw_doc ? NotesDocument.new(raw_doc) : nil
120
+ end
121
+
122
+ def GetEntryByKey( keyArray, exactMatch=false )
123
+ raw_viewEntry = @raw_object.GetEntryByKey( keyArray, exactMatch)
124
+ NotesViewEntry.new(raw_viewEntry)
125
+ end
126
+
127
+ def GetFirstDocument
128
+ raw_doc = @raw_object.GetFirstDocument()
129
+ raw_doc ? NotesDocument.new(raw_doc) : nil
130
+ end
131
+
132
+ def GetLastDocument
133
+ raw_doc = @raw_object.GetLastDocument()
134
+ raw_doc ? NotesDocument.new(raw_doc) : nil
135
+ end
136
+
137
+ def GetNextDocument(document)
138
+ raw_doc = toRaw(document)
139
+ raw_nextDoc = @raw_object.GetNextDocument(raw_doc)
140
+ raw_nextDoc ? NotesDocument.new(raw_nextDoc) : nil
141
+ end
142
+
143
+ def GetNextSibling( document )
144
+ raw_doc = toRaw(document)
145
+ raw_nextDoc = @raw_object.GetNextSibling(raw_doc)
146
+ raw_nextDoc ? NotesDocument.new(raw_nextDoc) : nil
147
+ end
148
+
149
+ def GetNthDocument(index)
150
+ raw_doc = @raw_object.GetNthDocument(index)
151
+ raw_doc ? NotesDocument.new(raw_doc) : nil
152
+ end
153
+
154
+ def GetParentDocument( document )
155
+ raw_doc = toRaw(document)
156
+ raw_parentDoc = @raw_object.GetParentDocument(raw_doc)
157
+ raw_parentDoc ? NotesDocument.new(raw_parentDoc) : nil
158
+ end
159
+
160
+ def GetPrevDocument( document )
161
+ raw_doc = toRaw(document)
162
+ raw_prevDoc = @raw_object.GetPrevDocument(raw_doc)
163
+ raw_prevDoc ? NotesDocument.new(raw_prevDoc) : nil
164
+ end
165
+
166
+ def GetPrevSibling( document )
167
+ raw_doc = toRaw(document)
168
+ raw_prevDoc = @raw_object.GetPrevSibling(raw_doc)
169
+ raw_prevDoc ? NotesDocument.new(raw_prevDoc) : nil
170
+ end
171
+
172
+ # ------ Additional Methods -----
173
+ def each_entry
174
+ self.AllEntries.each {|entry|
175
+ yield entry
176
+ }
177
+ end
178
+
179
+ def each_column
180
+ self.Columns.each {|column|
181
+ yield column
182
+ }
183
+ end
184
+
185
+ alias UNID UniversalID
186
+
187
+ def count
188
+ self.AllEntries.Count
189
+ end
190
+ alias size count
191
+
192
+ def inspect
193
+ "<#{self.class}, Name:#{self.Name.inspect}>"
194
+ end
195
+ end
196
+
197
+ # ====================================================
198
+ # ============= NotesViewColumn Class ================
199
+ # ====================================================
200
+ class NotesViewColumn < GripWrapper
201
+ # ------ Additional Methods -----
202
+ def inspect
203
+ "<#{self.class}, Title:#{self.Title.inspect}>"
204
+ end
205
+
206
+ def to_s
207
+ @raw_object.Title
208
+ end
209
+ end
210
+
211
+ # ====================================================
212
+ # ============= NotesViewEntry Class ================
213
+ # A view entry represents a row in a view.
214
+ # ====================================================
215
+ class NotesViewEntry < GripWrapper
216
+ def Document
217
+ raw_doc = @raw_object.Document
218
+ NotesDocument.new(raw_doc)
219
+ end
220
+
221
+ def UniversalID
222
+ @raw_object.UniversalID
223
+ end
224
+ # ------ Additional Methods -----
225
+ alias UNID UniversalID
226
+ def inspect
227
+ colValues = self.ColumnValues[0,3]
228
+ "<#{self.class}, #{colValues.inspect}>"
229
+ end
230
+
231
+ end
232
+
233
+ # ====================================================
234
+ # ============= NotesViewEntryCollection Class ================
235
+ # ====================================================
236
+ class NotesViewEntryCollection < GripWrapper
237
+ def each_viewEntry
238
+ raw_entry = @raw_object.GetFirstEntry
239
+ while raw_entry
240
+ next_entry = @raw_object.GetNextEntry(raw_entry)
241
+ yield NotesViewEntry.new(raw_entry)
242
+ raw_entry = next_entry
243
+ end
244
+ end
245
+ alias each each_viewEntry
246
+
247
+ def count
248
+ @raw_object.Count
249
+ end
250
+ alias size count
251
+
252
+ def inspect
253
+ "<#{self.class}, Count:#{self.Count}>"
254
+ end
255
+ end
256
+
257
+ # ====================================================
258
+ # ============= NotesViewNavigator Class ================
259
+ # ====================================================
260
+ class NotesViewNavigator < GripWrapper
261
+ def GetChild(entry)
262
+ raw_entry = toRaw(entry)
263
+ raw_viewEntry = @raw_object.GetChild(raw_entry)
264
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
265
+ end
266
+
267
+ def GetCurrent()
268
+ raw_viewEntry = @raw_object.GetCurrent()
269
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
270
+ end
271
+
272
+ def GetEntry( entry )
273
+ raw_entry = toRaw(entry)
274
+ raw_viewEntry = @raw_object.GetEntry(raw_entry)
275
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
276
+ end
277
+
278
+ def GetFirst
279
+ raw_viewEntry = @raw_object.GetFirst()
280
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
281
+ end
282
+
283
+ def GetFirstDocument
284
+ raw_viewEntry = @raw_object.GetFirstDocument()
285
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
286
+ end
287
+
288
+ def GetLast
289
+ raw_viewEntry = @raw_object.Getlast()
290
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
291
+ end
292
+
293
+ def GetLastDocument
294
+ raw_viewEntry = @raw_object.GetLastDocument()
295
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
296
+ end
297
+
298
+ def GetNext(entry)
299
+ raw_entry = toRaw(entry)
300
+ raw_viewEntry = @raw_object.GetNext(raw_entry)
301
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
302
+ end
303
+
304
+ def GetNextCategory(entry)
305
+ raw_entry = toRaw(entry)
306
+ raw_viewEntry = @raw_object.GetNextCategory(raw_entry)
307
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
308
+ end
309
+
310
+ def GetNextDocument(entry)
311
+ raw_entry = toRaw(entry)
312
+ raw_viewEntry = @raw_object.GetNextDocument(raw_entry)
313
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
314
+ end
315
+
316
+ def GetNextSibling(entry)
317
+ raw_entry = toRaw(entry)
318
+ raw_viewEntry = @raw_object.GetNextSibling(raw_entry)
319
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
320
+ end
321
+
322
+ def GetNth( index )
323
+ raw_viewEntry = @raw_object.GetNth( index )
324
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
325
+ end
326
+
327
+ def GetParent( entry )
328
+ raw_entry = toRaw(entry)
329
+ raw_viewEntry = @raw_object.GetParent(raw_entry)
330
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
331
+ end
332
+
333
+ def GetPos( position, separator )
334
+ raw_viewEntry = @raw_object.GetPos( position, separator )
335
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
336
+ end
337
+
338
+ def GetPrev( entry )
339
+ raw_entry = toRaw(entry)
340
+ raw_viewEntry = @raw_object.GetPrev(raw_entry)
341
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
342
+ end
343
+
344
+ def GetPrevCategory( entry )
345
+ raw_entry = toRaw(entry)
346
+ raw_viewEntry = @raw_object.GetPrevCategory(raw_entry)
347
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
348
+ end
349
+
350
+ def GetPrevDocument( entry )
351
+ raw_entry = toRaw(entry)
352
+ raw_viewEntry = @raw_object.GetPrevDocument(raw_entry)
353
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
354
+ end
355
+
356
+ def GetPrevSibling( entry )
357
+ raw_entry = toRaw(entry)
358
+ raw_viewEntry = @raw_object.GetPrevSibling(raw_entry)
359
+ raw_viewEntry ? NotesViewEntry.new(raw_viewEntry) : nil
360
+ end
361
+
362
+ def GotoChild( entry )
363
+ raw_entry = toRaw(entry)
364
+ @raw_object.GotoChild(raw_entry)
365
+ end
366
+
367
+ def GotoEntry( entry )
368
+ raw_entry = toRaw(entry)
369
+ @raw_object.GotoEntry(raw_entry)
370
+ end
371
+
372
+ def GotoFirst( )
373
+ @raw_object.GotoFirst()
374
+ end
375
+
376
+ def GotoFirstDocument( )
377
+ @raw_object.GotoFirstDocument( )
378
+ end
379
+
380
+ def GotoLast( )
381
+ @raw_object.GotoLast( )
382
+ end
383
+
384
+ def GotoNext( entry )
385
+ raw_entry = toRaw(entry)
386
+ @raw_object.GotoNext(raw_entry)
387
+ end
388
+
389
+ def GotoNextCategory( entry )
390
+ raw_entry = toRaw(entry)
391
+ @raw_object.GotoNextCategory(raw_entry)
392
+ end
393
+
394
+ def GotoNextDocument( entry )
395
+ raw_entry = toRaw(entry)
396
+ @raw_object.GotoNextDocument(raw_entry)
397
+ end
398
+
399
+ def GotoNextSibling( entry )
400
+ raw_entry = toRaw(entry)
401
+ @raw_object.GotoNextSibling(raw_entry)
402
+ end
403
+
404
+ def GotoParent( entry )
405
+ raw_entry = toRaw(entry)
406
+ @raw_object.GotoParent(raw_entry)
407
+ end
408
+
409
+ def GotoPos( pos, separator )
410
+ @raw_object.GotoPos( pos, separator )
411
+ end
412
+
413
+ def GotoPrev( entry )
414
+ raw_entry = toRaw(entry)
415
+ @raw_object.GotoPrev(raw_entry)
416
+ end
417
+
418
+ def GotoPrevCategory( entry )
419
+ raw_entry = toRaw(entry)
420
+ @raw_object.GotoPrevCategory(raw_entry)
421
+ end
422
+
423
+ def GotoPrevDocument( entry )
424
+ raw_entry = toRaw(entry)
425
+ @raw_object.GotoPrevDocument(raw_entry)
426
+ end
427
+
428
+ def GotoPrevSibling( entry )
429
+ raw_entry = toRaw(entry)
430
+ @raw_object.GotoPrevSibling(raw_entry)
431
+ end
432
+
433
+ def MarkAllRead( username=nil )
434
+ @raw_object.MarkAllRead( username )
435
+ end
436
+
437
+ def MarkAllUnread( username=nil )
438
+ @raw_object.MarkAllUnread( username )
439
+ end
440
+
441
+ # ----- Additional Methods -----
442
+ def inspect
443
+ "<#{self.class}, Count:#{self.Count}>"
444
+ end
445
+ end
446
+
447
+ end
@@ -0,0 +1,3 @@
1
+ module Notesgrip
2
+ VERSION = "0.0.4"
3
+ end
data/lib/notesgrip.rb ADDED
@@ -0,0 +1,17 @@
1
+ #!ruby -Ks
2
+
3
+ # NotesGrip Ver.0.00 2014/7/12
4
+ # Copyright (C) 2014 Yac <notesgrip@tech-notes.dyndns.org>
5
+ # This software is released under the MIT License, see LICENSE.txt.
6
+ require 'win32ole'
7
+ require 'singleton'
8
+ require 'notesgrip/version'
9
+ require 'notesgrip/GripWrapper'
10
+ require 'notesgrip/NotesSession'
11
+ require 'notesgrip/DocCollection'
12
+ require 'notesgrip/NotesDatabase'
13
+ require 'notesgrip/NotesDocument'
14
+ require 'notesgrip/NotesItem'
15
+ require 'notesgrip/NotesRichTextItem'
16
+ require 'notesgrip/NotesView'
17
+
data/notesgrip.gemspec ADDED
@@ -0,0 +1,23 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'notesgrip/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "notesgrip"
8
+ spec.version = Notesgrip::VERSION
9
+ spec.authors = ["yac4423"]
10
+ spec.email = ["notesgrip@tech-notes.dyndns.org"]
11
+ spec.summary = %q{Control Notes/Domino from Ruby Script.}
12
+ spec.description = %q{Control Notes/Domino from Ruby Script.}
13
+ spec.homepage = "https://github.com/yac4423/notesgrip"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.6"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ end
metadata ADDED
@@ -0,0 +1,92 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: notesgrip
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.4
5
+ platform: ruby
6
+ authors:
7
+ - yac4423
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-08-31 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.6'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ~>
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description: Control Notes/Domino from Ruby Script.
42
+ email:
43
+ - notesgrip@tech-notes.dyndns.org
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - .gitignore
49
+ - Gemfile
50
+ - LICENSE
51
+ - LICENSE.txt
52
+ - README.rdoc
53
+ - Rakefile
54
+ - Sample/sample_NotesDatabase.rb
55
+ - Sample/sample_NotesSession.rb
56
+ - Sample/sample_NotesView.rb
57
+ - lib/notesgrip.rb
58
+ - lib/notesgrip/DocCollection.rb
59
+ - lib/notesgrip/GripWrapper.rb
60
+ - lib/notesgrip/NotesDatabase.rb
61
+ - lib/notesgrip/NotesDocument.rb
62
+ - lib/notesgrip/NotesItem.rb
63
+ - lib/notesgrip/NotesRichTextItem.rb
64
+ - lib/notesgrip/NotesSession.rb
65
+ - lib/notesgrip/NotesView.rb
66
+ - lib/notesgrip/version.rb
67
+ - notesgrip.gemspec
68
+ homepage: https://github.com/yac4423/notesgrip
69
+ licenses:
70
+ - MIT
71
+ metadata: {}
72
+ post_install_message:
73
+ rdoc_options: []
74
+ require_paths:
75
+ - lib
76
+ required_ruby_version: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - '>='
79
+ - !ruby/object:Gem::Version
80
+ version: '0'
81
+ required_rubygems_version: !ruby/object:Gem::Requirement
82
+ requirements:
83
+ - - '>='
84
+ - !ruby/object:Gem::Version
85
+ version: '0'
86
+ requirements: []
87
+ rubyforge_project:
88
+ rubygems_version: 2.0.14
89
+ signing_key:
90
+ specification_version: 4
91
+ summary: Control Notes/Domino from Ruby Script.
92
+ test_files: []