conchiterz 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be84ab885dd8973f26a64ecf6ad23734b6e08787
-  data.tar.gz: 7068a21dd3fc268dd5a3a0cc39521d649123823d
+  metadata.gz: ee101a3c9eed10ffbb0419afabf1c4b40e188a28
+  data.tar.gz: e362d4b393b102c901cf7036efec5c01aa8ff4b5
 SHA512:
-  metadata.gz: 5c58df5235a39e99baa52aa3f192014d0d6ab50736700c4b49773344962574f1f3401254efdbca12e07617c145501d45a740f2cd6c02a682f624d7c5115377f0
-  data.tar.gz: b7b876230d9d6f6a71062e86bd9938e05e7639c56634483d01625025e9ab0e15d27cd521afe80b03ae0988f71b61c6b65758507f31e51388d82f51804aaebb16
+  metadata.gz: 5df116760ea45ee392b0a75c9cf3c18bf7ad8340a4df2374e2a135475bfd1de2a28f35c3a90f9c617d9db96aff9d684d60565b097ea320c73f9f10b61278df16
+  data.tar.gz: 02cd0f10d29808a50dfd1eaca6dd549dc904a7143661b4622530de71afd612df5ea235c398306fb2a52213aef6cb5d7a8b08b84dfd8bdf03f9ff870f8dd1a43b

data/README.md

