friendly_slug 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d527472b32e4a952ba533e7681eed150833ab8d438a634782a565ecaaad7dc46
-  data.tar.gz: 662b7278db9c754c2740552d7fe6c93a9cc5d1681b54ce41ac80fe925782009f
+  metadata.gz: c6565fc64fa222495652a035607e48c7c0b0833a3a4661b8681a0a0aeadc330a
+  data.tar.gz: '074509b1f073d3de471c53f7d8bf604d52a495f6b90653e788ddb52308ca30d3'
 SHA512:
-  metadata.gz: a6ad47a123ca083d0a335a6bbb322cafb9b0f88326bb372e62e8601fb6fb31e1e32da8d3359fbbf667912888fed84abe100d54616bb5bf69c6a0ead68161d9a1
-  data.tar.gz: 6dda687af9e701bc8410382b815a3ddb29f00cb3cbc8a4af9f4eea4533773f5f0f60a736c02027590bd82a0a1a513ef9b99775945c8e2ee10a3689e91d2447d9
+  metadata.gz: c671c2238048afaefdf3f79e0bf4d43e917dae869e5a5e29bf082f0c395dca6a356861d0f4baed9b54db53dee636f940b48d1302e372c60db0b7fac2bf87cffb
+  data.tar.gz: e01075b8939e690cfb9c658c0e55909843ab1fb71607230b60616b1dfffda430556e52a1f325796217348b810922b958e29e3011d2e38b041eff5fb42cc8da1d

data/README.md

@@ -1,7 +1,7 @@
 # FriendlySlug
 
 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.
+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 Model in your code base for this to work.
 
 ## Installation
 
@@ -24,10 +24,11 @@ Or install it yourself as:
 In the model you want to add your slug to, simply put the following code in it:
 
 ```ruby
+# models/your_model.rb
 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.
+You must provide one unique indexed attribute that you can search by to retrieve a database row and one other attribute you want to appear in the URL. The method only accepts two parameters at the moment.
 
 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:
 
@@ -35,15 +36,15 @@ For example, if I have a blog post with a `title` and `id`, `id` being a primary
 @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
+link_to @blog.title, blog_path(@blog) # => 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
+def set_blog
+  @blog = 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.
+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 sentence being the title.
 
 Likewise you could move
 
@@ -57,11 +58,17 @@ Doing it the this way would require you do call `.first` in the controller inste
 
 ```ruby
 # controllers/blogs_controller.rb
-def set_blog_post
-  @blog_post = Blog.find(params[:id].split("-".first)) # => 1
+def set_blog
+  @blog = Blog.find(params[:id].split("-").first) # => 1
 end
 ```
 
+You can also set a static string in place of an attribute if you wanted URL's to be similar in wording.
+
+```ruby
+build_friendly_slug :id, "My Static String"  # => http://localhost:3000/blogs/:id-my-static-string
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/friendly_slug.gemspec

@@ -20,8 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  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 "activemodel", "~> 3.0"
+  spec.add_development_dependency "bundler", "> 1.16"
+  spec.add_development_dependency "rake", "> 10.0"
+  spec.add_development_dependency "activemodel", "> 3.0"
 end

data/lib/friendly_slug/active_record/base.rb

@@ -17,7 +17,7 @@ module FriendlySlug
 
         class_eval do
           def to_param
-            "#{lookup_key(self.class.first_attribute_key)}-#{lookup_key(self.class.second_attribute_key)}".to_s.gsub(/<\/?[^>]*>|[^\w\s-]/, '').strip.downcase.gsub(/\s/, '-')
+            "#{lookup_key(self.class.first_attribute_key)}-#{lookup_key(self.class.second_attribute_key)}".to_s.gsub(/<\/?[^>]*>|[^\w\s-]/, '').strip.downcase.gsub(/\s{1,}/, '-')
           end
 
           private 

data/lib/friendly_slug/version.rb

@@ -1,3 +1,3 @@
 module FriendlySlug
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,69 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: friendly_slug
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sam Holst
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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'
 - !ruby/object:Gem::Dependency
   name: activemodel
   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. Friendly Slug is meant