diacritics 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42c761947e39ed8a644d322afb5f66616a85bbb9
-  data.tar.gz: 238f4ebac3386ec8bba58588077f927067fe3728
+  metadata.gz: 6dce2222cc44039074138a5bad8c19a7f8f4e5ec
+  data.tar.gz: e1497d04a6141d1466325611c20f3ba3ff5d3c0a
 SHA512:
-  metadata.gz: 5c3a41f6eee963ff4d60a70408d5c53312a724fb21001e037be40a0c713dae026904fb206d8d7550a431b1e99913e35379b07cf6a2c478275bea26a201d04130
-  data.tar.gz: fcad3df658bbd9122c6a6c66fd4300e83ecfe0adc0d2a11b39114a7bec399b84ddd16aea240dc96ff859f8655723855f3a1ef6baf77eefd34e5f94b544f1930b
+  metadata.gz: 7c1ab640844f696417ac9368e88241db44db929817b65c20af82d7429a51b4467b34f16adbe18c107a16e93c7dc8397ada3a949bf5aa2b498def950ac8d39918
+  data.tar.gz: 67d4a6507128e8529ef67023f55d1f9fa588c034ac6c3dd42d61678f2867c29fae8f66f364f45da9c5024a70db049e25802620cae85d4418690c76f38eb9414b

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   Excludes:
-    # - diacritics.gemspec
+    - diacritics.gemspec
 LineLength:
   Enabled: true
   Max: 79

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.2.0

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - rbx
+  - 2.1.0
+  - 2.2.0
   - jruby-head

data/CHANGELOG.md

@@ -1,15 +1,20 @@
-## v0.0.1
+## v0.0.5
 
-* initial release
+* Check if the string is permanent?
+* Check if the string is slug? (only alphanumeric, - and _)
 
-## v0.0.2
+## v0.0.4
 
-* simpler way to use downcase, upcase and permanent in String class
+Nothing new. Updated rspec tests v3.0.
 
 ## v0.0.3
 
 * benchmark
 
-## v0.0.4
+## v0.0.2
 
-Nothing new. Updated rspec tests v3.0.
+* simpler way to use downcase, upcase and permanent in String class
+
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -1,12 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in diacritics.gemspec
 gemspec
 
 group :development, :test do
   gem 'coveralls', require: false
   gem 'codeclimate-test-reporter', require: false
-  gem 'rspec', '~> 3.0.0.beta1'
+  gem 'rspec', '~> 3.0.0'
   gem 'reek'
   gem 'guard'
   gem 'guard-bundler'

data/Guardfile

