simple_form_wysihtml 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d9101c670f1be008a11428b9d7d3a69d3be0f84
+  data.tar.gz: c931b10c95007d6dbcc4fa39147372de9442ad38
+SHA512:
+  metadata.gz: 1949ca6a611e6e718647d65336128d5bfb7a16a4d986e82f31df8cf0b08d6ffeee3320271bedb814f5097e8e4675795b562232f05250701616f2d6e76cda3db4
+  data.tar.gz: 4b89fbdad6d35a2351057c2962cef069f6dc1fabd2db8ff77eef022a33a0153f13cf10e3c249e684382feedc31179de8c59ef6ac7f843d1bc18beb4fdfdb798c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'https://rails-assets.org'
+
+# Specify your gem's dependencies in simple_form_wysihtml.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tomas Celizna
+
+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,130 @@
+# Simple Form Wysihtml
+
+Integrates [Wysihtml5](http://xing.github.io/wysihtml5) editor (resp. [this branch](https://github.com/Edicy/wysihtml5) of it) with Rails and [Simple Form](https://github.com/plataformatec/simple_form).
+
+## Installation
+
+Add the gem to your Gemfile:
+
+    gem 'simple_form_wysihtml'
+
+And execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_form_wysihtml
+
+To make it work you need to require the javascripts in `application.js`:
+
+    //= require simple_form_wysihtml
+
+Optionally you can add the (very minimal) default styling in `application.css`:
+
+    *= require 'simple_form_wysihtml'
+
+## Usage
+
+Use in forms:
+
+    = form.input :body, as: :wysihtml
+
+## Styling
+
+See [simple_form_wysihtml.css.scss](https://github.com/tomasc/simple_form_wysihtml/blob/master/lib/assets/stylesheets/simple_form_wysihtml.css.scss) for how to style the editor.
+
+## Configuration
+
+### The toolbar
+
+You can override the defaults by specifying the toolbar in an initializer:
+
+```Ruby
+# config/initializers/simple_form_wysihtml.rb
+
+SimpleFormWysihtml::WysihtmlInput.configure do |c|
+  c.commands = [
+    { bold: { label: 'Bold' }, italic: { label: 'Italic' } },
+    { createLink:  { label: 'Create Link' } },
+    { insertOrderedList: nil, insertUnorderedList: nil }
+  ]
+end
+```
+
+Alternatively, you can configure individual input fields in the form:
+
+```Slim
+= f.input :body, as: :wysihtml, commands: [{ bold: { label: 'B' } }, { italic: { label: 'I' } }]
+```
+
+See the [list of available commands](https://github.com/Edicy/wysihtml5/tree/master/src/commands).
+
+### Parser rules
+
+The parser rules are defined as a javascript variable, containing a hash of rules (see [Wysihtml5x](https://github.com/Edicy/wysihtml5/tree/master/parser_rules).
+
+Add a javascript file with your own parser rules (namespaced for example like this):
+
+```js
+// app/assets/javascripts/parser_rules.js
+
+YourCoolNameSpace = (function(){
+
+  var YourCoolNameSpace = {
+    parserRules: {
+      tags: {
+        i: {
+          rename_tag: 'em'
+        },
+
+        a: {
+          set_attributes: {
+            target: "_self"
+          }
+        }
+      }
+    }
+  }
+
+  return YourCoolNameSpace;
+})();
+```
+
+Then in your initializer assign the `parser_rules` to the name of your JS variable:
+
+```Ruby
+# config/initializers/simple_form_wysihtml.rb
+
+SimpleFormWysihtml::WysihtmlInput.configure do |c|
+  c.parser_rules = 'YourCoolNameSpace.parserRules'
+end
+```
+
+## TODO
+
+### Add remaining commands from wysihtml5:
+
+* addTableCells
+* bgColorStyle
+* removeLink
+* createTable
+* deleteTableCells
+* fontSizeStyle
+* foreColorStyle
+* justifyFull
+* mergeTableCells
+
+Reference: [wysihtml5 wiki](https://github.com/edicy/wysihtml5/wiki/Supported-Commands).
+
+### Testing
+
+How to do it?
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_form_wysihtml/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/assets/javascripts/simple_form_wysihtml.js

@@ -0,0 +1,3 @@
+//= require simple_form_wysihtml/simple_form_wysihtml_parser_rules
+//= require simple_form_wysihtml/simple_form_wysihtml
+//= require wysihtml5x

data/lib/assets/javascripts/simple_form_wysihtml/simple_form_wysihtml.js.coffee.erb

@@ -0,0 +1,18 @@
+
+
+
+$ ->
+  editors = []
+
+  $('div.wysihtml_editor').each (idx, wrapper) ->
+    e = new wysihtml5.Editor(
+      $(wrapper).find('textarea').get(0)
+      toolbar: $(wrapper).find('div.toolbar').get(0)
+      parserRules: <%= SimpleFormWysihtml::WysihtmlInput.configuration.parser_rules %>
+      # useLineBreaks: false
+      # cleanUp: true
+    )
+    # showToolbarAfterInit: false
+    editors.push(e)
+
+

data/lib/assets/javascripts/simple_form_wysihtml/simple_form_wysihtml_parser_rules.js

@@ -0,0 +1,37 @@
+// Sets up some sensible defaults
+
+SimpleFormWysihtml = (function(){
+
+  var SimpleFormWysihtml = {
+    parserRules: {
+      tags: {
+        strong: {},
+        b:      {
+          rename_tag: 'strong'
+        },
+        i:      {
+          rename_tag: 'em'
+        },
+        em:     {},
+        br:     {},
+        p:      {},
+        div:    {},
+        span:   {},
+        ul:     {},
+        ol:     {},
+        li:     {},
+        a:      {
+          set_attributes: {
+            target: "_self",
+            rel:    "nofollow"
+          },
+          check_attributes: {
+            href:   "url"
+          }
+        }
+      }
+    }
+  }
+
+  return SimpleFormWysihtml;
+})();

data/lib/assets/stylesheets/simple_form_wysihtml.css.scss

@@ -0,0 +1,23 @@
+div.wysihtml_editor {
+  div.toolbar {
+    ul.commands {
+      margin: 0;
+      padding: 0;
+
+      li.command_group {
+        display: inline-block;
+
+        a.command.button {
+          margin-right: .5em;
+        }
+      }
+    }
+    div.dialogs {
+      div.dialog {
+        a.button {
+          margin-right: .5em;
+        }
+      }
+    }
+  }
+}

data/lib/simple_form_wysihtml.rb

@@ -0,0 +1,15 @@
+require "simple_form"
+require "simple_form_wysihtml/engine"
+require "simple_form_wysihtml/configuration"
+require "simple_form_wysihtml/simple_form_wysihtml"
+require "simple_form_wysihtml/version"
+
+require "rails-assets-wysihtml5x"
+
+# ---------------------------------------------------------------------
+
+module SimpleForm
+  class FormBuilder
+    map_type :wysihtml, to: SimpleFormWysihtml::WysihtmlInput
+  end
+end

data/lib/simple_form_wysihtml/configuration.rb

@@ -0,0 +1,17 @@
+module SimpleFormWysihtml
+  class Configuration
+
+    attr_accessor :commands, :parser_rules
+
+    def initialize
+      @parser_rules = 'SimpleFormWysihtml.parserRules'
+      @commands = [
+        { bold: { label: 'B' }, italic: { label: 'I' } },
+        { createLink: nil },
+        { insertOrderedList: nil, insertUnorderedList: nil },
+        { undo: nil, redo: nil }
+      ]
+    end
+
+  end
+end

data/lib/simple_form_wysihtml/engine.rb

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

data/lib/simple_form_wysihtml/simple_form_wysihtml.rb

@@ -0,0 +1,308 @@
+module SimpleFormWysihtml
+  class WysihtmlInput < SimpleForm::Inputs::Base
+
+    class << self
+
+      attr_accessor :configuration
+
+      def configure
+        @configuration ||= Configuration.new
+        yield @configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+    end
+
+    # =====================================================================
+
+    # @return [String]
+    def input
+      template.content_tag :div, class: %w(wysihtml_editor) do
+        toolbar + text_area
+      end
+    end
+
+    private # =============================================================
+
+    # Array of commands for text area toolbar, arranged into command groups.
+    # @return [Array]
+    def command_list
+      options[:commands] || SimpleFormWysihtml::WysihtmlInput.configuration.commands
+    end
+
+    # ---------------------------------------------------------------------
+
+    # @return [String]
+    def text_area
+      @builder.text_area(attribute_name, input_html_options).html_safe
+    end
+
+    # @return [String]
+    def toolbar
+      template.content_tag :div, class: 'toolbar' do
+        commands + dialogs
+      end.html_safe
+    end
+
+    # @return [String]
+    def commands
+      template.content_tag :ul, class: 'commands' do
+        command_list.collect do |group|
+          command_group(group)
+        end.join.html_safe
+      end
+    end
+
+    # @param [Array] group
+    # @return [String]
+    def command_group group
+      template.content_tag :li, class: 'command_group' do
+        group.map do |command, options|
+          self.send(command, options || {})
+        end.join.html_safe
+      end.html_safe
+    end
+
+    # @param [String]
+    def dialogs
+      flattened_command_list = command_list.inject({}){ |res, i| res.merge!(i) }
+      command_list_with_dialog = flattened_command_list.select{ |k,v| %w(createLink insertImage).include?(k.to_s) }
+
+      return unless command_list_with_dialog.present?
+
+      template.content_tag :div, class: 'dialogs' do
+        command_list_with_dialog.map do |command, options|
+          self.send("#{command}_dialog", options || {})
+        end.join.html_safe
+      end
+    end
+
+    # ---------------------------------------------------------------------
+
+    # @param [Hash] options
+    # @return [String]
+    def bold options={}
+      label = options[:label] || 'Bold'
+
+      command_tag 'bold', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def createLink options={}
+      label = options[:label] || 'Link'
+      value = options[:value] || 'http://'
+
+      command_tag('createLink', label, value)
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def createLink_dialog options={}
+      dialog_label = options[:dialog_label] || 'Link:'
+      value = options[:value] || 'http://'
+      dialog_field = dialog_field_tag('href', value)
+
+      dialog_tag('createLink', dialog_label, dialog_field)
+    end
+
+    # @param [Hash] options
+    # @retun [String]
+    def fontSize options={}
+      label = options[:label] || 'Size'
+      value = options[:value] || 'small'
+
+      command_tag 'fontSize', label, value
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def foreColor options={}
+      label = options[:label] || 'Color'
+      value = options[:label] || 'red'
+
+      command_tag 'foreColor', label, value
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def formatBlock options={}
+      label = options[:label] || 'Block'
+      value = options[:value] || 'h1'
+
+      command_tag 'formatBlock', label, value
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def formatInline options={}
+      label = options[:label] || 'Inline'
+      value = options[:value] || 'span'
+
+      command_tag 'formatInline', label, value
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def insertHTML options={}
+      label = options[:label] || 'HTML'
+      value = options[:value] || '<blockquote>foobar</blockquote>'
+
+      command_tag 'insertHTML', label, value
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def insertImage options={}
+      label = options[:label] || 'Image'
+      value = options[:value] || 'http://'
+
+      command_tag('insertImage', label)
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def insertImage_dialog options={}
+      dialog_label = options[:dialog_label] || 'Image:'
+      value = options[:value] || 'http://'
+      dialog_field = dialog_field_tag('src', value)
+
+      dialog_tag('createLink', dialog_label, dialog_field)
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def insertLineBreak options={}
+      label = options[:label] || 'Line Break'
+
+      command_tag 'insertLineBreak', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def insertOrderedList options={}
+      label = options[:label] || 'OL'
+
+      command_tag 'insertOrderedList', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def insertUnorderedList options={}
+      label = options[:label] || 'UL'
+
+      command_tag 'insertUnorderedList', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def italic options={}
+      label = options[:label] || 'Italic'
+
+      command_tag 'italic', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def justifyCenter options={}
+      label = options[:label] || 'Center'
+
+      command_tag 'justifyCenter', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def justifyLeft options={}
+      label = options[:label] || 'Left'
+
+      command_tag 'justifyLeft', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def justifyRight options
+      label = options[:label] || 'Right'
+
+      command_tag 'justifyRight', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def redo options={}
+      label = options[:label] || 'Redo'
+
+      command_tag 'redo', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def underline options={}
+      label = options[:label] || 'Underline'
+
+      command_tag 'underline', label
+    end
+
+    # @param [Hash] options
+    # @return [String]
+    def undo options={}
+      label = options[:label] || 'Undo'
+
+      command_tag 'undo', label
+    end
+
+    # ---------------------------------------------------------------------
+
+    # Generates link for specified command
+    #
+    # @param [String] command
+    # @param [String] label
+    # @param [String] value
+    # @return [String]
+    def command_tag command, label, value=nil
+      options = { 'data-wysihtml5-command' => command }
+      options.merge!({ 'data-wysihtml5-command-value' => value }) if value.present?
+      options.merge!({ class: 'command button' })
+
+      template.content_tag :a, options do
+        label
+      end.html_safe
+    end
+
+    # @param [String] command
+    # @param [String] label
+    # @param [String] dialog_field
+    # @return [String]
+    def dialog_tag command, label, dialog_field
+      options = { 'data-wysihtml5-dialog' => command, style: 'display: none' }
+      options.merge!({ class: 'dialog' })
+
+      template.content_tag :div, options do
+        template.content_tag(:label, (label + dialog_field).html_safe).html_safe +
+          action_tag('save', 'OK') +
+          action_tag('cancel', 'Cancel')
+      end.html_safe
+    end
+
+    # @param [String] action
+    # @param [String] label
+    # @return [String]
+    def action_tag action, label
+      template.content_tag :a, 'data-wysihtml5-dialog-action' => action, class: 'button' do
+        label
+      end.html_safe
+    end
+
+    # @param [String] att
+    # @param [String] value
+    # @return [String]
+    def dialog_field_tag att, value=nil
+      "<input data-wysihtml5-dialog-field='#{att}' value='#{value}'>".html_safe
+    end
+
+    # ---------------------------------------------------------------------
+
+  end
+end

data/lib/simple_form_wysihtml/version.rb

@@ -0,0 +1,3 @@
+module SimpleFormWysihtml
+  VERSION = "0.0.1"
+end

data/simple_form_wysihtml.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_form_wysihtml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_form_wysihtml"
+  spec.version       = SimpleFormWysihtml::VERSION
+  spec.authors       = ["Tomas Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+  spec.summary       = %q{Integrates Wysihtml5 editor with Rails and Simple Form.}
+  spec.description   = %q{Integrates Wysihtml5 editor with Rails and Simple Form.}
+  spec.homepage      = "https://github.com/tomasc/simple_form_wysihtml"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "simple_form", ">= 3.0.2"
+  spec.add_dependency "rails-assets-wysihtml5x", ">= 0.4.12"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: simple_form_wysihtml
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: rails-assets-wysihtml5x
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.12
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integrates Wysihtml5 editor with Rails and Simple Form.
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/assets/javascripts/simple_form_wysihtml.js
+- lib/assets/javascripts/simple_form_wysihtml/simple_form_wysihtml.js.coffee.erb
+- lib/assets/javascripts/simple_form_wysihtml/simple_form_wysihtml_parser_rules.js
+- lib/assets/stylesheets/simple_form_wysihtml.css.scss
+- lib/simple_form_wysihtml.rb
+- lib/simple_form_wysihtml/configuration.rb
+- lib/simple_form_wysihtml/engine.rb
+- lib/simple_form_wysihtml/simple_form_wysihtml.rb
+- lib/simple_form_wysihtml/version.rb
+- simple_form_wysihtml.gemspec
+homepage: https://github.com/tomasc/simple_form_wysihtml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Integrates Wysihtml5 editor with Rails and Simple Form.
+test_files: []
+has_rdoc: