effective_classifieds 0.0.2

data/app/models/effective/classified.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Effective
+  class Classified < ActiveRecord::Base
+    self.table_name = EffectiveClassifieds.classifieds_table_name.to_s
+
+    attr_accessor :current_user
+
+    acts_as_slugged
+    log_changes if respond_to?(:log_changes)
+    acts_as_role_restricted if respond_to?(:acts_as_role_restricted)
+
+    # This will be the owner of the classified submission
+    # Or the admin user that created it
+    belongs_to :owner, polymorphic: true
+
+    # When submitted through the wizard
+    belongs_to :classified_submission, polymorphic: true, optional: true
+
+    has_rich_text :body
+
+    acts_as_statused(
+      :draft,       # Initial state
+      :submitted,   # Once submitted by the classified submission.
+      :approved     # Exit state. Classified was approved.
+    )
+
+    effective_resource do
+      title              :string
+      category           :string
+
+      organization       :string    # Or seller
+      location           :string
+
+      website            :string
+      email              :string
+      phone              :string
+
+      # Logic
+      start_on           :date
+      end_on             :date
+
+      # Acts as Slugged
+      slug               :string
+
+      # Acts as Statused
+      status                 :string, permitted: false
+      status_steps           :text, permitted: false
+
+      # Access
+      roles_mask         :integer
+      authenticate_user  :boolean
+
+      archived           :boolean
+
+      timestamps
+    end
+
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { with_rich_text_body }
+
+    scope :upcoming, -> { where(arel_table[:end_on].gt(Time.zone.now)) }
+    scope :past, -> { where(arel_table[:end_on].lteq(Time.zone.now)) }
+
+    scope :unarchived, -> { where(archived: false) }
+    scope :archived, -> { where(archived: true) }
+
+    scope :published, -> {
+      approved
+      .unarchived
+      .where(arel_table[:start_on].lteq(Time.zone.now))
+      .where(arel_table[:end_on].gt(Time.zone.now))
+    }
+
+    scope :paginate, -> (page: nil, per_page: nil) {
+      page = (page || 1).to_i
+      offset = [(page - 1), 0].max * (per_page || EffectiveClassifieds.per_page)
+
+      limit(per_page).offset(offset)
+    }
+
+    scope :classifieds, -> (user: nil, unpublished: false) {
+      scope = all.deep.sorted
+
+      if defined?(EffectiveRoles) && EffectiveClassifieds.use_effective_roles
+        scope = scope.for_role(user&.roles)
+      end
+
+      if user.blank?
+        scope = scope.where(authenticate_user: false)
+      end
+
+      unless unpublished
+        scope = scope.published
+      end
+
+      scope
+    }
+
+    before_validation(if: -> { current_user.present? }) do
+      self.owner ||= current_user
+    end
+
+    # Automatically approve submissions created by admins outside the submissions wizard
+    before_validation(if: -> { new_record? && classified_submission.blank? }) do
+      assign_attributes(status: :approved)
+    end
+
+    validates :title, presence: true, length: { maximum: 200 }
+    validates :category, presence: true
+    validates :body, presence: true
+
+    validates :start_on, presence: true
+    validates :end_on, presence: true
+    validates :location, presence: true
+
+    validates :organization, presence: true
+    validates :email, presence: true
+    validates :phone, presence: true
+
+    validate(if: -> { start_on.present? && end_on.present? }) do
+      self.errors.add(:end_on, 'must be after start date') if end_on < start_on
+    end
+
+    validate(if: -> { start_on.present? && end_on.present? && EffectiveClassifieds.max_duration.present? }) do
+      if (end_on - start_on) > EffectiveClassifieds.max_duration
+        distance = ApplicationController.helpers.distance_of_time_in_words(end_on + EffectiveClassifieds.max_duration, end_on).gsub('about', '').strip
+        self.errors.add(:end_on, "must be within #{distance} of start date")
+      end
+    end
+
+    validate(if: -> { category.present? }) do
+      self.errors.add(:category, 'is invalid') unless Array(EffectiveClassifieds.categories).include?(category)
+    end
+
+    def to_s
+      title.presence || 'New Classified'
+    end
+
+    def published?
+      return false unless approved?
+      return false if archived?
+      return false if start_on.blank? || (Time.zone.now < start_on)
+      return false if end_on.present? && (Time.zone.now >= end_on)
+      true
+    end
+
+    def submit!
+      submitted!
+      approve! if EffectiveClassifieds.auto_approve
+
+      after_commit do
+        EffectiveClassifieds.send_email(:classified_submitted, self)
+      end
+
+      true
+    end
+
+    def approve!
+      approved!
+    end
+
+  end
+end

