sanscript 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d94fb9c3290ec64af941b806bb8cd78f0b66b442
+  data.tar.gz: 3e298a3b363a89081fbf603247f2b49a71144b8a
+SHA512:
+  metadata.gz: 8ed2a31fa2f140f4e0085638996cbf31693735d07348fb367505fa104a06a1d22834f18ac3cbc0696079ff0503729b0b64192c006ccce1945ad3de5737d8aef3
+  data.tar.gz: fe535ef6247b9d91ab23643566a2d9e86d7c144cdccf66f3ce6f8b18ba49830813c8d9c20e27c10fcb536c480cee25d504119bf2ba7f04d2676b49f59d4135d4

data/.codeclimate.yml

@@ -0,0 +1,9 @@
+---
+engines:
+  rubocop:
+    enabled: true
+  fixme:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"

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/.rubocop.yml

@@ -0,0 +1,97 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+# Metrics
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Reference: 'http://c2.com/cgi/wiki?AbcMetric'
+  Enabled: false
+  Max: 20
+
+Metrics/BlockNesting:
+  Description: 'Avoid excessive block nesting'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
+  Enabled: true
+  Max: 4
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 250 lines of code.'
+  Enabled: true
+  Max: 250
+
+Metrics/CyclomaticComplexity:
+  Description: >-
+                 A complexity metric that is strongly correlated to the number
+                 of test cases needed to validate a method.
+  Enabled: true
+  Max: 10
+
+Metrics/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
+  Enabled: false
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 40 lines of code.'
+  Enabled: true
+  Max: 40
+
+Metrics/ModuleLength:
+  Description: 'Avoid modules longer than 250 lines of code.'
+  Enabled: true
+  Max: 250
+
+Metrics/ParameterLists:
+  Description: 'Avoid parameter lists longer than three or four parameters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params'
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Description: >-
+                 A complexity metric geared towards measuring complexity for a
+                 human reader.
+  Enabled: false
+
+# Style
+Style/AsciiComments:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLiteral:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+  AllowPredicates: true

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+script: bundle exec rake spec SPEC_OPTS="--format p"
+addons:
+  code_climate:
+    repo_token: b4319eb676f021fb9473aa342324abd74f58d146e174f3cdf57f103bab052f25

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at nomoon@phoebus.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sanscript.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 learnsanskrit.org (original Javascript)
+Copyright (c) 2016 ported by Tim Bellefleur (Ruby port)
+
+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 @@
+# Sanscript.rb
+
+[![Build Status](https://travis-ci.org/ubcsanskrit/sanscript.rb.svg?branch=master)](https://travis-ci.org/ubcsanskrit/sanscript.rb)
+[![Code Climate](https://codeclimate.com/github/ubcsanskrit/sanscript.rb/badges/gpa.svg)](https://codeclimate.com/github/ubcsanskrit/sanscript.rb)
+[![Test Coverage](https://codeclimate.com/github/ubcsanskrit/sanscript.rb/badges/coverage.svg)](https://codeclimate.com/github/ubcsanskrit/sanscript.rb/coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/ubcsanskrit/sanscript.rb.svg)](https://gemnasium.com/github.com/ubcsanskrit/sanscript.rb)
+
+This gem is starting off as a mostly-straightforward port of [learnsanskrit.org's Sanscript.js](https://github.com/sanskrit/sanscript.js), and will go from there. It also incorporates transliteration scheme detection based on [learnsanskrit.org's Detect.js](https://github.com/sanskrit/detect.js).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sanscript'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanscript
+
+## Usage
+
+You can access detection through `Sanscript.detect(text)` and transliteration through `Sanscript.transliterate(text, from, to)`. Code should be fairly straightforward and partially documented.
+
+## 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/ubcsanskrit/sanscript. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,7 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sanscript"
+
+# 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

data/bin/setup

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

data/lib/sanscript.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require "sanscript/version"
+require "sanscript/detect"
+require "sanscript/transliterate"
+require "sanscript/benchmark"
+
+module Sanscript
+  module_function
+
+  # Proxies the Detect.detect_script method
+  #
+  def detect(text)
+    Detect.detect_script(text)
+  end
+
+  # The transliterate method accepts multiple signatures
+  #   .transliterate(text, to) will auto-detect the source script
+  #   .transliterate(text, to, from) will specify the source and target script
+  #
+  #   Final Hash arguments are passed along as options.
+  #
+  def transliterate(text, first, second = nil, **options)
+    if second.nil?
+      second = first
+      first = Detect.detect_script(text)
+    end
+    Transliterate.transliterate(text, first, second, options)
+  end
+end

data/lib/sanscript/benchmark.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "sanscript/refinements"
+require "benchmark"
+
+module Sanscript
+  using Refinements
+  module Benchmark
+    module_function
+
+    def detection!
+      n = 100_000
+      iast_string = "nānāśāstrasubhāṣitāmṛtarasaiḥ śrotrotsavaṃ kurvatāṃ yeṣāṃ yānti dināni paṇḍitajanavyāyāmakhinnātmanām teṣāṃ janma ca jīvitaṃ ca sukṛtaṃ tair eva bhūr bhūṣitā śeṣaih kiṃ paśuvad vivekarahitair bhūbhārabhūtair naraḥ"
+      deva_string = "नानाशास्त्रसुभाषितामृतरसैः श्रोत्रोत्सवं कुर्वतां येषां यान्ति दिनानि पण्डितजनव्यायामखिन्नात्मनाम् तेषां जन्म च जीवितं च सुकृतं तैर् एव भूर् भूषिता शेषैह् किं पशुवद् विवेकरहितैर् भूभारभूतैर् नरः"
+
+      ::Benchmark.bmbm(18) do |x|
+        x.report("Detect IAST") do
+          n.times { raise unless Sanscript.detect(iast_string) == :iast }
+        end
+        x.report("Detect Devanagari") do
+          n.times { raise unless Sanscript.detect(deva_string) == :devanagari }
+        end
+      end
+    end
+
+    def transliteration!
+      n = 5_000
+      iast_string = "nānāśāstrasubhāṣitāmṛtarasaiḥ śrotrotsavaṃ kurvatāṃ yeṣāṃ yānti dināni paṇḍitajanavyāyāmakhinnātmanām teṣāṃ janma ca jīvitaṃ ca sukṛtaṃ tair eva bhūr bhūṣitā śeṣaih kiṃ paśuvad vivekarahitair bhūbhārabhūtair naraḥ"
+
+      deva_string = "नानाशास्त्रसुभाषितामृतरसैः श्रोत्रोत्सवं कुर्वतां येषां यान्ति दिनानि पण्डितजनव्यायामखिन्नात्मनाम् तेषां जन्म च जीवितं च सुकृतं तैर् एव भूर् भूषिता शेषैह् किं पशुवद् विवेकरहितैर् भूभारभूतैर् नरः"
+      ::Benchmark.bmbm(18) do |x|
+        x.report("IAST**>Devanagari") do
+          n.times { Sanscript.transliterate(iast_string, :devanagari) }
+        end
+        x.report("IAST==>Devanagari") do
+          n.times { Sanscript.transliterate(iast_string, :iast, :devanagari) }
+        end
+        x.report("IAST**>SLP1") do
+          n.times { Sanscript.transliterate(iast_string, :slp1) }
+        end
+        x.report("IAST==>SLP1") do
+          n.times { Sanscript.transliterate(iast_string, :iast, :slp1) }
+        end
+        x.report("Devanagari**>SLP1") do
+          n.times { Sanscript.transliterate(deva_string, :slp1) }
+        end
+        x.report("Devanagari**>IAST") do
+          n.times { Sanscript.transliterate(deva_string, :iast) }
+        end
+      end
+    end
+  end
+end

data/lib/sanscript/detect.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+#
+# Developed from code available @ https://github.com/sanskrit/detect.js
+#
+module Sanscript
+  module Detect
+    # Match any character in the block of Brahmic scripts
+    # between Devanagari and Malayalam.
+    RE_BRAHMIC_RANGE = /[\u0900-\u0d7f]/
+
+    # Match each individual Brahmic script.
+    RE_BRAHMIC_SCRIPTS = {
+      devanagari: /\p{Devanagari}/,
+      bengali: /\p{Bengali}/,
+      gurmukhi: /\p{Gurmukhi}/,
+      gujarati: /\p{Gujarati}/,
+      oriya: /\p{Oriya}/,
+      tamil: /\p{Tamil}/,
+      telugu: /\p{Telugu}/,
+      kannada: /\p{Kannada}/,
+      malayalam: /\p{Malayalam}/,
+    }.freeze
+
+    # Match on special Roman characters
+    RE_IAST_OR_KOLKATA_ONLY = /[āīūṛṝḷḹēōṃḥṅñṭḍṇśṣḻ]/i
+
+    # Match on Kolkata-specific Roman characters
+    RE_KOLKATA_ONLY = /[ēō]/i
+
+    # Match on ITRANS-only
+    RE_ITRANS_ONLY = /ee|oo|\^[iI]|RR[iI]|L[iI]|~N|N\^|Ch|chh|JN|sh|Sh|\.a/
+
+    # Match on SLP1-only characters and bigrams
+    RE_SLP1_ONLY = /[fFxXEOCYwWqQPB]|kz|Nk|Ng|tT|dD|Sc|Sn|[aAiIuUfFxXeEoO]R|G[yr]|(\\W|^)G'/
+
+    # Match on Velthuis-only characters
+    RE_VELTHUIS_ONLY = /\.[mhnrlntds]|"n|~s/
+
+    # Match on chars shared by ITRANS and Velthuis
+    RE_ITRANS_OR_VELTHUIS_ONLY = /aa|ii|uu|~n/
+
+    # Match on characters unavailable in Harvard-Kyoto
+    RE_HARVARD_KYOTO = /[aAiIuUeoRMHkgGcjJTDNtdnpbmyrlvzSsh]/
+
+    private_constant :RE_BRAHMIC_RANGE, :RE_BRAHMIC_SCRIPTS, :RE_IAST_OR_KOLKATA_ONLY,
+                     :RE_KOLKATA_ONLY, :RE_ITRANS_ONLY, :RE_SLP1_ONLY, :RE_VELTHUIS_ONLY,
+                     :RE_ITRANS_OR_VELTHUIS_ONLY, :RE_HARVARD_KYOTO
+
+    module_function
+
+    def detect_script(text)
+      # Brahmic schemes are all within a specific range of code points.
+      if text =~ RE_BRAHMIC_RANGE
+        RE_BRAHMIC_SCRIPTS.each do |script, regex|
+          return script if text =~ regex
+        end
+      end
+
+      # Romanizations
+      if text =~ RE_IAST_OR_KOLKATA_ONLY
+        text =~ RE_KOLKATA_ONLY ? :kolkata : :iast
+      elsif text =~ RE_ITRANS_ONLY
+        :itrans
+      elsif text =~ RE_SLP1_ONLY
+        :slp1
+      elsif text =~ RE_VELTHUIS_ONLY
+        :velthuis
+      elsif text =~ RE_ITRANS_OR_VELTHUIS_ONLY
+        :itrans
+      elsif text =~ RE_HARVARD_KYOTO
+        :hk
+      else
+        :unknown
+      end
+    end
+  end
+end