@@ -9,5 +9,5 @@ guard :rspec do
     name = array.last
     "spec/#{name}_spec.rb"
   end
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,4 +1,10 @@
-# Diacritics [![Gem Version](https://badge.fury.io/rb/diacritics.png)](http://badge.fury.io/rb/diacritics) [![Build Status](https://travis-ci.org/fractalsoft/diacritics.png)](https://travis-ci.org/fractalsoft/diacritics) [![Dependency Status](https://gemnasium.com/fractalsoft/diacritics.png)](https://gemnasium.com/fractalsoft/diacritics) [![Coverage Status](https://coveralls.io/repos/fractalsoft/diacritics/badge.png)](https://coveralls.io/r/fractalsoft/diacritics) [![Stories in Ready](https://badge.waffle.io/fractalsoft/diacritics.png)](http://waffle.io/fractalsoft/diacritics)  
+# Diacritics
+[![Gem Version](https://badge.fury.io/rb/diacritics.png)](http://badge.fury.io/rb/diacritics)
+[![Build Status](https://travis-ci.org/fractalsoft/diacritics.png)](https://travis-ci.org/fractalsoft/diacritics)
+[![Dependency Status](https://gemnasium.com/fractalsoft/diacritics.png)](https://gemnasium.com/fractalsoft/diacritics)
+[![Coverage Status](https://coveralls.io/repos/fractalsoft/diacritics/badge.png)](https://coveralls.io/r/fractalsoft/diacritics)
+[![Code Climate](https://codeclimate.com/repos/5284c9f156b1021a6e016740/badges/030f7f569aa0fa54ea66/gpa.png)](https://codeclimate.com/repos/5284c9f156b1021a6e016740/feed)
+[![Stories in Ready](https://badge.waffle.io/fractalsoft/diacritics.png)](http://waffle.io/fractalsoft/diacritics)
 [![endorse](https://api.coderwall.com/torrocus/endorsecount.png)](https://coderwall.com/torrocus)
 
 Diacritics is a gem which support downcase, upcase and permanent link with diacritical characters.
@@ -19,12 +25,6 @@ Or install it yourself as:
 
 ## Usage
 
-```ruby
-Diacritics::downcase(text)
-Diacritics::upcase(text)
-Diacritics::permanent(text)
-```
-
 You can include methods into String class:
 
 ```ruby
@@ -37,6 +37,10 @@ and use
 "ŁoreM Ìpsum Ðolór. Šit Ämet".downcase #=> "łorem ìpsum ðolór. šit ämet"
 "łorem ìpsum ðolÓr. šit ämet".upcase #=> "ŁOREM ÌPSUM ÐOLÓR. ŠIT ÄMET"
 "Łorem ìpsum ÐolÓr. Šit ämet".permanent #=> "lorem-ipsum-dolor-sit-aemet"
+'lorem-ipsum-dolor-sit-aemet'.permanent? #=> true
+'łorem ìpsum ðolór. šit ämet'.permanent? #=> false
+'lorem-ipsum-dolor-sit-aemet'.slug? #=> true
+'lorem@ipsum-dolor-sit-aemet'.slug? #=> false
 ```
 
 ## Contributing

data/diacritics.gemspec

@@ -6,7 +6,7 @@ require 'diacritics/version'
 Gem::Specification.new do |spec|
   spec.name          = 'diacritics'
   spec.version       = Diacritics::VERSION
-  spec.authors       = ['Aleksander Malaszkiewicz']
+  spec.authors       = ['Aleksander Malaszkiewicz', 'Agnieszka Matysek']
   spec.email         = ['info@fractalsoft.org']
   spec.summary       = %q{Support diacritics}
   spec.homepage      = 'https://github.com/fractalsoft/diacritics'
@@ -17,6 +17,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 end

data/lib/diacritics.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'diacritics/alphabet'
 require 'diacritics/cases'
 require 'diacritics/string'

data/lib/diacritics/alphabet.rb

@@ -2,181 +2,180 @@
 
 # Diacritics private class
 module Diacritics
-
   private
 
-    # Characters from many alphabets
-    class Alphabet
-      attr_reader :regexp, :hash
+  # Characters from many alphabets
+  class Alphabet
+    attr_reader :regexp, :hash
+
+    def initialize
+      @downcase, @upcase, @permanent = [], [], []
+      prepare_alphabet
+      @hash, @regexp = prepare_hash, prepare_regexp
+    end
 
-      def initialize
-        @downcase, @upcase, @permanent = [], [], []
-        prepare_alphabet
-        @hash, @regexp = prepare_hash, prepare_regexp
+    private
+
+    def prepare_alphabet
+      data.each_pair do |_language, hash|
+        @downcase += hash[:downcase]
+        @upcase += hash[:upcase]
+        @permanent += hash[:permanent]
       end
+    end
+
+    def prepare_hash
+      klass = Diacritics::Alphabet
+      hash = klass.hashed(@downcase, @upcase)
+      one = klass.hashed(@downcase, @permanent)
+      two = klass.hashed(@upcase, @permanent)
+      {
+        downcase: hash.invert,
+        upcase: hash,
+        permanent: one.merge(two)
+      }
+    end
+
+    def prepare_regexp
+      downcase, upcase = @upcase.join, @downcase.join
+      permanent = (@downcase + @upcase).uniq.join
+      {
+        downcase: /[#{downcase}]/,
+        upcase: /[#{upcase}]/,
+        permanent: /[#{permanent}]/
+      }
+    end
+
+    # Creates a hash from two arrays
+    #
+    #   ["a", "b"], ["A", "B"] #=> {"a" => "A", "b" => "B"}
+    def self.hashed(one, two)
+      hash = {}
+      [one, two].transpose.each { |key, value| hash[key] = value }
+      hash
+    end
+
+    def data
+      {
+        en: en, de: de, pl: pl, cs: cs, fr: fr, it: it, eo: eo,
+        is: is, pt: pt, sp: sp, hu: hu, nn: nn, ru: ru, gr: gr
+      }
+    end
+
+    def en
+      { # English
+        downcase:  [' ', '?', '.', ','],
+        upcase:    [' ', '?', '.', ','],
+        permanent: ['-', '', '', '']
+      }
+    end
+
+    def de
+      { # German
+        downcase:  %w(ä ö ü ß),
+        upcase:    %w(Ä Ö Ü ẞ),
+        permanent: %w(ae oe ue ss)
+      }
+    end
+
+    def pl
+      { # Polish
+        downcase:  %w(ą ć ę ł ń ó ś ż ź),
+        upcase:    %w(Ą Ć Ę Ł Ń Ó Ś Ż Ź),
+        permanent: %w(a c e l n o s z z)
+      }
+    end
+
+    def cs
+      { # Czech
+        downcase:  %w(á č í ř š ý ž),
+        upcase:    %w(Á Č Í Ř Š Ý Ž),
+        permanent: %w(a c i r s y z)
+      }
+    end
+
+    def fr
+      { # French
+        downcase:  %w(à é è ê ô),
+        upcase:    %w(À É È Ê Ô),
+        permanent: %w(a e e e o)
+      }
+    end
+
+    def it
+      { # Italian
+        downcase:  %w(ì ù ò),
+        upcase:    %w(Ì Ù Ò),
+        permanent: %w(i u o)
+      }
+    end
+
+    def eo
+      { # Esperanto
+        downcase:  %w(ĉ ĝ ĥ ĵ ŝ ŭ),
+        upcase:    %w(Ĉ Ĝ Ĥ Ĵ Ŝ Ŭ),
+        permanent: %w(c g h j s u)
+      }
+    end
+
+    def is
+      { # Iceland
+        downcase:  %w(ð þ),
+        upcase:    %w(Ð Þ),
+        permanent: %w(d p)
+      }
+    end
+
+    def pt
+      { # Portugal
+        downcase:  %w(ã ç),
+        upcase:    %w(Ã Ç),
+        permanent: %w(a c)
+      }
+    end
+
+    def sp
+      { # Spanish
+        downcase:  ['¿'],
+        upcase:    ['¿'],
+        permanent: ['']
+      }
+    end
+
+    def hu
+      { # Hungarian
+        downcase:  %w(ő),
+        upcase:    %w(Ő),
+        permanent: %w(oe)
+      }
+    end
+
+    def nn
+      { # Norwegian
+        downcase:  %w(æ å),
+        upcase:    %w(Æ Å),
+        permanent: %w(ae a)
+      }
+    end
+
+    def ru
+      { # Russian
+        downcase: %w(
+          а б в г д е ё ж з и й к л м н о п р с т у ф х ц ч ш ы ь ю я),
+        upcase: %w(
+          А Б В Г Д Е Ё Ж З И Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш Ы Ь Ю Я),
+        permanent: %w(
+          а б в г д е ё ж з и й к л м н о п р с т у ф х ц ч ш ы ь ю я)
+      }
+    end
 
-      private
-
-        def prepare_alphabet
-          data.each_pair do |language, hash|
-            @downcase += hash[:downcase]
-            @upcase += hash[:upcase]
-            @permanent += hash[:permanent]
-          end
-        end
-
-        def prepare_hash
-          klass = Diacritics::Alphabet
-          hash = klass.hashed(@downcase, @upcase)
-          one = klass.hashed(@downcase, @permanent)
-          two = klass.hashed(@upcase, @permanent)
-          {
-            downcase: hash.invert,
-            upcase: hash,
-            permanent: one.merge(two),
-          }
-        end
-
-        def prepare_regexp
-          downcase, upcase = @upcase.join, @downcase.join
-          permanent = (@downcase + @upcase).uniq.join
-          {
-            downcase: /[#{downcase}]/,
-            upcase: /[#{upcase}]/,
-            permanent: /[#{permanent}]/,
-          }
-        end
-
-        # Creates a hash from two arrays
-        #
-        #   ["a", "b"], ["A", "B"] #=> {"a" => "A", "b" => "B"}
-        def self.hashed(one, two)
-          hash = {}
-          [one, two].transpose.each { |key, value| hash[key] = value }
-          hash
-        end
-
-        def data
-          {
-            en: en, de: de, pl: pl, cs: cs, fr: fr, it: it, eo: eo,
-            is: is, pt: pt, sp: sp, hu: hu, nn: nn, ru: ru, gr: gr
-          }
-        end
-
-        def en
-          { # English
-            downcase:  [' ', '?', '.', ','],
-            upcase:    [' ', '?', '.', ','],
-            permanent: ['-', '',  '', ''],
-          }
-        end
-
-        def de
-          { # German
-            downcase:  %w[ä  ö  ü  ß],
-            upcase:    %w[Ä  Ö  Ü  ẞ],
-            permanent: %w[ae oe ue ss]
-          }
-        end
-
-        def pl
-          { # Polish
-            downcase:  %w[ą ć ę ł ń ó ś ż ź],
-            upcase:    %w[Ą Ć Ę Ł Ń Ó Ś Ż Ź],
-            permanent: %w[a c e l n o s z z]
-          }
-        end
-
-        def cs
-          { # Czech
-              downcase:  %w[á č í ř š ý ž],
-              upcase:    %w[Á Č Í Ř Š Ý Ž],
-              permanent: %w[a c i r s y z]
-          }
-        end
-
-        def fr
-          { # French
-            downcase:  %w[à é è ê ô],
-            upcase:    %w[À É È Ê Ô],
-            permanent: %w[a e e e o]
-          }
-        end
-
-        def it
-          { # Italian
-            downcase:  %w[ì ù ò],
-            upcase:    %w[Ì Ù Ò],
-            permanent: %w[i u o]
-          }
-        end
-
-        def eo
-          { # Esperanto
-            downcase:  %w[ĉ ĝ ĥ ĵ ŝ ŭ],
-            upcase:    %w[Ĉ Ĝ Ĥ Ĵ Ŝ Ŭ],
-            permanent: %w[c g h j s u]
-          }
-        end
-
-        def is
-          { # Iceland
-            downcase:  %w[ð þ],
-            upcase:    %w[Ð Þ],
-            permanent: %w[d p]
-          }
-        end
-
-        def pt
-          { # Portugal
-            downcase:  %w[ã ç],
-            upcase:    %w[Ã Ç],
-            permanent: %w[a c]
-          }
-        end
-
-        def sp
-          { # Spanish
-            downcase:  ['¿'],
-            upcase:    ['¿'],
-            permanent: ['']
-          }
-        end
-
-        def hu
-          { # Hungarian
-            downcase:  %w[ő],
-            upcase:    %w[Ő],
-            permanent: %w[oe]
-          }
-        end
-
-        def nn
-          { # Norwegian
-            downcase:  %w[æ å],
-            upcase:    %w[Æ Å],
-            permanent: %w[ae a]
-          }
-        end
-
-        def ru
-          { # Russian
-            downcase: %w[
-              а б в г д е ё ж з и й к л м н о п р с т у ф х ц ч ш ы ь ю я],
-            upcase: %w[
-              А Б В Г Д Е Ё Ж З И Й К Л М Н О П Р С Т У Ф Х Ц Ч Ш Ы Ь Ю Я],
-            permanent: %w[
-              а б в г д е ё ж з и й к л м н о п р с т у ф х ц ч ш ы ь ю я]
-          }
-        end
-
-        def gr
-          { # Greek
-            downcase: %w[α ά γ δ ε έ ζ η θ ι ί κ λ μ ν ξ ο ό π ρ σ τ υ φ ψ],
-            upcase:   %w[Α Ά Γ Δ Ε Έ Ζ Η Θ Ι Ί Κ Λ Μ Ν Ξ Ο Ό Π Ρ Σ Τ Υ Φ Ψ],
-            permanent: %w[
-              a a g d e e z e th i i k l m n x o o p r s t y ph ps]
-          }
-        end
+    def gr
+      { # Greek
+        downcase: %w(α ά γ δ ε έ ζ η θ ι ί κ λ μ ν ξ ο ό π ρ σ τ υ φ ψ),
+        upcase:   %w(Α Ά Γ Δ Ε Έ Ζ Η Θ Ι Ί Κ Λ Μ Ν Ξ Ο Ό Π Ρ Σ Τ Υ Φ Ψ),
+        permanent: %w(
+          a a g d e e z e th i i k l m n x o o p r s t y ph ps)
+      }
     end
+  end
 end

data/lib/diacritics/string.rb

@@ -2,30 +2,6 @@
 module Diacritics
   # Include this into String class
   module String
-    # @deprecated Please use {#downcase} instead.
-    def diacritics_downcase
-      # rubocop:disable all
-      warn '[DEPRECATION] `diacritics_downcase` is depraceted. Please use `downcase` instead.'
-      # rubocop:enable all
-      send :downcase
-    end
-
-    # @deprecated Please use {#upcase} instead.
-    def diacritics_upcase
-      # rubocop:disable all
-      warn '[DEPRECATION] `diacritics_upcase` is depraceted. Please use `upcase` instead.'
-      # rubocop:enable all
-      send :upcase
-    end
-
-    # @deprecated Please use {#permanent} instead.
-    def permanent_link
-      # rubocop:disable all
-      warn '[DEPRECATION] `permanent_link` is depraceted. Please use `permanent` instead.'
-      # rubocop:enable all
-      send :permanent
-    end
-
     def self.included(klass)
       klass.class_eval do
         def downcase
@@ -41,5 +17,13 @@ module Diacritics
     def permanent
       Diacritics::Cases.instance.permanent self
     end
+
+    def permanent?
+      Diacritics::Cases.instance.permanent(self) == self
+    end
+
+    def slug?
+      !match(/^[[:alnum:][_-]]+$/).nil?
+    end
   end
 end

data/lib/diacritics/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # Gem version
 module Diacritics
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/diacritics/string_spec.rb

@@ -16,6 +16,12 @@ describe Diacritics::String do
     describe '#permanent' do
       it { expect(subject.permanent).to eq result[2] }
     end
+
+    describe '#pernament?' do
+      let(:permanent) { subject.permanent }
+      it { expect(subject).not_to be_permanent }
+      it { expect(permanent).to be_permanent }
+    end
   end
 
   context 'English' do
@@ -74,11 +80,11 @@ describe Diacritics::String do
     it_behaves_like 'word processing' do
       subject { 'Ödögidöggi' }
       let(:result) do
-        [
-          'ödögidöggi',
-          'ÖDÖGIDÖGGI',
-          'oedoegidoeggi'
-        ]
+        %w(
+          ödögidöggi
+          ÖDÖGIDÖGGI
+          oedoegidoeggi
+        )
       end
     end
   end
@@ -475,11 +481,11 @@ describe Diacritics::String do
     it_behaves_like 'word processing' do
       subject { 'Nyelvtörők' }
       let(:result) do
-        [
-          'nyelvtörők',
-          'NYELVTÖRŐK',
-          'nyelvtoeroek'
-        ]
+        %w(
+          nyelvtörők
+          NYELVTÖRŐK
+          nyelvtoeroek
+        )
       end
     end
   end
@@ -496,4 +502,27 @@ describe Diacritics::String do
       end
     end
   end
+
+  context do
+    it { expect('lorem-ipsum').to be_slug }
+    it { expect('lorem_ipsum').to be_slug }
+    it { expect('lorem!ipsum').not_to be_slug }
+    it { expect('lorem#ipsum').not_to be_slug }
+    it { expect('lorem$ipsum').not_to be_slug }
+    it { expect('lorem&ipsum').not_to be_slug }
+    it { expect("lorem'ipsum").not_to be_slug }
+    it { expect('lorem(ipsum').not_to be_slug }
+    it { expect('lorem)ipsum').not_to be_slug }
+    it { expect('lorem+ipsum').not_to be_slug }
+    it { expect('lorem,ipsum').not_to be_slug }
+    it { expect('lorem/ipsum').not_to be_slug }
+    it { expect('lorem:ipsum').not_to be_slug }
+    it { expect('lorem;ipsum').not_to be_slug }
+    it { expect('lorem?ipsum').not_to be_slug }
+    it { expect('lorem@ipsum').not_to be_slug }
+    it { expect('lorem[ipsum').not_to be_slug }
+    it { expect('lorem]ipsum').not_to be_slug }
+    it { expect('lorem{ipsum').not_to be_slug }
+    it { expect('lorem}ipsum').not_to be_slug }
+  end
 end

metadata

@@ -1,41 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: diacritics
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Aleksander Malaszkiewicz
+- Agnieszka Matysek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -46,12 +47,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -80,17 +81,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Support diacritics