mr_common 1.3.0 → 2.0.0

data/app/models/mr_common/csv_renderer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module MrCommon
+  # Renders collections of objects to a CSV string.
+  #
+  # @param collection [Enumerable<Object>] a collection of objects.
+  # @param fields [Array<String, Symbol>] fields to use as columns in the CSV.
+  #   It is expected that each item responds to each field if sent as a message.
+  # @param decorator [SimpleDelegator, nil] optional wrapper class used to
+  #   generate values for CSV rows when items in the collection don't respond to
+  #   every field provided.
+  class CSVRenderer
+    attr_reader :collection, :decorator, :fields
+
+    def initialize(collection: [], fields: [], decorator: nil)
+      @collection = collection
+      @decorator = decorator
+      @fields = fields.map(&:to_sym)
+    end
+
+    # Renders the provided collection to a CSV string.
+    #
+    # @return [String] the CSV file contents
+    def render
+      CSV.generate do |csv|
+        csv << fields
+
+        collection.each do |item|
+          item = decorator ? decorator.new(item) : item
+          row = fields.map { |field_name| item.try(field_name) }
+          csv << row
+        end
+      end
+    end
+  end
+end

data/app/models/mr_common/pattern.rb

@@ -1,11 +1,21 @@
 # frozen_string_literal: true
 
 module MrCommon
+  # Common regex patterns
   class Pattern
     class << self
+      # Matches valid email addresses. Ensures that the @ symbol is
+      # preceded by something resembling a username and followed by something
+      # resembling a domain name.
       def email
         /\A\S+@\S+\.\S+\z/
       end
+
+      # Matches most phone numbers a person could enter. Tests for at least 7 of
+      # the characters that can appear in a phone number.
+      def phone_number
+        /[\d()\\x+\- ]{7,}/
+      end
     end
   end
 end

data/app/models/mr_common/pre_registration.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module MrCommon
+  # When MrCommon.enable_pre_registration is true newly created Registrations
+  # will be checked against existing PreRegistrations. If a PreRegistration is
+  # found the Registration will be confirmed automatically.
+  #
+  # A PreRegistration requires a first+last name OR an email to be valid.
+  class PreRegistration < ApplicationRecord
+    validates :email, presence: true, format: MrCommon::Pattern.email, if: :should_validate_email?
+    validates :first_name, presence: true, if: :should_validate_name?
+    validates :last_name, presence: true, if: :should_validate_name?
+    validates :normalized_name, presence: true, if: :should_validate_name?
+
+    before_validation :normalize_email
+    before_validation :set_normalized_name
+
+    def self.exists_for?(registration)
+      email = registration.email&.downcase
+      name = normalized_name_from(registration).presence
+
+      exists_for_email = email.present? ? exists?(email: email) : false
+      exists_for_name = name.present? ? exists?(normalized_name: name) : false
+      exists_for_email || exists_for_name
+    end
+
+    private
+
+      def self.normalized_name_from(registration_or_self)
+        first = registration_or_self.first_name.downcase.gsub(/\W+/, "-")
+        last = registration_or_self.last_name.downcase.gsub(/\W+/, "-")
+        spacer = first.present? && last.present? ? "-" : ""
+        "#{first}#{spacer}#{last}"
+      end
+
+      def should_validate_email?
+        first_name.blank? && last_name.blank?
+      end
+
+      def should_validate_name?
+        email.blank?
+      end
+
+      def set_normalized_name
+        self.normalized_name = PreRegistration.normalized_name_from(self)
+      end
+
+      def normalize_email
+        self.email = email.downcase
+      end
+  end
+end

data/app/models/mr_common/pre_registration_importer.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module MrCommon
+  # Imports PreRegistration records from a CSV file that looks like:
+  #
+  #   first_name, last_name, email
+  #   John, Smith, jsmith@example.com
+  #   Jane, Doe, jdoe@example.com
+  #   ,,unknown@example.com
+  #   Name,Only,
+  #
+  # @author Corey Smedstad <csmedstad@mreach.com>
+  class PreRegistrationImporter
+    RowStruct = Struct.new(:first_name, :last_name, :email) do
+      # Returns true if the row does not represent a duplicate PreRegistration
+      # @return [Boolean]
+      def new?
+        !PreRegistration.exists_for?(self)
+      end
+    end
+
+    ResultStruct = Struct.new(:created, :skipped)
+
+    attr_reader :csv, :current_row, :result
+
+    # @param csv [String] a the contents of a CSV file
+    def initialize(csv)
+      @csv = csv
+      @created = 0
+      @skipped = 0
+    end
+
+    # Attempts to create PreRegistration records for each row in the CSV
+    # recording the number of created and skipped records in the process.
+    #
+    # The result is memoized to prevent double imports.
+    #
+    # @returns [ResultStruct] the result of the import
+    def import
+      @result ||= perform_import
+    end
+
+    private
+
+      def perform_import
+        PreRegistration.transaction do
+          rows.each do |data|
+            load_row(data)
+
+            if current_row.new?
+              make_pre_registration
+            else
+              skip_pre_registration
+            end
+          end
+        end
+
+        ResultStruct.new(@created, @skipped)
+      end
+
+      def rows
+        CSV.parse(csv, headers: true)
+      end
+
+      def load_row(data)
+        first_name = data[0] || ""
+        last_name = data[1] || ""
+        email = data[2] || ""
+
+        @current_row = RowStruct.new(first_name, last_name, email)
+      end
+
+      def make_pre_registration
+        pre_registration = PreRegistration.new(
+          first_name: current_row.first_name,
+          last_name: current_row.last_name,
+          email: current_row.email
+        )
+
+        if pre_registration.save
+          @created += 1
+        else
+          skip_pre_registration
+        end
+      end
+
+      def skip_pre_registration
+        @skipped += 1
+      end
+  end
+end

data/app/models/mr_common/registration.rb

@@ -8,11 +8,20 @@ module MrCommon
 
     validates :first_name, presence: true
     validates :last_name, presence: true
-    validates :email, presence: true
+    validates :email, presence: true, format: Pattern.email
     validates :company_name, presence: true
-    validates :telephone, presence: true
+    validates :telephone, presence: true, format: Pattern.phone_number
     validates :job_title, presence: true
     validates :contact_via_email, inclusion: [true, false]
     validates :contact_via_phone, inclusion: [true, false]
+
+    validate :telephone_length
+
+    private
+
+      def telephone_length
+        digits = telephone.gsub(/\D+/, "")
+        errors.add(:telephone, "must be longer") if digits.length < 7
+      end
   end
 end

data/app/models/mr_common/registration_decorator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MrCommon
+  # Implements custom field values when exporting Registration records as CSV.
+  class RegistrationDecorator < SimpleDelegator
+    def preregistered?
+      __getobj__.preregistered? ? "YES" : "NO"
+    end
+
+    def confirmed?
+      __getobj__.confirmed? ? "YES" : "NO"
+    end
+
+    if MrCommon.registration_confirmation_strategy == :pre_register
+      def pre_registered?
+        PreRegistration.exists_for?(__getobj__) ? "YES" : "NO"
+      end
+    end
+  end
+end

data/app/models/mr_common/reminder.rb

@@ -3,6 +3,10 @@
 require_dependency "mr_common/application_record"
 
 module MrCommon
+  # Stores information for generating downloadable calendar reminders that
+  # appear in some emails.
+  #
+  # When
   class Reminder < ApplicationRecord
     validates :start_time, presence: true
     validates :end_time, presence: true
@@ -15,6 +19,8 @@ module MrCommon
 
     before_validation :parameterize_slug
 
+    scope :for_confirmed_notice, -> { where(include_in_confirmation_mailer: true) }
+
     def to_ical
       cal = Icalendar::Calendar.new
 

data/app/models/mr_common/timezone.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
 module MrCommon
+  # Helper class for building time zone select options. Pares down the list by
+  # grouping locations that share ones or offsets.
   class Timezone
     class << self
+      # @return [Array<String>] list of time zone names ordered by offset
       def time_zone_options
         filtered_time_zones.collect(&:name)
       end
 
+      # @return [Array<Array<String, String>>] list of label value pairs for
+      #   building time zone select options ordered by offset.
       def time_zone_select_options
         filtered_time_zones.collect do |tz|
           ["(UTC#{tz_utc_offset(tz)}) #{tz_friendly_name(tz)}", tz.name]

data/app/views/layouts/mr_common/_navigation.html.erb

@@ -13,6 +13,13 @@
       <li>
         <%= link_to 'Reminders', reminders_path %>
       </li>
+
+      <% if MrCommon.registration_confirmation_strategy == :pre_register %>
+        <li>
+          <%= link_to 'PreRegistrations', pre_registrations_path %>
+        </li>
+      <% end %>
+
       <% if MrCommon.authentication_method_name.present? %>
         <li>
           <%= link_to 'Log Out', main_app.send(MrCommon.logout_path_helper), method: MrCommon.logout_path_method %>

data/app/views/mr_common/pre_registrations/import/new.html.erb

