unicode-types 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b93d80fe62f3f1218284bf85048338b0d684c4c
+  data.tar.gz: 5eba94569c06428ceddf928034f85662fb0b1e13
+SHA512:
+  metadata.gz: 56e416f18e96a487038868b11dc39b5f18674d503a5b71af3a411d54a8e25aa652841465125d2d0519d3225dfdb79bb872abe4f789d47b70a6bd082dc75aae34
+  data.tar.gz: bfd61c8ca952d317d6a895bceffe1d4181e543e9f48e8add9eb0f6ca3035b9337115f3d81bbb07bd560f3aa8876d30de0f288beb5239a03259c5791b8d119b45

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_types_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,46 @@
+# Unicode::Types [![[version]](https://badge.fury.io/rb/unicode-types.svg)](http://badge.fury.io/rb/unicode-types)  [![[travis]](https://travis-ci.org/janlelis/unicode-types.png)](https://travis-ci.org/janlelis/unicode-types)
+
+Determine the basic type of codepoints. This can be one of:
+
+- Graphic
+- Format
+- Control
+- Private-use
+- Surrogate
+- Noncharacter
+- Reserved
+
+Unicode version: **8.0.0**
+
+Supported Rubies: **2.3**, **2.2**, **2.1**
+
+## Gemfile
+
+```ruby
+gem "unicode-types"
+```
+
+## Usage
+
+```ruby
+require "unicode/types"
+
+# All general types of a string
+Unicode::Types.types("A\tb") # => ["Control", "Graphic"]
+
+# Also aliased as .of 
+Unicode::Types.of("\u{FFFFF}") # => ["Noncharacter"]
+
+# Single codepoint
+Unicode::Types.type("\u{FFFFD}") # => "Reserved"
+```
+
+The list of types is always sorted alphabetically.
+
+See [unicode-x](https://github.com/janlelis/unicode-x) for more Unicode related micro libraries.
+
+## 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,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/types.rb

@@ -0,0 +1,35 @@
+require_relative "types/constants"
+
+module Unicode
+  module Types
+    def self.types(string)
+      res = []
+      string.each_char{ |char|
+        type_name = type(char)
+        res << type_name unless res.include?(type_name)
+      }   
+      res.sort
+    end 
+    class << self; alias of types; end 
+
+    def self.type(char)
+      require_relative 'types/index' unless defined? ::Unicode::Types::INDEX
+      codepoint_depth_offset = char.unpack("U")[0] or
+          raise(ArgumentError, "Unicode::Types.type must be given a valid char")
+      index_or_value = INDEX[:TYPES]
+      [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
+          return INDEX[:TYPE_NAMES][index_or_value.to_i]
+        end
+      }
+      INDEX[:TYPE_NAMES][index_or_value[codepoint_depth_offset].to_i]
+    end 
+
+    def self.names
+      require_relative 'types/index' unless defined? ::Unicode::Types::INDEX
+      INDEX[:TYPE_NAMES].dup
+    end
+  end
+end

data/lib/unicode/types/constants.rb

@@ -0,0 +1,9 @@
+module Unicode
+  module Types
+    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 + '/types.marshal.gz').freeze
+  end
+end
+

data/lib/unicode/types/index.rb

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

data/lib/unicode/types/string_ext.rb

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

data/spec/unicode_types_spec.rb

@@ -0,0 +1,58 @@
+require_relative "../lib/unicode/types"
+require "minitest/autorun"
+
+describe Unicode::Types do
+  describe ".types (alias .of)" do
+    it "will always return an Array" do
+      assert_equal [], Unicode::Types.of("")
+    end 
+
+    it "will return all types that characters in the string belong to" do
+      assert_equal ["Control", "Graphic"], Unicode::Types.of("A\tb")
+    end 
+
+    it "will return all types sorted order" do
+      assert_equal ["Control", "Graphic"], Unicode::Types.of("A\t")
+      assert_equal ["Control", "Graphic"], Unicode::Types.of("\tA")
+    end 
+
+    it "will call .type for every character" do
+      mocked_method = MiniTest::Mock.new
+      mocked_method.expect :call, "first type",  ["A"]
+      mocked_method.expect :call, "second type", ["2"]
+      Unicode::Types.stub :type, mocked_method do
+        Unicode::Types.of("A2")
+      end 
+      mocked_method.verify
+    end 
+  end
+
+  describe ".type" do
+    it "will return type for that character" do
+      assert_equal "Format", Unicode::Types.type("­")
+    end
+
+    it "will return Noncharacter for codepoints defined as noncharacter" do
+      assert_equal "Noncharacter", Unicode::Types.type("\u{10ffff}")
+    end
+
+    it "will return Reserved for unassigned codepoints" do
+      assert_equal "Reserved", Unicode::Types.type("\u{10c50}")
+    end
+  end
+
+  describe ".names" do
+    it "will return a list of all types" do
+      assert_equal %w[ 
+        Graphic
+        Format
+        Control
+        Private-use
+        Surrogate
+        Noncharacter
+        Reserved
+      ], Unicode::Types.names
+    end
+  end
+end
+

data/unicode-types.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/unicode/types/constants"
+
+Gem::Specification.new do |gem|
+  gem.name          = "unicode-types"
+  gem.version       = Unicode::Types::VERSION
+  gem.summary       = "Determine the basic type of codepoints."
+  gem.description   = "[Unicode version: #{Unicode::Types::UNICODE_VERSION}] Determine the basic type of codepoints (Graphic, Format, Control, Private-use, Surrogate, Noncharacter, Reserved)"
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["mail@janlelis.de"]
+  gem.homepage      = "https://github.com/janlelis/unicode-types"
+  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-types
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-15 00:00:00.000000000 Z
+dependencies: []
+description: "[Unicode version: 8.0.0] Determine the basic type of codepoints (Graphic,
+  Format, Control, Private-use, Surrogate, Noncharacter, Reserved)"
+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/types.marshal.gz
+- lib/unicode/types.rb
+- lib/unicode/types/constants.rb
+- lib/unicode/types/index.rb
+- lib/unicode/types/string_ext.rb
+- spec/unicode_types_spec.rb
+- unicode-types.gemspec
+homepage: https://github.com/janlelis/unicode-types
+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 basic type of codepoints.
+test_files:
+- spec/unicode_types_spec.rb
+has_rdoc: