make_exportable 1.0.0

data/lib/make_exportable/errors.rb

@@ -0,0 +1,7 @@
+module MakeExportable
+  class FormatNotFound < StandardError #:nodoc:
+  end
+
+  class ExportFault < StandardError #:nodoc:
+  end
+end

data/lib/make_exportable/exportable_format.rb

@@ -0,0 +1,33 @@
+module MakeExportable #:nodoc:
+  class ExportableFormat
+
+    class_inheritable_accessor :reference
+    class_inheritable_accessor :name
+    
+    attr_accessor :long
+    attr_accessor :mime_type
+
+    class << self
+      # Register this format with the mothership
+      def register_format
+        unless MakeExportable.exportable_formats[self.reference]
+          MakeExportable.exportable_formats[self.reference] = self
+        end
+      end
+
+    end
+    
+    def generate(data_set, data_headers=nil)
+    end
+
+    def sanitize(value)
+      value
+    end
+
+    def generate_header_option(data_headers=[])
+      self.mime_type += (self.data_headers.blank? || data_headers === false) ? " header=absent" : " header=present"
+    end
+
+  end
+
+end

data/lib/make_exportable/exportable_formats/csv.rb

@@ -0,0 +1,34 @@
+require "csv"
+# for compatibility with Rails 2
+require 'fastercsv' if CSV.const_defined?(:Reader)
+
+module MakeExportable #:nodoc:
+  class CSV < ExportableFormat
+
+    cattr_accessor :csv_type
+
+    self.reference = :csv
+    self.name      = 'CSV'
+    self.register_format
+    self.csv_type = ::CSV.const_defined?(:Reader) ? FasterCSV : ::CSV
+
+    attr_accessor :data_set, :data_headers
+
+    def initialize(data_set, data_headers=[])
+      self.long      = 'Comma-separated (CSV)'
+      self.mime_type = 'text/csv; charset=utf-8;'
+      self.data_set = data_set
+      self.data_headers = data_headers
+    end
+
+
+    def generate
+      generate_header_option(data_headers)
+      @@csv_type.generate do |csv|
+        csv << data_headers.map {|h| sanitize(h.humanize.titleize)} unless data_headers.blank?
+        data_set.each {|row| csv << row }
+      end
+    end
+  end
+
+end

data/lib/make_exportable/exportable_formats/excel.rb

@@ -0,0 +1,39 @@
+module MakeExportable #:nodoc:
+  class Excel < ExportableFormat
+
+    self.reference = :xls
+    self.name      = 'Excel'
+    self.register_format
+    
+    attr_accessor :data_set, :data_headers
+    
+    def initialize(data_set, data_headers=[])
+      self.long      = 'Microsoft Excel'
+      self.mime_type = 'application/vnd.ms-excel; charset=utf-8;'
+      self.data_set = data_set
+      self.data_headers = data_headers
+    end
+
+    def generate
+      generate_header_option(data_headers)
+      output = "<table>\n"
+      unless data_headers.blank?
+        output << "\t<tr>\n"
+        output << data_headers.map {|h| "\t\t<th>#{sanitize(h.humanize.titleize)}</th>\n" }.join
+        output << "\t</tr>\n"
+      end
+      data_set.each do |row|
+        output << "\t<tr>\n"
+        output << row.map {|field| "\t\t<td>#{sanitize(field)}</td>\n"}.join
+        output << "\t</tr>\n"
+      end
+      output << "</table>\n"
+      return output
+    end
+
+    def sanitize(value)
+      value.gsub(/</, '&lt;').gsub(/>/, '&gt;')
+    end
+  end
+
+end

data/lib/make_exportable/exportable_formats/html.rb

