tinymce-rails-config-manager 0.0.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 ITHouse Latvia and Arturs Meisters
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# TinymceRailsConfigManager
+Simple tinyMCE configuration manager
+
+## Instructions
+
+1. Add **tinymce-rails-config-manager** 
+
+  ```ruby
+  gem 'tinymce-rails-config-manager'
+  ```
+
+2. Include asset in your JS manifest file
+
+  ` //= require tinymce-rails-config-manager `
+
+## Usage
+
+### How to change setting properties
+
+* To add new property (added only once)
+
+  This will add **template** to plugin option existing value
+
+  ```javascript
+  TinyMCEConfigManager.get().config.add("plugin", "template")
+  ```
+
+* To add new value after some other (added only once; buttons is shortcut to all theme_advanced_buttonsX)
+
+  This will add fullscreen button after bold
+
+  ```javascript
+  TinyMCEConfigManager.get().config.addAfter("buttons", "fullscreen", "bold")
+  ```
+
+* To add new value before some other (added only once)
+  
+  This will add fullscreen button before bold
+
+  ```javascript
+  TinyMCEConfigManager.get().config.addBefore("buttons", "fullscreen", "bold")
+  ```
+
+* To set property
+  
+  This will set value **right** for theme_advanced_toolbar_align
+
+  ```javascript
+  TinyMCEConfigManager.get().config.set("theme_advanced_toolbar_align", "right")
+  ```
+
+* To add callback (new callback function will be added with every call)
+
+  This will add callback for **setup**
+
+  ```javascript
+  TinyMCEConfigManager.get().config.addFunction("setup", function(editor){ /*do something here*/})
+  ```
+
+
+### How to change settings
+
+To add or change settings for specific textareas use 
+
+```javascript
+TinyMCEConfigManager.get().configFor("#my_special_textarea")
+```
+
+and then use all property modifiers as mentioned above. Default settings will be loaded for all other textareas.
+
+### How to load
+
+Simply call `load()`. Also it is possible to pass some specific configuration there, but that will overwrite existing and
+that is not recommended.
+
+```javascript
+TinyMCEConfigManager.get().load()
+```
+
+## Roadmap
+
+* Make it possible to change order of existing values
+* add tests
+
+This project rocks and uses MIT-LICENSE.
+

data/Rakefile

@@ -0,0 +1,68 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TinymceRailsConfigManager'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'jasmine'
+load 'jasmine/tasks/jasmine.rake'
+
+Bundler::GemHelper.install_tasks
+
+namespace :jasmine do
+  desc "Compile CoffeeScript files" 
+  task :compile do 
+    require 'coffee-script'
+    source_files = Dir["./app/assets/javascripts/**/*.coffee"]
+    source_specs = Dir["./spec/javascripts/**/*.coffee"]
+
+    dest_dir = "./spec/javascripts/generated"
+    spec_dest_dir = File.join(dest_dir, "spec")
+    js_dest_dir = File.join(dest_dir, "javascripts")
+
+    [spec_dest_dir, js_dest_dir].each do |dir|
+      unless File.directory?(dir)
+        Dir.mkdir(dir)
+      end
+    end
+
+    { spec_dest_dir => source_specs, js_dest_dir => source_files}.each do |dest_dir, files|
+      files.each do |file_path|
+        dest_path = File.join(dest_dir, File.basename(file_path, ".coffee"))
+        File.open(dest_path, "w") do |f|
+          f.write(CoffeeScript.compile(File.read(file_path)))
+        end
+      end
+    end
+  end
+
+  namespace :ci do
+    desc "Run Jasmine CI for CoffeeScripts"
+    task :coffee do
+      Rake::Task['jasmine:compile'].invoke
+      Rake::Task['jasmine:ci'].invoke
+    end
+  end
+
+  desc "Run Jasmine for CoffeeScripts"
+  task :coffee do 
+    Rake::Task['jasmine:compile'].invoke
+    Rake::Task['jasmine'].invoke
+  end
+end

data/app/assets/javascripts/tinymce-rails-config-manager/manager.js.coffee

