dibbler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bcfbc952b12ac5e2238a7d51f535072c611a7806e51c748da0e46c757fd5864
+  data.tar.gz: 4f6ac5c65ab5f5a887fb1900e024fa26b0f09d0039a8809f6bf9539353406455
+SHA512:
+  metadata.gz: bcef9236447f561223e8daa5e2aad79eb8a211c43cd8380144453332b0463dd6a205351b3883df3994cefa660e80c67fe8b25b8d374cf3867343d8208a040535
+  data.tar.gz: 24e30c664a953bcb3678affa9481f4eca6b02550d0d4c5a11d222bbf7637a36f4c0d5c1f9fccec131650be525de01e749e75bd99a82e923b93794a9ed6c4b039

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Matěj Outlý
+
+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,73 @@
+# Dibbler
+Most enterprisingly unsuccessful entrepreneur. With this gem you can generate, 
+manage and integrate pretty (human readable and localized) URL addresses into 
+the web application. It uses DB table `slugs` on the background for storing URL
+translations for all supported languages.
+
+## Installation
+
+Add gem to your Gemfile:
+
+```ruby
+gem "dibbler"
+```
+
+Add database migrations to you application (you can modify DB structure 
+accordingly before migrating):
+
+    $ rake dibbler:install:migrations
+    $ rake db:migrate
+
+## Filters
+
+Content of DB table `slugs` can be simply segmented into several subsets with 
+`filter` attribute. If filters are enabled, translation table loads only slugs
+with filter attribute matching the the current filter defined by 
+`current_app_filter` option. With this system, you can store slugs for different
+application variants (subdomains) in a single DB table (if many application 
+variants uses the same database).
+
+```ruby
+Dibbler.setup do |config|
+    config.use_filter = true
+    config.current_app_filter = Rails.configuration.theme # contains "subdomain1", "subdomain2", etc.
+    config.available_filter_urls = {
+        subdomain1: "http://subdomain1.sample.com",
+        subdomain2: "http://subdomain2.sample.com",
+        subdomain3: "http://subdomain3.sample.com",
+        subdomain4: "http://subdomain4.sample.com",
+        subdomain5: "http://subdomain5.sample.com",
+        subdomain6: "http://subdomain6.sample.com",
+        subdomain7: "http://subdomain7.sample.com",
+        subdomain7: "http://subdomain8.sample.com",
+    }
+    ...
+end
+```
+
+## Static slugs
+
+You can define set of slugs which is integrated into translation tables by 
+default (not necessary to generate it in generators). Static slugs can be 
+configured in module configuration file:
+
+```ruby
+Dibbler.setup do |config|
+    config.static_slugs = [
+        { locale: "cs", original: "search", translation: "vysledky-vyhledavani" },
+        { locale: "en", original: "search", translation: "search-results" },
+        { locale: "cs", original: "gallery", translation: "fotogalerie" },
+        { locale: "en", original: "gallery", translation: "photogallery" },
+    ]
+    ...
+end
+```
+
+Additionaly you can define `filter` attribute in each static slugs table.
+
+## Other configuration options
+
+Other supported configuration options are:
+
+- disable_default_locale
+- downcase_translations

data/app/models/dibbler/slug.rb

@@ -0,0 +1,17 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Slug
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Dibbler
+  class Slug < ActiveRecord::Base
+    include Dibbler::Utils::Enum
+    include Dibbler::Models::Slug
+  end
+end

data/config/locales/cs.yml

@@ -0,0 +1,18 @@
+cs:
+  activerecord:
+    attributes:
+      dibbler/slug:
+        locale: Jazyk
+        original: Systémové URL
+        translation: Hezké URL
+        filter: Syst. zn. aplikace
+    notices:
+      models:
+        dibbler/slug:
+          create: "Překlad URL byl úspěšně vytvořen."
+          update: "Překlad URL byl úspěšně upraven."
+          destroy: "Překlad URL byl úspěšně smazán."
+    errors:
+      models:
+        dibbler/slug:
+          not_found: "Překlad URL nebyl nalezen."

data/config/locales/en.yml

@@ -0,0 +1,18 @@
+en:
+  activerecord:
+    attributes:
+      dibbler/slug:
+        locale: Language
+        original: System URL
+        translation: Pretty URL
+        filter: Application reference
+    notices:
+      models:
+        dibbler/slug:
+          create: URL translation was successfully saved.
+          update: URL translation was successfully created.
+          destroy: URL translation was successfully deleted.
+    errors:
+      models:
+        dibbler/slug:
+          not_found: URL translation was not found.

