ckeditor_rails_6 4.10.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9085f652439bf186b037ab03ac16e4252328e2913bf6878daaa62834d79a8210
+  data.tar.gz: 7f39aa452b8261494c7da212ac8f31c3e89da6b0ca05c6fd8beae8fadd436419
+SHA512:
+  metadata.gz: 66c50623e3757dccff39056d398bec940c10d1371b5c93b401d93fedb4155913eb2a773c452a3128fc63b475f1e82335a0325132634f728769f2efda542360ac
+  data.tar.gz: e1d1276fc458964201db6b210ba52de59313744bfa8b3bf9777980769e0862f0935a376a9fa23b724f6a525b02a9f2610ea8d5710a2a36ee7f202872f176660b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CONTRIBUTORS

@@ -0,0 +1,7 @@
+Contributors
+============
+
+list by commit order.
+
+* Rafe Rosen
+* Eric Anderson

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011-2013 by Tse-Ching Ho
+
+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,159 @@
+# CKEditor for rails asset pipeline
+
+[CKEditor](http://ckeditor.com/) is a library for WYSIWYG editor to be used inside web pages.
+
+The `ckeditor_rails` gem integrates the `CKEditor` with the Rails asset pipeline.
+
+And it would work with following environments:
+
+* ruby 1.9.3+
+* rails 3.0+
+
+## Basic Usage
+
+### Install ckeditor_rails gem
+
+Include `ckeditor_rails` in Gemefile
+
+```ruby
+gem 'ckeditor_rails_6'
+```
+
+Then run `bundle install`
+
+### Include CKEditor javascript assets
+
+Add to your `app/assets/javascripts/application.js` after `//= require jquery_ujs` to work with jQuery
+
+``` javascript
+//= require ckeditor-jquery
+```
+
+### Modify form field for CKEditor
+
+Add `ckeditor` class to text area tag
+
+``` ruby
+<%= f.text_area :content, :class => 'ckeditor' %>
+```
+
+### Initialize CKEditor in Javascript file
+
+``` javascript
+$('.ckeditor').ckeditor({
+  // optional config
+});
+```
+
+### Deployment
+
+Since version 4.1.3, non-digested assets of `ckeditor-rails` will simply be copied after digested assets were compiled.
+
+Eric Anderson, thanks.
+
+## Advanced Usage
+
+### Include customized configuration javascript for CKEditor
+
+Add your `app/assets/javascripts/ckeditor/config.js.coffee` like
+
+``` coffee
+CKEDITOR.editorConfig = (config) ->
+  config.language = "zh"
+  config.uiColor = "#AADC6E"
+  true
+```
+
+### Include customized CKEDITOR_BASEPATH setting
+
+Add your `app/assets/javascripts/ckeditor/basepath.js.erb` like
+
+``` ruby
+<%
+  base_path = ''
+  if ENV['PROJECT'] =~ /editor/i
+    base_path << "/#{Rails.root.basename.to_s}/"
+  end
+  base_path << Rails.application.config.assets.prefix
+  base_path << '/ckeditor/'
+%>
+var CKEDITOR_BASEPATH = '<%= base_path %>';
+```
+
+### Include customized stylesheet for contents of CKEditor
+
+Add your `app/assets/stylesheets/ckeditor/contents.css.scss` like
+
+``` scss
+body {
+  font-size: 14px;
+  color: gray;
+  background-color: yellow;
+}
+ol,ul,dl {
+  *margin-right:0px;
+  padding:4 20px;
+}
+```
+
+### Configure plugins, languages, and skins of CKEditor assets
+
+Add `ckeditor_rails.rb` to `config/initializers/`
+
+``` ruby
+Ckeditor::Rails.configure do |config|
+  # default is nil for all languages, or set as %w[en zh]
+  config.assets_languages = nil
+
+  # default is nil for all plugins,
+  # or set as white list: %w[image link liststyle table tabletools]
+  # or set as black list: config.default_plugins - %w[about a11yhelp]
+  config.assets_plugins = nil
+
+  # default is nil for all skins, or set as %w[moono-lisa]
+  config.assets_skins = nil
+end
+```
+
+## Gem maintenance
+
+Maintain `ckeditor_rails` gem with `Rake` commands.
+
+Update origin CKEditor source files.
+
+    rake update_ckeditor VERSION=4.11.1
+
+Publish gem.
+
+    rake release
+
+## Troubleshooting
+
+#### CKEditor only loading after page refresh
+
+This is due to interference with Turbolinks -
+
+The problem stems from the link itself so in order to resolve this issue you must disable turbolinks in the div containing the link pointing to where CKEditor is.
+
+You can visit the Rails Turbolinks Repo for detailed documentation
+https://github.com/rails/turbolinks/#opting-out-of-turbolinks
+
+**Example**
+
+    <div class="example" data-no-turbolink>
+    ...
+    </div>
+
+#### Asset Compilation Process Does Not Produce JS and/or CSS Files
+
+If you observe an issue (especially in Heroku environment) where asset compilation process skips JS and or CSS files, try adding the following line to `app/environments/production.rb` (or config file for the environment where you observe the issue):
+
+``` ruby
+config.assets.precompile += ['ckeditor/*']
+```
+
+## License
+
+CKEditor use [CKEditor license](http://ckeditor.com/license).
+
+Other parts of gem use MIT license.

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require File.expand_path('../lib/ckeditor-rails/source_file', __FILE__)
+
+desc 'Update CKEditor Library, VERSION is required.'
+task 'update_ckeditor' do
+  files = SourceFile.new
+  files.fetch ENV['VERSION']
+  files.destination_root = 'vendor/assets'
+  files.move
+  files.fix_css
+  files.cleanup
+end

data/ckeditor-rails-6.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ckeditor-rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Donnadieu']
+  gem.email         = ['donnadieu.69@gmail.com']
+  gem.description   = %q{CKEditor is a javascript library of the WYSIWYG rich-text editor. This gem integrates CKEditor with Rails asset pipeline for easy of use.}
+  gem.summary       = %q{Integrate CKEditor javascript library with Rails asset pipeline}
+  gem.homepage      = 'https://github.com/Donnadieu/ckeditor-rails-6'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'ckeditor_rails_6'
+  gem.require_paths = ['lib']
+  gem.version       = Ckeditor::Rails::VERSION
+
+  gem.add_dependency 'railties', '>= 3.0'
+
+  gem.add_development_dependency 'bundler', '>= 1.0'
+  gem.add_development_dependency 'rails', '>= 3.0'
+  gem.add_development_dependency 'thor', '>= 0.14'
+end

data/lib/assets/javascripts/ckeditor-jquery.js

@@ -0,0 +1,3 @@
+//= require ckeditor/basepath
+//= require ckeditor/ckeditor
+//= require ckeditor/jquery

data/lib/assets/javascripts/ckeditor/basepath.js.erb

@@ -0,0 +1,6 @@
+<%
+  base_path = File.join(Rails.application.config.assets.prefix, 'ckeditor/')
+  base_path = File.join(Rails.application.config.action_controller.relative_url_root, base_path) if Rails.application.config.action_controller.relative_url_root
+%>
+
+var CKEDITOR_BASEPATH = "<%= base_path %>";

data/lib/assets/javascripts/ckeditor/jquery.js

@@ -0,0 +1,10 @@
+/*
+ Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
+ For licensing, see LICENSE.md or http://ckeditor.com/license
+*/
+(function(a){if("undefined"==typeof a)throw Error("jQuery should be loaded before CKEditor jQuery adapter.");if("undefined"==typeof CKEDITOR)throw Error("CKEditor should be loaded before CKEditor jQuery adapter.");CKEDITOR.config.jqueryOverrideVal="undefined"==typeof CKEDITOR.config.jqueryOverrideVal?!0:CKEDITOR.config.jqueryOverrideVal;a.extend(a.fn,{ckeditorGet:function(){var a=this.eq(0).data("ckeditorInstance");if(!a)throw"CKEditor is not initialized yet, use ckeditor() with a callback.";return a},
+ckeditor:function(g,d){if(!CKEDITOR.env.isCompatible)throw Error("The environment is incompatible.");if(!a.isFunction(g)){var m=d;d=g;g=m}var k=[];d=d||{};this.each(function(){var b=a(this),c=b.data("ckeditorInstance"),f=b.data("_ckeditorInstanceLock"),h=this,l=new a.Deferred;k.push(l.promise());if(c&&!f)g&&g.apply(c,[this]),l.resolve();else if(f)c.once("instanceReady",function(){setTimeout(function(){c.element?(c.element.$==h&&g&&g.apply(c,[h]),l.resolve()):setTimeout(arguments.callee,100)},0)},
+null,null,9999);else{if(d.autoUpdateElement||"undefined"==typeof d.autoUpdateElement&&CKEDITOR.config.autoUpdateElement)d.autoUpdateElementJquery=!0;d.autoUpdateElement=!1;b.data("_ckeditorInstanceLock",!0);c=a(this).is("textarea")?CKEDITOR.replace(h,d):CKEDITOR.inline(h,d);b.data("ckeditorInstance",c);c.on("instanceReady",function(d){var e=d.editor;setTimeout(function(){if(e.element){d.removeListener();e.on("dataReady",function(){b.trigger("dataReady.ckeditor",[e])});e.on("setData",function(a){b.trigger("setData.ckeditor",
+[e,a.data])});e.on("getData",function(a){b.trigger("getData.ckeditor",[e,a.data])},999);e.on("destroy",function(){b.trigger("destroy.ckeditor",[e])});e.on("save",function(){a(h.form).submit();return!1},null,null,20);if(e.config.autoUpdateElementJquery&&b.is("textarea")&&a(h.form).length){var c=function(){b.ckeditor(function(){e.updateElement()})};a(h.form).submit(c);a(h.form).bind("form-pre-serialize",c);b.bind("destroy.ckeditor",function(){a(h.form).unbind("submit",c);a(h.form).unbind("form-pre-serialize",
+c)})}e.on("destroy",function(){b.removeData("ckeditorInstance")});b.removeData("_ckeditorInstanceLock");b.trigger("instanceReady.ckeditor",[e]);g&&g.apply(e,[h]);l.resolve()}else setTimeout(arguments.callee,100)},0)},null,null,9999)}});var f=new a.Deferred;this.promise=f.promise();a.when.apply(this,k).then(function(){f.resolve()});this.editor=this.eq(0).data("ckeditorInstance");return this}});CKEDITOR.config.jqueryOverrideVal&&(a.fn.val=CKEDITOR.tools.override(a.fn.val,function(g){return function(d){if(arguments.length){var m=
+this,k=[],f=this.each(function(){var b=a(this),c=b.data("ckeditorInstance");if(b.is("textarea")&&c){var f=new a.Deferred;c.setData(d,function(){f.resolve()});k.push(f.promise());return!0}return g.call(b,d)});if(k.length){var b=new a.Deferred;a.when.apply(this,k).done(function(){b.resolveWith(m)});return b.promise()}return f}var f=a(this).eq(0),c=f.data("ckeditorInstance");return f.is("textarea")&&c?c.getData():g.call(f)}}))})(window.jQuery);

data/lib/ckeditor-rails.rb

@@ -0,0 +1,68 @@
+require 'ckeditor-rails/version'
+
+module Ckeditor
+  module Rails
+
+    mattr_accessor :assets_languages
+    @@assets_languages = nil
+
+    mattr_accessor :assets_plugins
+    @@assets_plugins = nil
+
+    mattr_accessor :assets_skins
+    @@assets_skins = nil
+
+    class << self
+      def configure
+        yield self
+      end
+
+      def root_path
+        @root_path ||= Pathname.new(File.expand_path('..', __FILE__))
+      end
+
+      def default_plugins
+        %W[
+          a11yhelp
+          about
+          clipboard
+          colordialog
+          dialog
+          div
+          find
+          flash
+          forms
+          iframe
+          image
+          link
+          liststyle
+          pastefromword
+          preview
+          scayt
+          smiley
+          specialchar
+          table
+          tabletools
+          templates
+          wsc
+        ]
+      end
+
+      def default_skins
+        %w[moono]
+      end
+    end
+
+  end
+end
+
+require 'ckeditor-rails/asset'
+
+case ::Rails.version.to_s
+when /^[456]/
+  require 'ckeditor-rails/engine'
+when /^3\.[12]/
+  require 'ckeditor-rails/engine3'
+when /^3\.[0]/
+  require 'ckeditor-rails/railtie'
+end if defined? ::Rails

data/lib/ckeditor-rails/asset.rb

@@ -0,0 +1,89 @@
+module Ckeditor
+  module Rails
+    class Asset
+
+      attr_reader :name, :root
+
+      def initialize name = 'ckeditor', path = '../vendor/assets'
+        @name = name
+        @root = Ckeditor::Rails.root_path.join path
+      end
+
+      def image_files
+        path = root.join('images', name)
+        files = Dir.glob(path.join('plugins', '**', '*.{png,gif,jpg}')).reject { |file|
+          invalid_plugin_file?(file)
+        }
+        files += Dir.glob(path.join('skins', '**', '*.{png,gif,jpg}')).reject { |file|
+          invalid_skin_file?(file)
+        }
+        files
+      end
+
+      def javascript_files
+        path = root.join('javascripts', name)
+        files = Dir.glob(path.join('*.js'))
+        files += Dir.glob(path.join('lang', '*.js')).reject { |file|
+          invalid_lang_file?(file)
+        }
+        files += Dir.glob(path.join('plugins', '**', '*.{js,html}')).reject { |file|
+          invalid_plugin_file?(file) or invalid_lang_file?(file)
+        }
+        files
+      end
+
+      def stylesheet_files
+        path = root.join('stylesheets', name)
+        files = Dir.glob(path.join('*.css'))
+        files += Dir.glob(path.join('plugins', '**', '*.css')).reject { |file|
+          invalid_plugin_file?(file)
+        }
+        files += Dir.glob(path.join('skins', '**', '*.css')).reject { |file|
+          invalid_skin_file?(file)
+        }
+        files
+      end
+
+      def files
+        files = []
+        files += image_files
+        files += javascript_files
+        files += stylesheet_files
+        files
+      end
+
+      private
+
+      def languages
+        Ckeditor::Rails.assets_languages
+      end
+
+      def plugins
+        Ckeditor::Rails.assets_plugins
+      end
+
+      def skins
+        Ckeditor::Rails.assets_skins
+      end
+
+      def invalid_lang_file? file
+        return false if languages.nil?
+        return false unless file.include? '/lang/'
+        not languages.include? File.basename(file, '.*')
+      end
+
+      def invalid_plugin_file? file
+        return false if plugins.nil?
+        retrun false unless file.include? '/plugins/'
+        plugins.none? { |plugin| file.include? "/#{plugin}/" }
+      end
+
+      def invalid_skin_file? file
+        return false if skins.nil?
+        return false unless file.include? '/skins/'
+        skins.none? { |skin| file.include? "/#{skin}/" }
+      end
+
+    end
+  end
+end