accent-buster 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb04300d0430b953c0f464ac9d011723ed9a1cc1
-  data.tar.gz: 4bf2da8dc8202bb6e84c231d1f3875106d92c957
+  metadata.gz: f68a3198636a19ba82aab1bbc92e6ee5d98d1ce6
+  data.tar.gz: e988a106de602aea667280496d366632b1f9ac73
 SHA512:
-  metadata.gz: d0bd287f9e6df2c72c5a1ea67403be0046774519b5bc6fedf849c4341dbb4f9540bdeace46557f19eddaf7cde6cb497165b2950381ed07b419f64a7ef6310dcf
-  data.tar.gz: 64e324619ffb08bd1fcf8fd842896eef17e95b18e645b2c4aceea5c2546829adab7fdaf25bb17172f302e83619bbb4c0a6b27e2cb5df5a3408c483771f37a8fa
+  metadata.gz: b0a27cfd4602c219bc256aa6d43275c2be01f15d85d8fc93889b4040e4d46909c742b89971de9305f3e8ad20b7e10a64b94c83d2d0ecbcfa1566d179db12e7c2
+  data.tar.gz: dae409cf9194a1cfc841970a49e6512de9afc1d6cf0ff49b763889075fd8c2e1cf527f1a4769e1c8ea719ebc915b5a6eabceed161427a331245c9eebdfadd065

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.idea
 coverage
 InstalledFiles
 lib/bundler/man

data/.ruby-gemset

@@ -0,0 +1 @@
+accent-buster

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    accent-buster (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.8)
+    formatador (0.2.5)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hitimes (1.2.2)
+    listen (2.10.0)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  accent-buster!
+  bundler (~> 1.0, >= 1.5.1)
+  guard-rspec (~> 4.5)
+  rake (~> 10.4, >= 10.4.2)

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,14 +1,18 @@
-# Accent Buster
+# Accent Buster (2.0)
 
-Add "String#accent\_buster" that replaces diacritics marks by their non-diacritic equivalents.
+Extra methods do deal with diacritics (accent) in latin languages.
 
-Modify "String#downcase", "String#downcase!", "String#upcase", "String#upcase!" to correctly handle diacritics.
+They replace diacritcs by their non-diacritic equivalents. Example: "ação" becomes "acao".
 
-I made it because I don't want to add "ActiveSupport" to the projects everytime I need that (also, I'm too lazy to type the same thing all the time).
+I made it because I don't want to add "ActiveSupport" to the projects everytime I need that (also, I'm too lazy to type the same code all the time).
 
 BTW, if you want to get really serious on that, the gem "UnicodeUtils" is a far better (and more complete) option. ^\_^
 
-Accent Buster uses refinements, so, ruby 2.0+ only.
+## Note on version 2.0
+
+I gave up on the "Refinement" idea of the previous version. Reason? I use this A LOT and, for some (unconventional) cases, I had to make fancy maneuvers to be able to use it. Meh :p
+
+The support for Refinement is still here, maybe I never remove it. However, I added 2 other usage options (explained below in "Usage").
 
 ## Installation
 
@@ -24,9 +28,56 @@ Or install it yourself as:
 
     $ gem install accent-buster
 
