passing in parameterse to otp_qr_code method?

[benkoshy]

Hi there,

Is it a crazy idea to allow for the passing in of parameters to a delegated method:

https://github.com/jeremyevans/rodauth/blob/master/lib/rodauth/features/otp.rb#L310-L313

    def otp_qr_code(color:  "ffffff")
      svg = RQRCode::QRCode.new(otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true, color: color)
      svg.sub(/\A<\?xml version="1\.0" standalone="yes"\?>/, '')
    end

Context: Dark Mode

I wish to change the fill / colors of the QR code, for users who are using Dark Mode.

Current Solution

Is to just re-implement the method in the view, and pass in what I need to.

<%== RQRCode::QRCode.new(rodauth.otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true, color: "ffffff") %>

[jeremyevans]

Adding arguments to the method (even optional arguments) cannot done without breaking backwards compatibility. We could consider adding a method to specify the color to use, so you only need to override that method to change the color.

[benkoshy]

Can you provide a short diff?

The diff will be implicit in below:

If no explicit default values are provided:

<div class="dark">
       <p><%== rodauth.otp_qr_code %></p>
</div>

Then this is the result (Cameras will have a hard time scanning this code):

However, if I pass in some sensible defaults, this is the result:

<div class="dark">
   <%== RQRCode::QRCode.new(rodauth.otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true, color: "ffffff", fill: "#000000") %> 
</div>

Cameras would have a much easier time recognising the above.

The problem is essentially "solved" if we explicitly specify a white / black background and foreground color (which was what we originally had) + this has the the added advantage of it just 'working' in "dark" mode.

Please let me know if you need further info / or a working example, or otherwise etc.

[jeremyevans]

So in the form of a short diff, what you are requesting is?:

diff --git a/lib/rodauth/features/otp.rb b/lib/rodauth/features/otp.rb
index 4aad932..de36bd1 100644
--- a/lib/rodauth/features/otp.rb
+++ b/lib/rodauth/features/otp.rb
@@ -308,7 +308,7 @@ module Rodauth
     end
 
     def otp_qr_code
-      svg = RQRCode::QRCode.new(otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true)
+      svg = RQRCode::QRCode.new(otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true, :color => "fff", :fill => "#000000")
       svg.sub(/\A<\?xml version="1\.0" standalone="yes"\?>/, '')
     end
 

Basically, rqrcode uses a black foreground and transparent background by default, and that causes a problem in dark mode where the background is dark.

Personally, I don't like the color being flipped, but I would be OK specifying fill: '#fff', so that the background is white instead of transparent. Would this work for you?:

diff --git a/lib/rodauth/features/otp.rb b/lib/rodauth/features/otp.rb
index 4aad932..21c4f2c 100644
--- a/lib/rodauth/features/otp.rb
+++ b/lib/rodauth/features/otp.rb
@@ -308,7 +308,7 @@ module Rodauth
     end
 
     def otp_qr_code
-      svg = RQRCode::QRCode.new(otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true)
+      svg = RQRCode::QRCode.new(otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true, fill: "#fff")
       svg.sub(/\A<\?xml version="1\.0" standalone="yes"\?>/, '')
     end
 

[benkoshy]

Personally, I don't like the color being flipped, but I would be OK specifying fill: '#fff', so that the background is white instead of transparent. Would this work for you?:

yes you got it perfectly. I forget which key it was (whether "fill" or "color) - but that aside, we have a perfect meeting of the minds.

I raise this issue mainly for the benefit of the community and leave it to your absolute discretion whether the proposal has merit or should be discarded.

[jeremyevans]

Adding the fill option seems fine, I'll push a commit for it shortly.

[benkoshy]

... I'll push a commit for it shortly.

I do not propose to increase burdens on maintainers, I could made a PR myself.

Thank you for your work on this (and other) gems.