slugfy_me 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6fa2321892027e9668f63b4c4ab0d58a07e89b3c5e9065b1690f4b977ef6d2c
+  data.tar.gz: 522af9004bf0d188f64bac935cbf280a2b6723641dc49f88ce61ad8011d52a20
+SHA512:
+  metadata.gz: 329fade8a25dd8d2b3d0f86210bf5982efd235db1be6e6439ace8bc1dcf97f411af984511caac5af18c9982169d85ef6f4aa1496ce7bc99100145a58e78f4187
+  data.tar.gz: 721f8467a0ca3f33a83a8d286ec1bf136e9fe2963c782488386c302089a2b1265990585ac0acd5e685f4d2c0afe821239610b2d88c3ce780bcd4399166e35f59

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-01
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 francilobbie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# SlugfyMe
+
+**EN:** A lightweight Ruby gem to generate clean slugs from strings, with basic accent and punctuation handling.
+**FR :** Une petite gem Ruby pour transformer des chaînes de caractères en slugs propres, avec gestion simple des accents et ponctuation.
+
+---
+
+## 🇫🇷 Présentation
+
+`SlugfyMe` est une gem Ruby éducative développée dans le cadre du blog [**Captain Ruby**](https://www.linkedin.com/company/captainruby), une ressource de référence pour la communauté Ruby francophone.
+
+Elle permet de transformer une chaîne comme :
+
+```ruby
+SlugfyMe.slugify("C'est quoi Ruby ?")
+# => "cest-quoi-ruby"
+```
+
+Vous pouvez également personnaliser le séparateur :
+
+```ruby
+SlugfyMe.slugify("Ruby c'est cool", separator: "_")
+# => "ruby_cest_cool"
+```
+
+Cette gem a été pensée comme un projet simple pour découvrir comment créer, tester et publier une gem Ruby.
+Elle n’a pas vocation à remplacer une solution complète comme `parameterize` ou `stringex`.
+
+---
+
+## 🇬🇧 About
+
+`SlugfyMe` is a minimalist Ruby gem built as part of [**Captain Ruby**](https://www.linkedin.com/company/captainruby), a French-speaking blog dedicated to Ruby and Rails developers.
+
+It turns strings like:
+
+```ruby
+SlugfyMe.slugify("What is Ruby?")
+# => "what-is-ruby"
+```
+
+You can also customize the separator:
+
+```ruby
+SlugfyMe.slugify("Ruby is cool", separator: "_")
+# => "ruby_is_cool"
+```
+
+This gem is educational: it's designed to help developers understand how to build, test, and publish a Ruby gem from scratch.
+It is not meant to compete with full-featured libraries like `stringex` or `parameterize`.
+
+---
+
+## ✨ Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'slugfy_me'
+```
+
+Or install it manually:
+
+```bash
+gem install slugfy_me
+```
+
+---
+
+## ✅ Usage
+
+```ruby
+require "slugfy_me"
+
+SlugfyMe.slugify("Crème brûlée au Café !")
+# => "creme-brulee-au-cafe"
+
+SlugfyMe.slugify("Salut à tous !", separator: "_")
+# => "salut_a_tous"
+```
+
+---
+
+## 🧪 Pourquoi cette gem ?
+
+Ce projet fait partie d’un article publié sur [Captain Ruby](https://www.linkedin.com/company/captainruby), un blog francophone dédié à Ruby, Rails et à la transmission du savoir dans notre belle communauté 🖠️
+
+Le but est de **montrer pas à pas** comment créer une gem Ruby et la publier sur RubyGems, avec des explications simples et accessibles.
+
+---
+
+## 🧑‍💻 Développement
+
+Après avoir cloné le repo, lance :
+
+```bash
+bin/setup
+```
+
+Pour exécuter les tests :
+
+```bash
+bundle exec rspec
+```
+
+Pour tester ta gem en local dans un environnement interactif :
+
+```bash
+bin/console
+```
+
+Pour installer la gem en local :
+
+```bash
+bundle exec rake install
+```
+
+Pour publier une nouvelle version :
+
+1. Mets à jour la version dans `lib/slugfy_me/version.rb`
+2. Lance :
+
+```bash
+bundle exec rake release
+```
+
+---
+
+## 🤝 Contributing
+
+Les pull requests sont les bienvenues !
+Tu peux proposer des améliorations simples : nouveaux caractères à gérer, support de langues, options de formatage supplémentaires, etc.
+
+Retrouve le projet sur GitHub :
+[https://github.com/francilobbie/slugfy_me](https://github.com/francilobbie/slugfy_me)
+
+Merci de suivre le [code de conduite](https://github.com/francilobbie/slugfy_me/blob/master/CODE_OF_CONDUCT.md).
+
+---
+
+## 📄 Licence
+
+La gem est disponible sous licence [MIT](https://opensource.org/licenses/MIT).
+
+---
+
+> 🇫🇷 Cette gem a été créée pour les besoins du blog [Captain Ruby](https://www.linkedin.com/company/captainruby) — le repère des passionnés de Ruby et Rails en français.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/slugfy_me/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SlugfyMe
+  VERSION = "0.1.0"
+end

data/lib/slugfy_me.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "slugfy_me/version"
+
+module SlugfyMe
+  def self.slugify(string, separator: '-')
+    string = remove_accents(string)
+    string.downcase
+          .gsub(/[^a-z0-9\s]/, '')     # garde lettres, chiffres et espaces
+          .strip
+          .gsub(/\s+/, separator)      # remplace les espaces par le séparateur choisi
+  end
+
+
+  def self.remove_accents(string)
+    accents = {
+      'àáâãäå' => 'a',
+      'ç'      => 'c',
+      'èéêë'   => 'e',
+      'ìíîï'   => 'i',
+      'ñ'      => 'n',
+      'òóôõö'  => 'o',
+      'ùúûü'   => 'u',
+      'ýÿ'     => 'y'
+    }
+
+    accents.each do |group, replacement|
+      string = string.gsub(/[#{group}]/i, replacement)
+    end
+
+    string
+  end
+end

data/sig/slugfy_me.rbs

@@ -0,0 +1,4 @@
+module SlugfyMe
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: slugfy_me
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- francilobbie
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-04 00:00:00.000000000 Z
+dependencies: []
+description: SlugfyMe is a minimalist Ruby gem created for the Captain Ruby blog.
+  It helps you generate clean slugs from strings, and was built as an educational
+  project to learn how to build and publish a Ruby gem.
+email:
+- francilobbie.lalane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slugfy_me.rb
+- lib/slugfy_me/version.rb
+- sig/slugfy_me.rbs
+homepage: https://github.com/francilobbie/slugfy_me
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/francilobbie/slugfy_me
+  source_code_uri: https://github.com/francilobbie/slugfy_me
+  changelog_uri: https://github.com/francilobbie/slugfy_me/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: An educational Ruby gem to generate simple slugs from strings
+test_files: []