unicode-categories 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5ffea705e0ea825e2da7d52510acc2d07542f34
+  data.tar.gz: 807bf0ab0e1fee003ab34d39f20a8383573fe029
+SHA512:
+  metadata.gz: 83e66060a6505ceee287bab54743ae5ff2a16719d3d4faf126b7a18448f6316660f4c0aa14d0658783d1482fe622c0e402eb948dc5b3d22ebf46b54fc867d20a
+  data.tar.gz: 5700854254d1d80e15d6459d3fed41f0a3c69e64437408eb244e1747e23e3597b0462637af7c2fb838b670f046ab2bb89931573db12e09fc2911c902ca1d6141

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+language: ruby
+
+script: bundle exec ruby spec/unicode_categories_spec.rb
+
+rvm:
+- 2.3.0
+- 2.2
+- 2.1
+- ruby-head
+- rbx-2
+- jruby-head
+- jruby-9.0.5.0
+
+cache:
+- bundler
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## CHANGELOG
+
+### 1.0.0
+
+* Inital release
+

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) 2016 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,92 @@
+# Unicode::Categories [![[version]](https://badge.fury.io/rb/unicode-categories.svg)](http://badge.fury.io/rb/unicode-categories)  [![[travis]](https://travis-ci.org/janlelis/unicode-categories.png)](https://travis-ci.org/janlelis/unicode-categories)
+
+Returns which [General Categories](https://en.wikipedia.org/wiki/Unicode_character_property#General_Category) are contained in Unicode string.
+
+Unicode version: **8.0.0**
+
+Supported Rubies: **2.3**, **2.2**, **2.1**
+
+## Gemfile
+
+```ruby
+gem "unicode-categories"
+```
+
+## Usage
+
+```ruby
+require "unicode/categories"
+
+# All general categories of a string
+Unicode::Categories.categories("A 2") # => ["Lu", "Nd", "Zs"]
+Unicode::Categories.categories("A 2", format: :long)
+# => ["Decimal_Number", "Space_Separator", "Uppercase_Letter"]
+
+# Also aliased as .of 
+Unicode::Categories.of("\u{10c50}") # => ["Cn"]
+
+# Single character
+Unicode::Categories.category("☼", format: :long) # => "Other_Symbol"
+```
+
+The list of categories is always sorted alphabetically.
+
+## Hints
+
+### Regex Matching
+
+If you have a string and want to match a substring/character from a specific Unicode block, you actually won't need this gem. Instead, you can use the [Regexp Unicode Property Syntax `\p{}`](http://ruby-doc.org/core-2.3.0/Regexp.html#class-Regexp-label-Character+Properties):
+
+```ruby
+"Find decimal numbers (like 2 or 3) within a string".scan(/\p{Nd}+/) # => ["2", "3"]
+```
+
+### List of General Categories
+
+You can retrieve a list of all General Categories like this:
+
+```ruby
+require "unicode/categories"
+puts Unicode::Categories.names
+
+# # # Output # # #
+
+Cc
+Cf
+Cn
+Co
+Cs
+LC
+Ll
+Lm
+Lo
+Lt
+Lu
+Mc
+Me
+Mn
+Nd
+Nl
+No
+Pc
+Pd
+Pe
+Pf
+Pi
+Po
+Ps
+Sc
+Sk
+Sm
+So
+Zl
+Zp
+Zs
+```
+
+
+## MIT License
+
+- Copyright (C) 2016 Jan Lelis <http://janlelis.com>. Released under the MIT license.
+- Unicode data: http://www.unicode.org/copyright.html#Exhibit1
+

data/Rakefile

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

data/lib/unicode/categories.rb

@@ -0,0 +1,45 @@
+require_relative "categories/constants"
+
+module Unicode
+  module Categories
+    def self.categories(string, **options)
+      res = []
+      string.each_char{ |char|
+        category_name = category(char, **options)
+        res << category_name unless res.include?(category_name)
+      }   
+      res.sort
+    end 
+    class << self; alias of categories; end 
+
+    def self.category(char, format: :short)
+      require_relative 'categories/index' unless defined? ::Unicode::Categories::INDEX
+      codepoint_depth_offset = char.unpack("U")[0] or
+          raise(ArgumentError, "Unicode::Categories.category must be given a valid char")
+      index_or_value = INDEX[:CATEGORIES]
+      [0x10000, 0x1000, 0x100, 0x10].each{ |depth|
+        index_or_value         = index_or_value[codepoint_depth_offset / depth]
+        codepoint_depth_offset = codepoint_depth_offset % depth
+        unless index_or_value.is_a? Array
+          res = index_or_value || "Cn"
+          return format == :long ? INDEX[:CATEGORY_NAMES][res] : res
+        end
+      }
+
+      res = index_or_value[codepoint_depth_offset] || "Cn"
+      format == :long ? INDEX[:CATEGORY_NAMES][res] : res
+    end 
+
+    def self.names(format: :short)
+      require_relative 'categories/index' unless defined? ::Unicode::Categories::INDEX
+      case format
+      when :long
+        INDEX[:CATEGORY_NAMES].values.sort
+      when :short
+        INDEX[:CATEGORY_NAMES].keys.sort
+      when :table
+        INDEX[:CATEGORY_NAMES].dup
+      end
+    end
+  end
+end

data/lib/unicode/categories/constants.rb

@@ -0,0 +1,9 @@
+module Unicode
+  module Categories
+    VERSION = "1.0.0".freeze
+    UNICODE_VERSION = "8.0.0".freeze
+    DATA_DIRECTORY = File.expand_path(File.dirname(__FILE__) + '/../../../data/').freeze
+    INDEX_FILENAME = (DATA_DIRECTORY + '/categories.marshal.gz').freeze
+  end
+end
+

data/lib/unicode/categories/index.rb

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

data/lib/unicode/categories/string_ext.rb

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

data/spec/unicode_categories_spec.rb

@@ -0,0 +1,57 @@
+require_relative "../lib/unicode/categories"
+require "minitest/autorun"
+
+describe Unicode::Categories do
+  describe ".categories (alias .of)" do
+    it "will always return an Array" do
+      assert_equal [], Unicode::Categories.of("")
+    end 
+
+    it "will return all categories that characters in the string belong to" do
+      assert_equal ["Lu", "Nd", "Zs"], Unicode::Categories.of("A 2")
+    end 
+
+    it "will return long identifiers for format: :long option" do
+      assert_equal ["Decimal_Number", "Space_Separator", "Uppercase_Letter"],
+          Unicode::Categories.of("A 2", format: :long)
+    end 
+
+    it "will return all categories sorted order" do
+      assert_equal ["Lu", "Nd"], Unicode::Categories.of("A2")
+      assert_equal ["Lu", "Nd"], Unicode::Categories.of("2A")
+    end 
+
+    it "will call .category for every character" do
+      mocked_method = MiniTest::Mock.new
+      mocked_method.expect :call, "first category",  ["A", {}]
+      mocked_method.expect :call, "second category", ["2", {}]
+      Unicode::Categories.stub :category, mocked_method do
+        Unicode::Categories.of("A2")
+      end 
+      mocked_method.verify
+    end 
+  end
+
+  describe ".category" do
+    it "will return category for that character" do
+      assert_equal "So", Unicode::Categories.category("�")
+    end
+
+    it "will return Cn for unassigned codepoints" do
+      assert_equal "Cn", Unicode::Categories.category("\u{10c50}")
+    end
+  end
+
+  describe ".names" do
+    it "will return a list of all categories" do
+      assert_kind_of Array, Unicode::Categories.names
+      assert_includes Unicode::Categories.names, "Sc"
+    end
+
+    it "will return a list of all long category names when used with format: :long" do
+      assert_kind_of Array, Unicode::Categories.names(format: :long)
+      assert_includes Unicode::Categories.names(format: :long), "Currency_Symbol"
+    end
+  end
+end
+

data/unicode-categories.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/unicode/categories/constants"
+
+Gem::Specification.new do |gem|
+  gem.name          = "unicode-categories"
+  gem.version       = Unicode::Categories::VERSION
+  gem.summary       = "Determine the Unicode General Categories of a string."
+  gem.description   = "[Unicode version: #{Unicode::Categories::UNICODE_VERSION}] Determine which Unicode General Categories a string belongs to."
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["mail@janlelis.de"]
+  gem.homepage      = "https://github.com/janlelis/unicode-categories"
+  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,62 @@
+--- !ruby/object:Gem::Specification
+name: unicode-categories
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-13 00:00:00.000000000 Z
+dependencies: []
+description: "[Unicode version: 8.0.0] Determine which Unicode General Categories
+  a string belongs to."
+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/categories.marshal.gz
+- lib/unicode/categories.rb
+- lib/unicode/categories/constants.rb
+- lib/unicode/categories/index.rb
+- lib/unicode/categories/string_ext.rb
+- spec/unicode_categories_spec.rb
+- unicode-categories.gemspec
+homepage: https://github.com/janlelis/unicode-categories
+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.3
+signing_key: 
+specification_version: 4
+summary: Determine the Unicode General Categories of a string.
+test_files:
+- spec/unicode_categories_spec.rb
+has_rdoc: