RubyGems - integral - Versions diffs - 1.0.0 - Mend

integral 1.0.0

Files changed (761) hide show

data/app/helpers/integral/backend/base_helper.rb ADDED

@@ -0,0 +1,72 @@
+module Integral
+  # View helper methods for Backend pages
+  module Backend
+    # Base Backend Helper
+    module BaseHelper
+      include Integral::SupportHelper
+      # @return [String] title provided through yield or i18n scoped to controller namespace & action
+      def page_title
+        return content_for(:title) if content_for?(:title)
+        # Scope is set to current controller namespace & action
+        t('title', scope: "#{controller_path.tr('/', '.')}.#{action_name}")
+      end
+      # Renders a grid from a local partial within a datagrid container
+      def render_data_grid
+        return content_tag(:div, render(partial: 'grid', locals: { grid: @grid }), data: { 'grid' => true, 'form' => 'grid_form' }) unless block_given?
+        content_tag :div, data: { 'grid' => true, 'form' => 'grid_form' } do
+          yield
+        end
+      end
+      # Data which is embedded into the backend <body> tag
+      def body_data_attributes
+        {
+          locale: I18n.locale,
+          'user-name' => current_user.name,
+          'user-email' => current_user.email,
+          'user-created-at' => current_user.created_at.to_i
+        }
+      end
+      # Backend Google Tag Manager Snippet
+      # @return [String] GTM Container if ID has been supplied
+      def google_tag_manager(type = :script)
+        GoogleTagManager.render(Integral.gtm_container_id, type)
+      end
+      # Renders a line chart
+      def render_line_chart(dataset)
+        ChartRenderer::Line.render(dataset)
+      end
+      # Renders a donut chart
+      def render_donut_chart(dataset)
+        ChartRenderer::Donut.render(dataset)
+      end
+      # Donut Graph - At a Glance
+      def dataset_dashboard_atg
+        [
+          { scope: Integral::Page, label: 'Total Pages' },
+          { scope: Integral::List, label: 'Total Lists' },
+          { scope: Integral::Image, label: 'Total Images' },
+          { scope: Integral::User, label: 'Total Users' }
+        ]
+      end
+      # Line graph - Last week
+      def dataset_dashboard_last_week
+        [
+          { scope: Integral::Page, label: 'Pages' },
+          { scope: Integral::List, label: 'Lists' },
+          { scope: Integral::Image, label: 'Images' },
+          { scope: Integral::User, label: 'Users' }
+        ]
+      end
+    end
+  end
+end

data/app/helpers/integral/blog_helper.rb ADDED

@@ -0,0 +1,26 @@
+module Integral
+  # Blog Helper which contains methods used through the blog
+  module BlogHelper
+    # Whether or not to display newsletter signup widget
+    def display_newsletter_signup_widget?
+      true
+    end
+    # Whether or not to display share widget
+    def display_share_widget?
+      return true if "#{controller_name}.#{action_name}" == 'posts.show'
+      false
+    end
+    # Whether or not to display recent posts sidebar widget
+    def display_recent_posts_widget?
+      return false if "#{controller_name}.#{action_name}" == 'posts.index'
+      true
+    end
+    # Whether or not to display recent posts sidebar widget
+    def display_popular_posts_widget?
+      Integral::Post.published.count > 4
+    end
+  end
+end

data/app/helpers/integral/gallery_helper.rb ADDED

@@ -0,0 +1,36 @@
+module Integral
+  # Gallery Helper which contains methods used to help render image galleries
+  module GalleryHelper
+    # Renders a thumbnail gallery
+    def render_thumb_gallery(list, opts = {})
+      opts.reverse_merge!(
+        renderer: Integral::SwiperListRenderer,
+        item_renderer: Integral::PartialListItemRenderer,
+        item_renderer_opts: {
+          partial_path: 'integral/shared/gallery/thumb_slide',
+          wrapper_element: 'div',
+          image_version: :small,
+          html_classes: 'swiper-slide'
+        }
+      )
+      opts[:renderer].render(list, opts).html_safe
+    end
+    # Renders an image gallery using the provided list
+    def render_gallery(list, opts = {})
+      opts.reverse_merge!(
+        renderer: Integral::SwiperListRenderer,
+        item_renderer: Integral::PartialListItemRenderer,
+        item_renderer_opts: {
+          partial_path: 'integral/shared/gallery/slide',
+          wrapper_element: 'div',
+          image_version: :large,
+          html_classes: 'swiper-slide'
+        }
+      )
+      opts[:renderer].render(list, opts).html_safe
+    end
+  end
+end

data/app/helpers/integral/mail_helper.rb ADDED

@@ -0,0 +1,16 @@
+module Integral
+  # Mail helper
+  module MailHelper
+    # @return [String] <a> tag containing URL of website and hostname as label
+    def website_url
+      full_url = Rails.application.routes.default_url_options[:host]
+      hostname = Addressable::URI.parse(full_url).host
+      link_to hostname, full_url
+    end
+    # @return [String] html tag containing title. Could override this to instead render an image.
+    def title
+      content_tag :h1, Integral::Settings.website_title
+    end
+  end
+end

data/app/helpers/integral/social_helper.rb ADDED

@@ -0,0 +1,123 @@
+module Integral
+  # Social Helper which contains methods relating to social networking
+  module SocialHelper
+    # Twitter social sharing
+    # URL snippet built from - https://sharingbuttons.io/
+    #
+    # @param [Hash] opts the options to create the share URL
+    # @option opts [String] :url Supply URL if would like to share URL other than the current
+    # @option opts [String] :message The message to provide a message for the tweet.
+    #
+    # @return [String] Twitter URL to share a page
+    def twitter_share_url(opts = {})
+      page_url = opts.fetch(:url, request.original_url)
+      message = opts.fetch(:message, '')
+      page_url = CGI.escape(page_url)
+      share_url = "https://twitter.com/intent/tweet/?url=#{page_url}"
+      share_url += "&amp;text=#{CGI.escape(message)}" if message.present?
+      share_url
+    end
+    # Facebook social sharing
+    # URL snippet built from - https://sharingbuttons.io/
+    #
+    # @param [Hash] opts the options to create the share URL
+    # @option opts [String] :url Supply URL if would like to share URL other than the current
+    #
+    # @return [String] Facebook URL to share a page
+    def facebook_share_url(opts = {})
+      page_url = opts.fetch(:url, request.original_url)
+      page_url = CGI.escape(page_url)
+      share_url = "https://facebook.com/sharer/sharer.php?u=#{page_url}"
+      share_url
+    end
+    # Google Plus social sharing
+    # URL snippet built from - https://sharingbuttons.io/
+    #
+    # @param [Hash] opts the options to create the share URL
+    # @option opts [String] :url Supply URL if would like to share URL other than the current
+    #
+    # @return [String] Google Plus URL to share a page
+    def google_plus_share_url(opts = {})
+      page_url = opts.fetch(:url, request.original_url)
+      page_url = CGI.escape(page_url)
+      share_url = "https://plus.google.com/share?url=#{page_url}"
+      share_url
+    end
+    # Linkedin social sharing
+    # URL snippet built from - https://sharingbuttons.io/
+    #
+    # @param [Hash] opts the options to create the share URL
+    # @option opts [String] :url Supply URL if would like to share URL other than the current
+    # @option opts [String] :message The message to provide a message for the tweet.
+    #
+    # @return [String] Linkedin URL to share a page
+    def linkedin_share_url(opts = {})
+      page_url = opts.fetch(:url, request.original_url)
+      message = opts.fetch(:message, '')
+      page_url = CGI.escape(page_url)
+      share_url = "https://www.linkedin.com/shareArticle?mini=true&amp;url=#{page_url}"
+      share_url += "&amp;title=#{CGI.escape(message)}" if message.present?
+      share_url
+    end
+    # Github URL set from within Backend Settings area
+    #
+    # @return [String] Github URL
+    def github_url
+      Settings.github_url
+    end
+    # Twitter Profile URL set from within Backend Settings area
+    #
+    # @return [String] Twitter URL
+    def twitter_url
+      Settings.twitter_url
+    end
+    # Facebook Profile URL set from within Backend Settings area
+    #
+    # @return [String] Facebook URL
+    def facebook_url
+      Settings.facebook_url
+    end
+    # Youtube Profile URL set from within Backend Settings area
+    #
+    # @return [String] Youtube URL
+    def youtube_url
+      Settings.youtube_url
+    end
+    # Google Plus Profile URL set from within Backend Settings area
+    #
+    # @return [String] Youtube URL
+    def google_plus_url
+      Settings.google_plus_url
+    end
+    # Linkedin Profile URL set from within Backend Settings area
+    #
+    # @return [String] Linkedin URL
+    def linkedin_url
+      Settings.linkedin_url
+    end
+    # Instagram Profile URL set from within Backend Settings area
+    #
+    # @return [String] Instagram URL
+    def instagram_url
+      Settings.instagram_url
+    end
+  end
+end

data/app/helpers/integral/support_helper.rb ADDED

