effective_events 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3cc18563f533b13a758addad2e5c979d07dc0cc5ac600470bac421be24bd749
-  data.tar.gz: 4ba14bd70df819232c3866ffd42afe7b78e02b2283da9db24f73408392fc0bdb
+  metadata.gz: 4b29ba82476500dc0793755782751f968623a5fd7a2a05a4c01075fd57dd3eb2
+  data.tar.gz: f3efe6fa8417a593fcf46a0219e2fdbe77183ab8d6b24344f969e969d4b45bf9
 SHA512:
-  metadata.gz: 9820e104abbb83b4ad4e628e837458d2ca6364e078b3590abe49cf605d99cf7fe2eaf2e760ce97e19e3395621b59177503577a1e7f21c071524417e12031746a
-  data.tar.gz: 9fbf56791b01f83864adf08828a366998c70f2e6db1c3396bc80a2c5d9bfda8d25ee3aa7d7276f96bff80fda85e2c7ae160bb9b7295080f69c36f175d1481589
+  metadata.gz: c1788863bd9f10ab8af6e147b4b83df8bb0f12c353efd26c44fd2274f8c3b2108d0db460eb62a770efd6764bc72fd8829023a090208c468cffdda1517cee2897
+  data.tar.gz: 424203654b7861c179002ef3d2989c8fa8334e57fa9886156638d405a292a1de586f836f3e40ac34eb6db5a8fa06dd01549232a9b3862fc48e7bf93ae24ac3c7

data/app/controllers/effective/events_controller.rb

@@ -7,6 +7,20 @@ module Effective
       Effective::Event.events(user: current_user, unpublished: unpublished)
     }
 
+    def index
+      @page_title ||= 'Events'
+      EffectiveResources.authorize!(self, :index, Effective::Event)
+
+      # Sometimes we just display a Datatable for the events
+      @datatable = EffectiveResources.best('EffectiveEventsDatatable').new
+
+      # But more often we do a full paginated index with search screen
+      @event_search = build_event_search
+      @event_search.search!
+
+      @events = @event_search.results(page: params[:page])
+    end
+
     def show
       @event = resource_scope.find(params[:id])
 
@@ -28,5 +42,28 @@ module Effective
       @page_title ||= @event.to_s
     end
 
+    def build_event_search
+      search = EventSearch.new(search_params)
+      search.current_user = current_user
+      search.unpublished = EffectiveResources.authorized?(self, :admin, :effective_events)
+      search.category ||= event_category
+      search
+    end
+
+    def event_category
+      return nil unless params[:category].present?
+      EffectiveEvents.categories.find { |category| category.parameterize == params[:category] }
+    end
+
+    def search_params
+      return {} unless params[:q].present?
+
+      if params[:q].respond_to?(:to_h)      # From the search form
+        params.require(:q).permit!
+      else
+        { term: params.permit(:q).fetch(:q) }   # From the url /events?q=asdf
+      end
+    end
+
   end
 end

data/app/datatables/admin/effective_event_notifications_datatable.rb

@@ -14,7 +14,7 @@ class Admin::EffectiveEventNotificationsDatatable < Effective::Datatable
     col :category
 
     col :from do |event|
-      html_escape(event.from)
+      simple_format(event.from)
     end
 
     # col :reminder do |poll_notification|

data/app/datatables/admin/effective_events_datatable.rb

@@ -3,7 +3,8 @@ module Admin
     filters do
       scope :all
       scope :registerable
-      scope :drafts
+      scope :published
+      scope :unpublished
       scope :upcoming
       scope :past
     end

data/app/datatables/effective_events_datatable.rb

@@ -2,6 +2,7 @@
 class EffectiveEventsDatatable < Effective::Datatable
   filters do
     # Upcoming should be first here, so when displayed as a simple datatable on the dashboard they only see upcoming events
+    scope :upcoming
     scope :registerable
     scope :all
   end
@@ -32,7 +33,8 @@ class EffectiveEventsDatatable < Effective::Datatable
 
     actions_col show: false do |event|
       if event.registerable?
-        dropdown_link_to('Register', effective_events.new_event_event_registration_path(event))
+        url = event.external_registration_url.presence || effective_events.new_event_event_registration_path(event)
+        dropdown_link_to('Register', url)
       end
     end
   end

data/app/models/concerns/effective_events_event_registration.rb

@@ -82,6 +82,11 @@ module EffectiveEventsEventRegistration
     validates :owner, presence: true
     validates :event, presence: true
 
