wcc-contentful 0.2.2 → 0.3.0.pre.rc

data/lib/generators/wcc/templates/menu/generated_add_menus.ts

@@ -1,90 +0,0 @@
-
-import Migration from 'contentful-migration-cli'
-
-export = function (migration: Migration) {
-  const menu = migration.createContentType('menu')
-    .name('Menu')
-    .description('A Menu contains a number of Menu Buttons or other Menus, which ' +
-     'will be rendered as drop-downs.')
-    .displayField('name') 
-
-  menu.createField('name')
-    .name('Menu Name')
-    .type('Symbol')
-    .required(true)
-
-  menu.createField('topButton')
-    .name('Top Button')
-    .type('Link')
-    .linkType('Entry')
-    .validations([
-      { 
-        linkContentType: [ 'menuButton' ],
-        message: 'The Top Button must be a button linking to a URL or page.  ' +
-          'If the menu is a dropdown, this button is visible when it is collapsed.'
-      }
-    ])
-  
-  menu.createField('items')
-    .name('Items')
-    .type('Array')
-    .items({
-      type: 'Link',
-      linkType: 'Entry',
-      validations: [
-        { 
-          linkContentType: [ 'menu', 'menuButton' ],
-          message: 'The items must be either buttons or drop-down menus'
-        }
-      ]
-    })
-
-  const menuButton = migration.createContentType('menuButton')
-    .name('Menu Button')
-    .description('A Menu Button is a clickable button that goes on a Menu.  ' +
-      'It has a link to a Page or a URL.')
-    .displayField('text')
-
-  menuButton.createField('text')
-    .name('Text')
-    .type('Symbol')
-    .required(true)
-    .validations([
-      { 
-        size: { min: 1, max: 60 },
-        message: 'A Menu Button should have a very short text field - ideally a ' +
-          'single word.  Please limit the text to 60 characters.'
-      }
-    ])
-
-  menuButton.createField('icon')
-    .name('Icon')
-    .type('Link')
-    .linkType('Asset')
-    .validations([
-      {
-        linkMimetypeGroup: ['image']
-      }
-    ])
-  
-  menuButton.createField('externalLink')
-    .name('External Link')
-    .type('Symbol')
-    .validations([
-      {
-        regexp: { pattern: "^(ftp|http|https):\\/\\/(\\w+:{0,1}\\w*@)?(\\S+)(:[0-9]+)?(\\/|\\/([\\w#!:.?+=&%@!\\-\\/]))?$" },
-        message: "The external link must be a URL like 'https://www.watermark.org/'" 
-      }
-    ])
-  
-  menuButton.createField('link')
-    .name('Page Link')
-    .type('Link')
-    .linkType('Entry')
-    .validations([
-      {
-        linkContentType: [ 'page' ],
-        message: 'The Page Link must be a link to a Page which has a slug.'
-      }
-    ])
-}

data/lib/generators/wcc/templates/menu/models/menu.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# This model represents the 'menu' content type in Contentful.  Any linked
-# entries of the 'menu' content type will be resolved as instances of this class.
-# It exposes #find, #find_by, and #find_all methods to query Contentful.
-class Menu < WCC::Contentful::Model::Menu
-  # Add custom validations to ensure that app-specific properties exist:
-  # validate_field :foo, :String, :required
-  # validate_field :bar_links, :Array, link_to: %w[bar baz]
-
-  # Override functionality or add utilities
-  #
-  # # Example: override equality
-  # def ===(other)
-  #   ...
-  # end
-  #
-  # # Example: override "name" attribute to always be camelized.
-  # #          `@name` is populated by the gem in the initializer.
-  # def name
-  #   @name_camelized ||= @name.camelize(true)
-  # end
-end

data/lib/generators/wcc/templates/menu/models/menu_button.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# This model represents the 'menuButton' content type in Contentful.  Any linked
-# entries of the 'menuButton' content type will be resolved as instances of this class.
-# It exposes #find, #find_by, and #find_all methods to query Contentful.
-class MenuButton < WCC::Contentful::Model::MenuButton
-  # Add custom validations to ensure that app-specific properties exist:
-  # validate_field :foo, :String, :required
-  # validate_field :bar_links, :Array, link_to: %w[bar baz]
-
-  # Override functionality or add utilities
-  #
-  # # Example: override equality
-  # def ===(other)
-  #   ...
-  # end
-  #
-  # # Example: override "text" attribute to always be camelized.
-  # #          `@text` is populated by the gem in the initializer.
-  # def text
-  #   @text_camelized ||= @text.camelize(true)
-  # end
-end

