scrivito_sdk 1.0.0 → 1.1.0.rc1

data/lib/scrivito/content_state.rb

@@ -1,109 +0,0 @@
-module Scrivito
-
-# This class represents a single instance of a content state.
-# Basically a content state has three important characteristics: cache with obj datas,
-# changes representing changed objs and ways they has been changed and an ancestor content state.
-class ContentState < Struct.new(:content_state_id, :changes, :changes_index, :from_content_state_id)
-  class << self
-    private :new
-
-    # Creates a new content state with given changes and ancestor (optional).
-    def create(attributes)
-      new(attributes).tap do |content_state|
-        content_state.index_changes!
-        CmsDataCache.write_content_state(content_state.content_state_id, content_state.to_hash)
-      end
-    end
-
-    # Finds a previously saved content state.
-    # Returns nil if not found.
-    def find(content_state_id)
-      if content_state_data = CmsDataCache.read_content_state(content_state_id)
-        new(content_state_data)
-      end
-    end
-
-    # Fetches an existing workspace.
-    # If not found creates a new one and returns it.
-    def find_or_create(content_state_id)
-      find(content_state_id) || create(content_state_id: content_state_id)
-    end
-  end
-
-  def initialize(attributes)
-    super(*attributes.symbolize_keys.values_at(:content_state_id, :changes, :changes_index,
-        :from_content_state_id))
-  end
-
-  # Stores arbitrary data in cache.
-  # Cache key is build from given index and key.
-  def save_obj_data(index, key, data)
-    CmsDataCache.write_obj_data(content_state_id, index, key, data)
-  end
-
-  # Fetches previously stored arbitrary data from cache.
-  # Returns nil if nothing found.
-  # Cache key is build from given index and key.
-  def find_obj_data(index, key)
-    CmsDataCache.read_obj_data(content_state_id, index, key)
-  end
-
-  # Fetches and caches the ancestor.
-  # Returns nil if there is no ancestor.
-  def from_content_state
-    @from_content_state ||= self.class.find(from_content_state_id)
-  end
-
-  # Determines whether given data is still up-to-date for given index and key.
-  def has_changes_for?(index, key, data)
-    case index
-    when 'id'
-      id_index.include?(key)
-    when 'path'
-      path_index.include?(key) || data.first && id_index.include?(data.first['_id'].first)
-    when 'ppath'
-      ppath_index.include?(key) || data.find { |d| id_index.include?(d['_id'].first) }
-    end
-  end
-
-  # Computes for a given changes feed a set of access-efficient indexes.
-  def index_changes!
-    id_index, path_index, ppath_index = Set.new, Set.new, Set.new
-    if changes.present?
-      changes.each do |hash|
-        id_index.add(hash['id'])
-        if path = hash['modified_path']
-          path_index.add(path)
-          ppath_index.add(ParentPath.of(path)) if path != '/'
-        end
-      end
-    end
-    self.changes = nil
-    self.changes_index = {'id' => id_index, 'path' => path_index, 'ppath' => ppath_index}
-  end
-
-  # Returns a hash representation of a content state for serialization purpose.
-  def to_hash
-    {
-      content_state_id: content_state_id,
-      changes_index: changes_index,
-      from_content_state_id: from_content_state_id
-    }
-  end
-
-  private
-
-  def id_index
-    @id_index ||= changes_index['id']
-  end
-
-  def path_index
-    @path_index ||= changes_index['path']
-  end
-
-  def ppath_index
-    @ppath_index ||= changes_index['ppath']
-  end
-end
-
-end

data/lib/scrivito/content_state_caching.rb

