active_scaffold_export_vho 3.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 vhochstein
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,5 @@
+This is my version of the active_scaffold_export plugin.
+
+It works with Rails 2.3 and both rails-2.3 and master branches of ActiveScaffold.
+
+I have renamed the old activescaffoldexport plugin to follow the same pattern as the other ActiveScaffold related plugins.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/active_scaffold_export/version.rb'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "active_scaffold_export_vho"
+  gem.version = ActiveScaffoldExport::Version::STRING
+  gem.homepage = "http://github.com/vhochstein/active_scaffold_export"
+  gem.license = "MIT"
+  gem.summary = %Q{Exporting Records with ActiveScaffold}
+  gem.description = %Q{Exporting Records with ActiveScaffold}
+  gem.email = "activescaffold@googlegroups.com"
+  gem.authors = ["Volker Hochstein"]
+  gem.add_runtime_dependency 'active_scaffold_vho', '~> 3.0'
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_scaffold_export #{ActiveScaffoldExport::Version::STRING}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/frontends/default/stylesheets/export-stylesheet-ie.css

@@ -0,0 +1,6 @@
+/* IE hacks
+   ==================================== */
+.active-scaffold-header div.actions a.export {
+background-image: none;
+filter: progid:DXImageTransform.Microsoft.AlphaImageLoader(src='../images/active_scaffold/default/export.png', sizingMethod='crop');
+}

data/frontends/default/stylesheets/export-stylesheet.css

@@ -0,0 +1,27 @@
+.active-scaffold-header div.actions a.show_export {
+  background-image: url(../../../images/active_scaffold/default/export.png);
+  background-position: 1px 50%;
+  background-repeat: no-repeat;
+  padding-left: 19px;
+}
+.active-scaffold div.show_export-view h3 {
+  font-weight: bold;
+}
+.active-scaffold div.show_export-view div.separator {
+  clear: both;
+  padding: .5em;
+}
+.active-scaffold div.show_export-view div.options div.separator {
+  padding: 0;
+}
+.active-scaffold div.show_export-view div.options div.checkbox-wrapper {
+  margin-bottom: .5em;
+}
+.active-scaffold div.show_export-view div div.checkbox-wrapper {
+  min-width: 20%;
+  margin-bottom: .25em;
+  float: left;
+}
+.active-scaffold div.show_export-view label #delimiter {
+  font-family: monospace;
+}

data/frontends/default/views/_export.csv.erb

@@ -0,0 +1,17 @@
+<%
+  fcsv_options = {
+    :row_sep => "\n",
+    :col_sep => params[:delimiter],
+    :force_quotes => @export_config.force_quotes,
+    :headers => @export_columns.collect { |column| format_export_column_header_name(column) }
+  }
+
+  data = FasterCSV.generate(fcsv_options) do |csv|
+    csv << fcsv_options[:headers] unless params[:skip_header] == 'true'
+    @records.each do |record|
+      csv << @export_columns.collect { |column|
+        get_export_column_value(record, column)
+      }
+    end
+  end
+-%><%= data.html_safe -%>

data/frontends/default/views/_export_form_body.html.erb

@@ -0,0 +1,28 @@
+<% export_config = active_scaffold_config.export %>
+<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) %>
+  </div>
+<% end -%>
+&nbsp;
+</div>
+<div class="separator"></div>
+<h3><%=as_('Options')%></h3>
+<div class="options checkbox-list">
+  <div class="option checkbox-wrapper">
+    <%= content_tag(:label, check_box_tag('skip_header', 1, export_config.default_skip_header) + " #{as_('Omit Header')}".html_safe) %>
+  </div>
+  <div class="option checkbox-wrapper">
+    <%= content_tag(:label, text_field_tag('delimiter', export_config.default_delimiter, :size => 1, :maxlength => 1) + " #{as_('Delimiter')}".html_safe) %>
+  </div>
+  <div class="separator"></div>
+  <div class="option checkbox-wrapper">
+    <%= content_tag(:label, radio_button_tag('full_download', false, !export_config.default_full_download) + " #{as_('This Page')}".html_safe) if export_config.allow_full_download %>
+  </div>
+  <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>
+  &nbsp;
+</div>
+<div class="separator"></div>

