scrivito_sdk 0.12.0

data/lib/scrivito/link_parser.rb

@@ -0,0 +1,81 @@
+require 'addressable/uri'
+
+module Scrivito
+  class LinkParser
+    def initialize(host, port)
+      @host = host
+      @port = port
+    end
+
+    def parse(url)
+      uri = Addressable::URI.parse(url)
+      link_params = {}
+
+      if obj = find_obj(uri)
+        link_params[:obj] = obj
+      else
+        if application_uri?(uri)
+          uri.path = '/' unless uri.path.present?
+          uri.port = nil
+          uri.host = nil
+          uri.scheme = nil
+        end
+
+        link_params[:url] = uri.to_s
+      end
+
+      link_params[:query] = remove_editing_context_params(uri.query)
+      link_params[:fragment] = uri.fragment
+
+      Link.new(link_params)
+    rescue Addressable::URI::InvalidURIError
+      Link.new(url: url)
+    end
+
+    private
+
+    def application_uri?(uri)
+      uri.absolute? && internal_uri?(uri) || uri.relative? && uri.path.present?
+    end
+
+    def internal_uri?(uri)
+      if uri.port.present?
+        uri.host == @host && uri.port == Integer(@port)
+      else
+        uri.host == @host
+      end
+    end
+
+    def find_obj(uri)
+      return nil unless application_uri?(uri) && application_route?(uri)
+
+      route_params = route(uri)
+
+      if id = route_params[:id]
+        Obj.find(id)
+      elsif permalink = route_params[:permalink]
+        Obj.find_by_permalink(permalink)
+      end
+    rescue Scrivito::ResourceNotFound
+    end
+
+    def application_route?(uri)
+      route_params = route(uri)
+      route_params && route_params[:controller] == 'scrivito/cms_dispatch'
+    end
+
+    def route(uri)
+      Rails.application.routes.recognize_path(uri.to_s, method: :get)
+    rescue ActionController::RoutingError
+    end
+
+    def remove_editing_context_params(query)
+      if query
+        params = Rack::Utils.parse_nested_query(query)
+        params.delete('_scrivito_display_mode')
+        params.delete('_scrivito_workspace_id')
+        params.to_query
+      end
+    end
+  end
+end

data/lib/scrivito/log_subscriber.rb

