acts_as_permalink 0.4.0 → 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 190594fc3346f8fd08fb3230464ca3de803c5d97
+  data.tar.gz: 7eb39d42f85095d85ade06cc2a6e07d05ae4b3a9
+SHA512:
+  metadata.gz: 4b3d28c4da66a76351e29cb9006c508f89dde1165eec32130e6fccaa70dd4d9cacad09450af84b6b8ec88ad8d0660a33c94661c2ecaaa1843b64395c84aa69ef
+  data.tar.gz: e782467bd4519a071e15ab29ee3639dc01d8f242b231ad8282340433f498c13f1ac28bcac86febd721f7a126529a44c5744b3f78a65885e6ea2b9e0fe123ec3d

data/README.markdown

@@ -1,58 +1,87 @@
-# Acts As Permalink
+# [Acts as Permalink](https://github.com/kmcphillips/acts_as_permalink)
+
+[![Build Status](https://travis-ci.org/kmcphillips/acts_as_permalink.svg?branch=master)](https://travis-ci.org/kmcphillips/acts_as_permalink)
 
 Manages permalink field on an ActiveRecord model to be used in place of the id field in Rails.
 
-Written by Kevin McPhillips (kmcphillips) in 2009.
+Written by [Kevin McPhillips](https://github.com/kmcphillips) ([github@kevinmcphillips.ca](mailto:github@kevinmcphillips.ca))
 
-Last updated March 2012.
 
-[http://github.com/kmcphillips/acts_as_permalink](http://github.com/kmcphillips/acts_as_permalink)
+## Installation
 
-[github@kevinmcphillips.ca](mailto:github@kevinmcphillips.ca)
+Using bundler, add to the Gemfile:
 
+```ruby
+gem 'acts_as_permalink'
+```
 
-## Usage
+Or stand alone:
 
-The gem is on RubyGems:
+```
+$ gem install acts_as_permalink
+```
 
-    gem 'acts_as_permalink'
+## Usage
+
+This gem works with ActiveRecord, and by convention looks for a `title` method and a `permalink` string field on the model:
 
 And then just call it in your model:
 
-    class Post < ActiveRecord::Base
-      acts_as_permalink
-    end
+```ruby
+class Post < ActiveRecord::Base
+  acts_as_permalink
+end
+```
+
+You can then use your link helpers normally:
 
-That's about it. 
-The plugin expects string fields to be used to save the permalink on the model and to use as a source for the permalink. It defaults to use the fields named "title" and "permalink" which can be overridden by options:
+```ruby
+post_path(@post) # "/post/the_name_of_post_here"
+```
 
-    :from        =>  :title       # Name of the active record column or function used to generate the permalink
-    :to          =>  :permalink   # Name of the column where the permalink will be stored
-    :max_length  =>  60           # Maximum number of characters the permalink will be
+The `title` and `permalink` fields can be overridden with the following options:
 
-So, for example you have want to store your permalink in a column called "path_name" and you want to generate your permalink using first and last name, and you want to restrict it to 40 characters, your model would look like:
+    from:        :title       # Name of the active record column or function used to generate the permalink
+    to:          :permalink   # Name of the column where the permalink will be stored
+    max_length:  60           # Maximum number of characters the permalink will be
 
-    class User < ActiveRecord::Base
-      acts_as_permalink :from => :full_name, :to => :path, :max_length => 40
+So, for example you have want to store your permalink in a column called `path_name` and you want to generate your permalink using first and last name, and you want to restrict it to 40 characters, your model would look like:
 
-      def full_name
-        first_name + last_name
-      end
-    end
+```ruby
+class User < ActiveRecord::Base
+  acts_as_permalink from: :full_name, to: :path, max_length: 40
+
+  def full_name
+    [first_name, last_name].join(" ")
+  end
+end
+```
 
 
 ## Tests
 
-Just run:
-  
-    rspec
+```
+$ bundle exec rspec
+```
+
+
+## Changelog
+
+* 0.4.1  --  Documentation improvements.
+
+* 0.4.0  --  Rails 4 support.
 
+* 0.3.2  --  Fixed regression in STI support.
 
-## History
+* 0.3.1  --  Rails 3.2 support.
 
-* May 3, 2012 -- 0.3.1 -- Finally got it gemified.
+* 0.3.0  --  Fixed collision problem with single table inheritance models. Removed dependency on andand gem.
 
-* March 19, 2012  --  Updated to work with Rails 3.2
 
-* Feb 13, 2010  --  Fixed collision problem with single table inheritance models. Removed dependency on andand gem.
+## Contributing
 
+1. Fork it ( https://github.com/kmcphillips/acts_as_permalink/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/acts_as_permalink/version.rb

@@ -1,5 +1,5 @@
 module Acts
   module Permalink
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,49 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_permalink
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &74411750 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *74411750
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74411240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74411240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &74410600 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74410600
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Manages permalink columns in active record models. Strips special characters
   and spaces, creates before validation, assures uniqueness. That kind of thing.
 email:
@@ -52,39 +60,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/acts_as_permalink.rb
-- lib/acts_as_permalink/version.rb
 - MIT-LICENSE
-- Rakefile
 - README.markdown
+- Rakefile
+- lib/acts_as_permalink.rb
+- lib/acts_as_permalink/version.rb
 homepage: http://github.com/kmcphillips/acts_as_permalink
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -473665709
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -473665709
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Automatically manage permalink fields for ActiveRecord models in Rails.
 test_files: []