rtl_that_string 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7752966a23a6506f024aae2c5478d7d061e3dfb
+  data.tar.gz: 802bfd4e86b754ca146aa6b6a0498ee3cfa8b313
+SHA512:
+  metadata.gz: 23429f639ae92867ee120f567dd5c1f389a103d4a53cc298232be0e678ccf97c7c81b896a6bda811962d77d959f26401a800aa177a303d80a6bf32f7a4ff4034
+  data.tar.gz: 6a78923725d71f68020cb966846b171c77756b9259cd04cfd812cf2a4d1f53798dd191388289b646803c1e7218152920de565004a2731876cef52fb6f2547324

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rtl_that_string.gemspec
+gemspec
+
+gem 'string-direction', '~> 0.0.4', :git => 'git@github.com:craig-day/string-direction.git', :branch => 'craig-day/cleanup' # https://github.com/waiting-for-dev/string-direction/pull/1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Craig Day
+
+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,43 @@
+# RtlThatString
+
+RtlThatString is a small, simple gem that helps support right-to-left text and html based on content.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rtl_that_string'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rtl_that_string
+
+## Usage
+
+```ruby
+require 'rtl_that_string'
+
+"هذا اختبار".with_rtl
+# => "\u202Fهذا اختبار\u202E"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/craig-day/rtl_that_string.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rtl_that_string"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rtl_that_string/base.rb

@@ -0,0 +1,80 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,25 @@
+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

data/lib/rtl_that_string/version.rb

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

data/lib/rtl_that_string.rb

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

data/rtl_that_string.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rtl_that_string/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rtl_that_string"
+  spec.version       = RtlThatString::VERSION
+  spec.authors       = ["Craig Day"]
+  spec.email         = ["cday@zendesk.com"]
+
+  spec.summary       = %q{Small library to wrap text/html in RTL markers/tags}
+  spec.description   = %q{Small library to wrap text/html in RTL markers/tags}
+  spec.homepage      = "https://github.com/craig-day/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rtl_that_string
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Craig Day
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/version.rb
+- rtl_that_string.gemspec
+homepage: https://github.com/craig-day/
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Small library to wrap text/html in RTL markers/tags
+test_files: []
+has_rdoc: