acts_more_seo 0.3.2 → 0.4.0

data/CHANGELOG.rdoc

@@ -19,4 +19,6 @@ Backward compatibility improvements
 = Version 0.3.1
 * Dependencies fix
 = Version 0.3.2
-* Downcase fix
+* Downcase fix
+= Version 0.4.0
+* Seo url history support for updating and searching

data/Manifest

@@ -7,6 +7,11 @@ Rakefile
 acts_more_seo.gemspec
 init.rb
 lib/acts_more_seo.rb
+lib/generators/acts_more_seo/install_generator.rb
+lib/generators/acts_more_seo/templates/create_seo_history_migration.rb
+lib/seo_finder.rb
+lib/seo_formatter.rb
+lib/seo_history.rb
 lib/string_ext.rb
 spec/acts_more_seo_spec.rb
 spec/spec_helper.rb

data/README.md

@@ -5,7 +5,7 @@
     gem install acts_more_seo
 
 and in your Gemfile:
-    
+
     gem 'acts_more_seo'
 
 ## About
@@ -36,7 +36,7 @@ You can also pass an array of columns like this
           })
     cool_element_path(mod) ===> cool_elements/12345-maciej-mensfeld-cool-stuff
 
-Further more - if you don't want to use na ID in your urls, just set use_id param to false
+Further more - if you don't want to use an ID in your urls, just set use_id param to false
 
     class CoolElement < ActiveRecord::Base
         acts_more_seo :columns => [:name, :surname, :title], :use_id => false
@@ -45,7 +45,7 @@ Further more - if you don't want to use na ID in your urls, just set use_id para
     mod = CoolElement.create({
             :name => 'Maciej',
             :surname => 'Mensfeld',
-            :title => 'cool stuuf :)'
+            :title => 'cool stuff :)'
           })
     cool_element_path(mod) ===> cool_elements/maciej-mensfeld-cool-stuff
 
@@ -59,8 +59,20 @@ so you can search via seo method:
 
 You don't need to update seo_url, gem will hook up with this field automatically if it exists.
 
+If you want to maintain your urls history, run:
+
+    rails generate acts_more_seo:install
+
+In order to create a SeoHistory table which will contain your urls history. History will be searchable (you don't need to do anything), just inform acts_more_seo that you want to use history:
+
+    class HisElement < ActiveRecord::Base
+        acts_more_seo :column => :name, :use_id => false, :history => true
+    end
+
+After that, you can use find_by_seo and it will search also though the urls history.
+
 ## Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a future version unintentionally.

data/Rakefile

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('acts_more_seo', '0.3.2') do |p|
+Echoe.new('acts_more_seo', '0.4.0') do |p|
   p.description    = "Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better"
   p.url            = "https://github.com/mensfeld/Css-Image-Embedder"
   p.author         = "Maciej Mensfeld"

data/acts_more_seo.gemspec

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{acts_more_seo}
-  s.version = "0.3.2"
+  s.name = "acts_more_seo"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Maciej Mensfeld}]
-  s.date = %q{2011-12-17}
-  s.description = %q{Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better}
-  s.email = %q{maciej@mensfeld.pl}
-  s.extra_rdoc_files = [%q{CHANGELOG.rdoc}, %q{README.md}, %q{lib/acts_more_seo.rb}, %q{lib/string_ext.rb}]
-  s.files = [%q{CHANGELOG.rdoc}, %q{Gemfile}, %q{MIT-LICENSE}, %q{Manifest}, %q{README.md}, %q{Rakefile}, %q{acts_more_seo.gemspec}, %q{init.rb}, %q{lib/acts_more_seo.rb}, %q{lib/string_ext.rb}, %q{spec/acts_more_seo_spec.rb}, %q{spec/spec_helper.rb}]
-  s.homepage = %q{https://github.com/mensfeld/Css-Image-Embedder}
-  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Acts_more_seo}, %q{--main}, %q{README.md}]
-  s.require_paths = [%q{lib}]
-  s.rubyforge_project = %q{acts_more_seo}
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better}
+  s.authors = ["Maciej Mensfeld"]
+  s.date = "2012-02-25"
+  s.description = "Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better"
+  s.email = "maciej@mensfeld.pl"
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.md", "lib/acts_more_seo.rb", "lib/generators/acts_more_seo/install_generator.rb", "lib/generators/acts_more_seo/templates/create_seo_history_migration.rb", "lib/seo_finder.rb", "lib/seo_formatter.rb", "lib/seo_history.rb", "lib/string_ext.rb"]
+  s.files = ["CHANGELOG.rdoc", "Gemfile", "MIT-LICENSE", "Manifest", "README.md", "Rakefile", "acts_more_seo.gemspec", "init.rb", "lib/acts_more_seo.rb", "lib/generators/acts_more_seo/install_generator.rb", "lib/generators/acts_more_seo/templates/create_seo_history_migration.rb", "lib/seo_finder.rb", "lib/seo_formatter.rb", "lib/seo_history.rb", "lib/string_ext.rb", "spec/acts_more_seo_spec.rb", "spec/spec_helper.rb"]
+  s.homepage = "https://github.com/mensfeld/Css-Image-Embedder"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_more_seo", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "acts_more_seo"
+  s.rubygems_version = "1.8.15"
+  s.summary = "Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/acts_more_seo.rb