data/lib/generators/wcc/templates/page/generated_add_pages.ts

@@ -1,50 +0,0 @@
-import Migration from 'contentful-migration-cli'
-
-export = function (migration: Migration) {
-  const page = migration.createContentType('page')
-    .name('Page')
-    .description('A page describes a collection of sections that correspond' +
-     'to a URL slug')
-    .displayField('title')
-
-  page.createField('title')
-    .name('Title')
-    .type('Symbol')
-    .required(true)
-
-  page.createField('slug')
-    .name('Slug')
-    .type('Symbol')
-    .required(true)
-    .validations([
-      {
-        unique: true
-      },
-      {
-        regexp: { pattern: "(\\/|\\/([\w#!:.?+=&%@!\\-\\/]))?$" },
-        message: "The slug must look like the path part of a URL and begin with a forward slash, example: '/my-page-slug'"
-      }
-    ])
-
-  page.createField('sections')
-    .name('Sections')
-    .type('Array')
-    .items({
-      type: 'Link',
-      linkType: 'Entry'
-    })
-
-  page.createField('subpages')
-    .name('Subpages')
-    .type('Array')
-    .items({
-      type: 'Link',
-      linkType: 'Entry',
-      validations: [
-        {
-          linkContentType: [ 'page' ]
-        }
-      ]
-    })
-
-}

data/lib/generators/wcc/templates/page/models/page.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# This model represents the 'page' content type in Contentful.  Any linked
-# entries of the 'page' content type will be resolved as instances of this class.
-# It exposes #find, #find_by, and #find_all methods to query Contentful.
-class Page < WCC::Contentful::Model::Page
-  # Add custom validations to ensure that app-specific properties exist:
-  # validate_field :foo, :String, :required
-  # validate_field :bar_links, :Array, link_to: %w[bar baz]
-
-  # 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

data/lib/generators/wcc/templates/release

@@ -1,9 +0,0 @@
-#!/bin/sh
-
-set -e
-
-echo "Migrating database..."
-bundle exec rake db:migrate
-
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-$DIR/contentful migrate -y

data/lib/generators/wcc/templates/wcc_contentful.rb

@@ -1,17 +0,0 @@
-
-WCC::Contentful.configure do |config|
-  # Required
-  config.access_token = # Contentful CDN access token
-  config.space = # Contentful Space ID
-
-  # Optional
-  config.management_token = # Contentful API management token
-  config.default_locale = # Set default locale, if left blank this is 'en-US'
-  config.content_delivery = # :direct, :eager_sync, or :lazy_sync
-end
-
-# Download content types, build models, and sync content
-WCC::Contentful.init!
-
-# Validate that models conform to a defined specification
-WCC::Contentful.validate_models! unless defined?(Rails) && Rails.env.development?

data/lib/wcc/contentful/model/menu.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class WCC::Contentful::Model::Menu < WCC::Contentful::Model
-  validate_field :name, :String
-  validate_field :top_button, :Link, :optional, link_to: 'menuButton'
-  validate_field :items, :Array, link_to: %w[menu menuButton]
-end

data/lib/wcc/contentful/model/menu_button.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-class WCC::Contentful::Model::MenuButton < WCC::Contentful::Model
-  validate_field :text, :String, :required
-  validate_field :icon, :Asset, :optional
-  validate_field :external_link, :String, :optional
-  validate_field :link, :Link, :optional, link_to: 'page'
-
-  # Gets either the external link or the slug from the referenced page.
-  # Example usage: `<%= link_to button.title, button.href %>`
-  def href
-    return external_link if external_link
-    link&.try(:slug) || link&.try(:url)
-  end
-end

data/lib/wcc/contentful/model/page.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-class WCC::Contentful::Model::Page < WCC::Contentful::Model
-  validate_field :title, :String
-  validate_field :slug, :String
-  validate_field :subpages, :Array, link_to: %w[page]
-  validate_field :sections, :Array, link_to: /^section/
-end

