beautified_url 0.0.1

data/lib/beautified_url.rb

@@ -0,0 +1,100 @@
+module BeautifiedUrl
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.send(:before_validation, :beautify_url)
+  end
+
+  module ClassMethods
+    attr_accessor :bu_token
+    attr_accessor :bu_attributes_hset
+    attr_accessor :bu_scope_set
+
+    def is_beautifiable?
+      @bu_token ||= "_bu_"
+      @bu_attributes_hset = {}
+      attribute_names.each do |attribute_name|
+        if attribute_name.starts_with?(@bu_token)
+          p_attr = attribute_name.gsub(@bu_token, "") #parent attribute name
+          @bu_attributes_hset[p_attr] = attribute_name if attribute_names.include?(p_attr)
+        end
+      end
+      (not @bu_attributes_hset.empty?)
+    end
+
+    def beautify_url_with_scope(options)
+      options = options.to_s if options.is_a?(Symbol)
+      @bu_scope_set = options if options.is_a?(Hash) or options.is_a?(String)
+    end
+  end
+
+  def attribute_scope_hash_set(base = self.class)
+    scope_hset = base.bu_scope_set
+
+    if base.bu_scope_set.is_a?(String) and base.attribute_names.include?(base.bu_scope_set)
+      scope_hset = {}
+      base.bu_attributes_hset.keys.each { |p_attr| scope_hset[p_attr] = base.bu_scope_set }
+    end
+    scope_hset ||{}
+  end
+
+  #generates condition array to be used while searching for unique record from bu_attribute value
+  def conditions_array(p_attr, bu_attr, bu_attr_value, base = self.class)
+    condition_array = ["#{bu_attr} = ? ", bu_attr_value]
+    unless self.send(base.primary_key).nil?
+      condition_array[0] = "#{condition_array[0]} and #{base.primary_key} != ?"
+      condition_array.push(self.send(base.primary_key))
+    end
+
+    attribute_scope_hash_set.each do |sp_key, sp_key_scope|
+      sp_key, sp_key_scope = sp_key.to_s, sp_key_scope.to_s
+      if p_attr == sp_key and base.attribute_names.include?(sp_key) and base.attribute_names.include?(sp_key_scope)
+        condition_array[0] = "#{condition_array[0]} and #{sp_key_scope} = ?"
+        condition_array.push(self.send(sp_key_scope))
+      end
+    end
+    condition_array
+  end
+
+  #finds uniqueness of bu_attribute's value (with scope if defined)
+  def make_unique_beautiful_url(p_attr, bu_attr, bu_attr_value, base = self.class)
+    bu_attr_value_t = bu_attr_value
+
+    keep_looking_flag = true
+    while (keep_looking_flag)
+      if base.where(conditions_array(p_attr, bu_attr, bu_attr_value_t)).count == 0
+        keep_looking_flag = false
+      else
+        counter ||= 0
+        counter += 1
+        bu_attr_value_t = "#{bu_attr_value}-#{counter}"
+      end
+    end
+
+    bu_attr_value_t
+  end
+
+  #makes beautiful url by looking at parent attribute(s) whose bu_attributes are identified by "_bu_" (default bu_token)
+  #only if bu_attribute is not already populated
+  def beautify_url(base = self.class)
+    return unless base.is_beautifiable?
+
+    base.bu_attributes_hset.each do |p_attr, bu_attr|
+      if self.send(bu_attr).nil?
+        unless (p_attr.nil? or p_attr.empty?) #If parent attribute is not nil or empty
+          self.send("#{bu_attr}=", make_unique_beautiful_url(p_attr, bu_attr, self.send(p_attr).beautify_me))
+        end
+      end
+    end
+  end
+end
+
+class String
+  def beautify_me
+    self.downcase.gsub(/[ -]+/, "-").gsub(/[^a-zA-Z0-9-]/, "")
+  end
+end
+
+
+#Adding to ActiveRecord::Base
+ActiveRecord::Base.send(:include, BeautifiedUrl)

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: beautified_url
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Praveen Kumar Sinha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Basic tool which provides feature of generating tokens which can be
+  used in url for identifying resource(uniquely of uniquely within a scope) instead
+  of :id. Just add another field which starts with _bu_ of one or many existing fields
+  to make it all happen. Example: For a blog post, if you have a ''title'' field and
+  want to beautify and use it instead of :id add another field like ''_bu_title''
+  and now modify routes and application to refer and fetch resource from ''_bu_title''
+  field.'
+email: praveen.kumar.sinha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/beautified_url.rb
+homepage: https://github.com/praveenkumarsinha/BeautifiedUrl
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: BeautifiedUrl
+test_files: []