to_slug_param 1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6d5f3779a49d050bdfd8d7acf006394b0466170
+  data.tar.gz: 99dbaa222ad987d333b0a1b5e06af4814319784f
+SHA512:
+  metadata.gz: 90e3f63eb644e74a8b40634138a31f49cbaa109c1685b77a117c46e96cf2e4ae839a8cb7c916d9368fd1c0a3ce1b7456e63a5640dae7c4dea50d0438abe5867b
+  data.tar.gz: 5bfcb5e8adcbcb4d942503b9029264e6e709519ce8919c2e89c136f76fe44cdb090886b500a4a3695d740081e8236cbd03b85520e8625c9e7f1bea5c1a5134ed

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ilya N. Zykin
+
+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/README.md

@@ -0,0 +1,91 @@
+### ToSlugParam
+
+Convert strings and symbols to slug param
+
+Transliteration + Parameterization for slugs building
+
+#### Install
+
+```ruby
+gem "to_slug_param", "~> 1.2"
+```
+
+<a href="http://rubygems.org/gems/to_slug_param">RubyGems/to_slug_param</a>
+
+#### Using
+
+For russian transliteration by default
+
+```ruby
+I18n.enforce_available_locales = true
+
+module DummyApp
+  class Application < Rails::Application
+    config.i18n.default_locale = :ru
+  end
+end
+```
+
+```ruby
+"Привет Мир! Hello world!".to_slug_param
+# => "privet-mir-hello-world"
+
+String.to_slug_param("Привет Мир! Hello world!")
+# => "privet-mir-hello-world"
+```
+
+Be carefully with file extension
+
+```ruby
+"Документ.doc".to_slug_param
+# => "dokument-doc"
+```
+
+For filenames:
+
+```ruby
+"/доки/dir/тест/документ.doc".slugged_filename         #=> "dokument.doc"
+String.slugged_filename("/доки/dir/тест/документ.doc") #=> "dokument.doc"
+```
+
+For full file path:
+
+```ruby
+"/доки/dir/тест/документ.doc".slugged_filepath         #=> "/доки/dir/тест/dokument.doc"
+String.slugged_filepath("/доки/dir/тест/документ.doc") #=> "/доки/dir/тест/dokument.doc"
+```
+
+Params
+
+```ruby
+"Документ.doc".to_slug_param(locale: :ru) # => "dokument-doc"
+"Документ.doc".to_slug_param(locale: :en) # => "doc"
+```
+
+```ruby
+"Документ.doc".to_slug_param(sep: '_', locale: :ru) # => "dokument_doc"
+"Документ.doc".to_slug_param(sep: '_', locale: :en) # => "doc"
+```
+
+### MIT-LICENSE
+
+##### Copyright (c) 2013-2014 [Ilya N.Zykin]
+
+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 @@
+require "bundler/gem_tasks"

