wcc-contentful-app 0.4.0.pre.alpha → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6a7ac206d21b391dfbd7c33d91b97b16e7e42fe9
-  data.tar.gz: 11b71582d95de2d7b85123c01fcf33f512f0af65
+SHA256:
+  metadata.gz: 4d2c8f87432e5df3bfa0ce1438ea0cbc2c89463a2c22c6ebee6a6f766b26b865
+  data.tar.gz: 5899cd069610da0a25a3ff330a4788e5c16f4d25618ca591bc5327678c594a7a
 SHA512:
-  metadata.gz: f579df1cc97c1860ad224426bf06316630d62ab8383a46f6ef943f8885f1f19f79e9de7d9cf69b5a4e01328d53f370685b099483892fce1c4a54f4d43758124f
-  data.tar.gz: caa17fafddab09ac55463fd65a2dfcb49693ddaec3aa527ab2403621a0d1e3f664a89de35714c4e946883029f760e2befeeed280875100d01e8524b83a24ded5
+  metadata.gz: a075b9cd2fc956189d8136848856e22aba9f3998e28e3853d4cbfe4c45d916a1f723e3ba4179b619c2da9af90de6b738b1941fb6cb707b9a922d4bb0075666a1
+  data.tar.gz: 689e7ec2251ff44627f5b70af5a8ce41dcc2d8d1305df6b74890ca8bc24a62c580e6f4c5ca0c892004ea8cb32a461ecbc47a57350dbcc758214495a4efd67d1e

data/.rspec

@@ -1,4 +1,4 @@
---require rails_helper
+--require spec_helper
 --format documentation
 --color
---order rand
+--order rand

data/README.md

