unicode-sequence_name 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f90aef1fd7900075dc17fdb5517cf0c843677dd
+  data.tar.gz: b7d1d4752e6c2a4d5c80a226a168c9cde38d224e
+SHA512:
+  metadata.gz: fcaa17b122d4f483f4ec8d482b7b41921a7c833853ba196a8040d05f3241dd84559d4f37317c4e9c3ab73b64e4d35b8967027ad56e42cdc3a4350fb4068cc9e3
+  data.tar.gz: 8f0594bd6f5948b1f4ee56e227ff2ff81e12128c4bfb1e717a7842a2f8e8089ef2c5a286c2f8f93eb8ba35090149b5e0835dc0050ac7032adee796a2670c8e49

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/pkg

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+language: ruby
+
+script: bundle exec ruby spec/unicode_name_spec.rb
+
+rvm:
+- 2.4.1
+- 2.3.4
+- 2.2
+- 2.1
+- ruby-head
+- jruby-head
+- jruby-9.1.8.0
+
+cache:
+- bundler
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## CHANGELOG
+
+### 1.0.0
+
+* Initial release (Unicode 9.0, Emoji 5.0)
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@janlelis.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest'

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Jan Lelis, mail@janlelis.de
+
+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,34 @@
+# Unicode::SequenceName [![[version]](https://badge.fury.io/rb/unicode-sequence_name.svg)](http://badge.fury.io/rb/unicode-sequence_name)  [![[travis]](https://travis-ci.org/janlelis/unicode-sequence_name.png)](https://travis-ci.org/janlelis/unicode-sequence_name)
+
+Returns name of a Unicode codepoint sequence, if one exists.
+
+Unicode version: **9.0.0**
+
+Emoji version: **5.0**
+
+Supported Rubies: **2.4**, **2.3**, **2.2**, **2.1**
+
+## Usage
+
+```ruby
+require "unicode/sequence_name"
+
+# Name
+Unicode::SequenceName.of "‼︎" # => "DOUBLE EXCLAMATION MARK (text style)"
+Unicode::SequenceName.of "㓟︀" # => "CJK COMPATIBILITY IDEOGRAPH-2F81F"
+Unicode::SequenceName.of "င︀" # => "MYANMAR LETTER NGA (dotted form)"
+Unicode::SequenceName.of "நி" # => "TAMIL SYLLABLE NI"
+Unicode::SequenceName.of "🇺🇳" # => "UNITED NATIONS"
+Unicode::SequenceName.of "🏴󠁧󠁢󠁳󠁣󠁴󠁿" # => "SCOTLAND"
+```
+
+## Also See
+
+- [uniscribe](https://github.com/janlelis/unicode-x) - cli utility that makes use of unicode-sequence-name
+- [unicode-name](https://github.com/janlelis/unicode-name) - single codepoint names
+- [unicode-x](https://github.com/janlelis/unicode-x) - more Unicode related micro libraries
+
+## MIT License
+
+- Copyright (C) 2017 Jan Lelis <http://janlelis.com>. Released under the MIT license.
+- Unicode data: http://www.unicode.org/copyright.html#Exhibit1

data/Rakefile

@@ -0,0 +1,37 @@
+# # #
+# Get gemspec info
+
+gemspec_file = Dir['*.gemspec'].first
+gemspec = eval File.read(gemspec_file), binding, gemspec_file
+info = "#{gemspec.name} | #{gemspec.version} | " \
+       "#{gemspec.runtime_dependencies.size} dependencies | " \
+       "#{gemspec.files.size} files"
+
+# # #
+# Gem build and install task
+
+desc info
+task :gem do
+  puts info + "\n\n"
+  print "  "; sh "gem build #{gemspec_file}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  puts; sh %{gem install --no-document pkg/#{gemspec.name}-#{gemspec.version}.gem}
+end
+
+# # #
+# Start an IRB session with the gem loaded
+
+desc "#{gemspec.name} | IRB"
+task :irb do
+  sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
+end
+
+# # #
+# Run Specs
+
+desc "#{gemspec.name} | Spec"
+task :spec do
+  sh "for file in spec/*.rb; do ruby $file; done"
+end
+task default: :spec

data/lib/unicode/sequence_name/constants.rb

@@ -0,0 +1,10 @@
+module Unicode
+  module SequenceName
+    VERSION = "1.0.0".freeze
+    UNICODE_VERSION = "9.0.0".freeze
+    EMOJI_VERSION = "5.0".freeze
+    DATA_DIRECTORY = File.expand_path(File.dirname(__FILE__) + '/../../../data/').freeze
+    INDEX_FILENAME = (DATA_DIRECTORY + '/sequence_name.marshal.gz').freeze
+  end
+end
+

data/lib/unicode/sequence_name/index.rb

@@ -0,0 +1,7 @@
+require_relative 'constants'
+
+module Unicode
+  module SequenceName
+    INDEX = Marshal.load(Gem.gunzip(File.binread(INDEX_FILENAME)))
+  end
+end

data/lib/unicode/sequence_name/string_ext.rb

@@ -0,0 +1,8 @@
+require_relative "../sequence_name"
+
+class String
+  # Optional string extension for your convenience
+  def unicode_sequence_name
+    Unicode::SequenceName.of(self)
+  end
+end

data/lib/unicode/sequence_name.rb

@@ -0,0 +1,34 @@
+require_relative "sequence_name/constants"
+
+module Unicode
+  module SequenceName
+    def self.sequence_name(string)
+      codepoints = get_codepoint_values(string)
+      require_relative "sequence_name/index" unless defined? ::Unicode::SequenceName::INDEX
+      if res = INDEX[codepoints]
+        res
+      else
+        nil
+      end
+    end
+    class << self; alias of sequence_name; end
+
+    def self.get_codepoint_values(string)
+      if string.valid_encoding?
+        return string.codepoints
+      elsif string.encoding.name == "UTF-8"
+        begin
+          return string.unpack("U*")
+        rescue ArgumentError
+        end
+      end
+
+      raise(ArgumentError, "Unicode::SequenceName.of must be given a valid string")
+    end
+
+    class << self
+      private :get_codepoint_values
+    end
+  end
+end
+

data/spec/unicode_sequence_name_spec.rb

@@ -0,0 +1,21 @@
+require_relative "../lib/unicode/sequence_name"
+require "minitest/autorun"
+
+describe Unicode::SequenceName do
+  describe ".sequence_name (alias .of)" do
+    it "will return name for that sequence name" do
+      assert_equal "DOUBLE EXCLAMATION MARK (text style)", Unicode::SequenceName.of("‼︎")
+      assert_equal "CJK COMPATIBILITY IDEOGRAPH-2F81F", Unicode::SequenceName.of("㓟︀")
+      assert_equal "MYANMAR LETTER NGA (dotted form)", Unicode::SequenceName.of("င︀")
+      assert_equal "TAMIL SYLLABLE NI", Unicode::SequenceName.of("நி")
+      assert_equal "UNITED NATIONS", Unicode::SequenceName.of("🇺🇳")
+      assert_equal "SCOTLAND", Unicode::SequenceName.of("🏴󠁧󠁢󠁳󠁣󠁴󠁿")
+    end
+
+    it "will return nil for characters without name" do
+      assert_nil Unicode::SequenceName.of("\u{10c50}")
+      assert_nil Unicode::SequenceName.of("bla")
+    end
+  end
+end
+

data/unicode-sequence_name.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/unicode/sequence_name/constants"
+
+Gem::Specification.new do |gem|
+  gem.name          = "unicode-sequence_name"
+  gem.version       = Unicode::SequenceName::VERSION
+  gem.summary       = "Returns name of a Unicode codepoint sequence, if one exists"
+  gem.description   = "[Unicode #{Unicode::SequenceName::UNICODE_VERSION}] Returns name of a Unicode codepoint sequence, if one exists"
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["mail@janlelis.de"]
+  gem.homepage      = "https://github.com/janlelis/unicode-sequence_name"
+  gem.license       = "MIT"
+
+  gem.files         = Dir["{**/}{.*,*}"].select{ |path| File.file?(path) && path !~ /^pkg/ }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = "~> 2.0"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: unicode-sequence_name
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-02 00:00:00.000000000 Z
+dependencies: []
+description: "[Unicode 9.0.0] Returns name of a Unicode codepoint sequence, if one
+  exists"
+email:
+- mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- data/sequence_name.marshal.gz
+- lib/unicode/sequence_name.rb
+- lib/unicode/sequence_name/constants.rb
+- lib/unicode/sequence_name/index.rb
+- lib/unicode/sequence_name/string_ext.rb
+- spec/unicode_sequence_name_spec.rb
+- unicode-sequence_name.gemspec
+homepage: https://github.com/janlelis/unicode-sequence_name
+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.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Returns name of a Unicode codepoint sequence, if one exists
+test_files:
+- spec/unicode_sequence_name_spec.rb