active-list 4.0.0

data/lib/active-list/compass/stylesheets/active-list/_theme.scss

@@ -0,0 +1,161 @@
+// Default style for ActiveList
+@import "compass/css3";
+@import "compass/typography/text/replacement";
+
+// Because Compass sprites do not seems to work well in gems
+@mixin active-list-sprite($name, $size: 16px) {
+  background-image: image-url("active-list.png");
+  background-repeat: no-repeat;
+  height: $size;
+  width: $size;
+  $i: 0;
+  @each $icon in menu check columns export pages first-page previous-page previous-line next-line next-page last-page sort sort-down sort-up true false { 
+    @if $icon == $name { 
+      background-position: (-$i * $size) 0;
+    }
+    $i: $i + 1;
+  }
+}
+
+
+@mixin active-list-theme($theme-color: #777777) { 
+  $default-border-color: mix($theme-color, #FFF, 30%);
+  table.list { 
+    border-collapse: collapse;
+    width: 100%;
+    border: 1px solid $default-border-color;
+    z-index: 2;
+    @include box-shadow(0 0 7px rgba(0, 0, 0, 0.15));
+    thead { 
+      th { 
+        border: 1px solid $default-border-color;
+        padding: 2px 3px;
+        @include background($theme-color linear-gradient(top, rgba(255, 255, 255, 0.9), rgba(255, 255, 255, 0.8)));
+        &[data-list-column-sort] { 
+          .icon { 
+            @include active-list-sprite(sort); 
+            @include inline-block;
+            margin: 0 2px;
+          }
+          &.sor[data-list-column-sort="desc"] .icon { 
+            @include active-list-sprite(sort-down); }
+          &.sor[data-list-column-sort="asc"] .icon { 
+            @include active-list-sprite(sort-up); }
+        }
+        html[dir="ltr"] & { text-align: left; }
+        html[dir="rtl"] & { text-align: right; }
+        &.spe { 
+          width: 16px;
+          height: 16px;
+          .list-menu { 
+            position: relative;
+            background: none;
+            .list-menu-start { 
+              padding: 2px;
+              width: 16px;
+              height: 16px;
+              .icon { @include active-list-sprite(menu); }
+              .text { display: none; }
+            }
+            &:hover {
+              .list-menu-start { 
+                background-color: white; 
+                z-index:5000; 
+              }
+            }
+            ul { 
+              border: 1px solid $default-border-color;
+              background: #FFF;
+              @include box-shadow(0 0 5px rgba(0, 0, 0, 0.3));
+              li { 
+                $menu-width: 290px;
+                width: $menu-width; 
+                ul { 
+                  html[dir="ltr"] & { right: $menu-width; }
+                  html[dir="rtl"] & { left: $menu-width; }
+                }
+              }
+            }
+            a, li { 
+              display: block;
+              padding: 2px;
+              .icon {
+                @include inline-block;
+                height:16px;
+                width: 16px;
+                html[dir="ltr"] & { margin-right:  4px; }
+                html[dir="rtl"] & { margin-left: 4px; }
+              }
+              &.pages     .icon { @include active-list-sprite(pages); }
+              &.export    .icon { @include active-list-sprite(export); }
+              &.check     .icon { @include active-list-sprite(check); }
+              &.columns   .icon { @include active-list-sprite(columns); }
+              &.checked   .icon { @include active-list-sprite(true); }
+              &.unchecked .icon { @include active-list-sprite(false); }
+            }
+            a:hover, li:hover { 
+              text-decoration: none;
+              background: mix($theme-color, #FFF, 10%);
+            }
+          }
+        }
+      }
+    }
+    tbody { 
+      tr {
+        td { 
+          padding: 2px 3px;
+          border-top: 1px solid mix($theme-color, #FFF, 10%);
+          border-bottom: none;
+          border-left: none;
+          border-right: none;
+          &.chk,&.act, &.dld, &.bln, &.dat, &.web  { text-align:center }
+          &.dec, &.flt, &.int { 
+            html[dir="ltr"] & { text-align: right; }
+            html[dir="rtl"] & { text-align: left; }
+          }
+          &.country { white-space: nowrap; }
+          &.color { color: white; text-shadow: 0 0 2px #000; width: 6ex; text-align: center; }
+        }
+        &:first-child td { 
+          border-top: none;
+        }
+      }
+    }
+
+    @include list-colors(#FFFFFF);
+  }
+  .extras { 
+    z-index: 0;
+    @include background(transparentize(mix($theme-color, #FFF, 40%), 0.7));
+    .pagination { 
+       html[dir="ltr"] & { text-align: left; }
+       html[dir="rtl"] & { text-align: right; }
+       & > * { 
+         margin: 0 2px;
+       }
+       .first-page, .previous-page, .next-page, .last-page {
+         @include inline-block;
+         @include squish-text;
+       }
+        html[dir="rtl"] & .last-page, html[dir="ltr"] & .first-page {
+          @include active-list-sprite(first-page);
+        }
+        html[dir="rtl"] & .first-page, html[dir="ltr"] & .last-page {
+          @include active-list-sprite(last-page);
+        }
+        html[dir="rtl"] & .next-page, html[dir="ltr"] & .previous-page {
+          @include active-list-sprite(previous-page);
+        }
+        html[dir="rtl"] & .previous-page, html[dir="ltr"] & .next-page {
+          @include active-list-sprite(next-page);
+        }
+       .separator { 
+         @include inline-block;
+         width: 2px;
+         height: 1.2em;
+         background: transparentize($theme-color, 0.7);
+       }
+    }
+  }
+}

data/lib/active-list/definition.rb

@@ -0,0 +1,103 @@
+module ActiveList
+
+  class Table
+    attr_reader :name, :model, :options, :id, :columns, :parameters
+    
+    @@current_id = 0
+
+    def initialize(name, model = nil, options = {})
+      @name    = name
+      @model   = model || name.to_s.classify.constantize
+      @options = options
+      @paginate = !(@options[:pagination]==:none || @options[:paginate].is_a?(FalseClass))
+      @options[:renderer] ||= :simple_renderer
+      @options[:per_page] = 20 if @options[:per_page].to_i <= 0
+      @options[:page] = 1 if @options[:page].to_i <= 0
+      @columns = []
+      @current_id = 0
+      @id = @@current_id.to_s(36).to_sym
+      @@current_id += 1
+      @parameters = {:sort=>:to_s, :dir=>:to_s}
+      @parameters.merge!(:page=>:to_i, :per_page=>:to_i) if self.paginate?
+    end
+
+    def new_id
+      id = @current_id.to_s(36).to_sym
+      @current_id += 1
+      return id
+    end
+
+    def model_columns
+      @model.columns
+    end
+
+    def sortable_columns
+      @columns.select{|c| c.sortable?}
+    end
+
+    def exportable_columns
+      @columns.select{|c| c.exportable?}
+    end
+
+    def paginate?
+      @paginate
+    end
+
+    def load_default_columns
+      for column in self.model_columns
+        reflections = @model.reflections.values.select{|r| r.macro == :belongs_to and r.foreign_key.to_s == column.name.to_s}
+        if reflections.size == 1
+          reflection = reflections.first
+          columns = reflection.class_name.constantize.columns.collect{ |c| c.name.to_s }
+          self.column([:label, :name, :code, :number].detect{ |l| columns.include?(l.to_s) }, :through => reflection.name, :url => true)
+        else
+          self.column(column.name)
+        end
+      end
+      return true
+    end
+
+  end
+
+  
+  class Column
+    attr_accessor :name, :options, :table
+    attr_reader :id
+    
+    def initialize(table, name, options={})
+      @table   = table
+      @name    = name
+      @options = options
+      @column  = @table.model.columns.detect{|c| c.name.to_s == @name.to_s }
+      @id = @table.new_id
+    end
+
+    def header_code
+      raise NotImplementedError.new("#{self.class.name}#header_code is not implemented.")
+    end
+    
+    def sortable?
+      false
+    end
+    
+    def exportable?
+      false
+    end
+
+    # Unique identifier of the column in the application
+    def unique_id
+      "#{@table.name}-#{@id}"
+    end
+
+    # Uncommon but simple identifier for CSS class uses
+    def simple_id
+      "_#{@table.id}_#{@id}"
+    end
+
+  end
+
+end
+
+require "active-list/columns/data_column"
+require "active-list/columns/action_column"
+require "active-list/columns/field_column"

data/lib/active-list/exporters.rb

@@ -0,0 +1,71 @@
+require 'active_support/core_ext/module/attribute_accessors'
+
+module ActiveList
+
+  mattr_reader :exporters
+  @@exporters = {}
+
+  def self.register_exporter(name, exporter)
+    raise ArgumentError.new("ActiveList::Exporter expected (got #{exporter.name}/#{exporter.ancestors.inspect})") unless exporter.ancestors.include? ActiveList::Exporter
+    @@exporters[name] = exporter.new(name)
+  end
+  
+  class Exporter
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def file_extension
+      "txt"
+    end
+    
+    def mime_type
+      Mime::TEXT
+    end
+
+    # Not used
+    # def condition
+    #   "not request.xhr? and params[:format] == '#{name}'"
+    # end
+       
+    def send_data_code(table)
+      raise NotImplementedError.new("#{self.class.name}#format_data_code is not implemented.")
+    end
+
+    def columns_headers(table, options={})
+      headers, columns = [], table.exportable_columns
+      for column in columns
+        datum = column.header_code
+        headers << (options[:iconv] ? "#{options[:iconv]}.iconv("+datum+".to_s)" : datum)
+      end
+      return headers
+    end
+    
+    def columns_to_array(table, nature, options={})
+      columns = table.exportable_columns
+      
+      array = []
+      record = options[:record]||'rekord'
+      for column in columns
+        if column.is_a? ActiveList::Column
+          if nature==:header
+            datum = column.header_code
+          else
+            datum = column.exporting_datum_code(record)
+          end
+          array << (options[:iconv] ? "#{options[:iconv]}.iconv("+datum+".to_s)" : datum)
+        end
+      end
+      return array
+    end
+
+  end
+
+end
+
+
+require "active-list/exporters/open_document_spreadsheet_exporter"
+require "active-list/exporters/csv_exporter"
+require "active-list/exporters/excel_csv_exporter"

data/lib/active-list/exporters/csv_exporter.rb

@@ -0,0 +1,30 @@
+module ActiveList
+  
+  class CsvExporter < ActiveList::Exporter
+
+    def file_extension
+      "csv"
+    end
+
+    def mime_type
+      Mime::CSV
+    end
+
+    def send_data_code(table)
+      record = "r"
+      code  = table.select_data_code(:paginate => false)
+      code += "data = ActiveList::CSV.generate do |csv|\n"
+      code += "  csv << [#{columns_to_array(table, :header).join(', ')}]\n"
+      code += "  for #{record} in #{table.records_variable_name}\n"  
+      code += "    csv << [#{columns_to_array(table, :body, :record=>record).join(', ')}]\n"
+      code += "  end\n"
+      code += "end\n"
+      code += "send_data(data, :type=>#{self.mime_type.to_s.inspect}, :disposition=>'inline', :filename=>#{table.model.name}.model_name.human.gsub(/[^a-z0-9]/i,'_')+'.#{self.file_extension}')\n"
+      return code
+    end
+
+  end
+
+end
+
+ActiveList.register_exporter(:csv, ActiveList::CsvExporter)

data/lib/active-list/exporters/excel_csv_exporter.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+# Register XCSV format unless is already set
+Mime::Type.register("text/csv", :xcsv) unless defined? Mime::XCSV
+
+module ActiveList
+  
+  class ExcelCsvExporter < ActiveList::CsvExporter
+
+    def file_extension
+      "csv"
+    end
+
+    def mime_type
+      Mime::XCSV
+    end
+
+    def send_data_code(table)
+      record = "r"
+      code  = table.select_data_code(:paginate => false)
+      code += "ic = Iconv.new('cp1252', 'utf-8')\n"
+      code += "data = ActiveList::CSV.generate(:col_sep=>';') do |csv|\n"
+      code += "  csv << [#{columns_to_array(table, :header, :iconv=>'ic').join(', ')}]\n"
+      code += "  for #{record} in #{table.records_variable_name}\n"  
+      code += "    csv << [#{columns_to_array(table, :body, :record=>record, :iconv=>'ic').join(', ')}]\n"
+      code += "  end\n"
+      code += "end\n"
+      code += "send_data(data, :type=>#{self.mime_type.to_s.inspect}, :disposition=>'inline', :filename=>#{table.model.name}.model_name.human.gsub(/[^a-z0-9]/i,'_')+'.#{self.file_extension}')\n"
+      return code
+    end
+
+  end
+
+end
+
+ActiveList.register_exporter(:xcsv, ActiveList::ExcelCsvExporter)

data/lib/active-list/exporters/open_document_spreadsheet_exporter.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+
+# Register ODS format unless is already set
+Mime::Type.register("application/vnd.oasis.opendocument.spreadsheet", :ods) unless defined? Mime::ODS
+
+module ActiveList
+  
+  class OpenDocumentSpreadsheetExporter < ActiveList::Exporter
+    
+    DATE_ELEMENTS = {
+      "m" => "<number:month number:style=\"long\"/>",
+      "d" => "<number:day number:style=\"long\"/>",
+      "Y" => "<number:year/>"
+    }
+
+
+    def file_extension
+      "ods"
+    end
+
+    def mime_type
+      Mime::ODS
+    end
+
+    def send_data_code(table)
+      xml_escape = "to_s.gsub('&', '&amp;').gsub('\\'', '&apos;').gsub('<', '&lt;').gsub('>', '&gt;')"
+      xml_escape << ".force_encoding('US-ASCII')" if xml_escape.respond_to?(:force_encoding)
+      record = "r"
+      code  = table.select_data_code(:paginate => false)
+      code << "name = #{table.model.name}.model_name.human.gsub(/[^a-z0-9]/i,'_')\n"
+      code << "temporary_dir = ::Rails.root.join('tmp', 'active-list')\n"
+      code << "FileUtils.mkdir_p(temporary_dir)\n"
+      code << "file = temporary_dir.join(name+rand.to_s+'.#{self.file_extension}')\n"
+      code << "Zip::ZipOutputStream.open(file) do |zile|\n"
+      # MimeType in first place
+      code << "  zile.put_next_entry('mimetype', nil, nil, Zip::ZipEntry::STORED)\n"
+      code << "  zile << '#{self.mime_type}'\n"
+
+      # Manifest
+      code << "  zile.put_next_entry('META-INF/manifest.xml')\n"
+      code << "  zile << ('<?xml version=\"1.0\" encoding=\"UTF-8\"?><manifest:manifest xmlns:manifest=\"urn:oasis:names:tc:opendocument:xmlns:manifest:1.0\"><manifest:file-entry manifest:media-type=\"#{self.mime_type}\" manifest:full-path=\"/\"/><manifest:file-entry manifest:media-type=\"text/xml\" manifest:full-path=\"content.xml\"/></manifest:manifest>')\n"
+      code << "  zile.put_next_entry('content.xml')\n"
+
+      code << "  zile << ('<?xml version=\"1.0\" encoding=\"UTF-8\"?><office:document-content xmlns:office=\"urn:oasis:names:tc:opendocument:xmlns:office:1.0\" xmlns:style=\"urn:oasis:names:tc:opendocument:xmlns:style:1.0\" xmlns:text=\"urn:oasis:names:tc:opendocument:xmlns:text:1.0\" xmlns:table=\"urn:oasis:names:tc:opendocument:xmlns:table:1.0\" xmlns:draw=\"urn:oasis:names:tc:opendocument:xmlns:drawing:1.0\" xmlns:fo=\"urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:dc=\"http://purl.org/dc/elements/1.1/\" xmlns:meta=\"urn:oasis:names:tc:opendocument:xmlns:meta:1.0\" xmlns:number=\"urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0\" xmlns:presentation=\"urn:oasis:names:tc:opendocument:xmlns:presentation:1.0\" xmlns:svg=\"urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0\" xmlns:chart=\"urn:oasis:names:tc:opendocument:xmlns:chart:1.0\" xmlns:dr3d=\"urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0\" xmlns:math=\"http://www.w3.org/1998/Math/MathML\" xmlns:form=\"urn:oasis:names:tc:opendocument:xmlns:form:1.0\" xmlns:script=\"urn:oasis:names:tc:opendocument:xmlns:script:1.0\" xmlns:ooo=\"http://openoffice.org/2004/office\" xmlns:ooow=\"http://openoffice.org/2004/writer\" xmlns:oooc=\"http://openoffice.org/2004/calc\" xmlns:dom=\"http://www.w3.org/2001/xml-events\" xmlns:xforms=\"http://www.w3.org/2002/xforms\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:field=\"urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:field:1.0\" office:version=\"1.1\"><office:scripts/>')\n"
+      # Styles
+      code << "  zile << ('<office:automatic-styles>"+
+        "<style:style style:name=\"co1\" style:family=\"table-column\"><style:table-column-properties fo:break-before=\"auto\" style:use-optimal-column-width=\"true\"/></style:style>"+
+        "<style:style style:name=\"header\" style:family=\"table-cell\"><style:text-properties fo:font-weight=\"bold\" style:font-weight-asian=\"bold\" style:font-weight-complex=\"bold\"/></style:style>"+
+        "<number:date-style style:name=\"K4D\" number:automatic-order=\"true\"><number:text>"+::I18n.translate("date.formats.default").gsub(/\%./){|x| "</number:text>"+DATE_ELEMENTS[x[1..1]]+"<number:text>"} +"</number:text></number:date-style><style:style style:name=\"ce1\" style:family=\"table-cell\" style:data-style-name=\"K4D\"/>"+
+        "</office:automatic-styles>')\n"
+
+      # Tables
+      code << "  zile << ('<office:body><office:spreadsheet><table:table table:name=\"'+#{table.model.name}.model_name.human.#{xml_escape}+'\">')\n"
+      code << "  zile << ('<table:table-column table:number-columns-repeated=\"#{table.exportable_columns.size}\"/>')\n"
+      code << "  zile << ('<table:table-header-rows><table:table-row>"+columns_headers(table).collect{|h| "<table:table-cell table:style-name=\"header\" office:value-type=\"string\"><text:p>'+(#{h}).#{xml_escape}+'</text:p></table:table-cell>"}.join+"</table:table-row></table:table-header-rows>')\n"
+      code << "  for #{record} in #{table.records_variable_name}\n"  
+      code << "    zile << ('<table:table-row>"+table.exportable_columns.collect do |column|
+        "<table:table-cell"+(if column.numeric? or column.datatype==:decimal
+                               " office:value-type=\"float\" office:value=\"'+(#{column.datum_code(record)}).#{xml_escape}+'\""
+                             elsif column.datatype==:boolean
+                               " office:value-type=\"boolean\" office:boolean-value=\"'+(#{column.datum_code(record)}).#{xml_escape}+'\""
+                             elsif column.datatype==:date
+                               " office:value-type=\"date\" table:style-name=\"ce1\" office:date-value=\"'+(#{column.datum_code(record)}).#{xml_escape}+'\""
+                             else 
+                               " office:value-type=\"string\""
+                             end)+"><text:p>'+("+column.exporting_datum_code(record, true)+").#{xml_escape}+'</text:p></table:table-cell>"
+      end.join+"</table:table-row>')\n"
+      code << "  end\n"
+      code << "  zile << ('</table:table></office:spreadsheet></office:body></office:document-content>')\n"
+      code << "end\n"
+      code << "send_file(file, :stream=>false, :type=>#{self.mime_type.to_s.inspect}, :disposition=>'inline', :filename=>name+'.#{self.file_extension}')\n"
+      code << "File.delete(file)\n" # Removes tmp files before they explode the disk
+      # raise code
+      return code
+    end
+
+  end
+
+end
+
+ActiveList.register_exporter(:ods, ActiveList::OpenDocumentSpreadsheetExporter)