@@ -1,47 +0,0 @@
-module Scrivito
-
-# This module provides advances auto-invalidating caching mechanism for storing obj data.
-#
-# To keep it up-to-date its caches and changes should be updated periodically
-# Its changes should be updated every time a new workspace data has been fetched.
-# Its caches should be updated every time a new obj data has been fetched.
-module ContentStateCaching
-  class << self
-    # How deep should a content state chain be inspected. Default depth is 20.
-    attr_accessor :cache_lookup_depth
-
-    # At which lookup depth to copy a hit found in an ancestor content state
-    # to the current content state's cache. Default depth is 5.
-    attr_accessor :cache_replication_depth
-
-    # Updates caches with data from given workspace.
-    # Should be called every time a new OBJ data has been fetched.
-    def store_obj_data(content_state, index, key, data)
-      content_state.save_obj_data(index, key, data) if content_state
-    end
-
-    # Fetches up-to-date obj data for given workspace, index and key.
-    # Returns nil if no up-to-date data found.
-    def find_obj_data(current_content_state , index, key)
-      if index == 'permalink'
-        current_content_state.find_obj_data(index, key)
-      else
-        visitor = ContentStateVisitor.new(current_content_state)
-        cache_lookup_depth.times do |depth|
-          return unless content_state = visitor.visit_next
-          if hit = content_state.find_obj_data(index, key)
-            visitor.visited_except_current.each { |cs| return if cs.has_changes_for?(index, key, hit) }
-            current_content_state.save_obj_data(index, key, hit) if depth >= cache_replication_depth
-            return hit
-          end
-        end
-        nil
-      end
-    end
-  end
-
-  self.cache_replication_depth = 5
-  self.cache_lookup_depth = 20
-end
-
-end

data/lib/scrivito/content_state_visitor.rb

@@ -1,19 +0,0 @@
-module Scrivito
-  class ContentStateVisitor
-    def initialize(start_content_state)
-      @next_content_state, @visited = start_content_state, []
-    end
-
-    def visit_next
-      if content_state = @next_content_state
-        @visited << content_state
-        @next_content_state = content_state.from_content_state
-        content_state
-      end
-    end
-
-    def visited_except_current
-      @visited[0..-2]
-    end
-  end
-end

data/lib/scrivito/obj_data_from_service.rb

@@ -1,63 +0,0 @@
-module Scrivito
-
-  class ObjDataFromService < ObjData
-    def initialize(data)
-      @data = data
-    end
-
-    def raw_value_and_type_of(attribute_name)
-      return [value_of_widget_pool, nil] if attribute_name == '_widget_pool'
-      if value_and_type = @data[attribute_name]
-        value, type = value_and_type
-        value = convert_value(value, type)
-        [value, type]
-      else
-        [nil, nil]
-      end
-    end
-
-    def convert_value(value, type)
-      case type
-      when 'html' then convert_text_links(value)
-      else value
-      end
-    end
-
-    def attribute_names
-      @data.keys
-    end
-
-    def to_h
-      @data.to_h
-    end
-
-    private
-
-    def convert_text_links(value)
-      text_links_conversion.convert(value)
-    end
-
-    def text_links_conversion
-      @text_links_conversion = TextLinkConversion.new(text_links_map)
-    end
-
-    def text_links_map
-      text_links = @data["_text_links"]
-      return nil unless text_links
-
-      text_links.first.each_with_object({}) do |link, map|
-        map[link["link_id"]] = TextLink.new(link)
-      end
-    end
-
-    def value_of_widget_pool
-      if widget_pool = @data['_widget_pool']
-        widget_pool.first.dup.tap do |hash|
-          hash.each_pair do |widget_id, raw_widget_data|
-            hash[widget_id] = self.class.new(raw_widget_data)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/scrivito/workspace_data_from_service.rb

@@ -1,43 +0,0 @@
-module Scrivito
-
-class WorkspaceDataFromService < WorkspaceData
-  class << self
-    # Fetches a workspace data previously store in cache storage.
-    # Returns nil if not found.
-    def find_from_cache(id)
-      if data = CmsDataCache.read_workspace_data(id)
-        new(data)
-      end
-    end
-  end
-
-  data_attr_reader :diff
-
-  def changes
-    diff && diff['changes']
-  end
-
-  def from_content_state_id
-    diff && diff['from_content_state_id']
-  end
-
-  def to_content_state_id
-    diff && diff['to_content_state_id']
-  end
-
-  # Serializes and stores a workspace data in cache storage.
-  # Also creates an appropriate content state if needed.
-  def store_in_cache_and_create_content_state
-    create_content_state if content_state_id
-    store_in_cache
-  end
-
-  private
-
-  def create_content_state
-    ContentState.create(content_state_id: to_content_state_id, changes: changes,
-        from_content_state_id: from_content_state_id)
-  end
-end
-
-end # module Scrivito