rtl_that_string 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7752966a23a6506f024aae2c5478d7d061e3dfb
-  data.tar.gz: 802bfd4e86b754ca146aa6b6a0498ee3cfa8b313
+  metadata.gz: 37d8425c91b11b96fac7e448aaef45b07c954639
+  data.tar.gz: 4061e2e831cd68a9395a87fde0d22bba1a23186a
 SHA512:
-  metadata.gz: 23429f639ae92867ee120f567dd5c1f389a103d4a53cc298232be0e678ccf97c7c81b896a6bda811962d77d959f26401a800aa177a303d80a6bf32f7a4ff4034
-  data.tar.gz: 6a78923725d71f68020cb966846b171c77756b9259cd04cfd812cf2a4d1f53798dd191388289b646803c1e7218152920de565004a2731876cef52fb6f2547324
+  metadata.gz: a999b66c40e1cedd1b0e98c9e46a871044487bfcdd703e043cb1e41bedcb1a0560310442bcf39ae4fc6d9bc9e972c8b5673e690464338a15d263f16ed671a73a
+  data.tar.gz: 763937007cf71f84ec3fdaee731de28fa86e72e1ea48108dc263d66cd36c9b71d4444945e86a4e7fb2088ee67c8087ecc919a5aea9319ac9c0b3f1664dddb276

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "bump/tasks"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/rtl_that_string/rtl_that_string.rb

@@ -0,0 +1,90 @@
+require 'string-direction'
+
+module RtlThatString
+  # String borders
+  # http://www.w3.org/International/questions/qa-bidi-unicode-controls#pairedcontrols
+  RTL_MARK = "\u202F".freeze  # RIGHT-TO-LEFT MARK
+  LTR_MARK = "\u202E".freeze  # LEFT-TO-RIGHT MARK
+  BIDI_START = "\u202B".freeze # RIGHT-TO-LEFT EMBEDDING (RLE)
+  BIDI_END   = "\u202C".freeze # POP DIRECTIONAL FORMATTING (PDF)
+
+  # Html wrapping tags
+  # http://www.w3.org/International/questions/qa-bidi-unicode-controls#correspondance
+  BDO_OPEN  = '<bdo dir="rtl">'.freeze
+  BDO_CLOSE = '</bdo>'.freeze
+  BDE_OPEN  = '<bde dir="rtl">'.freeze
+  BDE_CLOSE = '</bde>'.freeze
+
+  STRIP_TAGS_REGEX = /<.*?>/.freeze # Strip any html tag, with or without attributes
+
+  # Wrap plain text or html in direction control unicode characters or tags
+  #
+  # If the string is detected as all RTL characters it will be bordered with
+  # directional override characters. If it has mixed RTL and LTR it will get
+  # wrapped with bi-directional override characters.
+  #
+  # If the `html: true` option is passed the string will get wrapped in either
+  # a <bdo></bdo> or <bde></bde> tag.
+  def with_rtl(options = {})
+    return with_rtl_html(options) if options.delete(:html)
+
+    case direction
+    when StringDirection::RTL
+      rtl_string_borders
+    when StringDirection::BIDI
+      majority_rtl? ? bidi_string_borders : self
+    else
+      self
+    end
+  end
+
+  # Modifies self with the result from `with_rtl`
+  def with_rtl!(options = {})
+    self.replace with_rtl(options)
+  end
+
+  # Evaluate the direction of text in an HTML blob by first removing the HTML
+  # tags, then checking the plain text, then returning a wrapped blob of HTML
+  def with_rtl_html(options = {})
+    plain_text = self.gsub(STRIP_TAGS_REGEX, '')
+
+    case plain_text.direction
+    when StringDirection::RTL
+      rtl_html_borders
+    when StringDirection::BIDI
+      plain_text.majority_rtl? ? bidi_html_borders : self
+    else
+      self
+    end
+  end
+
+  protected
+
+  def majority_rtl?
+    dir_counts = split(' ').each_with_object({}) do |token, h|
+      dir = token.direction
+      h[dir] ||= 1
+      h[dir] += 1
+    end
+
+    dir_counts[StringDirection::RTL] > dir_counts[StringDirection::LTR]
+  end
+
+  private
+
+  def rtl_string_borders
+    prepend(RTL_MARK).concat(LTR_MARK)
+  end
+
+  def bidi_string_borders
+    prepend(BIDI_START).concat(BIDI_END)
+  end
+
+  def rtl_html_borders
+    prepend(BDO_OPEN).concat(BDO_CLOSE)
+  end
+
+  def bidi_html_borders
+    prepend(BDE_OPEN).concat(BDE_CLOSE)
+  end
+end

data/lib/rtl_that_string/version.rb

@@ -1,3 +1,3 @@
 module RtlThatString
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rtl_that_string.rb

@@ -1,6 +1,4 @@
 require 'rtl_that_string/version'
-require 'rtl_that_string/string'
-require 'rtl_that_string/safe_buffer' if defined?(ActiveSupport)
+require 'rtl_that_string/rtl_that_string'
 
