tao_editor 1.0.0.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdc27084893ed1e9c6f1e0ff2e275cf0e495f20b
+  data.tar.gz: 52ba3d38bcca068f3bc53b25878e9f3b1b7b4727
+SHA512:
+  metadata.gz: 812db616f553953bbd0ea75df2a4fc1b00f983ac4b6a2650e96bf6c4d8861e2d8bf0e5852275e36bbca846a21583575ff82f26d15bc661f49e209e18ac80a0a4
+  data.tar.gz: bb6831c0196f7e6b00d2962a9e1e940aebd1cb44b0cdc1ec72fad8f39a2d40573c0f8aab5b1c2ba38812578ecfe685f998538edd6523b1cb29ac7c838f160939

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 farthinker
+
+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,28 @@
+# TaoEditor
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tao_editor'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install tao_editor
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/lib/tao_editor.rb

@@ -0,0 +1,9 @@
+
+module TaoEditor
+
+  mattr_accessor :inputs_namespace
+  @@inputs_namespace = 'TaoEditor::Inputs'
+
+end
+
+require 'tao_editor/engine'

data/lib/tao_editor/components/editor_component.rb

@@ -0,0 +1,55 @@
+module TaoEditor
+  module Components
+    class EditorComponent < TaoForm::Components::FieldComponent
+
+      attr_reader :toolbar_options
+
+      def initialize view, builder = nil, attribute_name = nil, options = {}
+        super
+        init_toolbar_options
+      end
+
+      def render &block
+        view.content_tag tag_name, html_options do
+          if block_given?
+            view.concat yield
+          else
+            view.concat builder.hidden_field(attribute_name, class: 'editor-field')
+          end
+          view.concat(render_toolbar) if @options[:toolbar].present?
+        end
+      end
+
+      def self.component_name
+        :editor
+      end
+
+      def render_toolbar
+        ToolbarComponent.new(view, toolbar_options).render
+      end
+
+      private
+
+      def default_options
+        {
+          class: 'tao-editor',
+          toolbar: true,
+          toolbar_floatable: true
+        }
+      end
+
+      def init_toolbar_options
+        @toolbar_options ||= begin
+          if @options[:toolbar].is_a?(Hash)
+            options = @options[:toolbar]
+            @options[:toolbar] = true
+          else
+            options = {}
+          end
+          options
+        end
+      end
+
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/align_item_component.rb

@@ -0,0 +1,20 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class AlignItemComponent < BaseItemComponent
+
+        def self.component_name
+          :editor_toolbar_align_item
+        end
+
+        private
+
+        def default_options
+          merge_options super, {
+            class: 'tao-editor-toolbar-align-item'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/base_item_component.rb

@@ -0,0 +1,55 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class BaseItemComponent < TaoOnRails::Components::Base
+
+        attr_reader :icon, :label, :tooltip
+
+        def initialize view, options = {}
+          super
+          @icon = @options[:icon].presence
+          @label = @options.delete(:label)
+          @tooltip = @options.delete(:tooltip)
+
+          @label = @options[:title] if @label == true
+
+          if @tooltip.present?
+            @tooltip = @options[:title] if @tooltip == true
+            @options.delete(:title)
+          end
+        end
+
+        def render &block
+          if template = find_template
+            render_template template, &block
+          else
+            view.content_tag tag_name, html_options do
+              view.concat render_item_link
+              view.concat(render_tooltip) if tooltip
+            end
+          end
+        end
+
+        def render_item_link
+          view.link_to 'javascript:;', class: 'item-link' do
+            view.concat(view.tao_icon icon) if icon.present? && label.blank?
+            view.concat(view.content_tag :span, label, class: 'item-name') if label.present?
+          end
+        end
+
+        def render_tooltip
+          view.tao_tooltip target_traversal: 'siblings', target_selector: '.item-link',
+            direction: 'bottom-center' do
+            tooltip
+          end
+        end
+
+        private
+
+        def default_options
+          {class: 'tao-editor-toolbar-item'}
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/block_item_component.rb

@@ -0,0 +1,27 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class BlockItemComponent < BaseItemComponent
+
+        def initialize view, options = {}
+          super
+          if @options[:block_attrs].present? && @options[:block_attrs].is_a?(Hash)
+            @options[:block_attrs] = @options[:block_attrs].to_json
+          end
+        end
+
+        def self.component_name
+          :editor_toolbar_block_item
+        end
+
+        private
+
+        def default_options
+          merge_options super, {
+            class: 'tao-editor-toolbar-block-item'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/command_item_component.rb

@@ -0,0 +1,20 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class CommandItemComponent < BaseItemComponent
+
+        def self.component_name
+          :editor_toolbar_command_item
+        end
+
+        private
+
+        def default_options
+          merge_options super, {
+            class: 'tao-editor-toolbar-command-item'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/list_item_component.rb

@@ -0,0 +1,20 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class ListItemComponent < BaseItemComponent
+
+        def self.component_name
+          :editor_toolbar_list_item
+        end
+
+        private
+
+        def default_options
+          merge_options super, {
+            class: 'tao-editor-toolbar-list-item'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/mark_item_component.rb

@@ -0,0 +1,20 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class MarkItemComponent < BaseItemComponent
+
+        def self.component_name
+          :editor_toolbar_mark_item
+        end
+
+        private
+
+        def default_options
+          merge_options super, {
+            class: 'tao-editor-toolbar-mark-item'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/menu_item_component.rb

@@ -0,0 +1,46 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class MenuItemComponent < BaseItemComponent
+
+        attr_reader :items
+
+        def initialize view, options = {}
+          super
+          @items = @options.delete(:items)
+        end
+
+        def render &block
+          render_template find_template, &block
+        end
+
+        def render_item item_options
+          type = item_options.delete(:type).to_s
+          item_name = item_options.delete(:name)
+          item_options = {
+            title: view.t("tao_editor.components.toolbar.items.#{item_name}"),
+            label: true,
+            class: "#{item_name.to_s.dasherize}-item"
+          }.merge(item_options)
+          view.send("tao_editor_toolbar_#{type.dasherize}_item", item_options)
+        end
+
+        def render_separator
+          view.content_tag 'div', nil, class: 'item-separator'
+        end
+
+        def self.component_name
+          :editor_toolbar_menu_item
+        end
+
+        private
+
+        def default_options
+          merge_options super, {
+            class: 'tao-editor-toolbar-menu-item'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar/table_item_component.rb

@@ -0,0 +1,20 @@
+module TaoEditor
+  module Components
+    module Toolbar
+      class TableItemComponent < MenuItemComponent
+
+        def self.component_name
+          :editor_toolbar_table_item
+        end
+
+        private
+
+        def default_options
+          merge_options super, {
+            class: 'tao-editor-toolbar-table-item'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tao_editor/components/toolbar_component.rb

@@ -0,0 +1,70 @@
+module TaoEditor
+  module Components
+    class ToolbarComponent < TaoOnRails::Components::Base
+
+      include TaoEditor::ToolbarDefaultItemsConfig
+
+      attr_reader :items, :items_config
+
+      def initialize view, options = {}
+        super
+        @items = @options.delete(:items)
+        @items_config = default_items_config.dup
+        @items_config.deep_merge! @options.delete(:items_config) || {}
+      end
+
+      def self.component_name
+        :editor_toolbar
+      end
+
+      def render &block
+        view.content_tag tag_name, html_options do
+          items.map(&:to_sym).each do |item|
+            if item == :'|'
+              view.concat render_separator
+            else
+              view.concat render_item item
+            end
+          end
+        end
+      end
+
+      def render_item item_name
+        item_options = get_item_options item_name
+        return unless item_options.present?
+
+        type = item_options.delete(:type)
+        component = if type
+          "tao_editor_toolbar_#{type.to_s.dasherize}_item"
+        else
+          item_options.delete(:component)
+        end
+        view.send(component, item_options)
+      end
+
+      def render_separator
+        view.content_tag 'div', nil, class: 'item-separator'
+      end
+
+      private
+
+      def default_options
+        {
+          class: 'tao-editor-toolbar',
+          items: ['heading', 'bold', 'italic', 'underline', 'alignment', '|', 'ul', 'ol', 'table', 'hr']
+        }
+      end
+
+      def get_item_options item_name
+        item_options = items_config[item_name]
+        return unless item_options.present?
+        {
+          title: view.t("tao_editor.components.toolbar.items.#{item_name}"),
+          tooltip: true,
+          class: "#{item_name.to_s.dasherize}-item"
+        }.merge(item_options)
+      end
+
+    end
+  end
+end

data/lib/tao_editor/engine.rb

@@ -0,0 +1,19 @@
+require 'tao_on_rails'
+require 'tao_ui'
+require 'tao_form'
+
+module TaoEditor
+  class Engine < Rails::Engine
+
+    config.eager_load_paths += Dir["#{config.root}/lib"]
+
+    config.i18n.load_path += Dir[config.root.join('config', 'locales', '**', '*.{rb,yml}')]
+
+    paths['app/views'] << 'lib/views'
+
+    ::ActiveSupport.on_load :tao_components do
+      load_tao_components TaoEditor::Engine.root
+    end
+
+  end
+end

data/lib/tao_editor/inputs/editor_input.rb

@@ -0,0 +1,20 @@
+module TaoEditor
+  module Inputs
+    class EditorInput < ::SimpleForm::Inputs::Base
+
+      def input(wrapper_options = nil)
+        merged_html_options = merge_wrapper_options(input_html_options, wrapper_options)
+        merged_component_options = component_options.merge(merged_html_options)
+        template.tao_editor(
+          @builder, attribute_name, merged_component_options
+        )
+      end
+
+      private
+
+      def component_options
+        @component_options ||= input_options.slice(:toolbar, :placeholder)
+      end
+    end
+  end
+end

data/lib/tao_editor/toolbar_default_items_config.rb

@@ -0,0 +1,44 @@
+module TaoEditor
+  module ToolbarDefaultItemsConfig
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :default_items_config, to: :class
+    end
+
+    class_methods do
+      def default_items_config
+        @default_items_config ||= {
+          bold: { type: :mark, icon: :bold, mark_name: :strong },
+          italic: { type: :mark, icon: :italic, mark_name: :em },
+          underline: { type: :mark, icon: :underline, mark_name: :u },
+          ul: { type: :list, icon: :unorder_list, list_name: :bullet_list },
+          ol: { type: :list, icon: :order_list, list_name: :ordered_list },
+          hr: { type: :command, command_name: :insertHr, icon: :hr },
+          alignment: { type: :menu, icon: :align_left, items: [
+            { type: :align, alignment: :left, name: :align_left, icon: :align_left },
+            { type: :align, alignment: :center, name: :align_center, icon: :align_center },
+            { type: :align, alignment: :right, name: :align_right, icon: :align_right }
+          ]},
+          heading: { type: :menu, icon: :heading, items: [
+            { type: :block, block_name: :heading, block_attrs: {level: 1}, name: :h1, icon: :heading_1 },
+            { type: :block, block_name: :heading, block_attrs: {level: 2}, name: :h2, icon: :heading_2 },
+            { type: :block, block_name: :heading, block_attrs: {level: 3}, name: :h3, icon: :heading_3 },
+            { type: :block, block_name: :heading, block_attrs: {level: 4}, name: :h4, icon: :heading_4 }, '|',
+            { type: :block, block_name: :paragraph, name: :text, icon: :heading }
+          ]},
+          table: { type: :table, icon: :table, items: [
+            { type: :command, command_name: :addColumnBefore, name: :add_column_before},
+            { type: :command, command_name: :addColumnAfter, name: :add_column_after},
+            { type: :command, command_name: :deleteColumn, name: :delete_column}, '|',
+            { type: :command, command_name: :addRowBefore, name: :add_row_before},
+            { type: :command, command_name: :addRowAfter, name: :add_row_after},
+            { type: :command, command_name: :deleteRow, name: :delete_row}, '|',
+            { type: :command, command_name: :deleteTable, name: :delete_table}
+          ]}
+        }
+      end
+    end
+
+  end
+end

data/lib/tao_editor/version.rb

@@ -0,0 +1,3 @@
+module TaoEditor
+  VERSION = '1.0.0.beta.1'
+end

data/lib/views/components/tao_editor/components/toolbar/_menu_item.html.erb

@@ -0,0 +1,15 @@
+<%= content_tag component.tag_name, component.html_options do %>
+  <%= component.render_item_link %>
+  <%= component.render_tooltip %>
+
+  <%= tao_popover target_selector: '.item-link', target_traversal: 'siblings',
+    class: 'menu-popover', with_arrow: false, direction: 'bottom-right', offset: -8 do %>
+    <% component.items.each do |item| %>
+      <% if item == '|' %>
+        <%= component.render_separator %>
+      <% else %>
+        <%= component.render_item item.clone %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/lib/views/components/tao_editor/components/toolbar/_table_item.html.erb

@@ -0,0 +1,31 @@
+<%= content_tag component.tag_name, component.html_options do %>
+  <%= component.render_item_link %>
+  <%= component.render_tooltip %>
+
+  <%= tao_popover target_selector: '.item-link', target_traversal: 'siblings',
+    class: 'menu-popover', with_arrow: false, direction: 'bottom-right', offset: -8 do %>
+    <div class="table-creator">
+      <table>
+        <tbody>
+          <% (1..6).each do |row_index| %>
+          <tr>
+            <% (1..6).each do |cell_index| %>
+            <td><%= link_to '', 'javascript:;', class: 'link-create-table' %></td>
+            <% end %>
+          </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+
+    <div class="table-command-items">
+      <% component.items.each do |item| %>
+        <% if item == '|' %>
+          <%= component.render_separator %>
+        <% else %>
+          <%= component.render_item item.clone %>
+        <% end %>
+      <% end %>
+    </div>
+  <% end %>
+<% end %>

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: tao_editor
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta.1
+platform: ruby
+authors:
+- farthinker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tao_on_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.1
+- !ruby/object:Gem::Dependency
+  name: tao_ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.1
+- !ruby/object:Gem::Dependency
+  name: tao_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Editor component based on prosemirror and tao_form
+email:
+- farthinker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/tao_editor.rb
+- lib/tao_editor/components/editor_component.rb
+- lib/tao_editor/components/toolbar/align_item_component.rb
+- lib/tao_editor/components/toolbar/base_item_component.rb
+- lib/tao_editor/components/toolbar/block_item_component.rb
+- lib/tao_editor/components/toolbar/command_item_component.rb
+- lib/tao_editor/components/toolbar/list_item_component.rb
+- lib/tao_editor/components/toolbar/mark_item_component.rb
+- lib/tao_editor/components/toolbar/menu_item_component.rb
+- lib/tao_editor/components/toolbar/table_item_component.rb
+- lib/tao_editor/components/toolbar_component.rb
+- lib/tao_editor/engine.rb
+- lib/tao_editor/inputs/editor_input.rb
+- lib/tao_editor/toolbar_default_items_config.rb
+- lib/tao_editor/version.rb
+- lib/views/components/tao_editor/components/toolbar/_menu_item.html.erb
+- lib/views/components/tao_editor/components/toolbar/_table_item.html.erb
+homepage: https://github.com/mycolorway/tao_editor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Online editor component
+test_files: []