wcc-contentful 0.3.0.pre.rc3 → 0.3.0

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class WCC::Contentful::Model::DropdownMenu < WCC::Contentful::Model
+  validate_field :name, :String
+  validate_field :label, :Link, link_to: 'menuButton'
+  validate_field :items, :Array, link_to: 'menuButton'
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class WCC::Contentful::Model::Menu < WCC::Contentful::Model
+  validate_field :name, :String
+  validate_field :items, :Array, link_to: %w[dropdownMenu menuButton]
+end

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

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,8 @@
+# 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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,121 @@
+# 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
+
+  def no_validate_field(field)
+    ct = try(:content_type) || name.demodulize.camelize(:lower)
+    return unless v = validations[ct]
+
+    field = field.to_s.camelize(:lower) unless field.is_a?(String)
+    v.reject! { |dsl| dsl.try(:field) == field }
+  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

@@ -0,0 +1,166 @@
+# 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

data/lib/wcc/contentful/store/postgres_store.rb

@@ -109,7 +109,7 @@ module WCC::Contentful::Store
           resolve_includes(
             JSON.parse(row['data']),
             @options[:include]
-          )
+            )
           )
         end
         arr
@@ -122,7 +122,7 @@ module WCC::Contentful::Store
             resolve_includes(
               JSON.parse(row['data']),
               @options[:include]
-            )
+             )
         end
         arr
       end

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '0.3.0-rc3'
+    VERSION = '0.3.0'
   end
 end

data/wcc-contentful.gemspec

@@ -10,9 +10,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Watermark Dev']
   spec.email         = ['dev@watermark.org']
 
-  spec.summary       = File.readlines(File.expand_path('README.md', __dir__)).join
-  spec.description   = 'Contentful API wrapper library exposing an ActiveRecord-like interface'
-  spec.homepage      = 'https://github.com/watermarkchurch/wcc-contentful/wcc-contentful'
+  spec.summary       = File.readlines('README.md').join
+  spec.description   = 'Contentful API wrapper library for Watermark apps'
+  spec.homepage      = 'https://github.com/watermarkchurch/wcc-contentful'
   spec.license       = 'MIT'
 
   spec.required_ruby_version = '>= 2.3'
@@ -29,9 +29,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
   spec.add_development_dependency 'vcr', '~> 4.0'
   spec.add_development_dependency 'webmock', '~> 3.0'
 
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3.0'
+
   # for generators
   spec.add_development_dependency 'generator_spec', '~> 0.9.4'
   spec.add_development_dependency 'rails', '~> 5.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre.rc3
+  version: 0.3.0
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -310,16 +366,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.1
-description: Contentful API wrapper library exposing an ActiveRecord-like interface
+description: Contentful API wrapper library for Watermark apps
 email:
 - dev@watermark.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
+- LICENSE.txt
 - README.md
+- Rakefile
 - app/controllers/wcc/contentful/application_controller.rb
 - app/controllers/wcc/contentful/webhook_controller.rb
 - app/jobs/wcc/contentful/delayed_sync_job.rb
@@ -330,6 +396,18 @@ files:
 - bin/setup
 - config/initializers/mime_types.rb
 - config/routes.rb
+- lib/generators/wcc/USAGE
+- lib/generators/wcc/model_generator.rb
+- lib/generators/wcc/templates/.keep
+- lib/generators/wcc/templates/Procfile
+- lib/generators/wcc/templates/contentful_shell_wrapper
+- lib/generators/wcc/templates/menu/generated_add_menus.ts
+- lib/generators/wcc/templates/menu/models/menu.rb
+- lib/generators/wcc/templates/menu/models/menu_button.rb
+- lib/generators/wcc/templates/page/generated_add_pages.ts
+- lib/generators/wcc/templates/page/models/page.rb
+- lib/generators/wcc/templates/release
+- lib/generators/wcc/templates/wcc_contentful.rb
 - lib/wcc/contentful.rb
 - lib/wcc/contentful/client_ext.rb
 - lib/wcc/contentful/configuration.rb
@@ -342,9 +420,16 @@ files:
 - lib/wcc/contentful/helpers.rb
 - lib/wcc/contentful/indexed_representation.rb
 - lib/wcc/contentful/model.rb
+- lib/wcc/contentful/model/dropdown_menu.rb
+- lib/wcc/contentful/model/menu.rb
+- lib/wcc/contentful/model/menu_button.rb
+- lib/wcc/contentful/model/page.rb
+- lib/wcc/contentful/model/redirect.rb
 - lib/wcc/contentful/model_builder.rb
 - lib/wcc/contentful/model_methods.rb
 - lib/wcc/contentful/model_singleton_methods.rb
+- lib/wcc/contentful/model_validators.rb
+- lib/wcc/contentful/model_validators/dsl.rb
 - lib/wcc/contentful/rails.rb
 - lib/wcc/contentful/services.rb
 - lib/wcc/contentful/simple_client.rb
@@ -361,7 +446,7 @@ files:
 - lib/wcc/contentful/sys.rb
 - lib/wcc/contentful/version.rb
 - wcc-contentful.gemspec
-homepage: https://github.com/watermarkchurch/wcc-contentful/wcc-contentful
+homepage: https://github.com/watermarkchurch/wcc-contentful
 licenses:
 - MIT
 metadata: {}
@@ -376,12 +461,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://badge.fury.io/rb/wcc-contentful)