renderful 0.2.0 → 0.3.0

data/lib/renderful.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
-require 'contentful'
-
-require 'renderful/no_renderer_error'
-require 'renderful/cache'
+require 'renderful/error/base'
+require 'renderful/error/entry_not_found_error'
+require 'renderful/error/no_component_error'
+require 'renderful/cache/base'
 require 'renderful/cache/redis'
-require 'renderful/cache_invalidator'
+require 'renderful/cache/null'
+require 'renderful/content_entry'
+require 'renderful/provider/base'
+require 'renderful/provider/contentful'
+require 'renderful/provider/prismic'
 require 'renderful/client'
-require 'renderful/renderer'
-require 'renderful/renderer/rails'
+require 'renderful/component/base'
 require 'renderful/version'
 
 module Renderful

data/lib/renderful/cache/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Cache
+    class Base
+      def exist?(_key)
+        raise NotImplementedError
+      end
+
+      def read(_key)
+        raise NotImplementedError
+      end
+
+      def write(_key, _value)
+        raise NotImplementedError
+      end
+
+      def delete(*_keys)
+        raise NotImplementedError
+      end
+
+      def delete_matched(_pattern)
+        raise NotImplementedError
+      end
+
+      def fetch(_key)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/renderful/cache/null.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Cache
+    class Null < Base
+      def exist?(_key)
+        false
+      end
+
+      def read(_key)
+        nil
+      end
+
+      def write(key, value)
+        # noop
+      end
+
+      def delete(*keys)
+        # noop
+      end
+
+      def delete_matched(pattern)
+        # noop
+      end
+
+      def fetch(_key)
+        yield
+      end
+    end
+  end
+end

data/lib/renderful/cache/redis.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Renderful
-  class Cache
-    class Redis < Cache
+  module Cache
+    class Redis < Base
       attr_reader :redis
 
       def initialize(redis)
@@ -21,8 +21,21 @@ module Renderful
         redis.set(key, value)
       end
 
-      def delete(key)
-        redis.del(key)
+      def delete(*keys)
+        redis.del(*keys)
+      end
+
+      def delete_matched(pattern)
+        keys = redis.scan_each(match: pattern).to_a
+        delete(*keys)
+      end
+
+      def fetch(key)
+        return read(key) if exist?(key)
+
+        yield.tap do |value|
+          write(key, value)
+        end
       end
     end
   end

data/lib/renderful/client.rb

@@ -2,34 +2,45 @@
 
 module Renderful
   class Client
-    attr_reader :contentful, :renderers, :cache
+    attr_reader :provider, :components, :cache
 
-    def initialize(contentful:, renderers:, cache: nil)
-      @contentful = contentful
-      @renderers = renderers
+    def initialize(provider:, components:, cache: Cache::Null.new)
+      @provider = provider
+      @components = components
       @cache = cache
     end
 
-    def render(entry)
-      renderer = renderers[entry.content_type.id]
-      fail(NoRendererError, entry) unless renderer
+    def render(entry_id, options = {})
+      cache.fetch(ContentEntry.build_cache_key(provider, id: entry_id)) do
+        content_entry = provider.find_entry(entry_id)
+        component = component_for_entry(content_entry)
 
-      return cache.read(cache_key_for(entry)) if cache&.exist?(cache_key_for(entry))
-
-      renderer.new(entry, client: self).render.tap do |output|
-        cache&.write(cache_key_for(entry), output)
+        if component.respond_to?(:render_in)
+          component.render_in(options.fetch(:view_context))
+        else
+          component.render
+        end
       end
     end
 
-    def cache_key_for(entry)
-      if entry.respond_to?(:content_type)
-        cache_key_for(
-          content_type_id: entry.content_type.id,
-          entry_id: entry.id,
-        )
-      else
-        "contentful/#{entry.fetch(:content_type_id)}/#{entry.fetch(:entry_id)}"
+    def invalidate_cache_from_webhook(body)
+      result = provider.cache_keys_to_invalidate(body)
+
+      cache.delete(*result[:keys])
+
+      result[:patterns].each do |pattern|
+        cache.delete_matched(pattern)
       end
     end
+
+    private
+
+    def component_klass_for_entry(content_entry)
+      components[content_entry.content_type] || fail(Error::NoComponentError, content_entry)
+    end
+
+    def component_for_entry(content_entry)
+      component_klass_for_entry(content_entry).new(entry: content_entry, client: self)
+    end
   end
 end

