zh_kostev_ext 0.1.4 → 0.1.5

data/lib/controller_extensions/export_to_excel.rb

@@ -0,0 +1,53 @@
+module ControllerExtensions
+  module ExportToExcel
+    def self.included(base)
+      base.class_eval do
+        private
+        #This is method to create excel file with data and send it to user.
+        #
+        # Example:
+        #
+        #   class PermissionSetsController < ApplicationController
+        #     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
+        #
+        # 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")
+        #
+        # 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", :worksheet_name => "super admins")
+        #
+        def export_to_excel_prototype(records, column_names, model_column_names, options)
+          spreadsheet = StringIO.new
+          book = create_spreadsheet_for_export(records, column_names, model_column_names, options)
+          book.write spreadsheet
+          send_data spreadsheet.string, :filename => (options[:file_name].presence || "export_#{Time.now.to_s.underscore}.xls"), :type => "application/vnd.ms-excel"
+        end
+
+
+        #create workbook and write data to it
+        def create_spreadsheet_for_export(records, column_names, model_column_names, options = {})
+          book = Spreadsheet::Workbook.new #create new book for writing
+          sheet = book.create_worksheet :name => (options[:worksheet_name].presence || options[:file_name].presence || 'Excel export') #create new sheet in book
+          sheet.row(0).concat column_names #write first row(column names)
+          records.each_with_index do |record, index|
+            write_record_to_sheet(sheet, record, model_column_names, index + 1) #index+1 - begin from second line(first line is column names)
+          end
+
+          book
+        end
+
+        #write to worksheet one line of data
+        def write_record_to_sheet(sheet, record, model_column_names, row_index)
+          model_column_names.each_with_index do |name, column_index|
+            sheet[row_index, column_index] = record.send(name.underscore.to_sym)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/controller_extensions/general_methods.rb

@@ -2,22 +2,31 @@ module ControllerExtensions
   module GeneralMethods
     def self.included(base)
       base.class_eval do
-        #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.
-        #You can specify DB_SCOPE constant in controller if you need to find model in special scope.
-        #example:
-        #class PermissionSetsController < ApplicationController
-        #  DB_MODEL = :contact
-        #  DB_SCOPE = :sent
-        #    before_filter :find_resource_or_404, :only => [:edit,:show, :destroy, :update]
-        # end  #it will find model as Contact.sent.find_by_id(params[:id])
-        #
-        #
-        #OR
-        #
-        #class PermissionSetsController < ApplicationController
-        #    before_filter :find_resource_or_404, :only => [:edit,:show, :destroy, :update]
-        # end
+        #Load resource or redirect to 404 if can't load resource. Used as before filter.
+        #
+        # Example:
+        #
+        #   class PermissionSetsController < ApplicationController
+        #     before_filter :find_resource_or_404, :only => [:edit,:show, :destroy, :update] #it will find model as PermissionSet.find(params[:id])
+        #
+        # 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_SCOPE and DB_MODEL together
+        #
+        #   class PermissionSetsController < 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])
+        #
+        # Valid Options:
+        #
+        # * <tt>:only/:except</tt> - Passed to the <tt>before_filter</tt> call. Set which actions are verified.
         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

data/lib/zh_kostev_ext.rb

@@ -1,6 +1,8 @@
 require "controller_extensions/general_methods"
+require "controller_extensions/export_to_excel"
 class ActionController::Base
   include ControllerExtensions::GeneralMethods
+  include ControllerExtensions::ExportToExcel
 end
 
 require "ruby_classes_extensions/hash_extensions"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zh_kostev_ext
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2012-10-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +115,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
+- lib/controller_extensions/export_to_excel.rb
 - lib/controller_extensions/general_methods.rb
 - lib/ruby_classes_extensions/hash_extensions.rb
 - lib/zh_kostev_ext.rb
@@ -119,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -797292081
+      hash: -764461171
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: