simple_form_epic_editor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b4c183688af9e5bf6e618e592b9a64aa8e59bd3
+  data.tar.gz: 7754ea2e7546d9676896a37a27d445ac2c4fa4a2
+SHA512:
+  metadata.gz: 1d6062e93209efce2042fdaa47bb9787fcdbd8bd92652df870ec32de68939324f8a5fb0b9845194a1de578623800a4d8d9520f829162536cf30c9d7a79c0d642
+  data.tar.gz: 0afe8e12ec525ca184a0b8934a1fff92b5cec8b5e552d17d8dd2d08d58e991a704b47a65b3f60ccedef071967d199eac3bc0bb0515ca366c8fde3ea1089c66d8

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_epic_editor.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,84 @@
+# Simple Form Epic Editor
+
+Integrates the markdown editor [Epic Editor](https://github.com/OscarGodson/EpicEditor) with Rails and [Simple Form](https://github.com/plataformatec/simple_form).
+
+This gem adjusts the default theme of [Epic Editor](https://github.com/OscarGodson/EpicEditor) and places the toolbar above the editing field.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_form_epic_editor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_form_epic_editor
+
+To make it work you need to require the javascripts in `application.js`:
+
+    //= require simple_form_epic_editor
+
+## Usage
+
+Use in forms:
+
+    = form.input :body, as: :epic_editor
+
+## Styling
+
+Styling for the editor is separated into three files:
+
+* base.css
+* preview.css
+* editor.css
+
+The default styling can be overridden by adding your own version of any or all of the three files in `lib/assets/stylesheets/simple_form_epic_editor/default_theme/`
+
+Alternatively you can configure the editor to use another [theme](#theme).
+
+## Configuration
+
+### Toolbar
+
+You can change the default button texts in an initializer:
+
+```Ruby
+# config/initializers/simple_form_epic_editor.rb
+
+SimpleFormEpicEditor::EpicEditorInput.configure do |c|
+  c.commands = [
+    @commands = {
+      edit: 'Edit',
+      preview: 'Render'
+    }
+  ]
+end
+```
+
+### Theme
+
+In the initializer you can assign any or all of the three stylesheets a new path:
+
+```Ruby
+# config/initializers/simple_form_epic_editor.rb
+
+SimpleFormEpicEditor::EpicEditorInput.configure do |c|
+  c.theme = {
+    base: '/simple_form_epic_editor/your_theme_name/base.css',
+    preview: '/simple_form_epic_editor/your_theme_name/preview.css',
+    editor: '/simple_form_epic_editor/your_theme_name/editor.css'
+  }
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_form_epic_editor/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_epic_editor.js

@@ -0,0 +1,2 @@
+//= require epiceditor
+//= require simple_form_epic_editor/simple_form_epic_editor

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

@@ -0,0 +1,87 @@
+# https://github.com/jquery-boilerplate/jquery-boilerplate/
+do ($ = jQuery, window, document) ->
+
+  pluginName = 'simple_form_epic_editor'
+  defaults =
+    debug: false
+
+  # ---------------------------------------------------------------------
+
+  class Plugin
+    constructor: (@element, options) ->
+      @settings = $.extend {}, defaults, options
+
+      @$element = $(@element)
+
+      @_defaults = defaults
+      @_name = pluginName
+
+      @init()
+
+    init: ->
+      console.log 'init' if @settings.debug
+
+      # ---------------------------------------------------------------------
+
+      e = new EpicEditor(
+        container: @get_editor_wrapper().get(0)
+        textarea: @get_editor_textarea().get(0)
+        basePath: '/assets'
+        theme: {
+          base: "<%= SimpleFormEpicEditor::EpicEditorInput.configuration.theme[:base] %>"
+          preview: "<%= SimpleFormEpicEditor::EpicEditorInput.configuration.theme[:preview] %>"
+          editor: "<%= SimpleFormEpicEditor::EpicEditorInput.configuration.theme[:editor] %>"
+        }
+        button: false
+      ).load()
+
+      # ---------------------------------------------------------------------
+
+      @get_toolbar_ul().children('li:first').addClass('active')
+
+      @get_toolbar_lis().on 'click', (event) ->
+        $li = $(event.currentTarget)
+        $li.siblings('li').removeClass('active')
+        $li.addClass('active')
+        e[$li.data('toggle')]()
+
+    # ---------------------------------------------------------------------
+
+    get_editor_wrapper: -> @$element.children('div.editor:first')
+    get_editor_toolbar: -> @$element.children('div.toolbar:first')
+    get_editor_textarea: -> @get_editor_wrapper().children('textarea:first')
+    get_toolbar_ul: -> @get_editor_toolbar().children('ul:first')
+    get_toolbar_lis: -> @get_toolbar_ul().children('li')
+
+  # ---------------------------------------------------------------------
+
+  # A really lightweight plugin wrapper around the constructor,
+  # preventing against multiple instantiations and allowing any
+  # public function (ie. a function whose name doesn't start
+  # with an underscore) to be called via the jQuery plugin,
+  # e.g. $(element).defaultPluginName('functionName', arg1, arg2)
+
+  $.fn[pluginName] = (options) ->
+    args = arguments
+    if options is `undefined` or typeof options is "object"
+      @each ->
+        $.data this, "plugin_" + pluginName, new Plugin(this, options)  unless $.data(this, "plugin_" + pluginName)
+
+    else if typeof options is "string" and options[0] isnt "_" and options isnt "init"
+      returns = undefined
+      @each ->
+        instance = $.data(this, "plugin_" + pluginName)
+        returns = instance[options].apply(instance, Array::slice.call(args, 1))  if instance instanceof Plugin and typeof instance[options] is "function"
+        $.data this, "plugin_" + pluginName, null  if options is "destroy"
+
+      (if returns isnt `undefined` then returns else this)
+
+# =====================================================================
+
+$ ->
+
+  $('div.epic_editor').simple_form_epic_editor()
+
+  # make sure the plugin is correctly rebound to new elements
+  $('body').on 'dom_update', (e) ->
+    $('div.epic_editor').simple_form_epic_editor()

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

@@ -0,0 +1,36 @@
+div.input.epic_editor {
+  div.toolbar {
+    ul.commands {
+      display: inline-block;
+      margin: 0;
+      padding: 0;
+      list-style: none;
+      margin-bottom: 5px;
+      width: 100%;
+
+      li {
+        display: inline-block;
+
+        span {
+          padding: 4px 8px 6px;
+          cursor: pointer;
+          display: inline-block;
+          border: 1px solid transparent;
+        }
+
+        &.active {
+          span {
+            color: rgba(0,0,0,1);
+            border: 1px solid rgba(0,0,0,1);
+            border-bottom: transparent;
+          }
+        }
+      }
+    }
+  }
+
+  div.epiceditor {
+    border: 1px solid rgb(0,0,0);
+    overflow: hidden;
+  }
+}

data/lib/assets/stylesheets/simple_form_epic_editor/default_theme/base.css

@@ -0,0 +1,19 @@
+html {
+  padding: 0;
+  margin: 0;
+  width: 100%;
+  height: 100%;
+}
+
+iframe {
+  margin: 0;
+  padding: 0;
+}
+
+body {
+  box-sizing: border-box;
+  height: 100%;
+  margin: 0;
+  padding: 0;
+  width: 100%;
+}

data/lib/assets/stylesheets/simple_form_epic_editor/default_theme/editor.css

@@ -0,0 +1,9 @@
+body {
+  font-family: 'Menlo', monospace;
+  margin: 0;
+  background: rgb(245, 245, 245);
+  color: rgb(0, 0, 0);
+  font-size: 14px;
+  line-height: 18px;
+  padding: 5px;
+}

data/lib/assets/stylesheets/simple_form_epic_editor/default_theme/preview.css

@@ -0,0 +1,9 @@
+body {
+  font-family: Helvetica, Arial, sans-serif;
+  background: rgb(255, 255, 255);
+  color: rgb(0, 0, 0);
+  font-size: 14px;
+  line-height: 18px;
+  padding: 5px;
+  margin: 0;
+}

data/lib/simple_form_epic_editor.rb

@@ -0,0 +1,15 @@
+require "simple_form"
+require "simple_form_epic_editor/engine"
+require "simple_form_epic_editor/configuration"
+require "simple_form_epic_editor/simple_form_epic_editor"
+require "simple_form_epic_editor/version"
+
+require "rails-assets-epiceditor"
+
+# ---------------------------------------------------------------------
+
+module SimpleForm
+  class FormBuilder
+    map_type :epic_editor, to: SimpleFormEpicEditor::EpicEditorInput
+  end
+end

data/lib/simple_form_epic_editor/configuration.rb

@@ -0,0 +1,21 @@
+module SimpleFormEpicEditor
+  class Configuration
+
+    attr_accessor :commands, :theme
+
+    # TODO: Make everything customizable!
+
+    def initialize
+      @commands = {
+        edit: 'Write',
+        preview: 'Preview'
+      }
+      @theme = {
+        base: '/simple_form_epic_editor/default_theme/base.css',
+        preview: '/simple_form_epic_editor/default_theme/preview.css',
+        editor: '/simple_form_epic_editor/default_theme/editor.css'
+      }
+    end
+
+  end
+end

data/lib/simple_form_epic_editor/engine.rb

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

data/lib/simple_form_epic_editor/simple_form_epic_editor.rb

@@ -0,0 +1,68 @@
+module SimpleFormEpicEditor
+  class EpicEditorInput < 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
+      toolbar + editor
+    end
+
+    private # =============================================================
+
+    # Array of commands for text area toolbar, arranged into command groups.
+    # @return [Hash]
+    def command_list
+      options[:commands] || SimpleFormEpicEditor::EpicEditorInput.configuration.commands
+    end
+
+    def editor
+      template.content_tag :div, class: %w(editor) do
+        text_area
+      end
+    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
+      end.html_safe
+    end
+
+    # @return [String]
+    def commands
+      template.content_tag :ul, class: 'commands' do
+        command_list.map do |c, t|
+          command(c, t)
+        end.flatten.join.html_safe
+      end
+    end
+
+    def command(c, t)
+      template.content_tag :li, class: c.to_s.underscore.downcase, :"data-toggle" => c.to_s do
+        template.content_tag :span, t.to_s
+      end
+    end
+
+  end
+end

data/lib/simple_form_epic_editor/version.rb

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

data/simple_form_epic_editor.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_epic_editor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_form_epic_editor"
+  spec.version       = SimpleFormEpicEditor::VERSION
+  spec.authors       = ["Tomas Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+  spec.summary       = %q{Integrates the markdown editor EpicEditor with Rails and Simple Form.}
+  spec.description   = %q{Integrates the markdown editor EpicEditor 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-epiceditor", ">= 0.2.2"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: simple_form_epic_editor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-15 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-epiceditor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !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 the markdown editor EpicEditor 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_epic_editor.js
+- lib/assets/javascripts/simple_form_epic_editor/simple_form_epic_editor.js.coffee.erb
+- lib/assets/stylesheets/simple_form_epic_editor.css.scss
+- lib/assets/stylesheets/simple_form_epic_editor/default_theme/base.css
+- lib/assets/stylesheets/simple_form_epic_editor/default_theme/editor.css
+- lib/assets/stylesheets/simple_form_epic_editor/default_theme/preview.css
+- lib/simple_form_epic_editor.rb
+- lib/simple_form_epic_editor/configuration.rb
+- lib/simple_form_epic_editor/engine.rb
+- lib/simple_form_epic_editor/simple_form_epic_editor.rb
+- lib/simple_form_epic_editor/version.rb
+- simple_form_epic_editor.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 the markdown editor EpicEditor with Rails and Simple Form.
+test_files: []
+has_rdoc: