effective_ckeditor 1.0.0

data/app/assets/javascripts/effective_ckeditor/config.js.coffee

@@ -0,0 +1,46 @@
+CKEDITOR.editorConfig = (config) ->
+  config.startupShowBorders = true
+
+  config.extraPlugins = 'effective_regions,effective_assets'
+  config.format_tags = 'p;h1;h2;h3;h4;h5;h6;pre;div'
+
+  config.templates = 'effective_regions'
+  config.templates_files = []
+  config.templates_replaceContent = false
+
+  config.filebrowserWindowHeight = 600
+  config.filebrowserWindowWidth = 800
+  config.filebrowserBrowseUrl = '/effective/assets?only=images'
+
+  CKEDITOR.dtd.$removeEmpty['i'] = false
+
+  config.toolbar_full = [
+    { name: 'save', items: ['Save', '-', 'NewPage'] },
+    { name: 'html', items: ['Sourcedialog', '-', 'ShowBlocks'] },
+    { name: 'editing', items: ['Undo', 'Redo'] },
+    { name: 'clipboard', items: ['Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord'] },
+    { name: 'basicstyles', items: ['Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', '-', 'RemoveFormat'] },
+    ['Exit']
+    '/',
+    { name: 'definedstyles', items: ['Format'] },
+    { name: 'links', items: ['Link', 'Unlink'] },
+    { name: 'insert', items: ['Image', 'tliyoutube', 'EffectiveAssets'] },
+    { name: 'lists', items: ['NumberedList', 'BulletedList', '-', 'Outdent', 'Indent'] },
+    { name: 'insert2', items: ['Table', 'HorizontalRule', 'Blockquote', 'PageBreak'] },
+    { name: 'snippets', items: ['Templates', 'InsertSnippet'] }
+  ]
+
+  config.toolbar_snippets = [
+    ['Save', '-', 'NewPage'],
+    ['Sourcedialog', '-', 'ShowBlocks'],
+    ['Undo', 'Redo'],
+    { name: 'snippets', items: ['InsertSnippet'] },
+    ['Exit']
+  ]
+
+  config.toolbar_simple = [
+    ['Save', '-', 'NewPage'],
+    ['Undo', 'Redo'],
+    ['Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord'],
+    ['Exit']
+  ]

data/app/assets/javascripts/effective_ckeditor/init.js.coffee

@@ -0,0 +1,90 @@
+CKEDITOR.disableAutoInline = true
+
+# Disable drag & dropping into regions (fixes issues with simple regions)
+$(document).on 'drop', '.effective-region', (event) -> event.preventDefault()
+
+# Don't propogate click events up
+$(document).on 'click', '.effective-region', (event) ->
+  event.stopPropagation()
+  event.preventDefault()
+
+$ -> init()
+
+init = ->
+  instance.destroy(true) for instance in CKEDITOR.instances
+
+  ckeditors = $('[data-effective-ckeditor]')
+
+  if ckeditors.length
+    $('body').prepend("<div id='effective-ckeditor-top'></div>").addClass('effective-ckeditor-editting')
+
+    $(window).on 'beforeunload', (event) -> promptToSaveIfDirty(event)
+    $(window).on 'unload', (event) -> $.cookie('effective_regions_editting', '', {path: '/', expires: -1})
+
+    ckeditors.each ->
+      editor_div = $(this)
+
+      if editor_div.is(':visible')
+        initEditor(this)
+      else
+        affixBootstrapMenu(editor_div)
+        editor_div.on 'click', -> try initEditor(this)
+
+initEditor = (editor_div) ->
+  region = $(editor_div).data('effective-ckeditor')
+
+  switch region
+    when 'full'
+      enterMode = CKEDITOR.ENTER_P
+      shiftEnterMode = CKEDITOR.ENTER_BR
+      startupOutlineBlocks = true
+      toolbar = 'full'
+    when 'snippets'
+      enterMode = CKEDITOR.ENTER_BR
+      shiftEnterMode = CKEDITOR.ENTER_BR
+      startupOutlineBlocks = false
+      toolbar = 'snippets'
+    when 'simple'
+      enterMode = CKEDITOR.ENTER_BR
+      shiftEnterMode = CKEDITOR.ENTER_BR
+      startupOutlineBlocks = false
+      toolbar = 'simple'
+
+  CKEDITOR.inline(editor_div.id,
+    toolbar: toolbar
+    allowedSnippets: $(editor_div).data('allowed-snippets')
+    effectiveRegionType: region
+    customConfig: '/assets/effective_ckeditor/config.js'
+    enterMode: enterMode
+    shiftEnterMode: shiftEnterMode
+    startupOutlineBlocks: startupOutlineBlocks
+    disableNativeTableHandles: true
+    sharedSpaces:
+      top: 'effective-ckeditor-top'
+  )
+
+promptToSaveIfDirty = (event) ->
+  dirty = false
+
+  for name, instance of CKEDITOR.instances
+    if instance.checkDirty()
+      dirty = true
+      break
+
+  if dirty
+    'You have unsaved changes'
+  else
+    event.stopPropagation()
+
+affixBootstrapMenu = (editor_div) ->
+  dropdown_menu = editor_div.closest('.dropdown-menu')
+
+  if dropdown_menu.length > 0
+    dropdown_menu.on 'click', (event) -> event.stopPropagation()
+
+    dropdown = editor_div.closest('.dropdown')
+    dropdown.on 'hide.bs.dropdown', (event) -> event.preventDefault()
+    dropdown.on 'click.bs.dropdown', (event) -> event.preventDefault()
+    dropdown.on 'click', (event) ->
+      $(this).removeClass('open') and event.stopPropagation() if $(this).hasClass('open')
+

