make_exportable 1.0.1 → 1.0.2

data/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.6)
+      actionpack (= 2.3.6)
+    actionpack (2.3.6)
+      activesupport (= 2.3.6)
+      rack (~> 1.1.0)
+    activerecord (2.3.6)
+      activesupport (= 2.3.6)
+    activeresource (2.3.6)
+      activesupport (= 2.3.6)
+    activesupport (2.3.6)
+    gemcutter (0.5.0)
+      json_pure
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    rack (1.1.0)
+    rails (2.3.6)
+      actionmailer (= 2.3.6)
+      actionpack (= 2.3.6)
+      activerecord (= 2.3.6)
+      activeresource (= 2.3.6)
+      activesupport (= 2.3.6)
+      rake (>= 0.8.3)
+    rake (0.8.7)
+    rspec (1.3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3-ruby (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rails
+  rspec
+  sqlite3-ruby

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/make_exportable/core.rb

@@ -22,117 +22,118 @@ module MakeExportable #:nodoc:
 
     protected
 
-    # <tt>make_exportable</tt> is an ActiveRecord method that, when called, add 
-    # methods to a particular class to make exporting data from that class easier.
-    #
-    # Example:
-    #
-    #   class Customer < ActiveRecord::Base
-    #     make_exportable
-    #   end
-    #   Customer.to_export(:csv)
-    #
-    # An optional hash of options can be passed as an argument to establish the default 
-    # export parameters.
-    #
-    # These options include:
-    # * :only and :except - specify columns or methods to export (defaults to all columns)
-    # * :as - specify formats to allow for exporting (defaults to all formats)
-    # * :scopes - specify scopes to be called on the class before exporting
-    # * find options - for Rails 2.3 and earlier compatibility, standard find options 
-    #     are supported (:conditions, :order, :limit, :offset, etc.). These will be deprecated 
-    #     and removed in future versions.
-    #
-    # Examples:
-    #
-    #   class Customer < ActiveRecord::Base
-    #     make_exportable :only => [:id, :username, :full_name]
-    #   end
-    #
-    #   class Customer < ActiveRecord::Base
-    #     make_exportable :except => [:id, :password], :scopes => [:new_signups, :with_referals], 
-    #                     :as => [:csv, :tsv, :xls]
-    #   end
-    #
-    #   class Customer < ActiveRecord::Base
-    #     make_exportable :conditions => {:active => true}, :order => 'last_name ASC, first_name ASC',
-    #                     :as => [:json, :html, :xml]
-    #   end
-    #
-    def make_exportable(options={})
-      # register the class as exportable
-      MakeExportable.exportable_classes[self.class_name] = self
-
-      # remove any invalid options
-      valid_options = [:as, :only, :except, :scopes, :conditions, :order, :include,
-                       :group, :having, :limit, :offset, :joins]
-      options.slice!(*valid_options)
-
-      # Determine the exportable formats, default to all registered formats
-      options[:formats] = MakeExportable.exportable_formats.keys
-      if format_options = options.delete(:as)
-        options[:formats] = options[:formats] & Array.wrap(format_options).map(&:to_sym)
-      end
-      # Handle case when :as option was sent, but with no valid formats
-      if options[:formats].blank?
-        valid_formats = MakeExportable.exportable_formats.keys.map {|f| ":#{f}"}
-        raise MakeExportable::FormatNotFound.new("No valid export formats. Use: #{valid_formats.join(', ')}") 
-      end
+      # <tt>make_exportable</tt> is an ActiveRecord method that, when called, add
+      # methods to a particular class to make exporting data from that class easier.
+      #
+      # Example:
+      #
+      #   class Customer < ActiveRecord::Base
+      #     make_exportable
+      #   end
+      #   Customer.to_export(:csv)
+      #
+      # An optional hash of options can be passed as an argument to establish the default
+      # export parameters.
+      #
+      # These options include:
+      # * :only and :except - specify columns or methods to export (defaults to all columns)
+      # * :as - specify formats to allow for exporting (defaults to all formats)
+      # * :scopes - specify scopes to be called on the class before exporting
+      # * find options - for Rails 2.3 and earlier compatibility, standard find options
+      #     are supported (:conditions, :order, :limit, :offset, etc.). These will be deprecated
+      #     and removed in future versions.
+      #
+      # Examples:
+      #
+      #   class Customer < ActiveRecord::Base
+      #     make_exportable :only => [:id, :username, :full_name]
+      #   end
+      #
+      #   class Customer < ActiveRecord::Base
+      #     make_exportable :except => [:id, :password], :scopes => [:new_signups, :with_referals],
+      #                     :as => [:csv, :tsv, :xls]
+      #   end
+      #
+      #   class Customer < ActiveRecord::Base
+      #     make_exportable :conditions => {:active => true}, :order => 'last_name ASC, first_name ASC',
+      #                     :as => [:json, :html, :xml]
+      #   end
+      #
+      def make_exportable(options={})
+        return unless self.table_exists?
+        # register the class as exportable
+        MakeExportable.exportable_classes[self.class_name] = self
 
-      # Determine the exportable columns, default to all columns and then
-      # remove columns using the :only and :except options
-      options[:columns] = column_names.map(&:to_sym)
-      if only_options = options.delete(:only)
-        options[:columns] = Array.wrap(only_options).map(&:to_sym)
-      end
-      if except_options = options.delete(:except)
-        options[:columns] = options[:columns] - Array.wrap(except_options).map(&:to_sym)
-      end
+        # remove any invalid options
+        valid_options = [:as, :only, :except, :scopes, :conditions, :order, :include,
+                         :group, :having, :limit, :offset, :joins]
+        options.slice!(*valid_options)
 
-      options[:scopes] ||= []
+        # Determine the exportable formats, default to all registered formats
+        options[:formats] = MakeExportable.exportable_formats.keys
+        if format_options = options.delete(:as)
+          options[:formats] = options[:formats] & Array.wrap(format_options).map(&:to_sym)
+        end
+        # Handle case when :as option was sent, but with no valid formats
+        if options[:formats].blank?
+          valid_formats = MakeExportable.exportable_formats.keys.map {|f| ":#{f}"}
+          raise MakeExportable::FormatNotFound.new("No valid export formats. Use: #{valid_formats.join(', ')}")
+        end
 
-      # exportable options will be :formats, :columns, :scopes & find options
-      write_inheritable_attribute :exportable_options, options
-      class_inheritable_reader :exportable_options
+        # Determine the exportable columns, default to all columns and then
+        # remove columns using the :only and :except options
+        options[:columns] = column_names.map(&:to_sym)
+        if only_options = options.delete(:only)
+          options[:columns] = Array.wrap(only_options).map(&:to_sym)
+        end
+        if except_options = options.delete(:except)
+          options[:columns] = options[:columns] - Array.wrap(except_options).map(&:to_sym)
+        end
 
-      extend MakeExportable::ClassMethods
-      include MakeExportable::InstanceMethods
+        options[:scopes] ||= []
 
-    end
+        # exportable options will be :formats, :columns, :scopes & find options
+        write_inheritable_attribute :exportable_options, options
+        class_inheritable_reader :exportable_options
+
+        extend MakeExportable::ClassMethods
+        include MakeExportable::InstanceMethods
+
+      end
 
   end
 
   module ClassMethods
 
     # <tt>exportable?<?tt> returns true if the class has called "make_exportable".
-    # This is overriding the default :exportable? in ActiveRecord::Base which 
+    # This is overriding the default :exportable? in ActiveRecord::Base which
     # always returns false.
-    # If a format is passed as an argument, returns true only if the format is 
+    # If a format is passed as an argument, returns true only if the format is
     # allowed for this class.
     def exportable?(format=nil)
       return exportable_options[:formats].include?(format.to_sym) if format
       return true
     end
 
-    # <tt>to_export</tt> exports records from a class. It can be called 
+    # <tt>to_export</tt> exports records from a class. It can be called
     # directly on an ActiveRecord class, but it can also be called on an ActiveRelation scope.
     # It takes two arguments: a format (required) and a hash of options (optional).
     #
     # The options include:
     # * :only and :except - specify columns or methods to export
     # * :scopes - specify scopes to be called on the class before exporting
-    # * find options - for Rails 2.3 and earlier compatibility, standard find options 
-    #     are supported (:conditions, :order, :limit, :offset, etc.). These will be deprecated 
+    # * find options - for Rails 2.3 and earlier compatibility, standard find options
+    #     are supported (:conditions, :order, :limit, :offset, etc.). These will be deprecated
     #     and removed in future versions.
-    # * :headers - supply an array of custom headers for the columns of exported attributes, 
+    # * :headers - supply an array of custom headers for the columns of exported attributes,
     #     the sizes of the header array and the exported columns must be equal.
-    #   
+    #
     # Examples:
     #
-    #   User.to_export(:xml, :only => [:first_name, :last_name, :username], 
+    #   User.to_export(:xml, :only => [:first_name, :last_name, :username],
     #      :order => 'users.last_name ASC')
     #
-    #   User.visible.sorted_by_username.to_export('csv', 
+    #   User.visible.sorted_by_username.to_export('csv',
     #      :only => [:first_name, :last_name, :username])
     #
     def to_export(format, options={})
@@ -144,16 +145,16 @@ module MakeExportable #:nodoc:
       export_string = create_report(format, export_data, :headers => options[:headers])
       return export_string
     end
-    
-    # <tt>get_export_data</tt> finds records for export using a combination of the default 
-    # export options and the argument options, and returns an array of arrays representing 
-    # the rows and columns of the export data. The first item ("row") in the array will be 
+
+    # <tt>get_export_data</tt> finds records for export using a combination of the default
+    # export options and the argument options, and returns an array of arrays representing
+    # the rows and columns of the export data. The first item ("row") in the array will be
     # an array of strings to be used as column headers.
-    # Valid options include :only, :except, :scopes and the standard find options. 
+    # Valid options include :only, :except, :scopes and the standard find options.
     # See <tt>to_export</tt> for more details on the options.
     #
     # Example:
-    # 
+    #
     #   User.get_export_data(:only => [:first_name, :last_name, :username])
     #   # => [['first_name', 'last_name', 'username'], ['John', 'Doe', 'johndoe'], ['Joe', 'Smith', 'jsmith']] }
     #
@@ -164,23 +165,23 @@ module MakeExportable #:nodoc:
       return export_data
     end
 
-    # <tt>create_report</tt> creates a report from a set of data. It takes three arguments: 
-    # a format, the data set to use for the report, and an optional hash of options. 
-    # The only meaningful option is :headers which sets the strings to be used as column 
+    # <tt>create_report</tt> creates a report from a set of data. It takes three arguments:
+    # a format, the data set to use for the report, and an optional hash of options.
+    # The only meaningful option is :headers which sets the strings to be used as column
     # headers for the data set. The value of :headers can be:
     # * true - headers are the first row in the data set
     # * false - headers are not in the data set and should not be added
     # * array of strings to use for the column headers
-    # 
+    #
     # The length of the headers must match the length of each row in the data set.
     def create_report(format, data_set, options={})
       if options[:headers] === true
         options[:headers] = data_set.shift
       end
-      
+
       validate_export_format(format)
       validate_export_data_lengths(data_set, options[:headers])
-      
+
       format_class = MakeExportable.exportable_formats[format.to_sym]
       formater = format_class.new(data_set, options[:headers])
       return formater.generate, formater.mime_type
@@ -188,7 +189,7 @@ module MakeExportable #:nodoc:
 
     private
 
-      # <tt>method_missing</tt> allows the class to accept dynamically named methods 
+      # <tt>method_missing</tt> allows the class to accept dynamically named methods
       # such as: SomeClass.to_xls_export(), SomeClass.create_csv_report()
       def method_missing(method_id, *arguments)
         possible_formats = MakeExportable.exportable_formats.keys.map(&:to_s).join('|')
@@ -205,11 +206,11 @@ module MakeExportable #:nodoc:
 
       # <tt>find_export_data</tt> finds all objects of a given
       # class using a combination of the default export options and the options passed in.
-      # Valid options include :scopes and the standard find options. It returns a collection of 
+      # Valid options include :scopes and the standard find options. It returns a collection of
       # objects matching the find criteria.
       # See <tt>to_export</tt> for more details on the options.
       def find_export_data(options={})
-        
+
         # merge with defaults then pull out the supported find and scope options
         merged_options = options.reverse_merge(exportable_options)
         find_options  = merged_options.slice(:conditions, :order, :include, :group, :having, :limit, :offset, :joins)
@@ -230,12 +231,12 @@ module MakeExportable #:nodoc:
         return collection
       end
 
-      # <tt>map_export_data</tt> takes a collection and outputs an array of arrays representing 
-      # the rows and columns of the export data. The first item ("row") in the array will be 
+      # <tt>map_export_data</tt> takes a collection and outputs an array of arrays representing
+      # the rows and columns of the export data. The first item ("row") in the array will be
       # an array of strings to be used as column headers.
       # Valid options include :only and :except.
       # See <tt>to_export</tt> for more details on the options.
-      # 
+      #
       #   User.map_export_data(User.visible, :only => [:first_name, :last_name, :username])
       #   # => [['first_name', 'last_name', 'username'], ['John', 'Doe', 'johndoe'], ...]
       #
@@ -269,7 +270,7 @@ module MakeExportable #:nodoc:
         end
       end
 
-      # <tt>validate_export_data_lengths</tt> ensures that the headers and all data rows are of the 
+      # <tt>validate_export_data_lengths</tt> ensures that the headers and all data rows are of the
       # same size. (This is an important data integrity check if you are using NoSQL.)
       def validate_export_data_lengths(data_set, data_headers=nil)
         row_length = !data_headers.blank? ? data_headers.size : data_set[0].size
@@ -283,13 +284,13 @@ module MakeExportable #:nodoc:
   module InstanceMethods
 
     # <tt>export_attribute</tt> returns the export value of an attribute or method.
-    # By default, this is simply the value of the attribute or method itself, 
-    # but the value can be permanently overridden with another value by defining 
-    # a method called "#{attribute}_export". The alternate method will *always* 
-    # be called in place of the original one. At a minimum, this is useful 
-    # when a date should be formatted when exporting or when booleans should  
-    # always export as "Yes"/"No".  But it can do more, performing any amount of 
-    # processing or additional queries, as long as in the end it returns a value 
+    # By default, this is simply the value of the attribute or method itself,
+    # but the value can be permanently overridden with another value by defining
+    # a method called "#{attribute}_export". The alternate method will *always*
+    # be called in place of the original one. At a minimum, this is useful
+    # when a date should be formatted when exporting or when booleans should
+    # always export as "Yes"/"No".  But it can do more, performing any amount of
+    # processing or additional queries, as long as in the end it returns a value
     # for the export to use.
     # Sending an attribute name that does not exist will return an empty string.
     def export_attribute(attribute)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: make_exportable
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Kevin Skoglund
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-27 00:00:00 -04:00
+date: 2010-08-06 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.rdoc
 - Rakefile