wayfarer 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102ad4ff568c6a84fb710cbb46f3ca4839ce6a319265d33953f5ed601038d95d
-  data.tar.gz: 22f2f2460eb814a5534567cfc4222663d5819739df76e8c07bd0e5add4de15ec
+  metadata.gz: 39fd7cefe2a4a7e07e2c3f69c0d13f96603e983432c56616444407a04af55442
+  data.tar.gz: 465b842759a03128413d66ff59b5116f0f7d444b193ad0929ed3a3914f55d5ad
 SHA512:
-  metadata.gz: 7c3c4780264a54b3ffc3b885027affb00d041c7d0d828435987d71d19cdaba03d69a03dda645901abfa59ab8f5b4f702dd85722fec87efb36a08d304a903296b
-  data.tar.gz: e05ab817b1125ebc8b644b79ec63e18fce3566ffdf4508e6409d5e8669a060b0bbd88e30a782db7f6abc9555198e1919fbb0feda4d9b75aba8f5b8823592c294
+  metadata.gz: 21111b9d58ab7d0286f2f0a8c575485f0553cc4ddb8f19ebcad9f82f67e70dd53290832de6a4da137839a22151f0d06a47b0c606bc139b1491c5ce3d2accf188
+  data.tar.gz: '049cc40ee6973ecc66ce921d1ca8bf746ae9066ef88ebe3a364a0b859d125d9857daba149dfffd0b630f9addf88d2330ca3f9de5e57dab521d1dc2908a1d5cde'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wayfarer (0.4.9)
+    wayfarer (0.4.10)
       activejob (>= 7.1)
       addressable (~> 2.8)
       capybara (~> 3.4)

data/docs/guides/development.md

@@ -2,21 +2,11 @@
 
 ## Release Procedure
 
-1. Ensure `Wayfarer::VERSION` was bumped appropriately.
-2. Ensure the version in wayfarer.gemspec matches.
-3. Open a release Pull Request develop -> master branch
-4. Merge the Pull Request
-5. Publish RubyGem and git tag as follows:
-
-```
-git checkout master
-git pull origin master --rebase
-bundle exec rake build
-gem push build/wayfarer-*.gem
-bundle exec rake clean
-git tag <VERSION>
-git push origin <VERSION>
-```
+1. Bump versions:
+  * `Wayfarer::VERSION` in `lib/wayfarer.rb`
+  * RubyGem version in `wayfarer.gemspec`
+  * Run `bundle install` to regenerate `Gemfile.lock`
+2. Push to `master` or `develop` and run the manual `release` worflow
 
 ## Conventions and guidelines
 
@@ -27,10 +17,11 @@ git push origin <VERSION>
 
 ### Navigate the web along URL patterns
 
-URLs are less prone to change than served markup.
-One reason for this is that changes to a URL's path can have negative
-consequences for its page ranking in search engines. Websites naturally implement
-architectural URL patterns like REST or expose surrogate keys.
+URLs are less prone to change than served markup. There are also SEO
+incentives to keep their paths stable. Since websites naturally implement
+architectural URL patterns like REST on the application layer, URL structure
+reflects internal domain concepts necessarily, for which Wayfarer's URL-based
+routing is designed.
 
 ### Follow URLs verbatim as they appear in responses
 
@@ -49,17 +40,18 @@ is ephemeral.
 
 There are two core features that depend on Redis. First, per-batch acylicity is
 achieved by maintaining the set of processed URLs per batch in Redis.
-There's no option to follow links in a cyclic manner. Second, batch completion
-requires updating an integer value in Redis, and batch completion is a very
-useful feature, since most crawls should end eventually, and often you want to
-know when.
+There's no configuration option to follow links in a cyclic manner. Second,
+batch completion requires updating an integer value in Redis, and batch completion
+is a very useful feature, since most crawls should end eventually, and often you want
+to know when.
 
 ### No configuration files
 
-Wayfarer can be configured through `Wayfarer.config` only, because `Wayfarer.config`
-may contain Ruby objects that don't de/serialize well, such as `Proc`s or `Set`s.
+Wayfarer can be configured through `Wayfarer.config` in Ruby code only,
+because `Wayfarer.config` may contain Ruby objects that don't de/serialize well,
+such as `Proc`s or `Set`s.
 
-### Features out of scope
+### Other features that are out of scope
 
 Wayfarer won't provide:
 

data/docs/guides/tutorial.md

@@ -62,5 +62,4 @@ bundle exec wayfarer perform -r dummy_job.rb DummyJob https://example.com
 If you don't provide a batch, Wayfarer uses a generated UUID instead.
 We could have also used `DummyJob.crawl
 
-
-
+(To be continued.)

data/lib/wayfarer/cli.rb

@@ -13,6 +13,13 @@ module Wayfarer
 
     class_option :require, aliases: :r, type: :string, default: nil
 
+    class_option :log_level,
+                 aliases: :l,
+                 type: :string,
+                 desc: "Set the log level (debug, info, warn, error, fatal).",
+                 enum: %w[debug info warn error fatal unknown],
+                 default: "info"
+
     desc "route JOB URL", "Routing tree for URL for JOB"
     option :format, type: :string, enum: %w[yaml json ruby], default: "yaml"
     def route(job, url)
@@ -84,6 +91,8 @@ module Wayfarer
       require File.join(Dir.pwd, require_path) if require_path
 
       load_rails
+
+      set_log_level
     end
 
     def load_rails
@@ -99,5 +108,12 @@ module Wayfarer
       require File.expand_path("config/boot", Dir.pwd)
       require File.expand_path("config/environment", Dir.pwd)
     end
+
+    def set_log_level
+      level = options[:log_level] || return
+      severity = ActiveSupport::Logger::Severity.const_get(level.upcase)
+
+      Wayfarer::Logging.logger.level = severity
+    end
   end
 end

data/lib/wayfarer/logging.rb

@@ -2,7 +2,7 @@
 
 module Wayfarer
   module Logging
-    mattr_accessor :logger, default: ActiveSupport::Logger.new($stdout)
+    mattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout))
 
     def self.emit(...)
       Emitter.new(...)
@@ -23,9 +23,8 @@ module Wayfarer
             level, msg = messages[key] || raise(ArgumentError, "No log message for #{key.inspect}")
             severity = ActiveSupport::Logger::Severity.const_get(level.upcase)
 
-            ActiveSupport::TaggedLogging
-              .new(Logging.logger)
-              .tagged(task.batch, task.url, task[:controller]&.class&.name) do |logger|
+            Logging.logger
+                   .tagged(task.batch, task.url, task[:controller]&.class&.name) do |logger|
               logger.add(severity, msg % args)
             end
           end

data/lib/wayfarer.rb

@@ -41,7 +41,7 @@ module Wayfarer
   module VERSION
     MAJOR = 0
     MINOR = 4
-    TINY = 9
+    TINY = 10
     STRING = [MAJOR, MINOR, TINY].join(".")
   end
 

data/spec/spec_helpers.rb

@@ -61,7 +61,7 @@ RSpec.configure do |config|
   config.include_context "with Redis", :redis
 
   config.before :suite do
-    Wayfarer::Logging.logger = Logger.new($stdout)
+    Wayfarer::Logging.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout))
 
     FactoryBot.find_definitions
     FactoryBot::SyntaxRunner.include(SpecHelpers)

data/wayfarer.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "wayfarer"
-  s.version = "0.4.9"
+  s.version = "0.4.10"
   s.license = "MIT"
 
   s.homepage = "http://github.com/bauerd/wayfarer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wayfarer
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - Dominic Bauer