url_slug 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e826d6198dc0c58d0feb8dd633c7dbc091d1136a7628e07482d6ead03b1ecc7
+  data.tar.gz: a35d57158513f68267ad17fbca91536ebb6f935a39d2c5ad2373d9d56ea61fcc
+SHA512:
+  metadata.gz: 0dc24817c0121fbf61b64967c06039634b0cf6b8cde7dbd842a1b403786ea63b578b6fd8f6a6c1b3eed153e9e9660a772dd831395d31a6cad30ba2262173fb8c
+  data.tar.gz: db8c904a42d4230b102cc13cbd6fe271f95b8de94c3135f2481ec60af7bc0d3c362e87a1aecd05c093af9e6d15b301e9a0e3292127764fe34392362dba0e5b0c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+AllCops:
+  Exclude:
+    - url_slug.gemspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 goran@domain.tld. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in url_slug.gemspec
+gemspec
+
+gem 'activesupport'
+gem 'thor'
+
+group :development do
+  gem 'rake', '~> 13.0'
+end
+
+group :development, :test do
+  gem 'byebug'
+  gem 'rspec', '~> 3.0', require: false
+  gem 'rubocop', '~> 1.21', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+group :test do
+  gem 'i18n', '~> 1.13', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,139 @@
+PATH
+  remote: .
+  specs:
+    url_slug (0.1.1)
+      activesupport (>= 4.0.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.5)
+      actionview (= 7.0.5)
+      activesupport (= 7.0.5)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.5)
+      activesupport (= 7.0.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.5)
+      activesupport (= 7.0.5)
+    activerecord (7.0.5)
+      activemodel (= 7.0.5)
+      activesupport (= 7.0.5)
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    thor (1.2.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (>= 4.0)
+  activesupport
+  byebug
+  i18n (~> 1.13)
+  railties (>= 4.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  thor
+  url_slug!
+
+BUNDLED WITH
+   2.3.13

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Write your name
+
+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,133 @@
+# UrlSlug
+
+UrlSlug is a slug/permalink plugin with ActiveRecord and I18n support. It lets you create SEO friendly URLs.
+
+With UrlSlug, it's easy to make your application use URLs like:
+
+    https://example.com/posts/this-is-a-friendly-url
+
+or
+
+    https://example.com/posts/123-this-is-a-friendly-url
+
+instead of:
+
+    https://example.com/posts/123
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'url_slug'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Run the generator
+
+```shell
+# thor url_slug:install ClassName field:attr --path="path/to/class.rb"
+thor url_slug:install Person name:slug --path="libs/person.rb"
+```
+
+or add it manually
+
+
+```ruby
+class Person
+  include UrlSlug
+  url_slug_for :name, attr: :slug
+
+  ...
+end
+
+person = Person.new
+person.name = "John Doe"
+person.slug #=> "john-doe"
+```
+
+The `slug` attribute is optional. If you dont define it, then `:name_slug` will be used as attribute
+
+```
+  url_slug_for :name # creates :name_slug attribute
+
+  person.name_slug
+```
+
+## Ruby on Rails
+
+Run the install generator.
+
+```shell
+# rails g url_slug:rails ClassName field:field_slug --migration
+rails g url_slug:rails Person name --migration
+```
+
+or add it manually
+
+Edit the class file (e.g `app/models/person.rb`):
+
+```ruby
+class Person < ApplicationRecord
+  include UrlSlug
+  url_slug_for :name
+end
+```
+
+Now when you create a new Person:
+
+```ruby
+person = Person.create!(name: "Ivan The Terrible")
+person.name_slug #=> "ivan-the-terrible"
+```
+
+Optionally, if you want to persist the slug to db, create a migration
+
+```shell
+rails g migration AddNameSlugToPersons name_slug:string
+rails db:migrate
+```
+
+### I18n support
+
+Make sure you have locale files in place
+
+
+```ruby
+I18n.with_locale(:de) do
+  person = Person.create!(name: "Wörter")
+  person.name_slug #=> "worter"
+end
+```
+
+## Bugs
+
+Please report them on the [Github issue
+tracker](https://github.com/gorangorun/url_slug/issues) for this project.
+
+## License
+
+Copyright (c) 2023 Goran Gjuroski, released under the MIT license.
+
+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/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/Thorfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'lib/generators/url_slug/install_generator'

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'url_slug'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/url_slug/actions.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'byebug'
+
+module UrlSlug
+  module Generators
+    module Actions
+      extend ActiveSupport::Concern
+
+      included do
+        argument :fields, type: :string
+
+        def include_module_into_class
+          puts "#{class_file_path} not found" unless class_exists?
+          puts "Module already included in #{class_file_path}" if class_exists? && module_included?
+
+          inject_into_file(
+            class_file_path,
+            "  include UrlSlug\n",
+            after: /^class #{class_name}[^\n]*\n/
+          )
+        end
+
+        def inject_macro_into_class
+          puts "#{class_file_path} not found" unless class_exists?
+          puts "Macro url_slug_for already included in #{class_file_path}" if class_exists? && macro_included?
+
+          inject_into_file(
+            class_file_path,
+            build_macro,
+            after: /^  include UrlSlug\n/
+          )
+        end
+      end
+
+      private
+
+      def class_file_path
+        "#{singular_name}.rb"
+      end
+
+      def class_exists?
+        File.exist?(class_file_path)
+      end
+
+      def module_included?
+        File.read(class_file_path).include?('include UrlSlug')
+      end
+
+      def macro_included?
+        File.read(class_file_path).include?("url_slug_for :#{slug_for}")
+      end
+
+      def slug_for
+        @slug_for ||= fields.split(':').first
+      end
+
+      def attr
+        @attr ||= fields.split(':')[1]
+      end
+
+      def build_macro
+        macro = '  url_slug_for '
+        macro += ":#{slug_for}"
+        macro += ", attr: :#{attr}" if attr.present?
+        macro += "\n"
+        macro
+      end
+    end
+  end
+end

data/lib/generators/url_slug/install_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'actions'
+
+module UrlSlug
+  module Generators
+    class InstallGenerator < Thor::Group
+      include Thor::Actions
+
+      desc 'Install UrlSlug'
+      argument :klass, type: :string
+
+      include Actions
+
+      namespace 'url_slug:install'
+      class_option :path
+
+      private
+
+      def singular_name
+        klass.singularize.downcase
+      end
+
+      def class_name
+        klass
+      end
+
+      def class_file_path
+        options[:path] || super
+      end
+    end
+  end
+end

data/lib/generators/url_slug/rails/rails_generator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+require 'rails/generators/active_record'
+require_relative '../actions'
+
+module UrlSlug
+  module Generators
+    class RailsGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      include Actions
+      source_root File.expand_path('templates', __dir__)
+
+      class_option :migration, type: :boolean
+
+      def create_url_slug_migration
+        return unless include_migration?
+
+        if table_exists?
+          create_add_slug_to_table_migration
+        else
+          puts "#{table_name} table does not exists"
+        end
+      end
+
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      private
+
+      def create_add_slug_to_table_migration
+        config = {
+          migration_version: migration_version,
+          column: slug_attr,
+          table: table_name
+        }
+
+        migration_template(
+          'db/migrate/add_slug_to_table.rb.erb',
+          File.join(migration_path, "add_#{slug_attr}_to_#{plural_name}.rb"),
+          config
+        )
+      end
+
+      def class_file_path
+        "app/models/#{super}"
+      end
+
+      def migration_path
+        'db/migrate'
+      end
+
+      def include_migration?
+        options.key?(:migration)
+      end
+
+      def table_exists?
+        ActiveRecord::Base.connection.data_source_exists?(table_name)
+      end
+
+      def slug_attr
+        attr.present? ? attr : "#{slug_for}_slug"
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/url_slug/rails/templates/db/migrate/add_slug_to_table.rb.erb

@@ -0,0 +1,5 @@
+class Add<%= config[:column].camelize %>To<%= config[:table].camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :<%= config[:table] %>, :<%= config[:column] %>, :string
+  end
+end

data/lib/url_slug/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module UrlSlug
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    def i18n_load_path
+      ::I18n.load_path
+    end
+
+    def i18n_load_path=(value)
+      ::I18n.load_path += value
+    end
+  end
+end

data/lib/url_slug/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UrlSlug
+  VERSION = '0.1.2'
+end

data/lib/url_slug.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'url_slug/version'
+require 'url_slug/configuration'
+require 'active_support/inflector'
+require 'active_support/concern'
+
+module UrlSlug
+  include ActiveSupport::Inflector
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def url_slug_for(name, args = {})
+      slug_name = args[:attr] || "#{name}_slug"
+
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{slug_name}
+          defined?(super) ? super : @#{slug_name}
+        end
+
+        def #{slug_name}=(value)
+          return if value.nil?
+          defined?(super) ? super(value.parameterize) : @#{slug_name} = value.parameterize
+        end
+
+        def #{name}=(value)
+          self.#{slug_name} = value
+          defined?(super) ? super(value) : @#{name} = value
+        end
+      CODE
+    end
+  end
+end

data/sig/url_slug.rbs

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

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'url_slug'
+require 'rails/generators'
+require 'generators/url_slug/install_generator'
+require 'generators/url_slug/rails/rails_generator'
+require 'support/generator_spec_helpers'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/generator_spec_helpers.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module GeneratorSpecHelpers
+  TMP_DIR = File.expand_path('tmp')
+
+  def file(filename)
+    File.join(TMP_DIR, filename)
+  end
+
+  def file_content(filename)
+    File.read(file(filename))
+  end
+
+  def file_exists?(filename)
+    File.exist?(file(filename))
+  end
+
+  def provide_existing_class(class_file, class_name)
+    copy_to_generator_tmp(template_class(class_name), file(class_file))
+  end
+
+  def prepare_destination
+    FileUtils.rm_rf(Dir[File.join(TMP_DIR, '*')])
+  end
+
+  def capture_output
+    original_stdout = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = original_stdout
+  end
+
+  private
+
+  def copy_to_generator_tmp(template, destination)
+    FileUtils.mkdir_p(File.dirname(destination))
+    FileUtils.cp(template, destination)
+  end
+
+  def template_class(class_name)
+    File.expand_path("spec/support/#{class_name}")
+  end
+end
+
+RSpec.configure do |config|
+  config.include GeneratorSpecHelpers
+
+  config.after(:example, :generator) do
+    prepare_destination
+  end
+end

data/spec/support/locales/mk.yml

@@ -0,0 +1,35 @@
+mk:
+  i18n:
+    transliterate:
+      rule:
+        'а': a
+        'б': b
+        'в': v
+        'г': g
+        'д': d
+        'ѓ': gj
+        'е': e
+        'ж': zh
+        'з': z
+        'ѕ': s
+        'и': i
+        'ј': j
+        'к': k
+        'л': l
+        'љ': lj
+        'м': m
+        'н': n
+        'њ': nj
+        'о': o
+        'п': p
+        'р': r
+        'с': s
+        'т': t
+        'ќ': kj
+        'у': u
+        'ф': f
+        'х': h
+        'ц': c
+        'ч': ch
+        'џ': dz
+        'ш': sh

data/spec/support/post

@@ -0,0 +1,2 @@
+class Post
+end

data/spec/url_slug/generators/install_generator_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe UrlSlug::Generators::InstallGenerator, :generator do
+  let(:generator) { described_class.new(*params) }
+  let(:class_name) { 'Post' }
+  let(:field) { 'title' }
+
+  before do
+    allow(generator).to receive(:class_file_path).and_return(file(class_filename))
+
+    provide_existing_class(class_filename, class_name.downcase)
+
+    capture_output { generator.invoke_all }
+  end
+
+  describe 'class file' do
+    let(:params) { [[class_name, field]] }
+
+    it 'includes UrlSlug module' do
+      expect(class_content).to include('include UrlSlug')
+    end
+
+    it 'includes macro' do
+      expect(class_content).to include("url_slug_for :#{field}")
+    end
+  end
+
+  def class_filename
+    "#{class_name.downcase}.rb"
+  end
+
+  def field_slug
+    "#{field}_slug"
+  end
+
+  def class_content
+    file_content(class_filename)
+  end
+end

data/spec/url_slug/generators/rails_generator_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe UrlSlug::Generators::RailsGenerator, :generator do
+  let(:generator) { described_class.new(*params) }
+  let(:class_name) { 'Post' }
+  let(:field) { 'title' }
+  let(:migration_number) { '00000000000000' }
+
+  before do
+    stub_const('MODEL_DIR', 'app/models')
+    stub_const('MIGRATION_DIR', 'db/migrate')
+
+    allow(generator).to receive(:class_file_path).and_return(file(class_path))
+    allow(generator).to receive(:migration_path).and_return('tmp/db/migrate')
+    allow(generator).to receive(:table_exists?).and_return(true)
+    allow(generator).to receive(:migration_version).and_return('7.0')
+    allow(described_class).to receive(:next_migration_number).and_return(migration_number)
+
+    provide_existing_class(class_path, class_name.downcase)
+
+    capture_output { generator.invoke_all }
+  end
+
+  describe 'class file' do
+    let(:params) { [[class_name, field]] }
+
+    xit 'check syntaxt' do
+    end
+
+    it 'includes UrlSlug module' do
+      expect(file_content(class_path)).to include('include UrlSlug')
+    end
+
+    it 'includes macro' do
+      expect(file_content(class_path)).to include("url_slug_for :#{field}")
+    end
+
+    it 'doesnt generate migration file' do
+      expect(migration_exists?).to be(false)
+    end
+  end
+
+  describe 'migration file' do
+    let(:params) { [[class_name, field], { migration: true }] }
+
+    it 'generates migration file' do
+      expect(migration_exists?).to be(true)
+    end
+
+    it 'contains add_column' do
+      result = "add_column :#{plural_name}, :#{field_slug}, :string"
+      expect(file_content(migration_path)).to include(result)
+    end
+  end
+
+  def plural_name
+    class_name.downcase.pluralize
+  end
+
+  def field_slug
+    "#{field}_slug"
+  end
+
+  def class_filename
+    "#{class_name.downcase}.rb"
+  end
+
+  def class_path
+    File.join(MODEL_DIR, class_filename)
+  end
+
+  def migration_filename
+    "#{migration_number}_add_#{field_slug}_to_#{plural_name}.rb"
+  end
+
+  def migration_path
+    File.join(MIGRATION_DIR, migration_filename)
+  end
+
+  def migration_exists?
+    file_exists?(migration_path)
+  end
+end

data/spec/url_slug_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'byebug'
+
+RSpec.describe UrlSlug do
+  let(:klass) do
+    Class.new do
+      include UrlSlug
+
+      attr_accessor :title
+
+      url_slug_for :title, persistence: false
+    end
+  end
+
+  let(:instance) { klass.new }
+
+  it 'has a version number' do
+    expect(UrlSlug::VERSION).not_to be nil
+  end
+
+  it 'defines the slug_name reader' do
+    expect(instance.respond_to?(:title_slug)).to be true
+  end
+
+  it 'defines the slug_name writer' do
+    expect(instance.respond_to?(:title_slug=)).to be true
+  end
+
+  it 'parameterizes slug' do
+    instance.title = 'foo bar'
+    expect(instance.title_slug).to eq('foo-bar')
+  end
+
+  it 'does not parameterize slug for empty string' do
+    expect(instance.title_slug).to eq(nil)
+  end
+
+  describe 'With i18n support' do
+    before do
+      described_class.configure do |config|
+        config.i18n_load_path = Dir[File.join('spec/support/locales', '**/*.*')]
+      end
+    end
+
+    it 'parameterizes and transliterates slug' do
+      I18n.available_locales = %i[en mk]
+
+      I18n.with_locale(:mk) do
+        instance.title = 'фоо бар'
+        expect(instance.title_slug).to eq('foo-bar')
+      end
+    end
+  end
+end

data/url_slug.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/url_slug/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'url_slug'
+  spec.version = UrlSlug::VERSION
+  spec.authors = ['Goran Gjuroski']
+  spec.email = ['gorang.pub@gmail.com']
+
+  spec.summary = 'Yet another URL slug plugin.'
+  spec.description = 'UrlSlug is a slug/permalink plugin with ActiveRecord and I18n support. It lets you create SEO friendly URLs.'
+  spec.homepage = 'https://github.com/gorangorun/url_slug'
+  spec.extra_rdoc_files = %w(LICENSE README.md)
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+  spec.add_dependency 'thor'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'i18n', '~> 1.13'
+  spec.add_development_dependency 'railties', '>= 4.0'
+  spec.add_development_dependency 'activerecord', '>= 4.0'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: url_slug
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Goran Gjuroski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: UrlSlug is a slug/permalink plugin with ActiveRecord and I18n support.
+  It lets you create SEO friendly URLs.
+email:
+- gorang.pub@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- Thorfile
+- bin/console
+- bin/setup
+- lib/generators/url_slug/actions.rb
+- lib/generators/url_slug/install_generator.rb
+- lib/generators/url_slug/rails/rails_generator.rb
+- lib/generators/url_slug/rails/templates/db/migrate/add_slug_to_table.rb.erb
+- lib/url_slug.rb
+- lib/url_slug/configuration.rb
+- lib/url_slug/version.rb
+- sig/url_slug.rbs
+- spec/spec_helper.rb
+- spec/support/generator_spec_helpers.rb
+- spec/support/locales/mk.yml
+- spec/support/post
+- spec/url_slug/generators/install_generator_spec.rb
+- spec/url_slug/generators/rails_generator_spec.rb
+- spec/url_slug_spec.rb
+- url_slug.gemspec
+homepage: https://github.com/gorangorun/url_slug
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gorangorun/url_slug
+  source_code_uri: https://github.com/gorangorun/url_slug
+  changelog_uri: https://github.com/gorangorun/url_slug
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Yet another URL slug plugin.
+test_files: []