flowmor_router 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f1ebc6d621b453c84faed0bb13d8308b3b41253
-  data.tar.gz: 605fb7c44ebfaf312147b27f622e70f6c15bf15d
+  metadata.gz: 5083f6f53551ab2b5b71297b68cf0051782d7467
+  data.tar.gz: 60b5fb5c276e951281ec0c4aa1ba7a1cc06e7349
 SHA512:
-  metadata.gz: 7c2ff21c3643e02cc1a599284c8bb88bca5d2d6dfaae291e95380bab1e6f9121aef714f4e45d201427554dbedb920ea16a331395ff483b13aa3ca0b6d2a08d4b
-  data.tar.gz: 99dcf89a95b529de76053d9c29225d4c28d09ae094f765c9d0cdedc5c1e06df0185877169996f48e4b14f8b92df8dd4f311e46c77569efbc2591afb8eff5a968
+  metadata.gz: f2503a0cb8da3e53c654bf9b6d5d64e202d36bd55e52c2863dd0605a76baa97f417cb1410f423a754c7e1caca8a756562b296d4a910afa254675631bfe414bd3
+  data.tar.gz: 9ffcd42582e48d404bc521647cdb1f034c799fd8287291562656f7f03e741d52b150ef766e472598da68883866fac27e594dc62ac2a2106994bbad9f14c9a510

data/README.md

@@ -34,15 +34,16 @@ Every model instance's route is named after the model and name.
 
 ## State of the project
 
-### 0.0.1
+### 0.0.3
+### Tested and Works on Rails 4.x and Ruby 2.x
 
-Its got enough functionality to work really well for me [(mwlang)](https://github.com/mwlang) in its current form.  Its a simple implementation with relatively few lines of code, adequately test covered.  It works and is used in production on a handful of sites.  You can see it in action on [my personal site](http://codeconnoisseur.org) and [business site](http://cybrains.net).
+Its got enough functionality to work really well for me [(mwlang)](https://github.com/mwlang) in its current form.  It's a simple implementation with relatively few lines of code, adequately test covered.  It works and is used in production on a handful of sites.  You can see it in action on [my personal site](http://codeconnoisseur.org) and [business site](http://cybrains.net).
 
 ### Is it For You?
 
-This isn't for everyone.  It does build routes from objects in the database.  It does provide functionality similar to [friendly_id](https://github.com/norman/friendly_id) or by simply redefining the id of a model with AR's #to_param. If you run multiple instances of an application, you'll need to take care of syncing when the database is updated.  The simplest way to do this is by adding Post.reload_routes (for example) to the before_filter callback of the controller.  Sounds like a performance killer, but its really not.  Just think every time you refresh during development that the routes are reloaded!
-
+This isn't for everyone.  It does build routes from objects in the database.  Rails purists will argue this method pollutes the routes space.  It does provide functionality similar to [friendly_id](https://github.com/norman/friendly_id) or by simply redefining the id of a model with AR's #to_param. If you run multiple instances of an application, you'll need to take care of syncing when the database is updated.  The simplest way to do this is by adding Post.reload_routes (for example) to the before_filter callback of the controller.  Sounds like a performance killer, but its really not.  Just think every time you refresh during development that the routes are reloaded! 
 
+On the other hand, this approach allows you a lot of flexibility to creating truly custom routes in your app.  It also allows you to avoid using a global "match any" in your config/routes.rb.  A use case is porting over a WordPress site to Rails where there was a highly customized permalink structure in place.  
 
 ### To Install
 
@@ -143,6 +144,14 @@ end
 
 If you need to get any fancier than that, then just about everything you need can be found in the [app/models/routable_record.rb](https://github.com/mwlang/flowmor_router/blob/master/app/models/routable_record.rb) implementation.
 
+By default, all RoutableRecord instances are added to the routes table.  What gets routed can be customized by overriding the :routable scope.
+
+```ruby
+class Article < RoutableRecord
+  scope :routable, -> { where published: true }
+  # ...
+end
+```
 ### TODO and Contributing
 
 This is largely an extraction of functionality from multiple Rails projects.  As such, it has the features I needed to fully extract to the engine.  However, some possible enhancements came to mind as I pulled this together:

data/app/models/routable_record.rb

@@ -1,6 +1,8 @@
 class RoutableRecord < ActiveRecord::Base
   self.abstract_class = true
 
+  scope :routable, -> {}
+  
   def self.route_model
     name.underscore.downcase
   end
@@ -90,11 +92,19 @@ class RoutableRecord < ActiveRecord::Base
   end
   
   def url
-    send("#{route_name}_url", default_url_options)
+    begin
+      send("#{route_name}_url", default_url_options)
+    rescue NoMethodError
+      raise FlowmorRouter::UnroutedRecord.new("#{self.inspect} was not routed.")
+    end
   end
 
   def path
-    send("#{route_name}_path")
+    begin
+      send("#{route_name}_path")
+    rescue NoMethodError
+      raise FlowmorRouter::UnroutedRecord.new("#{self.inspect} was not routed.")
+    end
   end
   
   def new_name_value

data/config/routes.rb

@@ -2,7 +2,7 @@ Rails.application.routes.draw do
 
   # Routes from RoutableRecord descendants
   RoutableRecord.descendants.each do |model|
-    model.all.each do |record|
+    model.routable.each do |record|
       get record.route,
       to: record.controller_action,
       defaults: { id: record.id },

data/lib/flowmor_router/exceptions.rb

@@ -1,3 +1,4 @@
 module FlowmorRouter
   class UnroutableRecord < RuntimeError; end
+  class UnroutedRecord < RuntimeError; end
 end

data/lib/flowmor_router/version.rb

@@ -1,3 +1,3 @@
 module FlowmorRouter
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/dummy/app/controllers/article_controller.rb

@@ -0,0 +1,9 @@
+class ArticleController < ApplicationController
+  before_action :set_article, only: [:show]
+
+  private
+  
+  def set_article
+    @article = Article.find(params[:id])
+  end
+end

data/test/dummy/app/models/article.rb

@@ -1,3 +1,3 @@
 class Article < RoutableRecord
-
+  scope :routable, -> { where(published: true) }
 end

data/test/dummy/app/views/article/show.html.erb

@@ -0,0 +1 @@
+<h1><%= @article.title %></h1>

data/test/dummy/db/migrate/20140818105255_add_published_to_articles.rb

@@ -0,0 +1,5 @@
+class AddPublishedToArticles < ActiveRecord::Migration
+  def change
+    add_column :articles, :published, :boolean
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,13 +11,14 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140811184010) do
+ActiveRecord::Schema.define(version: 20140818105255) do
 
   create_table "articles", force: true do |t|
     t.string   "title"
     t.string   "name"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.boolean  "published"
   end
 
   create_table "news_articles", force: true do |t|