sinicum 0.5.0

data/lib/sinicum/navigation/navigation_handler.rb

@@ -0,0 +1,95 @@
+module Sinicum
+  module Navigation
+    # Public: Handles the API communication and initializes the
+    # NavigationElement instances.
+    class NavigationHandler
+      include Jcr::ApiClient
+
+      def initialize(axis, base_node_or_path, navigation_element_class, options = {})
+        @navigation_element_class = navigation_element_class
+        if axis == :children
+          @elements = fetch_children(base_node_or_path, options[:depth])
+        elsif axis == :parents
+          @elements = fetch_parents(base_node_or_path)
+        end
+      end
+
+      def elements
+        NavigationElementList.new(@elements)
+      end
+
+      def self.children(base_node_or_path, depth,
+          navigation_element_class = DefaultNavigationElement)
+        new(:children, base_node_or_path, navigation_element_class, depth: depth)
+      end
+
+      def self.parents(base_node_or_path, navigation_element_class = DefaultNavigationElement)
+        new(:parents, base_node_or_path, navigation_element_class)
+      end
+
+      private
+
+      def fetch_children(base_node, depth)
+        url = "/_navigation/children#{base_node_url_part(base_node)}"
+        result = api_get(
+          url,
+          "depth" => depth,
+          "properties" => @navigation_element_class.navigation_properties.join(";"))
+        if result.ok?
+          json = MultiJson.load(result.body)
+          initialize_from_json(json)
+        end
+      end
+
+      def fetch_parents(base_node)
+        url = "/_navigation/parents#{base_node_url_part(base_node)}"
+        result = api_get(
+          url, "properties" => @navigation_element_class.navigation_properties.join(";"))
+        if result.ok?
+          json = MultiJson.load(result.body)
+          initialize_from_json(json)
+        end
+      end
+
+      def initialize_from_json(json)
+        result = []
+        json.each do |el|
+          element = initialize_element(el)
+          result << element if element
+        end
+        @elements = result
+      end
+
+      def initialize_element(el)
+        result = nil
+        unless @navigation_element_class.filter_node(el)
+          children = resolve_children(el)
+          element = @navigation_element_class.new(
+            el["uuid"], el["path"], el["depth"], el["properties"], children)
+          result = element
+        end
+        result
+      end
+
+      def resolve_children(el)
+        children = []
+        if el["children"]
+          el["children"].each do |child_el|
+            child = initialize_element(child_el)
+            children << child if child
+          end
+        end
+        children.size > 0 ? children : nil
+      end
+
+      def base_node_url_part(base_node)
+        if base_node.respond_to?(:uuid)
+          url_part = "/" + base_node.uuid
+        else
+          url_part = base_node
+        end
+        url_part
+      end
+    end
+  end
+end

data/lib/sinicum/navigation/navigation_status.rb

@@ -0,0 +1,27 @@
+module Sinicum
+  module Navigation
+    # Public: Provides meta-information about the status of a NavigationElement
+    # in the iteration.
+    class NavigationStatus
+      attr_reader :size, :count
+
+      def initialize(size, count)
+        @size = size
+        @count = count
+      end
+
+      def first?
+        count == 0
+      end
+
+      def last?
+        count == size - 1
+      end
+
+      def to_s
+        self.class.to_s + ": " +
+          { size: @size, count: @count, :first? => first?, :last? => last? }.inspect
+      end
+    end
+  end
+end

data/lib/sinicum/templating/area_handler.rb

@@ -0,0 +1,33 @@
+module Sinicum
+  module Templating
+    # Private: Handles the lookup and creation of Areas on the server.
+    #
+    # Returns an Array of Strings with the available components or nil if no
+    # area could be identified.
+    class AreaHandler
+      include Jcr::ApiClient
+
+      def lookup_or_create_area(base_node, area_name)
+        result = nil
+        if base_node && area_name.present?
+          path = "/_templating/areas/initialize"
+          response = api_post(
+            path, body: {
+              workspace: base_node.jcr_workspace,
+              baseNodeUuid: base_node.uuid,
+              areaName: area_name })
+          if response.ok?
+            begin
+              json = MultiJson.load(response.body)
+              result = json["availableComponents"]
+            rescue => e
+              Rails.logger.error("Could not lookup area: " + e.to_s)
+              nil
+            end
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/lib/sinicum/templating/dialog_resolver.rb

@@ -0,0 +1,26 @@
+module Sinicum
+  module Templating
+    # Private: Provides information about Magnolia dialogs.
+    class DialogResolver
+      include TemplatingUtils
+      include Jcr::ApiClient
+
+      def dialog_for_node(node)
+        result = nil
+        template = split_template_path(node.mgnl_template)
+        path = "/_templating/dialogs/#{template[:type]}" \
+          "/#{template[:module]}/#{template[:name]}"
+        response = api_get(path)
+        if response.ok?
+          begin
+            json = MultiJson.load(response.body)
+            result = json["dialog"]
+          rescue
+            # nothing
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/lib/sinicum/templating/templating_utils.rb

@@ -0,0 +1,24 @@
+module Sinicum
+  module Templating
+    module TemplatingUtils
+      private
+
+      def split_template_path(path)
+        result = {}
+        parts = path.split(":")
+        result[:module] = parts[0]
+        result[:type] = result_type(parts)        
+        result[:name] = parts[1][parts[1].index("/") + 1, parts[1].length]
+        result
+      end
+
+      def result_type(parts)
+        if parts[1].index("pages/") == 0
+          :page
+        elsif parts[1].index("components/") == 0
+          :component
+        end
+      end
+    end
+  end
+end