@@ -0,0 +1,194 @@
+# TinyMCEConfigManager class makes it easier to manage configuration for TinyMCE.
+# There are only one instance of TinyMCEConfigManager and to access it call
+#     TinyMCEConfigManager.get()
+# To access default configuration call
+#     TinyMCEConfigManager.get().config.[someMethod]
+# To access configuration for specific selector call
+#     TinyMCEConfigManager.get().configFor("#myTextFieldID").[someMethod]
+# To load tinymce call
+#     TinyMCEConfigManager.load([optional settings here])
+# Those selector that are used with selector specific configurations are not used with default selector in when tinyMCE is initialized with default selector
+class TinyMCEConfigManager
+
+  TEXTAREA_SELECTOR = "textarea[data-simple!=true]"
+  DEFAULT_SETTINGS = {
+    theme: "advanced",
+    skin: "cirkuit",
+    mode: "textareas",
+    plugins: "table,fullscreen,lists,paste",
+    theme_advanced_buttons1 : "bold,italic,underline,|,bullist,numlist,|,justifyleft,justifycenter,justifyright,|,formatselect,|,image,removeformat,code,fullscreen",
+    theme_advanced_buttons2 : "tablecontrols,|,paste,pastetext,pasteword,|,anchor,link,unlink",
+    theme_advanced_buttons3 : "",
+    theme_advanced_toolbar_location: "top",
+    theme_advanced_toolbar_align: "left",
+  }
+    
+  @_instance: null
+
+  @get: ->
+    if not @_instance?
+      @_instance = new @
+      @_instance.init()
+    @_instance
+
+  init: ->
+    @defaultConfig = @_createNewConfiguration()
+    @defaultConfig.setAsDefault()
+    @config = @defaultConfig
+    @_configs = {}
+
+  #TODO any configuration added to specific selectors should go in queue and only when load is called
+  # then those commands should be applied to real settings. Then always any other selector will use latest
+  # default config settings, and in right order will apply their settings to it
+  configFor: (selector) ->
+    unless @_configs[selector]
+      @_configs[selector] = @_createNewConfiguration(@config.settings)
+    @_configs[selector]
+
+  load: (extendedSettings) ->
+    for selector, config of @_configs
+      @_initializeTinyMCEFor(selector, config, extendedSettings)
+    @_initializeDefaultTinyMCE(extendedSettings)
+
+  defaultSettings: ->
+    DEFAULT_SETTINGS
+
+  textareaSelector: ->
+    TEXTAREA_SELECTOR
+
+  _createNewConfiguration: (givenSettings) ->
+    new TinyMCEConfigManagerConfiguration(@_settings(givenSettings))
+
+  _settings: (givenSettings) ->
+    newSettings = $.extend(true, {}, @defaultSettings())
+    if givenSettings
+      $.extend(true, newSettings, givenSettings)
+    newSettings
+
+  _initializeTinyMCEFor: (selector, config, extendedSettings) ->
+    newSettings = $.extend(true, $.extend(true, {}, config.settings), extendedSettings)
+    $(selector).tinymce(newSettings)
+
+  _initializeDefaultTinyMCE: (extendedSettings) ->
+    newSettings = $.extend(true, $.extend(true, {}, @config.settings), extendedSettings)
+    $selector = $(@textareaSelector())
+    for selector, config of @_configs
+      $selector = $selector.not(selector)
+    $selector.tinymce(newSettings)
+
+  # TinyMCEConfigManagerConfiguration allow to change values of tinyMCE configuration.
+  @TinyMCEConfigManagerConfiguration = class TinyMCEConfigManagerConfiguration
+
+    constructor: (settings) ->
+      @settings = settings
+      @callbacks = {}
+      @default = false
+
+    add: (keyName, newValue) ->
+      listManager = new TinyMCEListSettingManager(this)
+      listManager.add(keyName, newValue)
+    
+    addAfter: (keyName, newValue, oldValue) ->
+      listManager = new TinyMCEListSettingManager(this)
+      listManager.addAfter(keyName, newValue, oldValue)
+
+    addBefore: (keyName, newValue, oldValue) ->
+      listManager = new TinyMCEListSettingManager(this)
+      listManager.addBefore(keyName, newValue, oldValue)
+    
+    set: (keyName, newValue) ->
+      valueManager = new TinyMCEValueSettingManager(this)
+      valueManager.set(keyName, newValue)
+
+    addFunction: (keyName, newFunction) ->
+      functionManager = new TinyMCEFunctionSettingManager(this)
+      functionManager.add(keyName, newFunction)
+
+    callCallbacksOn: (callbackName, args) ->
+      for callback in @callbacks[callbackName]
+        callback.apply(window, args)
+
+    setValue: (keyName, newValue) ->
+      @settings[keyName] = newValue
+
+    setAsDefault: ->
+      @default = true
+
+
+  class TinyMCESettingManager
+    constructor: (config) ->
+      @config = config
+
+    _getValue: (keyName) ->
+      @config.settings[keyName]
+
+    _setValue: (keyName, newValue) ->
+      @config.setValue(keyName, newValue)
+
+  # Manage options that consist of string values that are seperated with commas
+  class TinyMCEListSettingManager extends TinyMCESettingManager
+    COMPLEX_OPTIONS = {
+      buttons: ['theme_advanced_buttons1', 'theme_advanced_buttons2', 'theme_advanced_buttons3']
+    }
+    
+    add:(keyName, newValue) ->
+      for listKeyName, list of @_valuesList(keyName)
+        if list
+          if list.length > 0
+            newList = list + "," + newValue
+          else
+            newList = newValue
+          @_setValue(listKeyName, newList)
+
+    addAfter: (keyName, newValue, oldValue) ->
+      for listKeyName, list of @_valuesList(keyName)
+        if list && @_valueExist(list, oldValue) and not @_valueExist(list, newValue)
+          newList = list.replace(@_valueRegExp(oldValue),  oldValue + "," + newValue)
+          @_setValue(listKeyName, newList)
+
+    addBefore: (keyName, newValue, oldValue) ->
+      for listKeyName, list of @_valuesList(keyName)
+        if list && @_valueExist(list, oldValue) and not @_valueExist(list, newValue)
+          newList = list.replace(@_valueRegExp(oldValue),  newValue + "," + oldValue)
+          @_setValue(listKeyName, newList)
+
+    _valueRegExp: (value)->
+      new RegExp("\\b" + value + "\\b")
+
+    _valueExist: (list, value) ->
+      list.match(@_valueRegExp(value))
+
+    _valuesList: (keyName) ->
+      complexKeys = COMPLEX_OPTIONS[keyName]
+      result = {}
+      if complexKeys
+        for key in complexKeys
+          result[key] = @_getValue(key)
+      else
+        result[keyName] = @_getValue(keyName)
+      result
+
+
+  class TinyMCEValueSettingManager extends TinyMCESettingManager
+
+    set: (keyName, newValue) ->
+      @_setValue(keyName, newValue)
+
+  class TinyMCEFunctionSettingManager extends TinyMCESettingManager
+
+    add: (keyName, newFunction) ->
+      @_addCallback(keyName, newFunction)
+      config = @config
+      @_setValue(keyName, (@arguments)->
+        config.callCallbacksOn(keyName, arguments)
+      )
+
+    _addCallback: (keyName, newFunction) ->
+      unless @config.callbacks[keyName]
+        @config.callbacks[keyName] = [newFunction]
+      else
+        @config.callbacks[keyName].push(newFunction)
+
+
+window.TinyMCEConfigManager = TinyMCEConfigManager
+

