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

data/lib/generators/wcc/templates/section-testimonial/models/section_testimonial.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This model represents the 'section-testimonials' content type in Contentful.  Any linked
+# entries of the 'section-testimonials' content type will be resolved as instances of this class.
+# It exposes .find, .find_by, and .find_all methods to query Contentful.
+class SectionTestimonials < WCC::Contentful::Model::SectionTestimonials
+  # 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/section-video-highlight/migrations/generated_add_section-video-highlights.ts

@@ -0,0 +1,80 @@
+import Migration, { MigrationFunction } from '@watermarkchurch/contentful-migration'
+
+// Generated by contentful-schema-diff
+// from empty-export.json
+// to   7yx6ovlj39n5
+export = function(migration : Migration, { makeRequest, spaceId, accessToken }) {
+
+  /************  section-video-highlight  ******************/
+
+  var sectionVideoHighlight = migration.createContentType('section-video-highlight', {
+    displayField: 'internalTitle',
+    name: 'Section: Video Highlight',
+    description: 'Highlight a video with some text'
+  })
+
+  sectionVideoHighlight.createField('internalTitle', {
+    name: 'Internal Title (Contentful Only)',
+    type: 'Symbol',
+    localized: false,
+    required: true,
+    validations: [],
+    disabled: false,
+    omitted: true
+  })
+
+  sectionVideoHighlight.createField('tag', {
+    name: 'Tag',
+    type: 'Symbol',
+    localized: true,
+    required: false,
+    validations:
+      [{
+        size: { min: 0, max: 75 },
+        message: 'Tag must be short!'
+      }],
+    disabled: false,
+    omitted: false
+  })
+
+  sectionVideoHighlight.createField('title', {
+    name: 'Title',
+    type: 'Symbol',
+    localized: false,
+    required: true,
+    validations: [],
+    disabled: false,
+    omitted: false
+  })
+
+  sectionVideoHighlight.createField('subtext', {
+    name: 'Subtext',
+    type: 'Text',
+    localized: true,
+    required: false,
+    validations: [{ size: { min: 0, max: 500 } }],
+    disabled: false,
+    omitted: false
+  })
+
+  sectionVideoHighlight.createField('embedCode', {
+    name: 'Embed Code',
+    type: 'Text',
+    localized: false,
+    required: true,
+    validations: [],
+    disabled: false,
+    omitted: false
+  })
+
+  sectionVideoHighlight.changeEditorInterface('tag', 'singleLine')
+
+  sectionVideoHighlight.changeEditorInterface('title', 'singleLine')
+
+  sectionVideoHighlight.changeEditorInterface('subtext', 'markdown')
+
+  sectionVideoHighlight.changeEditorInterface('embedCode', 'markdown')
+
+  sectionVideoHighlight.changeEditorInterface('internalTitle', 'singleLine')
+
+} as MigrationFunction

data/lib/generators/wcc/templates/section-video-highlight/models/section_video_highlight.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This model represents the 'section-video-highlight' content type in Contentful.  Any linked
+# entries of the 'section-video-highlight' content type will be resolved as instances of this class.
+# It exposes .find, .find_by, and .find_all methods to query Contentful.
+class SectionVideoHighlight < WCC::Contentful::Model::SectionVideoHighlight
+  # 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/section-video/migrations/generated_add_section-videos.ts

@@ -0,0 +1,77 @@
+import Migration, { MigrationFunction } from '@watermarkchurch/contentful-migration'
+
+// Generated by contentful-schema-diff
+// from empty-export.json
+// to   7yx6ovlj39n5
+export = function(migration : Migration, { makeRequest, spaceId, accessToken }) {
+
+  /************  section-video  ******************/
+
+  var sectionVideo = migration.createContentType('section-video', {
+    displayField: 'internalTitle',
+    name: 'Section: Video',
+    description: 'Full width video with a title'
+  })
+
+  sectionVideo.createField('internalTitle', {
+    name: 'Internal Title (Contentful Only)',
+    type: 'Symbol',
+    localized: false,
+    required: true,
+    validations: [],
+    disabled: false,
+    omitted: true
+  })
+
+  sectionVideo.createField('title', {
+    name: 'Title',
+    type: 'Symbol',
+    localized: true,
+    required: false,
+    validations:
+      [{
+        size:
+        {
+          max: 255,
+          min: 0
+        }
+      }],
+    disabled: false,
+    omitted: false
+  })
+
+  sectionVideo.createField('embedCode', {
+    name: 'Embed Code',
+    type: 'Text',
+    localized: false,
+    required: true,
+    validations: [],
+    disabled: false,
+    omitted: false
+  })
+
+  sectionVideo.createField('style', {
+    name: 'Style',
+    type: 'Symbol',
+    localized: false,
+    required: false,
+    validations:
+      [{
+        in:
+          ['off white',
+            'default',
+            'gray']
+      }],
+    disabled: false,
+    omitted: false
+  })
+
+  sectionVideo.changeEditorInterface('title', 'singleLine')
+
+  sectionVideo.changeEditorInterface('embedCode', 'markdown')
+
+  sectionVideo.changeEditorInterface('internalTitle', 'singleLine')
+
+  sectionVideo.changeEditorInterface('style', 'dropdown')
+
+} as MigrationFunction