@@ -0,0 +1,39 @@
+module MakeExportable #:nodoc:
+  class HTML < ExportableFormat
+
+    self.reference = :html
+    self.name      = 'HTML'
+    self.register_format
+    
+    attr_accessor :data_set, :data_headers
+
+    def initialize(data_set, data_headers=[])
+      self.long      = 'HTML'
+      self.mime_type = 'text/html; charset=utf-8;'
+      self.data_set = data_set
+      self.data_headers = data_headers
+    end
+
+    def generate
+      generate_header_option(data_headers)
+      output = "<table>\n"
+      unless data_headers.blank?
+        output << "\t<tr>\n"
+        output << data_headers.map {|h| "\t\t<th>#{sanitize(h.humanize.titleize)}</th>\n" }.join
+        output << "\t</tr>\n"
+      end
+      data_set.each do |row|
+        output << "\t<tr>\n"
+        output << row.map {|field| "\t\t<td>#{sanitize(field)}</td>\n"}.join
+        output << "\t</tr>\n"
+      end
+      output << "</table>\n"
+      return output
+    end
+
+    def sanitize(value)
+      value.gsub(/</, '&lt;').gsub(/>/, '&gt;')
+    end
+  end
+
+end

data/lib/make_exportable/exportable_formats/json.rb

@@ -0,0 +1,36 @@
+module MakeExportable #:nodoc:
+  class JSON < ExportableFormat
+
+    self.reference = :json
+    self.name      = "JSON"
+    self.register_format
+
+    attr_accessor :data_set, :data_headers
+
+    def initialize(data_set, data_headers=[])
+      self.long      = "JavaScript Object Notation (JSON)"
+      self.mime_type = "application/json; charset=utf-8;"
+      self.data_set = data_set
+      self.data_headers = data_headers
+    end
+
+    def generate
+      output = []
+      unless data_headers.blank?
+        data_set.each do |row|
+          h = {}
+          row.each_with_index do |field, i|
+            h[data_headers[i]] = field
+          end
+          output << h
+        end
+      else
+      end
+      return output.to_json
+    end
+
+    def sanitize(value)
+    end
+
+  end
+end

data/lib/make_exportable/exportable_formats/tsv.rb

@@ -0,0 +1,34 @@
+module MakeExportable #:nodoc:
+  class TSV < ExportableFormat
+
+    self.reference = :tsv
+    self.name      = "TSV"
+    self.register_format
+
+    attr_accessor :data_set, :data_headers
+
+    def initialize(data_set, data_headers=[])
+      self.long      = "Tab-separated (TSV)"
+      self.mime_type = "text/tab-separated-values; charset=utf-8;"
+      self.data_set = data_set
+      self.data_headers = data_headers
+    end
+
+    def generate
+      generate_header_option(data_headers)
+      output = ""
+      unless data_headers.blank?
+        output << data_headers.map {|h| sanitize(h.humanize.titleize) }.join("\t")
+      end
+      output << "\n" unless output.blank?
+      data_set.each do |row|
+        output << row.map {|field| sanitize(field)}.join("\t") << "\n"
+      end
+      return output
+    end
+
+    def sanitize(value)
+      value.gsub(/(\t|\\t)/, '  ')
+    end
+  end
+end

data/lib/make_exportable/exportable_formats/xml.rb

