wcc-contentful 0.4.0.pre.alpha → 0.4.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c54cd88861b87469555e71fe1a83ee70cbfe6dfe
-  data.tar.gz: e0fbecf29c3dde28acf284ecce0973a0ceca9669
+  metadata.gz: ff6f351c2042a4a584360d284e9079944fb3345f
+  data.tar.gz: 511988b09e647cf69c7b6c9accf4098fce140d08
 SHA512:
-  metadata.gz: 21d1522d8f7655123eebba0f2a768c279fdb8907f8333445255113dbf78b45ec64479f92c15053622bda2e222724be7ce903d350c5f677bbd94d9ee2bb2e753d
-  data.tar.gz: a84363867c283dea04e32120b71cbb0fe5fa15d58f4e2da242f28144ee59976740b5f78f9e52988ee15738aa9242113bf0fc4d9ae22ae9f73debd2721258ccd9
+  metadata.gz: b3fac31b5af8c0f24e9bb91139946819134f5f68d38dfa2b90c70e30aacd6d9933bee1a716f5717b1d1769118875af4eb0f7ca6657fc6b09b736141c6cf4640d
+  data.tar.gz: 30141b535a65ade870b48573efee983310ad4c3ff704332f0cee15ceaf8e033e94d4cfa3bda4f42f36e3812fa7be49bf2d807375fa695231cf50b925cdfd92f8

data/README.md

@@ -211,6 +211,66 @@ class MyJob < ApplicationJob
 end
 ```
 
+## Test Helpers
+
+To use the test helpers, include the following in your rails_helper.rb:
+
+```ruby
+require 'wcc/contentful/rspec'
+```
+
+This adds the following helpers to all your specs:
+
+```ruby
+##
+# Builds a in-memory instance of the Contentful model for the given content_type.
+# All attributes that are known to be required fields on the content type
+# will return a default value based on the field type.
+instance = contentful_create('my-content-type', my_field: 'some-value')
+# => #<WCC::Contentful::Model::MyContentType:0x0000000005c71a78 @created_at=2018-04-16 18:41:17 UTC...>
+
+instance.my_field
+# => "some-value"
+
+instance.other_required_field
+# => "default-value"
+
+instance.other_optional_field
+# => nil
+
+instance.not_a_field
+# NoMethodError: undefined method `not_a_field' for #<Menu:0x00007fbac81ee490>
+
+##
+# Builds a rspec double of the Contentful model for the given content_type.
+# All attributes that are known to be required fields on the content type
+# will return a default value based on the field type.
+dbl = contentful_double('my-content-type', my_field: 'other-value')
+# => #<Double (anonymous)>
+
+dbl.my_field
+# => "other-value"
+
+dbl.not_a_field
+# => #<Double (anonymous)> received unexpected message :not_a_field with (no args)
+
+##
+# Builds out a fake Contentful entry for the given content type, and then
+# stubs the Model API to return that content type for `.find` and `.find_by`
+# query methods.
+stubbed = contentful_stub('my-content-type', id: '1234', my_field: 'test')
+
+WCC::Contentful::Model.find('1234') == stubbed
+# => true
+
+MyContentType.find('1234') == stubbed
+# => true
+
+MyContentType.find_by(my_field: 'test') == stubbed
+# => true
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/wcc/contentful/rspec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'wcc/contentful'
+
+require_relative './test'
+
+module WCC::Contentful::RSpec
+  include WCC::Contentful::Test::Double
+  include WCC::Contentful::Test::Factory
+
+  ##
+  # Builds out a fake Contentful entry for the given content type, and then
+  # stubs the Model API to return that content type for `.find` and `.find_by`
+  # query methods.
+  def contentful_stub(content_type, **attrs)
+    const = WCC::Contentful::Model.resolve_constant(content_type.to_s)
+    instance = contentful_create(content_type, **attrs)
+
+    allow(WCC::Contentful::Model).to receive(:find)
+      .with(instance.id)
+      .and_return(instance)
+    allow(WCC::Contentful::Model).to receive(:find)
+      .with(instance.id, anything)
+      .and_return(instance)
+    allow(const).to receive(:find) { |id, options| WCC::Contentful::Model.find(id, options) }
+
+    attrs.each do |k, v|
+      allow(const).to receive(:find_by)
+        .with(hash_including(k => v))
+        .and_return(instance)
+    end
+
+    instance
+  end
+end
+
+if defined?(RSpec)
+  RSpec.configure do |config|
+    config.include WCC::Contentful::RSpec
+  end
+end

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

@@ -1,20 +1,25 @@
 # frozen_string_literal: true
 
 gem 'pg', '~> 1.0'
+gem 'connection_pool', '~> 2.2'
 require 'pg'
+require 'connection_pool'
 
 module WCC::Contentful::Store
   class PostgresStore < Base
-    def initialize(_config = nil, connection_options = nil)
+    attr_reader :connection_pool
+
+    def initialize(_config = nil, connection_options = nil, pool_options = nil)
       super()
+      @schema_ensured = false
       connection_options ||= { dbname: 'postgres' }
-      @conn = PG.connect(connection_options)
-      PostgresStore.ensure_schema(@conn)
+      pool_options ||= {}
+      @connection_pool = build_connection_pool(connection_options, pool_options)
     end
 
     def set(key, value)
       ensure_hash value
-      result = @conn.exec_prepared('upsert_entry', [key, value.to_json])
+      result = @connection_pool.with { |conn| conn.exec_prepared('upsert_entry', [key, value.to_json]) }
       return if result.num_tuples == 0
 
       val = result.getvalue(0, 0)
@@ -22,21 +27,21 @@ module WCC::Contentful::Store
     end
 
     def keys
-      result = @conn.exec_prepared('select_ids')
+      result = @connection_pool.with { |conn| conn.exec_prepared('select_ids') }
       arr = []
       result.each { |r| arr << r['id'].strip }
       arr
     end
 
     def delete(key)
-      result = @conn.exec_prepared('delete_by_id', [key])
+      result = @connection_pool.with { |conn| conn.exec_prepared('delete_by_id', [key]) }
       return if result.num_tuples == 0
 
       JSON.parse(result.getvalue(0, 1))
     end
 
     def find(key, **_options)
-      result = @conn.exec_prepared('select_entry', [key])
+      result = @connection_pool.with { |conn| conn.exec_prepared('select_entry', [key]) }
       return if result.num_tuples == 0
 
       JSON.parse(result.getvalue(0, 1))
@@ -46,7 +51,7 @@ module WCC::Contentful::Store
       statement = "WHERE data->'sys'->'contentType'->'sys'->>'id' = $1"
       Query.new(
         self,
-        @conn,
+        @connection_pool,
         statement,
         [content_type],
         options
@@ -54,9 +59,9 @@ module WCC::Contentful::Store
     end
 
     class Query < Base::Query
-      def initialize(store, conn, statement = nil, params = nil, options = nil)
+      def initialize(store, connection_pool, statement = nil, params = nil, options = nil)
         super(store)
-        @conn = conn
+        @connection_pool = connection_pool
         @statement = statement ||
           "WHERE data->'sys'->>'id' IS NOT NULL"
         @params = params || []
@@ -74,7 +79,7 @@ module WCC::Contentful::Store
 
         Query.new(
           @store,
-          @conn,
+          @connection_pool,
           statement,
           params,
           @options
@@ -85,7 +90,7 @@ module WCC::Contentful::Store
         return @count if @count
 
         statement = 'SELECT count(*) FROM contentful_raw ' + @statement
-        result = @conn.exec(statement, @params)
+        result = @connection_pool.with { |conn| conn.exec(statement, @params) }
         @count = result.getvalue(0, 0).to_i
       end
 
@@ -93,7 +98,7 @@ module WCC::Contentful::Store
         return @first if @first
 
         statement = 'SELECT * FROM contentful_raw ' + @statement + ' LIMIT 1'
-        result = @conn.exec(statement, @params)
+        result = @connection_pool.with { |conn| conn.exec(statement, @params) }
         return if result.num_tuples == 0
 
         resolve_includes(
@@ -135,7 +140,7 @@ module WCC::Contentful::Store
         return @resolved if @resolved
 
         statement = 'SELECT * FROM contentful_raw ' + @statement
-        @resolved = @conn.exec(statement, @params)
+        @resolved = @connection_pool.with { |conn| conn.exec(statement, @params) }
       end
 
       def push_param(param, params)
@@ -168,11 +173,27 @@ module WCC::Contentful::Store
         $$ LANGUAGE 'plpgsql';
       HEREDOC
       )
+    end
 
+    def self.prepare_statements(conn)
       conn.prepare('upsert_entry', 'SELECT * FROM upsert_entry($1,$2)')
       conn.prepare('select_entry', 'SELECT * FROM contentful_raw WHERE id = $1')
       conn.prepare('select_ids', 'SELECT id FROM contentful_raw')
       conn.prepare('delete_by_id', 'DELETE FROM contentful_raw WHERE id = $1 RETURNING *')
     end
+
+    private
+
+    def build_connection_pool(connection_options, pool_options)
+      ConnectionPool.new(pool_options) do
+        PG.connect(connection_options).tap do |conn|
+          unless @schema_ensured
+            PostgresStore.ensure_schema(conn)
+            @schema_ensured = true
+          end
+          PostgresStore.prepare_statements(conn)
+        end
+      end
+    end
   end
 end

data/lib/wcc/contentful/test.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module WCC::Contentful::Test
+end
+
+require_relative 'test/double'
+require_relative 'test/factory'

data/lib/wcc/contentful/test/attributes.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module WCC::Contentful::Test::Attributes
+  DEFAULTS = {
+    String: 'test',
+    Int: 0,
+    Float: 0.0,
+    DateTime: Time.at(0),
+    Boolean: false,
+    Json: -> { OpenStruct.new },
+    Coordinates: -> { OpenStruct.new }
+  }.freeze
+
+  class << self
+    def [](key)
+      DEFAULTS[key]
+    end
+
+    ##
+    # Get a hash of default values for all attributes unique to the given Contentful model.
+    def defaults(const)
+      unless const < WCC::Contentful::Model
+        raise ArgumentError, "#{const} is not a subclass of WCC::Contentful::Model"
+      end
+
+      const.content_type_definition.fields.each_with_object({}) do |(name, f), h|
+        h[name.to_sym] = h[name.underscore.to_sym] = default_value(f)
+      end
+    end
+
+    ##
+    # Gets the default value for a contentful IndexedRepresentation::Field.
+    # This comes from the 'content_type_definition' of a contentful model class.
+    def default_value(field)
+      return [] if field.array
+      return unless field.required
+
+      val = DEFAULTS[field]
+      return val.call if val.respond_to?(:call)
+
+      val
+    end
+  end
+end

data/lib/wcc/contentful/test/double.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative './attributes'
+
+module WCC::Contentful::Test::Double
+  ##
+  # Builds a rspec double of the Contentful model for the given content_type.
+  # All attributes that are known to be required fields on the content type
+  # will return a default value based on the field type.
+  def contentful_double(content_type, **attrs)
+    const = WCC::Contentful::Model.resolve_constant(content_type)
+    attrs.symbolize_keys!
+
+    bad_attrs = attrs.reject { |a| const.instance_methods.include?(a) }
+    raise ArgumentError, "Attribute(s) do not exist on #{const}: #{bad_attrs.keys}" if bad_attrs.any?
+
+    double(attrs[:name] || attrs[:id] || nil, defaults(const).merge(attrs))
+  end
+
+  ##
+  # Builds an rspec double of a Contentful image asset, including the file
+  # URL and details.  These fields can be overridden.
+  def contentful_image_double(**attrs)
+    attrs = {
+      title: WCC::Contentful::Test::Attributes[:String],
+      description: WCC::Contentful::Test::Attributes[:String],
+      file: {
+        url: '//images.ctfassets.net/7yx6/2rak/test.jpg',
+        details: {
+          image: {
+            width: 0,
+            height: 0
+          }
+        }
+      }
+    }.deep_merge!(attrs)
+
+    attrs[:file] = OpenStruct.new(attrs[:file]) if attrs[:file]
+
+    attrs[:raw] = {
+      sys: {
+        space: {
+          sys: {
+            type: 'Link',
+            linkType: 'Space',
+            id: ENV['CONTENTFUL_SPACE_ID']
+          }
+        },
+        id: SecureRandom.urlsafe_base64,
+        type: 'Asset',
+        createdAt: Time.now.to_s(:iso8601),
+        updatedAt: Time.now.to_s(:iso8601),
+        environment: {
+          sys: {
+            id: 'master',
+            type: 'Link',
+            linkType: 'Environment'
+          }
+        },
+        revision: rand(100),
+        locale: 'en-US'
+      },
+      fields: attrs.each_with_object({}) { |(k, v), h| h[k] = { 'en-US' => v } }
+    }
+
+    double(attrs)
+  end
+
+  private
+
+  def defaults(model)
+    attributes = WCC::Contentful::Test::Attributes.defaults(model)
+    methods = model.instance_methods - WCC::Contentful::Model.instance_methods
+    methods.each_with_object(attributes) { |f, h| h[f] ||= nil }
+  end
+end

data/lib/wcc/contentful/test/factory.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative './attributes'
+
+module WCC::Contentful::Test::Factory
+  ##
+  # Builds a in-memory instance of the Contentful model for the given content_type.
+  # All attributes that are known to be required fields on the content type
+  # will return a default value based on the field type.
+  def contentful_create(content_type, **attrs)
+    const = WCC::Contentful::Model.resolve_constant(content_type.to_s)
+    attrs = attrs.transform_keys { |a| a.to_s.camelize(:lower) }
+
+    id = attrs.delete('id')
+    bad_attrs = attrs.reject { |a| const.content_type_definition.fields.key?(a) }
+    raise ArgumentError, "Attribute(s) do not exist on #{const}: #{bad_attrs.keys}" if bad_attrs.any?
+
+    default_instance(const, id).tap do |instance|
+      attrs.each do |k, v|
+        field = const.content_type_definition.fields[k]
+
+        raw = v
+        if %i[Asset Link].include?(field.type)
+          raw = to_raw(v, field.type)
+
+          unless field.array ? v.any? { |i| i.is_a?(String) } : v.is_a?(String)
+            instance.instance_variable_set("@#{field.name}_resolved", v)
+          end
+        end
+
+        instance.raw['fields'][field.name][instance.sys.locale] = raw
+        instance.instance_variable_set("@#{field.name}", raw)
+      end
+
+      def instance.to_s
+        "#<#{self.class.name} id=\"#{id}\">"
+      end
+    end
+  end
+
+  class Link
+    attr_reader :id
+    attr_reader :link_type
+    attr_reader :raw
+
+    LINK_TYPES = {
+      Asset: 'Asset',
+      Link: 'Entry'
+    }.freeze
+
+    def initialize(model, link_type = nil)
+      @id = model.try(:id) || model
+      @link_type = link_type
+      @link_type ||= model.is_a?(WCC::Contentful::Model::Asset) ? :Asset : :Link
+      @raw =
+        {
+          'sys' => {
+            'type' => 'Link',
+            'linkType' => LINK_TYPES[@link_type],
+            'id' => @id
+          }
+        }
+    end
+
+    alias_method :to_h, :raw
+  end
+
+  private
+
+  def default_instance(model, id = nil)
+    model.new(default_raw(model, id))
+  end
+
+  def default_raw(model, id = nil)
+    { sys: sys(model, id), fields: fields(model) }.as_json
+  end
+
+  def sys(model, id = nil)
+    {
+      space: {
+        sys: {
+          type: 'Link',
+          linkType: 'Space',
+          id: ENV['CONTENTFUL_SPACE_ID']
+        }
+      },
+      id: id || SecureRandom.urlsafe_base64,
+      type: 'Entry',
+      createdAt: Time.now.to_s(:iso8601),
+      updatedAt: Time.now.to_s(:iso8601),
+      environment: {
+        sys: {
+          id: 'master',
+          type: 'Link',
+          linkType: 'Environment'
+        }
+      },
+      revision: rand(100),
+      contentType: {
+        sys: {
+          type: 'Link',
+          linkType: 'ContentType',
+          id: model.content_type
+        }
+      },
+      locale: 'en-US'
+    }
+  end
+
+  def fields(model)
+    WCC::Contentful::Test::Attributes.defaults(model).each_with_object({}) do |(k, v), h|
+      h[k] = { 'en-US' => v }
+    end
+  end
+
+  def to_raw(val, field_type)
+    if val.is_a? Array
+      val.map { |i| to_raw(i, field_type) }
+    elsif val.is_a? String
+      Link.new(val, field_type).raw
+    elsif val
+      val.raw
+    end
+  end
+end

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '0.4.0-alpha'
+    VERSION = '0.4.0-beta'
   end
 end

data/wcc-contentful.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'timecop', '~> 0.9.1'
 
   # optional dependencies
+  spec.add_development_dependency 'connection_pool', '~> 2.2'
   spec.add_development_dependency 'contentful', '2.6.0'
   spec.add_development_dependency 'contentful-management', '2.0.2'
   spec.add_development_dependency 'graphql', '~> 1.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre.alpha
+  version: 0.4.0.pre.beta
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -262,6 +262,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: contentful
   requirement: !ruby/object:Gem::Requirement
@@ -431,6 +445,7 @@ files:
 - lib/wcc/contentful/model_methods.rb
 - lib/wcc/contentful/model_singleton_methods.rb
 - lib/wcc/contentful/rails.rb
+- lib/wcc/contentful/rspec.rb
 - lib/wcc/contentful/services.rb
 - lib/wcc/contentful/simple_client.rb
 - lib/wcc/contentful/simple_client/http_adapter.rb
@@ -444,6 +459,10 @@ files:
 - lib/wcc/contentful/store/memory_store.rb
 - lib/wcc/contentful/store/postgres_store.rb
 - lib/wcc/contentful/sys.rb
+- lib/wcc/contentful/test.rb
+- lib/wcc/contentful/test/attributes.rb
+- lib/wcc/contentful/test/double.rb
+- lib/wcc/contentful/test/factory.rb
 - lib/wcc/contentful/version.rb
 - wcc-contentful.gemspec
 homepage: https://github.com/watermarkchurch/wcc-contentful/wcc-contentful
@@ -536,14 +555,33 @@ summary: '[![Gem Version](https://badge.fury.io/rb/wcc-contentful.svg)](https://
   You can also include the {WCC::Contentful::ServiceAccessors} concern to define these
   services as attributes in a class.  ```ruby class MyJob < ApplicationJob include
   WCC::Contentful::ServiceAccessors  def perform Page.find(...)  store.find(...)  client.entries(...)
-  end end ```  ## Development  After checking out the repo, run `bin/setup` to install
-  dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console`
-  for an interactive prompt that will allow you to experiment.  To install this gem
-  onto your local machine, run `bundle exec rake install`. To release a new version,
-  update the version number in `version.rb`, and then run `bundle exec rake release`,
-  which will create a git tag for the version, push git commits and tags, and push
-  the `.gem` file to [rubygems.org](https://rubygems.org).  ## Contributing  Bug reports
-  and pull requests are welcome on GitHub at https://github.com/watermarkchurch/wcc-contentful.
+  end end ```  ## Test Helpers  To use the test helpers, include the following in
+  your rails_helper.rb:  ```ruby require ''wcc/contentful/rspec'' ```  This adds the
+  following helpers to all your specs:  ```ruby ## # Builds a in-memory instance of
+  the Contentful model for the given content_type. # All attributes that are known
+  to be required fields on the content type # will return a default value based on
+  the field type. instance = contentful_create(''my-content-type'', my_field: ''some-value'')
+  # => #<WCC::Contentful::Model::MyContentType:0x0000000005c71a78 @created_at=2018-04-16
+  18:41:17 UTC...>  instance.my_field # => "some-value"  instance.other_required_field
+  # => "default-value"  instance.other_optional_field # => nil  instance.not_a_field
+  # NoMethodError: undefined method `not_a_field'' for #<Menu:0x00007fbac81ee490>  ##
+  # Builds a rspec double of the Contentful model for the given content_type. # All
+  attributes that are known to be required fields on the content type # will return
+  a default value based on the field type. dbl = contentful_double(''my-content-type'',
+  my_field: ''other-value'') # => #<Double (anonymous)>  dbl.my_field # => "other-value"  dbl.not_a_field
+  # => #<Double (anonymous)> received unexpected message :not_a_field with (no args)  ##
+  # Builds out a fake Contentful entry for the given content type, and then # stubs
+  the Model API to return that content type for `.find` and `.find_by` # query methods.
+  stubbed = contentful_stub(''my-content-type'', id: ''1234'', my_field: ''test'')  WCC::Contentful::Model.find(''1234'')
+  == stubbed # => true  MyContentType.find(''1234'') == stubbed # => true  MyContentType.find_by(my_field:
+  ''test'') == stubbed # => true ```   ## Development  After checking out the repo,
+  run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+  You can also run `bin/console` for an interactive prompt that will allow you to
+  experiment.  To install this gem onto your local machine, run `bundle exec rake
+  install`. To release a new version, update the version number in `version.rb`, and
+  then run `bundle exec rake release`, which will create a git tag for the version,
+  push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).  ##
+  Contributing  Bug reports and pull requests are welcome on GitHub at https://github.com/watermarkchurch/wcc-contentful.
   This project is intended to be a safe, welcoming space for collaboration, and contributors
   are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org)
   code of conduct.  ## License  The gem is available as open source under the terms