zh_kostev_ext 0.1.16 → 1.0.0

data/README.rdoc

@@ -1,6 +1,89 @@
-= zh_kostev_ext
+== ZhKostevExt - some usefull method container
+
+== Installation
+
+Add it to your Gemfile:
+
+ gem "zh_kostev_ext"
+
+Run the following command to install it:
+
+ bundle install
+
+== Usage
+
+<b>ZhKostevExt</b> add some methods. Here is list of this methods:
+
+== In ActionController::Base
+
+===== find_resource_or_404 #Load resource or redirect to 404 if can't load resource. Used as before filter.
+You can specify DB_MODEL constant in controller if controller name doesn't connects with model which it used.
+   DB_MODEL = :contact
+You can specify DB_SCOPE constant in controller if you need to find model in special scope.
+    DB_SCOPE = :sent
+You can specify DB_ID_PARAM constant in controller if you pass to controller not id, but smth else.
+    DB_ID_PARAM = :contact_id
+You can specify DB_SCOPE and DB_MODEL and DB_ID_PARAM together
+   class ContactsController < ApplicationController
+     DB_MODEL = :contact
+     DB_SCOPE = :sent
+     DB_ID_PARAM = :contact_id
+     before_filter :find_resource_or_404, :only => [:edit,:show, :destroy, :update] #it will find model as Contact.sent.find(params[:contact_id])
+
+=====  store_location #stores request path if request is get and not ajax and controller is not session_controller
+Example
+  after_filter :store_location
+
+=====  redirect_back_or_default #redirects to back. !IMPORTANT to use this method you should add after_filter to your application_controller(after_filter :store_location)
+You can specify REDIRECT_DEFAULT_PATH constant in ApplicationController to setup default redirect path(by default REDIRECT_DEFAULT_PATH='/')
+You can also pass params to redirect to method. Example
+ redirect_back_or_default :test_param => "test"
+
+=====  add_params_to_url #add params to url. Prevent situation with identical param name
+Example:
+ add_params_to_url('localhost:3000?test=3', {:test => 5, :asd => 2} #result will be  'localhost:3000?test=5&asd=2'
+
+===== Gem add ability to set default params(override default url_for method).
+Example if you set in HomeController:
+ before_filter { @hash_of_additional_params = {:test => '123'} } #this will add test param to all urls in home views
+'auctions_path' return '/auctions' by default, but after you set example before filter  
+'auctions_path' will return '/auctions?test=123'
+
+== In ExportToExcel module
+Nowadays export to excel files is common task. ExportToExcel module provide export_to_excel_prototype method.
+It uses gem speadsheet in order to export to excel. 
+First you should include this module in your controller
+ include ControllerExtensions::ExportToExcel
+Then use export_to_excel_prototype method. It will create excel file with data and send it to user. See example below:
+ class PermissionSetsController < ApplicationController
+   # ["First Name", "Last Name"] names of the columns in excel
+   # %w(first_name last_name) mthods, which will be called on user to set values in columns
+   def export_to_excel
+     records = User.where(:super_admin => true).all #find record to export
+     export_to_excel_prototype(records, ["First Name", "Last Name"], %w(first_name last_name))
+   end
+ end
+ 
+You can specify file_name to provide name of excel file
+
+  export_to_excel_prototype(records, ["First Name", "Last Name"], %w(first_name last_name), :file_name => "Super Admin excel export.xls")
+
+You can specify worksheet_name to provide name of worksheet in excel file
+
+  export_to_excel_prototype(records, ["First Name", "Last Name"], %w(first_name last_name), :file_name => "Super Admin excel export.xls", :worksheet_name => "super admins")
+
+== In Hash class
+
+===== humanized #This hash return humanized value of key(except moments when key has set another value)
+Example
+ a = Hash.humanized
+ a[:vladimir] = 'Vlad'
+ 
+ a[:misha] will return 'Misha'
+ a[:vladimir] will return 'Vlad'(because this value set manually)
+
+
 
-Description goes here.
 
 == Contributing to zh_kostev_ext
  
@@ -16,4 +99,3 @@ Description goes here.
 
 Copyright (c) 2012 zh.kostev. See LICENSE.txt for
 further details.
-

data/lib/controller_extensions/export_to_excel.rb

@@ -9,9 +9,11 @@ module ControllerExtensions
         # Example:
         #
         #   class PermissionSetsController < ApplicationController
+        #     include ControllerExtensions::ExportToExcel
+        #
         #     def export_to_excel
         #       records = User.where(:super_admin => true).all #find record to export
-        #       export_to_excel_prototype(records, ["First Name", "Last Name"], %w(first_name, last_name))
+        #       export_to_excel_prototype(records, ["First Name", "Last Name"], %w(first_name last_name))
         #     end
         #   end
         #

data/lib/controller_extensions/general_methods.rb

@@ -17,13 +17,17 @@ module ControllerExtensions
         # You can specify DB_SCOPE constant in controller if you need to find model in special scope.
         #
         #    DB_SCOPE = :sent
+        # You can specify DB_ID_PARAM constant in controller if you pass to controller not id, but smth else.
+        #
+        #    DB_ID_PARAM = :contact_id
         #
         # You can specify DB_SCOPE and DB_MODEL together
         #
-        #   class PermissionSetsController < ApplicationController
+        #   class ContactsController < ApplicationController
         #     DB_MODEL = :contact
         #     DB_SCOPE = :sent
-        #     before_filter :find_resource_or_404, :only => [:edit,:show, :destroy, :update] #it will find model as Contact.sent.find(params[:id])
+        #     DB_ID_PARAM = :contact_id
+        #     before_filter :find_resource_or_404, :only => [:edit,:show, :destroy, :update] #it will find model as Contact.sent.find(params[:contact_id])
         #
         # Valid Options:
         #
@@ -31,11 +35,9 @@ module ControllerExtensions
         def find_resource_or_404
           model_name = defined?(self.class::DB_MODEL) ? self.class::DB_MODEL : controller_name.singularize
           model_to_find = defined?(self.class::DB_SCOPE) ? model_name.to_s.classify.constantize.send(self.class::DB_SCOPE) : model_name.to_s.classify.constantize
-          begin
-            instance_variable_set("@#{model_name.to_s.underscore}", model_to_find.find(params[:id]))
-          rescue
-            redirect_to '/404'
-          end
+          id_from_param = defined?(self.class::DB_ID_PARAM) ? params[self.class::DB_ID_PARAM.to_sym] : params[:id]
+
+          instance_variable_set("@#{model_name.to_s.underscore}", model_to_find.find(id_from_param))
         end
 
         #redirects to back.
@@ -66,14 +68,15 @@ module ControllerExtensions
         #   add_params_to_url('localhost:3000?test=3', {:test => 5, :asd => 2} #result will be  'localhost:3000?test=5&asd=2'
         def add_params_to_url(url, options)
           main_url, main_params = url.split('?')
-          if main_params
+          options = {} if options.nil?
+          if main_params && main_params.split('&')
             main_params = Hash[main_params.split('&').map { |el| el.split("=") }]
             main_params = main_params.symbolize_keys
             options = options.symbolize_keys
             options = main_params.merge(options)
           end
 
-          main_url + "#{'?' unless options.blank?}"+options.map { |key, value| "#{key}=#{value}" }.join("&")
+          main_url + "#{'?' unless options.blank?}" + options.map { |key, value| "#{key}=#{value}" }.join("&")
         end
       end
     end

data/lib/zh_kostev_ext.rb

@@ -4,7 +4,6 @@ require "controller_extensions/url_ext"
 
 class ActionController::Base
   include ControllerExtensions::GeneralMethods
-  include ControllerExtensions::ExportToExcel
   include ControllerExtensions::UrlExt
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zh_kostev_ext
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2013-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spreadsheet
@@ -123,7 +123,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: GEM IN DEVELOPMENT MODE
+description: ! "ZhKostevExt add some methods. It add some methods to ActionController::Base
+  and Hash class.\n      Gem contains export to excel module to make export easier.
+  See readme https://github.com/ZhKostev/zh_kostev_ext"
 email: zh.kostev@gmail.com
 executables: []
 extensions: []
@@ -153,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -818128301
+      hash: 4217705574523471923
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,8 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: GEM IN DEVELOPMENT MODE
+summary: Some usefull method container
 test_files: []