data/lib/renderful/component/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Component
+    class Base
+      attr_reader :entry, :client
+
+      def initialize(entry:, client:)
+        @entry = entry
+        @client = client
+      end
+
+      def render
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/renderful/content_entry.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Renderful
+  class ContentEntry
+    attr_reader :provider, :id, :content_type, :fields
+
+    class << self
+      def build_cache_key(provider, id: nil)
+        ['renderful', provider.cache_prefix, id || '*'].join('/')
+      end
+    end
+
+    def initialize(provider:, id:, content_type: nil, fields: {})
+      @provider = provider
+      @id = id
+      @content_type = content_type
+      @fields = fields
+    end
+
+    def cache_key
+      self.class.build_cache_key(provider, id: id)
+    end
+  end
+end

data/lib/renderful/error/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Error
+    class Base < StandardError; end
+  end
+end

data/lib/renderful/error/entry_not_found_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Error
+    class EntryNotFoundError < Base
+      attr_reader :entry_id
+
+      def initialize(entry_id, *args)
+        @entry_id = entry_id
+
+        super "Cannot find entry #{@entry_id}", *args
+      end
+    end
+  end
+end

data/lib/renderful/error/no_component_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Error
+    class NoComponentError < Base
+      attr_reader :entry
+
+      def initialize(entry, *args)
+        @entry = entry
+
+        super "Cannot find component for content type #{entry.content_type}", *args
+      end
+    end
+  end
+end

data/lib/renderful/provider/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Provider
+    class Base
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def cache_prefix
+        fail NotImplementedError
+      end
+
+      def find_entry(_entry_id)
+        fail NotImplementedError
+      end
+
+      def cache_keys_to_invalidate(_webhook_body)
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/renderful/provider/contentful.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Provider
+    class Contentful < Base
+      def initialize(options)
+        super
+
+        fail ArgumentError, 'contentful option is required!' unless contentful
+      end
+
+      def cache_prefix
+        :contentful
+      end
+
+      def find_entry(entry_id)
+        entry = contentful.entry(entry_id)
+        raise Error::EntryNotFoundError, entry_id unless entry
+
+        wrap_entry(entry)
+      end
+
+      def cache_keys_to_invalidate(webhook_body)
+        params = webhook_body.is_a?(String) ? JSON.parse(webhook_body) : webhook_body
+
+        keys_to_invalidate = [ContentEntry.build_cache_key(self, id: params['sys']['id'])]
+        keys_to_invalidate += contentful.entries(links_to_entry: params['sys']['id']).map do |entry|
+          ContentEntry.build_cache_key(self, id: entry.id)
+        end
+
+        {
+          keys: keys_to_invalidate,
+          patterns: [],
+        }
+      end
+
+      private
+
+      def wrap_entry(entry)
+        ContentEntry.new(
+          provider: self,
+          id: entry.id,
+          content_type: entry.content_type.id,
+          fields: entry.fields,
+        )
+      end
+
+      def entries_linking_to(entry_id); end
+
+      def contentful
+        options[:contentful]
+      end
+    end
+  end
+end

data/lib/renderful/provider/prismic.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Renderful
+  module Provider
+    class Prismic < Base
+      def initialize(options)
+        super
+
+        fail ArgumentError, 'prismic option is required!' unless prismic
+      end
+
+      def cache_prefix
+        :prismic
+      end
+
+      def find_entry(entry_id)
+        entry = prismic.getByID(entry_id)
+        raise Error::EntryNotFoundError, entry_id unless entry
+
+        wrap_entry(entry)
+      end
+
+      def cache_keys_to_invalidate(_webhook_body)
+        {
+          keys: [],
+          patterns: ['renderful/prismic/*'],
+        }
+      end
+
+      private
+
+      def wrap_entry(entry)
+        ContentEntry.new(
+          provider: self,
+          id: entry.id,
+          content_type: entry.type,
+          fields: entry.fragments,
+        )
+      end
+
+      def prismic
+        options[:prismic]
+      end
+    end
+  end
+end

data/lib/renderful/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Renderful
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/renderful.gemspec

@@ -27,16 +27,22 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'contentful', '~> 2.11'
-  spec.add_dependency 'rails', ['>= 5.0.0', '< 7']
-
   spec.add_development_dependency 'appraisal', '~> 2.2'
   spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'capybara', '~> 3.32'
   spec.add_development_dependency 'combustion', '~> 1.1'
+  spec.add_development_dependency 'contentful', '~> 2.11'
+  spec.add_development_dependency 'gem-release', '~> 2.1'
+  spec.add_development_dependency 'github_changelog_generator', '~> 1.15'
+  spec.add_development_dependency 'prismic.io', '~> 1.7'
+  spec.add_development_dependency 'rails', ['>= 5.0.0', '< 7']
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'redis', '~> 4.1'
   spec.add_development_dependency 'rspec-rails', '~> 4.0.0.beta4'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
   spec.add_development_dependency 'rubocop', '~> 0.79.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
+  spec.add_development_dependency 'vcr', '~> 5.1'
+  spec.add_development_dependency 'view_component', '~> 2.2'
+  spec.add_development_dependency 'webmock', '~> 3.8'
 end