qr_forge 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39cc8a8482cee2898925eab861d71d2a96e778d61d34e3e3e6d2774f8ec3fa95
-  data.tar.gz: d217725f654c5b08ee9e7addb7d04f04a8b7e9495b2809210c5ead98e933deb2
+  metadata.gz: 68e6f3102dc3d6954c036f6bfb17a2820743956eea34b7ef11565f173cab0a9a
+  data.tar.gz: e3d5a5c12559c0cf707537ce5163d10717e0f1c18a39130cfb5ba940bc71647d
 SHA512:
-  metadata.gz: cc85e4a4f63070f81e69d2a7c715b17a9fccb5dd19469a4a72dd37ebfb40245b073b79e2a35357b5b0edfb73ca812f32be6651cf7afb496fc0af419093b87c9e
-  data.tar.gz: 48a38d7344bdc09748a0bd546a3466f4e403a90611ef85d40c6f9418cbf569f18b7c797d4dae346e8b192d14ed6ae836020bceddc51a855e1dc700b2dfa70540
+  metadata.gz: 33ba1ce62ea6a782dcc019c72f4c94f487c0ea49847485ae888fc9729b27a710741a5a6d5a771113f1617bbec52ba8e5a9d007b9dfc83ac574b08a7c6031c42a
+  data.tar.gz: 1f245ef3f6a10dadc97c8eb60d8d74e27aeff4f0258c0cf84989e39c85179c4fe027a1c204f0ef2df838c100b9039feb34d3712a373d986816a579735a09f371

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 3.1
+  NewCops: enable
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -17,4 +18,7 @@ Metrics/ParameterLists:
   Max: 10
 
 Metrics/BlockLength:
-  Max: 150
+  Max: 150
+
+Metrics/ClassLength:
+  Max: 500

data/README.md

@@ -1,5 +1,4 @@
-# !! Docs are still being written !! #
-![output](https://github.com/user-attachments/assets/71edb1aa-2182-4cd3-bb28-ec4f71336029)
+![output](https://github.com/user-attachments/assets/6d360bbb-511d-43f4-a356-8adf634efac0)
 
 An example of the output of QR Forge
 
@@ -19,177 +18,160 @@ or if using bundler
 bundle add qr_forge
 ```
 
-Note: To export in the PNG format you will also want to install vips on your machine
-
-```shell
-brew install vips
-```
-
 # Usage
 
 To create a QR Code you can simply do the following:
 
+### Payloads
+
+Did you know that QR Codes can store different pieces of data such as wifi access, passkeys, geolocation and quite a few more! Below are a few different types of data payloads that are implemented with in the gem. More will be added as needed.
+
+#### Plain text
+
 ```ruby
-QrForge::Forge.build(text: "https://yourlinkhere.com")
+QrForge::Forge.build(data: "https://yourlinkhere.com", type: :plain)
 ```
 
-If you want an (SVG) QRCode fast, that's all there is to it. Everything else is covered by default values, however, you can tweak anything you want, which we will go through in the next section.
+#### URL
 
-## Configuration
+```ruby
+QrForge::Forge.build(data: "https://yourlinkhere.com", type: :url)
+```
 
-The library tries to provide sensible defaults, but defaults can be subjective, so the following shows a configuration object that you can pass to the QR Code.
+#### Wifi
 
 ```ruby
-QrForge::Forge.build(
-  text: "https://www.google.com",
-  config: {
-    qr: { version: 10 },
-    components: { inner_eye: QrForge::Components::EyeInner::Square },
-    design: {
-      size: 800,
-      colors: { module: 'blue', outer_eye: 'cyan', inner_eye: 'skyblue' },
-      image: Base64.strict_encode64(...)
-    },
-    output: { format: :png }
-  }
-)
+QrForge::Payload.build(data: { ssid: "MyNetwork", password: "MyPassword", encryption: "WPA" }, type: :wifi)
 ```
+Fields: 
+- ssid,
+- password
+- encryption (WEP WPA WPA2 WPA3)
+- hidden (true/false)
 
-##### QR
+>[!NOTE]
+>You can also pass "nopass" to encryption which means a password does not need to be provided either (public wifi etc.)
+
+#### Geo/Coordinates
 
-This hash provides details to the underlying QR code generator (see: https://github.com/whomwah/rqrcode_core).
+```ruby
+QrForge::Payload.build(data: { latitude: 40.712776, longitude: -74.005974 }, type: :geo)
+```
+Fields:
+- latitude
+- longitude
 
-_version_ dictates the module count or size of the QR Code and how much data it can hold. It does not necessarily dictate the dimensions, however, it will be unreadable if you choose too small of a size, but a larger QR code version. (see: https://www.qrcode.com/en/about/version.html)
+#### Phone number
 
-##### Components
+```ruby
+QrForge::Payload.build(data: "+1234567890", type: :phone)
+QrForge::Payload.build(data: "1234567890", type: :phone)
+QrForge::Payload.build(data: "123-456-7890", type: :phone)
+QrForge::Payload.build(data: "(123) 456-7890", type: :phone)
+QrForge::Payload.build(data: "123.456.7890", type: :phone)
+```
 
-This hash can have up to 3 components:
-- outer_eye
-<img width="77" alt="Screenshot 2025-06-17 at 1 23 39 AM" src="https://github.com/user-attachments/assets/ccef3f08-cc4b-43c7-95b4-8d6c707f5f5a" />
+More are planned to be added.
 
-- inner_eye
-<img width="77" alt="Screenshot 2025-06-17 at 1 24 22 AM" src="https://github.com/user-attachments/assets/c21bb175-00c2-4179-a20a-4e505ad37df1" />
+### Design
 
-- module
-<img width="216" alt="Screenshot 2025-06-17 at 1 25 24 AM" src="https://github.com/user-attachments/assets/f670d5fd-e2dc-42cc-9bff-d77a51d65fa1" />
+Design controls the look and feel of the QR Code from the [QR Version](https://www.qrcode.com/en/about/version.html) to the colors of the individual modules.
 
-This is what the circle outer_eye component looks like:
+##### QR
 
 ```ruby
-# frozen_string_literal: true
-
-module QrForge
-  module Components
-    module EyeOuter
-      class Circle < ForgeComponent
-        DEFAULT_STROKE_WIDTH = 1.0
-
-        # @see ForgeComponent#draw
-        # Draws a circle that fills the full 'area' box, inset by half the stroke so it
-        # never overlaps the modules beneath.
-        def draw(y:, x:, quiet_zone:, area:, color: "black", **_)
-          stroke_width = DEFAULT_STROKE_WIDTH
-
-          # Radius = (full width of box – one stroke) / 2
-          r = (area - stroke_width) / 2.0
-
-          # Center of the N×N box (plus quiet_zone offset)
-          cx = x + quiet_zone + (area / 2.0)
-          cy = y + quiet_zone + (area / 2.0)
-
-          @xml_builder.circle(
-            cx: cx,
-            cy: cy,
-            r: r,
-            'stroke-width': stroke_width,
-            stroke: color,
-            fill: "transparent",
-            test_id: @test_id
-          )
-        end
-      end
-    end
-  end
-end
+QrForge::Payload.build(..., design: { qr { version: 10 } }, ...)
 ```
+Fields:
+- Version
+  
+##### Image
 
-And the square for comparison:
+```ruby
+QrForge::Payload.build(..., design: { image: "..." }, ...)
+```
+The image should be a **Base64 encoded** image like the following:
 
 ```ruby
-# frozen_string_literal: true
-
-module QrForge
-  module Components
-    module EyeOuter
-      class Square < ForgeComponent
-        # @see ForgeComponent#draw
-        def draw(y:, x:, quiet_zone:, area:, color: "black", **_)
-          x += quiet_zone
-          y += quiet_zone
-
-          # Draw the outer black square (7x7)
-          @xml_builder.rect(
-            x:,
-            y:,
-            width: area,
-            height: area,
-            fill: color
-          )
-
-          # Draw the inner (cutout) square (5x5) to create the finder pattern
-          inset = 1
-          inner = area - 2
-
-          @xml_builder.rect(
-            x: x + inset,
-            y: y + inset,
-            width: inner,
-            height: inner,
-            fill: color,
-            test_id: @test_id
-          )
-        end
-      end
-    end
-  end
-end
+Base64.strict_encode64(image_png_binary)
 ```
+More image formats will be added as needed or required.
 
-All components must inherit from the base ForgeComponent. You can look at that to see what is available to be used (this is on the roadmap to allow more design variations).
+##### Colors
 
-If you create your own designs, follow the same pattern and pass them into the components config. It will merge them with the default components, so if you only want to change one or two of the components, but not all three, you can!
+```ruby
+QrForge::Payload.build(..., design: {colors: { outer_eye: "#30363D", inner_eye: "#30363D", module: "#484F58" }, ...)
+```
+Fields:
+- outer_eye
+- inner_eye
+- module
+  
+Any hex code or plain color such as "red", "cyan", "peru", etc. will work as the color value.
 
-##### Design
+See the Components section for more details on which field references what component of the QR Code.
 
+### Output
+
+```ruby
+QrForge::Payload.build(..., output: { size: 250 }, ...)
 ```
-size: 800
-```
+Fields:
+- size
+  
+QR Codes are equal in height and width, the size will control the width and height of the returned SVG.
 
-This sets the width and height of the svg. I recommend that you set this to a higher value than you plan to use as the SVG will scale well without needing to use any image processing like vips. If you do want to use your own strategies for image processing, I still recommend a higher size and do with the SVG as you wish.
+There is only an ouput of SVG format, see this PR for reasoning: https://github.com/keegankb93/qr_forge/pull/1
 
-```
-colors: { module: 'blue', outer_eye: 'cyan', inner_eye: 'skyblue' }
-```
+If different formats are a requirement and that requirement means the image conversion should take place in the gem, send me a message with your usecase. SVG as the format should be good for almost all usecases.
 
-This will set the fill or stroke appropriately for the respective component.
+### Components
 
-``` 
-image: ...
+```ruby
+QrForge::Payload.build(..., components: {
+                              outer_eye: QrForge::Components::EyeOuter::Square,
+                              inner_eye: QrForge::Components::EyeInner::Square,
+                              module: QrForge::Components::Module::Squre
+                            },
+                        ...)
 ```
+Fields:
+- outer_eye
+<img width="77" alt="Screenshot 2025-06-17 at 1 23 39 AM" src="https://github.com/user-attachments/assets/ccef3f08-cc4b-43c7-95b4-8d6c707f5f5a" />
 
-A base64 encoded image that will be placed in the center of your QR Code. This scales with the version of the QR Code and is strictly set as to make sure that we do not remove more data that can be recovered through the error correcting algorithms.
+- inner_eye
+<img width="77" alt="Screenshot 2025-06-17 at 1 24 22 AM" src="https://github.com/user-attachments/assets/c21bb175-00c2-4179-a20a-4e505ad37df1" />
 
-##### Output
+- module
+<img width="216" alt="Screenshot 2025-06-17 at 1 25 24 AM" src="https://github.com/user-attachments/assets/f670d5fd-e2dc-42cc-9bff-d77a51d65fa1" />
 
-```
-output: { format: :png }})
-```
+You can create your own designs and pass them through as long as they inherit from the ForgeComponent. If you create your own designs, when you pass them through the config, it will merge them with the default components, so if you only want to change one or two of the components, but not all three, you can!
+
+>[!NOTE]
+>More designs are to come, so not every facet of qr code manipulation may be available at this time such as module look aheads/behinds. This is >coming soon.
+
+### Example
 
-This will use vips to process the svg and return it as a PNG. If you want to do your own image processing, you can leave this off as the default is the raw SVG string.
+This is the code that was used to create the QR Code at the top of the page.
 
+```ruby
+QrForge::Forge.build(data: "https://www.github.com/keegankb93/qr_forge",
+                     type: :url,
+                     config: {
+                       qr: { version: 5 },
+                       design: {
+                         image:,
+                         colors: {
+                           outer_eye: "#30363D",
+                           inner_eye: "#30363D",
+                           module: "#484F58"
+                         }
+                       },
+                       output: { size: 250 }
+                     })
+```
 
-## Roadmap
-- Color gradients for components
-- More data types i.e. wifi, passkey etc.
+### Roadmap
+- Color gradients for outer and inner eyes
 - Image background and shape improvements
 - More default component selections

data/Rakefile

@@ -7,6 +7,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end
 
 task default: %i[spec rubocop]

data/lib/qr_forge/components/eye_outer/circle.rb

@@ -23,7 +23,7 @@ module QrForge
             cx: cx,
             cy: cy,
             r: r,
-            'stroke-width': stroke_width,
+            "stroke-width": stroke_width,
             stroke: color,
             fill: "transparent",
             test_id: @test_id

data/lib/qr_forge/exporter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "vips"
-
 module QrForge
   #
   # Handles exporting the generated QR code in various formats.
@@ -10,12 +8,15 @@ module QrForge
       @format = config.dig(:output, :format) || :svg
     end
 
+    #
+    # Exports the generated QR code in the specified format.
+    # @param svg [String] The generated SVG content of the QR code
+    # @return [String] The exported QR code in the specified format
+    # @raise [RuntimeError] if the format is unsupported
     def export(svg)
       case @format
       when :svg
-        svg
-      when :png
-        as_png(svg)
+        process_svg(svg)
       else
         raise "Unsupported export format: #{@format}"
       end
@@ -24,15 +25,23 @@ module QrForge
     private
 
     #
-    # Exports the SVG to PNG format using Vips.
-    # @param svg [String] The SVG content to convert
-    # @return [StringIO] A StringIO object containing the PNG data
-    def as_png(svg)
-      image = Vips::Image.svgload_buffer(svg)
-      # TODO: Compression doesn't really seem to give much noticeable difference in quality or file size.
-      buffer = image.write_to_buffer(".png")
+    # Performs any last-minute processing on the svg before exporting if applicable
+    # @param [String] svg the preprocessed svg
+    # @return [String] the final svg
+    def process_svg(svg)
+      return svg if ENV["SVG_OUTPUT_MODE"] == "test"
 
-      StringIO.new(buffer)
+      clean(svg)
+    end
+
+    #
+    # Cleans the SVG by removing test_id attributes.
+    # @param svg [String] The generated SVG
+    # @return [String] The cleaned SVG content
+    def clean(svg)
+      doc = Nokogiri::XML(svg)
+      doc.xpath("//@test_id").remove
+      doc.to_xml
     end
   end
 end

data/lib/qr_forge/forge.rb

@@ -20,7 +20,7 @@ module QrForge
     #   - `:qr` - QR code specific settings (e.g., version).
     #   - `:design` - Design specific settings (e.g., colors, shapes).
     #   - `:output` - Export specific settings (e.g., format).
-    # @return [String, StringIO] The SVG or PNG representation of the QR code
+    # @return [String] The SVG or PNG representation of the QR code
     def self.build(data:, type: :url, config: {})
       new(data:, type:, config:).build
     end

data/lib/qr_forge/payload.rb

@@ -5,6 +5,7 @@ module QrForge
   # Payload is a factory class that builds different types of payloads based on the provided type and data.
   # It will validate the payload data (based on the type) and return a string representation of the payload.
   class Payload
+    # TODO: Add passkey and sms support and vcard
     PAYLOAD_TYPES = {
       wifi: ::QrForge::Payloads::Wifi,
       plain: ::QrForge::Payloads::PlainText,

data/lib/qr_forge/payloads/geo.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-puts "[Geo] file loaded"
-
 module QrForge
   module Payloads
     #

data/lib/qr_forge/payloads/phone.rb

@@ -1,4 +1,4 @@
-require 'uri'
+# frozen_string_literal: true
 
 module QrForge
   module Payloads
@@ -6,7 +6,6 @@ module QrForge
     # Represents a telephone payload
     # @example return "https://example.com" or "http://example.com"
     class Phone
-
       def initialize(phone_number)
         @phone_number = phone_number
       end

data/lib/qr_forge/payloads/url.rb

@@ -1,4 +1,6 @@
-require 'uri'
+# frozen_string_literal: true
+
+require "uri"
 
 module QrForge
   module Payloads
@@ -6,7 +8,6 @@ module QrForge
     # Represents a URL payload
     # @example return "https://example.com" or "http://example.com"
     class Url
-
       def initialize(url)
         @url = url
       end

data/lib/qr_forge/payloads.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module QrForge
   module Payloads
     class PayloadValidationError < StandardError; end

data/lib/qr_forge/qr_data.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rqrcode_core/qrcode"
+require "rqrcode_core"
 
 module QrForge
   #
@@ -11,7 +11,7 @@ module QrForge
     attr_reader :modules, :version, :module_count, :quiet_zone
 
     def initialize(text:, version: 10, level: :h)
-      qr = RQRCodeCore::QRCode.new(text, size: version, level: level)
+      qr = ::RQRCodeCore::QRCode.new(text, size: version, level: level)
       @version = qr.version
       @modules = qr.modules.map(&:dup)
       @module_count = @modules.size

data/lib/qr_forge/renderer.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "nokogiri"
-require_relative "layout"
 
 module QrForge
   #
@@ -47,8 +46,7 @@ module QrForge
       @quiet_zone = 4
       @module_count = qr_data.module_count
       @image = config.dig(:design, :image)
-      @width = config.dig(:design, :size)
-      @height = config.dig(:design, :size)
+      @size = config.dig(:output, :size)
       @colors = DEFAULT_COLORS.merge(config.dig(:design, :colors) || {})
       @layout = QrForge::Layout.new(qr_data:, has_image: image_present?)
     end
@@ -58,10 +56,11 @@ module QrForge
     def to_svg
       Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
         xml.svg(
-          width: @width || canvas_size,
-          height: @height || canvas_size,
+          width: @size,
+          height: @size,
           xmlns: "http://www.w3.org/2000/svg",
-          viewBox: "0 0 #{canvas_size} #{canvas_size}"
+          viewBox: "0 0 #{canvas_size} #{canvas_size}",
+          shape_rendering: "crispEdges"
         ) do
           draw_background(xml)
           draw_image(xml)
@@ -98,10 +97,10 @@ module QrForge
     def draw_image(xml)
       return unless image_present? && @qr_data.version >= 2
 
-      image_range = @layout.image_area # a Range (row indices) for the image
+      image_range = @layout.image_area # row indices for the image
       size = image_range.size # width/height in modules
 
-      # Convert module coords → SVG coords (including quiet zone)
+      # Convert module coords to SVG coords (including quiet zone)
       x = image_range.first + @quiet_zone
       y = image_range.first + @quiet_zone
 

data/lib/qr_forge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QrForge
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qr_forge
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Keegankb93
@@ -51,20 +51,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: vips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.15'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.15'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +119,7 @@ metadata:
   homepage_uri: https://github.com/keegankb93/qr_forge
   source_code_uri: https://github.com/keegankb93/qr_forge
   changelog_uri: https://github.com/keegankb93/qr_forge/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib