switch_access-rails 1.1.4

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2012, Leif Ringstad
+All rights reserved.
+
+Please not that Switch-Access from version 1.1 is dual licensed under GPL or a commercial license.
+
+You can either
+  a) License it under GPL (See LICENSE.GPL for details)
+  b) Obtain a commercial license (Contact leifcr@gmail.com for details)
+
+Switch Access library version 1.0 was licensed under the BSD 2-clause license.

data/README.md

@@ -0,0 +1,121 @@
+# Rails 3.2 Integration for switch_access
+
+The `switch_access-rails` gem integrates the [Switch Access](http://leifcr.github.com/switch_access) library with the Rails 3.2 asset pipeline.
+
+
+## Usage
+
+### Installation
+
+**1. Add `switch_access-rails` to your Gemfile**
+
+    gem 'switch_access-rails'
+
+**2. Run `bundle install`.**
+
+**3. Using**
+
+Add to your application.js:
+_jQuery_ is only needed if you haven't included them already
+
+```js
+//= require jquery 
+//= require switch_access
+```
+### Helper methods
+Four helper methods that should be used when creating switch-elements, and initializing the library
+
+```ruby
+# Reset counters to 0, this is done before rendering
+sw_element_reset_counters()
+
+# get the next "group" classname with an id appended (increments automatically)
+sw_element_begin_group()
+
+# get the next "element" classname with an id appended (increments automatically)
+sw_element_next_class()
+
+# ends the group that was started.
+sw_element_end_group()
+
+# Get javascript initializer with given options. 
+# (Recommended to have as late as possible on the page)
+sw_element_js_initializer(options = {})
+
+# finalizes the switch access. Note: Must be done on the end of each page for now...
+sw_element_fini()
+
+```
+
+## Example
+
+Example in a ERB view
+
+```erb
+<%= 
+content_tag :div, :class => sw_element_begin_group() do
+  content_tag(:div, "Switch element 1 in group 1", :class => sw_element_next_class()) +
+  content_tag(:div, "Switch element 2 in group 1", :class => sw_element_next_class()) +
+  content_tag(:div, "Switch element 3 in group 1", :class => sw_element_next_class())
+end
+
+%>
+<% sw_element_end_group() %>
+
+<%=
+content_tag :div, :class => sw_element_begin_group() do
+  content_tag(:div, "Switch element 1 in group 2", :class => sw_element_next_class()) +
+  content_tag(:div, "Switch element 2 in group 2", :class => sw_element_next_class())
+end
+%>
+<% sw_element_end_group() %>
+
+<%= content_tag :div, "Switch element 3 outside groups", :class => sw_element_next_class() %>
+<%= sw_element_js_initializer({
+  :debug => false, # can be removed if value is false
+  :switches => {
+    :number_of_switches => 2, 
+    :groups => true,
+    :delay_for_allowed_keypress => 0
+    }
+  }) %>
+<%= sw_element_fini() %>
+```
+
+See [leifcr.github.com/switch_access](http://leifcr.github.com/switch_access) for examples, unit tests of the library and documentation.
+
+### Example CSS
+
+You can include sample CSS stylesheets to see how highlighters/classes work
+```css
+/* Complete example
+ *= require switch_access/example
+ *
+ * Only highlighters
+ *= require switch_access/example_highlighter
+ *
+ * Only switch element
+ *= require switch_access/example_switch_element
+ */
+```
+
+### Debugging
+
+If you need to debug, log4javascript is included in the gem To avoid issues with log4javascript in other gems, it's namespaced under switch_access
+
+First, add log4javascript to your application.js or other .js
+```js
+//= require switch_access/log4javascript
+```
+
+Second, set debug to true, and a log4javascript Appender/console should show up.
+
+If you have a div with id set to "logger" the appender/console will be created inside that div.
+
+## License
+This GEM is dual licensed under the GPL license and a commercial license. See LICENSE and LICENSE.GPL for details. For commercial usage, please contact leifcr@gmail.com
+
+## Contact
+Feel free to contact me at @leifcr (twitter).
+
+Copyright (c) 2012 Leif Ringstad

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+require 'rubygems/package_task'
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'switch_access/rails/version'
+
+gemspec = eval(File.read('switch_access-rails.gemspec'))
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.gem_spec = gemspec
+end
+
+desc 'build the gem and release it to rubygems.org'
+task :release => :gem do
+  sh "gem push pkg/switch_access-rails-#{SwitchAccess::Rails::VERSION}.gem"
+end

data/lib/switch_access-rails.rb

@@ -0,0 +1 @@
+require 'switch_access/rails'

data/lib/switch_access/rails.rb

@@ -0,0 +1,3 @@
+require 'switch_access/rails/version'
+require 'switch_access/rails/engine'
+require 'switch_access/rails/railtie'

data/lib/switch_access/rails/engine.rb

@@ -0,0 +1,6 @@
+module SwitchAccess
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/switch_access/rails/railtie.rb

@@ -0,0 +1,14 @@
+require 'switch_access/rails/view_helpers'
+
+module SwitchAccess
+  module Rails
+    class Railtie < ::Rails::Railtie
+      ActiveSupport.on_load(:action_view) do
+        include SwitchAccess::Rails::ViewHelpers
+      end
+      # initializer "switch_access.rails.view_helpers" do |app|
+      #   ActionView::Base.send :include, ViewHelpers
+      # end
+    end # class Railtie < Rails::Railtie
+  end # module Rails
+end # module SwitchAccess

data/lib/switch_access/rails/version.rb

@@ -0,0 +1,5 @@
+module SwitchAccess
+  module Rails
+    VERSION = '1.1.4'
+  end
+end

data/lib/switch_access/rails/view_helpers.rb

@@ -0,0 +1,109 @@
+module SwitchAccess
+  module Rails
+    module ViewHelpers
+
+      @@_sw_element_sci_class = nil
+
+      def sw_element_init(options = {})
+        sw_element_fini()
+        sw_element_sci(options)
+      end
+
+      def sw_element_sci(options = {})
+        @@_sw_element_sci_class = SwitchElements.new(options) if @@_sw_element_sci_class == nil
+        @@_sw_element_sci_class
+      end
+
+      #
+      # Reset counters
+      #      
+      def sw_element_reset_counters
+        sw_element_sci().reset_counters()
+      end
+
+      #
+      # Begin a switch element group
+      #
+      def sw_element_begin_group
+        sw_element_sci().begin_group()
+      end
+
+      def sw_element_fini
+        @@_sw_element_sci_class = nil
+      end
+
+      #
+      # End a switch element group
+      #
+      def sw_element_end_group
+        ret = sw_element_sci().end_group()
+        if (ret < 0)
+          sw_element_fini()
+        end
+        ret
+      end
+
+      #
+      # Get the next switch element class
+      #
+      def sw_element_next_class
+        sw_element_sci().next_element_class()
+      end
+
+      #
+      # Get javascript initializer for switch access
+      #
+      def sw_element_js_initializer(options = {})
+        str = 
+        <<-js
+        $(document).ready(function() {
+          if (typeof window._railsaccess == 'undefined') {
+            window._rails_sw_access = new SwitchAccess(#{options.to_json});
+          }
+        });
+        js
+        javascript_tag str.html_safe
+      end
+
+      class SwitchElements
+        def initialize(options = {})
+          @options = options
+          @options[:element_class_name] = "switch-element-" if !options.has_key?(:element_class_name)
+          reset_counters()
+        end
+
+        def reset_counters()
+          @parent_next_element_id = 0
+          @next_element_id        = 0
+          @level                  = 0
+        end
+        
+        def begin_group
+          @parent_next_element_id = @next_element_id + 1
+          @next_element_id = 1
+          @level += 1
+          "#{@options[:element_class_name]}#{@parent_next_element_id}"
+        end
+        
+        def end_group
+          @level -= 1
+          @next_element_id = @parent_next_element_id
+        end
+
+        #
+        # Get the next switch element class
+        #
+        def next_element_class
+          "#{@options[:element_class_name]}#{increase_next_id()}"
+        end
+        #
+        # Increase the switch element id and return it
+        #
+        def increase_next_id
+          @next_element_id += 1
+        end
+      end # class SwitchElements
+
+    end # module ViewHelpers
+  end # module Rails
+end # module SwitchAccess

data/vendor/assets/javascripts/switch_access.js

@@ -0,0 +1,3 @@
+//= require switch_access/execute_method
+//= require switch_access/jquery.csswatch
+//= require switch_access/switch_access

data/vendor/assets/javascripts/switch_access/execute_method.coffee

@@ -0,0 +1,107 @@
+###
+# Execute Method
+# (c) 2012 Leif Ringstad
+# Licensed under the freeBSD license (see LICENSE.txt for details)
+#
+# Source: http://github.com/leifcr/execute_method
+# v 1.0.0
+###
+
+ExecuteMethod =
+  getFunctionsAndProperties: (str) ->
+    # console.log"getFunctionsAndProperties"
+    arr = str.split(".")
+    i = 0
+    ret = []
+    while i < arr.length
+      ret.push ExecuteMethod.getFunctionAndParameters(arr[i])
+      i++
+    # console.log ret
+    ret
+
+  getFunctionAndParameters: (str) ->
+    # console.log "getFunctionAndParameters"
+    if ExecuteMethod.isFunction(str)
+      params = str.substring(str.indexOf("(")+1, str.indexOf(")"))
+      if params.length > 0
+        params = ExecuteMethod.splitAndTypeCastParameters(params)
+      else
+        params = []
+      func = str.substring(0, str.indexOf ("\(") )
+      isfunc = true
+    else 
+      func = str
+      params = null
+      isfunc = false
+
+    {func: func, params: params, isfunc: isfunc}
+
+  splitAndTypeCastParameters: (params) ->
+    # console.log"splitAndTypeCastParameters"
+    arr = params.split(",")
+    ret = []
+    i = 0
+    ret = []
+    while i < arr.length
+      ret.push ExecuteMethod.typecastParameter(arr[i])
+      i++
+    ret
+
+  isFunction: (str) ->
+    # console.log "isFunction"
+    if ExecuteMethod.regexIndexOf(str, /(\([\d|\D]+\))|(\(\))/, 0) != -1
+      return true
+    false
+
+  regexIndexOf: (string, regex, startpos) ->
+    # console.log "regexIndexOf"
+    indexOf = string.substring(startpos || 0).search(regex);
+    if (indexOf >= 0) then (indexOf + (startpos || 0)) else indexOf;
+
+  typecastParameter: (param) ->
+    param = param.trim()
+    param = param.replace(/^"/, "")
+    param = param.replace(/"$/m, "")
+    if param.search(/^\d+$/) == 0
+      # only numbers, parse to integer
+      return parseInt(param)
+    else if param.search(/^\d+\.\d+$/) == 0
+      return parseFloat(param)
+    else if param == "false" 
+      return false
+    else if param == "true"
+      return true
+
+    param # just return the param as a string otherwise
+
+  executeSingleFunction: (func, params, context, _that) ->
+    context[func].apply(_that, params)
+
+  getSingleProperty: (property, context) ->
+    context[property]
+
+  ###
+  # @param {String} Provide a string on what to execute (e.g. this.is.something(true).to_run() or myFunction().property or myFunction())
+  # @param {Object} Provide a object to run the string provided on
+  # @param {Object} Provide an object that points to the "this" pointer which 
+  ###
+  executeMethodByFunctionName: (str, context) ->
+    func_data = ExecuteMethod.getFunctionsAndProperties(str)
+    # since it's possible to chain functions and/or properties, and it's not possible to chain properly do a loop
+    i = 0
+    current_context = context
+    current_val = null
+    while i < func_data.length
+      if (func_data[i]["isfunc"] == true)
+        current_context = ExecuteMethod.executeSingleFunction(func_data[i]["func"], func_data[i]["params"], current_context, context)
+      else
+        current_context = ExecuteMethod.getSingleProperty(func_data[i]["func"], current_context)
+      i++
+    current_context
+
+if (!String.prototype.trim)
+  String.prototype.trim = ->
+    this.replace(/^\s+|\s+$/g,'');
+
+if (window.ExecuteMethod == "undefined" || window.ExecuteMethod == null || window.ExecuteMethod == undefined)
+  window.ExecuteMethod = ExecuteMethod

data/vendor/assets/javascripts/switch_access/jquery.csswatch.coffee

@@ -0,0 +1,264 @@
+###
+jQuery css-watch event Coffeescript v1.2 - 11/20/2012
+http://github.com/leifcr/jquery-csswatch/
+(c) 2012 Leif Ringstad
+
+@author Leif Ringstad
+@version 1.0
+
+Licensed under the freeBSD license
+###
+
+# Note that with this pattern, as per Alex Sexton's, the plugin logic
+# hasn't been nested in a jQuery plugin. Instead, we just use
+# jQuery for its instantiation.
+
+(($, window, document) ->
+
+  ###
+    Plugin constructor
+  ###
+  CssWatch = (elem, options) ->
+    @elem = elem
+    @$elem = $(elem)
+    @options = options
+    @cb_timer_id = null
+    @cached_function_name = ""
+    @stop_requested = false
+    return
+
+  ###
+    Plugin prototype
+  ###
+  CssWatch:: =
+    defaults:
+      event_name:        "css-change"
+      data_attr_name:    "css-watch-data"
+      use_event:         true
+      callback:          null
+      props:             ""
+      props_functions:   {}
+
+
+    ###
+      Initializer
+    ###
+    init: ->
+      @config = $.extend({}, @defaults, @options, @metadata)
+      @config.props = @splitAndTrimProps(@config.props)
+      if @config.props.length > 0
+        @setInitialData()
+        @start()
+
+      @
+    
+    ###
+      split and trim properties
+    ###
+    splitAndTrimProps: (props) ->
+      arr = props.split(",")
+      ret = []
+      i = 0
+      while i < arr.length
+        ret.push arr[i].trim()
+        i++
+      ret
+
+    ###
+      set initial data
+    ###
+    setInitialData: ->
+      i = 0
+      while i < @config.props.length
+        @setData @config.props[i], @getPropertyValue(@config.props[i])
+        i++
+      return
+
+    ###
+      set a data element for a css property on the current element
+    ###
+    setData: (property, value) ->
+      @$elem.data("#{@config.data_attr_name}-#{property}", value)
+
+    ###
+      update data attributes from changes
+    ###
+    updateDataFromChanges: (changes) ->
+      @setData property, changes[property] for property, value in Object.keys(changes)
+      return
+    
+    ###
+      get the datavalue stored for a property
+    ###
+    getDataValue: (property) ->
+      @$elem.data("#{@config.data_attr_name}-#{property}")
+
+    ###
+      get css property value (from jquery css or from custom function if needed)
+    ###
+    getPropertyValue: (property) ->
+      return @$elem.css(property) if (@cached_function_name == null) || (Object.keys(@config.props_functions).length == 0)
+
+      if @cached_function_name == ""
+        keys = Object.keys(@config.props_functions)
+        if property in keys
+          @cached_function_name = @config.props_functions[property]
+        else
+          @cached_function_name == null
+      
+      if (@cached_function_name != "") && (@cached_function_name != null)
+        if (window.ExecuteMethod)
+          return ExecuteMethod.executeMethodByFunctionName(@cached_function_name, @$elem)
+        else
+          console.log "You are missing the ExecuteMethod library."
+      else
+        return @$elem.css(property)
+
+    ###
+      get object of changes
+    ###
+    changedProperties: ->
+      i = 0
+      ret = {}
+      while i < @config.props.length
+        if (@getPropertyValue(@config.props[i]) != @getDataValue(@config.props[i]))
+          ret[@config.props[i]] = @getPropertyValue(@config.props[i])
+        i++
+      ret
+
+    ###
+      stop csswatch / checking of css attributes
+    ###
+    stop: ->
+      return if (typeof @config == "undefined" || @config == null)
+      stop_requested = true
+      # stop the timer/windowanimate cb for this object
+      window.cssWatchCancelAnimationFrame(@cb_timer_id)
+
+
+    ###
+      start csswatch / checking of css attributes
+    ###
+    start: ->
+      return if (typeof @config == "undefined" || @config == null)
+      @stop_requested = false
+      # start the timer/windowanimate cb for this object if it isn't running
+      @cb_timer_id = window.cssWatchRequestAnimationFrame(=> @check(); return)
+      return
+
+    ###
+      the actual checking of changes
+    ###
+    check: ->
+      return false if (typeof @config == "undefined" || @config == null)
+      return false if @stop_requested == true
+      changes = @changedProperties()
+
+      if (Object.keys(changes).length > 0)
+        if @config.use_event
+          @$elem.trigger(@config.event_name, changes)
+        
+        if @config.callback != null
+          @config.callback.apply(null, [changes])
+          # @config.callback.call({changes})
+        # set new data for each changed property
+        @updateDataFromChanges(changes)
+
+      @cb_timer_id = window.cssWatchRequestAnimationFrame(=> @check(); return)
+      false
+
+    ###
+     destroy plugin (stop/remove data)
+    ###
+    destroy: ->
+      @stop()
+      @$elem.removeData("css-watch-object")
+      @$elem.removeData(@config.data_attr_name)
+      return null
+
+  ###
+   Set defaults
+  ###
+  CssWatch.defaults = CssWatch::defaults
+
+  ###
+   Jquery extension for plugin
+   Plugin funcitonality is in the class above
+  ###
+  $.fn.csswatch = (options) ->
+    @each ->
+      if typeof options is "object" or not options
+        # check if there is an object existing, if so, delete it!
+        data = $(@).data("css-watch-object")
+        unless data
+          obj = new CssWatch(@, options)
+          $(@).data("css-watch-object", obj)
+          obj.init()
+        return
+      else if typeof options is "string"
+        obj = $(@).data("css-watch-object")
+        if obj && obj[options]
+          obj[options].apply this
+
+  return
+
+  #optional: window.Plugin = Plugin;
+
+) jQuery, window, document
+
+###
+#
+# Cross browser Object.keys implementation
+#
+# This is suggested implementation from Mozilla for supporting browser that do not implement Object.keys
+# if object doesn't have .keys function
+# if(!Object.keys) Object.keys = function(o){
+#    if (o !== Object(o))
+#       throw new TypeError('Object.keys called on non-object');
+#    var ret=[],p;
+#    for(p in o) if(Object.prototype.hasOwnProperty.call(o,p)) ret.push(p);
+#    return ret;
+# }
+###
+
+unless Object.keys
+  Object.keys = (o) ->
+    throw new TypeError("Object.keys called on non-object")  if o isnt Object(o)
+    ret = []
+    p = undefined
+    for p of o
+      ret.push p  if Object::hasOwnProperty.call(o, p)
+    ret
+
+###
+  Cross browser requestAnimationFrame
+  Not including settimeout as it will have a static value for timeout
+###
+
+unless window.cssWatchRequestAnimationFrame
+  window.cssWatchRequestAnimationFrame = (->
+    window.webkitAnimationFrame or
+    window.webkitRequestAnimationFrame or
+    window.mozRequestAnimationFrame or
+    window.oRequestAnimationFrame or
+    window.msRequestAnimationFrame or
+    window.requestAnimationFrame or
+    (callback, element) ->
+      window.setTimeout(callback, 1000/60)
+  )()
+
+###
+  Cross browser cancelAnimationFrame
+###
+unless window.cssWatchCancelAnimationFrame
+  window.cssWatchCancelAnimationFrame = (->
+    window.cancelAnimationFrame or
+    window.webkitCancelAnimationFrame or
+    window.webkitCancelRequestAnimationFrame or
+    window.mozCancelAnimationFrame or
+    window.mozCancelRequestAnimationFrame or
+    window.oCancelRequestAnimationFrame or
+    window.msCancelRequestAnimationFrame or
+    (timeout_id) -> # function FrameRequestCallback
+      window.clearTimeout timeout_id
+  )()