+    # All Steps
+    validate(if: -> { event.present? }) do
+      self.errors.add(:base, "cannot register for an external registration event") if event.external_registration?
+    end
+
     # Tickets Step
     validate(if: -> { current_step == :tickets }) do
       self.errors.add(:event_registrants, "can't be blank") unless present_event_registrants.present?

data/app/models/effective/event.rb

@@ -28,6 +28,8 @@ module Effective
     # rich_text_select_content
     # rich_text_select_content
 
+    has_one_attached :file
+
     acts_as_slugged
     log_changes if respond_to?(:log_changes)
     acts_as_role_restricted if respond_to?(:acts_as_role_restricted)
@@ -37,8 +39,11 @@ module Effective
     effective_resource do
       title                  :string
 
+      category               :string
       slug                   :string
+
       draft                  :boolean
+      published_at           :datetime
 
       start_at               :datetime
       end_at                 :datetime
@@ -48,6 +53,9 @@ module Effective
 
       early_bird_end_at      :datetime  # Optional
 
+      external_registration       :boolean
+      external_registration_url   :string
+
       # Access
       roles_mask             :integer
       authenticate_user      :boolean
@@ -55,11 +63,11 @@ module Effective
       timestamps
     end
 
-    scope :sorted, -> { order(:end_at) }
+    scope :sorted, -> { order(published_at: :desc).order(:id) }
     scope :deep, -> { includes(:event_registrants, :event_tickets) }
 
-    scope :drafts, -> { where(draft: true) }
-    scope :published, -> { where(draft: false) }
+    scope :published, -> { where(draft: false).where(arel_table[:published_at].lt(Time.zone.now)) }
+    scope :unpublished, -> { where(draft: true).where(arel_table[:published_at].gteq(Time.zone.now)) }
 
     scope :upcoming, -> { where(arel_table[:end_at].gt(Time.zone.now)) }
     scope :past, -> { where(arel_table[:end_at].lteq(Time.zone.now)) }
@@ -79,7 +87,7 @@ module Effective
       limit(per_page).offset(offset)
     }
 
