mvz-dnote 1.7.1

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.
Files changed (55) hide show
  1. checksums.yaml +7 -0
  2. data/COPYING.rdoc +31 -0
  3. data/HISTORY.rdoc +171 -0
  4. data/README.rdoc +113 -0
  5. data/bin/dnote +4 -0
  6. data/lib/dnote.rb +4 -0
  7. data/lib/dnote.yml +1 -0
  8. data/lib/dnote/core_ext.rb +92 -0
  9. data/lib/dnote/format.rb +173 -0
  10. data/lib/dnote/note.rb +150 -0
  11. data/lib/dnote/notes.rb +320 -0
  12. data/lib/dnote/rake/dnotetask.rb +116 -0
  13. data/lib/dnote/session.rb +269 -0
  14. data/lib/dnote/templates/html.erb +49 -0
  15. data/lib/dnote/templates/html/file.erb +48 -0
  16. data/lib/dnote/templates/html/label.erb +49 -0
  17. data/lib/dnote/templates/html/list.erb +42 -0
  18. data/lib/dnote/templates/json.erb +8 -0
  19. data/lib/dnote/templates/json/file.erb +8 -0
  20. data/lib/dnote/templates/json/label.erb +8 -0
  21. data/lib/dnote/templates/json/list.erb +8 -0
  22. data/lib/dnote/templates/md.erb +19 -0
  23. data/lib/dnote/templates/md/file.erb +14 -0
  24. data/lib/dnote/templates/md/label.erb +19 -0
  25. data/lib/dnote/templates/md/list.erb +10 -0
  26. data/lib/dnote/templates/rdoc.erb +12 -0
  27. data/lib/dnote/templates/rdoc/file.erb +10 -0
  28. data/lib/dnote/templates/rdoc/label.erb +12 -0
  29. data/lib/dnote/templates/rdoc/list.erb +7 -0
  30. data/lib/dnote/templates/soap.erb +4 -0
  31. data/lib/dnote/templates/soap/file.erb +4 -0
  32. data/lib/dnote/templates/soap/label.erb +4 -0
  33. data/lib/dnote/templates/soap/list.erb +4 -0
  34. data/lib/dnote/templates/text.erb +12 -0
  35. data/lib/dnote/templates/text/file.erb +11 -0
  36. data/lib/dnote/templates/text/label.erb +11 -0
  37. data/lib/dnote/templates/text/list.erb +8 -0
  38. data/lib/dnote/templates/xml.erb +23 -0
  39. data/lib/dnote/templates/xml/file.erb +23 -0
  40. data/lib/dnote/templates/xml/label.erb +23 -0
  41. data/lib/dnote/templates/xml/list.erb +14 -0
  42. data/lib/dnote/templates/xoxo.erb +4 -0
  43. data/lib/dnote/templates/xoxo/file.erb +4 -0
  44. data/lib/dnote/templates/xoxo/label.erb +4 -0
  45. data/lib/dnote/templates/xoxo/list.erb +6 -0
  46. data/lib/dnote/templates/yaml.erb +1 -0
  47. data/lib/dnote/templates/yaml/file.erb +1 -0
  48. data/lib/dnote/templates/yaml/label.erb +1 -0
  49. data/lib/dnote/templates/yaml/list.erb +1 -0
  50. data/lib/dnote/version.rb +17 -0
  51. data/test/notes_case.rb +59 -0
  52. data/try/sample.bas +7 -0
  53. data/try/sample.js +11 -0
  54. data/try/sample.rb +11 -0
  55. metadata +131 -0