data/app/assets/javascripts/tinymce-rails-config-manager.js

@@ -0,0 +1 @@
+//= require_directory ./tinymce-rails-config-manager

data/lib/tasks/jasmine.rake

@@ -0,0 +1,8 @@
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/lib/tasks/tinymce-rails-config-manager_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tinymce-rails-config-manager do
+#   # Task goes here
+# end

data/lib/tinymce-rails-config-manager/engine.rb

@@ -0,0 +1,5 @@
+module TinymceRailsConfigManager
+  class Engine < Rails::Engine
+
+  end
+end

data/lib/tinymce-rails-config-manager/version.rb

@@ -0,0 +1,3 @@
+module TinymceRailsConfigManager
+  VERSION = "0.0.6"
+end

data/lib/tinymce-rails-config-manager.rb

@@ -0,0 +1,7 @@
+module TinymceRailsConfigManager
+  def self.load!
+    require 'tinymce-rails-config-manager/engine'
+  end
+end
+
+TinymceRailsConfigManager.load!

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: tinymce-rails-config-manager
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- ITHouse (Latvia) and Arturs Meisters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+description: Simple tinyMCE configuration manager that makes it easier to manage different
+  configurations without changing templates
+email:
+- support@ithouse.lv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/tinymce-rails-config-manager/manager.js.coffee
+- app/assets/javascripts/tinymce-rails-config-manager.js
+- lib/tinymce-rails-config-manager/version.rb
+- lib/tinymce-rails-config-manager/engine.rb
+- lib/tinymce-rails-config-manager.rb
+- lib/tasks/tinymce-rails-config-manager_tasks.rake
+- lib/tasks/jasmine.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/ithouse/tinymce-rails-config-manager
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2286425305098803774
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2286425305098803774
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple tinyMCE configuration manager.
+test_files: []