imedo_client_communication 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in imedo_client_communication.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'gemmer'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run all tests.'
+task :default => ['test:units', 'test:functionals']
+
+desc 'Unit Test the common_helpers gem.'
+Rake::TestTask.new('test:units') do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/unit/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Functional Test the common_helpers gem.'
+Rake::TestTask.new('test:functionals') do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/functional/**/*_test.rb'
+  t.verbose = true
+end
+
+Gemmer::Tasks.new('imedo_client_communication') do |t|
+  t.release_via :scatter, :to => 'dev01'
+end

data/imedo_client_communication.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "imedo_client_communication/version"
+
+# Dependencies
+dependencies = [
+  [ %q<activesupport> , ["= 2.3.3"] ],
+  [ %q<actionpack>    , ["= 2.3.3"] ]
+]
+
+Gem::Specification.new do |s|
+  s.name        = "imedo_client_communication"
+  s.version     = ImedoClientCommunication::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["imedo GmbH"]
+  s.email       = ["entwickler@imedo.de"]
+  s.homepage    = ""
+  s.summary     = %q{Client-side communication with the main application}
+
+  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"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      dependencies.each{|dep| s.add_runtime_dependency(*dep) }
+    else
+      dependencies.each{|dep| s.add_dependency(*dep) }
+    end
+  else
+    dependencies.each{|dep| s.add_dependency(*dep) }
+  end
+
+end

data/lib/imedo_client_communication.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'action_controller'
+module ImedoClientCommunication
+  autoload :Context, "imedo_client_communication/context"
+  autoload :Payload, "imedo_client_communication/payload"
+  autoload :BaseProvider, "imedo_client_communication/base_provider"
+end

data/lib/imedo_client_communication/base_provider.rb

@@ -0,0 +1,37 @@
+module ImedoClientCommunication
+
+  module BaseProvider
+    def self.included(receiver)
+      receiver.class_eval do
+
+        provides_context :title
+        provides_context :main_title, :main_subtitle, :meta_title, :title_class, :subtitle
+        provides_context :page_description, :page_keywords, :keywords
+        provides_context :geo_location_city, :geo_location_latlong, :geo_location_icbm, :geo_location_region
+        provides_context :noindex, :canonical, :no_breadcrumb
+
+        provides_context :request_uri do
+          request.request_uri
+        end
+
+        provides_context :forbidden
+
+        provides_context :page_id
+        provides_context :model_type => lambda { @navigation_model.class.name if @navigation_model },
+          :model_id => lambda { @navigation_model.id if @navigation_model },
+          # remove respond_to when all client apps implemented the necessary remote sitemap method in all models
+          :model_name => lambda { @navigation_model.sitemap_name if @navigation_model && @navigation_model.respond_to?(:sitemap_name) },
+          :model_param => lambda { @navigation_model.to_param if @navigation_model }
+
+        provides_context :back_link
+
+        provides_context :current_topic # hook to connect contents across apps
+
+        provides_context :client_javascripts do
+          (Array(@client_javascripts) || []).join(",")
+        end
+
+      end
+    end
+  end
+end

data/lib/imedo_client_communication/context.rb

@@ -0,0 +1,52 @@
+module ImedoClientCommunication
+
+  module Context
+    module ClassMethods
+      def provides_context(*names, &block)
+        if names.size > 1 && block_given?
+          raise "Either give the names of several instance variables, or one instance variable and a block"
+        else
+          if names.size == 1 && block_given?
+            names = { names.first => block }
+          elsif names.first.is_a?(Hash)
+            names = names.first
+          else
+            names = names.inject({}) { |hash, name| hash[name] = lambda { instance_variable_get :"@#{name}" }; hash }
+          end
+          self.context_providers.merge! names
+        end
+      end
+
+    end
+
+    module InstanceMethods
+      def dump_context
+        context.merge!(eval_context)
+        context
+      end
+
+      protected
+      def eval_context
+        self.class.context_providers.inject({}) do |hash, pair|
+          hash[pair.first] = pair.last.bind(@template || self).call
+          hash
+        end
+      end
+
+      def context
+        @context ||= {}
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+
+      receiver.class_eval do
+        class_inheritable_accessor :context_providers
+        self.context_providers = {}
+        helper_method :dump_context if self.respond_to?(:helper_method)
+      end
+    end
+  end
+end

data/lib/imedo_client_communication/payload.rb

@@ -0,0 +1,11 @@
+module ImedoClientCommunication
+
+  class Payload
+
+    def self.serialize(body)
+      BERT.encode(body)
+    end
+
+  end
+end
+

data/lib/imedo_client_communication/version.rb

@@ -0,0 +1,3 @@
+module ImedoClientCommunication
+  VERSION = "0.0.1"
+end

data/test/functional/lib/context_test.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class ImedoClientCommunication::ContextTest < ActionController::TestCase
+
+  test "should provide context for one variable" do
+    c = create_class do
+      provides_context :variable
+    end
+    assert c.context_providers.has_key?(:variable)
+  end
+
+  test "should provide context for more than one variable" do
+    c = create_class do
+      provides_context :one, :two, :three
+    end
+    assert (c.context_providers.keys - [:one, :two, :three]).blank?
+  end
+
+  test "should provide context for one variable with hash" do
+    c = create_class do
+      provides_context :variable => lambda { |value| Hash.new(:value => value) }
+    end
+    assert c.context_providers.has_key?(:variable)
+  end
+
+  test "should allow block as lambda for one variable" do
+    c = create_class do
+      provides_context :variable do |value|
+        Hash.new(:value => value)
+      end
+    end
+    assert c.context_providers.has_key?(:variable)
+  end
+
+  test "should not allow block as lambda for multiple variables" do
+    assert_raise RuntimeError do
+      create_class do
+        provides_context :one, :two do |value|
+          Hash.new(:value => value)
+        end
+      end
+    end
+  end
+
+  test "should dump context" do
+    klass = create_class do
+      provides_context :variable
+      attr_accessor :variable
+    end
+    c = klass.new
+    c.variable = { :value => 15 }
+    expected = { :variable => { :value => 15 } }
+    assert_equal expected, c.dump_context
+  end
+
+protected
+  def create_class(&block)
+    returning Class.new(ApplicationController) do |klass|
+      klass.class_eval do
+        block.bind(self).call if block_given?
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+
+RAILS_ROOT = File.dirname(__FILE__) + '/..'
+
+gem 'activesupport', '2.3.3'
+
+require 'active_support'
+require 'ostruct'
+
+require File.dirname(__FILE__) + '/../lib/imedo_client_communication'
+ActionController::Base.send(:include, ImedoClientCommunication::Context)
+class ApplicationController<ActionController::Base; end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: imedo_client_communication
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- imedo GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: 
+- entwickler@imedo.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- imedo_client_communication.gemspec
+- lib/imedo_client_communication.rb
+- lib/imedo_client_communication/base_provider.rb
+- lib/imedo_client_communication/context.rb
+- lib/imedo_client_communication/payload.rb
+- lib/imedo_client_communication/version.rb
+- test/functional/lib/context_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Client-side communication with the main application
+test_files: 
+- test/functional/lib/context_test.rb
+- test/test_helper.rb