rtl-string 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 461df237cf8844d39ee350d4c8c07ee8a62ea8f6
+  data.tar.gz: 85ba4f993a18f717f7713d76fc292ea0d49181b1
+SHA512:
+  metadata.gz: 8cc3b12d769636d6a894162d7a3c4203e420d429ba0a7f1bca7009fcdc07f17c908e595827e136235822b3cdd977d1415db55089dcd74230d7bca24447e44f88
+  data.tar.gz: cc4766d0fe09f2dd83d0ce7cc037563cf53f918a6bb485bfa283bb196443edf72408e00df6d7e86b1f2b207d32bc703c5fef916be142bf691aa6ab6e8f88e12a

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "pry-nav"
+end
+
+group :test do
+  gem "rspec"
+  gem "rr"
+end

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* Birthday!

data/LICENSE

@@ -0,0 +1,177 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,47 @@
+rtl-string
+==========
+
+Easier string manipulation for people who come from LTR backgrounds.
+
+### Usage
+
+Create a new `RtlString` instance with some Arabic text.  Calling `.to_s` will show an LTR representation of the string.  You should read it from left to right, just like you would an English string:
+
+```ruby
+arabic_str = [1575, 1605, 32, 98, 108, 97, 114, 103, 32, 1576, 1573, 1590].pack("U*")
+RtlString.new(arabic_str).to_s  # => "[alef][meem] blarg [beh][alef - hamza below][dad]"
+```
+
+You can also call `.to_rtl_s` on a regular string:
+
+```ruby
+arabic_str.to_rtl_s  # => "[alef][meem] blarg [beh][alef - hamza below][dad]"
+```
+
+### String Operations
+
+Instances of `RtlString` respond to a few additional string operations, including `delete_at`, `insert`, `[]`, and `size`:
+
+```ruby
+str = arabic_str.to_rtl_s
+str.delete_at(1)  # => "[meem]"
+str.delete_range(1..2)
+str.insert([1605].pack("U*"), 1)
+str.to_s          # => "[alef][meem][meem] blarg [beh][alef - hamza below][dad]"
+str[1]            # => "[meem]
+str[1..3]         # => "[meem] b"
+str.size          # => 12
+str.length        # => 12
+```
+
+### Requirements
+
+Depends on the  [twitter-cldr-rb](https://github.com/twitter/twitter-cldr-rb) gem.
+
+### Running Tests
+
+`bundle exec rspec`
+
+### Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+require 'bundler'
+require 'digest'
+
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/rtl_string'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/lib/rtl-string/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+class RtlString
+  VERSION = "1.0.0"
+end

data/lib/rtl_string.rb

@@ -0,0 +1,92 @@
+# encoding: UTF-8
+
+require 'twitter_cldr'
+
+class RtlString
+  RTL_RANGES = [
+    0x0600..0x06FF,
+    0x0750..0x077F,
+    0x0590..0x05FF,
+    0xFE70..0xFEFF,
+  ]
+
+  attr_reader :string
+
+  def initialize(string)
+    @string = string
+  end
+
+  def to_s
+    string.localize.code_points.inject("") do |ret, code_point|
+      ret << if is_rtl?(code_point)
+        "[#{name_for(code_point)}]"
+      else
+        [code_point].pack("U*")
+      end
+    end
+  end
+
+  def inspect
+    to_s.inspect
+  end
+
+  def delete_at(index)
+    code_points = string.localize.code_points
+    deleted = code_points.delete_at(index)
+    @string = code_points.pack("U*")
+    self.class.new([deleted].pack("U*"))
+  end
+
+  def delete_range(range)
+    code_points = string.localize.code_points
+    range.each do |i|
+      code_points.delete_at(range.first)
+    end
+    @string = code_points.pack("U*")
+    nil
+  end
+
+  def [](index_or_range)
+    code_points = string.localize.code_points
+    selected = code_points[index_or_range]
+    self.class.new((selected.is_a?(Array) ? selected : [selected]).pack("U*"))
+  end
+
+  def insert(str, index)
+    code_points = string.localize.code_points
+    code_points.insert(index, *str.localize.code_points)
+    @string = code_points.pack("U*")
+    self
+  end
+
+  def size
+    string.localize.size
+  end
+
+  alias :length :size
+
+  private
+
+  def is_rtl?(code_point)
+    RTL_RANGES.any? { |range| range.include?(code_point) }
+  end
+
+  def name_for(code_point)
+    unicode_data = TwitterCldr::Shared::CodePoint.find(code_point)
+    name_cache[code_point] ||= unicode_data.name
+      .gsub(/(:?ARABIC|HEBREW)(:?\sLETTER\s|\sSIGN\s|\-INDIC\s)?/, "")
+      .gsub("WITH", "-")
+      .strip
+      .downcase
+  end
+
+  def name_cache
+    @@name_cache ||= {}
+  end
+end
+
+class String
+  def to_rtl_s
+    RtlString.new(self)
+  end
+end

data/rtl-string.gemspec

@@ -0,0 +1,20 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rtl-string/version'
+
+Gem::Specification.new do |s|
+  s.name     = "rtl-string"
+  s.version  = ::RtlString::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["cdutro@twitter.com"]
+  s.homepage = "https://github.com/camertron"
+
+  s.description = s.summary = "Easier string manipulation for people who come from LTR backgrounds."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'twitter_cldr'
+
+  s.require_path = 'lib'
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "LICENSE", "Rakefile", "README.md", "rtl-string.gemspec"]
+end