data/app/assets/javascripts/vendor/jquery.cookie.js

@@ -0,0 +1,117 @@
+/*!
+ * jQuery Cookie Plugin v1.4.0
+ * https://github.com/carhartl/jquery-cookie
+ *
+ * Copyright 2013 Klaus Hartl
+ * Released under the MIT license
+ */
+(function (factory) {
+  if (typeof define === 'function' && define.amd) {
+    // AMD. Register as anonymous module.
+    define(['jquery'], factory);
+  } else {
+    // Browser globals.
+    factory(jQuery);
+  }
+}(function ($) {
+
+  var pluses = /\+/g;
+
+  function encode(s) {
+    return config.raw ? s : encodeURIComponent(s);
+  }
+
+  function decode(s) {
+    return config.raw ? s : decodeURIComponent(s);
+  }
+
+  function stringifyCookieValue(value) {
+    return encode(config.json ? JSON.stringify(value) : String(value));
+  }
+
+  function parseCookieValue(s) {
+    if (s.indexOf('"') === 0) {
+      // This is a quoted cookie as according to RFC2068, unescape...
+      s = s.slice(1, -1).replace(/\\"/g, '"').replace(/\\\\/g, '\\');
+    }
+
+    try {
+      // Replace server-side written pluses with spaces.
+      // If we can't decode the cookie, ignore it, it's unusable.
+      s = decodeURIComponent(s.replace(pluses, ' '));
+    } catch(e) {
+      return;
+    }
+
+    try {
+      // If we can't parse the cookie, ignore it, it's unusable.
+      return config.json ? JSON.parse(s) : s;
+    } catch(e) {}
+  }
+
+  function read(s, converter) {
+    var value = config.raw ? s : parseCookieValue(s);
+    return $.isFunction(converter) ? converter(value) : value;
+  }
+
+  var config = $.cookie = function (key, value, options) {
+
+    // Write
+    if (value !== undefined && !$.isFunction(value)) {
+      options = $.extend({}, config.defaults, options);
+
+      if (typeof options.expires === 'number') {
+        var days = options.expires, t = options.expires = new Date();
+        t.setDate(t.getDate() + days);
+      }
+
+      return (document.cookie = [
+        encode(key), '=', stringifyCookieValue(value),
+        options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
+        options.path    ? '; path=' + options.path : '',
+        options.domain  ? '; domain=' + options.domain : '',
+        options.secure  ? '; secure' : ''
+      ].join(''));
+    }
+
+    // Read
+
+    var result = key ? undefined : {};
+
+    // To prevent the for loop in the first place assign an empty array
+    // in case there are no cookies at all. Also prevents odd result when
+    // calling $.cookie().
+    var cookies = document.cookie ? document.cookie.split('; ') : [];
+
+    for (var i = 0, l = cookies.length; i < l; i++) {
+      var parts = cookies[i].split('=');
+      var name = decode(parts.shift());
+      var cookie = parts.join('=');
+
+      if (key && key === name) {
+        // If second argument (value) is a function it's a converter...
+        result = read(cookie, value);
+        break;
+      }
+
+      // Prevent storing a cookie that we couldn't decode.
+      if (!key && (cookie = read(cookie)) !== undefined) {
+        result[name] = cookie;
+      }
+    }
+
+    return result;
+  };
+
+  config.defaults = {};
+
+  $.removeCookie = function (key, options) {
+    if ($.cookie(key) !== undefined) {
+      // Must not alter options, thus extending a fresh object...
+      $.cookie(key, '', $.extend({}, options, { expires: -1 }));
+      return true;
+    }
+    return false;
+  };
+
+}));

data/app/assets/stylesheets/effective_ckeditor.css.scss

@@ -0,0 +1,2 @@
+@import 'effective_ckeditor/layout';
+@import 'effective_ckeditor/overrides';

data/app/assets/stylesheets/effective_ckeditor/layout.css.scss

@@ -0,0 +1,10 @@
+.effective-ckeditor-editting {
+  padding-top: 80px; // Whatever the height of our top bar will be
+}
+
+#effective-ckeditor-top { 
+  position: fixed; 
+  top: 0; 
+  width: 100%; 
+  z-index: 9000;
+}

