bootsy_full_html 2.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d54008bf7ba2ab2c7a7e1cd76cdcaaea4ec0a1b5
+  data.tar.gz: 8e1c822f62dba69e01c989a44f1eb8c2aec0a8b9
+SHA512:
+  metadata.gz: d0919221ed31dc38b2464e16c8568d08a36ed4ad380d83b4b58688c257f2afca280164607b4f88dcbf5ba14b2db2cf92cbb32f6626ee50abe8d190c011f6b972
+  data.tar.gz: 89fc44025f80e59ba20e5413aaf3aacf1218ddffc264f2a745a93b14276db8551fb4227cc540fc1b307229e95ceac08a7c244340f01404909270a12a202a660d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012-2015 Volmer Soares
+
+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 @@
+# Bootsy
+
+[![Gem Version](https://badge.fury.io/rb/bootsy.png)](http://badge.fury.io/rb/bootsy)
+[![Build Status](https://secure.travis-ci.org/volmer/bootsy.png?branch=master)](http://travis-ci.org/volmer/bootsy)
+[![Dependency Status](https://gemnasium.com/volmer/bootsy.png)](https://gemnasium.com/volmer/bootsy)
+[![Code Climate](https://codeclimate.com/github/volmer/bootsy.png)](https://codeclimate.com/github/volmer/bootsy)
+[![Coverage Status](https://coveralls.io/repos/volmer/bootsy/badge.png?branch=master)](https://coveralls.io/r/volmer/bootsy)
+
+*Bootsy* is a WYSIWYG editor for Rails based on
+[Bootstrap-wysihtml5](https://github.com/jhollingworth/bootstrap-wysihtml5) with image uploads using
+[CarrierWave](https://github.com/carrierwaveuploader/carrierwave).
+
+### Live demo
+
+* [bootsy-demo.herokuapp.com](http://bootsy-demo.herokuapp.com/)
+[![image](https://f.cloud.github.com/assets/301187/1365250/e1b7ba80-3854-11e3-9bfe-8bd1e090aca8.png)](http://bootsy-demo.herokuapp.com/)
+
+
+## Requirements
+
+* ImageMagick or GraphicsMagick (for MiniMagick);
+* Rails `4`;
+* [Bootstrap `3`](http://getbootstrap.com/) fully installed in your app.
+
+
+## Installation
+
+1. Add Bootsy to your Gemfile:
+  ```ruby
+  gem 'bootsy'
+  ```
+
+2. Run the bundle command to install it:
+  ```console
+  bundle install
+  ```
+
+3. Run the install generator:
+  ```console
+  bundle exec rails generate bootsy:install
+  ```
+  It will include the javascripts and stylesheets in the assets pipeline,
+  create the `bootsy.rb` initializer and add a copy of the english translations.
+
+  **Note:** If your project uses SASS or LESS and `application.css` does not exist,
+  you will be required to require bootsy manually using `*= require bootsy` or if you prefer
+  to import assets yourself `@import "bootsy";`
+
+4. Add and run migrations:
+  ```console
+  bundle exec rake bootsy:install:migrations
+  bundle exec rake db:migrate
+  ```
+
+
+## Usage
+
+Just call `bootsy_area` in your `FormBuilder` instances, the
+same way you'd call `textarea`. Example:
+```erb
+<%= form_for(@post) do |f| %>
+  <%= f.label :title %>
+  <%= f.text_field :title %>
+
+  <%= f.label :content %>
+  <%= f.bootsy_area :content %>
+
+  <%= f.submit %>
+<% end %>
+```
+
+Bootsy will group the uploaded images as galleries and associate them to one of
+your models. For instance, if you have a `Post` model and you want to use `bootsy_area`
+with it, you must include the `Bootsy::Container` module:
+```ruby
+class Post < ActiveRecord::Base
+  include Bootsy::Container
+end
+```
+
+Don't forget to ensure the association between your model objects with Bootsy
+image galleries. For `strong_parameters`, you must whitelist the `bootsy_image_gallery_id` parameter
+in your controller:
+```ruby
+private
+
+def post_params
+  params.require(:post).permit(:title, :content, :bootsy_image_gallery_id)
+end
+```
+
+
+## Bootsy with [Simple Form](https://github.com/plataformatec/simple_form) builders
+
+You can use `bootsy` as an input type in `SimpleForm::FormBuilder` instances. Example:
+```erb
+<%= simple_form_for @post do |f| %>
+  <%= f.input :title %>
+
+  <%= f.input :content, as: :bootsy %>
+
+  <%= f.button :submit %>
+<% end %>
+```
+
+
+## Editor options
+
+You can customize Bootsy through a hash of `editor_options`:
+
+
+### Enable/disable features
+
+You can enable and disable features as you like. For instance, if you don't want link and color features:
+```erb
+<%= f.bootsy_area :my_attribute, editor_options: { link: false, color: false } %>
+```
+Available options are: `:blockquote`, `:font_styles`, `:emphasis`, `:lists`, `:html`, `:link`, `:image` and `:color`.
+
+
+### Alert of unsaved changes
+
+By default Bootsy alerts the user about unsaved changes if the page is closed or reloaded. You can disable
+this feature with:
+```erb
+<%= f.bootsy_area :my_attribute, editor_options: { alert_unsaved: false } %>
+```
+
+## Uploads
+
+If you don't want to have image uploads, just call `bootsy_area` in a form builder not
+associated to a `Bootsy::Container` model. This way users will still be able to insert
+images in the text area using an external image URL.
+
+
+## Configuration
+
+You can set the default editor options, image sizes available (small, medium,
+large and/or its original), dimensions and more. Take a look at Bootsy's initalizer
+file `/config/initializers/bootsy.rb` in your app and feel free to uncomment and change
+the options as you like.
+
+
+## I18n
+
+Bootsy defines some I18n keys. English translations are added by default to your
+`config/locales` directory as `bootsy.en.yml`. You can use it as a template
+to translate Bootsy to your language.
+[Here are some examples](https://github.com/volmer/bootsy/tree/master/config/locales).
+
+You also need to translate Bootsy on the JavaScript side. Just follow
+[this example](https://github.com/volmer/bootsy/blob/master/app/assets/javascripts/bootsy/locales/en.js).
+Bootsy will try to guess the locale based on the `lang` attribute of the page's `<html>` tag.
+You can set the locale directly by setting a `data-bootsy-locale` attribute on your `<textarea>`.
+
+
+## License
+
+MIT License. Copyright 2012-2015 Volmer Soares

data/Rakefile

@@ -0,0 +1,35 @@
+#!/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    = 'Bootsy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['app/**/*.rb', 'lib/**/*.rb']
+end
+Coveralls::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec, 'coveralls:push']

data/app/assets/javascripts/bootsy.js

@@ -0,0 +1,11 @@
+//= require jquery.remotipart
+//= require bootsy/vendor/polyfill
+//= require bootsy/vendor/wysihtml5
+//= require bootsy/vendor/bootstrap-wysihtml5
+//= require bootsy/vendor/bootstrap.file-input
+//= require bootsy/area
+//= require bootsy/editor_options
+//= require bootsy/image_template
+//= require bootsy/init
+//= require bootsy/locales/en
+//= require bootsy/modal

data/app/assets/javascripts/bootsy/area.js

@@ -0,0 +1,89 @@
+/* global Bootsy */
+
+window.Bootsy = window.Bootsy || {};
+
+Bootsy.Area = function($el) {
+  var self = this;
+
+  this.$el = $el;
+  this.unsavedChanges = false;
+  this.locale = $el.data('bootsy-locale') || $('html').attr('lang');
+  if (!$.fn.wysihtml5.locale.hasOwnProperty(this.locale)) this.locale = 'en';
+
+  this.options = {
+    locale: this.locale,
+    alertUnsavedChanges: $el.data('bootsy-alert-unsaved'),
+    uploader: $el.data('bootsy-uploader'),
+    color: $el.data('bootsy-color'),
+    emphasis: $el.data('bootsy-emphasis'),
+    'font-styles': $el.data('bootsy-font-styles'),
+    html: $el.data('bootsy-html'),
+    image: $el.data('bootsy-image'),
+    link: $el.data('bootsy-link'),
+    lists: $el.data('bootsy-lists'),
+    events: {
+      change: function() {
+        self.unsavedChanges = true;
+      }
+    }
+  };
+};
+
+// Alert for unsaved changes
+Bootsy.Area.prototype.unsavedChangesAlert = function () {
+  if (this.unsavedChanges) {
+    return $.fn.wysihtml5.locale[this.locale].bootsy.alertUnsaved;
+  }
+};
+
+// Clear everything
+Bootsy.Area.prototype.clear = function () {
+  this.editor.clear();
+  this.setImageGalleryId('');
+  this.modal.$el.data('gallery-loaded', false);
+};
+
+Bootsy.Area.prototype.setImageGalleryId = function(id) {
+  this.$el.data('gallery-id', id);
+  this.$el.siblings('.bootsy_image_gallery_id').val(id);
+};
+
+// Init components
+Bootsy.Area.prototype.init = function() {
+  if (!this.$el.data('bootsy-initialized')) {
+    if ((this.options.image === true) && (this.options.uploader === true)) {
+      this.modal = new Bootsy.Modal(this);
+      this.options.image = false;
+      this.options.customCommand = true;
+      this.options.customCommandCallback = this.modal.show.bind(this.modal);
+      this.options.customTemplates = { customCommand: Bootsy.imageTemplate };
+    }
+
+    this.editor = this.$el.wysihtml5($.extend(true, {}, Bootsy.options, this.options)).data('wysihtml5').editor;
+
+    // Mechanism for unsaved changes alert
+    if (this.options.alertUnsavedChanges !== false) {
+      window.onbeforeunload = this.unsavedChangesAlert.bind(this);
+    }
+
+    this.$el.closest('form').submit(function() {
+      this.unsavedChanges = false;
+
+      return true;
+    }.bind(this));
+
+    this.$el.data('bootsy-initialized', true);
+  }
+};
+
+// Insert image in the text
+Bootsy.Area.prototype.insertImage = function(image) {
+  this.editor.currentView.element.focus();
+
+  if (this.caretBookmark) {
+    this.editor.composer.selection.setBookmark(this.caretBookmark);
+    this.caretBookmark = null;
+  }
+
+  this.editor.composer.commands.exec('insertImage', image);
+};

data/app/assets/javascripts/bootsy/editor_options.js

@@ -0,0 +1,47 @@
+window.Bootsy = window.Bootsy || {};
+
+var pageStylesheets = [];
+$('link[rel="stylesheet"]').each(function () {
+  pageStylesheets.push($(this).attr('href'));
+});
+
+window.Bootsy.options = {};
+
+$.extend(true, window.Bootsy.options, $.fn.wysihtml5.defaultOptions, {
+  parserRules: {
+    classes: {
+      "wysiwyg-float-left": 1,
+      "wysiwyg-float-right": 1,
+      "wysiwyg-float-inline": 1
+    },
+    tags: {
+      "cite": {
+        "check_attributes": {
+          "title": "alt"
+        }
+      },
+      "img": {
+        "check_attributes": {
+          "src": "src"
+        },
+        "add_class": {
+          "align": "align_img"
+        }
+      },
+      // this allows youtube embed codes
+      "iframe": {
+        set_attributes: {
+          "frameborder": "0",
+          "allowfullscreen": "1"
+        },
+        check_attributes: {
+          "width": "numbers",
+          "height": "numbers",
+          "src": "href"
+        }
+      }
+    }
+  },
+  color: true,
+  stylesheets: pageStylesheets
+});

data/app/assets/javascripts/bootsy/image_template.js

@@ -0,0 +1,11 @@
+window.Bootsy = window.Bootsy || {};
+
+window.Bootsy.imageTemplate = function(locale, options) {
+  var size = (options && options.size) ? ' btn-' + options.size : '';
+
+  return  '<li>' +
+    '<a class="btn btn-default ' + size + '" data-wysihtml5-command="customCommand" title="' + locale.image.insert + '" tabindex="-1">' +
+      '<span class="glyphicon glyphicon-picture"></span>' +
+    '</a>' +
+  '</li>';
+};

data/app/assets/javascripts/bootsy/init.js

@@ -0,0 +1,38 @@
+/* global Bootsy */
+window.Bootsy = window.Bootsy || {};
+
+// Public: Intialize Bootsy editors in all visible `textarea`
+//         elements that has the `bootsy_text_area` class.
+Bootsy.init = function() {
+  if (!Bootsy.areas) {
+    Bootsy.areas = {};
+  }
+
+  $('textarea.bootsy_text_area').each(function(index) {
+    if (!$(this).data('bootsy-initialized')) {
+      var area = new Bootsy.Area($(this));
+      var areaIdx = $(this).attr('id') || index;
+
+      /* There's always people who let elements share ids */
+      if(Bootsy.areas[areaIdx] !== undefined) {
+        areaIdx = $(this).attr('id') + index;
+      }
+
+      area.init();
+
+      Bootsy.areas[areaIdx] = area;
+    }
+  });
+};
+
+/* Initialize Bootsy on document load */
+$(function() {
+  $(window).load(function() {
+    Bootsy.init();
+
+    /* Reload Bootsy on page load when using Turbolinks. */
+    if (window.Turbolinks) {
+      $(document).on('page:load', Bootsy.init);
+    }
+  });
+});

data/app/assets/javascripts/bootsy/locales/en.js

@@ -0,0 +1,54 @@
+/**
+ * English translations for bootstrap-wysihtml5 and Bootsy
+ */
+(function($){
+  $.fn.wysihtml5.locale['en'] = {
+    font_styles: {
+      normal: 'Normal text',
+      h1: 'Heading 1',
+      h2: 'Heading 2',
+      h3: 'Heading 3'
+    },
+    emphasis: {
+      bold: 'Bold',
+      italic: 'Italic',
+      underline: 'Underline',
+      small: 'Small'
+    },
+    lists: {
+      unordered: 'Unordered list',
+      ordered: 'Ordered list',
+      outdent: 'Outdent',
+      indent: 'Indent'
+    },
+    link: {
+      insert: 'Insert link',
+      cancel: 'Cancel',
+      target: 'Open link in new window'
+    },
+    image: {
+      insert: 'Insert image',
+      cancel: 'Cancel'
+    },
+    html: {
+      edit: 'Edit HTML'
+    },
+    colours: {
+      black: 'Black',
+      silver: 'Silver',
+      gray: 'Grey',
+      maroon: 'Maroon',
+      red: 'Red',
+      purple: 'Purple',
+      green: 'Green',
+      olive: 'Olive',
+      navy: 'Navy',
+      blue: 'Blue',
+      orange: 'Orange'
+    },
+    bootsy: {
+      alertUnsaved: 'You have unsaved changes.',
+      error: 'Something went wrong. Please try again later.'
+    }
+  };
+}(jQuery));