@@ -1,5 +1,8 @@
 require "babosa"
 require "string_ext"
+require "seo_formatter"
+require "seo_finder"
+require "seo_history"
 
 module Acts
   module MoreSeo
@@ -16,6 +19,7 @@ module Acts
 
         columns = params[:column] || params[:columns] || :name
         use_id  = !params[:use_id].nil? ? params[:use_id] : true
+        history = params[:history] || false
 
         if columns.is_a?(Array)
           columns.collect!{|a| a.to_sym}
@@ -25,13 +29,22 @@ module Acts
 
         cattr_accessor :seo_columns
         cattr_accessor :seo_use_id
+        cattr_accessor :seo_history
 
         before_update :update_seo_url
         after_create  :set_seo_url
 
         self.seo_columns = columns
-
+        self.seo_history = history
         self.seo_use_id  = use_id
+
+        if self.seo_history
+          has_many :seo_histories,
+            :as => :seo_historable,
+            :dependent => :destroy,
+            :class_name => 'Acts::MoreSeo::SeoHistory'
+        end
+
         class_eval <<-END
            include Acts::MoreSeo::InstanceMethods
         END
@@ -52,9 +65,7 @@ module Acts
 
       # Lets return nice and smooth url
       def to_url
-        seo_path = seo_text_part
-        seo_path = "#{self.id}#{"-#{seo_path}" if seo_path && seo_path.length > 0}"
-        seo_path.length > 0 ? seo_path : "#{self.id}"
+        Acts::MoreSeo::SeoFormatter.new(self).to_url
       end
       # Alias
       def url
@@ -62,21 +73,20 @@ module Acts
       end
 
       def to_seo
-        if self.seo_use_id
-          to_url
-        else
-          seo_link = seo_text_part.length > 0 ? seo_text_part : "#{self.id}"
-          if !self.class.where("seo_url = ? AND id != ?", seo_link, self.id).limit(1).empty?
-            to_url
-          else
-            seo_link
-          end
-        end
+        Acts::MoreSeo::SeoFormatter.new(self).to_seo
       end
 
       def update_seo_url
         if self.class.seo_url_table?
-          self.update_column(:seo_url, to_seo)
+
+          new_url = to_seo
+
+          # Add old url to history if its different from the new one
+          if self.class.seo_history? && (new_url != self.seo_url)
+            self.seo_histories.create(:seo_url => self.seo_url)
+          end
+
+          self.update_column(:seo_url, new_url)
         end
       end
 
@@ -88,46 +98,24 @@ module Acts
 
       module ClassMethods
 
+        def seo_history?
+          self.seo_history && !self.seo_use_id
+        end
+
         def seo_url_table?
           self.column_names.include?("#{:seo_url}")
         end
 
         def find_by_seo!(id)
-          if self.seo_use_id
-            find(id)
-          else
-            find_by_seo_url! id, :first
-          end
+           Acts::MoreSeo::Finder.new(self).search!(id)
         end
 
         def find_by_seo(id)
-          if self.seo_use_id
-            find_by_id(id)
-          else
-            find_by_seo_url id, :first
-          end
+          Acts::MoreSeo::Finder.new(self).search(id)
         end
 
       end
 
-      private
-
-      def seo_text_part
-        # If there is more than one SEO column - prepare url "text" part
-        if self.class.seo_columns.is_a?(Array)
-          seo_parts = self.class.seo_columns.collect do |field|
-            el = self.send(field)
-            el.to_url if el
-          end
-          seo_parts.delete_if{|el| el.to_s.length == 0}
-          seo_path = seo_parts.join('-')
-        else
-          el = self.send(self.class.seo_columns)
-          seo_path = el ? el.to_url : ''
-        end
-        seo_path
-      end
-
     end
   end
 end