data/lib/wcc/contentful/model/redirect.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-class WCC::Contentful::Model::Redirect < WCC::Contentful::Model
-  def href
-    if !url.nil?
-      url
-    elsif valid_page_reference?(pageReference)
-      "/#{pageReference.url}"
-    end
-  end
-
-  def valid_page_reference?(page_ref)
-    if !page_ref.nil? && !defined?(page_ref.url).nil?
-      true
-    else
-      false
-    end
-  end
-end

data/lib/wcc/contentful/model_validators.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry-validation'
-
-require_relative 'model_validators/dsl'
-
-module WCC::Contentful::ModelValidators
-  def schema
-    return if validations.nil? || validations.empty?
-
-    all_field_validations =
-      validations.each_with_object({}) do |(content_type, procs), h|
-        next if procs.empty?
-
-        # "page": {
-        #   "sys": { ... }
-        #   "fields": {
-        #     "title": { ... },
-        #     "sections": { ... },
-        #     ...
-        #   }
-        # }
-        h[content_type] =
-          Dry::Validation.Schema do
-            # Had to dig through the internals of Dry::Validation to find
-            # this magic incantation
-            procs.each { |dsl| instance_eval(&dsl.to_proc) }
-          end
-      end
-
-    Dry::Validation.Schema do
-      all_field_validations.each do |content_type, fields_schema|
-        required(content_type).schema do
-          required('fields').schema(fields_schema)
-        end
-      end
-    end
-  end
-
-  def validations
-    # This needs to be a class variable so that subclasses defined in application
-    # code can add to the total package of model validations
-    # rubocop:disable Style/ClassVars
-    @@validations ||= {}
-    # rubocop:enable Style/ClassVars
-  end
-
-  ##
-  # Accepts a block which uses the {dry-validation DSL}[http://dry-rb.org/gems/dry-validation/]
-  # to validate the 'fields' object of a content type.
-  def validate_fields(&block)
-    raise ArgumentError, 'validate_fields requires a block' unless block_given?
-    dsl = ProcDsl.new(Proc.new(&block))
-
-    ct = try(:content_type) || name.demodulize.camelize(:lower)
-    (validations[ct] ||= []) << dsl
-  end
-
-  ##
-  # Validates a single field is of the expected type.
-  # Type expectations are one of:
-  #
-  # [:String]   the field type must be `Symbol` or `Text`
-  # [:Int]      the field type must be `Integer`
-  # [:Float]    the field type must be `Number`
-  # [:DateTime] the field type must be 'Date'
-  # [:Asset]    the field must be a link and the `linkType` must be `Asset`
-  # [:Link]     the field must be a link and the `linkType` must be `Entry`.
-  # [:Location] the field type must be `Location`
-  # [:Boolean]  the field type must be `Boolean`
-  # [:Json]     the field type must be `Json` - a json blob.
-  # [:Array]    the field must be a List.
-  #
-  # Additional validation options can be enforced:
-  #
-  # [:required] the 'Required Field' checkbox must be checked
-  # [:optional] the 'Required Field' checkbox must not be checked
-  # [:link_to]  (only `:Link` or `:Array` type) the given content type(s) must be
-  #             checked in the 'Accept only specified entry type' validations
-  #             Example:
-  #               validate_field :button, :Link, link_to: ['button', 'altButton']
-  #
-  # [:items]    (only `:Array` type) the items of the list must be of the given type.
-  #             Example:
-  #               validate_field :my_strings, :Array, items: :String
-  #
-  # Examples:
-  # see WCC::Contentful::Model::Menu and WCC::Contentful::Model::MenuButton
-  def validate_field(field, type, *options)
-    dsl = FieldDsl.new(field, type, options)
-
-    ct = try(:content_type) || name.demodulize.camelize(:lower)
-    (validations[ct] ||= []) << dsl
-  end
-
-  ##
-  # Accepts a content types response from the API and transforms it
-  # to be acceptible for the validator.
-  def self.transform_content_types_for_validation(content_types)
-    if !content_types.is_a?(Array) && items = content_types.try(:[], 'items')
-      content_types = items
-    end
-
-    # Transform the array into a hash keyed by content type ID
-    content_types.each_with_object({}) do |ct, ct_hash|
-      # Transform the fields into a hash keyed by field ID
-      ct['fields'] =
-        ct['fields'].each_with_object({}) do |f, f_hash|
-          f_hash[f['id']] = f
-        end
-
-      ct_hash[ct.dig('sys', 'id')] = ct
-    end
-  end
-end