data/spec/rtl_string_spec.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+describe String do
+  describe "#to_rtl_s" do
+    it "should return an instance of RtlString" do
+      "abc".to_rtl_s.should be_a(RtlString)
+    end
+  end
+end
+
+describe RtlString do
+  let(:str) do
+    [
+      1602, 1575, 1605,
+      32, 98, 108, 97, 114, 103, 32,
+      1576, 1573, 1590, 1575, 1601, 1578, 1603,
+    ].pack("U*")
+  end
+
+  let(:representation) do
+    "[qaf][alef][meem] blarg [beh][alef - hamza below][dad][alef][feh][teh][kaf]"
+  end
+
+  before(:each) do
+    @rtl_str = RtlString.new(str)
+  end
+
+  describe "#to_s" do
+    it "should correctly display rtl characters in byte order and with placeholders" do
+      @rtl_str.to_s.should == representation
+    end
+  end
+
+  describe "#inspect" do
+    it "uses to_s to represent the string" do
+      @rtl_str.inspect.should == "\"#{representation}\""
+    end
+  end
+
+  describe "#delete_at" do
+    it "removes characters from the string" do
+      @rtl_str.delete_at(2).to_s.should == "[meem]"
+      @rtl_str.to_s.should == "[qaf][alef] blarg [beh][alef - hamza below][dad][alef][feh][teh][kaf]"
+    end
+  end
+
+  describe "#delete_range" do
+    it "removes a range of characters from the string" do
+      @rtl_str.delete_range(10..12).should be_nil
+      @rtl_str.to_s.should == "[qaf][alef][meem] blarg [alef][feh][teh][kaf]"
+    end
+  end
+
+  describe "#insert" do
+    it "inserts characters into the string" do
+      @rtl_str.insert([1576].pack("U*"), 2).should eql(@rtl_str)
+      @rtl_str.to_s.should == "[qaf][alef][beh][meem] blarg [beh][alef - hamza below][dad][alef][feh][teh][kaf]"
+    end
+  end
+
+  describe "#[]" do
+    it "retrieves the character at the specified index" do
+      @rtl_str[2].tap do |char|
+        char.should be_a(RtlString)
+        char.to_s.should == "[meem]"
+      end
+    end
+
+    it "retrieves a range of characters" do
+      @rtl_str[2..5].tap do |chars|
+        chars.should be_a(RtlString)
+        chars.to_s.should == "[meem] bl"
+      end
+    end
+  end
+
+  describe "#size" do
+    it "returns the length of the string by number of actual chars" do
+      @rtl_str.size.should == 17
+    end
+  end
+
+  describe "#length" do
+    it "returns the length of the string by number of actual chars" do
+      @rtl_str.length.should == 17
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+require 'rspec'
+require 'rtl_string'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rtl-string
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter_cldr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easier string manipulation for people who come from LTR backgrounds.
+email:
+- cdutro@twitter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rtl-string/version.rb
+- lib/rtl_string.rb
+- spec/rtl_string_spec.rb
+- spec/spec_helper.rb
+- Gemfile
+- History.txt
+- LICENSE
+- Rakefile
+- README.md
+- rtl-string.gemspec
+homepage: https://github.com/camertron
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Easier string manipulation for people who come from LTR backgrounds.
+test_files: []
+has_rdoc: true