active_scaffold_export 3.3.0 → 3.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a839bd6f44ec26aa73f8da128adc2678f87f65dc
+  data.tar.gz: 0377be1f4026ebbae123d012b7faa1938fef34f3
+SHA512:
+  metadata.gz: 75e352107ecc0d1fb6e4f80444f56806cc62a3d6a3fb18eb3a5ab68a0fbeac02ce8248595b65c4563e1b3c0995b21e8cfb73d80fb1488265e876541eab65d480
+  data.tar.gz: 15964ca9effd8a6b8fba7d48d86ee7cf9f381be1d486ec65179278872c047bb6aaa065fe979c3003b23bf9518fb5190cf7301e66c46e6f0859b9abd28039bbfb

data/README.md

@@ -0,0 +1,70 @@
+# Active Scaffold Export
+### An [active scaffold](https://github.com/activescaffold/active_scaffold) addon to let it export data in CSV or XLSX format
+
+####How to?
+Easy. First get [active scaffold](https://github.com/activescaffold/active_scaffold) if you haven't yet. 
+Then, add this to your Gemfile:
+```
+gem 'active_scaffold_export'
+```
+if you're using REE or Ruby 1.8.7, you need to add backports gem as well as fastercsv since REE lacks ruby 1.9 streaming features and fastercsv is in core in 1.9
+```
+gem 'backports'
+gem 'fastercsv'
+```
+if you want xlsx format, add:
+```
+gem 'axlsx_rails'
+```
+if that gem is present, XLSX will be used by default. 
+You can change this by adding to active scaffold config:
+```
+conf.export.default_file_format = 'csv' # or 'xlsx' 
+```
+read important notes at the bottom about xlsx.
+
+Remember to bundle install.
+Add to application.css:
+```
+ *= require active_scaffold_export
+```
+
+Now let's add it to controller, inside active_scaffold config block:
+```ruby
+conf.actions.add :export
+# you can filter or sort columns if you want
+conf.export.columns = %w(name last_name phone address) 
+# you can define a default values for the exporting form
+conf.export.default_deselected_columns = %w(phone address)
+conf.export.default_delimiter = ";"
+conf.export.force_quotes = "true"
+```
+And enjoy happy exporting :)
+
+### Security
+It's controlled the same way as Active Scaffold. The extra actions added are:
+* **:show_export** for the options form
+* **:export** for retrieving the data
+Tested with AS internal security and [Cancan](https://github.com/ryanb/cancan)
+
+### Translations 
+Go in the same active scaffold scope:
+```yaml
+active_scaffold:
+    columns_for_export: Columnas para exportar
+    export_options: Opciones de exportación
+    this_page: esta página
+    all_pages: todas las páginas 
+```
+
+### XLSX support 
+This support depends on axlsx_rails and axlsx of course. 
+header styling override will be added soon. 
+NOTE: There's NO streaming support for xlsx format. Only CSV. So if your data is huge, set default_file_format to 'csv' instead.
+Streaming in xlsx will never be supported since the entire file needs to be serialized and zipped to be a valid OOXML file. 
+So, rather than streaming, background jobs will be the most likely future approach.  
+[Read axlsx issue about this](https://github.com/randym/axlsx/issues/169#issuecomment-13252750)
+
+This gem has not been tested in other rubies than REE and Ruby 1.9. 
+For contact, help, support, comments, please use Active Scaffold official mailing list  activescaffold@googlegroups.com
+

data/active_scaffold_export.gemspec

@@ -5,21 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = "active_scaffold_export"
-  s.version = "3.3.0"
+  s.version = "3.3.2"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Volker Hochstein", "Sergio Cambra", "Hernan Astudillo"]
-  s.date = "2012-12-13"
   s.description = "Exporting Records with ActiveScaffold"
   s.email = "activescaffold@googlegroups.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README"
+    "README.md"
   ]
   s.files = [
     ".document",
     "LICENSE.txt",
-    "README",
+    "README.md",
     "Rakefile",
     "init.rb",
     "active_scaffold_export.gemspec",
@@ -41,34 +39,6 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/naaano/active_scaffold_export"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "Ability to export records to CSV with ActiveScaffold"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<active_scaffold>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_runtime_dependency 'active_scaffold', '>= 3.3.0.rc'
-    else
-      s.add_dependency(%q<active_scaffold>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_runtime_dependency 'active_scaffold', '>= 3.3.0.rc'
-    end
-  else
-    s.add_dependency(%q<active_scaffold>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_runtime_dependency 'active_scaffold', '>= 3.3.0.rc'
-  end
+  s.summary = "Ability to export records to CSV/XLSX with ActiveScaffold"
+  s.add_runtime_dependency 'active_scaffold', '>= 3.3.0.rc'
 end
-

data/app/views/active_scaffold_overrides/_export_form_body.html.erb

@@ -1,9 +1,14 @@
 <% export_config = active_scaffold_config.export %>
 <h3><%=as_(:columns_for_export)%></h3>
+<% if ActiveScaffold.js_framework == :jquery %>
+<%= link_to as_(:select_all), '#', onclick: 'jQuery(".columnCheckbox").prop("checked", true);', class: 'active-scaffold-footer' %>
+ |
+<%= link_to as_(:select_none), '#', onclick: 'jQuery(".columnCheckbox").prop("checked", false);', class: 'active-scaffold-footer' %>
+<% end %>
 <div class="columns checkbox-list">
 <% export_config.columns.each do |column| -%>
   <div class="column checkbox-wrapper">
-    <%= content_tag(:label, check_box_tag("export_columns[#{column.name}]", 1, !export_config.default_deselected_columns.include?(column.name)) + "&nbsp;#{column.label}".html_safe) %>
+    <%= content_tag(:label, check_box_tag("export_columns[#{column.name}]", 1, !export_config.default_deselected_columns.include?(column.name), :class => 'columnCheckbox') + "&nbsp;#{column.label}".html_safe) %>
   </div>
 <% end -%>
 &nbsp;
@@ -24,6 +29,13 @@
   <div class="option checkbox-wrapper">
     <%= content_tag(:label, radio_button_tag('full_download', true, export_config.default_full_download) + " #{as_(:all_pages)}".html_safe) if export_config.allow_full_download %>
   </div>
+  <div class="separator"></div>
+  <div class="option checkbox-wrapper">
+    <%= content_tag(:label, radio_button_tag('format', :xlsx, export_config.default_file_format.to_sym == :xlsx) + ' XLSX') %>
+  </div>
+  <div class="option checkbox-wrapper">
+    <%= content_tag(:label, radio_button_tag('format', :csv, export_config.default_file_format.to_sym == :csv) + ' CSV') %>
+  </div>
   &nbsp;
 </div>
-<div class="separator"></div>
+<div class="separator"></div>

data/app/views/active_scaffold_overrides/_show_export.html.erb

@@ -1,6 +1,6 @@
 <%= render :partial => "base_form", :locals => {:xhr => false,
                                                 :form_action => :export,
-                                                :url_options => params_for(:action => :export, :format => 'csv'),
+                                                :url_options => params_for(:action => :export),
                                                 :method => :post,
                                                 :cancel_link => true,
                                                 :headline => as_(:export),

data/lib/active_scaffold/actions/export.rb

@@ -12,7 +12,7 @@ module ActiveScaffold::Actions
 
     # display the customization form or skip directly to export
     def show_export
-      export_config = active_scaffold_config.export
+      @export_config = active_scaffold_config.export
       respond_to do |wants|
         wants.html do
           render(:partial => 'show_export', :layout => true)
@@ -40,29 +40,59 @@ module ActiveScaffold::Actions
         params.merge!(options)
       end
 
+      @export_columns = export_config.columns.reject { |col| params[:export_columns][col.name.to_sym].nil? }
+      includes_for_export_columns = @export_columns.collect{ |col| col.includes }.flatten.uniq.compact
+      self.active_scaffold_includes.concat includes_for_export_columns
+      @export_config = export_config
+      # Make sure active_scaffold's find_page is dealing with the same list of
+      # columns. Prevents an invalid SQL query when exporting after filtering
+      # with field_search against a relation column, and that relation column is
+      # not included in the set of export columns.
+      @list_columns = @export_columns
+
       # this is required if you want this to work with IE
       if request.env['HTTP_USER_AGENT'] =~ /msie/i
         response.headers['Pragma'] = "public"
         response.headers['Cache-Control'] = "no-cache, must-revalidate, post-check=0, pre-check=0"
         response.headers['Expires'] = "0"
       end
-
-      response.headers['Content-type'] = 'text/csv'
       response.headers['Content-Disposition'] = "attachment; filename=#{export_file_name}"
 
-      @export_columns = export_config.columns.reject { |col| params[:export_columns][col.name.to_sym].nil? }
-      includes_for_export_columns = @export_columns.collect{ |col| col.includes }.flatten.uniq.compact
-      self.active_scaffold_includes.concat includes_for_export_columns
-      @export_config = export_config
+      unless defined? Mime::XLSX
+        Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+      end
 
-      # start streaming output
-      self.response_body = Enumerator.new do |y|
-        find_items_for_export do |records|
-          @records = records
-          str = render_to_string :partial => 'export', :layout => false, :formats => [:csv]
-          y << str
-          params[:skip_header] = 'true' # skip header on the next run
+      respond_to do |format|
+        format.csv do
+          response.headers['Content-type'] = 'text/csv'
+          # start streaming output
+          self.response_body = Enumerator.new do |y|
+            find_items_for_export do |records|
+              @records = records
+              str = render_to_string :partial => 'export', :layout => false, :formats => [:csv]
+              y << str
+              params[:skip_header] = 'true' # skip header on the next run
+            end
+          end
+        end
+        format.xlsx do 
+          response.headers['Content-type'] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+          p = Axlsx::Package.new
+          header = p.workbook.styles.add_style sz: 11, b: true,:bg_color => "69B5EF", :fg_color => "FF", alignment: { horizontal: :center }
+          p.workbook.add_worksheet(name: active_scaffold_config.label) do |sheet|
+            sheet.add_row(@export_columns.collect { |column| view_context.format_export_column_header_name(column) }, style: header) unless params[:skip_header]
+            find_items_for_export do |records|
+              records.each do |record|
+                sheet.add_row @export_columns.collect{|column| view_context.get_export_column_value(record, column, false)}
+              end
+            end
+          end
+          stream = p.to_stream # when adding rows to sheet, they won't pass to this stream if declared before. axlsx issue?
+          self.response_body = Enumerator.new do |y|
+            y << stream.read 
+          end
         end
+
       end
     end
 
@@ -100,7 +130,19 @@ module ActiveScaffold::Actions
     # The default name of the downloaded file.
     # You may override the method to specify your own file name generation.
     def export_file_name
-      "#{self.controller_name}.csv"
+      filename = self.controller_name
+
+      if params[:format]
+        if params[:format].to_sym == :xlsx
+          filename << '.xlsx'
+        elsif params[:format].to_sym == :csv
+          filename << '.csv'
+        end
+      else
+        filename << ".#{active_scaffold_config.export.default_file_format}"
+      end
+
+      return filename
     end
 
     # The default security delegates to ActiveRecordPermissions.

data/lib/active_scaffold/config/export.rb

@@ -29,7 +29,7 @@ module ActiveScaffold::Config
       end
     end
 
-    attr_writer :show_form, :allow_full_download, :force_quotes, :default_full_download, :default_delimiter, :default_skip_header, :default_deselected_columns
+    attr_writer :show_form, :allow_full_download, :force_quotes, :default_full_download, :default_delimiter, :default_skip_header, :default_deselected_columns, :default_file_format
     def show_form
       self.show_form = @core.export_show_form if @show_form.nil?
       @show_form
@@ -58,6 +58,16 @@ module ActiveScaffold::Config
       self.default_deselected_columns = [] if @default_deselected_columns.nil?
       @default_deselected_columns
     end
+    def default_file_format
+      if @core.export_xlsx_avaliable
+        self.default_file_format = @default_file_format || 'xlsx'
+      else
+        self.default_file_format = @default_file_format || @core.export_default_file_format
+      end
+    end
+    def xlsx_present?
+      Gem::Specification::find_all_by_name('axlsx_rails').any?
+    end
 
     # provides access to the list of columns specifically meant for this action to use
     def columns

data/lib/active_scaffold/helpers/export_helpers.rb

@@ -9,14 +9,14 @@ module ActiveScaffold
       # format_export_column(raw_value)
       # format_singular_association_export_column(association_record)
       # format_plural_association_export_column(association_records)
-      def get_export_column_value(record, column)
+      def get_export_column_value(record, column, csv = true)
         if export_column_override? column
           send(export_column_override(column), record)
         else
           raw_value = record.send(column.name)
 
           if column.association.nil? or column_empty?(raw_value)
-            format_export_column(raw_value)
+            csv ? format_export_column(raw_value) : raw_value # xlsx needs original data type
           else
             case column.association.macro
             when :has_one, :belongs_to
@@ -37,7 +37,19 @@ module ActiveScaffold
       end
 
       def format_export_column(raw_value)
-        format_value(raw_value)
+        format_value_for_csv(raw_value) 
+      end
+
+      def format_value_for_csv(column_value)
+        value = if column_empty?(column_value)
+          active_scaffold_config.list.empty_field_text
+        elsif column_value.is_a?(Time) || column_value.is_a?(Date)
+          l(column_value, :format => :default)
+        elsif [FalseClass, TrueClass].include?(column_value.class)
+          as_(column_value.to_s.to_sym)
+        else
+          column_value.to_s
+        end
       end
 
       def format_singular_association_export_column(association_record)
@@ -53,8 +65,9 @@ module ActiveScaffold
       ## This helper can be overridden to change the way that the headers
       # are formatted. For instance, you might want column.name.to_s.humanize
       def format_export_column_header_name(column)
-        column.name.to_s
+        column.label
       end
+
     end
   end
 end

data/lib/active_scaffold_export/config/core.rb

@@ -8,10 +8,12 @@ ActiveScaffold::Config::Core.class_eval do
   self.send :class_variable_set, :@@export_force_quotes, false
   self.send :class_variable_set, :@@export_default_skip_header, false
   self.send :class_variable_set, :@@export_default_delimiter, ','
+  self.send :class_variable_set, :@@export_default_file_format, Gem::Specification::find_all_by_name('axlsx_rails').any? ? 'xlsx' : 'csv'
   
   cattr_accessor :export_show_form, :export_allow_full_download,
       :export_force_quotes, :export_default_full_download,
-      :export_default_delimiter, :export_default_skip_header
+      :export_default_delimiter, :export_default_skip_header, 
+      :export_default_file_format, :export_xlsx_avaliable
 
   ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:show_export] = :get
   ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:export] = :post

data/lib/active_scaffold_export/version.rb

@@ -1,8 +1,8 @@
 module ActiveScaffoldExport
   module Version
     MAJOR = 3
-    MINOR = 1
-    PATCH = 1
+    MINOR = 3
+    PATCH = 2
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold_export
 version: !ruby/object:Gem::Version
-  version: 3.3.0
-  prerelease: 
+  version: 3.3.2
 platform: ruby
 authors:
 - Volker Hochstein
@@ -11,102 +10,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_scaffold
   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
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.4
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: active_scaffold
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0.rc
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0.rc
 description: Exporting Records with ActiveScaffold
@@ -115,13 +32,12 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README
+- README.md
 files:
-- .document
+- ".document"
 - LICENSE.txt
-- README
+- README.md
 - Rakefile
-- init.rb
 - active_scaffold_export.gemspec
 - app/assets/images/export.png
 - app/assets/stylesheets/active_scaffold_export.css.erb
@@ -130,6 +46,7 @@ files:
 - app/views/active_scaffold_overrides/_export_form_body.html.erb
 - app/views/active_scaffold_overrides/_show_export.html.erb
 - app/views/active_scaffold_overrides/show_export.html.erb
+- init.rb
 - lib/active_scaffold/actions/export.rb
 - lib/active_scaffold/config/export.rb
 - lib/active_scaffold/helpers/export_helpers.rb
@@ -140,26 +57,25 @@ files:
 homepage: http://github.com/naaano/active_scaffold_export
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: Ability to export records to CSV with ActiveScaffold
+specification_version: 4
+summary: Ability to export records to CSV/XLSX with ActiveScaffold
 test_files: []

data/README

@@ -1,14 +0,0 @@
-This is active_scaffold_export plugin, forked from Volker Hochstein. 
-
-This version works for official ActiveScaffold gem/plugin (https://github.com/activescaffold/active_scaffold)
-
-It works with Rails 3.1 master branch of ActiveScaffold.
-
-For older versions, please refer to https://github.com/vhochstein/active_scaffold_export
-
-gem 'active_scaffold_export'
-or
-gem 'active_scaffold_export', :git => 'git://github.com/naaano/active_scaffold_export.git'
-
-In addition you have to add folowing line to your application.css file:
- *= require active_scaffold_export