-    scope :events, -> (user: nil, unpublished: false) {
+    scope :events, -> (user: nil, category: nil, unpublished: false) {
       scope = all.deep.sorted
 
       if defined?(EffectiveRoles) && EffectiveEvents.use_effective_roles
@@ -90,6 +98,10 @@ module Effective
         scope = scope.where(authenticate_user: false)
       end
 
+      if category.present?
+        scope = scope.where(category: category)
+      end
+
       unless unpublished
         scope = scope.published
       end
@@ -98,11 +110,12 @@ module Effective
     }
 
     validates :title, presence: true, length: { maximum: 255 }
-
+    validates :published_at, presence: true, unless: -> { draft? }
     validates :start_at, presence: true
     validates :end_at, presence: true
     validates :registration_start_at, presence: true
     validates :registration_end_at, presence: true
+    validates :external_registration_url, presence: true, if: -> { external_registration? }
 
     validate(if: -> { start_at && end_at }) do
       self.errors.add(:end_at, 'must be after start date') unless start_at < end_at
@@ -120,6 +133,14 @@ module Effective
       self.errors.add(:early_bird_end_at, 'must be before start date') unless early_bird_end_at < start_at
     end
 
+    validate(if: -> { file.attached? }) do
+      self.errors.add(:file, 'must be an image') unless file.image?
+    end
+
+    validate(if: -> { category.present? }) do
+      self.errors.add(:category, 'is not included in the list') unless EffectiveEvents.categories.include?(category)
+    end
+
     def to_s
       title.presence || 'New Event'
     end
@@ -132,13 +153,19 @@ module Effective
       rich_text_excerpt
     end
 
-    def registerable?
+    def published?
       return false if draft?
+      return false if published_at.blank?
+
+      published_at < Time.zone.now
+    end
+
+    def registerable?
+      return false unless published?
       return false if closed?
       return false if sold_out?
-      return false if event_tickets.blank?
 
-      true
+      external_registration? || event_tickets.present?
     end
 
     def closed?

data/app/models/effective/event_search.rb

@@ -0,0 +1,82 @@
+module Effective
+  class EventSearch
+    include ActiveModel::Model
+
+    ORDERS = ['Sort by Published Date', 'Sort by Event Date']
+
+    attr_accessor :current_user
+    attr_accessor :unpublished
+
+    attr_accessor :term
+    attr_accessor :category
+    attr_accessor :order
+
+    validates :term, length: { minimum: 2, allow_blank: true }
+    validates :order, inclusion: { in: ORDERS, allow_blank: true }
+
+    # Base collection to search.
+    def collection
+      Event.events(user: current_user, unpublished: unpublished)
+    end
+
+    def per_page
+      (EffectiveEvents.per_page || 24).to_i
+    end
+
+    def present?
+      term.present? || category.present? || order.present?
+    end
+
+    # Search and assigns the collection
+    # Assigns the entire collection() if there are no search terms
+    # Otherwise validate the search terms
+    def search!
+      @events = build_collection()
+      @events = @events.none if present? && !valid?
+      @events
+    end
+
+    # The unpaginated results of the search
+    def events
+      @events || collection
+    end
+
+    # The paginated results
+    def results(page: nil)
+      page = (page || 1).to_i
+      offset = [(page - 1), 0].max * per_page
+
+      events.limit(per_page).offset(offset)
+    end
+
+    protected
+
+    def build_collection
+      events = collection()
+      raise('expected an ActiveRecord collection') unless events.kind_of?(ActiveRecord::Relation)
+
+      # Filter by term
+      if term.present?
+        events = Effective::Resource.new(events).search_any(term)
+      end
+
+      # Filter by category
+      if category.present?
+        events = events.where(category: category)
+      end
+
+      # Apply Sorting
+      events = case order.to_s
+      when 'Sort by Published Date'
+        events.reorder(published_at: :desc)
+      when 'Sort by Event Date'
+        events.reorder(start_at: :desc)
+      else
+        events.reorder(published_at: :desc) # Default Sort by Published Date
+      end
+
+      events
+    end
+  end
+
+end

data/app/views/admin/events/_form.html.haml

@@ -6,6 +6,7 @@
     = tab 'Content' do
       = render '/admin/events/form_content', event: event
 
+  - if event.persisted? && !event.external_registration?
     = tab 'Tickets' do
       %h2 Tickets
       - datatable = Admin::EffectiveEventTicketsDatatable.new(event_id: event.id)
@@ -40,6 +41,7 @@
     = tab 'Wizard' do
       = render '/admin/events/form_event_registration_content', event: event
 
+  - if event.persisted?
     = tab 'Access' do
       = render '/admin/events/form_access', event: event
 

data/app/views/admin/events/_form_content.html.haml

@@ -1,9 +1,11 @@
 = effective_form_with(model: [:admin, event], engine: true) do |f|
+  = f.file_field :file, label: 'Image attachment', hint: EffectiveEvents.events_hint_text
+
   - if defined?(EffectiveArticleEditor)
-    = f.article_editor :rich_text_excerpt, hint: 'Will be used for the events excerpt on index pages.'
-    = f.article_editor :rich_text_body, hint: 'The main body of your event'
+    = f.article_editor :rich_text_excerpt, label: 'Excerpt', hint: 'Will be used for the events excerpt on index pages.'
+    = f.article_editor :rich_text_body, label: 'Body', hint: 'The main body of your event'
   - else
-    = f.rich_text_area :rich_text_excerpt, hint: 'Will be used for the events excerpt on index pages.'
-    = f.rich_text_area :rich_text_body, hint: 'The main body of your event'
+    = f.rich_text_area :rich_text_excerpt, label: 'Excerpt', hint: 'Will be used for the events excerpt on index pages.'
+    = f.rich_text_area :rich_text_body, label: 'Body', hint: 'The main body of your event'
 
   = f.submit

data/app/views/admin/events/_form_event.html.haml

@@ -1,5 +1,11 @@
 = effective_form_with(model: [:admin, event], engine: true) do |f|
   = f.text_field :title, label: "Title"
+
+  - categories = EffectiveEvents.categories
+  - if categories.present?
+    = f.select :category, categories, hint: 'optional category'
+
+  = f.datetime_field :published_at, label: 'Publish date', hint: 'When should this be displayed on the website.'
   = f.check_box :draft, hint: 'Save this event as a draft. It will not be accessible on the website.'
 
   - if f.object.persisted? || f.object.errors.include?(:slug)
@@ -13,10 +19,14 @@
   %p The online registration and purchase for this event will be available between:
   = f.datetime_field :registration_start_at, label: "Registration Start"
   = f.datetime_field :registration_end_at, label: "Registration End"
-
   = f.datetime_field :early_bird_end_at, label: "Early Bird End",
     hint: 'Event tickets can be purchased for early bird pricing before this date. Afterwards regular pricing applies.'
 
+  = f.check_box :external_registration, label: "Yes, the registration for this event is handled by another website"
+
+  = f.show_if(:external_registration, true) do
+    = f.url_field :external_registration_url, hint: "The url for external event registration. Must start with http(s)://"
+
   = f.submit do
     = f.save 'Save'
     = f.save 'Save and View', class: 'btn btn-secondary'

data/app/views/effective/events/_categories.html.haml

@@ -0,0 +1,8 @@
+.effective-event-categories
+  %p
+    %strong Categories
+
+  = link_to('All Events', effective_events.events_path)
+
+  - EffectiveEvents.categories.each do |category|
+    = link_to(category, effective_events.events_path + '/' + category.parameterize)

data/app/views/effective/events/_event.html.haml

@@ -1,5 +1,10 @@
 .card
   .card-body
+    - if event.file.attached?
+      = image_tag(event.file)
+
+    = event.excerpt.to_s
+
     %table.table.effective-events-table
       %tbody
         %tr
@@ -9,6 +14,15 @@
             %br
             Ends: #{event.end_at&.strftime('%F %R')}
 
+        - if event.category.present?
+          %tr
+            %th Category
+            %td= event.category
+
+        %tr
+          %th Published At
+          %td= event.published_at.strftime('%F %R')
+
         %tr
           %th Registration Closes
           %td= event.registration_end_at.strftime('%F %R')
@@ -20,12 +34,13 @@
             %br
             Ends: #{event.early_bird_end_at&.strftime('%F %R')}
 
-        %tr
-          %th Tickets
-          %td
-            %ul.pl-3
-              - event.event_tickets.each do |ticket|
-                %li= "#{ticket} (#{price_to_currency(ticket.price)})"
+        - if event.event_tickets.present?
+          %tr
+            %th Tickets
+            %td
+              %ul.pl-3
+                - event.event_tickets.each do |ticket|
+                  %li= "#{ticket} (#{price_to_currency(ticket.price)})"
 
         - if event.event_products.present?
           %tr
@@ -35,7 +50,4 @@
                 - event.event_products.each do |product|
                   %li= "#{product} (#{price_to_currency(product.price)})"
 
-        - if event.body.present?
-          %tr
-            %th Description
-            %td= event.body
+    = link_to('View more', effective_events.event_path(event))

data/app/views/effective/events/_form.html.haml

@@ -0,0 +1,11 @@
+= effective_form_with(scope: :q, model: event_search, method: :get, url: request.path) do |f|
+  - if f.object.term.present?
+    = f.search_field :term, label: 'Term'
+
+  /= f.radios :category, EffectiveEvents.categories, buttons: true
+
+  - f.object.order ||= Effective::EventSearch::ORDERS.first
+  = f.radios :order, Effective::EventSearch::ORDERS, buttons: true
+
+  = f.save('Search', class: 'btn btn-primary btn-search mr-3', name: nil)
+  = link_to 'Reset filters', request.path

data/app/views/effective/events/_layout.html.haml

@@ -0,0 +1,2 @@
+.effective-events
+  = yield

data/app/views/effective/events/index.html.haml

@@ -1,5 +1,16 @@
-= card do
-  - if @datatable.present?(self)
-    = render_datatable(@datatable, simple: true)
-  - else
-    %p There are no events open for registration. When there are, we'll show them here.
+= render 'layout' do
+  -# render_datatable(@datatable)
+
+  .mb-4= render('effective/events/categories')
+  .mb-4= render('effective/events/form', event_search: @event_search)
+
+  - results = @event_search.results(page: params[:page])
+
+  - if @event_search.present? && results.length == 0
+    .alert.alert-info There are no results for your search. Please try again.
+
+  -# This renders effective/events/event
+  = render(results)
+
+  %nav.d-flex.justify-content-center
+    = bootstrap_paginate(results, per_page: @event_search.per_page)

data/app/views/effective/events/show.html.haml

@@ -7,6 +7,46 @@
 
   - if @event.registerable?
     .resource-buttons
-      = link_to 'Register', effective_events.new_event_event_registration_path(@event), class: 'btn btn-primary'
+      - url = @event.external_registration_url.presence || effective_events.new_event_event_registration_path(@event)
+      = link_to 'Register', url, class: 'btn btn-primary'
 
-  = render 'effective/events/event', event: @event
+  = card do
+    - if @event.file.attached?
+      = image_tag(@event.file)
+
+    = @event.body.to_s
+
+    %table.table.effective-events-table
+      %tbody
+        %tr
+          %th Dates
+          %td
+            Starts: #{@event.start_at&.strftime('%F %R')}
+            %br
+            Ends: #{@event.end_at&.strftime('%F %R')}
+
+        %tr
+          %th Registration Closes
+          %td= @event.registration_end_at.strftime('%F %R')
+
+        %tr
+          %th Early Bird
+          %td
+            Status: #{@event.early_bird_status}
+            %br
+            Ends: #{@event.early_bird_end_at&.strftime('%F %R')}
+
+        %tr
+          %th Tickets
+          %td
+            %ul.pl-3
+              - @event.event_tickets.each do |ticket|
+                %li= "#{ticket} (#{price_to_currency(ticket.price)})"
+
+        - if @event.event_products.present?
+          %tr
+            %th Add-ons
+            %td
+              %ul.pl-0
+                - @event.event_products.each do |product|
+                  %li= "#{product} (#{price_to_currency(product.price)})"

data/config/effective_events.rb

@@ -19,6 +19,12 @@ EffectiveEvents.setup do |config|
   # Events can be restricted by role
   config.use_effective_roles = true
 
+  # Categories
+  config.categories = ['Events']
+
+  # Hint text for event images attachments
+  config.events_hint_text = 'Hint text that includes required image dimensions'
+
   # Mailer Settings
   # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
   #

data/config/routes.rb

@@ -7,6 +7,16 @@ end
 EffectiveEvents::Engine.routes.draw do
   # Public routes
   scope module: 'effective' do
+
+    # Event Category routes
+    match 'events/:category', to: 'events#index', via: :get, constraints: lambda { |req|
+      EffectiveEvents.categories.map(&:parameterize).include?(req.params['category'])
+    }
+
+    match "events/:category/:id", to: 'events#show', via: :get, constraints: lambda { |req|
+      EffectiveEvents.categories.map(&:parameterize).include?(req.params['category'])
+    }
+
     resources :events, only: [:index, :show] do
       resources :event_registrations, only: [:new, :show, :destroy] do
         resources :build, controller: :event_registrations, only: [:show, :update]

data/db/migrate/01_create_effective_events.rb.erb

@@ -3,8 +3,11 @@ class CreateEffectiveEvents < ActiveRecord::Migration[6.0]
     create_table <%= @events_table_name %> do |t|
       t.string :title
 
+      t.string :category
       t.string :slug
+
       t.boolean :draft, default: false
+      t.datetime :published_at
 
       t.datetime :start_at
       t.datetime :end_at
@@ -16,6 +19,9 @@ class CreateEffectiveEvents < ActiveRecord::Migration[6.0]
       t.integer :event_registrants_count, default: 0
       t.integer :event_addons_count, default: 0
 
+      t.boolean :external_registration, default: false
+      t.string :external_registration_url
+
       t.integer :roles_mask
       t.boolean :authenticate_user, default: false
 

data/db/seeds.rb

@@ -13,6 +13,7 @@ event = Effective::Event.create!(
   rich_text_excerpt: '<p>This is a great event</p>',
   rich_text_body: '<p>This is a really great event!</p>',
 
+  published_at: Time.zone.now,
   start_at: (now + 1.week),
   end_at: (now + 1.week + 1.hour),
 

data/lib/effective_events/version.rb

@@ -1,3 +1,3 @@
 module EffectiveEvents
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/effective_events.rb

@@ -9,8 +9,8 @@ module EffectiveEvents
       :events_table_name, :event_registrants_table_name, :event_tickets_table_name,
       :event_registrations_table_name, :event_products_table_name, :event_addons_table_name,
       :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates,
-      :layout, :per_page, :use_effective_roles,
-      :event_registration_class_name,
+      :layout, :per_page, :use_effective_roles, :categories, :events_hint_text,
+      :event_registration_class_name
     ]
   end
 
@@ -24,4 +24,8 @@ module EffectiveEvents
     mailer&.constantize || Effective::EventsMailer
   end
 
+  def categories
+    Array(config[:categories]) - [nil, false, '']
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_events
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -222,6 +222,7 @@ files:
 - app/models/effective/event_product.rb
 - app/models/effective/event_registrant.rb
 - app/models/effective/event_registration.rb
+- app/models/effective/event_search.rb
 - app/models/effective/event_ticket.rb
 - app/views/admin/event_addons/_form.html.haml
 - app/views/admin/event_notifications/_form.html.haml
@@ -251,8 +252,11 @@ files:
 - app/views/effective/event_registrations/submitted.html.haml
 - app/views/effective/event_registrations/summary.html.haml
 - app/views/effective/event_registrations/tickets.html.haml
+- app/views/effective/events/_categories.html.haml
 - app/views/effective/events/_dashboard.html.haml
 - app/views/effective/events/_event.html.haml
+- app/views/effective/events/_form.html.haml
+- app/views/effective/events/_layout.html.haml
 - app/views/effective/events/index.html.haml
 - app/views/effective/events/show.html.haml
 - app/views/effective/events_mailer/event_registrant_purchased.liquid