data/lib/generators/wcc/templates/section-video/models/section_video.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This model represents the 'section-video' content type in Contentful.  Any linked
+# entries of the 'section-video' content type will be resolved as instances of this class.
+# It exposes .find, .find_by, and .find_all methods to query Contentful.
+class SectionVideo < WCC::Contentful::Model::SectionVideo
+  # 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/site-config/migrations/generated_add_site-configs.ts

@@ -0,0 +1,97 @@
+import Migration, { MigrationFunction } from '@watermarkchurch/contentful-migration'
+
+// Generated by contentful-schema-diff
+// from empty-export.json
+// to   7yx6ovlj39n5
+export = function(migration : Migration, { makeRequest, spaceId, accessToken }) {
+
+  /************  site-config  ******************/
+
+  var siteConfig = migration.createContentType('site-config', {
+    displayField: 'internalTitle',
+    name: 'Site Config',
+    description: 'This is the top level object for the configuration of your site.'
+  })
+
+  siteConfig.createField('internalTitle', {
+    name: 'Internal Title (Contentful Only)',
+    type: 'Symbol',
+    localized: false,
+    required: true,
+    validations: [],
+    disabled: false,
+    omitted: true
+  })
+
+  siteConfig.createField('foreignKey', {
+    name: 'Foreign Key',
+    type: 'Symbol',
+    localized: false,
+    required: true,
+    validations:
+      [{ unique: true },
+      {
+        in: ['default'],
+        message: 'We only allow the default site config for this site'
+      }],
+    disabled: false,
+    omitted: false
+  })
+
+  siteConfig.createField('homepage', {
+    name: 'Homepage',
+    type: 'Link',
+    localized: false,
+    required: true,
+    validations: [{ linkContentType: ['page'] }],
+    disabled: false,
+    omitted: false,
+    linkType: 'Entry'
+  })
+
+  siteConfig.createField('mainNavigation', {
+    name: 'Main Navigation',
+    type: 'Link',
+    localized: false,
+    required: false,
+    validations: [{ linkContentType: ['menu'] }],
+    disabled: false,
+    omitted: false,
+    linkType: 'Entry'
+  })
+
+  siteConfig.createField('brand', {
+    name: 'Brand',
+    type: 'Link',
+    localized: false,
+    required: false,
+    validations: [{ linkContentType: ['menuButton'] }],
+    disabled: false,
+    omitted: false,
+    linkType: 'Entry'
+  })
+
+  siteConfig.createField('emailHeader', {
+    name: 'Email Header',
+    type: 'Link',
+    localized: false,
+    required: false,
+    validations: [{ linkMimetypeGroup: ['image'] }],
+    disabled: false,
+    omitted: false,
+    linkType: 'Asset'
+  })
+
+  siteConfig.changeEditorInterface('title', 'singleLine')
+
+  siteConfig.changeEditorInterface('foreignKey', 'radio', { helpText: 'Must be `default`' })
+
+  siteConfig.changeEditorInterface('homepage', 'entryLinkEditor')
+
+  siteConfig.changeEditorInterface('mainNavigation', 'entryLinkEditor')
+
+  siteConfig.changeEditorInterface('brand', 'entryLinkEditor')
+
+  siteConfig.changeEditorInterface('emailHeader', 'assetLinkEditor')
+
+} as MigrationFunction