data/app/models/effective/classified_submission.rb

@@ -0,0 +1,7 @@
+module Effective
+  class ClassifiedSubmission < ActiveRecord::Base
+    self.table_name = EffectiveClassifieds.classified_submissions_table_name.to_s
+
+    effective_classifieds_classified_submission
+  end
+end

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

@@ -0,0 +1,12 @@
+= tabs do
+  = tab 'Classified' do
+    = render 'admin/classifieds/form_classified', classified: classified
+
+  - if classified.persisted?
+
+    = tab 'Access' do
+      = render '/admin/classifieds/form_access', classified: classified
+
+    - if classified.respond_to?(:log_changes_datatable)
+      = tab 'Logs' do
+        = render_inline_datatable(classified.log_changes_datatable)

data/app/views/admin/classifieds/_form_access.html.haml

@@ -0,0 +1,10 @@
+= effective_form_with(model: classified, url: classified.persisted? ? effective_classifieds.admin_classified_path(classified.id) : effective_classifieds.admin_classifieds_path) do |f|
+  = f.check_box :authenticate_user, label: 'Yes, the user must be be signed in to view this classified', hint: 'Sign up is required to register for any classified'
+
+  - if EffectiveClassifieds.use_effective_roles
+    = f.checks :roles, EffectiveRoles.roles_collection(f.object)
+
+  %p.text-hint
+    * leave blank for a regular public classified that anyone can view
+
+  = f.submit

data/app/views/admin/classifieds/_form_classified.html.haml

@@ -0,0 +1,3 @@
+= effective_form_with(model: [:admin, classified], engine: true) do |f|
+  = render('effective/classifieds/fields', f: f, classified: f.object)
+  = effective_submit(f)

data/app/views/effective/classified_submissions/_classified.haml

@@ -0,0 +1,12 @@
+= card do
+  .row
+    .col-sm
+      %h5.card-title= classified_submission.wizard_step_title(:classified)
+    .col-sm-auto.text-right
+      = link_to('Edit', wizard_path(:classified)) if edit_effective_classified_submissions_wizard?
+
+  - classified = classified_submission.classified
+
+  - if classified.present?
+    = render('effective/classifieds/classified', classified: classified) do
+      = classified.body

data/app/views/effective/classified_submissions/_classified_submission.html.haml

@@ -0,0 +1,8 @@
+.effective-classified-submission
+  - blacklist = EffectiveClassifieds.ClassifiedSubmission.required_wizard_steps
+  - steps = classified_submission.required_steps - blacklist
+
+  = render "effective/classified_submissions/summary", classified_submission: classified_submission
+
+  - steps.select { |step| classified_submission.has_completed_step?(step) }.each do |partial|
+    = render "effective/classified_submissions/#{partial}", classified_submission: classified_submission, step: partial

data/app/views/effective/classified_submissions/_content.html.haml

@@ -0,0 +1 @@
+-# Intentionally blank

data/app/views/effective/classified_submissions/_dashboard.html.haml

@@ -0,0 +1,28 @@
+-# In progress submission
+- submission = EffectiveClassifieds.ClassifiedSubmission.in_progress.for(current_user).first
+- datatable = EffectiveResources.best('EffectiveClassifiedSubmissionsDatatable').new(self, namespace: :effective)
+
+- if submission.present?
+  %h2 In Progress Classified Submissions
+
+  %p
+    Your submission for #{submission.classified.presence || 'a classified'} is incomplete
+
+  %p
+    Please
+    = link_to("Continue submission for #{submission.classified.presence || 'a classified'}", effective_classifieds.classified_submission_build_path(submission, submission.next_step), 'data-turbolinks' => false, class: 'btn btn-primary')
+    or you can
+    = link_to('Abandon submission', effective_classifieds.classified_submission_path(submission), 'data-confirm': "Really delete #{submission}?", 'data-method': :delete, class: 'btn btn-danger')
+    to submit another.
+
+  %hr
+
+%h2 Classified Submissions
+
+- if datatable.present?
+  = render_simple_datatable(datatable)
+- else
+  %p You have no past classified submissions. When you do, we'll show them here.
+
+- if submission.blank?
+  %p= link_to 'Submit New Classified', effective_classifieds.new_classified_submission_path, class: 'btn btn-primary'

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

