make_permalink 0.0.1 → 0.0.2

data/README.textile

@@ -0,0 +1,81 @@
+h1. Simple make_permalink Gem
+
+*make_permalink* is a simple gem that allows you to easily create permalinks (url-friendly-output) for methods in your objects. You don't need any database storage to make it work which is just awesome!
+
+h1. Example
+
+<pre>
+  class Post
+    make_permalink :title
+  end
+
+  p = Post.create(:title => "Hello World!")
+  p.permalink   # => "1-hello-world"
+</pre>
+
+If you're using _rails_ and you want your url's to have the permalink and not only the id, just add the *to_param* method to your model
+
+<pre>
+  class Post < ActiveRecord::Base
+    make_permalink :title
+
+    def to_param
+      permalink
+    end
+  end
+</pre>
+
+h1. Install
+
+It's really simple to install this magnificent gem. Just run a small @gem install make_permalink@ and you've got it!
+
+Well, not quite, you may have the gem installed in your system, but when you share the beautiful code you've created, people won't actually know that. So, that's when  @Bundler@ appears.
+
+Add @gem 'make_permalink'@ to your Gemfile and then run @bundle install@. Well, and remember to check your Gemfile in your repo.
+
+h1. Options
+
+h3. Non ascii characters
+
+You can have a permalink that won't change non-ascii.
+
+<tt> :replace_non_ascii </tt>: If set to false non-ascii chars won't be replaced. Default is true
+
+<pre>
+  class Post
+    make_permalink :title, :replace_non_ascii => false
+  end
+
+  p = Post.create(:title => "Let's rock & roll")
+  p.permalink   # => "1-let-s-rock-roll"
+</pre>
+
+Notice that if you don't replace non-ascii chars the permalik would be way cooler (thanks to the "stringex":https://github.com/svenfuchs/stringex gem)
+
+<pre>
+  # You will get this with the default behavior 
+  p.permalink  # => "1-lets-rock-and-roll"
+</pre>
+
+h3. Remove id from permalink
+
+I don't really like to have the ID of the object on the permalink, so I just added an option to remove it. Just call the method with *_:include_id => false_* and you're done!
+
+<tt> :include_id </tt> is true by default but just change it to remove the id from the permalink.
+
+Internally the gem will look for the *_create_permalink_prefix(boolean)_* method so if you want to change the prefix, just override that method and you'll be good to go in no time!
+
+h1. Bugs/Contact
+
+If you need to contact me about a bug or anythig, please open an issue "here":https://github.com/nhocki/make_permalink/issues
+
+Also, feel free to patch it as needed, every fix/refactoring/extension is more than welcome!
+
+h1. Contributors
+
+Nicolás Hock ("nhocki":http://github.com/nhocki)
+Federico Builes ("febuiles":http://github.com/febuiles) 
+Sven Fuchs ("svenfuchs":http://github.com/svenfuchs) for the Stringex gem
+
+
+Copyright (c) 2011 Nicolás Hock Isaza, released under the MIT license

data/lib/make_permalink/base.rb

@@ -28,6 +28,22 @@ module MakePermalink
       }
     end
     
+    
+    # Creates a permalink for a given object based on the method passed as
+    # parameter:
+    #
+    # You can modify the default behavior with this two options
+    #
+    # <tt>:include_id</tt>: This will include the objects id method. Default true.
+    # <tt>:replace_non_ascii</tt>: This will replace non-ascii-chars (like & and $) for their english words (and - dollars). Default true
+    #     
+    #   class Post < ActiveRecord::Base
+    #     make_permalink :title
+    #   end
+    #
+    #   p = Post.create(:title => "Rock & Roll!")
+    #   p.permalink   # => "1-rock-and-roll"
+
     def make_permalink(method, options = {})
       define_method "permalink" do
         options = self.class.default_options.merge!(options)

data/lib/make_permalink/version.rb

@@ -1,3 +1,3 @@
 module MakePermalink
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -2,7 +2,7 @@
 name: make_permalink
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Nicol\xC3\xA1s Hock Isaza"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 -05:00
+date: 2011-02-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.textile
 - Rakefile
 - lib/make_permalink.rb
 - lib/make_permalink/base.rb
@@ -78,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: make_permalink
-rubygems_version: 1.5.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Create dynamic permalinks from an attribute