data/frontends/default/views/_show_export.html.erb

@@ -0,0 +1,7 @@
+<%= render :partial => "base_form", :locals => {:xhr => false,
+                                                :form_action => :export,
+                                                :url_options => params_for(:action => :export, :format => 'csv'),
+                                                :method => :get,
+                                                :cancel_link => true,
+                                                :headline => as_('Columns to Export'),
+                                                :body_partial => 'export_form_body'} %>

data/frontends/default/views/show_export.html.erb

@@ -0,0 +1,5 @@
+<div class="active-scaffold">
+  <div class="show-export view">
+    <%= render :partial => 'show_export' -%>
+  </div>
+</div>

data/init.rb

@@ -0,0 +1,9 @@
+ACTIVE_SCAFFOLD_EXPORT_INSTALLED = :plugin
+
+require 'active_scaffold_export'
+
+begin
+  ActiveScaffoldAssets.copy_to_public(ActiveScaffoldExport.root)
+rescue
+  raise $! unless Rails.env == 'production'
+end

data/lib/active_scaffold/actions/export.rb

@@ -0,0 +1,91 @@
+module ActiveScaffold::Actions
+  module Export
+    def self.included(base)
+      base.before_filter :export_authorized?, :only => [:export]
+      base.before_filter :init_session_var
+
+      as_export_plugin_path = File.join(ActiveScaffold::Config::Export.plugin_directory, 'frontends', 'default' , 'views')
+      
+      base.add_active_scaffold_path as_export_plugin_path
+    end
+
+    def init_session_var
+      session[:search] = params[:search] if !params[:search].nil? || params[:commit] == as_('Search')
+    end
+
+    # display the customization form or skip directly to export
+    def show_export
+      export_config = active_scaffold_config.export
+      respond_to do |wants|
+        wants.html do
+          render(:partial => 'show_export', :layout => true)
+        end
+        wants.js do
+          render(:partial => 'show_export', :layout => false)
+        end
+      end
+    end
+
+    # if invoked directly, will use default configuration
+    def export
+      export_config = active_scaffold_config.export
+      if params[:export_columns].nil?
+        export_columns = {}
+        export_config.columns.each { |col|
+          export_columns[col.name.to_sym] = 1
+        }
+        options = {
+          :export_columns => export_columns,
+          :full_download => export_config.default_full_download.to_s,
+          :delimiter => export_config.default_delimiter,
+          :skip_header => export_config.default_skip_header.to_s
+        }
+        params.merge!(options)
+      end
+
+      find_items_for_export
+
+      response.headers['Content-Disposition'] = "attachment; filename=#{export_file_name}"
+      render :partial => 'export', :layout => false, :content_type => Mime::CSV, :status => response_status
+    end
+
+    protected
+
+    # The actual algorithm to do the export
+    def find_items_for_export
+      export_config = active_scaffold_config.export
+      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
+
+      find_options = { :sorting => active_scaffold_config.list.user.sorting }
+      params[:search] = session[:search]
+      do_search rescue nil
+      params[:segment_id] = session[:segment_id]
+      do_segment_search rescue nil
+      unless params[:full_download] == 'true'
+        find_options.merge!({
+          :per_page => active_scaffold_config.list.user.per_page,
+          :page => active_scaffold_config.list.user.page
+        })
+      end
+
+      @export_config = export_config
+      @export_columns = export_columns
+      @records = find_page(find_options).items
+    end
+
+    # 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"
+    end
+
+    # The default security delegates to ActiveRecordPermissions.
+    # You may override the method to customize.
+    def export_authorized?
+      authorized_for?(:action => :read)
+    end
+  end
+end

data/lib/active_scaffold/config/export.rb