-String.send :include, RtlThatString::String
-ActiveSupport::SafeBuffer.send :include, RtlThatString::SafeBuffer if defined?(ActiveSupport)
+String.send :include, RtlThatString

data/rtl_that_string.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bump"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtl_that_string
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Craig Day
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  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: Small library to wrap text/html in RTL markers/tags
 email:
 - cday@zendesk.com
@@ -69,9 +83,7 @@ files:
 - bin/console
 - bin/setup
 - lib/rtl_that_string.rb
-- lib/rtl_that_string/base.rb
-- lib/rtl_that_string/safe_buffer.rb
-- lib/rtl_that_string/string.rb
+- lib/rtl_that_string/rtl_that_string.rb
 - lib/rtl_that_string/version.rb
 - rtl_that_string.gemspec
 homepage: https://github.com/craig-day/

data/lib/rtl_that_string/base.rb

@@ -1,80 +0,0 @@
-require 'string-direction'
-
-module RtlThatString
-  module Base
-    # String borders
-    # http://www.w3.org/International/questions/qa-bidi-unicode-controls#pairedcontrols
-    RTL_START = "\u202F".freeze  # RIGHT-TO-LEFT MARK
-    RTL_END   = "\u202E".freeze  # LEFT-TO-RIGHT MARK
-    BIDI_START = "\u202B".freeze # RIGHT-TO-LEFT EMBEDDING (RLE)
-    BIDI_END   = "\u202C".freeze # POP DIRECTIONAL FORMATTING (PDF)
-
-    # Html wrapping tags
-    # http://www.w3.org/International/questions/qa-bidi-unicode-controls#correspondance
-    BDO_OPEN  = '<bdo dir="rtl">'.freeze
-    BDO_CLOSE = '</bdo>'.freeze
-    BDE_OPEN  = '<bde dir="rtl">'.freeze
-    BDE_CLOSE = '</bde>'.freeze
-
-    STRIP_TAGS_REGEX = /<.*?>/.freeze # Strip any html tag, with or without attributes
-
-    # Wrap plain text or html in direction control unicode characters or tags
-    #
-    # If the string is detected as all RTL characters it will be bordered with
-    # directional override characters. If it has mixed RTL and LTR it will get
-    # wrapped with bi-directional override characters.
-    #
-    # If the `html: true` option is passed the string will get wrapped in either
-    # a <bdo></bdo> or <bde></bde> tag.
-    def with_rtl(options = {})
-      return with_rtl_html(options) if options.delete(:html)
-
-      case direction
-      when StringDirection::RTL
-        rtl_string_borders
-      when StringDirection::BIDI
-        bidi_string_borders
-      else
-        self
-      end
-    end
-
-    # Modifies self with the result from `with_rtl`
-    def with_rtl!(options = {})
-      self.replace with_rtl(options)
-    end
-
-    # Evaluate the direction of text in an HTML blob by first removing the HTML
-    # tags, then checking the plain text, then returning a wrapped blob of HTML
-    def with_rtl_html(options = {})
-      plain_text = self.gsub(STRIP_TAGS_REGEX, '')
-
-      case plain_text.direction
-      when StringDirection::RTL
-        rtl_html_borders
-      when StringDirection::BIDI
-        bidi_html_borders
-      else
-        self
-      end
-    end
-
-    private
-
-    def rtl_string_borders
-      raise "must be implemented by submodule"
-    end
-
-    def bidi_string_borders
-      raise "must be implemented by submodule"
-    end
-
-    def rtl_html_borders
-      raise "must be implemented by submodule"
-    end
-
-    def bidi_html_borders
-      raise "must be implemented by submodule"
-    end
-  end
-end

data/lib/rtl_that_string/safe_buffer.rb

@@ -1,25 +0,0 @@
-require_relative './base'
-
-module RtlThatString
-  module SafeBuffer
-    include RtlThatString::Base
-
-    private
-
-    def rtl_string_borders
-      prepend(RTL_START).concat(RTL_END)
-    end
-
-    def bidi_string_borders
-      prepend(BIDI_START).concat(BIDI_END)
-    end
-
-    def rtl_html_borders
-      prepend(BDO_OPEN).concat(BDO_CLOSE)
-    end
-
-    def bidi_html_borders
-      prepend(BDE_OPEN).concat(BDE_CLOSE)
-    end
-  end
-end

data/lib/rtl_that_string/string.rb

@@ -1,25 +0,0 @@
-require_relative './base'
-
-module RtlThatString
-  module String
-    include RtlThatString::Base
-
-    private
-
-    def rtl_string_borders
-      "#{RTL_START}#{self}#{RTL_END}"
-    end
-
-    def bidi_string_borders
-      "#{BIDI_START}#{self}#{BIDI_END}"
-    end
-
-    def rtl_html_borders
-      "#{BDO_OPEN}#{self}#{BDO_CLOSE}"
-    end
-
-    def bidi_html_borders
-      "#{BDE_OPEN}#{self}#{BDE_CLOSE}"
-    end
-  end
-end