acts_more_seo 0.1.1 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,2 +1,6 @@
 = Version 0.1.0
 * Gem existence started
+= Version 0.2.0
+* Changed API (backward compatibility included)
+* Much better use (without an id in url)
+* Way cooler ;)

data/README.md

@@ -14,13 +14,51 @@ Gem makes your ActiveRecord models more SEO friendly. Changes URLs to look way b
 
 ## Example
 
+First of all - remember to make URL fields uniq!
+
     class CoolElement < ActiveRecord::Base
         acts_more_seo :title
     end
 
-    mod = CoolElement.create(:title => 'cool stuuf :)')
+    mod = CoolElement.create({:title => 'cool stuuf :)'})
     cool_element_path(mod) ===> cool_elements/12345-cool-stuff
 
+You can also pass an array of columns like this
+
+    class CoolElement < ActiveRecord::Base
+        acts_more_seo :columns => [:name, :surname, :title]
+    end
+
+    mod = CoolElement.create({
+            :name => 'Maciej',
+            :surname => 'Mensfeld',
+            :title => 'cool stuuf :)'
+          })
+    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
+
+    class CoolElement < ActiveRecord::Base
+        acts_more_seo :columns => [:name, :surname, :title], :use_id => false
+    end
+
+    mod = CoolElement.create({
+            :name => 'Maciej',
+            :surname => 'Mensfeld',
+            :title => 'cool stuuf :)'
+          })
+    cool_element_path(mod) ===> cool_elements/maciej-mensfeld-cool-stuff
+
+However, if you do so - it is highly recommended to create string seo_url column in your model:
+
+    add_column :model, :seo_url, :string
+
+so you can search via find_by_seo_url method:
+
+    CoolElement.find_by_seo_url(params[:id])
+
+You don't need to update seo_url, gem will hook up with this field automatically if it exists.
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -1,8 +1,9 @@
+require 'psych'
 require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('acts_more_seo', '0.1.1') do |p|
+Echoe.new('acts_more_seo', '0.2.1') 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

@@ -2,22 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_more_seo}
-  s.version = "0.1.1"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Maciej Mensfeld"]
-  s.cert_chain = ["/home/mencio/.cert_keys/gem-public_cert.pem"]
-  s.date = %q{2011-04-17}
+  s.authors = [%q{Maciej Mensfeld}]
+  s.date = %q{2011-11-04}
   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 = ["CHANGELOG.rdoc", "README.md", "lib/acts_more_seo.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/string_ext.rb", "spec/acts_more_seo_spec.rb", "spec/spec_helper.rb"]
+  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 = ["--line-numbers", "--inline-source", "--title", "Acts_more_seo", "--main", "README.md"]
-  s.require_paths = ["lib"]
+  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.5.2}
-  s.signing_key = %q{/home/mencio/.cert_keys/gem-private_key.pem}
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better}
 
   if s.respond_to? :specification_version then

data/lib/acts_more_seo.rb

@@ -3,14 +3,40 @@ require "string_ext"
 module Acts
   module MoreSeo
 
+    class NoSeoUrlTable < StandardError; end
+
     def self.included(base)
       base.extend AddActsAsMethod
     end
 
     module AddActsAsMethod
-      def acts_more_seo(seo_column = :name)
-        cattr_accessor :seo_column
-        self.seo_column = seo_column
+      def acts_more_seo(params = {})
+        # Backward compatibility
+        params = {:column => params}  if params.is_a?(String) || params.is_a?(Symbol)
+        params = {:columns => params} if params.is_a?(Array)
+
+        columns = params[:column] || params[:columns] || :name
+        use_id  = !params[:use_id].nil? ? params[:use_id] : true
+
+        if columns.is_a?(Array)
+          columns.collect!{|a| a.to_sym}
+        else
+          columns = columns.to_sym
+        end
+
+        if !use_id && !self.column_names.include?("#{:seo_url}")
+          raise NoSeoUrlTable , 'Create seo_url table for your model'
+        end
+
+        cattr_accessor :seo_columns
+        cattr_accessor :seo_use_id
+
+        before_update :update_seo_url
+        after_create  :set_seo_url
+
+        self.seo_columns = columns
+
+        self.seo_use_id  = use_id
         class_eval <<-END
            include Acts::MoreSeo::InstanceMethods
         END
@@ -20,6 +46,10 @@ module Acts
     # Istance methods
     module InstanceMethods
 
+      def self.included(aClass)
+        aClass.extend ClassMethods
+      end
+
       # Overwrite default to_param - should return nice url
       def to_param
         self.url
@@ -27,11 +57,54 @@ module Acts
 
       # Lets return nice and smooth url
       def url
-        seo = self.send(self.class.seo_column)
-        seo ? "#{self.id}-#{seo.to_url}" : self.id
+        # 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
+
+        if self.class.seo_use_id
+          seo_path = "#{self.id}#{"-#{seo_path}" if seo_path && seo_path.length > 0}"
+        end
+
+        seo_path.length > 0 ? seo_path : "#{self.id}"
+      end
+
+      def update_seo_url
+        if self.class.seo_url_table?
+          self.update_column(:seo_url, self.to_param)
+        end
+      end
+
+      def set_seo_url
+        if self.class.seo_url_table?
+          self.update_column(:seo_url, self.to_param)
+        end
       end
 
       module ClassMethods