@@ -0,0 +1,60 @@
+module Integral
+  # Support Helper which contains common helper methods used within backend & frontend
+  module SupportHelper
+    # @return [String] markup listing flash notifications
+    def render_flashes
+      flash_types = %i[notice alert error]
+      content_tag :div, id: :flash_list do
+        flash_types.each do |type|
+          concat render_flash(type, flash[type]) if flash[type].present?
+        end
+      end
+    end
+    # Creates an anchor link
+    #
+    # @param body [String] body of the link
+    # @param location [String] location of the anchor
+    #
+    # @return [String] anchor to a particular location of the current page
+    def anchor_to(body, location)
+      current_path = url_for(only_path: false)
+      path = "#{current_path}##{location}"
+      link_to body, path
+    end
+    # Override method_missing to check for main app routes before throwing exception
+    def method_missing(method, *args, &block)
+      if method.to_s.end_with?('_path', '_url')
+        if main_app.respond_to?(method)
+          main_app.send(method, *args)
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+    # Override respond_to? to check for main app routes
+    def respond_to?(method, include_all = false)
+      if method.to_s.end_with?('_path', '_url')
+        if main_app.respond_to?(method)
+          true
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+    private
+    def render_flash(type, message)
+      content_tag(:div, nil, class: :flash, data: { message: message, klass: type })
+    end
+  end
+end

data/app/jobs/integral/application_job.rb ADDED

@@ -0,0 +1,10 @@
+module Integral
+  # All jobs inherit this behaviour
+  class ApplicationJob < ActiveJob::Base
+    # Automatically retry jobs that encountered a deadlock
+    # retry_on ActiveRecord::Deadlocked
+    # Most jobs are safe to ignore if the underlying records are no longer available
+    # discard_on ActiveJob::DeserializationError
+  end
+end

data/app/jobs/integral/newsletter_signup_job.rb ADDED

@@ -0,0 +1,28 @@
+module Integral
+  # Carry out actual newsletter signing up process
+  class NewsletterSignupJob < ApplicationJob
+    queue_as :default
+    rescue_from(Gibbon::MailChimpError) do |e|
+      error_msg = "NewsletterSignupJob - Error when signing visitor up to Newsletter: #{e.message}"
+      Rails.logger.error(error_msg)
+    end
+    # Attempts to signup an email to newsletter
+    def perform(signup)
+      return unless NewsletterSignup.api_available?
+      gibbon = Gibbon::Request.new(api_key: Settings.newsletter_api_key)
+      request_body = { email_address: signup.email, status: 'subscribed' }
+      gibbon.lists(newsletter_list_id(signup)).members.create(body: request_body)
+      # Update signup when the response is successful (in this case - if no error returned)
+      signup.update_attribute(:processed, true)
+    end
+    # @return [String] The newsletter identifier to sign up to
+    def newsletter_list_id(*)
+      Settings.newsletter_list_id
+    end
+  end
+end

data/app/mailers/integral/contact_mailer.rb ADDED

@@ -0,0 +1,56 @@
+module Integral
+  # Handles sending auto replys to visitors and passing on enquiries
+  class ContactMailer < ActionMailer::Base
+    layout 'integral/mailer'
+    helper 'integral/mail'
+    # Send supplied enquiry to contact email
+    #
+    # @param enquiry [Enquiry] enquiry which the visitor has created
+    def forward_enquiry(enquiry)
+      @enquiry = enquiry
+      sender = email_sender(enquiry.name, enquiry.email)
+      mail subject: forwarding_subject(enquiry), from: sender, to: incoming_email_address, reply_to: sender
+    end
+    # Send an auto reply to the visitor of the supplied enquiry
+    #
+    # @param enquiry [Enquiry] enquiry which the visitor has created
+    def auto_reply(enquiry)
+      @enquiry = enquiry
+      sender = email_sender(Integral::Settings.website_title, outgoing_email_address)
+      mail subject: auto_reply_subject(enquiry), to: enquiry.email, from: sender, reply_to: sender
+    end
+    private
+    # Override this to configure the outgoing email address
+    def outgoing_email_address
+      Integral::Settings.contact_email
+    end
+    # Override this to configure the incoming email address
+    def incoming_email_address
+      Integral::Settings.contact_email
+    end
+    # Builds the format so that email clients display name and email nicely
+    def email_sender(name, email)
+      "#{name} <#{email}>"
+    end
+    # Subject of the auto reply
+    def auto_reply_subject(enquiry)
+      I18n.t('integral.contact_mailer.auto_reply.subject', reference: enquiry.reference)
+    end
+    # Subject of the forwarding email
+    # Adds the enquiry subject if it exists otherwise uses only reference
+    def forwarding_subject(enquiry)
+      return "#{enquiry.reference} #{I18n.t('integral.contact_mailer.forward_enquiry.subject')}" if enquiry.subject.blank?
+      "#{enquiry.reference} #{I18n.t('integral.contact_mailer.forward_enquiry.subject')} - #{enquiry.subject}"
+    end
+  end
+end

data/app/models/ckeditor/asset.rb ADDED

@@ -0,0 +1,8 @@
+# CKEditor base asset file
+class Ckeditor::Asset < ActiveRecord::Base
+  include Ckeditor::Orm::ActiveRecord::AssetBase
+  delegate :url, :current_path, :content_type, to: :data
+  validates_presence_of :data
+end