@@ -0,0 +1,3 @@
+.row
+  .col-lg-3.mb-3= render_wizard_sidebar(resource)
+  .col-lg-9= yield

data/app/views/effective/classified_submissions/_summary.html.haml

@@ -0,0 +1,30 @@
+= card('Classified Submission') do
+  - classified = classified_submission.classified
+
+  %table.table.table-sm
+    %tbody
+      %tr
+        %th.border-0 Classified
+        %td.border-0
+
+          - if classified&.published?
+            = link_to(classified, effective_classifieds.classified_path(classified), target: '_blank')
+          - else
+            = classified.presence || 'Classified was deleted'
+
+      - if request.path.start_with?('/admin')
+        %tr
+          %th Owner
+          %td
+            - url = (polymorphic_admin_path(classified_submission.owner) rescue "/admin/users/#{classified_submission.owner.to_param}/edit")
+            = link_to(classified_submission.owner, url)
+      - else
+        %tr
+          %th Owner
+          %td= classified_submission.owner
+
+      - if classified&.was_submitted?
+        %tr
+          %th Status
+          %td
+            %span.badge.badge-secondary= classified.status

data/app/views/effective/classified_submissions/classified.html.haml

@@ -0,0 +1,17 @@
+= render 'layout' do
+  = render 'effective/classified_submissions/content', resource: resource
+
+  .card
+    .card-body
+      = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+        = f.hidden_field :id
+
+        = f.fields_for :classified, (f.object.classified || f.object.build_classified) do |fc|
+          = fc.hidden_field :id
+
+          = fc.hidden_field :owner_id, value: f.object.owner_id
+          = fc.hidden_field :owner_type, value: f.object.owner_type
+
+          = render('effective/classifieds/fields', f: fc, classified: fc.object)
+
+        = f.save 'Save and Continue'

data/app/views/effective/classified_submissions/start.html.haml

@@ -0,0 +1,16 @@
+= render 'layout' do
+  = render 'effective/classified_submissions/content', resource: resource
+
+  .card
+    .card-body
+      %p Welcome #{current_user}!
+
+      %p You are about to submit a classified
+
+      = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+        = f.hidden_field :id
+
+        = f.hidden_field :owner_type
+        = f.hidden_field :owner_id
+
+        = f.save 'Save and Continue'

data/app/views/effective/classified_submissions/submitted.html.haml

@@ -0,0 +1,13 @@
+= render 'layout' do
+  = render 'effective/classified_submissions/content', resource: resource
+
+  - raise('expected a submitted classified_submission') unless resource.was_submitted?
+
+  .alert.alert-warning.mb-4
+    Successfully submitted on #{resource.submitted_at.strftime('%F')}.
+
+  = link_to "Return to Dashboard", root_path, class: 'btn btn-lg btn-primary mb-4'
+
+  = render 'effective/classified_submissions/classified_submission', classified_submission: resource
+
+  = link_to "Return to Dashboard", root_path, class: 'btn btn-lg btn-primary'

data/app/views/effective/classified_submissions/summary.html.haml

@@ -0,0 +1,8 @@
+= render 'layout' do
+  = render 'effective/classified_submissions/content', resource: resource
+
+  = render('effective/classified_submissions/classified_submission', classified_submission: resource)
+
+  = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+    = f.hidden_field :id
+    = f.submit 'Submit Classified', class: 'btn btn-primary'

data/app/views/effective/classifieds/_classified.html.haml

