draftjs_exporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61ee95a90f71865abb4072666f015cd2ef60faef
+  data.tar.gz: 2c2ceb50a8612074054451c544eeecd771724cb6
+SHA512:
+  metadata.gz: 10c7d1527d1bfd2d007fe3c213385ddc25c434e15aa8d03dba858bd74c0bf0ecad31306f7689cd8f730d81768f21f75e5d5b500bc7fd2ab30567eb172d5e7224
+  data.tar.gz: 46056dde84ff7b0c09949f1eeb2a4e839fb49c4c3f083cd2037071738eb1b175f4390b9ec022540f31c88eafde69eed79e322271b554c9ee6e3f16712792b9be

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Ignition Works Limited
+
+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,87 @@
+# Draft.js Exporter
+
+[![Circle CI](https://circleci.com/gh/ignitionworks/draftjs_exporter/tree/master.svg?style=shield)](https://circleci.com/gh/ignitionworks/draftjs_exporter/tree/master)
+[![Code Climate](https://codeclimate.com/github/ignitionworks/draftjs_exporter/badges/gpa.svg)](https://codeclimate.com/github/ignitionworks/draftjs_exporter)
+[![Test Coverage](https://codeclimate.com/github/ignitionworks/draftjs_exporter/badges/coverage.svg)](https://codeclimate.com/github/ignitionworks/draftjs_exporter/coverage)
+
+[Draft.js](https://facebook.github.io/draft-js/) is a framework for
+building rich text editors. However, it does not support exporting
+documents at HTML. This gem is designed to take the raw `ContentState`
+(output of [`convertToRaw`](https://facebook.github.io/draft-js/docs/api-reference-data-conversion.html#converttoraw))
+from Draft.js and convert it to HTML using Ruby.
+
+## Usage
+
+```ruby
+# Create configuration for entities and styles
+config = {
+  entity_decorators: {
+    'LINK' => DraftjsExporter::Entities::Link.new
+  },
+  block_map: {
+    'header-one' => { element: 'h1' },
+    'unordered-list-item' => {
+      element: 'li',
+      wrapper: ['ul', { className: 'public-DraftStyleDefault-ul' }]
+    },
+    'unstyled' => { element: 'div' }
+  },
+  style_map: {
+    'ITALIC' => { fontStyle: 'italic' }
+  }
+}
+
+# New up the exporter
+exporter = DraftjsExporter::HTML.new(config)
+
+# Provide raw content state
+exporter.call({
+  entityMap: {
+    '0' => {
+      type: 'LINK',
+      mutability: 'MUTABLE',
+      data: {
+        url: 'http://example.com'
+      }
+    }
+  },
+  blocks: [
+    {
+      key: '5s7g9',
+      text: 'Header',
+      type: 'header-one',
+      depth: 0,
+      inlineStyleRanges: [],
+      entityRanges: []
+    },
+    {
+      key: 'dem5p',
+      text: 'some paragraph text',
+      type: 'unstyled',
+      depth: 0,
+      inlineStyleRanges: [
+        {
+          offset: 0,
+          length: 4,
+          style: 'ITALIC'
+        }
+      ],
+      entityRanges: [
+        {
+          offset: 5,
+          length: 9,
+          key: 0
+        }
+      ]
+    }
+  ]
+})
+# => "<h1>Header</h1><div>\n<span style=\"fontStyle: italic;\">some</span> <a href=\"http://example.com\">paragraph</a> text</div>"
+```
+
+## Tests
+
+```bash
+$ rspec
+```
+

data/lib/draftjs_exporter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'draftjs_exporter/version'
+require 'draftjs_exporter/html'

data/lib/draftjs_exporter/command.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module DraftjsExporter
+  Command = Struct.new(:name, :index, :data)
+end

data/lib/draftjs_exporter/entities/link.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module DraftjsExporter
+  module Entities
+    class Link
+      def call(parent_element, data)
+        element = parent_element.document.create_element('a', href: data.fetch(:data, {}).fetch(:url))
+        parent_element.add_child(element)
+        element
+      end
+    end
+  end
+end

data/lib/draftjs_exporter/entities/null.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module DraftjsExporter
+  module Entities
+    class Null
+      def call(parent_element, _data)
+        parent_element
+      end
+    end
+  end
+end

data/lib/draftjs_exporter/entity_state.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'draftjs_exporter/entities/null'
+
+module DraftjsExporter
+  class EntityState
+    attr_reader :entity_decorators, :entity_map, :entity_stack, :root_element
+
+    def initialize(root_element, entity_decorators, entity_map)
+      @entity_decorators = entity_decorators
+      @entity_map = entity_map
+      @entity_stack = [[Entities::Null.new.call(root_element, nil), nil]]
+    end
+
+    def apply(command)
+      case command.name
+      when :start_entity
+        start_command(command)
+      when :stop_entity
+        stop_command(command)
+      end
+    end
+
+    def current_parent
+      element, _data = entity_stack.last
+      element
+    end
+
+    private
+
+    def start_command(command)
+      entity_details = entity_map.fetch(command.data.to_s)
+      decorator = entity_decorators.fetch(entity_details.fetch(:type))
+      parent_element = entity_stack.last.first
+      new_element = decorator.call(parent_element, entity_details)
+      entity_stack.push([new_element, entity_details])
+    end
+
+    def stop_command(command)
+      entity_details = entity_map.fetch(command.data.to_s)
+      _element, expected_entity_details = entity_stack.last
+
+      if expected_entity_details != entity_details
+        raise "Invalid entity. Expected #{expected_entity_details.inspect} got #{entity_details.inspect}"
+      end
+
+      entity_stack.pop
+    end
+  end
+end

data/lib/draftjs_exporter/html.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+require 'nokogiri'
+require 'draftjs_exporter/entity_state'
+require 'draftjs_exporter/style_state'
+require 'draftjs_exporter/command'
+
+module DraftjsExporter
+  class HTML
+    attr_reader :block_map, :style_map, :entity_decorators
+
+    def initialize(block_map:, style_map:, entity_decorators:)
+      @block_map = block_map
+      @style_map = style_map
+      @entity_decorators = entity_decorators
+    end
+
+    def call(content_state)
+      content_state.fetch(:blocks, []).map { |block|
+        content_state_block(block, content_state.fetch(:entityMap, {}))
+      }.inject(:+)
+    end
+
+    private
+
+    def content_state_block(block, entity_map)
+      document = Nokogiri::HTML::Document.new
+      fragment = Nokogiri::HTML::DocumentFragment.new(document)
+      type = block.fetch(:type, 'unstyled')
+      element = document.create_element(*block_options(type)) { |e|
+        block_contents(e, block, entity_map)
+      }
+      fragment.add_child(element).to_s
+    end
+
+    def block_contents(element, block, entity_map)
+      style_state = StyleState.new(style_map)
+      entity_state = EntityState.new(element, entity_decorators, entity_map)
+      build_command_groups(block).each do |text, commands|
+        commands.each do |command|
+          entity_state.apply(command)
+          style_state.apply(command)
+        end
+
+        add_node(entity_state.current_parent, text, style_state)
+      end
+    end
+
+    def block_options(type)
+      options = block_map.fetch(type)
+      return [options.fetch(:element)] unless options.key?(:wrapper)
+
+      wrapper = options.fetch(:wrapper)
+      name = wrapper[0]
+      config = wrapper[1] || {}
+      options = {}
+      options[:class] = config.fetch(:className) if config.key?(:className)
+      [name, options]
+    end
+
+    def add_node(element, text, state)
+      document = element.document
+      node = if state.text?
+               document.create_text_node(text)
+             else
+               document.create_element('span', text, state.element_attributes)
+             end
+      element.add_child(node)
+    end
+
+    def build_command_groups(block)
+      text = block.fetch(:text)
+      grouped = build_commands(block).group_by(&:index).sort
+      grouped.map.with_index { |(index, commands), command_index|
+        start_index = index
+        next_group = grouped[command_index + 1]
+        stop_index = (next_group && next_group.first || 0) - 1
+        [text.slice(start_index..stop_index), commands]
+      }
+    end
+
+    def build_commands(block)
+      [
+        Command.new(:start_text, 0),
+        Command.new(:stop_text, block.fetch(:text).size)
+      ] +
+        build_range_commands(:inline_style, :style, block.fetch(:inlineStyleRanges)) +
+        build_range_commands(:entity, :key, block.fetch(:entityRanges))
+    end
+
+    def build_range_commands(name, data_key, ranges)
+      ranges.flat_map { |range|
+        data = range.fetch(data_key)
+        start = range.fetch(:offset)
+        stop = start + range.fetch(:length)
+        [
+          Command.new("start_#{name}".to_sym, start, data),
+          Command.new("stop_#{name}".to_sym, stop, data)
+        ]
+      }
+    end
+  end
+end

data/lib/draftjs_exporter/style_state.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module DraftjsExporter
+  class StyleState
+    attr_reader :styles, :style_map
+
+    def initialize(style_map)
+      @styles = []
+      @style_map = style_map
+    end
+
+    def apply(command)
+      case command.name
+      when :start_inline_style
+        styles.push(command.data)
+      when :stop_inline_style
+        styles.delete(command.data)
+      end
+    end
+
+    def text?
+      styles.empty?
+    end
+
+    def element_attributes
+      return {} unless styles.any?
+      { style: styles_css }
+    end
+
+    def styles_css
+      styles.map { |style|
+        style_map.fetch(style)
+      }.inject({}, :merge).map { |key, value|
+        "#{key}: #{value};"
+      }.join
+    end
+  end
+end

data/lib/draftjs_exporter/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module DraftjsExporter
+  VERSION = '0.0.1'.freeze
+end

data/spec/integrations/html_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'draftjs_exporter/html'
+require 'draftjs_exporter/entities/link'
+
+RSpec.describe DraftjsExporter::HTML do
+  subject(:mapper) do
+    described_class.new(
+      entity_decorators: {
+        'LINK' => DraftjsExporter::Entities::Link.new
+      },
+      block_map: {
+        'header-one' => { element: 'h1' },
+        'unordered-list-item' => {
+          element: 'li',
+          wrapper: ['ul', { className: 'public-DraftStyleDefault-ul' }]
+        },
+        'unstyled' => { element: 'div' }
+      },
+      style_map: {
+        'ITALIC' => { fontStyle: 'italic' }
+      }
+    )
+  end
+
+  describe '#call' do
+    it 'decodes the content_state to html' do
+      input = {
+        entityMap: {
+          '0' => {
+            type: 'LINK',
+            mutability: 'MUTABLE',
+            data: {
+              url: 'http://example.com'
+            }
+          }
+        },
+        blocks: [
+          {
+            key: '5s7g9',
+            text: 'Header',
+            type: 'header-one',
+            depth: 0,
+            inlineStyleRanges: [],
+            entityRanges: []
+          },
+          {
+            key: 'dem5p',
+            text: 'some paragraph text',
+            type: 'unstyled',
+            depth: 0,
+            inlineStyleRanges: [
+              {
+                offset: 0,
+                length: 4,
+                style: 'ITALIC'
+              }
+            ],
+            entityRanges: [
+              {
+                offset: 5,
+                length: 9,
+                key: 0
+              }
+            ]
+          }
+        ]
+      }
+
+      expected_output = <<-OUTPUT.strip
+<h1>Header</h1><div>
+<span style="fontStyle: italic;">some</span> <a href="http://example.com">paragraph</a> text</div>
+      OUTPUT
+
+      expect(mapper.call(input)).to eq(expected_output)
+    end
+  end
+end

data/spec/integrations/requires_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe 'requires' do
+  describe 'draftjs_exporter' do
+    it 'can be required' do
+      expect { require('draftjs_exporter') }.to_not raise_error
+    end
+  end
+
+  describe 'draftjs_exporter/version' do
+    it 'can be required' do
+      expect { require('draftjs_exporter/version') }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'simplecov'
+require 'codeclimate-test-reporter'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::HTMLFormatter,
+      CodeClimate::TestReporter::Formatter
+    ]
+  )
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.order = :random
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: draftjs_exporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Theo Cushion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: |+
+  # Draft.js Exporter
+
+  [![Circle CI](https://circleci.com/gh/ignitionworks/draftjs_exporter/tree/master.svg?style=shield)](https://circleci.com/gh/ignitionworks/draftjs_exporter/tree/master)
+  [![Code Climate](https://codeclimate.com/github/ignitionworks/draftjs_exporter/badges/gpa.svg)](https://codeclimate.com/github/ignitionworks/draftjs_exporter)
+  [![Test Coverage](https://codeclimate.com/github/ignitionworks/draftjs_exporter/badges/coverage.svg)](https://codeclimate.com/github/ignitionworks/draftjs_exporter/coverage)
+
+  [Draft.js](https://facebook.github.io/draft-js/) is a framework for
+  building rich text editors. However, it does not support exporting
+  documents at HTML. This gem is designed to take the raw `ContentState`
+  (output of [`convertToRaw`](https://facebook.github.io/draft-js/docs/api-reference-data-conversion.html#converttoraw))
+  from Draft.js and convert it to HTML using Ruby.
+
+  ## Usage
+
+  ```ruby
+  # Create configuration for entities and styles
+  config = {
+    entity_decorators: {
+      'LINK' => DraftjsExporter::Entities::Link.new
+    },
+    block_map: {
+      'header-one' => { element: 'h1' },
+      'unordered-list-item' => {
+        element: 'li',
+        wrapper: ['ul', { className: 'public-DraftStyleDefault-ul' }]
+      },
+      'unstyled' => { element: 'div' }
+    },
+    style_map: {
+      'ITALIC' => { fontStyle: 'italic' }
+    }
+  }
+
+  # New up the exporter
+  exporter = DraftjsExporter::HTML.new(config)
+
+  # Provide raw content state
+  exporter.call({
+    entityMap: {
+      '0' => {
+        type: 'LINK',
+        mutability: 'MUTABLE',
+        data: {
+          url: 'http://example.com'
+        }
+      }
+    },
+    blocks: [
+      {
+        key: '5s7g9',
+        text: 'Header',
+        type: 'header-one',
+        depth: 0,
+        inlineStyleRanges: [],
+        entityRanges: []
+      },
+      {
+        key: 'dem5p',
+        text: 'some paragraph text',
+        type: 'unstyled',
+        depth: 0,
+        inlineStyleRanges: [
+          {
+            offset: 0,
+            length: 4,
+            style: 'ITALIC'
+          }
+        ],
+        entityRanges: [
+          {
+            offset: 5,
+            length: 9,
+            key: 0
+          }
+        ]
+      }
+    ]
+  })
+  # => "<h1>Header</h1><div>\n<span style=\"fontStyle: italic;\">some</span> <a href=\"http://example.com\">paragraph</a> text</div>"
+  ```
+
+  ## Tests
+
+  ```bash
+  $ rspec
+  ```
+
+email: theo@ignition.works
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/draftjs_exporter.rb
+- lib/draftjs_exporter/command.rb
+- lib/draftjs_exporter/entities/link.rb
+- lib/draftjs_exporter/entities/null.rb
+- lib/draftjs_exporter/entity_state.rb
+- lib/draftjs_exporter/html.rb
+- lib/draftjs_exporter/style_state.rb
+- lib/draftjs_exporter/version.rb
+- spec/integrations/html_spec.rb
+- spec/integrations/requires_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ignitionworks/draftjs_exporter
+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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Export Draft.js content state into HTML
+test_files: []