wgit 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f448212c206f3384275cb2df9a0c81139323cef6efa17dcfc1d907c037c08d
-  data.tar.gz: 28a12eee9935860c7c25b7500a718a6aa066e610a83dbc71003be7f63bb8a3dc
+  metadata.gz: c712169a7a2cf41bebb38b2c798aa883c9f685e4d3671929ab7a3ead55da0134
+  data.tar.gz: 0fb789510761c01f3d0459415b653f4eb896d194e31c610300ef94141dfab63a
 SHA512:
-  metadata.gz: 0dba9a82f73f3872f4c845b1c6c546efaef0afff1563b89b13a50efc429fe86bfe3590811d127df777569cc802904676d3e9a127705a7f10ce9b895e4b581c7d
-  data.tar.gz: d1c90814c1eab72a3cf6d0ea0f9f3bc239e71fc575b6ff89382135dad5d72bf770a05d75219cd78e16b5c686e8f15c7a5a6c3af89319f64c90e976049f60e7b5
+  metadata.gz: e175d2d23877fbb5aefc89aca1f98c31d9fee0ba78ec810bb3cc2260fdd97208c35ba9840b8cdc92ea49bdd8f6fd198910443fd61efdd563767048206f5a9788
+  data.tar.gz: 7dad82e66a10228ba0bce8e7d4cf8d17bdab734f90315813854c0c7e17807fa4c7f500711290a3e5eb28c431bab1c22ba4d25d7b585c1516c8f5470636bf37b4

data/CHANGELOG.md

@@ -9,6 +9,15 @@
 - ...
 ---
 
+## v0.10.2
+### Added
+- `Wgit::Base#setup` and `#teardown` methods (lifecycle hooks) that can be overridden by subclasses.
+### Changed/Removed
+- ...
+### Fixed
+- ...
+---
+
 ## v0.10.1
 ### Added
 - Support for Ruby 3.

data/lib/wgit/base.rb

@@ -4,16 +4,25 @@ module Wgit
   class Base
     extend Wgit::DSL
 
+    # Runs once before the crawl/index is run. Override as needed.
+    def setup; end
+
+    # Runs once after the crawl/index is complete. Override as needed.
+    def teardown; end
+
     # Runs the crawl/index passing each crawled `Wgit::Document` and the given
     # block to the subclass's `#parse` method.
     def self.run(&block)
+      crawl_method = @method || :crawl
       obj = new
+
       unless obj.respond_to?(:parse)
         raise "#{obj.class} must respond_to? #parse(doc, &block)"
       end
 
-      crawl_method = @method || :crawl
+      obj.setup
       send(crawl_method) { |doc| obj.parse(doc, &block) }
+      obj.teardown
 
       obj
     end

data/lib/wgit/indexer.rb

@@ -80,8 +80,8 @@ database capacity, exiting.")
           urls_count += write_urls_to_db(ext_links)
         end
 
-        Wgit.logger.info("Crawled and indexed docs for #{docs_count} url(s) \
-overall for this iteration.")
+        Wgit.logger.info("Crawled and indexed documents for #{docs_count} \
+url(s) overall for this iteration.")
         Wgit.logger.info("Found and saved #{urls_count} external url(s) for \
 the next iteration.")
 
@@ -136,8 +136,8 @@ the next iteration.")
         Wgit.logger.info("Found and saved #{num_inserted_urls} external url(s)")
       end
 
-      Wgit.logger.info("Crawled and indexed #{total_pages_indexed} docs for \
-the site: #{url}")
+      Wgit.logger.info("Crawled and indexed #{total_pages_indexed} documents \
+for the site: #{url}")
 
       total_pages_indexed
     end

data/lib/wgit/version.rb

@@ -6,7 +6,7 @@
 # @author Michael Telford
 module Wgit
   # The current gem version of Wgit.
-  VERSION = '0.10.1'
+  VERSION = '0.10.2'
 
   # Returns the current gem version of Wgit as a String.
   def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wgit
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Michael Telford
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable