turkish_support 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aebbf4b1c2c8f0283519893af65a7af8ddff76f4
-  data.tar.gz: 494229ce7f845ca31046b82159b039e33b43504c
+  metadata.gz: b2d1af86e3516703c1a1a9c9b63a2f5084420c0b
+  data.tar.gz: 29c3d95b0d17ed33157a1c3e6a82f24f03660fd2
 SHA512:
-  metadata.gz: 65e2dc445b5eb618c8b4d647dcf1460dab949eb8b7510614d567133feb3d191c4f8aa29d99df068ebf00b4ceab30affd784464232e5ce530234b376444c7341c
-  data.tar.gz: b2fed1c1d5d1f0e79828ba9a4dafa9308776bca9e2e4d4648fca73b359809e133a341f92d9c6dd0f6f6474ff5ea23f343fcfd1ec1e43200140414ca2299b919a
+  metadata.gz: bee27f7790ae647404b90d9c291e6b062d51799bd0f61ac6d2c7950547bf146e02a1dc04f586c0be093c5c61962ba7524375105c54a13d54471602ccad17b800
+  data.tar.gz: cd9a89e523e5def88c076dc5e686058b5c0bbd7101b9e01371283eb7c03d05853331a4b13bec50be7c12d0132c4f7eec8c4e1a3a9bd5a10c7dbb99a09c3e5160

data/README.md