@@ -0,0 +1,27 @@
+<div class="row">
+  <div class="col">
+    <h1>Import Pre Registrations</h1>
+    <%= form_with scope: :import, url: pre_registrations_import_index_url, local: true do |f| %>
+      <fieldset>
+        <legend>Import</legend>
+        <div class="form-group">
+          <%= f.label :csv_file, "CSV File" %>
+          <%= f.file_field :csv_file, required: true, accept: "text/csv" %>
+        </div>
+        <p>The CSV file should be formatted like this example:</p>
+        <pre>
+first_name, last_name, email
+John, Smith, jsmith@example.com
+Jane, Doe, jdoe@example.com
+,,unknown@example.com
+Name,Only,
+      </pre>
+        <p>If you have a spreadsheet with these columns, "Save as..." and choose the CSV as the file type.</p>
+        <p>It is assumed that your CSV has column headings. The first non-empty row will be ignored.</p>
+      </fieldset>
+
+      <%= f.submit "Import" %>
+      <%= link_to "Cancel", pre_registrations_path, class: 'button-secondary' %>
+    <% end %>
+  </div>
+</div>

data/app/views/mr_common/pre_registrations/pre_registrations/_form.html.erb

@@ -0,0 +1,29 @@
+<%= form_with model: @pre_registration, local: true do |f| %>
+  <fieldset>
+    <legend>Pre-registration details</legend>
+    <%= f.form_group :email do %>
+      <%= f.label :email %>
+      <%= f.text_field :email %>
+      <%= f.errors :email %>
+    <% end %>
+
+    <%= f.form_group :first_name do %>
+      <%= f.label :first_name %>
+      <%= f.text_field :first_name %>
+      <%= f.errors :first_name %>
+    <% end %>
+
+    <%= f.form_group :last_name do %>
+      <%= f.label :last_name %>
+      <%= f.text_field :last_name %>
+      <%= f.errors :last_name %>
+    <% end %>
+  </fieldset>
+
+  <%= f.submit "Save" %>
+  <% if @pre_registration.new_record? %>
+    <%= link_to "Cancel", pre_registrations_path, class: 'button-secondary' %>
+  <% else %>
+    <%= link_to "Cancel", pre_registration_path(@pre_registration), class: 'button-secondary' %>
+  <% end %>
+<% end %>

data/app/views/mr_common/pre_registrations/pre_registrations/index.html.erb

@@ -0,0 +1,32 @@
+<div class="row">
+  <div class="col">
+    <h1>PreRegistrations</h1>
+    <p>
+      <%= link_to 'New', new_pre_registration_path, class: 'button' %>
+    </p>
+  </div>
+</div>
+<div class="row">
+  <div class="col">
+    <table>
+      <thead>
+        <tr>
+          <th>Email</th>
+          <th>First</th>
+          <th>Last</th>
+          <th>Actions</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @pre_registration.each do |r| %>
+          <tr>
+            <td><%= r.email %></td>
+            <td><%= r.first_name %></td>
+            <td><%= r.last_name %></td>
+            <td><%= link_to 'Delete', r, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/{lib/generators/mr_common/views/templates/mr_common/registrations/public → app/views/mr_common/pre_registrations/pre_registrations}/new.html.erb

@@ -1,6 +1,7 @@
 <div class="row">
   <div class="col">
-    <h1>New Registration</h1>
+
+    <h1>New PreRegistration</h1>
     <%= render 'form' %>
   </div>
 </div>

data/{lib/generators/mr_common/views/templates/mr_common/registration_mailer/confirmation.html.erb → app/views/mr_common/registration_mailer/confirmed_registration.html.erb}

@@ -1,4 +1,7 @@
 <h1>Thanks for registering</h1>
+
+<p>Your registration is confirmed.</p>
+
 <p>Don't forget to download the reminder and add it to your calendar.</p>
 
 <%= render 'mr_common/registration_mailer/html_reminders' %>

data/app/views/mr_common/registration_mailer/{confirmation.text.erb → confirmed_registration.text.erb}

@@ -1,6 +1,8 @@
 Thanks for registering
 ---
 
+Your registration is confirmed.
+
 Don't forget to download the reminder and add it to your calendar.
 
 <%= render 'mr_common/registration_mailer/text_reminders' %>

data/app/views/mr_common/registration_mailer/revoked_registration.html.erb

@@ -0,0 +1,5 @@
+<h1>Your registration is no longer confirmed</h1>
+
+<p>Thank you for your interest in our invitation-only event.</p>
+
+<p>Unfortunately, we aren’t able to accommodate your registration at this time. If we are able to confirm a spot for you, we will notify you before the event.</p>

data/app/views/mr_common/registration_mailer/revoked_registration.text.erb

@@ -0,0 +1,6 @@
+Your registration is no longer confirmed
+---
+
+Thank you for your interest in our invitation-only event.
+
+Unfortunately, we aren’t able to accommodate your registration at this time. If we are able to confirm a spot for you, we will notify you before the event.