cmu-web-qrnegie 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62151d8825df8d5c06ae141cc9242f77f7a24b856d52381bf2e30aeaafad7f4a
+  data.tar.gz: 49c124b273f30a61721f332c562630a5f6fd07bd301e383ea6eef458bed18012
+SHA512:
+  metadata.gz: dc09d931ec78bb4b6aaf20e93fa3cdbdbd9f28fec6a05dcadcc4a38e9688ca401f537825431c05f983c68ef037ab6f755ec52b254b5869e915934de4f29d31e2
+  data.tar.gz: 39bfe2b7f91e40e33010d68ba65267bd120e00a6080fd56b3b2d3c7c1fed7bd319238a5c81e2936ce2bfd21343a20a2bee997ab72cc1836f1cbcd8ba309a0246

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Carnegie Mellon University
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,72 @@
+# QRnegie for Ruby and Rails
+
+QR codes from [QRnegie](https://qrnegie.andrew.cmu.edu/) in Ruby code and
+Rails views, in Carnegie Mellon styles, as SVG or PNG. The gem only builds
+image addresses: QRnegie draws each code when someone loads it, and the gem
+never calls the service itself.
+
+The gem lives in the QRnegie repository's `packages/ruby/`. Each QRnegie
+release publishes it at the same version.
+
+## Install
+
+```ruby
+gem 'cmu-web-qrnegie', '~> 0.3'
+```
+
+## In Rails Views
+
+Rails views get `qrnegie_tag`. It takes the text or link to encode, alt
+text and QRnegie's options; anything else goes to `image_tag`:
+
+```erb
+<%= qrnegie_tag 'https://www.cmu.edu/', alt: 'QR code for cmu.edu' %>
+<%= qrnegie_tag event_url(@event), alt: 'QR code for this event', style: :mosaic, width: 1024 %>
+<%= qrnegie_tag 'https://www.cmu.edu/', alt: 'QR code for cmu.edu', below: 'Scan Me', class: 'qr' %>
+```
+
+Alt text is required. Say where the code goes, not that it's a QR code
+alone.
+
+## In Ruby
+
+```ruby
+require 'cmu-web-qrnegie'
+
+QRnegie.url('https://www.cmu.edu/')
+QRnegie.url('https://www.cmu.edu/', style: 'kraus-campo', width: 1024, format: :png)
+QRnegie.url('https://www.cmu.edu/', style: :icon, icon: 'calendar-event')
+```
+
+## Options
+
+| Option             | Gives                                                                        |
+| ------------------ | ---------------------------------------------------------------------------- |
+| `style:`           | A style from QRnegie's Styles page, e.g., `mosaic`; Basic Scotty if left out |
+| `width:`           | The image's width in pixels, up to 2048; 512 if left out                     |
+| `above:`, `below:` | A line of text above or below the code, up to 40 characters each             |
+| `icon:`            | Center Icon's icon, a Bootstrap Icons name such as `wifi`                    |
+| `format:`          | `:svg` (the default) or `:png`                                               |
+
+The gem checks the text, width, lines and format; QRnegie checks the rest
+and explains any address it can't draw. The
+[Styles](https://qrnegie.andrew.cmu.edu/styles.html) and
+[Reference](https://qrnegie.andrew.cmu.edu/reference.html) pages list every
+style and the smallest width each one takes. Detailed styles start at 1024.
+
+To point at a local copy of QRnegie, set the host once:
+
+```ruby
+QRnegie.host = 'http://127.0.0.1:3000'
+```
+
+## Work on the Gem
+
+```bash
+cd packages/ruby
+bundle install
+bundle exec rake test build
+```
+
+`rake version` copies the app's license and its version from
+`package.json` into the gem; `rake clean` removes them and the build.

data/VERSION

@@ -0,0 +1 @@
+0.3.2

data/lib/cmu-web-qrnegie.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'qrnegie'

data/lib/qrnegie/helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module QRnegie
+  # A view helper for Rails, included in every view by the Railtie
+  module Helper
+    OPTIONS = %i[style width above below icon format].freeze
+
+    # <%= qrnegie_tag 'https://www.cmu.edu/', alt: 'QR code for cmu.edu', style: :mosaic %>
+    # Takes QRnegie's options, and image_tag's for everything else. Alt text
+    # is required; say where the code goes.
+    def qrnegie_tag(text, alt:, **options)
+      code = options.slice(*OPTIONS)
+      html = options.except(*OPTIONS)
+      # Text above or below makes the image taller, so only the width is known
+      image_tag(QRnegie.url(text, **code), alt: alt, width: code.fetch(:width, 512), **html)
+    end
+  end
+end

data/lib/qrnegie/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module QRnegie
+  # Makes qrnegie_tag available in Rails views
+  class Railtie < ::Rails::Railtie
+    initializer 'qrnegie.helper' do
+      ActiveSupport.on_load(:action_view) { include QRnegie::Helper }
+    end
+  end
+end

data/lib/qrnegie/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module QRnegie
+  GEM_ROOT = File.expand_path('../..', __dir__)
+  # A built gem carries a VERSION file (rake version); a checkout reads the
+  # app's package.json, so the gem and the app share one version
+  VERSION = if File.file?(File.join(GEM_ROOT, 'VERSION'))
+              File.read(File.join(GEM_ROOT, 'VERSION')).strip
+            else
+              JSON.parse(File.read(File.expand_path('../../package.json', GEM_ROOT))).fetch('version')
+            end.freeze
+end

data/lib/qrnegie.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'uri'
+require_relative 'qrnegie/version'
+
+# Addresses for QRnegie's QR code images (https://qrnegie.andrew.cmu.edu/).
+# Only builds URLs; it never calls the service, which draws each code when
+# it's requested and checks the options itself.
+module QRnegie
+  # The longest text a code holds, in UTF-8 bytes, and the longest line of
+  # text above or below it, in characters
+  TEXT_LIMIT = 1024
+  LABEL_LIMIT = 40
+  MAX = 2048
+  FORMATS = %i[svg png].freeze
+
+  class << self
+    # The service the addresses point to; set it for a local copy
+    attr_writer :host
+
+    def host
+      @host || 'https://qrnegie.andrew.cmu.edu'
+    end
+
+    # QRnegie.url('https://www.cmu.edu/', style: :mosaic, width: 1024)
+    # QRnegie.url('https://www.cmu.edu/', below: 'Scan Me', format: :png)
+    # Left out, the style is Basic Scotty and the width 512 pixels.
+    def url(text, style: nil, width: nil, above: nil, below: nil, icon: nil, format: :svg)
+      check(text, width, above, below, format)
+      query = { text: text, style: style, width: width, above: above, below: below, icon: icon }
+              .reject { |_, value| value.nil? || value.to_s.strip.empty? }
+      "#{host.chomp('/')}/qr.#{format}?#{URI.encode_www_form(query)}"
+    end
+
+    private
+
+    def check(text, width, above, below, format)
+      if text.to_s.strip.empty? || text.to_s.bytesize > TEXT_LIMIT
+        raise ArgumentError, "QRnegie text must have 1 to #{TEXT_LIMIT} UTF-8 bytes"
+      end
+      if width && !(width.is_a?(Integer) && width.between?(1, MAX))
+        raise ArgumentError, "QRnegie widths are whole numbers up to #{MAX}, not #{width.inspect}"
+      end
+      if [above, below].any? { |line| line.to_s.length > LABEL_LIMIT }
+        raise ArgumentError, "Keep QRnegie text above or below the code to #{LABEL_LIMIT} characters"
+      end
+      return if FORMATS.include?(format&.to_sym)
+
+      raise ArgumentError, "QRnegie format must be one of #{FORMATS.join(', ')}"
+    end
+  end
+end
+
+require_relative 'qrnegie/helper'
+require_relative 'qrnegie/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: cmu-web-qrnegie
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Carnegie Mellon University
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Builds addresses for QRnegie, which draws QR codes in Carnegie Mellon
+  styles as SVG or PNG. Includes a Rails view helper.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- lib/cmu-web-qrnegie.rb
+- lib/qrnegie.rb
+- lib/qrnegie/helper.rb
+- lib/qrnegie/railtie.rb
+- lib/qrnegie/version.rb
+homepage: https://qrnegie.andrew.cmu.edu/
+licenses:
+- BSD-3-Clause
+metadata:
+  source_code_uri: https://github.com/cmu-web/cmu-web-qrnegie
+  documentation_uri: https://github.com/cmu-web/cmu-web-qrnegie/tree/main/packages/ruby#readme
+  bug_tracker_uri: https://github.com/cmu-web/cmu-web-qrnegie/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: QR code image addresses from QRnegie, for Ruby and Rails
+test_files: []