data/lib/wcc/contentful/model_validators/dsl.rb

@@ -1,165 +0,0 @@
-# frozen_string_literal: true
-
-module WCC::Contentful::ModelValidators
-  class ProcDsl
-    def to_proc
-      @proc
-    end
-
-    def initialize(proc)
-      @proc = proc
-    end
-  end
-
-  class FieldDsl
-    attr_reader :field
-
-    # "sections": {
-    #   "id": "sections",
-    #   "name": "Sections",
-    #   "type": "Array",
-    #   "localized": false,
-    #   "required": false,
-    #   "validations": [],
-    #   "disabled": false,
-    #   "omitted": false,
-    #   "items": {
-    #     "type": "Link",
-    #     "validations": [
-    #       {
-    #         "linkContentType": [
-    #           "Section"
-    #         ]
-    #       }
-    #     ],
-    #     "linkType": "Entry"
-    #   }
-    # }
-
-    def schema
-      return @field_schema if @field_schema
-
-      # example: required('type').value(...)
-      type_pred = parse_type_predicate(@type)
-
-      # example: [required('required').value(eq?: true), ...]
-      procs =
-        @options.map do |opt|
-          if opt.is_a?(Hash)
-            opt.map { |k, v| parse_option(k, v) }
-          else
-            parse_option(opt)
-          end
-        end
-
-      @field_schema =
-        Dry::Validation.Schema do
-          instance_eval(&type_pred)
-
-          procs.flatten.each { |p| instance_eval(&p) }
-        end
-    end
-
-    def to_proc
-      f = field
-      s = schema
-      proc { required(f).schema(s) }
-    end
-
-    def initialize(field, field_type, options)
-      @field = field.to_s.camelize(:lower) unless field.is_a?(String)
-      @type = field_type
-      @options = options
-    end
-
-    private
-
-    def parse_type_predicate(type)
-      case type
-      when :String
-        proc { required('type').value(included_in?: %w[Symbol Text]) }
-      when :Int
-        proc { required('type').value(eql?: 'Integer') }
-      when :Float
-        proc { required('type').value(eql?: 'Number') }
-      when :DateTime
-        proc { required('type').value(eql?: 'Date') }
-      when :Asset
-        proc {
-          required('type').value(eql?: 'Link')
-          required('linkType').value(eql?: 'Asset')
-        }
-      else
-        proc { required('type').value(eql?: type.to_s.camelize) }
-      end
-    end
-
-    def parse_option(option, option_arg = nil)
-      case option
-      when :required
-        proc { required('required').value(eql?: true) }
-      when :optional
-        proc { required('required').value(eql?: false) }
-      when :link_to
-        link_to_proc = parse_field_link_to(option_arg)
-        return link_to_proc unless @type.to_s.camelize == 'Array'
-        proc {
-          required('items').schema do
-            required('type').value(eql?: 'Link')
-            instance_eval(&link_to_proc)
-          end
-        }
-      when :items
-        type_pred = parse_type_predicate(option_arg)
-        proc {
-          required('items').schema do
-            instance_eval(&type_pred)
-          end
-        }
-      else
-        raise ArgumentError, "unknown validation requirement: #{option}"
-      end
-    end
-
-    def parse_field_link_to(option_arg)
-      raise ArgumentError, 'validation link_to: requires an argument' unless option_arg
-
-      # this works because a Link can only have one validation in its "validations" array -
-      # this will fail if Contentful ever changes that.
-
-      # the 'validations' schema needs to be optional because if we get the content
-      # types from the CDN instead of the management API, sometimes the validations
-      # don't get sent back.
-
-      # "validations": [
-      #   {
-      #     "linkContentType": [
-      #       "section-CardSearch",
-      #       "section-Faq",
-      #       "section-Testimonials",
-      #       "section-VideoHighlight"
-      #     ]
-      #   }
-      # ]
-
-      if option_arg.is_a?(Regexp)
-        return proc {
-          optional('validations').each do
-            schema do
-              required('linkContentType').each(format?: option_arg)
-            end
-          end
-        }
-      end
-
-      option_arg = [option_arg] unless option_arg.is_a?(Array)
-      proc {
-        optional('validations').each do
-          schema do
-            required('linkContentType').value(eql?: option_arg)
-          end
-        end
-      }
-    end
-  end
-end