data/config/locales/yandex_translit.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+# Russian for Yandex. Based on:
+# (c) Yaroslav Markin, Julian "julik" Tarkhanov and Co
+# https://github.com/yaroslav/russian/blob/master/lib/russian/transliteration.rb
+
+module RailsI18n
+  module Transliteration
+    module Russian
+      class << self
+        def rule
+          lambda do |string|
+            chars = string.scan(%r{#{multi_keys.join '|'}|\w|.})
+
+            result = ""
+
+            chars.each_with_index do |char, index|
+              if upper.has_key?(char) && lower.has_key?(chars[index+1])
+                # combined case
+                result << upper[char].downcase.capitalize
+              elsif upper.has_key?(char)
+                result << upper[char]
+              elsif lower.has_key?(char)
+                result << lower[char]
+              else
+                result << char
+              end
+            end
+
+            result
+          end
+        end
+
+        private
+
+        # use instance variables instead of constants to prevent warnings
+        # on re-evaling after I18n.reload!
+
+        def upper
+          @upper ||= begin
+            upper_single = {
+              "Ё"=>"E","Э"=>"E","Ю"=>"YU","Я"=>"YA",
+              "Ж"=>"ZH","Х"=>"KH","Й"=>"J",
+              "Ц"=>"TS","Ш"=>"SH","Щ"=>"SCH","Ь"=>"","Ъ"=>"",
+
+              "Ґ"=>"G","Є"=>"E","Ї"=>"YI","І"=>"I",
+              "А"=>"A","Б"=>"B","В"=>"V","Г"=>"G",
+              "Д"=>"D","Е"=>"E","З"=>"Z","И"=>"I",
+              "К"=>"K","Л"=>"L","М"=>"M","Н"=>"N",
+              "О"=>"O","П"=>"P","Р"=>"R","С"=>"S",
+              "Т"=>"T","У"=>"U","Ф"=>"F","Ч"=>"CH","Ы"=>"Y"
+            }
+
+            (upper_single.merge(upper_multi)).freeze
+          end
+        end
+
+        def lower
+          @lower ||= begin
+            lower_single = {
+              "ё"=>"e","э"=>"e","ю"=>"yu","я"=>"ya",
+              "ж"=>"zh","х"=>"kh","й"=>"j",
+              "ц"=>"ts","ш"=>"sh","щ"=>"sch","ь"=>"","ъ"=>"",
+
+              "і"=>"i","ґ"=>"g","№"=>"#",
+              "ї"=>"yi","а"=>"a","б"=>"b",
+              "в"=>"v","г"=>"g","д"=>"d","е"=>"e",
+              "з"=>"z","и"=>"i","к"=>"k","л"=>"l",
+              "м"=>"m","н"=>"n","о"=>"o","п"=>"p",
+              "р"=>"r", "с"=>"s","т"=>"t","у"=>"u",
+              "ф"=>"f","ч"=>"ch","ы"=>"y"
+            }
+
+            (lower_single.merge(lower_multi)).freeze
+          end
+        end
+
+        def upper_multi
+          @upper_multi ||= { "ЬЕ"=>"IE", "ЬЁ"=>"IE" }
+        end
+
+        def lower_multi
+          @lower_multi ||= { "ье"=>"ie", "ьё"=>"ie" }
+        end
+
+        def multi_keys
+          @multi_keys ||= (lower_multi.merge(upper_multi)).keys.sort_by {|s| s.length}.reverse.freeze
+        end
+      end
+    end
+  end
+end
+
+{ :ru => {
+    :i18n => {
+      :transliterate => {
+        :rule => RailsI18n::Transliteration::Russian.rule }}}}

data/lib/to_slug_param/string.rb

@@ -0,0 +1,81 @@
+class String
+  def to_slug_param opts = {}
+    self.class.to_smart_slug_param(self, opts)
+  end
+
+  def to_slug_param_base opts = {}
+    self.class.to_slug_param_base(self, opts)
+  end
+
+  def slugged_filename opts = {}
+    self.class.slugged_filename(self, opts)
+  end
+
+  def slugged_filepath opts = {}
+    self.class.slugged_filepath(self, opts)
+  end
+
+  def to_smart_slug_param opts = {}
+    self.class.to_smart_slug_param(self, opts)
+  end
+
+  # -----------------------------------
+  # Self methods
+  # -----------------------------------
+  class << self
+    def to_slug_param str, opts = {}
+      to_smart_slug_param(str, opts)
+    end
+
+    def to_slug_param_base str, opts = {}
+      sep = opts.delete(:sep) || '-'
+      str = str.gsub(/\-{2,}/, '-').mb_chars
+      str = I18n::transliterate(str, opts)
+      str = ToSlugParam::basic_parameterize(sep, opts)
+      ToSlugParam::parameterize(sep, opts)
+    end
+
+    def to_smart_slug_param str, opts = {}
+      tolerance = opts.delete(:tolerance) || 75
+
+      x = str.to_slug_param_base
+      y = str.to_url
+
+      ratio = (x.size.to_f/y.size.to_f)
+
+      # x=0.0/y=0.0 => NaN
+      return '' if ratio.nan?
+      # x=1.0/y=0.0 => Infinite
+      return x if ratio.infinite?
+      # x=0.0/y=1.0 => 0.0
+      return y if ratio.zero?
+      # ((x=5.0/y=3.0)*100).to_i => 166 => x
+      # ((x=3.0/y=5.0)*100).to_i => 60  => y
+      (ratio*100).to_i > tolerance ? x : y
+    end
+
+    def file_ext file_name, opts = {}
+      File.extname(file_name)[1..-1].to_s.to_slug_param_base opts
+    end
+
+    def file_name name, opts = {}
+      name = File.basename name
+      ext  = File.extname  name
+      File.basename(name, ext).to_s.to_slug_param_base opts
+    end
+
+    def slugged_filename name, opts = {}
+      name  = File.basename  name
+      fname = self.file_name name, opts
+      ext   = self.file_ext  name, opts
+
+      return fname if ext.blank?
+      [fname, ext].join('.')
+    end
+
+    def slugged_filepath file_full_path, opts = {}
+      fname = slugged_filename file_full_path, opts
+      file_full_path.split('/')[0...-1].push(fname).join '/'
+    end
+  end
+end

data/lib/to_slug_param/symbol.rb

@@ -0,0 +1,17 @@
+class Symbol
+  def to_slug_param opts = {}
+    String.to_slug_param(self.to_s, opts)
+  end
+
+  def to_slug_param_base opts = {}
+    String.to_slug_param_base(self.to_s, opts)
+  end
+
+  def slugged_filename opts = {}
+    String.slugged_filename(self.to_s, opts)
+  end
+
+  def slugged_filepath opts = {}
+    String.slugged_file(self.to_s, opts)
+  end
+end

data/lib/to_slug_param.rb

@@ -0,0 +1,20 @@
+require 'rails-i18n'
+require 'stringex_lite'
+require 'to_slug_param/string'
+require 'to_slug_param/symbol'
+
+module ToSlugParam
+  class Engine < Rails::Engine; end
+
+  class << self
+    def basic_parameterize(str, sep)
+      str.gsub('_', sep).gsub('-', sep)
+    end
+
+    def parameterize(str, sep)
+      Rails::VERSION::MAJOR > 4          ? \
+        str.parameterize(separator: sep) : \
+        str.parameterize(sep)
+    end
+  end
+end

data/spec/dummy_app/.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy_app/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy_app/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.0.0'
+
+gem 'sqlite3'
+gem 'rspec'
+gem 'rspec-rails'
+gem 'to_slug_param', path: '../../'

data/spec/dummy_app/README.md

@@ -0,0 +1,14 @@
+### Test App
+
+```ruby
+git clone git@github.com:the-teacher/to_slug_param.git
+
+cd to_slug_param/spec/dummy_app/
+
+bundle
+
+RAILS_ENV=test rake db:create
+RAILS_ENV=test rake db:migrate
+
+rspec spec/helpers/string.rb
+```

data/spec/dummy_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+DummyApp::Application.load_tasks

data/spec/dummy_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/dummy_app/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>DummyApp</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy_app/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy_app/config/application.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env)
+
+I18n.enforce_available_locales = true
+
+module DummyApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    config.i18n.default_locale = :ru
+  end
+end

data/spec/dummy_app/config/boot.rb

@@ -0,0 +1,4 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy_app/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+DummyApp::Application.initialize!

data/spec/dummy_app/config/environments/development.rb

@@ -0,0 +1,29 @@
+DummyApp::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end