restful_controller 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96495291f7c6fc588ba0ab6b78abbd2f4bb770d9
-  data.tar.gz: 29039ed3b70521b5300936d3f315416d97cb9263
+  metadata.gz: 8c635006c6bd149411f94320dea9d3ec324e935d
+  data.tar.gz: 2987656f85763c77dbece18e5d7ed263d10fdc81
 SHA512:
-  metadata.gz: 17227ee0aa864e192759081eb36a00e3e874bfd7b46736a90a9c3a9faf41fef4e6f491423bc6bfd972bdb43e082121def309d670b98aeac605cd4a918d156a72
-  data.tar.gz: 089528b0ea4dd812e6d89d50dfa24603cb0216821605ccf9ba13da65ec599de698d61d67d86e6013501e0a4ce97ea0e48fa384005e92568b000faf702e360baf
+  metadata.gz: 7e5b7b1a47b8a8d009baebfc3039268b0df25e8414b786381f081d3923c2606e11ce7217f3a54d8efe4d01c37d4e42cd2d92cf859362be009c7ab617083c2953
+  data.tar.gz: 32ec1f7af9df76e53e9f60b572fe309d13edaad386e4cdf504db16edd7d617c90870ce51ce2fa138cb29adc8e41e7397bb5cebd331b881c6d06eed77ea4eb543

data/README.rdoc

@@ -27,6 +27,7 @@ This macro accepts 2 params:
 
 === Params
 * model: A requires parameter which is a symbol of the model name.
+* route_prefix: A prefix string to be used with controller's url helper.
 * actions: An array of actions that a controller should implement, if none is passed then all seven REST actions are defined.
 
 === Examples
@@ -44,6 +45,19 @@ This definition will create the seven REST actions for Document model,
 this setup a single object instance variable @document and a collection
 variable @documents.
 
+Route prefix:
+
+  class DocumentsController < ApplicationController
+    include Restful::Base
+    respond_to :html
+
+    restful model: :document, route_prefix: 'admin'
+  end
+
+With *route_prefix* param every URL helper method in our controller will have the defined prefix.
+
+`edit_resource_path` helper method will call internally `admin_edit_resource_path`.
+
 Listed actions variation:
 
 The last parameter *actions* allows you to list in an array the actions

data/lib/restful/base.rb

@@ -44,43 +44,52 @@ module Restful
       ##
       # Generic route path helper method to edit a model.
       def edit_resource_path(object)
-        self.send "edit_#{class_name.model_name.singular_route_key}_path",
+        self.send route_prefix_to_method_name("edit_#{class_name.model_name.singular_route_key}_path"),
           object
       end
 
       ##
       # Generic route url helper method to edit a model.
       def edit_resource_url(object)
-        self.send "edit_#{class_name.model_name.singular_route_key}_url",
+        self.send route_prefix_to_method_name("edit_#{class_name.model_name.singular_route_key}_url"),
           object
       end
 
       ##
       # Generic route path helper method for new model.
       def new_resource_path
-        self.send "new_#{class_name.model_name.singular_route_key}_path"
+        self.send route_prefix_to_method_name("new_#{class_name.model_name.singular_route_key}_path")
       end
 
       ##
       # Generic route url helper method for new model.
       def new_resource_url
-        self.send "new_#{class_name.model_name.singular_route_key}_url"
+        self.send route_prefix_to_method_name("new_#{class_name.model_name.singular_route_key}_url")
       end
 
       ##
       # This is a helper method to get the object collection path.
       def collection_path
-        self.send "#{class_name.model_name.route_key}_path"
+        self.send route_prefix_to_method_name("#{class_name.model_name.route_key}_path")
       end
 
       ##
       # This is a helper method to get the object collection url.
       def collection_url
-        self.send "#{class_name.model_name.route_key}_url"
+        self.send route_prefix_to_method_name("#{class_name.model_name.route_key}_url")
       end
 
       protected
       ##
+      # Return a url helper method name with additional route prefix if set.
+      # If route_prefix param is set to `admin` then the method name will be:
+      #
+      #   edit_resource_path => admin_edit_resource_path
+      #
+      def route_prefix_to_method_name(method)
+        "#{route_prefix + '_' if route_prefix}#{method}"
+      end
+      ##
       # Return the instance variable name for a single object based on the model
       # name defined in the restful macro, example:
       #
@@ -243,7 +252,9 @@ module Restful
       # This macro accepts 3 params:
       #
       # ==== Params
-      # * model: A requires parameter which is a symbol of the model name.
+      # * model: A required parameter which is a symbol of the model name.
+      # * route_prefix: A prefix string to be used with controller's url
+      # helper.
       # * actions: An array of actions that a controller should implement, if
       # none is passed then all seven REST actions are defined.
       #
@@ -262,6 +273,21 @@ module Restful
       # this setup a single object instance variable @document and a collection
       # variable @documents.
       #
+      # Route prefix:
+      #
+      #   class DocumentsController < ApplicationController
+      #     include Restful::Base
+      #     respond_to :html
+      #
+      #     restful model: :document, route_prefix: 'admin'
+      #   end
+      #
+      # With *route_prefix* param every URL helper method in our controller
+      # will have the defined prefix.
+      #
+      # `edit_resource_path` helper method will call internally
+      # `admin_edit_resource_path`.
+      #
       # Listed actions variation:
       #
       # The last parameter *actions* allows you to list in an array the actions
@@ -304,12 +330,13 @@ module Restful
       # include it in your controllers and list the formats do you wish your
       # controller to respond.
       #
-      def restful(model: nil, actions: :all)
-        self.class_attribute :model_name, :class_name,
+      def restful(model: nil, route_prefix: nil, actions: :all)
+        self.class_attribute :model_name, :class_name, :route_prefix,
           instance_writer: false
 
         self.model_name = model
         self.class_name = class_from_name
+        self.route_prefix = route_prefix
 
         include InstanceMethods
         include Restful::Actions

data/lib/restful/version.rb

@@ -3,5 +3,5 @@
 module Restful
   ##
   # Sets the library version
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/test/dummy/app/controllers/admin/prefix_controller.rb

@@ -0,0 +1,4 @@
+class Admin::PrefixController < BaseController
+
+  restful model: :document, route_prefix: 'admin'
+end

data/test/dummy/config/routes.rb

@@ -4,59 +4,16 @@ Dummy::Application.routes.draw do
   resources :custom_notices, only: [:create, :update]
   resources :blocks, only: [:create, :update]
 
-  root 'home#index'
-  # The priority is based upon order of creation: first created -> highest priority.
-  # See how all your routes lay out with "rake routes".
-
-  # You can have the root of your site routed with "root"
-  # root 'welcome#index'
-
-  # Example of regular route:
-  #   get 'products/:id' => 'catalog#view'
-
-  # Example of named route that can be invoked with purchase_url(id: product.id)
-  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
+  namespace :admin do
+    get '/new' => 'prefix#new', as: :new_document
+    get '/:id' => 'prefix#show', as: :document
 
-  # Example resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
+    get '/:id/edit' => 'prefix#edit', as: :edit_document
 
-  # Example resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
+    get '/' => 'prefix#index', as: :documents
+    post '/' => 'prefix#create'
+    put '/' => 'prefix#update'
+  end
 
-  # Example resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Example resource route with more complex sub-resources:
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', on: :collection
-  #     end
-  #   end
-
-  # Example resource route with concerns:
-  #   concern :toggleable do
-  #     post 'toggle'
-  #   end
-  #   resources :posts, concerns: :toggleable
-  #   resources :photos, concerns: :toggleable
-
-  # Example resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
+  root 'home#index'
 end