locomotive_plugins 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGY3MDQyNWJhN2VkZGM3ZjU5MGNjNzhhMmYxZGQzMzRlNTIyMjdhNA==
+    MWY0YzE2YWNmMjMzMGQxOTZmNjQzMWY5MWI1ZDhiNzAxNWY5OTczZQ==
   data.tar.gz: !binary |-
-    MmJmMGYzMmNhNWM5ZDlhZDg0MzJiYzE0OWE4OTdhYzYyZDNlYTY0Mw==
+    YmE3OGQ3NjliNTVkN2JmYzU1OTc2MGNhZmUxM2UyNGM5NDIxZDljZg==
 SHA512:
   metadata.gz: !binary |-
-    MDAxZDdlODc5ZjEwZmQxYTdjZWZkYTg2ZWEzZTcwZGUzODRkZGFiNTI2MGNm
-    ZDFmM2UyZDAxNzkxZjczNDY5ZDQzNTk0ZDkzZGUwZmIxYWU5ZTQ2ZGQ5NDIw
-    OGM4OGM3MDQ5NGQwMDkwMzA1MDE1ZjI3Nzk4ZDcyOWRjYzM2NmE=
+    NDdmNjhmZTljM2VkODExMDkzZTllNWFmNTZkZmM2YTQyNjkyYjg2ZTQxNGFl
+    NTFlZjE2MzJmZjc3NTk0ZjQ1ZDk4YzNhNTA0NDFiMWFmODU1NDZlMjJiZjk5
+    MDViNTgyNDE1ZjIzNjE2YjVmMWFkNjYyNGVmMjdmYzY2YTMwOWI=
   data.tar.gz: !binary |-
-    YzNiZjdkM2MwYWZmNzllN2FjZjZkNzkxN2E2NTQ3OTcxY2RjYzNmNzFiOTAx
-    MDU4MmMwMTdiMDk3YmY1YWY3ZjQ3NWI2N2NmMzAyZDU1NzZiMDhlMjc0MjZk
-    M2ZmODdkZDhlYTg5MDRkMzYzYzg4OGY2Y2ExZGQ5ZTI5NjY3MWQ=
+    MWE3MzlmNTg5MWU4NDY5Mzk3ZjI5M2ZiYTg1OWIwY2QzZWU5NDU1OTk1ZWU4
+    ZDk2OWIyNTJhMWI3OGFjZjNhYTg2OWRkYjY4ZjgyYjEwYTUyZmY3OWZmYTMw
+    ZjYzZTIzMGVkMjAwOWY4OTIxY2YzODE1YWQzMGM1Y2U3ZTY4ZDU=

data/lib/locomotive/plugin.rb

@@ -15,6 +15,7 @@ module Locomotive
     include LoadInitialization
     include Liquid
     include RackAppHelpers
+    include JS3
 
     # @private
     #
@@ -95,7 +96,29 @@ module Locomotive
         nil
       end
 
-    end
+      # Override this method to specify ruby objects accessable via the global
+      # javascript context. The return value must be a hash whoes keys are the
+      # variable names and the values are the objects. The objects will be
+      # included in the global context after being prefixed with the plugin_id.
+      #
+      # Note:
+      #   therubyracer is not able to execute class methods so please ensure
+      #   that the objects you pass in are not classes.
+      #
+      # @exaple
+      #   class MyPlugin
+      #     def self.javascript_context
+      #       {
+      #         :things => ::Locomotive::Plugins::Variable.new {Thing.all},
+      #         :say => lambda{|this,word,times| word * times}
+      #       }
+      #     end
+      #   end
+      def javascript_context
+        {}
+      end
+
+    end ## class
 
     # This variable is set by LocomotiveCMS. It contains the controller which
     # is handling the current request.

data/lib/locomotive/plugin/js3.rb

@@ -0,0 +1,15 @@
+module Locomotive
+  module Plugin
+    # This module add helpers for using js3 (JavaScript on the Server Side)
+    module JS3
+
+      # The js3 context
+      #
+      # @return a V8 context object
+      def js3_context
+        Locomotive::Plugins.js3_context
+      end
+
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module LocomotivePlugins
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/lib/locomotive/plugin_spec.rb

@@ -42,5 +42,13 @@ module Locomotive
       PluginWithRackApp.rack_app.should_not be_nil
     end
 
+    it 'should optionally supply a js3 context' do
+      MyPlugin.javascript_context.keys.should == [:variable, :method]
+      UselessPlugin.javascript_context.should == {}
+    end
+
+    it 'should be able to get a js3 context' do
+      @plugin.respond_to?(:js3_context).should be true
+    end
   end
 end

data/spec/support/plugins/my_plugin.rb

@@ -48,6 +48,13 @@ module Locomotive
       { 'my_tag' => MyTag }
     end
 
+    def self.javascript_context
+      {
+        variable: self.custom_attribute,
+        method: lambda{|this,word,times| word * times  }
+      }
+    end
+
     def my_method1
       'This is my before filter!'
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locomotive_plugins
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Colibri Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: locomotive_liquid
@@ -108,6 +108,7 @@ files:
 - lib/locomotive/plugin/class_tracker.rb
 - lib/locomotive/plugin/config_ui.rb
 - lib/locomotive/plugin/exceptions.rb
+- lib/locomotive/plugin/js3.rb
 - lib/locomotive/plugin/liquid.rb
 - lib/locomotive/plugin/liquid/context_helpers.rb
 - lib/locomotive/plugin/liquid/drop_extension.rb