data/lib/sinicum/util.rb

@@ -0,0 +1,12 @@
+module Sinicum
+  # Public: Collection of various utility methods.
+  class Util
+    UUID_REGEXP = /^[abcdef0-9]{8}-[abcdef0-9]{4}-[abcdef0-9]{4}-[abcdef0-9]{4}-[abcdef0-9]{12}$/i
+
+    def self.is_a_uuid?(value)
+      return false if value.nil? || !value.respond_to?('match')
+      result = value.match(UUID_REGEXP)
+      !!result
+    end
+  end
+end

data/lib/sinicum/version.rb

@@ -0,0 +1,3 @@
+module Sinicum
+  VERSION = "0.5.0"
+end

data/script/cibuild

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+set -e
+
+eval "$(rbenv init -)"
+
+run_tests () {
+    if [ $BUNDLE_GEMFILE ]; then
+        rm -f "${BUNDLE_GEMFILE}.lock"
+        echo "Testing with Gemfile ${BUNDLE_GEMFILE}"
+    else
+        rm -f "Gemfile.lock"
+        echo "Testing with default Gemfile"
+    fi
+    bundle install --path vendor/bundle
+    bundle exec rake
+}
+
+# run tests
+for rbenv_version in "1.9.3-p545" "2.0.0-p247" "2.1.1"; do
+    rbenv shell $rbenv_version
+    echo "Using Ruby ${rbenv_version}"
+
+    # Run with Rails 3.2
+    export BUNDLE_GEMFILE=gemfiles/Gemfile-3.2
+    run_tests
+
+    # Run with Rails 4
+    unset BUNDLE_GEMFILE
+    run_tests
+done

data/sinicum.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sinicum/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sinicum"
+  s.version     = Sinicum::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dievision GmbH"]
+  s.email       = ["info@dievision.de"]
+  s.homepage    = "http://github.com/dievision/sinicum"
+  s.summary     = %q{Use Magnolia as a CMS backend in a Rails application}
+  s.description = %q{Provides the necessary functionality to work with Magnolia-managed content in a Rails application.}
+
+  s.add_dependency('rails', '>= 3.2')
+  s.add_dependency('httpclient', '~> 2.3')
+  s.add_dependency('multi_json', '~> 1.3')
+  s.add_development_dependency('rspec-rails', '~> 2.14')
+  s.add_development_dependency('yard')
+  s.add_development_dependency('webmock', '~> 1.8')
+  s.add_development_dependency('rubocop', '~> 0.20')
+  s.add_development_dependency('cane', '~> 2.5.2')
+  s.add_development_dependency('codeclimate-test-reporter')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/controllers/sinicum/controller_base_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module Sinicum
+  describe ApplicationController do
+    let(:node) { Jcr::Node.new }
+
+    before(:each) do
+      Content::Aggregator.stub(:original_content).and_return(node)
+      Content::WebsiteContentResolver.stub(:find_for_path).and_return(node)
+      node.stub(:mgnl_template).and_return("something")
+    end
+
+    it "should remove the html_ending" do
+      get :index, format: "html"
+      response.should redirect_to("/home")
+    end
+
+    it "should ignore and conserve query strings" do
+      get :index, format: "html", key: "value"
+      response.should redirect_to("/home?key=value")
+    end
+
+    it "should ignore post requests" do
+      post :index, format: "html"
+      response.status.should eq(200)
+    end
+
+    describe "layout" do
+      it "should render with the application layout if no matching file is found" do
+        get :index
+        response.should render_template("application")
+      end
+
+      it "should render with the application layout if no matching file is found" do
+        node.stub(:mgnl_template).and_return("layout_name")
+        get :index
+        response.should render_template("layout_name")
+      end
+
+      it "should handle Magnolia 4.5-style layouts" do
+        node.stub(:mgnl_template).and_return("my_module:pages/test")
+        get :index
+        response.should render_template("my_module/test")
+      end
+
+      it "should handle Magnolia 4.5-style layouts with dashes" do
+        node.stub(:mgnl_template).and_return("my-module:pages/test")
+        get :index
+        response.should render_template("my-module/test")
+      end
+    end
+  end
+end

data/spec/controllers/sinicum/controllers/global_state_cache_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module Sinicum
+  module Controllers
+    describe GlobalStateCache do
+      let(:controller) do
+        controller = double(:controller)
+        request = double(:request)
+        controller.stub(:request).and_return(request)
+        request.stub(:base_url).and_return("base")
+        request.stub(:fullpath).and_return("fullpath")
+        controller
+      end
+
+      before(:each) do
+        Sinicum::Jcr::Cache::GlobalCache.any_instance
+          .stub(:current_key).and_return("a11cd0d31248427cbadfd8a7bc51e04e96e4de98")
+      end
+
+      it "should return Rails' deployment revision" do
+        GlobalStateCache.send(:deploy_revision)
+          .should eq("d18187f9016c71e82993c867a90ff9a0554519c9")
+      end
+
+      it "should return the cache key" do
+        cache = GlobalStateCache.new(controller)
+        cache.send(:cache_key).should eq(%w(
+          basefullpath
+          a11cd0d31248427cbadfd8a7bc51e04e96e4de98
+          d18187f9016c71e82993c867a90ff9a0554519c9
+          ))
+      end
+    end
+  end
+end

data/spec/dummy/REVISION

@@ -0,0 +1 @@
+d18187f9016c71e82993c867a90ff9a0554519c9

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  include Sinicum::ControllerBase
+
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/application/index.html.erb

@@ -0,0 +1 @@
+<h1>Sinicum</h1>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "sinicum"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end