+
+        def seo_url_table?
+          self.column_names.include?("#{:seo_url}")
+        end
+
+        def find(*args)
+          super
+        rescue ActiveRecord::RecordNotFound
+          if !self.seo_use_id && !(el = find_by_seo_url(args.first, :first)).nil?
+            el
+          else
+            raise ActiveRecord::RecordNotFound
+          end
+        end
+
       end
     end
   end

data/spec/acts_more_seo_spec.rb

@@ -11,13 +11,31 @@ class CoolerElement < ActiveRecord::Base
     acts_more_seo :title
 end
 
+class SpecialElement < ActiveRecord::Base
+    acts_more_seo :columns => [:name, :surname, :title]
+end
+
+class BestElement < ActiveRecord::Base
+    acts_more_seo :columns => [:name, :surname, :title], :use_id => false
+end
+
 describe CoolElement do
   subject { CoolElement }
 
+  context "when we have a class which has use_id => true" do
+    it "should find element unless id is corrupted" do
+      a = subject.create(:name => 'bla bla bla')
+      subject.find(a.id).should eql(a)
+      subject.find(a.to_param).should eql(a)
+      subject.find("#{a.to_param}aaa").should eql(a)
+      lambda { subject.find("134534dass") }.should raise_error(ActiveRecord::RecordNotFound)
+    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)
+      a.to_param.should eql(a.id.to_s)
     end
   end
 
@@ -30,7 +48,7 @@ describe CoolElement do
     context "and there are some url-not-friendly letters" do
       it "should remove them and return nice url" do
         a = subject.create(:name => 'ą')
-        a.to_param.should eql("#{a.id}-aa")
+        a.to_param.should eql("#{a.id}-a")
       end
     end
   end
@@ -42,7 +60,17 @@ describe CoolerElement do
   context "when there is no name" do
     it "should return only id" do
       a = subject.create
-      a.to_param.should eql(a.id)
+      a.to_param.should eql(a.id.to_s)
+    end
+
+    it "should be able to find existing element" do
+      a = subject.create
+      subject.find(a.id).should eql(a)
+    end
+
+    it "should raise error when there is no element" do
+      a = subject.create
+     lambda { subject.find(a.id+1) }.should raise_error(ActiveRecord::RecordNotFound)
     end
   end
 
@@ -50,13 +78,106 @@ describe CoolerElement do
     it "should return nice url" do
       a = subject.create(:title => 'bla bla bla')
       a.to_param.should eql("#{a.id}-bla-bla-bla")
+      subject.find(a.to_param).should eql(a)
     end
 
     context "and there are some url-not-friendly letters" do
       it "should remove them and return nice url" do
         a = subject.create(:title => 'ą')
-        a.to_param.should eql("#{a.id}-aa")
+        a.to_param.should eql("#{a.id}-a")
       end
     end
   end
 end
+
+describe SpecialElement do
+  subject { SpecialElement }
+
+  context "when there is no name" do
+    context "but surname and title exists" do
+      it "should return nice looking url " do
+        a = subject.create({:surname => 'mensfeld', :title => 'test abc'})
+        a.to_param.should eql("#{a.id}-mensfeld-test-abc")
+      end
+    end
+
+    context "and no other param" do
+      it "should return only id" do
+        a = subject.create()
+        a.to_param.should eql("#{a.id}")
+      end
+    end
+  end
+
+  context "when there are all the params" do
+    it "should return nice url" do
+        a = subject.create({:name => 'maciej', :surname => 'mensfeld', :title => 'test abc'})
+        a.to_param.should eql("#{a.id}-maciej-mensfeld-test-abc")
+    end
+  end
+end
+
+
+describe BestElement do
+  subject { BestElement }
+
+  context "when there is no surname" do
+    context "but surname and title exists" do
+      it "should return nice looking url " do
+        a = subject.create({:name => 'mensfeld', :title => 'test abc'})
+        a.to_param.should eql("mensfeld-test-abc")
+        a.seo_url.should eql("mensfeld-test-abc")
+      end
+    end
+  end
+
+  context "when there is no name" do
+    context "but surname and title exists" do
+      it "should return nice looking url " do
+        a = subject.create({:surname => 'mensfeld', :title => 'test abc'})
+        a.to_param.should eql("mensfeld-test-abc")
+        a.reload
+        a.seo_url.should eql("mensfeld-test-abc")
+      end
+    end
+
+    context "and no other param" do
+      it "should return only id" do
+        a = subject.create()
+        a.to_param.should eql("#{a.id}")
+        a.reload
+        a.seo_url.should eql("#{a.id}")
+      end
+    end
+  end
+
+  context "when there are all the params" do
+    it "should return nice url" do
+        a = subject.create({:name => 'maciej', :surname => 'mensfeld', :title => 'test abc'})
+        a.to_param.should eql("maciej-mensfeld-test-abc")
+        a.reload
+        a.seo_url.should eql("maciej-mensfeld-test-abc")
+    end
+  end
+
+  context "when we have a class which has use_id => false" do
+    it "should find element only when seo_url is same (or by id)" do
+      a = subject.create(:name => 'bla bla bla')
+      subject.find(a.id).should eql(a)
+      subject.find(a.to_param).should eql(a)
+      lambda { subject.find("#{a.to_param}aaa") }.should raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  context "when updating object" do
+    it "should have refreshed seo_url" do
+        a = subject.create({:name => 'mensfeld', :title => 'test abc'})
+        a.to_param.should eql("mensfeld-test-abc")
+        a.name = 'kowalski'
+        a.save
+        a.to_param.should eql("kowalski-test-abc")
+        subject.find("kowalski-test-abc").should eql(a)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -21,5 +21,24 @@ ActiveRecord::Schema.define do
     create_table :cooler_elements do |table|
       table.string :title
     end