@@ -0,0 +1,43 @@
+module MakeExportable #:nodoc:
+  class XML < ExportableFormat
+
+    self.reference = :xml
+    self.name      = 'XML'
+    self.register_format
+
+    attr_accessor :data_set, :data_headers
+
+    def initialize(data_set, data_headers=[])
+      self.long      = 'XML'
+      self.mime_type = 'application/xml;'
+      self.data_set = data_set
+      self.data_headers = data_headers
+    end
+
+    def generate
+      generate_header_option(data_headers)
+      xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      xml << "<records>\n"
+      data_set.each do |row|
+        xml << "\t<record>\n"
+        row.each_with_index do |field,i|
+          if !data_headers.blank?
+            attr_name = sanitize(data_headers[i].dasherize)
+          else
+            attr_name = "attribute_#{i}"
+          end
+          xml << "\t\t<#{attr_name}>#{sanitize(field)}</#{attr_name}>\n"
+        end
+        xml << "\t</record>\n"
+      end
+      xml << "</records>\n"
+      return xml
+    end
+
+    def sanitize(value)
+      value.gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;').
+        gsub(/"/, '&quot;').gsub(/'/, '&apos;')
+    end
+  end
+
+end

data/lib/make_exportable/make_exportable_helper.rb

@@ -0,0 +1,27 @@
+module MakeExportableHelper
+
+  def self.exportable_class_list
+    MakeExportable.exportable_classes.keys.sort {|item1, item2| item1[0] <=> item2[0] }
+  end
+
+  def self.exportable_table_list
+    MakeExportable.exportable_classes.values.map do |klass|
+      klass.table_name
+    end.sort {|item1, item2| item1[0] <=> item2[0] }
+  end
+
+  def self.exportable_format_list
+    MakeExportable.exportable_formats.map do |key, fmt|
+      [fmt.name, key]
+    end.sort {|item1, item2| item1[0] <=> item2[0] }
+  end
+
+  def self.exportable_units
+    hash = {}
+    MakeExportable.exportable_classes.values.map do |klass|
+      hash[klass] = klass.table_name
+    end
+    hash
+  end
+
+end

data/lib/make_exportable/version.rb

@@ -0,0 +1,9 @@
+module MakeExportable
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '..', 'init')

data/spec/database.yml

@@ -0,0 +1,10 @@
+sqlite3:
+  adapter: sqlite3
+  database: make_exportable.sqlite3
+
+mysql:
+  adapter: mysql
+  hostname: localhost
+  username: root
+  password:
+  database: make_exportable

data/spec/database.yml.sample

@@ -0,0 +1,10 @@
+sqlite3:
+  adapter: sqlite3
+  database: make_exportable.sqlite3
+
+mysql:
+  adapter: mysql
+  hostname: localhost
+  username: root
+  password:
+  database: make_exportable

