unaccent 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fd05234b8a82c9fb4528e7490bc96d35d6004891106e64b89a41c3019fb05d
-  data.tar.gz: c8878cdf36d7647264676d22b6068398a9c5a4c67dc48a65a7e2033a9d65e97c
+  metadata.gz: 1f56e5660dbb7639bb9ef70628cd7ecbcfc2c7bc7ae7bdb69e2a8ab2e5c9638e
+  data.tar.gz: 54bd414076246db4389c6646200c59eebd1372c445f3813b723ab29da3634dde
 SHA512:
-  metadata.gz: 8fddd65833fc29aaaee6dd35088181403803714bd54d0dccfaa499dad55928c2263db27561cdefa0a565d0bb587a64d969f2523a3a87994caa9935b530a1461b
-  data.tar.gz: 33b518cba22b0919320a1b4ac65bd4406b2dac1b2cbe17b63448a59ea132967a2014120dc5ca461e74de9fa4cf782ceb9422fe548a56538c204ec723c6549457
+  metadata.gz: 9d8a3cfb89f5771db43ebf2aefa0e767d4777ebf762fe4847af25966df9b2cf69da28ddebc7f3c158bf8d069eba77f01174021e22b9dc267e8ddeb2334e31b28
+  data.tar.gz: 65937e76c7d787b76cd4d7a5509469ac00d6abfa6ceadb825b031c5b15ba9533c97de71439c46a73e34e58ae46f9ccb9a026622d1333e1779161ab42c04403cd

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--exclude lib/unaccent/accentmap.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+# Code of Conduct
+
+All participants of this project are expected to abide by our Code of Conduct, both online and during in-person events that are hosted and/or associated with this project.
+
+## The Pledge
+
+In the interest of fostering an open and welcoming environment, we pledge to make 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.
+
+## The Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Referring to people by their preferred pronouns and using gender-neutral pronouns when uncertain
+* 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
+* Dismissing or attacking inclusion-oriented requests
+
+## Enforcement
+
+Violations of the Code of Conduct may be reported by sending an email to info@hardpixel.eu. All reports will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Further details of specific enforcement policies may be posted separately.
+
+We hold the right and responsibility to remove comments or other contributions that are not aligned to this Code of Conduct, or to suspend temporarily or permanently any members for other behaviors that are inappropriate, threatening, offensive, or harmful.
+
+## Attribution
+
+This Code of Conduct is adapted from [dev.to](https://dev.to/code-of-conduct).

data/LICENSE.txt

@@ -1,5 +1,6 @@
 The MIT License (MIT)
 
+Copyright (c) 2010-2019 Joel Parker Henderson
 Copyright (c) 2022 Jonian Guveli
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.md

@@ -1,6 +1,6 @@
 # Unaccent
 
-Ruby gem to replace a string's accent characters with ASCII characters. Based on [SixArm Ruby Unaccent](https://github.com/SixArm/sixarm_ruby_unaccent).
+Ruby gem to replace a string's accent characters with unaccented characters. Based on [SixArm Ruby Unaccent](https://github.com/SixArm/sixarm_ruby_unaccent).
 
 [![Gem Version](https://badge.fury.io/rb/unaccent.svg)](https://badge.fury.io/rb/unaccent)
 [![Build](https://github.com/hardpixel/unaccent/actions/workflows/build.yml/badge.svg)](https://github.com/hardpixel/unaccent/actions/workflows/build.yml)
@@ -39,24 +39,28 @@ require 'unaccent/string'
 ## Benchmark
 
 ```
-IPS Comparison:
-                gsub:    33804.1 i/s
-           each_char:    16639.9 i/s - 2.03x  (± 0.00) slower
-  each_char (sixarm):    13708.2 i/s - 2.47x  (± 0.00) slower
-                scan:    10390.0 i/s - 3.25x  (± 0.00) slower
-       scan (sixarm):     8765.8 i/s - 3.86x  (± 0.00) slower
-           split_map:     7800.9 i/s - 4.33x  (± 0.00) slower
-  split_map (sixarm):     6780.7 i/s - 4.99x  (± 0.00) slower
-
-
-Memory Comparison:
-                gsub:       5947 allocated
-           each_char:      10704 allocated - 1.80x more
-                scan:      15368 allocated - 2.58x more
-           split_map:      20582 allocated - 3.46x more
-  split_map (sixarm):      23185 allocated - 3.90x more
-  each_char (sixarm):      24979 allocated - 4.20x more
-       scan (sixarm):      29979 allocated - 5.04x more
+Warming up --------------------------------------
+            unaccent     3.259k i/100ms
+              sixarm   838.000  i/100ms
+Calculating -------------------------------------
+            unaccent     32.573k (± 2.1%) i/s -    162.950k in   5.004780s
+              sixarm      8.025k (± 4.6%) i/s -     40.224k in   5.023339s
+
+Comparison:
+            unaccent:    32573.1 i/s
+              sixarm:     8024.7 i/s - 4.06x  (± 0.00) slower
+
+Calculating -------------------------------------
+            unaccent     5.947k memsize (     0.000  retained)
+                        76.000  objects (     0.000  retained)
+                        42.000  strings (     0.000  retained)
+              sixarm    29.979k memsize (     0.000  retained)
+                       633.000  objects (     0.000  retained)
+                        50.000  strings (     0.000  retained)
+
+Comparison:
+            unaccent:       5947 allocated
+              sixarm:      29979 allocated - 5.04x more
 ```
 
 ## Development

data/lib/unaccent/accentmap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Unaccent
   ACCENTMAP = {
     # 00A0 NO-BREAK SPACE
@@ -5038,7 +5040,7 @@ module Unaccent
     # 2103 DEGREE CELSIUS
     # ->   00B0 DEGREE SIGN
     #    + 0043 LATIN CAPITAL LETTER C
-    "\u{2103}" => "\u{B0C}",
+    "\u{2103}" => "\u{B0}C",
 
     # 2105 CARE OF
     # ->   0063 LATIN SMALL LETTER C
@@ -5059,7 +5061,7 @@ module Unaccent
     # 2109 DEGREE FAHRENHEIT
     # ->   00B0 DEGREE SIGN
     #    + 0046 LATIN CAPITAL LETTER F
-    "\u{2109}" => "\u{B0F}",
+    "\u{2109}" => "\u{B0}F",
 
     # 210A SCRIPT SMALL G
     # ->   0067 LATIN SMALL LETTER G

data/lib/unaccent/string.rb

@@ -1,23 +1,16 @@
+# frozen_string_literal: true
+
 require 'unaccent'
 
 module Unaccent
+  # Extend the String class with unaccent method.
   module String
     def unaccent
       Unaccent.unaccent(self)
     end
-
-    def unaccent_via_gsub
-      Unaccent.via_gsub(self)
-    end
-
-    def unaccent_via_each_char
-      Unaccent.via_each_char(self)
-    end
-
-    def unaccent_via_split_map
-      Unaccent.via_split_map(self)
-    end
   end
 end
 
-String.include Unaccent::String
+class String
+  include Unaccent::String
+end

data/lib/unaccent/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Unaccent
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.4.0'
 end

data/lib/unaccent.rb

@@ -1,78 +1,24 @@
-require 'unaccent/accentmap'
+# frozen_string_literal: true
+
 require 'unaccent/version'
 
+# Replace accented characters with unaccented characters in a string.
 module Unaccent
+  autoload :ACCENTMAP, 'unaccent/accentmap'
+
   class << self
     # Replace a string's accented characters with unaccented characters.
     #
     # @example
-    #   s = 'Å Ç ß'
-    #   Unaccent.unaccent(s) = > 'AA C ss'
-    #
-    # @return [String] a string that has no accents
-
-    def unaccent(str)
-      via_gsub(str)
-    end
-
-    # Replace a string's accented characters with unaccented characters,
-    # by using string `#gsub` to replace non-ascii characters.
-    #
-    # @example
     #   str = 'Å Ç ß'
-    #   Unaccent.via_gsub(str) = > 'AA C ss'
+    #   Unaccent.unaccent(str) = > 'AA C ss'
     #
     # @return [String] a string that has no accents
 
-    def via_gsub(str)
-      return str if str.ascii_only?
-
-      str.gsub(/[^[:ascii:]]/) { |c| ACCENTMAP.fetch(c, c) }
-    end
-
-    # Replace a string's accented characters with unaccented characters,
-    # by using string `#scan` to iterate on characters.
-    #
-    # @example
-    #   str = 'Å Ç ß'
-    #   Unaccent.via_scan(str) = > 'AA C ss'
-    #
-    # @return [String] a string that has no accents
-
-    def via_scan(str)
-      return str if str.ascii_only?
-
-      res = ''; str.scan(/./) { |c| res << ACCENTMAP.fetch(c, c) }; res
-    end
-
-    # Replace a string's accented characters with unaccented characters,
-    # by using string `#each_char` to iterate on characters.
-    #
-    # @example
-    #   str = 'Å Ç ß'
-    #   Unaccent.via_each_char(str) = > 'AA C ss'
-    #
-    # @return [String] a string that has no accents
-
-    def via_each_char(str)
-      return str if str.ascii_only?
-
-      res = ''; str.each_char { |c| res << ACCENTMAP.fetch(c, c) }; res
-    end
-
-    # Replace a string's accented characters with unaccented characters,
-    # by using string `#split` and `#map` to iterate on characters.
-    #
-    # @example
-    #   str = 'Å Ç ß'
-    #   Unaccent.via_split_map(str) = > 'AA C ss'
-    #
-    # @return [String] a string that has no accents
-
-    def via_split_map(str)
+    def unaccent(str)
       return str if str.ascii_only?
 
-      str.split(//u).map { |c| ACCENTMAP.fetch(c, c) }.join
+      str.gsub(/[^[:ascii:]]/) { |char| ACCENTMAP.fetch(char, char) }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unaccent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jonian Guveli
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-27 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: Replace accented characters with unaccented characters.
 email:
 - jonian@hardpixel.eu
@@ -45,21 +59,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".gitignore"
-- ".ruby-version"
-- Gemfile
+- ".yardopts"
+- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/benchmark
-- bin/console
-- bin/setup
 - lib/unaccent.rb
 - lib/unaccent/accentmap.rb
 - lib/unaccent/string.rb
 - lib/unaccent/version.rb
-- unaccent.gemspec
 homepage: https://github.com/hardpixel/unaccent
 licenses:
 - MIT
@@ -72,14 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Replace accented characters with unaccented characters

data/.github/workflows/build.yml

@@ -1,36 +0,0 @@
----
-name: Build
-
-on:
-  push:
-    branches: [master]
-    paths-ignore:
-      - 'README.md'
-      - 'LICENSE.txt'
-      - 'bin/**'
-  pull_request:
-    branches: [master]
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        ruby: ['2.7']
-    runs-on: ${{ matrix.os }}
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Run tests
-        run: |
-          bundle exec rake test

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock

data/.ruby-version

@@ -1 +0,0 @@
-3.1.2

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in buildex.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end

data/bin/benchmark

@@ -1,81 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/inline'
-require 'tempfile'
-
-gemfile true, quiet: true do
-  source 'https://rubygems.org'
-  gemspec
-
-  gem 'benchmark-ips'
-  gem 'benchmark-memory'
-  gem 'sixarm_ruby_unaccent'
-end
-
-STRINGS = [
-  'String without accents in english',
-  'Streng med aksenter på norsk',
-  'Řetězec s akcenty v češtině',
-  'Chaîne avec accents en français',
-  'Cuerda con acentos en español',
-  'Corda amb accents en català',
-  'Stīga ar akcentiem latviešu valodā',
-  'Türkçe aksanlı dize',
-  'Varg me theks në shqip',
-  'Κείμενο με τόνους στα ελληνικά'
-]
-
-reports = lambda do |x|
-  x.report('gsub') do
-    STRINGS.each do |str|
-      Unaccent.via_gsub(str)
-    end
-  end
-
-  x.report('scan') do
-    STRINGS.each do |str|
-      Unaccent.via_scan(str)
-    end
-  end
-
-  x.report('each_char') do
-    STRINGS.each do |str|
-      Unaccent.via_each_char(str)
-    end
-  end
-
-  x.report('split_map') do
-    STRINGS.each do |str|
-      Unaccent.via_split_map(str)
-    end
-  end
-
-
-  x.report('scan (sixarm)') do
-    STRINGS.each do |str|
-      str.unaccent_via_scan
-    end
-  end
-
-  x.report('each_char (sixarm)') do
-    STRINGS.each do |str|
-      str.unaccent_via_each_char
-    end
-  end
-
-  x.report('split_map (sixarm)') do
-    STRINGS.each do |str|
-      str.unaccent_via_split_map
-    end
-  end
-end
-
-Benchmark.ips do |x|
-  reports.call(x)
-  x.compare!
-end
-
-Benchmark.memory do |x|
-  reports.call(x)
-  x.compare!
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'unaccent'
-
-# 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
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/unaccent.gemspec

@@ -1,24 +0,0 @@
-require_relative 'lib/unaccent/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'unaccent'
-  spec.version       = Unaccent::VERSION
-  spec.authors       = ['Jonian Guveli']
-  spec.email         = ['jonian@hardpixel.eu']
-
-  spec.summary       = 'Replace accented characters with unaccented characters'
-  spec.description   = 'Replace accented characters with unaccented characters.'
-  spec.homepage      = 'https://github.com/hardpixel/unaccent'
-  spec.license       = 'MIT'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-end