data/lib/generators/wcc/templates/site-config/models/site_config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This model represents the 'site-config' content type in Contentful.  Any linked
+# entries of the 'site-config' content type will be resolved as instances of this class.
+# It exposes .find, .find_by, and .find_all methods to query Contentful.
+class SiteConfig < WCC::Contentful::Model::SiteConfig
+  # 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/wcc_contentful.rb

@@ -7,7 +7,7 @@ WCC::Contentful.configure do |config|
   # 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
+  config.store = # :direct, :eager_sync, or :lazy_sync
 end
 
 # Download content types, build models, and sync content

data/lib/wcc/contentful/app.rb

@@ -2,18 +2,61 @@
 
 require 'wcc/contentful/rails'
 
+require_relative './app/rails'
 require_relative './app/exceptions'
-require_relative './app/model_validators'
-require_relative './ext/model'
+require_relative './app/configuration'
 
 module WCC::Contentful::App
+  class << self
+    attr_reader :initialized
+
+    # Gets the current configuration, after calling WCC::Contentful::App.configure
+    attr_reader :configuration
+  end
+
+  def self.configure
+    if initialized || WCC::Contentful.initialized
+      raise WCC::Contentful::InitializationError, 'Cannot configure after initialization'
+    end
+
+    WCC::Contentful.configure do |wcc_contentful_config|
+      if @configuration&.wcc_contentful_config != wcc_contentful_config
+        @configuration = Configuration.new(wcc_contentful_config)
+      end
+      yield(configuration)
+    end
+
+    configuration.validate!
+
+    configuration
+  end
+
   def self.init!
-    raise ArgumentError, 'Please first call WCC::Contentful.init!' unless WCC::Contentful.types
+    raise ArgumentError, 'Please first call WCC::Contentful::App.configure' if configuration.nil?
+
+    WCC::Contentful.init!
 
     # Extend all model types w/ validation & extra fields
     WCC::Contentful.types.each_value do |t|
       file = File.dirname(__FILE__) + "/model/#{t.name.underscore}.rb"
       require file if File.exist?(file)
     end
+
+    @db_connected =
+      begin
+        ::ActiveRecord::Base.connection_pool.with_connection(&:active?)
+      rescue StandardError
+        false
+      end
+
+    @configuration = WCC::Contentful::App::Configuration::FrozenConfiguration.new(
+      configuration,
+      WCC::Contentful.configuration
+    )
+    @initialized = true
+  end
+
+  def self.db_connected?
+    @db_connected
   end
 end

data/lib/wcc/contentful/app/configuration.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# This object contains all the configuration options for the `wcc-contentful` gem.
+class WCC::Contentful::App::Configuration
+  # TODO: things to configure in the app?
+  ATTRIBUTES = %i[
+    preview_password
+  ].freeze
+
+  # Sets the password that will be checked when the query string contains `preview=`,
+  # if it matches, then the Contentful entries are fetched via the preview API.
+  attr_accessor :preview_password
+
+  attr_reader :wcc_contentful_config
+
+  delegate(*WCC::Contentful::Configuration::ATTRIBUTES, to: :wcc_contentful_config)
+  delegate(*(WCC::Contentful::Configuration::ATTRIBUTES.map { |a| "#{a}=" }),
+    to: :wcc_contentful_config)
+
+  def initialize(wcc_contentful_config)
+    @wcc_contentful_config = wcc_contentful_config
+    @preview_password = ENV['CONTENTFUL_PREVIEW_PASSWORD']
+  end
+
+  # Validates the configuration, raising ArgumentError if anything is wrong.  This
+  # is called by WCC::Contentful::App.init!
+  def validate!
+    wcc_contentful_config.validate!
+  end
+
+  def frozen?
+    false
+  end
+
+  class FrozenConfiguration
+    attr_reader(*ATTRIBUTES)
+
+    attr_reader :wcc_contentful_config
+
+    delegate(*WCC::Contentful::Configuration::ATTRIBUTES, to: :wcc_contentful_config)
+
+    def initialize(configuration, frozen_wcc_contentful_config)
+      unless frozen_wcc_contentful_config.frozen?
+        raise ArgumentError, 'Please first freeze the wcc_contentful_config'
+      end
+
+      @wcc_contentful_config = frozen_wcc_contentful_config
+
+      ATTRIBUTES.each do |att|
+        val = configuration.public_send(att)
+        val.freeze if val.respond_to?(:freeze)
+        instance_variable_set("@#{att}", val)
+      end
+    end
+
+    def frozen?
+      true
+    end
+  end
+end