@@ -0,0 +1,76 @@
+module ActiveScaffold::Config
+  class Export < ActiveScaffold::Config::Form
+    self.crud_type = :read
+
+    def initialize(core_config)
+      @core = core_config
+    end
+
+    # global level configuration
+    # --------------------------
+    # the ActionLink for this action
+    cattr_accessor :link
+    @@link = ActiveScaffold::DataStructures::ActionLink.new('show_export', :label => :export, :type => :collection, :security_method => :export_authorized?)
+
+    # configures where the plugin itself is located. there is no instance version of this.
+    cattr_accessor :plugin_directory
+    @@plugin_directory = File.expand_path(__FILE__).match(%{(^.*)/lib/active_scaffold/config/export.rb})[1]
+
+
+    # instance-level configuration
+    # ----------------------------
+
+    attr_writer :link
+    def link
+      @link ||= if show_form
+        self.class.link.clone
+      else
+        ActiveScaffold::DataStructures::ActionLink.new('export', :label => :export, :type => :collection, :inline => false, :security_method => :export_authorized?)
+      end
+    end
+
+    attr_writer :show_form, :allow_full_download, :force_quotes, :default_full_download, :default_delimiter, :default_skip_header, :default_deselected_columns
+    def show_form
+      self.show_form = @core.export_show_form if @show_form.nil?
+      @show_form
+    end
+    def allow_full_download
+      self.allow_full_download = @core.export_allow_full_download if @allow_full_download.nil?
+      @allow_full_download
+    end
+    def force_quotes
+      self.force_quotes = @core.export_force_quotes if @force_quotes.nil?
+      @force_quotes
+    end
+    def default_full_download
+      self.default_full_download = @core.export_default_full_download if @default_full_download.nil?
+      @default_full_download
+    end
+    def default_delimiter
+      self.default_delimiter = @core.export_default_delimiter if @default_delimiter.nil?
+      @default_delimiter
+    end
+    def default_skip_header
+      self.default_skip_header = @core.export_default_skip_header if @default_skip_header.nil?
+      @default_skip_header
+    end
+    def default_deselected_columns
+      self.default_deselected_columns = [] if @default_deselected_columns.nil?
+      @default_deselected_columns
+    end
+
+    # provides access to the list of columns specifically meant for this action to use
+    def columns
+      self.columns = @core.columns._inheritable unless @columns
+      @columns
+    end
+    def columns=(val)
+      @columns = ActiveScaffold::DataStructures::ActionColumns.new(*val)
+      @columns.action = self
+    end
+
+    def multipart?
+      false
+    end
+  end
+end

data/lib/active_scaffold/helpers/export_helpers.rb

@@ -0,0 +1,76 @@
+module ActiveScaffold
+  module Helpers
+    # Helpers that assist with the rendering of a Export Column
+    module ExportHelpers
+      def self.included(base)
+        base.alias_method_chain :active_scaffold_stylesheets, :export
+        base.alias_method_chain :active_scaffold_ie_stylesheets, :export
+      end
+
+      # Provides stylesheets to include with +stylesheet_link_tag+
+      def active_scaffold_stylesheets_with_export(frontend = :default)
+        active_scaffold_stylesheets_without_export.to_a << ActiveScaffold::Config::Core.asset_path("export-stylesheet.css", frontend)
+      end
+      
+
+      # Provides stylesheets for IE to include with +stylesheet_link_tag+
+      def active_scaffold_ie_stylesheets_with_export(frontend = :default)
+        active_scaffold_ie_stylesheets_without_export.to_a << ActiveScaffold::Config::Core.asset_path("export-stylesheet-ie.css", frontend)
+      end
+
+      ## individual columns can be overridden by defining
+      # a helper method <column_name>_export_column(record)
+      # You can customize the output of all columns by
+      # overriding the following helper methods:
+      # 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)
+        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)
+          else
+            case column.association.macro
+            when :has_one, :belongs_to
+              format_singular_association_export_column(raw_value)
+            when :has_many, :has_and_belongs_to_many
+              format_plural_association_export_column(raw_value)
+            end
+          end
+        end
+      end
+
+      def export_column_override(column)
+        "#{column.name.to_s.gsub('?', '')}_export_column" # parse out any question marks (see issue 227)
+      end
+
+      def export_column_override?(column)
+        respond_to?(export_column_override(column))
+      end
+
+      def format_export_column(raw_value)
+        format_value(raw_value)
+      end
+
+      def format_singular_association_export_column(association_record)
+        format_value(association_record.to_label)
+      end
+
+      def format_plural_association_export_column(association_records)
+        firsts = association_records.first(4).collect { |v| v.to_label }
+        firsts[3] = ' ' if firsts.length == 4
+        format_value(firsts.join(','))
+      end
+
+      ## 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
+      end
+    end
+  end
+end

data/lib/active_scaffold_export/config/core.rb

@@ -0,0 +1,17 @@
+# Need to open the AS module carefully due to Rails 2.3 lazy loading
+ActiveScaffold::Config::Core.class_eval do
+  # For some note obvious reasons, the class variables need to be defined
+  # *before* the cattr !!
+  @@export_show_form = true
+  @@export_allow_full_download = true
+  @@export_default_full_download = true
+  @@export_force_quotes = false
+  @@export_default_skip_header = false
+  @@export_default_delimiter = ','
+  cattr_accessor :export_show_form, :export_allow_full_download,
+      :export_force_quotes, :export_default_full_download,
+      :export_default_delimiter, :export_default_skip_header
+
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:show_export] = :get
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:export] = :get
+end

data/lib/active_scaffold_export/version.rb

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

data/lib/active_scaffold_export.rb

@@ -0,0 +1,39 @@
+ActiveScaffold rescue throw "should have included ActiveScaffold plug in first.  Please make sure that this plug-in comes alphabetically after the ActiveScaffold plug-in"
+
+# Load our overrides
+require "#{File.dirname(__FILE__)}/active_scaffold_export/config/core.rb"
+
+module ActiveScaffoldExport
+  def self.root
+    File.dirname(__FILE__) + "/.."
+  end
+end
+
+module ActiveScaffold
+  module Actions
+    ActiveScaffold.autoload_subdir('actions', self, File.dirname(__FILE__))
+  end
+
+  module Config
+    ActiveScaffold.autoload_subdir('config', self, File.dirname(__FILE__))
+  end
+
+  module Helpers
+    ActiveScaffold.autoload_subdir('helpers', self, File.dirname(__FILE__))
+  end
+end
+
+ActionView::Base.send(:include, ActiveScaffold::Helpers::ExportHelpers)
+
+
+##
+## Run the install assets script, too, just to make sure
+## But at least rescue the action in production
+##
+Rails::Application.initializer("active_scaffold_export.install_assets", :after => "active_scaffold.install_assets") do
+  begin
+    ActiveScaffoldAssets.copy_to_public(ActiveScaffoldExport.root)
+  rescue
+    raise $! unless Rails.env == 'production'
+  end
+end unless defined?(ACTIVE_SCAFFOLD_EXPORT_INSTALLED) && ACTIVE_SCAFFOLD_EXPORT_INSTALLED == :plugin

data/lib/active_scaffold_export_vho.rb

@@ -0,0 +1,2 @@
+ACTIVE_SCAFFOLD_EXPORT_INSTALLED = :gem
+require 'active_scaffold_export'

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: active_scaffold_export_vho
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 0
+  version: 3.0.0
+platform: ruby
+authors: 
+- Volker Hochstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: active_scaffold_vho
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  requirement: *id005
+  type: :runtime
+description: Exporting Records with ActiveScaffold
+email: activescaffold@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+files: 
+- .document
+- LICENSE.txt
+- README
+- Rakefile
+- frontends/default/images/export.png
+- frontends/default/stylesheets/export-stylesheet-ie.css
+- frontends/default/stylesheets/export-stylesheet.css
+- frontends/default/views/_export.csv.erb
+- frontends/default/views/_export_form_body.html.erb
+- frontends/default/views/_show_export.html.erb
+- frontends/default/views/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
+- lib/active_scaffold_export.rb
+- lib/active_scaffold_export/config/core.rb
+- lib/active_scaffold_export/version.rb
+- lib/active_scaffold_export_vho.rb
+has_rdoc: true
+homepage: http://github.com/vhochstein/active_scaffold_export
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Exporting Records with ActiveScaffold
+test_files: []
+