@@ -0,0 +1,11 @@
+[![Gem Version](https://badge.fury.io/rb/wcc-contentful-app.svg)](https://rubygems.org/gems/wcc-contentful-app)
+[![Build Status](https://travis-ci.org/watermarkchurch/wcc-contentful.svg?branch=master)](https://travis-ci.org/watermarkchurch/wcc-contentful)
+[![Coverage Status](https://coveralls.io/repos/github/watermarkchurch/wcc-contentful/badge.svg?branch=master)](https://coveralls.io/github/watermarkchurch/wcc-contentful?branch=master)
+
+# WCC::Contentful::App
+
+This gem specifies default models, controllers, views, and javascripts that
+get installed into all Watermarkchurch apps that use contentful.  It is a highly
+opinionated starting point for a very flexible site design using Contentful.
+
+You probably should not use this.

data/Rakefile

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fileutils'
+
+require 'wcc/contentful'
+
+# rubocop:disable Metrics/LineLength
+# Disabling line length for contentful-schema-diff backtick execution
+
+namespace :app do
+  desc "Imports a set of models from a space as a single template for the ModelGenerator.\n" \
+    'Usage: rake wcc:import_model[content-type-id,space-id?,extra-content-type-1,extra-content-type-2...]'
+  task :import_model, [:model, :space] do |_t, args|
+    raise ArgumentError, 'Must give a content type' unless model = args[:model]
+
+    singular = model.downcase.singularize
+    plural = model.downcase.pluralize
+
+    all_models = [model, *args.extras]
+
+    unless space = args[:space].presence
+      space = ENV['CONTENTFUL_SPACE_ID']
+      space = "#{space}/#{ENV['CONTENTFUL_ENVIRONMENT']}" if ENV['CONTENTFUL_ENVIRONMENT']
+    end
+    raise ArgumentError, 'Must provide a space' unless space
+    unless mgmt_token = ENV['CONTENTFUL_MANAGEMENT_TOKEN']
+      raise ArgumentError, 'Must set CONTENTFUL_MANAGEMENT_TOKEN envvar'
+    end
+
+    client = WCC::Contentful::SimpleClient::Management.new(
+      space: space.split('/').first,
+      environment: space.split('/')[1],
+      management_token: mgmt_token
+    )
+
+    # Update the `content_types_mgmt_api.json` which we use to generate models in specs
+    content_types = JSON.parse(File.read('spec/fixtures/contentful/content_types_mgmt_api.json'))
+    all_models.each do |model_id|
+      content_type = client.content_type(model_id).raw
+
+      if index = content_types['items'].find_index { |ct| ct.dig('sys', 'id').casecmp(model_id) == 0 }
+        content_types['items'][index] = content_type
+      else
+        content_types['items'].push(content_type)
+      end
+    end
+    File.write('spec/fixtures/contentful/content_types_mgmt_api.json',
+      JSON.pretty_generate(content_types))
+
+    # Make the generator directory
+    FileUtils.mkdir_p("lib/generators/wcc/templates/#{singular}/models")
+
+    # Generate a migration for the content type
+    File.write('empty-export.json', <<~HEREDOC)
+      {
+        "contentTypes": [],
+        "editorInterfaces": [],
+        "entries": [],
+        "assets": [],
+        "locales": []
+      }
+    HEREDOC
+    begin
+      result = `contentful-schema-diff --from empty-export.json --to #{space} #{all_models.map { |m| "-c #{m}" }.join(' ')} -a '#{mgmt_token}' --out './' --one-file`
+      result = result.strip
+      raise StandardError, 'Error writing diff!' unless result.present?
+
+      FileUtils.mv(result, "lib/generators/wcc/templates/#{singular}/generated_add_#{plural}.ts")
+    ensure
+      File.unlink('empty-export.json')
+    end
+
+    const = WCC::Contentful::Helpers.constant_from_content_type(model)
+
+    # Write a model for the content type
+    File.write("lib/generators/wcc/templates/#{singular}/models/#{singular.tr('-', '_')}.rb", <<~HEREDOC)
+      # frozen_string_literal: true
+
+      # This model represents the '#{model}' content type in Contentful.  Any linked
+      # entries of the '#{model}' content type will be resolved as instances of this class.
+      # It exposes .find, .find_by, and .find_all methods to query Contentful.
+      class #{const} < WCC::Contentful::Model::#{const}
+        # Override functionality or add utilities
+        #
+        # # Example: override equality
+        # def ===(other)
+        #   ...
+        # end
+        #
+        # # Example: override "title" attribute to always be titlecase.
+        # #          `@title` is populated by the gem in the initializer.
+        # def title
+        #   @title_titlecased ||= @title.titlecase
+        # end
+      end
+    HEREDOC
+
+    view_name = const.demodulize.underscore.sub('section_', '')
+    FileUtils.touch("app/views/sections/_#{view_name}.html.erb")
+    File.write("spec/views/sections/_#{view_name}.html.erb_spec.rb", <<~HEREDOC)
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe 'sections/#{view_name}' do
+        helper WCC::Contentful::App::SectionHelper
+
+        it 'renders successfully' do
+          section = contentful_create('#{model}')
+
+          render partial: 'components/section', locals: { section: section }
+
+          expect(rendered).to have_css('section.#{model}.default')
+        end
+      end
+    HEREDOC
+  end
+end
+
+# rubocop:enable Metrics/LineLength
+
+task :release do
+  raise StandardError, 'Please run rake release only from the root folder.'
+end

data/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+// https://eileencodes.com/posts/the-sprockets-4-manifest/
+//= link_tree ../javascripts
+//= link_directory ../stylesheets
+//= link_tree ../images
+

data/app/assets/images/down-arrow-primary.svg

@@ -0,0 +1,3 @@
+<svg width="21" height="13" viewBox="0 0 21 13" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M18.55 0L10.5 8.08108L2.45 0L0 2.45946L10.5 13L21 2.45946L18.55 0Z" fill="#f47754"/>
+</svg>

data/app/assets/images/up-arrow-primary.svg

@@ -0,0 +1,3 @@
+<svg width="21" height="13" viewBox="0 0 21 13" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M2.45 13L10.5 4.91892L18.55 13L21 10.5405L10.5 0L0 10.5405L2.45 13Z" fill="#f47754"/>
+</svg>

data/app/assets/javascripts/wcc/contentful/app/contact-form.js

@@ -0,0 +1,70 @@
+if (typeof window.$ == 'undefined' ) {
+  var $ = window.jQuery
+}
+
+$(function() {
+  function warningAlert(message) {
+    var div = $('<div>')
+      .addClass('alert alert-danger alert-dismissible fade show')
+      .text(message)
+
+    return div.append(
+      '<button type="button" class="close" data-dismiss="alert" aria-label="Close">' +
+        '<span aria-hidden="true">&times;</span>' +
+      '</button>'
+    )
+  }
+
+  function handleResponse($form, event, status, xhr) {
+    // Handle backwards compat for [rails/jquery]-ujs ajax callbacks
+    var json
+    try {
+      if (event.detail) {
+        json = JSON.parse(event.detail[2].response)
+        status = event.detail[1]
+      } else {
+        json = xhr.responseJSON
+      }
+    } catch(ex) {
+      status = 'error'
+      json = {}
+    }
+
+    if (status == 'OK' || status == 'success') {
+      $form.append(
+        $('<span>').text(json.message).delay(2000).fadeOut(2000, function() { $(this).remove() })
+      )
+      $('input:visible, textarea', $form).val('')
+      $('.alert', $form).remove()
+      if (typeof window.grecaptcha != 'undefined') {
+        window.grecaptcha.reset()
+      }
+    } else if (json.message) {
+      $form.append(warningAlert(json.message))
+    } else {
+      $form.append(warningAlert('Sorry, something went wrong.'))
+    }
+  }
+
+  $('[data-contact-form]').each(function(_, input) {
+    var $form = $(input)
+
+    $form.on('ajax:success', function(event, data, status, xhr) {
+      try {
+        handleResponse($form, event, status, xhr)
+      } catch(ex) {
+        alert('Sorry, something went wrong.')
+        throw ex
+      }
+    })
+
+    $form.on('ajax:error', function(event, xhr, status) {
+      try {
+        handleResponse($form, event, status, xhr)
+      } catch(ex) {
+        alert('Sorry, something went wrong.')
+        throw ex
+      }
+    })
+  })
+})

data/app/assets/javascripts/wcc/contentful/app/index.js

@@ -0,0 +1 @@
+//= require_tree .

data/app/assets/stylesheets/_wcc-contentful-app.scss

@@ -0,0 +1,7 @@
+@import './components/menu-item';
+
+@import './sections/faq';
+
+.safe-line-break {
+  white-space: pre-line;
+}

data/app/assets/stylesheets/components/_menu-item.scss

@@ -0,0 +1,5 @@
+.nav-link {
+  .material-icons {
+    vertical-align: middle;
+  }
+}

data/app/assets/stylesheets/sections/_faq.scss

@@ -0,0 +1,39 @@
+.section-faq {
+  &__show-more-button {
+    text-decoration: none;
+
+    &[aria-expanded='false'] {
+      .section-faq__show-more-button__expanded {
+        display: none;
+      }
+    }
+
+    &[aria-expanded='true'] {
+      .section-faq__show-more-button__collapsed {
+        display: none;
+      }
+    }
+  }
+
+  &__faq-question {
+    cursor: pointer;
+  }
+
+  &__expander {
+    display: flex;
+    text-align: right;
+
+    a {
+      text-decoration: none;
+      width: 100%;
+
+      &[aria-expanded='false']::before {
+        content: '+';
+      }
+
+      &[aria-expanded='true']::before {
+        content: '-';
+      }
+    }
+  }
+}

data/app/controllers/wcc/contentful/app/contact_form_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class WCC::Contentful::App::ContactFormController < ApplicationController
+  include WCC::Contentful::App::PreviewPassword
+
+  def create
+    address =
+      form_model.to_address(email_object_id: params[:email_object_id])
+
+    form_model.send_email(
+      form_params.merge!(
+        {
+          notification_email: address,
+          internal_title: params[:internal_title]
+        }
+      )
+    )
+
+    render json: { type: 'success', message: "Thanks for reaching out. We'll be in touch soon!" }
+  end
+
+  private
+
+  def form_model
+    raise ArgumentError, 'missing form ID' unless params[:id]
+
+    @form_model ||= form_class.find(
+      params[:id], options: { preview: preview? }
+    )
+  end
+
+  def form_class
+    WCC::Contentful::Model.resolve_constant('section-contact-form')
+  end
+
+  def form_params
+    params.slice(*form_model.fields.map(&:title))
+  end
+end

data/app/controllers/wcc/contentful/app/pages_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class WCC::Contentful::App::PagesController < ApplicationController
+  include WCC::Contentful::App::PreviewPassword
+
+  helper ::WCC::Contentful::App::SectionHelper
+
+  def index
+    @page = global_site_config&.homepage ||
+      page_model.find_by(slug: '/', options: { include: 3, preview: preview? })
+    render 'pages/show'
+  end
+
+  def show
+    slug = '/' + params[:slug]
+    @page = page_model.find_by(slug: slug, options: { include: 3, preview: preview? })
+
+    return render 'pages/show' if @page
+
+    redirect = redirect_model.find_by(slug: slug, options: { include: 0, preview: preview? })
+    raise WCC::Contentful::App::PageNotFoundError, slug unless redirect
+
+    redirect_to redirect.href
+  end
+
+  private
+
+  def page_model
+    WCC::Contentful::Model.resolve_constant('page')
+  end
+
+  def redirect_model
+    WCC::Contentful::Model.resolve_constant('redirect')
+  end
+
+  def site_config_model
+    # They may have not installed `site-config` in the project
+    WCC::Contentful::Model.resolve_constant('site-config')
+  rescue WCC::Contentful::ContentTypeNotFoundError
+    nil
+  end
+
+  def global_site_config
+    return unless model = site_config_model
+
+    @global_site_config ||= model.instance(preview?)
+  end
+end

data/app/helpers/wcc/contentful/app/menu_helper.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module WCC::Contentful::App::MenuHelper
+  def dropdown?(item)
+    item.respond_to?(:items)
+  end
+
+  def menu_button?(item)
+    item.is_a? WCC::Contentful::Model::MenuButton
+  end
+
+  def item_active?(item)
+    return true if item.try(:label) && item_active?(item.label)
+    return item.items.any? { |i| item_active?(i) } if item.respond_to?(:items)
+    return current_page?(item.href) if item.try(:href)
+
+    false
+  end
+
+  def render_button(button, options = {}, &block)
+    html = render_button_inner_html(button, options, &block)
+
+    if button.try(:external?)
+      push_class('external', options)
+      options[:target] = :_blank
+    end
+    if button.icon.present? || button.material_icon.present? || options.dig(:icon, :fallback)
+      push_class('icon-only', options) unless button.text.present?
+    elsif button.text.present?
+      push_class('text-only', options)
+    end
+
+    push_class(button.style, options) if button.style
+
+    href = button.href
+    href = hash_only(href) if href.present? && local?(href)
+    return link_to(html, href, options) if href.present?
+
+    content_tag(:a, html, options)
+  end
+
+  def render_button_inner_html(button, options = {}, &block)
+    html = render_button_icon(button.icon, options.delete(:icon)) || ''.html_safe
+    html += render_button_material_icon(button.material_icon) + content_tag(:span, button.text)
+
+    html += capture(&block) if block_given?
+    html
+  end
+
+  def render_button_icon(icon, options = {})
+    fallback = options&.delete(:fallback)
+    return fallback&.call unless icon
+
+    options = {
+      alt: icon.description || icon.title,
+      width: icon.file.dig('details', 'image', 'width'),
+      height: icon.file.dig('details', 'image', 'height')
+    }.merge!(options || {})
+    image_tag(icon&.file&.url, options)
+  end
+
+  def render_button_material_icon(material_icon)
+    content_tag(:i, material_icon&.downcase, class: ['material-icons'])
+  end
+
+  def push_class(classes, options)
+    options[:class] = [*classes, *options[:class]]
+  end
+
+  def hash_only(href)
+    url = URI(href)
+    '#' + url.fragment if url.fragment.present?
+  end
+
+  # An href is local if it points to a part of the page
+  def local?(href)
+    return true if href =~ /^#/
+
+    url = URI(href)
+    return false unless url.fragment.present?
+
+    url.fragment = nil
+    current_page?(url.to_s)
+  end
+end