@@ -0,0 +1 @@
1
+ <%= require 'yaml'; notes.map{ |n| n.to_h_raw }.to_yaml %>
@@ -0,0 +1,17 @@
1
+ module DNote
2
+ VERSION = '1.7.1'
3
+
4
+ #
5
+ def self.metadata
6
+ @metadata ||= (
7
+ require 'yaml'
8
+ YAML.load_file(File.dirname(__FILE__) + '/../dnote.yml')
9
+ )
10
+ end
11
+
12
+ #
13
+ def self.const_missing(name)
14
+ metadata[name.to_s.downcase] || super(name)
15
+ end
16
+
17
+ end
@@ -0,0 +1,59 @@
1
+ require 'dnote/notes'
2
+ require 'minitest/autorun'
3
+
4
+ describe DNote::Notes do
5
+
6
+ describe :labels do
7
+ it 'returns the list of labels' do
8
+ notes = DNote::Notes.new([], :labels=>['TODO'])
9
+ notes.labels.must_equal ['TODO'] #DNote::Notes::DEFAULT_LABELS
10
+ end
11
+ end
12
+
13
+ describe :files do
14
+ it 'returns the files attribute' do
15
+ notes = DNote::Notes.new(["example1.rb"])
16
+ notes.files.must_equal ["example1.rb"]
17
+ end
18
+ end
19
+
20
+ describe :files do
21
+ it 'changes the paths attribute' do
22
+ notes = DNote::Notes.new([])
23
+ notes.files = ["example1.rb"]
24
+ notes.files.must_equal ["example1.rb"]
25
+ end
26
+ end
27
+
28
+ describe :match_general do
29
+ it 'works' do
30
+ notes = DNote::Notes.new([])
31
+ line, lineno, file = "# TODO: Do something or another!", 1, "foo.rb"
32
+ rec = notes.match_general(line, lineno, file)
33
+ rec.to_h.must_equal({'label'=>"TODO",'file'=>file,'line'=>lineno,'text'=>"Do something or another!"})
34
+ end
35
+ end
36
+
37
+ describe :match_special do
38
+ it 'works' do
39
+ notes = DNote::Notes.new([], :labels=>['TODO'])
40
+ line, lineno, file = "# TODO: Do something or another!", 1, "foo.rb"
41
+ rec = notes.match_special(line, lineno, file)
42
+ rec.to_h.must_equal({'label'=>"TODO",'file'=>file,'line'=>lineno,'text'=>"Do something or another!"})
43
+ end
44
+ end
45
+
46
+ describe :counts do
47
+ it { skip 'pending' }
48
+ end
49
+
50
+ describe :notes do
51
+ it { skip 'pending' }
52
+ end
53
+
54
+ describe :parse do
55
+ it { skip 'pending' }
56
+ end
57
+
58
+ end
59
+
@@ -0,0 +1,7 @@
1
+ ' Here is a sample of Javascript.
2
+ '
3
+ ' TODO: This is what we will do.
4
+ '
5
+ ' FIXME: And this is something urgant
6
+
7
+
@@ -0,0 +1,11 @@
1
+ // Here is a sample of Javascript.
2
+ //
3
+ // TODO: This is what we will do.
4
+ //
5
+ // FIXME: And this is something urgant
6
+
7
+ function sample() [
8
+ var n = 100;
9
+ return n;
10
+ }
11
+
@@ -0,0 +1,11 @@
1
+ # Here is a sample of Javascript.
2
+ #
3
+ # TODO: This is what we will do.
4
+ #
5
+ # FIXME: And this is something urgant
6
+
7
+ def sample
8
+ n = 100
9
+ n
10
+ end
11
+
metadata ADDED
@@ -0,0 +1,131 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mvz-dnote
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.7.1
5
+ platform: ruby
6
+ authors:
7
+ - Thomas Sawyer
8
+ - Matijs van Zuijlen
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2017-03-05 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: minitest
16
+ requirement: !ruby/object:Gem::Requirement
17
+ requirements:
18
+ - - "~>"
19
+ - !ruby/object:Gem::Version
20
+ version: '5.10'
21
+ type: :development
22
+ prerelease: false
23
+ version_requirements: !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - "~>"
26
+ - !ruby/object:Gem::Version
27
+ version: '5.10'
28
+ - !ruby/object:Gem::Dependency
29
+ name: rake
30
+ requirement: !ruby/object:Gem::Requirement
31
+ requirements:
32
+ - - "~>"
33
+ - !ruby/object:Gem::Version
34
+ version: '12.0'
35
+ type: :development
36
+ prerelease: false
37
+ version_requirements: !ruby/object:Gem::Requirement
38
+ requirements:
39
+ - - "~>"
40
+ - !ruby/object:Gem::Version
41
+ version: '12.0'
42
+ description: |2
43
+ DNote makes it easy to extract developer's notes from source code,
44
+ and supports almost any language.
45
+ email:
46
+ - matijs@matijs.net
47
+ executables:
48
+ - dnote
49
+ extensions: []
50
+ extra_rdoc_files:
51
+ - HISTORY.rdoc
52
+ - README.rdoc
53
+ - COPYING.rdoc
54
+ files:
55
+ - COPYING.rdoc
56
+ - HISTORY.rdoc
57
+ - README.rdoc
58
+ - bin/dnote
59
+ - lib/dnote.rb
60
+ - lib/dnote.yml
61
+ - lib/dnote/core_ext.rb
62
+ - lib/dnote/format.rb
63
+ - lib/dnote/note.rb
64
+ - lib/dnote/notes.rb
65
+ - lib/dnote/rake/dnotetask.rb
66
+ - lib/dnote/session.rb
67
+ - lib/dnote/templates/html.erb
68
+ - lib/dnote/templates/html/file.erb
69
+ - lib/dnote/templates/html/label.erb
70
+ - lib/dnote/templates/html/list.erb
71
+ - lib/dnote/templates/json.erb
72
+ - lib/dnote/templates/json/file.erb
73
+ - lib/dnote/templates/json/label.erb
74
+ - lib/dnote/templates/json/list.erb
75
+ - lib/dnote/templates/md.erb
76
+ - lib/dnote/templates/md/file.erb
77
+ - lib/dnote/templates/md/label.erb
78
+ - lib/dnote/templates/md/list.erb
79
+ - lib/dnote/templates/rdoc.erb
80
+ - lib/dnote/templates/rdoc/file.erb
81
+ - lib/dnote/templates/rdoc/label.erb
82
+ - lib/dnote/templates/rdoc/list.erb
83
+ - lib/dnote/templates/soap.erb
84
+ - lib/dnote/templates/soap/file.erb
85
+ - lib/dnote/templates/soap/label.erb
86
+ - lib/dnote/templates/soap/list.erb
87
+ - lib/dnote/templates/text.erb
88
+ - lib/dnote/templates/text/file.erb
89
+ - lib/dnote/templates/text/label.erb
90
+ - lib/dnote/templates/text/list.erb
91
+ - lib/dnote/templates/xml.erb
92
+ - lib/dnote/templates/xml/file.erb
93
+ - lib/dnote/templates/xml/label.erb
94
+ - lib/dnote/templates/xml/list.erb
95
+ - lib/dnote/templates/xoxo.erb
96
+ - lib/dnote/templates/xoxo/file.erb
97
+ - lib/dnote/templates/xoxo/label.erb
98
+ - lib/dnote/templates/xoxo/list.erb
99
+ - lib/dnote/templates/yaml.erb
100
+ - lib/dnote/templates/yaml/file.erb
101
+ - lib/dnote/templates/yaml/label.erb
102
+ - lib/dnote/templates/yaml/list.erb
103
+ - lib/dnote/version.rb
104
+ - test/notes_case.rb
105
+ - try/sample.bas
106
+ - try/sample.js
107
+ - try/sample.rb
108
+ homepage: https://github.com/mvz/dnote
109
+ licenses: []
110
+ metadata: {}
111
+ post_install_message:
112
+ rdoc_options: []
113
+ require_paths:
114
+ - lib
115
+ required_ruby_version: !ruby/object:Gem::Requirement
116
+ requirements:
117
+ - - ">="
118
+ - !ruby/object:Gem::Version
119
+ version: '0'
120
+ required_rubygems_version: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ requirements: []
126
+ rubyforge_project:
127
+ rubygems_version: 2.6.8
128
+ signing_key:
129
+ specification_version: 4
130
+ summary: Extract developer's notes from source code.
131
+ test_files: []