data/lib/generators/acts_more_seo/install_generator.rb

@@ -0,0 +1,13 @@
+module ActsMoreSeo
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def add_my_migration
+      timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+      source = "create_seo_history_migration.rb"
+      target = "db/migrate/#{timestamp}_create_seo_history_migration.rb"
+      copy_file source, target
+    end
+
+  end
+end

data/lib/generators/acts_more_seo/templates/create_seo_history_migration.rb

@@ -0,0 +1,19 @@
+class CreateSeoHistoryMigration < ActiveRecord::Migration
+  def self.up
+
+    create_table :seo_histories do |t|
+      t.integer :seo_historable_id
+      t.string  :seo_historable_type
+      t.string  :seo_url
+      t.timestamps
+    end
+
+    add_index :seo_histories, :seo_historable_id
+    add_index :seo_histories, :seo_historable_type
+    add_index :seo_histories, :seo_url
+  end
+
+  def self.down
+    drop_table :seo_histories
+  end
+end

data/lib/seo_finder.rb

@@ -0,0 +1,63 @@
+module Acts
+  module MoreSeo
+
+    # Used to search for apropriate element in seo_urls or history (if included)
+    class Finder
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def search(name)
+        ret = search_in_table(name)
+
+        if !ret && @klass.seo_history?
+          ret = search_in_history(name)
+        end
+
+        ret
+      end
+
+      def search!(name)
+        search_in_table!(name)
+      rescue ActiveRecord::RecordNotFound => e
+        if @klass.seo_history?
+          ret = search_in_history(name)
+          return ret if ret
+        end
+        raise e
+      end
+
+      private
+
+      # Try to find element in an instance class table
+      def search_in_table(name)
+        if @klass.seo_use_id
+          @klass.find_by_id(name)
+        else
+          @klass.find_by_seo_url name, :first
+        end
+      end
+
+      # Try to find element in an instance class table and raise exception
+      # if it failes
+      def search_in_table!(name)
+        if @klass.seo_use_id
+          @klass.find(name)
+        else
+          @klass.find_by_seo_url! name, :first
+        end
+      end
+
+      # Try to find element in its seo history
+      def search_in_history(name)
+        sql = 'seo_url = ? AND seo_historable_type = ?'
+        ret = Acts::MoreSeo::SeoHistory.where(sql, name, @klass.to_s).limit(1).first
+        ret = ret.seo_historable if ret
+        ret
+      end
+
+    end
+
+  end
+end

data/lib/seo_formatter.rb

@@ -0,0 +1,56 @@
+module Acts
+  module MoreSeo
+
+    class SeoFormatter
+
+      def initialize(instance)
+        @instance = instance
+        @klass    = instance.class
+      end
+
+      def to_url
+        seo_path = text_part
+        seo_path = "#{@instance.id}#{"-#{seo_path}" if seo_path && seo_path.length > 0}"
+        seo_path.length > 0 ? seo_path : "#{@instance.id}"
+      end
+
+      def to_seo
+        return @to_seo if @to_seo
+
+        if @instance.seo_use_id
+          @to_seo = to_url
+        else
+          seo_link = text_part.length > 0 ? text_part : "#{@instance.id}"
+          if !@klass.where("seo_url = ? AND id != ?", seo_link, @instance.id).limit(1).empty?
+            @to_seo = to_url
+          else
+            @to_seo = seo_link
+          end
+        end
+        @to_seo
+      end
+
+      private
+
+      # Prepare text part of a seo url (the one without an id)
+      def text_part
+        return @seo_path if @seo_path
+        # If there is more than one SEO column - prepare url "text" part
+        if @klass.seo_columns.is_a?(Array)
+          seo_parts = @klass.seo_columns.collect do |field|
+            el = @instance.send(field)
+            el.to_url if el
+          end
+          seo_parts.delete_if{|el| el.to_s.length == 0}
+          @seo_path = seo_parts.join('-')
+        else
+          el = @instance.send(@klass.seo_columns)
+          @seo_path = el ? el.to_url : ''
+        end
+        @seo_path
+      end
+
+    end
+
+  end
+end

data/lib/seo_history.rb

@@ -0,0 +1,12 @@
+module Acts
+  module MoreSeo
+
+    # Store the history of urls if they where changed
+    class SeoHistory < ActiveRecord::Base
+
+      belongs_to :seo_historable, :polymorphic => true
+
+    end
+
+  end
+end

