dnote 1.3.0 → 1.3.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.
data/HISTORY CHANGED
@@ -1,6 +1,27 @@
1
1
  = RELEASE HISTORY
2
2
 
3
- == 1.2 / 2010-02-18
3
+ == 1.3.1 / 2010-06-11
4
+
5
+ This release fixes a simple bug. Some version of Ruby do not have
6
+ the Enumerable#group_by method. This release provides it if it is
7
+ missing.
8
+
9
+ Changes:
10
+
11
+ * Bug fix, provide #group_by when it is not present.
12
+
13
+
14
+ == 1.3.0 / 2010-06-04
15
+
16
+ This release adds support for alternate comment markers. Simply
17
+ supply the marker with the -m option.
18
+
19
+ Changes:
20
+
21
+ * Add support for languages other than Ruby.
22
+
23
+
24
+ == 1.2.0 / 2010-02-18
4
25
 
5
26
  By request this release adds additional formats, allowing notes to be
6
27
  sorted by filename as well a label. In addition, paths can now be
@@ -29,7 +50,7 @@ Changes:
29
50
  * Add --templates/-T to list all format templates.
30
51
 
31
52
 
32
- == 1.1 / 2010-02-06
53
+ == 1.1.0 / 2010-02-06
33
54
 
34
55
  This relase primarily adjusts the way output it rendered
35
56
  underthehood. Serialization formats are rendered as
@@ -47,7 +68,7 @@ Changes:
47
68
  * Move lib/plugin to lib/plugins.
48
69
 
49
70
 
50
- == 1.0 / 2009-10-25
71
+ == 1.0.0 / 2009-10-25
51
72
 
52
73
  This relase adds support for arbitrary note labels.
53
74
  Any all-caps word followed by a colon will be
@@ -59,7 +80,7 @@ Changes:
59
80
  * Added support for arbitrary labels.
60
81
 
61
82
 
62
- == 0.9 / 2009-10-10
83
+ == 0.9.0 / 2009-10-10
63
84
 
64
85
  This release adds a syckle plugin and improves output.
65
86
 
@@ -71,7 +92,7 @@ Changes:
71
92
  * If no paths specified, will scan '**/*.rb'
72
93
 
73
94
 
74
- == 0.8 / 2009-10-09
95
+ == 0.8.0 / 2009-10-09
75
96
 
76
97
  This is the initial release of DNote. DNote is a spin-off
77
98
  of a Syckle (formerlly Reap) plugin which scans source
data/VERSION CHANGED
@@ -1,5 +1,5 @@
1
1
  name : dnote
2
2
  major: 1
3
3
  minor: 3
4
- patch: 0
5
- date : 2010-06-04
4
+ patch: 1
5
+ date : 2010-06-11
@@ -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
+
@@ -1,32 +1,27 @@
1
+ require 'yaml'
2
+
1
3
  module DNote
2
- VERSION = "1.2.1" #:till: VERSION = "<%= version %>"
4
+ DIRECTORY = File.dirname(__FILE__) + '/dnote'
3
5
 
4
- require 'dnote/session'
6
+ profile = YAML.load(File.new(DIRECTORY + '/profile.yml'))
7
+ verfile = YAML.load(File.new(DIRECTORY + '/version.yml'))
5
8
 
6
- # NOTE: Toying with the idea of making DNote a class.
9
+ VERSION = verfile.values_at('major','minor','patch','state','build').compact.join('.')
7
10
 
8
- #attr :notes
9
- #
10
- #def initialize(paths, options={})
11
- # labels = options[:labels] || options['labels']
12
- # @notes = Notes.new(paths, labels)
13
- #end
14
- #
15
- #
16
- #def save(format, output, options)
17
- # options = options.merge({ :format=>format, :output=>output })
18
- # format = Format.new(notes, options)
19
- # format.render
20
- #end
21
11
  #
22
- #
23
- #def display(format, options)
24
- # options = options.merge({ :format=>format, :output=>nil })
25
- # format = Format.new(@notes, options)
26
- # format.render
27
- #end
28
-
12
+ def self.const_missing(name)
13
+ key = name.to_s.downcase
14
+ if verfile.key?(key)
15
+ verfile[key]
16
+ elsif profile.key?(key)
17
+ profile[key]
18
+ else
19
+ super(name)
20
+ end
21
+ end
29
22
  end
30
23
 
24
+ require 'dnote/session'
25
+
31
26
  # TEST: This is a test of arbitraty labels.
32
27
 