data/app/assets/stylesheets/effective_ckeditor/overrides.css.scss

@@ -0,0 +1,40 @@
+// This is the 'Insert Snippet' dropdown
+span.cke_combo__insertsnippet > a > .cke_combo_text {
+  width: 88px;
+}
+
+// The 'Insert Snippet' dropped down panel
+.cke_combopanel.cke_combopanel__insertsnippet {
+  width: 250px;
+}
+
+// The 'Styles' dropped down panel
+.cke_combopanel.cke_combopanel__styles {
+  width: 250px;
+}
+
+// The 'Styles' dropped down panel
+.cke_combopanel.cke_combopanel__format {
+  width: 180px;
+}
+
+span.cke_button__exit_label {
+  display: inline;
+}
+
+.effective-region {
+  outline: none;
+  display: inherit;
+  border: 1px dotted #4195fc;
+  min-height: 10px;
+  min-width: 10px;
+
+  &:focus {
+    outline: none;
+    border: 1px solid #4195fc;
+
+    -webkit-box-shadow: 0px 0px 6px #4195fc;
+       -moz-box-shadow: 0px 0px 6px #4195fc;
+            box-shadow: 0px 0px 6px #4195fc;
+  }
+}

data/lib/effective_ckeditor.rb

@@ -0,0 +1,10 @@
+require "effective_ckeditor/engine"
+require "effective_ckeditor/version"
+
+module EffectiveCkeditor
+
+  def self.setup
+    yield self
+  end
+
+end

data/lib/effective_ckeditor/engine.rb

@@ -0,0 +1,21 @@
+module EffectiveCkeditor
+  class Engine < ::Rails::Engine
+    engine_name 'effective_ckeditor'
+    isolate_namespace EffectiveCkeditor
+
+    # Append some precompiled assets we need access to
+    # This works in conjunction with the effective_ckeditor rake task that enhances assets:precompile
+    initializer "effective_ckeditor.append_precompiled_assets" do |app|
+      precompile = [
+        'effective_ckeditor.js',
+        'effective_ckeditor.css',
+        'effective_ckeditor/config.js',
+        'ckeditor/*',
+        'effective/snippets/*'
+      ]
+
+      Rails.application.config.assets.precompile += precompile
+    end
+
+  end
+end

data/lib/effective_ckeditor/version.rb

@@ -0,0 +1,3 @@
+module EffectiveCkeditor
+  VERSION = '1.0.0'.freeze
+end

data/lib/generators/effective_ckeditor/install_generator.rb

@@ -0,0 +1,15 @@
+module EffectiveCkeditor
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Creates an EffectiveCKeditor initializer in your application."
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Thanks for using EffectiveCkeditor

data/lib/tasks/effective_ckeditor_tasks.rake

@@ -0,0 +1,19 @@
+# This was modified from https://github.com/galetahub/ckeditor
+
+namespace :ckeditor do
+  desc 'Create nondigest versions of some ckeditor assets (e.g. moono skin png)'
+  task :create_nondigest_assets do
+    fingerprint = /\-[0-9a-f]{32}\./
+    for file in Dir['public/assets/ckeditor/**/*.*', 'public/assets/effective_ckeditor/**/*.*', 'public/assets/effective/**/*.*']
+      next unless file =~ fingerprint
+      nondigest = file.sub fingerprint, '.' # contents-0d8ffa186a00f5063461bc0ba0d96087.css => contents.css
+      FileUtils.cp file, nondigest, verbose: true
+    end
+  end
+end
+
+# auto run ckeditor:create_nondigest_assets after assets:precompile
+Rake::Task['assets:precompile'].enhance do
+  puts 'undigesting required effective_ckeditor assets'
+  Rake::Task['ckeditor:create_nondigest_assets'].invoke
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.