data/spec/acts_more_seo_spec.rb

@@ -19,6 +19,10 @@ class BestElement < ActiveRecord::Base
     acts_more_seo :columns => [:name, :surname, :title], :use_id => false
 end
 
+class HistorableElement < ActiveRecord::Base
+    acts_more_seo :columns => :name, :use_id => false, :history => true
+end
+
 describe CoolElement do
   subject { CoolElement }
   before(:each){ subject.destroy_all }
@@ -130,7 +134,6 @@ describe SpecialElement do
   end
 end
 
-
 describe BestElement do
   subject { BestElement }
   before(:each){ subject.destroy_all }
@@ -228,3 +231,46 @@ describe BestElement do
   end
 
 end
+
+describe HistorableElement do
+  subject { HistorableElement }
+  before(:each){ subject.destroy_all }
+
+  context "when we have polish letters" do
+    it "should turn them into global and use downcase" do
+      a = subject.create(:name => 'Kraj Żelaza')
+      a.name.to_url.should == 'kraj-zelaza'
+    end
+  end
+
+  context "when there is no name" do
+    it "should return only id" do
+      a = subject.create
+      a.to_param.should eql(a.id.to_s)
+    end
+  end
+
+  context "when we change element name" do
+    it "should be able to find it via old one also" do
+      a = subject.create(:name => 'Kraj Żelaza')
+      a.name.to_url.should == 'kraj-zelaza'
+
+      a.update_attributes(:name => 'Kraj Złota')
+      a.reload
+      subject.find_by_seo('kraj-zelaza').should eql a
+      subject.find_by_seo('kraj-zlota').should eql a
+      subject.find_by_seo('kraj-a').should eql nil
+    end
+
+    context "and the new seo_url looks the same as old one" do
+      it "should not remember it in history" do
+        nr = Acts::MoreSeo::SeoHistory.count
+        a = subject.create(:name => 'Kraj Żelaza')
+        a.update_attributes(:name => 'Kraj Żelaza')
+        nr.should eql Acts::MoreSeo::SeoHistory.count
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -40,5 +40,15 @@ ActiveRecord::Schema.define do
       table.string :surname
       table.string :seo_url
     end
-end
 
+    create_table :historable_elements do |table|
+      table.string :name
+      table.string :seo_url
+    end
+
+    create_table :seo_histories do |table|
+      table.integer :seo_historable_id
+      table.string  :seo_historable_type
+      table.string  :seo_url
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_more_seo
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-17 00:00:00.000000000Z
+date: 2012-02-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: babosa
-  requirement: &20403020 !ruby/object:Gem::Requirement
+  requirement: &11903760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20403020
+  version_requirements: *11903760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20402000 !ruby/object:Gem::Requirement
+  requirement: &11902800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *20402000
+  version_requirements: *11902800
 - !ruby/object:Gem::Dependency
   name: active_record
-  requirement: &20401280 !ruby/object:Gem::Requirement
+  requirement: &11902200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20401280
+  version_requirements: *11902200
 description: Gem makes your ActiveRecord models more SEO friendly. Changes URL to
   look way better
 email: maciej@mensfeld.pl
@@ -53,6 +53,11 @@ extra_rdoc_files:
 - CHANGELOG.rdoc
 - README.md
 - lib/acts_more_seo.rb
+- lib/generators/acts_more_seo/install_generator.rb
+- lib/generators/acts_more_seo/templates/create_seo_history_migration.rb
+- lib/seo_finder.rb
+- lib/seo_formatter.rb
+- lib/seo_history.rb
 - lib/string_ext.rb
 files:
 - CHANGELOG.rdoc
@@ -64,6 +69,11 @@ files:
 - acts_more_seo.gemspec
 - init.rb
 - lib/acts_more_seo.rb
+- lib/generators/acts_more_seo/install_generator.rb
+- lib/generators/acts_more_seo/templates/create_seo_history_migration.rb
+- lib/seo_finder.rb
+- lib/seo_formatter.rb
+- lib/seo_history.rb
 - lib/string_ext.rb
 - spec/acts_more_seo_spec.rb
 - spec/spec_helper.rb
@@ -93,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.2'
 requirements: []
 rubyforge_project: acts_more_seo
-rubygems_version: 1.8.5
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Gem makes your ActiveRecord models more SEO friendly. Changes URL to look