-## Usage
+## Usage (plain object)
+
+If you need a "no fluffy, no magic" version, this one is for you. Just a Plain Old Ruby Object`.tm`
 
 ```ruby
+require 'accent-buster'
+
+# Bust accents
+AccentBuster::Buster.new('ação').bust # => 'acao'
+
+# Bust accents (with include)
+include AccentBuster
+x = Buster.new('é você?')
+x.bust # => x = 'e voce'
+
+# Upcase
+Buster.new('ação').up # => 'AÇÃO'
+
+# Downcase
+Buster.new('É VocÊ?').downcase # => 'é você?'
+```
+
+## Usage (monkey patch)
+
+(#shame My favorite!)
+
+Just one method added: String#buster. This should reduce the chance of name collision and it keeps the API clean and extensible.
+
+If you are using it for applications, I recommend use it this way. If you are making a gem, avoid this.
+
+```ruby
+require 'accent-buster/monkey_patch_string'
+
+# Bust accents
+'ação'.buster.bust # => 'acao'
+
+# Upcase
+'ação'.buster.up # => 'AÇÃO'
+
+# Downcase
+'É VocÊ?'.buster.down # => 'é você?'
+```
+
+## Usage (with refinements)
+
+Safe, clean and "modern" :p
+
+```ruby
+require 'accent-buster'
+
 # Refinements!
 using AccentBuster::StringExtension
 
@@ -48,3 +99,4 @@ x.upcase!
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+6. Wait, have a cake, enjoy!

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require "bundler/gem_tasks"

data/accent-buster.gemspec

@@ -4,18 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'accent-buster/version'
 
 Gem::Specification.new do |spec|
-  # We are using refinements
-  # Something wrong when trying to install
-  # using bundler =\
-  # Does not accept ruby 2.1 >_<
-  #spec.required_ruby_version = '>= 2.0'
-
   spec.name          = "accent-buster"
   spec.version       = AccentBuster::VERSION
   spec.authors       = ["Ronie Uliana"]
   spec.email         = ["ronie.uliana@gmail.com"]
   spec.description   = %q{Add "String#accent_buster" that replaces diacritics marks by their non-diacritic equivalents.}
-  spec.summary       = %q{Add "String#accent_buster" that replaces diacritics marks by their non-diacritic equivalents. I made it because I don't want to add "ActiveSupport" to the projects everytime I need that (also, I'm too lazy to type the same thing all the time). This lib will have NO MORE than the very strictly necessary to replace diacritics, currently, it has 2 methods: "String#accent_buster" and "String#accent_buster!" (note the bang).}
+  spec.summary       = %q{Add "String#accent_buster" that replaces diacritics marks by their non-diacritic equivalents. I made it because I don't want to add "ActiveSupport" to the projects everytime I need that (also, I'm too lazy to type the same thing all the time). This lib will have NO MORE than the very strictly necessary to replace diacritics.}
   spec.homepage      = "http://github.com/ruliana/accent-buster"
   spec.license       = "MIT"
 
@@ -25,5 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.0", ">= 1.5.1"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.4", ">= 10.4.2"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
 end

data/lib/accent-buster.rb

@@ -1,5 +1,16 @@
-require 'accent-buster/version'
-require 'accent-buster/string_extension'
+require "accent-buster/version"
+require "accent-buster/string_extension"
+require "accent-buster/buster"
 
 module AccentBuster
+  # Wrap an object to add accent wise (diacritic wise)
+  # methods.
+  #
+  # It works for latin languages only.
+  #
+  # @see Buster#bust
+  # @return [Buster] object with extra methods.
+  def buster
+    Buster.new(self)
+  end
 end

data/lib/accent-buster/buster.rb

@@ -0,0 +1,43 @@
+class AccentBuster::Buster
+  ACCENT_DOWNCASE    = "áéíóúâêîôûäëïöüãõñç"
+  NO_ACCENT_DOWNCASE = "aeiouaeiouaeiouaonc"
+  ACCENT_UPCASE      = "ÁÉÍÓÚÂÊÎÔÛÄËÏÖÜÃÕÑÇ"
+  NO_ACCENT_UPCASE   = "AEIOUAEIOUAEIOUAONC"
+
+  # Wrap an object to add accent wise (diacritic wise)
+  # methods.
+  #
+  # It works for latin languages only.
+  #
+  # @param a_string [#to_s]
+  def initialize(a_string)
+    @a_string = a_string.to_s
+  end
+
+  # Convert diacritics chars to their non-diacritic equivalents.
+  #
+  # "áéíóú âêîôû äëïöü ãõ ñç" => "aeiou aeiou aeiou ao nc"
+  #
+  # @return the string with diacritics removed.
+  def bust
+    @a_string.tr(ACCENT_DOWNCASE + ACCENT_UPCASE, NO_ACCENT_DOWNCASE + NO_ACCENT_UPCASE)
+  end
+
+  # Upcase the string, correctly converting diacritcs.
+  #
+  # Example: "ótimo" => "ÓTIMO"
+  #
+  # @return the string upper case
+  def up
+    @a_string.tr(ACCENT_DOWNCASE, ACCENT_UPCASE).upcase
+  end
+
+  # Downcase the string, correctly converting diacritcs.
+  #
+  # Example: "ÓTIMO" => "ótimo"
+  #
+  # @return the string lower case
+  def down
+    @a_string.tr(ACCENT_UPCASE, ACCENT_DOWNCASE).downcase
+  end
+end

data/lib/accent-buster/monkey_patch_string.rb

@@ -0,0 +1,5 @@
+require 'accent-buster'
+
+class String
+  include AccentBuster
+end

data/lib/accent-buster/string_extension.rb

@@ -1,9 +1,10 @@
 module AccentBuster::StringExtension
+  # @deprecated Use [Buster] or include [AccentBuster] to use #buster method
   refine String do
-    ACCENT_DOWNCASE    = 'áéíóúâêîôûäëïöüãõñç'
-    NO_ACCENT_DOWNCASE = 'aeiouaeiouaeiouaonc'
-    ACCENT_UPCASE      = 'ÁÉÍÓÚÂÊÎÔÛÄËÏÖÜÃÕÑÇ'
-    NO_ACCENT_UPCASE   = 'AEIOUAEIOUAEIOUAONC'
+    ACCENT_DOWNCASE    = "áéíóúâêîôûäëïöüãõñç"
+    NO_ACCENT_DOWNCASE = "aeiouaeiouaeiouaonc"
+    ACCENT_UPCASE      = "ÁÉÍÓÚÂÊÎÔÛÄËÏÖÜÃÕÑÇ"
+    NO_ACCENT_UPCASE   = "AEIOUAEIOUAEIOUAONC"
 
     # Convert diacritics chars to their non-diacritic equivalents.
     #

data/lib/accent-buster/version.rb

@@ -1,3 +1,3 @@
 module AccentBuster
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

data/spec/lib/accent_buster_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe AccentBuster do
+  let(:subject) { "açÃo!".extend(AccentBuster) }
+  describe "#accent_buster" do
+    it 'replaces "açÃo!" by "acAo!"' do
+      expect(subject.buster.bust).to eq "acAo!"
+    end
+  end
+
+  describe "#accent_buster(:up)" do
+    it 'upcases "açÃo!" to "AÇÃO!"' do
+      expect(subject.buster.up).to eq "AÇÃO!"
+    end
+  end
+
+  describe "#accent_buster(:down)" do
+    it 'upcases "açÃo!" to "ação!"' do
+      expect(subject.buster.down).to eq "ação!"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "accent-buster"
+
+include AccentBuster

metadata

@@ -1,49 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: accent-buster
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Ronie Uliana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.5'
 description: Add "String#accent_buster" that replaces diacritics marks by their non-diacritic
   equivalents.
 email:
@@ -52,15 +72,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
+- Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - accent-buster.gemspec
 - lib/accent-buster.rb
+- lib/accent-buster/buster.rb
+- lib/accent-buster/monkey_patch_string.rb
 - lib/accent-buster/string_extension.rb
 - lib/accent-buster/version.rb
+- spec/lib/accent_buster_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/ruliana/accent-buster
 licenses:
 - MIT
@@ -71,23 +99,23 @@ 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.1.11
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: 'Add "String#accent_buster" that replaces diacritics marks by their non-diacritic
-  equivalents. I made it because I don''t want to add "ActiveSupport" to the projects
-  everytime I need that (also, I''m too lazy to type the same thing all the time).
-  This lib will have NO MORE than the very strictly necessary to replace diacritics,
-  currently, it has 2 methods: "String#accent_buster" and "String#accent_buster!"
-  (note the bang).'
-test_files: []
+summary: Add "String#accent_buster" that replaces diacritics marks by their non-diacritic
+  equivalents. I made it because I don't want to add "ActiveSupport" to the projects
+  everytime I need that (also, I'm too lazy to type the same thing all the time).
+  This lib will have NO MORE than the very strictly necessary to replace diacritics.
+test_files:
+- spec/lib/accent_buster_spec.rb
+- spec/spec_helper.rb