@@ -0,0 +1,29 @@
+module Scrivito
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def self.runtime=(value)
+      Thread.current["scrivito_cms_load_runtime"] = value
+    end
+
+    def self.runtime
+      Thread.current["scrivito_cms_load_runtime"] ||= 0
+    end
+
+    def self.reset_runtime
+      rt, self.runtime = runtime, 0
+      rt
+    end
+
+    def cms_load(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      name = '%s (%.1fms)' % [event.payload[:name], event.duration]
+      debug "  #{name}  #{event.payload[:index]} #{event.payload[:keys].inspect}"
+    end
+
+    def logger
+      Rails.logger
+    end
+  end
+end
+

data/lib/scrivito/migration.rb

@@ -0,0 +1,2 @@
+# ::Scrivito::Migration is just a shortcut
+::Scrivito::Migration = ::Scrivito::Migrations::Migration

data/lib/scrivito/migrations.rb

@@ -0,0 +1,12 @@
+module Scrivito
+  module Migrations
+    extend ActiveSupport::Autoload
+
+    autoload :Migration
+    autoload :Migrator
+    autoload :MigrationStore
+    autoload :MigrationDsl
+    autoload :CmsBackend
+    autoload :WorkspaceLock
+  end
+end

data/lib/scrivito/migrations/cms_backend.rb

@@ -0,0 +1,94 @@
+module Scrivito
+  module Migrations
+    class CmsBackend
+      def read
+        obj = find_migration_store_obj
+
+        if obj
+          obj[attribute_name]
+        else
+          initial_value
+        end
+      end
+
+      def save(value)
+        CmsRestApi.put(
+          endpoint("objs/#{migration_store_obj.id}"),
+          :obj => {
+            attribute_name => value
+          }
+        )
+      end
+
+      private
+
+      def create
+        # Create obj class
+        CmsRestApi.post(
+          endpoint('obj_classes'),
+          :obj_class => {
+            :name => obj_class_name,
+            :attributes => [
+              {
+                :name => attribute_name,
+                :type => :text,
+              },
+            ],
+            :type => :publication,
+            :title => obj_class_name,
+          }
+        )
+
+        # Create obj
+        CmsRestApi.post(
+          endpoint('objs'),
+          :obj => {
+            :_path => path,
+            :_obj_class => obj_class_name,
+            attribute_name => initial_value,
+          }
+        )
+
+        # Deactivate obj class
+        CmsRestApi.put(
+          endpoint("obj_classes/#{obj_class_name}"),
+          :obj_class => {
+            :is_active => false,
+          }
+        )
+      end
+
+      def migration_store_obj
+        unless find_migration_store_obj
+          create
+        end
+
+        find_migration_store_obj
+      end
+
+      def find_migration_store_obj
+        Obj.find_by_path(path)
+      end
+
+      def attribute_name
+        'versions'
+      end
+
+      def obj_class_name
+        'MigrationStore'
+      end
+
+      def path
+        '/_internal/migration-store'
+      end
+
+      def initial_value
+        ''
+      end
+
+      def endpoint(path)
+        "workspaces/#{Workspace.current.id}/#{path}"
+      end
+    end
+  end
+end

data/lib/scrivito/migrations/installer.rb

@@ -0,0 +1,45 @@
+module Scrivito
+  module Migrations
+    class Installer
+      def initialize(from)
+        @to_load = from.blank? ? :all : from.split(',').map(&:strip)
+      end
+
+      def install
+        Scrivito::Migrations::Migration.copy(destination, find_engines_with_migrations)
+      end
+
+      private
+
+      def destination
+        Scrivito::Migrations::Migrator.migrations_path
+      end
+
+      def find_engines_with_migrations
+        Rails.application.railties.inject({}) do |railties, railtie|
+          next railties unless @to_load == :all || @to_load.include?(railtie.railtie_name)
+
+          if path = railtie_migration_path_for(railtie)
+            railties[railtie.railtie_name] = path
+          end
+
+          railties
+        end
+      end
+
+      def railtie_migration_path_for(railtie)
+        if railtie.respond_to?(:paths)
+          path = railtie.paths.path + relative_migration_path
+
+          if File.exist?(path)
+            path
+          end
+        end
+      end
+
+      def relative_migration_path
+        'cms/migrate'
+      end
+    end
+  end
+end

data/lib/scrivito/migrations/migration.rb

@@ -0,0 +1,93 @@
+module Scrivito
+  module Migrations
+    # CMS Migrations can alter the structure and content of the CMS and allow
+    # other developers to simultaneously apply changes. Migrations provide a set
+    # of methods to create, update or delete CMS objects, attributes and object
+    # classes.
+    #
+    # @example Simple Migration
+    #
+    #   class CreateTestAttribute < Scrivito::Migrations::Migration
+    #     def up
+    #       add_attribute_to('homepage', :name => 'test', :type => 'string')
+    #     end
+    #   end
+    class Migration
+      include MigrationDsl
+
+      class << self
+        def copy(destination, sources)
+          unless File.exist?(destination)
+            FileUtils.mkdir_p(destination)
+          end
+
+          destination_migrations = Scrivito::Migrations::Migrator.determine_migrations(destination)
+          last = destination_migrations.last
+
+          sources.each do |scope, path|
+            source_migrations = Scrivito::Migrations::Migrator.determine_migrations(path)
+
+            source_migrations.each do |migration|
+              next if duplicate_migration?(destination_migrations, migration.name, scope)
+
+              name = migration.name
+              version = next_migration_number(last ? last.version : 0)
+              filename = File.join(destination, "#{version}_#{name.underscore}.#{scope}.rb")
+
+              new_migration = self.new(name, version, filename, scope)
+
+              FileUtils.cp(migration.filename, new_migration.filename)
+
+              last = new_migration
+              destination_migrations << new_migration
+            end
+          end
+        end
+
+        def duplicate_migration?(migrations, name, scope)
+          migrations.detect do |migration|
+            migration.name == name && migration.scope == scope.to_s
+          end
+        end
+
+        def next_migration_number(max)
+          timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+
+          if max >= timestamp
+            timestamp = max + 1
+          end
+
+          timestamp
+        end
+      end
+
+      attr_accessor :name
+      attr_accessor :version
+      attr_accessor :filename
+      attr_accessor :scope
+
+      def initialize(name, version, filename, scope)
+        @name = name
+        @version = version.to_i
+        @filename = filename
+        @scope = scope.to_s
+      end
+
+      def migrate
+        announce 'migrating'
+
+        time = Benchmark.measure { up }
+
+        announce 'migrated (%.4fs)' % time.real; puts
+      end
+
+      private
+
+      def announce(message)
+        text = "#{version} #{name}: #{message}"
+        length = [0, 75 - text.length].max
+        puts('== %s %s' % [text, '=' * length])
+      end
+    end
+  end
+end

data/lib/scrivito/migrations/migration_dsl.rb

@@ -0,0 +1,143 @@
+module Scrivito
+  # @api public
+  module Migrations
+    # @api public
+    module MigrationDsl
+      # Adds an attribute to an object class.
+      #
+      # @example Add "test" attribute to object class "Foo.
+      #
+      #   add_attribute_to('Foo', { name: 'test', type: 'string' })
+      #
+      # @param obj_class_name [String] The class name of the object class.
+      # @param params [Hash] The definition of the new attribute.
+      #
+      # @return nothing
+      def add_attribute_to(obj_class_name, params)
+        attributes = get_obj_class(obj_class_name)['attributes']
+        attributes << params
+
+        update_obj_class(obj_class_name, attributes: attributes)
+      end
+
+      # Deletes an attribute from an object class.
+      #
+      # @example Delete "test" attribute from object class "Foo.
+      #
+      #   delete_attribute_from('Foo', 'test')
+      #
+      # @param obj_class_name [String] The class name of the object class.
+      # @param attribute_name [String] The name of the attribute that should be
+      #   deleted.
+      #
+      # @return nothing
+      def delete_attribute_from(obj_class_name, attribute_name)
+        attributes = get_obj_class(obj_class_name)['attributes']
+        attributes = attributes.delete_if do |attribute|
+          attribute['name'] == attribute_name.to_s
+        end
+
+        update_obj_class(obj_class_name, attributes: attributes)
+      end
+
+      # Updates an attribute for an object class.
+      #
+      # @example Update "test" attribute for object class "Foo.
+      #
+      #   update_attribute_for('Foo', 'test', { title: 'New Title' })
+      #
+      # @param obj_class_name [String] The class name of the object class.
+      # @param attribute_name [String] The name of the attribute that should be
+      #   updated.
+      # @param params [Hash] Hash of updated attributes.
+      #
+      # @return nothing
+      def update_attribute_for(obj_class_name, attribute_name, params)
+        attribute_name = attribute_name.to_s
+        attributes = get_obj_class(obj_class_name)['attributes']
+        found = false
+
+        attributes.each_with_index do |attribute, index|
+          if attribute['name'] == attribute_name
+            attributes[index] = attribute.merge(params.stringify_keys)
+            update_obj_class(obj_class_name, attributes: attributes)
+
+            found = true
+
+            break
+          end
+        end
+
+        unless found
+          raise ArgumentError.new("Object class '#{obj_class_name}' does not have attribute '#{attribute_name}'.")
+        end
+      end
+
+      # Creates a CMS object class.
+      #
+      # @example Create "Test" Object Class
+      #
+      #   create_obj_class(name: 'Test', type: 'publication')
+      #
+      # @param attributes [Hash] The attributes and their values of the new
+      #   CMS object class.
+      #
+      # @return nothing
+      # @api public
+      def create_obj_class(attributes = {})
+        endpoint = "workspaces/#{Workspace.current.id}/obj_classes"
+
+        CmsRestApi.post(endpoint, obj_class: attributes)
+      end
+
+      # Fetches all object attributes and their values.
+      #
+      # @example Get all attributes for the obj with id "abc123"
+      #
+      #   get_obj('abc123')
+      #
+      # @param id [String] The ID of the CMS object.
+      #
+      # @return [Hash] a hash with attributes and their values.
+      # @api public
+      def get_obj(id)
+        endpoint = "workspaces/#{Workspace.current.id}/objs/#{id}"
+
+        CmsRestApi.get(endpoint)
+      end
+
+      # Fetches all object class attributes and their values.
+      #
+      # @example Get all attributes for the object class "Test"
+      #
+      #   get_obj_class('Test')
+      #
+      # @param id [String] The ID of the object class.
+      #
+      # @return [Hash] a hash with attributes and their values.
+      # @api public
+      def get_obj_class(id)
+        endpoint = "workspaces/#{Workspace.current.id}/obj_classes/#{id}"
+
+        CmsRestApi.get(endpoint)
+      end
+
+      # Updates a CMS object class.
+      #
+      # @example Update the title of the "Test" Object Class
+      #
+      #   update_obj_class('Test', title: 'Test Title')
+      #
+      # @param id [String] The ID of the CMS object class.
+      # @param attributes [Hash] The updated attributes and their values.
+      #
+      # @return nothing
+      # @api public
+      def update_obj_class(id, attributes = {})
+        endpoint = "workspaces/#{Workspace.current.id}/obj_classes/#{id}"
+
+        CmsRestApi.put(endpoint, obj_class: attributes)
+      end
+    end
+  end
+end