@@ -0,0 +1,50 @@
+.card.effective-classified
+  .card-body
+    %h5.card-title= classified.title
+
+    %table.table.effective-classified-table
+      %tbody
+        %tr
+          %td Category
+          %td= classified.category
+
+        %tr
+          %td Available
+          %td #{classified.start_on&.strftime('%F')} to #{classified.end_on&.strftime('%F')}
+
+        %tr
+          %td Location
+          %td= classified.location.presence || '-'
+
+        %tr
+          %td Website
+          %td
+            - if classified.website.present?
+              = link_to(classified.website, classified.website, target: '_blank')
+            - else
+              = '-'
+
+        %tr
+          %td Contact
+          %td= classified.organization
+
+        %tr
+          %td Email
+          %td
+            - if classified.email.present?
+              = mail_to(classified.email)
+            - else
+              = '-'
+
+        %tr
+          %td Phone
+          %td
+            - if classified.phone.present?
+              = classified.phone
+            - else
+              = '-'
+
+    - if block_given?
+      = yield
+    - else
+      %p= link_to('View Classified', effective_classifieds.classified_path(classified), class: 'btn btn-primary')

data/app/views/effective/classifieds/_dashboard.html.haml

@@ -0,0 +1,8 @@
+%h2 Classifieds
+
+- published = Effective::Classified.classifieds(user: current_user).count
+
+- datatable = EffectiveClassifiedsDatatable.new(self, namespace: :effective)
+= render_datatable(datatable, simple: true)
+
+%p= link_to 'View All Classifieds', effective_classifieds.classifieds_path, class: 'btn btn-primary'

data/app/views/effective/classifieds/_fields.html.haml

@@ -0,0 +1,28 @@
+= f.text_field :title
+= f.select :category, EffectiveClassifieds.categories, required: true
+
+- if f.object.persisted? || f.object.errors.include?(:slug)
+  - current_url = (effective_classifieds.classified_url(f.object) rescue nil)
+  = f.text_field :slug, hint: "The slug controls this resource's internet address. Be careful, changing the slug will break links that other websites may have to the old address.<br>#{('This is currently reachable via ' + link_to(current_url.gsub(f.object.slug, '<strong>' + f.object.slug + '</strong>').html_safe, current_url)) if current_url }".html_safe
+
+- minDate = [Time.zone.now, f.object.created_at].compact.min
+
+= f.date_field :start_on, label: "Classified Start",
+  hint: 'The classified ad will be displayed starting on this date',
+  input_js: { minDate: minDate.strftime('%F') }
+
+= f.date_field :end_on, label: "Classified End",
+  hint: 'The classified ad will no longer be displayed on this date'
+
+- if f.object.persisted? && !f.object.draft?
+  = f.check_box :archived, label: 'Yes, this classified is archived and will not be displayed'
+
+%h2 Classified Content
+= f.rich_text_area :body, hint: 'The main body of your classified'
+= f.text_field :location
+= f.url_field :website
+
+%h2 Contact Information
+= f.text_field :organization
+= f.email_field :email
+= f.tel_field :phone

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

@@ -0,0 +1,3 @@
+= effective_form_with(model: classified, engine: true) do |f|
+  = render('effective/classifieds/fields', f: f, classified: f.object)
+  = effective_submit(f)

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

@@ -0,0 +1 @@
+= yield

data/app/views/effective/classifieds/_spacer.html.haml

@@ -0,0 +1 @@
+%hr

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

@@ -0,0 +1,8 @@
+%h1= @page_title
+
+= render 'layout' do
+  .effective-classifieds
+    = render partial: @classifieds, spacer_template: 'spacer'
+
+  %nav.d-flex.justify-content-center
+    = bootstrap_paginate(@classifieds, per_page: EffectiveClassifieds.per_page)

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

@@ -0,0 +1,8 @@
+= render 'layout' do
+  .effective-classified
+    - unless @classified.published?
+      .alert.alert-warning This classified is currently unavailable.
+
+    = render 'effective/classifieds/classified', classified: @classified do
+      .classified-body.classified-content
+        = @classified.body

data/app/views/effective/classifieds_mailer/classified_submitted.html.haml

@@ -0,0 +1,16 @@
+%p Hello Admin!
+
+- if @classified.published?
+  %p The following classified has been submitted and is published online:
+- else
+  %p The following classified has been submitted and is awaiting your approval:
+  %p= link_to('Approve Classified', effective_classifieds.edit_admin_classified_path(@classified))
+
+= render('effective/classifieds/classified', classified: @classified) do
+  %p= @classified.body
+
+%hr
+
+%p= link_to('View Classified', effective_classifieds.classified_path(@classified))
+
+%p Have a great day!

data/app/views/layouts/effective_classifieds_mailer_layout.html.haml