+
+    create_table :special_elements do |table|
+      table.string :title
+      table.string :name
+      table.string :surname
+    end
+
+    create_table :better_elements do |table|
+      table.string :title
+      table.string :name
+      table.string :surname
+    end
+
+    create_table :best_elements do |table|
+      table.string :title
+      table.string :name
+      table.string :surname
+      table.string :seo_url
+    end
 end
 

metadata

@@ -1,73 +1,49 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: acts_more_seo
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Maciej Mensfeld
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZtYWNp
-  ZWoxGDAWBgoJkiaJk/IsZAEZFghtZW5zZmVsZDESMBAGCgmSJomT8ixkARkWAnBs
-  MB4XDTExMDQwOTA5NDcyMloXDTEyMDQwODA5NDcyMlowPzEPMA0GA1UEAwwGbWFj
-  aWVqMRgwFgYKCZImiZPyLGQBGRYIbWVuc2ZlbGQxEjAQBgoJkiaJk/IsZAEZFgJw
-  bDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0+nG3V4/exIeiJ0IN+
-  wVfq8Utcu4Qpo+58EIVMIu3FiK+8w6MBvatZnUrRu12pqWLw9xrUkCiYeRErD+jF
-  AmdggIM/tu9CcjvURXH7VeTzOVA+pnV+eJWMD61o8HljFVcb/nyEYYVKErtr9/O4
-  QrIGv5lnszq1PMj2sBMy2gOP1YnzawncMLmkpp/T5SU4JZ5gAktGMRVz8RxmZzF5
-  6NVqFLbuqSRSU5U//WJvZVJt8dycCGgQzBM4Vi3nkOWyjIF0BANf1TqnlU2u6s8d
-  UK1AoDZfg5feef5e8eqoomHebX1opNGM/SOQhu3LRgax4rJfnl6VS3I2wighohsf
-  AgcCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQUGlrWBqxVieAPk7NEzBDp
-  kM+iAMMwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IBAQAJMoyBaJs8boiz
-  lFpbw6MWjk+7ZhqoHpFrWEV4nzb5GzyHZ7GU/pa1fSEQR0SCs+LnTLQbAYNQyUTT
-  O+UsTuA7xzI//v6cSodv3Q9NbfoDlou74xv1NXorWoosQFMpVWrXv+c/1RqU3cq4
-  WUr+rRiveEXG4tXOwkrpX8KH8xVp2vQZcGw3AXPqhzfqDGzpHd6ws3lk+8HoSrSo
-  2L68tDoxraF2Z2toAg9vfFw1+mOeDk1xVIPVcBy3tJxstHfHGHlQuMiRiDQX2b2D
-  YYU8UWVt2841IwB5Dgl4O+atXhe9ZTBO0W32pl4Bq5CP9lhQRT1KL7sxfznJlF7Y
-  BH3YFsdk
-  -----END CERTIFICATE-----
-
-date: 2011-04-17 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+cert_chain: []
+date: 2011-11-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &12118440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: active_record
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *12118440
+- !ruby/object:Gem::Dependency
+  name: active_record
+  requirement: &12117940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better
+  prerelease: false
+  version_requirements: *12117940
+description: Gem makes your ActiveRecord models more SEO friendly. Changes URL to
+  look way better
 email: maciej@mensfeld.pl
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGELOG.rdoc
 - README.md
 - lib/acts_more_seo.rb
 - lib/string_ext.rb
-files: 
+files:
 - CHANGELOG.rdoc
 - Gemfile
 - MIT-LICENSE
@@ -80,38 +56,35 @@ files:
 - lib/string_ext.rb
 - spec/acts_more_seo_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/mensfeld/Css-Image-Embedder
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Acts_more_seo
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.2"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
 requirements: []
-
 rubyforge_project: acts_more_seo
-rubygems_version: 1.5.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Gem makes your ActiveRecord models more SEO friendly. Changes URL to look way better
+summary: Gem makes your ActiveRecord models more SEO friendly. Changes URL to look
+  way better
 test_files: []
-

metadata.gz.sig

@@ -1 +0,0 @@
-A1/ɐ����a��o��f���9������[&�&ƫ{���_�JV�O7}�bƢ�O���{�΢��