data/config/routes.rb

@@ -0,0 +1,13 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Routes
+# *
+# * Author: Matěj Outlý
+# * Date  : 26. 11. 2015
+# *
+# *****************************************************************************
+
+Dibbler::Engine.routes.draw do
+end

data/db/migrate/20150721151036_create_slugs.rb

@@ -0,0 +1,11 @@
+class CreateSlugs < ActiveRecord::Migration
+  def change
+    create_table :slugs do |t|
+      t.timestamps null: true
+      t.string :locale, index: true
+      # t.string :filter, index: true # Optional column distinguishing application variant
+      t.string :original, index: true
+      t.string :translation, index: true
+    end
+  end
+end

data/lib/dibbler.rb

@@ -0,0 +1,199 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Dibbler engine
+# *
+# * Author: Matěj Outlý
+# * Date  : 9. 6. 2015
+# *
+# *****************************************************************************
+
+# Engines
+require "dibbler/engine"
+
+# Middlewares
+require "dibbler/middlewares/locale"
+require "dibbler/middlewares/slug"
+
+# Models
+require "dibbler/models/slug"
+require "dibbler/models/slug_generator"
+require "dibbler/models/hierarchical_slug_generator"
+
+# Helpers
+require "dibbler/helpers/url_helper"
+
+# Utils
+require "dibbler/utils/enum"
+
+module Dibbler
+
+  # This will keep Rails Engine from generating all table prefixes with the engines name
+  def self.table_name_prefix
+  end
+
+  # *************************************************************************
+  # Interface
+  # *************************************************************************
+
+  def self.disassemble(path)
+    # TODO work correctly with http:// and https:// links
+
+    # Match locale from path
+    match = /^\/(#{I18n.available_locales.join("|")})\//.match(path + "/")
+    if match
+      locale = match[1].to_sym
+    else
+      locale = nil
+    end
+
+    # Remove locale from path
+    if locale
+      path = path[(1 + locale.to_s.length)..-1]
+    end
+
+    # Root
+    if path.blank?
+      path = "/"
+    end
+
+    return [locale, path]
+  end
+
+  def self.assemble(locale, path)
+    if locale && (Dibbler.disable_default_locale || (I18n.default_locale.to_sym != locale.to_sym))
+      if path == "/"
+        path = "/" + locale.to_s
+      elsif path.starts_with?("http")
+        split1 = path.split("//")
+        split2 = split1[1].to_s.split("/")
+        split1[1] = split2.insert(1, locale.to_s).join("/")
+        path = split1.join("//")
+      else
+        path = "/" + locale.to_s + path
+      end
+    end
+    return path
+  end
+
+  def self.localify(path)
+    return path if path == "#"
+
+    # Match locale from path
+    locale, path = self.disassemble(path)
+
+    # Take current locale if path locale not defined
+    if locale.nil?
+      locale = I18n.locale
+    end
+
+    # Assemble back into path with locale
+    path = self.assemble(locale, path)
+
+    return path
+  end
+
+  def self.slugify(path)
+
+    # Match locale from path
+    locale, original = self.disassemble(path)
+
+    # Translate from original
+    tmp_uri = URI.parse(original)
+    tmp_path = Dibbler.slug_model.original_to_translation((locale ? locale : I18n.default_locale), tmp_uri.path)
+    if tmp_path
+      tmp_uri.path = tmp_path
+      translation = tmp_uri.to_s
+    else
+      translation = original
+    end
+
+    # Add locale if defined
+    translation = self.assemble(locale, translation)
+
+    return translation
+  end
+
+  # *************************************************************************
+  # Configuration
+  # *************************************************************************
+
+  # Default way to setup module
+  def self.setup
+    yield self
+  end
+
+  # *************************************************************************
+  # Config options
+  # *************************************************************************
+
+  # Disable unaccent extension in SQL queries
+  mattr_accessor :disable_unaccent
+  @@disable_unaccent = false
+
+  # Slug model
+  mattr_accessor :slug_model
+
+  def self.slug_model
+    return @@slug_model.constantize
+  end
+
+  @@slug_model = "Dibbler::Slug"
+
+  # Enable slugs subsystem
+  mattr_accessor :enable_slugs
+  @@enable_slugs = true
+
+  # Enable localization subsystem
+  mattr_accessor :enable_locales
+  @@enable_locales = true
+
+  # Default locale is hidden in URL by default. This feature can be disabled
+  # by setting true to this option.
+  #
+  # Example: Default locale is "cs" and all available locales are "cs" and
+  # "en". For false value URLs looks like this:
+  # - /fotogalerie
+  # - /en/photogallery
+  # For true value URLs looks like this:
+  # - /cs/fotogalerie
+  # - /en/photogallery
+  mattr_accessor :disable_default_locale
+  @@disable_default_locale = false
+
+  # By default, headers sent from browser are checked and default locale is
+  # set automatically according to browser language (if possible). This
+  # feature can be disable by setting true to this option.
+  mattr_accessor :disable_browser_locale
+  @@disable_browser_locale = false
+
+  # Use filter column in slug records?
+  #
+  # Filter column can be used for filtering subset of slugs valid for some
+  # specific application variant (different domain or subdomain) in case
+  # these variants share database.
+  mattr_accessor :use_filter
+  @@use_filter = false
+
+  # Use this string to filter slugs valid for this application
+  mattr_accessor :current_app_filter
+  @@current_app_filter = nil
+
+  # Map of available filters => URL to be created. Used for linking to
+  # different application variant (different domain).
+  mattr_accessor :available_filter_urls
+  @@available_filter_urls = {}
+
+  # If enabled translations are downcased before lookup. It means that
+  # translated URLs like /fotogalerie, /Fotogalerie and /FOTOGALERIE points
+  # to the same original URL.
+  mattr_accessor :downcase_translations
+  @@downcase_translations = false
+
+  # Slugs which are by loaded to translation tables by default without necessity
+  # to generate it in generators.
+  mattr_accessor :static_slugs
+  @@static_slugs = []
+
+end

data/lib/dibbler/engine.rb

@@ -0,0 +1,17 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Engine
+# *
+# * Author: Matěj Outlý
+# * Date  : 9. 6. 2015
+# *
+# *****************************************************************************
+
+module Dibbler
+  class Engine < ::Rails::Engine
+    isolate_namespace Dibbler
+  end
+end
+

data/lib/dibbler/helpers/url_helper.rb

@@ -0,0 +1,26 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * URL helper
+# *
+# * Author: Matěj Outlý
+# * Date  : 22. 7. 2015
+# *
+# *****************************************************************************
+
+module Dibbler
+  module Helpers
+    module UrlHelper
+
+      def localify(path)
+        return Dibbler.localify(path)
+      end
+
+      def slugify(path)
+        return Dibbler.slugify(path)
+      end
+
+    end
+  end
+end

data/lib/dibbler/middlewares/locale.rb

@@ -0,0 +1,62 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Recognize locale based on request
+# *
+# * Author: Matěj Outlý
+# * Date  : 22. 7. 2015
+# *
+# *****************************************************************************
+
+module Dibbler
+  module Middlewares
+    class Locale
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if filter(env)
+          @app.call(env)
+        else
+
+          # Match locale from path
+          path_locale, path = Dibbler.disassemble(env["PATH_INFO"])
+          path_locale = nil unless I18n.available_locales.include?(path_locale)
+
+          # Match locale from browser
+          if !Dibbler.disable_browser_locale && env['HTTP_ACCEPT_LANGUAGE']
+            browser_locale = env['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]{2}/).first
+            if browser_locale
+              browser_locale = browser_locale.to_sym
+              browser_locale = nil unless I18n.available_locales.include?(browser_locale)
+            else
+              browser_locale = nil
+            end
+          else
+            browser_locale = nil
+          end
+
+          # Set as default locale (for paths without locale spec)
+          I18n.default_locale = browser_locale if browser_locale
+
+          # Set correct locale and define default locale for URLs
+          I18n.locale = path_locale || I18n.default_locale
+          Rails.application.routes.default_url_options[:locale] = (I18n.default_locale == I18n.locale ? nil : I18n.locale)
+
+          @app.call(env)
+        end
+      end
+
+      protected
+
+      def filter(env)
+        return true if env["PATH_INFO"].start_with?("/assets/")
+        false
+      end
+
+    end
+  end
+end