data/spec/make_exportable/formats_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Exportable Formats" do
+
+  before(:each) do
+    class User
+      make_exportable
+    end
+    clean_database!
+    User.create(:first_name => "user_1", :last_name => "Doe", :created_at => Time.at(0), :updated_at => Time.at(0))
+    User.create(:first_name => "user_2", :last_name => "Doe", :created_at => Time.at(0), :updated_at => Time.at(0))
+  end
+  
+  context "csv format" do
+
+    it "should export the columns as csv" do
+      User.to_export( "csv", :only => [:first_name, "is_admin"]).should ==  ["First Name,Is Admin\nuser_1,false\nuser_2,false\n", "text/csv; charset=utf-8; header=present"]
+    end
+
+    it "should export the columns as csv and detect that there is no header" do
+      User.to_export( "csv", :only => [:first_name, "is_admin"], :headers => false).should ==  ["user_1,false\nuser_2,false\n", "text/csv; charset=utf-8; header=absent"]
+    end
+
+  end
+  
+  context "excel format" do
+
+    it "should export the columns as xls" do
+      User.to_export( "xls", :only =>  [:first_name, "is_admin"]).should == ["<table>\n\t<tr>\n\t\t<th>First Name</th>\n\t\t<th>Is Admin</th>\n\t</tr>\n\t<tr>\n\t\t<td>user_1</td>\n\t\t<td>false</td>\n\t</tr>\n\t<tr>\n\t\t<td>user_2</td>\n\t\t<td>false</td>\n\t</tr>\n</table>\n", "application/vnd.ms-excel; charset=utf-8; header=present"]
+    end
+
+    it "should export the columns as xls and detect no header" do
+      User.to_export( "xls", :only =>  [:first_name, "is_admin"], :headers => false).should == ["<table>\n\t<tr>\n\t\t<td>user_1</td>\n\t\t<td>false</td>\n\t</tr>\n\t<tr>\n\t\t<td>user_2</td>\n\t\t<td>false</td>\n\t</tr>\n</table>\n", "application/vnd.ms-excel; charset=utf-8; header=absent"]
+    end
+
+  end
+
+  context "tsv format" do
+
+    it "should export the columns as tsv" do
+      User.to_export( "tsv", :only => [:first_name, "is_admin"]).should == ["First Name\tIs Admin\nuser_1\tfalse\nuser_2\tfalse\n", "text/tab-separated-values; charset=utf-8; header=present"]
+    end
+
+    it "should export the columns as tsv  and detect no header" do
+      User.to_export( "tsv", :only => [:first_name, "is_admin"], :headers => false).should == ["user_1\tfalse\nuser_2\tfalse\n", "text/tab-separated-values; charset=utf-8; header=absent"]
+    end
+
+  end
+
+  context "html format" do
+
+    it "should export the columns as html" do
+      User.to_export( "html", :only => [:first_name, "is_admin"]).should == ["<table>\n\t<tr>\n\t\t<th>First Name</th>\n\t\t<th>Is Admin</th>\n\t</tr>\n\t<tr>\n\t\t<td>user_1</td>\n\t\t<td>false</td>\n\t</tr>\n\t<tr>\n\t\t<td>user_2</td>\n\t\t<td>false</td>\n\t</tr>\n</table>\n", "text/html; charset=utf-8; header=present"]
+    end
+
+    it "should export the columns as html and detect no header" do
+      User.to_export( "html", :only => [:first_name, "is_admin"], :headers => false).should == ["<table>\n\t<tr>\n\t\t<td>user_1</td>\n\t\t<td>false</td>\n\t</tr>\n\t<tr>\n\t\t<td>user_2</td>\n\t\t<td>false</td>\n\t</tr>\n</table>\n", "text/html; charset=utf-8; header=absent"]
+    end
+
+  end
+
+  context "xml format" do
+
+    it "should export the columns as xml" do
+      User.to_export( "xml", :only => [:first_name, "is_admin"]).should == ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<records>\n\t<record>\n\t\t<first-name>user_1</first-name>\n\t\t<is-admin>false</is-admin>\n\t</record>\n\t<record>\n\t\t<first-name>user_2</first-name>\n\t\t<is-admin>false</is-admin>\n\t</record>\n</records>\n", "application/xml; header=present"]
+    end
+
+    it "should export the columns as xml and detect no header" do
+      User.to_export( "xml", :only => [:first_name, "is_admin"], :headers => false).should == ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<records>\n\t<record>\n\t\t<attribute_0>user_1</attribute_0>\n\t\t<attribute_1>false</attribute_1>\n\t</record>\n\t<record>\n\t\t<attribute_0>user_2</attribute_0>\n\t\t<attribute_1>false</attribute_1>\n\t</record>\n</records>\n", "application/xml; header=absent"]
+    end
+
+  end
+
+  context "json format" do
+    it "should export the columns as json" do
+      User.to_export( "json", :only => [:first_name]).should ==["[{\"first_name\":\"user_1\"},{\"first_name\":\"user_2\"}]", "application/json; charset=utf-8;"]
+    end
+
+  end
+  
+end

data/spec/make_exportable/make_exportable_helper_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Make Exportable Helper" do
+
+  before(:each) do
+    clean_database!
+  end
+
+  it "it should output an array of exportable classes" do
+    MakeExportable.exportable_classes = {}
+    User.class_eval("make_exportable")
+    Post.class_eval("make_exportable")
+    MakeExportableHelper.exportable_class_list.should == ["Post", "User"]
+    MakeExportable.exportable_classes = {}
+  end
+
+  it "it should output an array of exportable tables" do
+    User.class_eval("make_exportable")
+    Post.class_eval("make_exportable")
+    MakeExportableHelper.exportable_table_list.should ==["posts", "users"]
+    MakeExportable.exportable_classes = {}
+  end
+  
+  it "it should output an array of exportable classes and tables to check against" do
+    User.class_eval("make_exportable")
+    Post.class_eval("make_exportable")
+    MakeExportableHelper.exportable_units.should == {User => "users", Post => "posts"}
+    MakeExportable.exportable_classes = {}
+  end
+
+end