embeditor-rails 1.0.1 → 1.1.0

data/README.md

@@ -15,8 +15,11 @@ gem 'embeditor'
 
 ## Dependencies
 
-Currently, [`underscore.js`](http://underscorejs.org/) is a required dependency.
-I hope to remove this dependency eventually.
+The following dependencies must be included manually. I hope to remove these
+eventually.
+
+* [jQuery](http://jquery.com/)
+* [underscore.js](http://underscorejs.org/)
 
 
 ## Usage
@@ -134,7 +137,12 @@ endpoint:
 When initializing the global `Embeditor.Base` object, you may specify
 configuration for individual adapters.
 
-The `plugin` object is for configuring the adapter.
+The `plugin` object is for configuring the adapter. The properties depends on
+the adapter.
+
+The `display` object is for configuring display options. Properties:
+* `placement` - the method to use for placing the embed, such as
+  `before`, `after`, or `replace`. Default is `after`.
 
 The `query` object is for configuring the query parameters, or in the case of
 an adapter which doesn't use a query, it's for configuring the embed properties.
@@ -154,6 +162,9 @@ new Embeditor.Base({
     FireTracker: {
         query: {
             maxheight: 350
+        },
+        display: {
+          placement: 'replaceWith'
         }
     },
     CoverItLive: {
@@ -187,6 +198,9 @@ class Embeditor.Adapters.Twitter extends Embeditor.Adapter
     @QueryDefaults =
         maxheight: 500
 
+    @DisplayDefaults =
+        placement: 'before'
+
     # ...
 ```
 
@@ -222,6 +236,11 @@ This eliminates any oEmbed headaches (Access-Control-Allowed-Origin, for
 example), and also reduces the time it takes for an embed to load.
 
 
+## CKEditor plugin
+
+An unofficial CKEditor plugin can be found [HERE](https://github.com/SCPR/SCPRv4/blob/master/vendor/assets/javascripts/ckeditor/plugins/embed-placeholder/plugin.js).
+Copy and paste it into your own repository.
+
 
 ## Extending
 
@@ -236,6 +255,8 @@ You can extend your adapter from:
 * `Embeditor.Adapters.StaticTemplate`, for embeds where the embed code is
   stored in the `/templates` directory and rendered with JST.
 
+**NOTE** Any function beginning with an underscore, like `_extractData()`,
+should be considered a private function.
 
 ## Known Issues
 

data/app/assets/javascripts/embeditor/adapter.js.coffee

@@ -6,33 +6,51 @@ class Embeditor.Adapter
 
     @QueryDefaults = {}
 
+    @DisplayDefaults =
+        placement : 'after'
+
+
     constructor: (@element, @options={}) ->
-        @adapter        = Embeditor.Adapters[@className]
-        @href           = @element.attr('href')
-        @dataOptions    = @_extractData()
-        @queryParams    = @_buildParams(@dataOptions, options)
+        @adapter    = Embeditor.Adapters[@className]
+        @href       = @element.attr('href')
+        @wrapper    = $("<div />", class: @options.wrapperClass)
+
+        displayData     = @_extractData('DisplayDefaults')
+        @display        = @_buildDisplayOptions(displayData)
 
-        @wrapper        = $("<div />", class: @options.wrapperClass)
+        queryData       = @_extractData('QueryDefaults')
+        @dataOptions    = queryData # Deprecated
+        @queryParams    = @_buildQueryParams(queryData)
 
 
+    # @Override
     swap: ->
         return
 
 
     embed: (html) ->
         @wrapper.html(html)
-        @element.after @wrapper
+        @element[Embeditor.PlacementFunctions[@display.placement]](@wrapper)
 
 
-    _extractData: ->
-        dataOptions = {}
+
+    _extractData: (defaults) ->
+        data = {}
 
         for key,val of @element.data()
             # Make sure we care about this attribute
-            if @adapter.QueryDefaults?[key]
-                dataOptions[key] = val
+            if @adapter[defaults]?[key]
+                data[key] = val
+
+        data
 
-        dataOptions
+
+    _buildDisplayOptions: (data) ->
+        @_defaultsWithoutEmptyStrings(data, # What the user wants
+            @options[@adapter]?['display'], # What the developer wants
+            @options['display'], # What the developer wants globally
+            @adapter.DisplayDefaults # What Embeditor wants
+        )
 
 
     # We're combining a few things (in order of precedence):
@@ -41,9 +59,23 @@ class Embeditor.Adapter
     #    initialization,
     # 3. The global options specified at Embeditor initialization,
     # 4. This adapter's default options (fallback options).
-    _buildParams: (dataOptions, options) ->
-        _.defaults(dataOptions,
-            @adapter.query,
-            options['query'],
+    _buildQueryParams: (data) ->
+        @_defaultsWithoutEmptyStrings(data,
+            @options[@adapter]?['query'],
+            @options['query'],
             @adapter.QueryDefaults
         )
+
+    # Like Underscore.defaults, but it will also fill in empty strings.
+    # This should be used when merging objects that including any user
+    # input.
+    _defaultsWithoutEmptyStrings: (obj) ->
+        args = Array.prototype.slice.call(arguments, 1)
+
+        for source in args
+            continue if !source
+
+            for prop,value of source
+                obj[prop] = source[prop] if !obj[prop]
+
+        obj

data/app/assets/javascripts/embeditor/adapters/embedly.js.coffee

@@ -3,6 +3,12 @@
 class Embeditor.Adapters.Embedly extends Embeditor.Adapter
     className: "Embedly"
 
+    # Map `data-placement` to Embedly `method` parameter options.
+    @MethodMap =
+        replace     : 'replace'
+        before      : 'before'
+        after       : 'after'
+
     # This object should hold any keys that we want to
     # send to the API. Any key not in this object will
     # be ignored as a data attribute.
@@ -10,14 +16,14 @@ class Embeditor.Adapters.Embedly extends Embeditor.Adapter
         maxheight   : 450
 
     @PluginDefaults =
-        method      : "after"
+        method      : 'after'
         className   : Embeditor.DefaultOptions.wrapperClass
         endpoint    : 'oembed'
         # Key must be specified
 
 
     constructor: (@element, @options={}) ->
-        pluginOpts = options['Embedly']?['plugin'] or {}
+        pluginOpts = @options['Embedly']?['plugin']
         @pluginOptions = _.defaults(pluginOpts, Embedly.PluginDefaults)
 
         super
@@ -25,6 +31,7 @@ class Embeditor.Adapters.Embedly extends Embeditor.Adapter
 
     swap: ->
         params = @_buildEmbedlyParams()
+        console.log params
         @element.embedly(params)
 
 
@@ -32,6 +39,9 @@ class Embeditor.Adapters.Embedly extends Embeditor.Adapter
         if @embedlyParams
             return @embedlyParams
 
+        # Use `data-placement` as the embedly method parameter
         @embedlyParams = _.extend(
-            @pluginOptions,
+            _.defaults({
+                method : Embedly.MethodMap[@display.placement]
+            }, @pluginOptions),
             query : @queryParams)

data/app/assets/javascripts/embeditor/adapters/google_fusion.js.coffee

@@ -0,0 +1,16 @@
+class Embeditor.Adapters.GoogleFusion extends Embeditor.Adapters.StaticTemplate
+    className: "GoogleFusion"
+
+    @Template = Embeditor.Template('google_fusion')
+
+    @QueryDefaults =
+        maxwidth  : 620
+        maxheight : 550
+
+    @Matchers = []
+
+    swap: ->
+        @embed GoogleFusion.Template
+            maxheight   : @queryParams.maxheight
+            maxwidth    : @queryParams.maxwidth
+            url         : @href

data/app/assets/javascripts/embeditor/embeditor.js.coffee

@@ -9,6 +9,7 @@ window.Embeditor = {
         'livestream'    : 'Embedly'
         'vine'          : 'Embedly'
         'googlemaps'    : 'Embedly'
+        'googlefusion'  : 'GoogleFusion'
         'scribd'        : 'Embedly'
         # 'documentcloud' : 'DocumentCloud'
         'polldaddy'     : 'Polldaddy'
@@ -29,10 +30,19 @@ window.Embeditor = {
         JST[@TemplatePath + template]
 
     DefaultOptions :
-        defaultAdapter      : 'Embedly' # Adapter that gets used when the service isn't recognized
-        defaultService      : 'other'   # Service that gets used when the `data-service` attribute is missing
-        placeholderClass    : "embed-placeholder" # The class that the embed placeholders have
-        wrapperClass        : "embed-wrapper" # The class the embed's wrapper should be given
+         # Adapter that gets used when the service isn't recognized
+        defaultAdapter      : 'Embedly'
+        # Service that gets used when the `data-service` attribute is missing
+        defaultService      : 'other'
+        # The class that the embed placeholders have
+        placeholderClass    : "embed-placeholder"
+        # The class the embed's wrapper should be given
+        wrapperClass        : "embed-wrapper"
+
+    PlacementFunctions :
+        before  : 'before'
+        after   : 'after'
+        replace : 'replaceWith'
 }
 
 

data/app/assets/javascripts/embeditor/templates/google_fusion.jst.eco

@@ -0,0 +1 @@
+<iframe width="<%=@maxwidth%>" height="<%=@maxheight%>" scrolling="no" frameborder="no" src="<%=@url%>"></iframe>

data/lib/embeditor-rails/version.rb

@@ -1,5 +1,5 @@
 module Embeditor
   module Rails
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embeditor-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -74,6 +90,7 @@ files:
 - app/assets/javascripts/embeditor/adapters/document_cloud.js.coffee
 - app/assets/javascripts/embeditor/adapters/embedly.js.coffee
 - app/assets/javascripts/embeditor/adapters/fire_tracker.js.coffee
+- app/assets/javascripts/embeditor/adapters/google_fusion.js.coffee
 - app/assets/javascripts/embeditor/adapters/instagram.js.coffee
 - app/assets/javascripts/embeditor/adapters/oembed.js.coffee
 - app/assets/javascripts/embeditor/adapters/polldaddy.js.coffee
@@ -85,6 +102,7 @@ files:
 - app/assets/javascripts/embeditor/embeditor.js.coffee
 - app/assets/javascripts/embeditor/templates/brightcove.jst.eco
 - app/assets/javascripts/embeditor/templates/cover_it_live.jst.eco
+- app/assets/javascripts/embeditor/templates/google_fusion.jst.eco
 - app/assets/javascripts/embeditor/templates/instagram.jst.eco
 - app/assets/javascripts/embeditor/templates/polldaddy_poll.jst.eco
 - app/assets/javascripts/embeditor/templates/polldaddy_survey.jst.eco