sluger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b36771ebb81cf3bef684ec32dc061527ee21ae0
+  data.tar.gz: 21feb450d84edc38b77076e82efa11d51bfec2b3
+SHA512:
+  metadata.gz: e35775ed9228a1c7f683be817d0228d9dc6043bef15d1bb1e696ec10acaaab57d3f4dc2b2dbe5df2732f1d5faebf0e237fc3556b8db0f094735017e9569b44d2
+  data.tar.gz: 60bee85d7d019631b261bdf7b81b5ead9099e3555aff52d2c52fbec6e36d493c9ba7a160f5519f576912496a270f9d56e3e5aeac7e159c3eebdde4e026d5d142

data/.gitignore

@@ -0,0 +1,24 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.idea/
+*~
+.DS_Store
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sluger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eugene Kondratyuk
+
+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,78 @@
+# Sluger
+
+Sluger is a plugin for generating SEO friendly permalinks. It adds ability to use
+alphabetic ID for entities instead of numeric ID.
+
+For instance, without sluger the helper `article_url(article)` returns:
+
+    http://localhost:3000/articles/1
+
+But with sluger this helper will return:
+
+    http://localhost:3000/articles/seo-friendly-name
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sluger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sluger
+
+## Usage
+
+Add a column which will store role/roles as integer:
+
+```ruby
+add_column :articles, :slug, :string, null: false, limit: 150
+add_index :articles, :slug, unique: true
+```
+
+And then tell a model that you use this gem functionality:
+
+```ruby
+# app/models/article.rb
+class Article < ActiveRecord::Base
+  sluger :title, :slug
+end
+```
+
+## Options
+
+For now the gem has only one option - `limit`. It helps to limit a slug's length. If you set
+the limit all extra characters will be cut.
+
+```ruby
+# app/models/article.rb
+class Article < ActiveRecord::Base
+  sluger :title, :slug, limit: 150
+end
+```
+
+So you can do this:
+
+```ruby
+article = Article.create!(title: 'Hello World!')
+article.slug # => hello-world
+article.title = 'New World!'
+article.save! # => hello-world
+article.slug = nil
+article.save! # => new-world
+article.to_param # => new-world
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ekondr/sluger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sluger"
+
+# 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

data/bin/setup

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

data/lib/generators/sluger/locales_generator.rb

@@ -0,0 +1,13 @@
+module Sluger
+  module Generators
+    class LocalesGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+      argument :locale_code, type: :string, default: 'uk'
+
+      desc 'Add localizations for transliterating.'
+      def copy_initializer_file
+        copy_file "#{locale_code.downcase}.yml", "config/locales/sluger.#{locale_code.downcase}.yml"
+      end
+    end
+  end
+end

data/lib/generators/templates/ru.yml

@@ -0,0 +1,73 @@
+ru:
+  i18n:
+    transliterate:
+      rule:
+        А: "A"
+        Б: "B"
+        В: "V"
+        Г: "G"
+        Д: "D"
+        Е: "E"
+        Ё: "E"
+        Ж: "J"
+        З: "Z"
+        И: "I"
+        Й: "Y"
+        К: "K"
+        Л: "L"
+        М: "M"
+        Н: "N"
+        О: "O"
+        П: "P"
+        Р: "R"
+        С: "S"
+        Т: "T"
+        У: "U"
+        Ф: "F"
+        Х: "H"
+        Ц: "C"
+        Ч: "CH"
+        Ш: "SH"
+        Щ: "SCH"
+        Ъ: ""
+        Ы: "Y"
+        Ь: ""
+        Э: "E"
+        Ю: "U"
+        Я: "YA"
+        а: "a"
+        б: "b"
+        в: "v"
+        г: "g"
+        д: "d"
+        е: "e"
+        ё: "e"
+        ж: "j"
+        з: "z"
+        и: "i"
+        й: "y"
+        к: "k"
+        л: "l"
+        м: "m"
+        н: "n"
+        о: "o"
+        п: "p"
+        р: "r"
+        с: "s"
+        т: "t"
+        у: "u"
+        ф: "f"
+        х: "h"
+        ц: "c"
+        ч: "ch"
+        ш: "sh"
+        щ: "sch"
+        ъ: ""
+        ы: "y"
+        ь: ""
+        э: "e"
+        ю: "u"
+        я: "ya"
+        №: "#"
+        —: "-"
+        /: "-"

data/lib/generators/templates/uk.yml

@@ -0,0 +1,75 @@
+uk:
+  i18n:
+    transliterate:
+      rule:
+        А: "A"
+        Б: "B"
+        В: "V"
+        Г: "h"
+        Ѓ: "G"
+        Д: "D"
+        Е: "E"
+        Є: "YE"
+        Ж: "ZH"
+        З: "Z"
+        И: "Y"
+        І: "I"
+        Ї: "YI"
+        Й: "J"
+        К: "K"
+        Л: "L"
+        М: "M"
+        Н: "N"
+        О: "O"
+        П: "P"
+        Р: "R"
+        С: "S"
+        Т: "T"
+        У: "U"
+        Ф: "F"
+        Х: "X"
+        Ц: "C"
+        Ч: "CH"
+        Ш: "SH"
+        Щ: "SHH"
+        Ь: ""
+        Ю: "YU"
+        Я: "YA"
+        а: "a"
+        б: "b"
+        в: "v"
+        г: "h"
+        ѓ: "g"
+        д: "d"
+        е: "e"
+        є: "ye"
+        ж: "zh"
+        з: "z"
+        и: "y"
+        і: "i"
+        ї: "yi"
+        й: "j"
+        к: "k"
+        л: "l"
+        м: "m"
+        н: "n"
+        о: "o"
+        п: "p"
+        р: "r"
+        с: "s"
+        т: "t"
+        у: "u"
+        ф: "f"
+        х: "x"
+        ц: "c"
+        ч: "ch"
+        ш: "sh"
+        щ: "shh"
+        ы: "y"
+        ь: ""
+        э: "e"
+        ю: "yu"
+        я: "ya"
+        №: "#"
+        —: "-"
+        /: "-"

data/lib/sluger.rb

@@ -0,0 +1,51 @@
+require 'sluger/version'
+
+module Sluger
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def sluger(*args)
+      options = { limit: 255 }
+      title_column = args.length > 0 ? args[0] : :title
+      slug_column = args.length > 1 ? args[1] : :slug
+      options.merge!(args[2]) if args.length > 2 && args[2].is_a?(Hash)
+      has_limit = options[:limit] > 0
+
+      self.class_eval do
+        before_validation :process_slugering
+      end
+
+      define_singleton_method(:slugering) do |entity, title|
+        return nil if title.blank?
+
+        new_slug = title.parameterize
+        new_slug = title[0, options[:limit]] if has_limit && new_slug.length > options[:limit]
+
+        pk = self.primary_key
+        relation = self
+        relation = relation.where.not(pk => entity[pk]) unless entity.new_record?
+
+        index = 0
+        base_slug = new_slug
+        while relation.where("#{slug_column} = ?", new_slug).count > 0 do
+          index += 1
+          new_slug = base_slug[0, options[:limit] - index.to_s.length - 1] if has_limit
+          new_slug = "#{new_slug}-#{index}"
+        end
+        new_slug
+      end
+
+      define_method(:process_slugering) do
+        return unless self[slug_column].blank?
+        new_value = self[title_column]
+        self[slug_column] = self.class.send(:slugering, self, new_value)
+      end
+
+      define_method(:to_param) do
+        self[slug_column]
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Sluger)

data/lib/sluger/version.rb

@@ -0,0 +1,3 @@
+module Sluger
+  VERSION = "0.1.0"
+end

data/sluger.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sluger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sluger'
+  spec.version       = Sluger::VERSION
+  spec.authors       = ['Eugene Kondratiuk']
+  spec.email         = ['ekondr@gmail.com']
+
+  spec.summary       = 'Sluger is a plugin for generating SEO friendly permalinks.'
+  spec.description   = 'Sluger is a plugin for generating SEO friendly permalinks. It adds ability to use alphabetic ID for entities instead of numeric ID.'
+  spec.homepage      = 'https://github.com/ekondr/sluger'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: sluger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eugene Kondratiuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sluger is a plugin for generating SEO friendly permalinks. It adds ability
+  to use alphabetic ID for entities instead of numeric ID.
+email:
+- ekondr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/sluger/locales_generator.rb
+- lib/generators/templates/ru.yml
+- lib/generators/templates/uk.yml
+- lib/sluger.rb
+- lib/sluger/version.rb
+- sluger.gemspec
+homepage: https://github.com/ekondr/sluger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sluger is a plugin for generating SEO friendly permalinks.
+test_files: []