friendly_slug 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b2cec4917ae2a17d1ff7baca9dfbb8ef36740c8db995067cf4f7f07be3df2a6
-  data.tar.gz: 0fb511c54e1aac67e7a954e89bea42250f1417680a2c4b3ddfc2c68de9272a95
+  metadata.gz: 1768c3c3790ed33b7ecfe7501ffb42d64230779492bea029a176f1993609f068
+  data.tar.gz: b10b282d7bfc58ba1d696326a9a2756dd8170d4967f0d73d682bdf59479367fe
 SHA512:
-  metadata.gz: ce152b9bb7dbeda1cde1a52a54dd1c61d7cf9035ba1ac17023fecd0506b946810e32fe9181deab968ef43e6b76894c2fd0932e32674d9a6d183bbc042a6ee396
-  data.tar.gz: 3f1be65cc290f951e23f02e6864cd85eedc49b457605ba441c8c50690a2eb2afd9f4afc8de4d76e3d5b349cdeeb1e793aadf0ce55ac3314f2f6a5d5a2d429f6d
+  metadata.gz: 2af459a248a59f29df70a7fc4c846e658c30519fae10a5bd61dfcc864c858ea593272cd8d59fc04ba2e45146d5347a94d2166e01109fced0fc78319f8cdd2b86
+  data.tar.gz: 34489be57533253a2c9af754a4020c24481424ed6bfd4061ef3b33887913f3f423df158100f9d10936bed3416e0307ac4ada03ace389eae3721655a1fbda5559

data/README.md

@@ -1,8 +1,7 @@
 # FriendlySlug
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/friendly_slug`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Friendly Slug is meant to dynamically create SEO friendly URL links. It is extremely lightweight and non resource intensive. Friendly Slug ties directly into the Rails URL Helpers so you dont 
+have to change anything. There is no need to create a Rails Migration as this gem does not add anything to your current database. You must have Active Record in your code base for this to work.
 
 ## Installation
 
@@ -22,7 +21,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In the model you want to add your slug to, simply put the following code in it:
+
+```ruby
+build_friendly_slug :title, :id
+```
+
+You will want at least one unique element that you can search by to retrieve a database row. This attribute should also have an index.
+
+For example, if I have a blog post with a `title` and `id`, `id` being a primary key and also an indexed table attribute, my slugged link would look like this:
+
+```ruby
+@blog.title = "The Great Friendly Slug"
+
+# views/blogs/index.rb
+link_to @blog_post.title, blog_post_path(@blog_post) # => http://localhost:3000/blogs/the-great-friendly-slug-1
+
+# controllers/blogs_controller.rb
+def set_blog_post
+  @blog_post = Blog.find(params[:id].split("-".last)) # => 1
+end
+```
+
+In the above example, we will split the `id`, which will end up being `"the-great-friendly-slug-1"`, `1` being the `id` of the actualy blog post, and the preceding setence being the title.
+
+Likewise you could move
+
+```ruby
+build_friendly_slug :id, :title
+```
+
+the reversed way to have the Friendly Slug be `"1-the-great-friendly-slug"`. It could be whatever you want it to be as you as long as you can search a unique attribute with the slugged text.
+
+Doing it the this way would require you do call `.first` in the controller instead of `.last` in the lookup:
+
+```ruby
+# controllers/blogs_controller.rb
+def set_blog_post
+  @blog_post = Blog.find(params[:id].split("-".first)) # => 1
+end
+```
 
 ## Development
 

data/friendly_slug.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Generate a model specific SEO URL friendly slug.}
   spec.description   = %q{A simple SEO URL friendly slug model generator.}
-  spec.homepage      = "https://rubygems.org/gems/friendly-slug"
+  spec.homepage      = "https://github.com/samholst/friendly_slug"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "active_model", "~> 3.0"
 end

data/lib/friendly_slug/version.rb

@@ -1,3 +1,3 @@
 module FriendlySlug
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_slug
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sam Holst
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: active_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A simple SEO URL friendly slug model generator.
 email:
 - sawohol@gmail.com
@@ -73,7 +87,7 @@ files:
 - lib/friendly_slug.rb
 - lib/friendly_slug/active_record/base.rb
 - lib/friendly_slug/version.rb
-homepage: https://rubygems.org/gems/friendly-slug
+homepage: https://github.com/samholst/friendly_slug
 licenses:
 - MIT
 metadata: {}