dibbler 1.0.0

data/lib/dibbler/models/slug_generator.rb

@@ -0,0 +1,111 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Linear slug generator
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 7. 2015
+# *
+# *****************************************************************************
+
+module Dibbler
+  module Models
+    module SlugGenerator
+      extend ActiveSupport::Concern
+
+      included do
+
+        after_save :generate_slugs
+        before_destroy :destroy_slugs, prepend: true
+
+      end
+
+      module ClassMethods
+
+        def generate_slugs(options = {})
+          self.all.each do |item|
+            item.generate_slugs(options)
+          end
+        end
+
+      end
+
+      def disable_slug_generator
+        @disable_slug_generator = true
+      end
+
+      def enable_slug_generator
+        @disable_slug_generator = false
+      end
+
+      # *************************************************************
+      # Hooks
+      # *************************************************************
+
+      def generate_slugs(options = {})
+        return if @disable_slug_generator
+        ActiveRecord::Base.transaction do
+
+          # Generate slug in this model
+          unless Dibbler.slug_model.nil?
+            I18n.available_locales.each do |locale|
+              self._destroy_slug_was(Dibbler.slug_model, locale)
+              self._generate_slug(Dibbler.slug_model, locale)
+            end
+          end
+
+        end
+      end
+
+      def destroy_slugs(options = {})
+
+        # Destroy slug of this model
+        unless Dibbler.slug_model.nil?
+          I18n.available_locales.each do |locale|
+            self._destroy_slug(Dibbler.slug_model, locale)
+          end
+        end
+
+      end
+
+      def url_original
+        if @url_original.nil?
+          @url_original = self._url_original
+        end
+        @url_original
+      end
+
+      def compose_slug_translation(locale)
+        self._compose_slug_translation(locale)
+      end
+
+      protected
+
+      # *************************************************************
+      # Callbacks to be defined in application
+      # *************************************************************
+
+      def _url_original
+        raise "To be defined in application."
+      end
+
+      def _compose_slug_translation(locale)
+        raise "To be defined in application."
+      end
+
+      def _generate_slug(slug_model, locale)
+        raise "To be defined in application."
+      end
+
+      def _destroy_slug(slug_model, locale)
+        raise "To be defined in application."
+      end
+
+      def _destroy_slug_was(slug_model, locale)
+        raise "To be defined in application."
+      end
+
+    end
+  end
+end

data/lib/dibbler/railtie.rb

@@ -0,0 +1,18 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Railtie for view helpers integration
+# *
+# * Author: Matěj Outlý
+# * Date  : 22. 7. 2015
+# *
+# *****************************************************************************
+
+module Dibbler
+  class Railtie < Rails::Railtie
+    initializer "dibbler.helpers" do
+      ActionView::Base.send :include, Helpers::UrlHelper
+    end
+  end
+end

data/lib/dibbler/utils/enum.rb

@@ -0,0 +1,133 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Enum definition
+# *
+# * Author: Matěj Outlý
+# * Date  : 7. 1. 2015
+# *
+# *****************************************************************************
+
+require "active_record"
+
+module Dibbler
+  module Utils
+    module Enum
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        # Add new enum column
+        def enum_column(new_column, spec, options = {})
+
+          # Prepare internal structure
+          if @enums.nil?
+            @enums = {}
+          end
+          @enums[new_column] = {}
+
+          # Fill out internal structure
+          spec.each do |item|
+
+            # Value check
+            if item.is_a?(OpenStruct)
+              item = item.to_h
+            elsif item.is_a? Hash
+              # OK
+            else
+              item = {value: item}
+            end
+            unless item[:value]
+              raise "Enum definition cannot be empty."
+            end
+
+            # Identify special type
+            item[:special_type] = :integer if item[:value].is_a?(Integer)
+
+            # Retype to string
+            item[:value] = item[:value].to_s
+
+            # Label
+            unless item[:label]
+              item[:label] = I18n.t("activerecord.attributes.#{model_name.i18n_key}.#{new_column.to_s}_values.#{item[:special_type] ? item[:special_type].to_s + "_" : ""}#{item[:value]}")
+            end
+
+            # Other attributes
+            if options[:attributes]
+              options[:attributes].each do |attribute|
+                singular_attribute_name = attribute.to_s.singularize
+                plural_attribute_name = attribute.to_s.pluralize
+                if item[singular_attribute_name.to_sym].nil?
+                  item[singular_attribute_name.to_sym] = I18n.t("activerecord.attributes.#{model_name.i18n_key}.#{new_column.to_s}_#{plural_attribute_name}.#{item[:special_type] ? item[:special_type].to_s + "_" : ""}#{item[:value]}")
+                end
+              end
+            end
+
+            # Store
+            @enums[new_column][item[:value].to_s] = OpenStruct.new(item)
+          end
+
+          # Obj method
+          define_method((new_column.to_s + "_obj").to_sym) do
+            column = new_column
+
+            # Get map Value => Object
+            enums = self.class.enums[column]
+
+            # Get possible special type
+            special_type = enums.values.first.special_type if enums.first && enums.values.first.special_type
+
+            # Get value and modify it according to special type
+            value = self.send(column)
+            value = value.to_i if special_type == :integer
+
+            return self.class.enums[column][value.to_s]
+          end
+
+          # All method
+          define_singleton_method(("available_" + new_column.to_s.pluralize).to_sym) do
+            column = new_column
+            return @enums[column].values
+          end
+
+          # All values method
+          define_singleton_method(("available_" + new_column.to_s + "_values").to_sym) do
+            column = new_column
+            return @enums[column].values.map { |o| o.value.to_sym }
+          end
+
+          # Label method
+          define_singleton_method((new_column.to_s + "_label").to_sym) do |value|
+            column = new_column
+            return @enums[column].values.select { |o| o.value.to_s == value.to_s }.map { |o| o.label }.first
+          end
+
+          # Default value
+          if options[:default]
+            before_validation do
+              column = new_column
+              default = options[:default]
+              if self.send(column).nil?
+                self.send(column.to_s + "=", default.to_s)
+              end
+            end
+          end
+
+        end
+
+        # Get all defined enums
+        def enums
+          @enums
+        end
+
+        # Check if given column is enum defined on this model
+        def has_enum?(column)
+          !@enums.nil? && !@enums[column].nil?
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: dibbler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matěj Outlý
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Dibbler is an engine containing entire backend for localized human readable
+  URLs generation and integration.
+email:
+- matej.outly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/models/dibbler/slug.rb
+- config/locales/cs.yml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20150721151036_create_slugs.rb
+- lib/dibbler.rb
+- lib/dibbler/engine.rb
+- lib/dibbler/helpers/url_helper.rb
+- lib/dibbler/middlewares/locale.rb
+- lib/dibbler/middlewares/slug.rb
+- lib/dibbler/models/hierarchical_slug_generator.rb
+- lib/dibbler/models/slug.rb
+- lib/dibbler/models/slug_generator.rb
+- lib/dibbler/railtie.rb
+- lib/dibbler/utils/enum.rb
+homepage: https://github.com/matej-outly/dibbler
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Human readable and localized URLs
+test_files: []