@@ -0,0 +1,7 @@
+!!!
+%html{style: 'background: #fff;'}
+  %head
+    %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
+
+  %body{style: 'background: #fff;'}
+    = yield

data/config/effective_classifieds.rb

@@ -0,0 +1,45 @@
+EffectiveClassifieds.setup do |config|
+  config.classifieds_table_name = :classifieds
+  config.classified_submissions_table_name = :classified_submissions
+
+  # Every classified must have a category.
+  config.categories = ['Job Board', 'Equipment Sales']
+
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+  # config.layout = { application: 'application', admin: 'admin' }
+
+  # Classified Settings
+  # config.classified_submission_class_name = 'Effective::ClassifiedSubmission'
+
+  # Pagination length on the Classified#index page
+  config.per_page = 10
+
+  # Classified can be restricted by role
+  config.use_effective_roles = true
+
+  # Automatically end classifieds after this duration
+  config.max_duration = 3.months
+
+  # Automatically approve classified submissions, otherwise require admin approval
+  config.auto_approve = false
+
+  # Mailer Configuration
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Effective::ClassifiedsMailer'
+
+  # Configure the parent class responsible to send e-mails.
+  # config.parent_mailer = 'ActionMailer::Base'
+
+  # Default deliver method
+  # config.deliver_method = :deliver_later
+
+  # Default layout
+  # config.mailer_layout = 'effective_classifieds_mailer_layout'
+
+  # Default From
+  config.mailer_sender = "no-reply@example.com"
+
+  # Send Admin correspondence To
+  config.mailer_admin = "admin@example.com"
+end

data/config/routes.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  mount EffectiveClassifieds::Engine => '/', as: 'effective_classifieds'
+end
+
+EffectiveClassifieds::Engine.routes.draw do
+  # Public routes
+  scope module: 'effective' do
+    resources :classifieds, only: [:index, :show, :edit, :update]
+
+    resources :classified_submissions, only: [:new, :show, :destroy] do
+      resources :build, controller: :classified_submissions, only: [:show, :update]
+    end
+
+  end
+
+  namespace :admin do
+    resources :classifieds, except: [:show] do
+      post :approve, on: :member
+    end
+  end
+
+end

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

@@ -0,0 +1,62 @@
+class CreateEffectiveClassifieds < ActiveRecord::Migration[6.1]
+  def change
+    create_table <%= @classifieds_table_name %> do |t|
+      t.integer :classified_submission_id
+      t.string :classified_submission_type
+
+      t.integer :owner_id
+      t.string :owner_type
+
+      t.string :title
+      t.string :category
+
+      t.string :organization
+      t.string :location
+
+      t.string :website
+      t.string :email
+      t.string :phone
+
+      t.datetime :start_on
+      t.datetime :end_on
+
+      t.string :slug
+
+      t.string :status
+      t.text :status_steps
+
+      t.integer :roles_mask
+      t.boolean :authenticate_user, default: false
+
+      t.boolean :archived, default: false
+
+      t.timestamps
+    end
+
+    add_index :classifieds, [:owner_id, :owner_type]
+    add_index :classifieds, :slug
+
+    create_table <%= @classified_submissions_table_name %> do |t|
+      t.string :token
+
+      t.integer :owner_id
+      t.string :owner_type
+
+      # Acts as Statused
+      t.string :status
+      t.text :status_steps
+
+      # Acts as Wizard
+      t.text :wizard_steps
+
+      # Dates
+      t.datetime :submitted_at
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :classified_submissions, [:owner_id, :owner_type]
+    add_index :classified_submissions, :token
+  end
+end

data/db/seeds.rb

@@ -0,0 +1 @@
+puts "Running effective_classifieds seeds"

data/lib/effective_classifieds/engine.rb

@@ -0,0 +1,18 @@
+module EffectiveClassifieds
+  class Engine < ::Rails::Engine
+    engine_name 'effective_classifieds'
+
+    # Set up our default configuration options.
+    initializer 'effective_classifieds.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_classifieds.rb")
+    end
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_classifieds.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(EffectiveClassifiedsClassifiedSubmission::Base)
+      end
+    end
+
+  end
+end

data/lib/effective_classifieds/version.rb

@@ -0,0 +1,3 @@
+module EffectiveClassifieds
+  VERSION = '0.0.2'.freeze
+end