@@ -0,0 +1,12 @@
1
+ module Enumerable
2
+
3
+ # Taken from Ruby Facets.
4
+ def group_by #:yield:
5
+ #h = k = e = nil
6
+ r = Hash.new
7
+ each{ |e| (r[yield(e)] ||= []) << e }
8
+ r
9
+ end unless method_defined?(:group_by)
10
+
11
+ end
12
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ title : DNote
3
+ suite : proutils
4
+ summary: Extract developer's notes from source code
5
+ contact: trans <transfire@gmail.com>
6
+ created: 2009-10-09
7
+ authors: Thomas Sawyer
8
+
9
+ description:
10
+ Dnote makes it easy to extract developer's
11
+ notes from source code, and supports almost
12
+ any language.
13
+
14
+ resources:
15
+ home: http://proutils.github.com/dnote
16
+ code: http://github.com/proutils/dnote
17
+ wiki: http://wiki.github.com/proutils/dnote
18
+ api : http://proutils.github.com/dnote/rdoc
19
+ mail: http://groups.google.com/group/proutils
20
+ repo: git://github.com/proutils/dnote.git
21
+
22
+ copyright: Copyright (c) 2009 Thomas Sawyer
23
+
@@ -1,5 +1,6 @@
1
1
  module DNote
2
2
 
3
+ require 'dnote/core_ext'
3
4
  require 'dnote/notes'
4
5
  require 'dnote/format'
5
6
 
@@ -155,10 +156,6 @@ module DNote
155
156
  opt.separator(" ")
156
157
  opt.separator("OUTPUT FORMAT: (choose one)")
157
158
 
158
- opt.on("--marker", '-m MARK', "Alternative remark marker") do |mark|
159
- session.marker = mark
160
- end
161
-
162
159
  opt.on("--format", "-f NAME", "select a format [text]") do |format|
163
160
  session.format = format
164
161
  end
@@ -187,6 +184,10 @@ module DNote
187
184
  session.colon = val
188
185
  end
189
186
 
187
+ opt.on("--marker", '-m MARK', "Alternative remark marker") do |mark|
188
+ session.marker = mark
189
+ end
190
+
190
191
  opt.on("--exclude", "-x PATH", "exclude file or directory") do |path|
191
192
  session.exclude << path
192
193
  end
@@ -221,7 +222,7 @@ module DNote
221
222
  tnames = tfiles.map{ |tname| tname.sub(tdir+'/', '').chomp('.erb') }
222
223
  groups = tnames.group_by{ |tname| tname.split('/').first }
223
224
  groups.sort.each do |(type, names)|
224
- puts ("%-18s " * names.size) % names.sort
225
+ puts("%-18s " * names.size) % names.sort
225
226
  end
226
227
  exit
227
228
  end
@@ -0,0 +1,5 @@
1
+ name : dnote
2
+ major: 1
3
+ minor: 3
4
+ patch: 1
5
+ date : 2010-06-11
metadata CHANGED
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
5
5
  segments:
6
6
  - 1
7
7
  - 3
8
- - 0
9
- version: 1.3.0
8
+ - 1
9
+ version: 1.3.1
10
10
  platform: ruby
11
11
  authors:
12
12
  - Thomas Sawyer
@@ -14,10 +14,33 @@ autorequire:
14
14
  bindir: bin
15
15
  cert_chain: []
16
16
 
17
- date: 2010-06-04 00:00:00 -04:00
17
+ date: 2010-06-11 00:00:00 -04:00
18
18
  default_executable:
19
- dependencies: []
20
-
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: syckle
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ segments:
28
+ - 0
29
+ version: "0"
30
+ type: :development
31
+ version_requirements: *id001
32
+ - !ruby/object:Gem::Dependency
33
+ name: lemon
34
+ prerelease: false
35
+ requirement: &id002 !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ segments:
40
+ - 0
41
+ version: "0"
42
+ type: :development
43
+ version_requirements: *id002
21
44
  description: Dnote makes it easy to extract developer's notes from source code, and supports almost any language.
22
45
  email: transfire@gmail.com
23
46
  executables:
@@ -28,9 +51,14 @@ extra_rdoc_files:
28
51
  - README.rdoc
29
52
  files:
30
53
  - bin/dnote
54
+ - demo/sample.bas
55
+ - demo/sample.js
56
+ - demo/sample.rb
57
+ - lib/dnote/core_ext.rb
31
58
  - lib/dnote/format.rb
32
59
  - lib/dnote/note.rb
33
60
  - lib/dnote/notes.rb
61
+ - lib/dnote/profile.yml
34
62
  - lib/dnote/session.rb
35
63
  - lib/dnote/string.rb
36
64
  - lib/dnote/templates/html/file.erb
@@ -69,6 +97,7 @@ files:
69
97
  - lib/dnote/templates/yaml/label.erb
70
98
  - lib/dnote/templates/yaml/list.erb
71
99
  - lib/dnote/templates/yaml.erb
100
+ - lib/dnote/version.yml
72
101
  - lib/dnote.rb
73
102
  - lib/plugins/rake/task.rb
74
103
  - lib/plugins/syckle/dnote.rb
@@ -80,7 +109,7 @@ files:
80
109
  - REQUIRE
81
110
  - VERSION
82
111
  has_rdoc: true
83
- homepage:
112
+ homepage: http://proutils.github.com/dnote
84
113
  licenses: []
85
114
 
86
115
  post_install_message: