mvz-dnote 1.9.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63a1703569a00e121051d24aa575d670c35a073d2ad3bb297ac21d9962df74c4
-  data.tar.gz: bb4a5b8e4af7345fd785a99437894558fde1db23afec33483fba5cc80a48bf2d
+  metadata.gz: dda17ae00a59e8fa38d63bfa8614eee12ba2a0432ec2686bb3eb507f3b9227a2
+  data.tar.gz: 4c47e756f2e283d70ea801dd7b779324852a930a52c7e1f14608d590778fb94f
 SHA512:
-  metadata.gz: 42983874e4878d69f6e6611a5498ca3fa8fe69432970430851375a42d7c8380c2a30c3dcdd7a72b867c570b35dcd9c7dcee47236608cff0869fa85ddc20e6fb2
-  data.tar.gz: 4818f542b9c8ff57c1764ab33e54d938777d23c24b78713f45d19cb6b84c55d5705bbe0cdbf907475d81486e9ae917b296b554382ff35fef0dcc72b7aed24719
+  metadata.gz: 597b4298e1ac055236da0b1d3c028cf17bdc6cbe98a447ffebd725d36da7e2a745df2e6a54bd0d9e304349affb0970b007078f16b6aee6ebca7dafb312e971fd
+  data.tar.gz: ffc5e2354dd5f7afad3f3ad5993640fd50bad159a654ddd989cca73ff6d19b3f2ff372be23c56bf7b84ae0a10915da110e42b76ce423b32dca80e885764381b0

data/HISTORY.rdoc

@@ -1,6 +1,16 @@
 = RELEASE HISTORY
 
-== Unreleased
+== 1.11.0 / 2025-05-24
+
+* Support Ruby 3.1 through 3.4, dropping support for older Rubies
+* Add rexml dependency
+* Update development dependencies
+
+== 1.10.0 / 2022-04-10
+
+* Add support for Ruby 3.1
+* Drop support for Ruby 2.5
+* Loosen development dependencies
 
 == 1.9.0 / 2021-09-17
 

data/lib/dnote/format.rb

@@ -14,7 +14,7 @@ module DNote
     require "rexml/text"
     require "dnote/core_ext"
 
-    EXTENSIONS = { "text" => "txt", "soap" => "xml", "xoxo" => "xml" }.freeze
+    EXTENSIONS = {"text" => "txt", "soap" => "xml", "xoxo" => "xml"}.freeze
 
     attr_reader :notes, :format, :output, :template, :title, :dryrun
 
@@ -24,17 +24,17 @@ module DNote
                    template: nil,
                    output: nil,
                    dryrun: false)
-      @notes    = notes
-      @format   = format
-      @title    = title
-      @dryrun   = dryrun
+      @notes = notes
+      @format = format
+      @title = title
+      @dryrun = dryrun
       @template = template
-      @output   = output
+      @output = output
     end
 
     def render
       if notes.empty?
-        $stderr << "No #{notes.labels.join(', ')} notes.\n"
+        $stderr << "No #{notes.labels.join(", ")} notes.\n"
       else
         case format
         when "custom"
@@ -75,13 +75,13 @@ module DNote
       else
         puts(result)
       end
-      $stderr << "(#{notes.counts.map { |l, n| "#{n} #{l}s" }.join(', ')})\n"
+      $stderr << "(#{notes.counts.map { |l, n| "#{n} #{l}s" }.join(", ")})\n"
     end
 
     def write(result, fname = nil)
       if output.to_s[-1, 1] == "/" || File.directory?(output)
-        fmt  = format.split("/").first
-        ext  = EXTENSIONS[fmt] || fmt
+        fmt = format.split("/").first
+        ext = EXTENSIONS[fmt] || fmt
         file = File.join(output, fname || "notes.#{ext}")
       else
         file = output
@@ -91,7 +91,7 @@ module DNote
         puts "write: #{file}"
       else
         dir = File.dirname(file)
-        fu.mkdir(dir) unless File.exist?(dir)
+        FileUtils.mkdir_p(dir, **fu_opts)
         File.open(file, "w") { |f| f << result }
       end
       file
@@ -105,16 +105,13 @@ module DNote
       $DEBUG
     end
 
-    def fu
-      @fu ||=
-        if dryrun? && debug?
-          FileUtils::DryRun
-        elsif dryrun?
-          FileUtils::Noop
-        elsif debug?
-          FileUtils::Verbose
-        else
-          FileUtils
+    def fu_opts
+      @fu_opts ||=
+        begin
+          opts = {}
+          opts[:noop] = true if dryrun?
+          opts[:verbose] = true if debug?
+          opts
         end
     end
 
@@ -126,11 +123,7 @@ module DNote
 
       def render(file)
         contents = File.read(file)
-        erb = if RUBY_VERSION >= "2.6"
-                ERB.new(contents, trim_mode: "<>")
-              else
-                ERB.new(contents, nil, "<>")
-              end
+        erb = ERB.new(contents, trim_mode: "<>")
         erb.result(binding)
       end
 

data/lib/dnote/note.rb

@@ -30,12 +30,12 @@ module DNote
 
     # Initialize new Note instance.
     def initialize(notes, file, label, line, text, mark)
-      @notes   = notes
-      @file    = file
-      @label   = label
-      @line    = line
-      @text    = text.rstrip
-      @mark    = mark
+      @notes = notes
+      @file = file
+      @label = label
+      @line = line
+      @text = text.rstrip
+      @mark = mark
       @capture = []
     end
 
@@ -68,12 +68,12 @@ module DNote
     # TODO: Add +code+? Problem is that xml needs code in CDATA.
     #++
     def to_h
-      { "label" => label, "text" => textline, "file" => file, "line" => line }
+      {"label" => label, "text" => textline, "file" => file, "line" => line}
     end
 
     # Convert to Hash, leaving the note text verbatim.
     def to_h_raw
-      { "label" => label, "text" => text, "file" => file, "line" => line, "code" => code }
+      {"label" => label, "text" => text, "file" => file, "line" => line, "code" => code}
     end
 
     # Convert to JSON.

data/lib/dnote/notes.rb

@@ -20,10 +20,10 @@ module DNote
   #++
   class Notes
     # Default paths (all ruby scripts).
-    DEFAULT_PATHS  = ["**/*.rb"].freeze
+    DEFAULT_PATHS = ["**/*.rb"].freeze
 
     # Default note labels to look for in source code. (NOT CURRENTLY USED!)
-    DEFAULT_LABELS = %w(TODO FIXME OPTIMIZE THINK DEPRECATE).freeze
+    DEFAULT_LABELS = %w[TODO FIXME OPTIMIZE THINK DEPRECATE].freeze
 
     # Files to search for notes.
     attr_reader :files
@@ -44,14 +44,15 @@ module DNote
     attr_reader :context
 
     # New set of notes for give +files+ and optional special labels.
-    def initialize(files, options = {})
-      @files   = [files].flatten
-      @labels  = [options[:labels] || DEFAULT_LABELS].flatten.compact
-      @colon   = options[:colon].nil? ? true : options[:colon]
-      @marker  = options[:marker]
-      @url     = options[:url]
-      @context = options[:context] || 0
-      @remark  = {}
+    def initialize(files, marker: nil, url: nil, labels: DEFAULT_LABELS,
+                   colon: true, context: 0)
+      @files = files
+      @labels = labels
+      @colon = colon
+      @marker = marker
+      @url = url
+      @context = context
+      @remark = {}
 
       parse
     end

data/lib/dnote/notes_collection.rb

@@ -29,8 +29,8 @@ module DNote
     end
 
     # Iterate through notes.
-    def each(&block)
-      notes.each(&block)
+    def each(&)
+      notes.each(&)
     end
 
     # No notes?

data/lib/dnote/rake/dnotetask.rb

@@ -9,7 +9,7 @@ module DNote
     require "rake/clean"
 
     # Default note labels to looked for in source code.
-    DEFAULT_LABELS = %w(TODO FIXME OPTIMIZE DEPRECATE).freeze
+    DEFAULT_LABELS = %w[TODO FIXME OPTIMIZE DEPRECATE].freeze
 
     # File paths to search.
     attr_accessor :files
@@ -40,10 +40,10 @@ module DNote
     def init
       require "dnote"
       require "dnote/format"
-      @files   = "**/*.rb"
-      @output  = "log/dnote"
+      @files = "**/*.rb"
+      @output = "log/dnote"
       @formats = ["index"]
-      @labels  = nil
+      @labels = nil
     end
 
     def define
@@ -79,13 +79,13 @@ module DNote
 
     def new_session
       ::DNote::Session.new do |s|
-        s.paths   = files
+        s.paths = files
         s.exclude = exclude
-        s.ignore  = ignore
-        s.labels  = labels
-        s.title   = title
-        s.output  = output
-        s.dryrun  = application.options.dryrun # trial?
+        s.ignore = ignore
+        s.labels = labels
+        s.title = title
+        s.output = output
+        s.dryrun = application.options.dryrun # trial?
       end
     end
 
@@ -97,12 +97,12 @@ module DNote
         session.format = format
       end
       session.run
-      report "Updated #{output.to_s.sub("#{Dir.pwd}/", '')}" unless trial?
+      report "Updated #{output.to_s.sub("#{Dir.pwd}/", "")}" unless trial?
     end
 
     def clean_format(format)
       if format == "index"
-        file = "#{output}index.html".to_s
+        file = "#{output}index.html"
       else
         ext = ::DNote::Format::EXTENSIONS[format] || format
         file = (output + "notes.#{ext}").to_s

data/lib/dnote/session.rb

@@ -71,24 +71,24 @@ module DNote
     private
 
     # New Session.
-    def initialize(options = {})
-      options ||= {}
+    def initialize(**options)
       initialize_defaults
-      options.each { |k, v| __send__("#{k}=", v) }
+      options.each { |k, v| __send__(:"#{k}=", v) }
       yield(self) if block_given?
     end
 
     # Set default values for attributes.
     def initialize_defaults
-      @paths   = []
-      @labels  = []
+      @paths = []
+      @labels = []
       @exclude = []
-      @ignore  = []
-      @format  = DEFAULT_FORMAT
-      @title   = DEFAULT_TITLE
-      @dryrun  = false
-      @marker  = nil
-      @url     = nil
+      @ignore = []
+      @format = DEFAULT_FORMAT
+      @title = DEFAULT_TITLE
+      @dryrun = false
+      @colon = true
+      @marker = nil
+      @url = nil
       @context = 0
     end
 
@@ -148,7 +148,7 @@ module DNote
 
     # List availble format templates
     def list_templates
-      tdir   = File.join(DIR, "templates")
+      tdir = File.join(DIR, "templates")
       tfiles = Dir[File.join(tdir, "**/*.erb")]
       tnames = tfiles.map { |tname| tname.sub("#{tdir}/", "").chomp(".erb") }
       groups = tnames.group_by { |tname| tname.split("/").first }

data/lib/dnote/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DNote
-  VERSION = "1.9.0"
+  VERSION = "1.11.0"
 end

metadata

@@ -1,58 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: mvz-dnote
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Thomas Sawyer
 - Matijs van Zuijlen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '3.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '9.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '9.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.2.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,70 +106,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.74'
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.24'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
 description: |
   DNote makes it easy to extract developer's notes from source code,
   and supports almost any language.
@@ -174,9 +179,9 @@ executables:
 - dnote
 extensions: []
 extra_rdoc_files:
+- COPYING.rdoc
 - HISTORY.rdoc
 - README.md
-- COPYING.rdoc
 files:
 - COPYING.rdoc
 - HISTORY.rdoc
@@ -235,7 +240,7 @@ metadata:
   homepage_uri: https://github.com/mvz/dnote
   source_code_uri: https://github.com/mvz/dnote
   changelog_uri: https://github.com/mvz/dnote/blob/master/HISTORY.rdoc
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options:
 - "--main"
 - README.md
@@ -245,15 +250,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Extract developer's notes from source code.
 test_files: []