@@ -1,8 +1,13 @@
+[![Gem Version](https://badge.fury.io/rb/conchiterz.svg)](https://badge.fury.io/rb/conchiterz)
+
 # Conchiterz
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/conchiterz`. To experiment with that code, run `bin/console` for an interactive prompt.
+A simply gem to feminize french word and french sentence.
 
-TODO: Delete this and the text above, and describe your gem
+* Keep intact upcase, downcase and capitalize letters
+* Hanfle numbers
+* Keep intact punctuation
+* Handle special characters
 
 ## Installation
 
@@ -20,22 +25,88 @@ Or install it yourself as:
 
     $ gem install conchiterz
 
-## Usage
+## Get started
+`Conchiterz.translate(string, boolean, escape = [])` feminize a french string if boolean is evaluates to true.
+
+Use on your CLI :
+```ruby
+[1] pry(main)> require 'conchiterz'
+=> true
+[2] pry(main)> Conchiterz.translate('Vous vous êtes inscrit avec succès.', true)
+=> "Vous vous êtes inscrite avec succès."
+```
+
+If you give feminine string whatever the boolean value, the same string will be returned.
+
+### Escaping words
+
+Sometimes in french you should have the need to not feminize some word in function of the context of your sentence.
+
+Take the following code and sentence:
+
+```ruby
+Conchiterz.translate('Nous vous souhaitons un joyeux réveillon, soyez heureux en 2018'
+, true)
+```
+
+We don't want the following result:
+
+```ruby
+'Nous vous souhaitons une joyeuse réveillon, soyez heureuse en 2018'
+```
+Because 'un joyeux réveillon' is invariable in french.
+
+In this way let's introduce the escape option.
+
+Just add an array of which words you not wanted to feminize, check the following code:
+
+```ruby
+[1] pry(main)> require 'conchiterz'
+=> true
+[2] pry(main)> Conchiterz.translate('Nous vous souhaitons un joyeux réveillon, soyez heureux en 2018'
+, true, ['un', 'joyeux'])
+=> 'Nous vous souhaitons un joyeux réveillon, soyez heureuse en 2018'
+```
+Et voila! Easy to feminize your sentence still understandable by french speaker.
+
+## Rails
+
+It adds String#conchiterz(boolean, escape = [])
+
+If you just want to feminize a sentence add in your view,
+
+```ruby
+# app/views/pratiquants/show.html.erb
+
+<%= 'Vous êtes bien inscrit à notre newsletter.'.conchiterz(@pratiquant.female?) %>
+```
+Will return
 
-TODO: Write usage instructions here
+```ruby
+"Vous êtes bien inscrite à notre newsletter."
+```
+if your pratiquant is a female.
 
-## Development
+### Escaping words
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+You wanted to escape some words? Just add these words inside an array and pass it as argument, as follow..
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+# app/views/pratiquants/show.html.erb
+
+<%= 'Nous vous souhaitons un joyeux réveillon et soyez heureux en 2018'.conchiterz(@pratiquant.female?,['un', 'joyeux']) %>
+```
+Will return
+
+```ruby
+'Nous vous souhaitons un joyeux réveillon et soyez heureuse en 2018'
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/conchiterz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/morissetcl/conchiterz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/conchiterz.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["morissetcl87@gmail.com"]
 
   spec.homepage      = "https://github.com/morissetcl/conchiterz"
-  spec.summary       = "Conchiterz allow you to feminize french word/sentence"
+  spec.summary       = "Conchiterz allows you to feminize french sentence"
   spec.license       = "MIT"
   spec.add_development_dependency "rspec", "~> 3.2"
 

data/lib/conchiterz.rb

@@ -1,16 +1,18 @@
 module Conchiterz
+  extend self
+
   module StringMethods
-    def conchiterz(boolean); Conchiterz.translate(self, boolean); end
+    def conchiterz(switch, escape = [])
+      Conchiterz.translate(self, switch, escape)
+    end
   end
-  
-  def self.translate(string, boolean)
+
+  def translate(string, switch, escape = [])
     return if string.nil?
     result = []
-    a_words = string.scan(/[[:alpha:]]+|[.,!?']+/)
-    if boolean == true
-      a_words.each do |word|
-        analyze_string(word, result)
-      end
+    a_words = string.scan(/[[:alpha:][:digit:]]+|[.,!?';]+/)
+    if switch == true
+      a_words.each{ |word| analyze_string(word, result, escape) }
       check_punctuation(result)
       check_special_character(result)
       result.join(' ')
@@ -19,22 +21,24 @@ module Conchiterz
     end
   end
 
-  def self.monkey_patch(mod)
-    mod.send(:include, Conchiterz::StringMethods)
+  def monkey_patch(str)
+    str.send(:include, Conchiterz::StringMethods)
   end
 
   private
 
-  def self.analyze_string(word, result)
+  def analyze_string(word, result, escape)
     check_word_length(word)
-    if TRANSLATION.has_key?(word.downcase)
+    if TRANSLATION.has_key?(word.downcase) && escape.include?(word)
+      result.push(word)
+    elsif TRANSLATION.has_key?(word.downcase)
       get_value(@capitalized, @upcased, result, word)
     else
       result.push(word)
     end
   end
 
-  def self.check_word_length(word)
+  def check_word_length(word)
     if word.length == 1
       @capitalized = (word == word.capitalize)
     else
@@ -43,59 +47,58 @@ module Conchiterz
     end
   end
 
-  def self.get_key(capitalized, upcased, result, word)
-    key = TRANSLATION.key(word.downcase)
-    add_value_to_result(capitalized, upcased, key, result)
-  end
-
-  def self.get_value(capitalized, upcased, result, word)
+  def get_value(capitalized, upcased, result, word)
     value = TRANSLATION.fetch(word.downcase)
     add_value_to_result(capitalized, upcased, value, result)
   end
 
-  def self.add_value_to_result(capitalized, upcased, type, result)
+  def add_value_to_result(capitalized, upcased, value, result)
     if check_sensitive(capitalized, upcased) == false
-      result << type
+      result << value
     else
-      capitalize_or_upcase?(capitalized, upcased, type, result)
+      capitalize_or_upcase(capitalized, upcased, value, result)
     end
   end
 
-  def self.check_sensitive(capitalized, upcased)
-    return unless (capitalized == false && upcased == false)
+  def check_sensitive(capitalized, upcased)
+    return if (capitalized == true || upcased == true)
     false
   end
 
-  def self.capitalize_or_upcase?(capitalized, upcased, type, result)
-    result << type.capitalize if capitalized
-    result << type.upcase if upcased
+  def capitalize_or_upcase(capitalized, upcased, value, result)
+    result << value.capitalize if capitalized
+    result << value.upcase if upcased
   end
 
-  def self.check_punctuation(result)
+  def check_punctuation(result)
+    punctuation = [',','.','!',':',';','?']
     result.each_with_index do |val, index|
-      if val == ',' || val == '.'
-        a = result.index(val)
-        result[a].insert(0, result[a-1])
-        result.delete(result[a-1])
+      if punctuation.include?(val)
+        index = result.index(val)
+        result[index].insert(0, result[index-1])
+        result.delete(result[index-1])
       end
     end
   end
 
-  def self.check_special_character(result)
+  def check_special_character(result)
     result.each_with_index do |val, index|
       if val == "'"
-        a = result.index(val)
-        b = result[a].insert(0, result[a-1])
-        index1 = result.index(b)
-        c = result[index1].insert(-1, result[index1+1])
-        d = result[result.index(c)+1]
-        v = result[result.index(c)-1]
-        result.delete_at(result.index(v))
-        result.delete_at(result.index(c)+1)
+        index = result.index(val)
+        word = [result[index-1], result[index], result[index+1]]
+        delete_useless_value(word, index, result)
+        result.insert(index-1, word.join(''))
       end
     end
   end
 
+  def delete_useless_value(word, index, result)
+    word.each do |a|
+      index_to_delete = result.index(a)
+      result.delete_at(index_to_delete)
+    end
+  end
+
   TRANSLATION =
     {
       'beau' => 'belle',
@@ -111,7 +114,13 @@ module Conchiterz
       'pareils' => 'pareilles',
       'monsieur' => 'madame',
       'm' => 'mme',
-      'le' => 'la'
+      'le' => 'la',
+      'chers' => 'chères',
+      'cher' => 'chère',
+      'bon' => 'bonne',
+      'super' => 'superbe',
+      'un' => 'une',
+      'heureux' => 'heureuse'
     }
 
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Conchiterz
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conchiterz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Clement Morisset
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-10 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -93,5 +93,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Conchiterz allow you to feminize french word/sentence
+summary: Conchiterz allows you to feminize french sentence
 test_files: []