@@ -2,11 +2,27 @@
 
 [![Gem Version](https://badge.fury.io/rb/turkish_support.svg)](http://badge.fury.io/rb/turkish_support)
 
-
-A gem for Turkish character support for `String#upcase`, `String#downcase`, `String#capitalize` methods and their destructive versions like `String#upcase!`. In other words; this gem is a lighter version of the UnicodeUtils gem.
+Turkish character support for some standard Ruby methods. This gem provide support for these methods:
+* `String#upcase`
+* `String#upcase!`
+* `String#downcase`
+* `String#downcase!`
+* `String#capitalize`
+* `String#capitalize!`
+* `String#swapcase`
+* `String#swapcase!`
+* `String#casecmp`
+
+Also gives you some new methods like:
+* `String#titleize`
 
 ## Requirements
-TurkishSupport uses refinements instead of monkey patching. So, you need to install at least v2.0.0 of Ruby.
+
+* Ruby  >= 2.0.0
+* Rails >= 4.0.0
+
+__Notice:__ TurkishSupport uses refinements instead of monkey patching. Refinements come with Ruby 2.0.0 as a new feature
+and also, it is an experimental feature for now. If you want to more information about refinements, you can see the doc at [http://www.ruby-doc.org/core-2.0.0/doc/syntax/refinements_rdoc.html](http://www.ruby-doc.org/core-2.0.0/doc/syntax/refinements_rdoc.html)
 
 ## Installation
 
@@ -22,17 +38,27 @@ Or install it yourself as:
 
     $ gem install turkish_support
 
-## Usage
+## Usage Instructions
+
+After the installation of the gem, you should follow these steps.
+
+* You need require it.
+
+__Note:__ If you are using a framework like Rails, you don't need to require, because it is already required by the framework.
+
+```ruby
+  require TurkishSupport
+```
 
-After installing the gem, you want to add a line before using Turkish supported version of the methods.
+* Add `using TurkishSupport` line to the top of the scope, __not inside of any class or module__.
 
 ```ruby
-  using TurkishSupport
+  using   TurkishSupport
 ```
 
-If you want to see a simple [gist](https://gist.github.com/sbagdat/9964521) that shows how should you use it.
+## Examples
 
-Now you can use your shiny new methods like below:
+Within the file which you added `using TurkishSupport` line to the top of the scope; you can use core methods like below:
 
 ```ruby
   str = 'Bağcılar'
@@ -46,6 +72,13 @@ Now you can use your shiny new methods like below:
   "merhaba".capitalize  #=> "Merhaba"
 ```
 
+__Note:__ If you also want to use original set of the core methods in the same scope, you can use `send` method like this:
+
+```ruby
+  str = 'Bağcılar'
+  str.send(:upcase)  #=> "BAğCıLAR"
+```
+
 
 ## Contributing
 

data/lib/turkish_support/swapcase.rb

@@ -9,5 +9,9 @@ module TurkishSupport
         end
       end.join
     end
+
+    def swapcase!
+      replace(swapcase)
+    end
   end
 end

data/lib/turkish_support/version.rb

@@ -1,3 +1,3 @@
 module TurkishSupport
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/turkish_support_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
+using TurkishSupport
 
 module TurkishSupport
-
   describe VERSION do
     it 'should have a version number' do
       TurkishSupport::VERSION.should_not be_nil
@@ -9,8 +9,6 @@ module TurkishSupport
   end
 
   describe String do
-    using TurkishSupport
-
     let(:downcased_turkish_alphabet) { "abcçdefgğhıijklmnoöprsştuüvyz" }
     let(:upcased_turkish_alphabet)   { "ABCÇDEFGĞHIİJKLMNOÖPRSŞTUÜVYZ" }
     let(:downcased_english_alphabet) { [*'a'..'z'].join }
@@ -109,20 +107,32 @@ module TurkishSupport
       end
 
       it "downcases characters other than first characters of all words" do
-        titleized = "mERHABA çAMUR iSMET".titleize
-        expect(titleized).to eq("Merhaba Çamur İsmet")
+        titleized = "mERHABA çAMUR iSMETOĞULLARI".titleize
+        expect(titleized).to eq("Merhaba Çamur İsmetoğulları")
       end
     end
 
     describe "#swapcase" do
-      it "swaps characters correctly" do
-        word = "mErHaba çamur ismetoğullarI".swapcase
-        expect(word).to eq("MeRhABA ÇAMUR İSMETOĞULLARı")
+      context "with non-destructive version" do
+        it "does not change the original value of the string" do
+          word = "mErHaba çamur ismetoğullarI"
+          expect{ word.swapcase }.to_not change{ word }
+        end
+
+        it "swaps characters correctly" do
+          word = "mErHaba çamur ismetoğullarI".swapcase
+          expect(word).to eq("MeRhABA ÇAMUR İSMETOĞULLARı")
+        end
+      end
+
+      context "with destructive version" do
+        it "changes the original value of the string with the swapcased version" do
+          word = "mErHaba çamur ismetoğullarI"
+          expect{ word.swapcase! }.to change{ word }
+          expect(word).to eq('MeRhABA ÇAMUR İSMETOĞULLARı')
+        end
       end
     end
 
   end
 end
-
-
-

data/turkish_support.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = TurkishSupport::VERSION
   spec.authors       = ["Sıtkı Bağdat"]
   spec.email         = ["sbagdat@gmail.com"]
-  spec.summary       = %q{Turkish characters support for upcase, downcase, etc.}
-  spec.description   = %q{A gem for Turkish character support for String#upcase, String#downcase, String#capitalize methods and their destructive versions like String#upcase!. In other words; this gem is a lighter version of the UnicodeUtils gem. }
+  spec.summary       = %q{Turkish character support for some standard Ruby methods.}
+  spec.description   = %q{Turkish character support for some standard Ruby methods like #upcase, #downcase, etc. Also provide some new useful methods like #titleize.}
   spec.homepage      = "https://github.com/sbagdat/turkish_support"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turkish_support
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Sıtkı Bağdat
@@ -52,9 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'A gem for Turkish character support for String#upcase, String#downcase,
-  String#capitalize methods and their destructive versions like String#upcase!. In
-  other words; this gem is a lighter version of the UnicodeUtils gem. '
+description: 'Turkish character support for some standard Ruby methods like #upcase,
+  #downcase, etc. Also provide some new useful methods like #titleize.'
 email:
 - sbagdat@gmail.com
 executables: []
@@ -104,7 +103,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Turkish characters support for upcase, downcase, etc.
+summary: Turkish character support for some standard Ruby methods.
 test_files:
 - spec/spec_helper.rb
 - spec/turkish_support_spec.rb