spreadsheet_architect 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64aee8164ace0ace168a8468abd18bee0fa75ab4
-  data.tar.gz: 340b7cb21f836d507c11a16b870b2774fa209fd7
+  metadata.gz: aecd3d727c30feaf79f0838b51fbab5d2a2d4179
+  data.tar.gz: 120005b9f5b0b987d7d66dada11f306003bab336
 SHA512:
-  metadata.gz: 545b1ebbd6c0cf59a1841a4e60b3a61c5de90d6fdc8a8b8fa8f370833b1e52abf0e0610e001b888b2a61743540d948b1ec68c2aedfb421121e694ca78f0082ab
-  data.tar.gz: 5adc741b06b52e70e6c3c73c192a36920631ffeca5c13791cf8d8eec9adf34a6097cfa1dad74f62c56d71e6afda03a9020f9125bff1260bb266073c4d6d5dd89
+  metadata.gz: ae91411764f7d32eebbc13b99b6b37bbe560a4221dbbb7a489a4db37e9c7c0c0d868ef3054ef1f5dbefe23485b2f448e5ae9c75ec49dba6a4025e7a651bd8967
+  data.tar.gz: 68058e1003fe7ab9c4ee244dd870886b1b89afc9719df958fea6c130d89c1f63d384be97bc672e5e1f1db0a8e04b094d321b4a7bef789924e74cb8a514196516

data/CHANGELOG.md

@@ -1,7 +1,19 @@
 CHANGELOG
 ---------
 
+- **March.3.2016**: 1.1.0 - Breaking Changes
+  - Move spreadsheet_columns method from the class to the instance
+  - Fix Bug: remove default underline on cells
+- **March.1.2016**: 1.0.4
+  - Extract helper methods to seperate module
+  - Improve readme
+- **March.1.2016**: 1.0.3
+  - Fix/Improve renderers
+  - Fix header default background color
+  - Fix default columns
+- **February.26.2016**: 1.0.2
+  - Enhance Style options
 - **February.26.2016**: 1.0.1
-  - Fix Bug in ActionController Renderers
+  - Fix bug in renderers
 - **February.26.2016**: 1.0.0
   - Gem Initial Release

data/README.md

@@ -1,4 +1,5 @@
 # Spreadsheet Architect
+<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VKY8YAWAS5XRQ&lc=CA&item_name=Weston%20Ganger&item_number=spreadsheet_architect&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest" target="_blank" title="Donate"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="Donate"/></a>
 
 Spreadsheet Architect lets you turn any activerecord relation or plain ruby class object into a XLSX, ODS, or CSV spreadsheets. Generates columns from model activerecord column_names or from an array of ruby methods.
 
@@ -15,6 +16,9 @@ Post.order(name: :asc).where(published: true).to_ods
 Post.order(name: :asc).where(published: true).to_csv
 ```
 
+## Note: Breaking Changes in 1.1.0
+The `spreadseheet_columns` method has been moved from the class to the instance. So now you can use string interpolation in your values. Please re-read the Model section below to see the changes. The side effect of this is if you are using the spreadsheet_columns option directly on the .to_* methods.
+
 
 # Install
 ```ruby
@@ -30,17 +34,25 @@ class Post < ActiveRecord::Base #activerecord not required
   include SpreadsheetArchitect
 
   belongs_to :author
+  belongs_to :category
+  has_many :tags
 
   #optional for activerecord classes, defaults to the models column_names
-  def self.spreadsheet_columns
+  def spreadsheet_columns
     #[[Label, Method/Statement to Call on each Instance]....]
-    [['Title', :title],['Content', 'content'],['Author','author.name rescue nil',['Published?', "(published ? 'Yes' : 'No')"]]]
+    [
+      ['Title', :title],
+      ['Content', content],
+      ['Author', (author.name rescue nil)],
+      ['Published?', (published ? 'Yes' : 'No')],
+      ['Category/Tags', "#{category.name} - #{tags.collect(&:name).join(', ')}"]
+    ]
 
     # OR just humanize the method to use as the label ex. "Title", "Content", "Author Name", "Published"
-    [:title, 'content', 'author.name rescue nil', :published]
+    [:title, content, (author.name rescue nil), :published]
 
     # OR a Combination of Both
-    [:title, :content, ['Author','author.name rescue nil'], :published]
+    [:title, :content, ['Author',(author.name rescue nil)], :published, ]
   end
 end
 ```
@@ -119,11 +131,11 @@ end
 # Method Options
 
 ### to_xlsx, to_ods, to_csv
-**data** - *Array* - Mainly for Plain Ruby objects pass in an array of instances. Optional for ActiveRecord relations, you can just chain the method to the end of your relation.
+**data** - *Array* - Mainly for Plain Ruby objects pass in an array of instances. Optional for ActiveRecord relations, you can just chain the method to the end of your relation. If Plain Ruby object it defaults to the instances `to_a` method.
 
 **headers** - *Boolean* - Default: true - Pass in false if you do not want a header row.
 
-**spreadsheet_columns** - *Array* - A string array of attributes, methods, or ruby statements to be executed on each instance. Use this to override the models spreadsheet_columns/column_names method for one time.
+**spreadsheet_columns** - *Array* - Use this to override the models spreadsheet_columns/column_names method for one time. Must use symbols that correspond to instance methods of the object. Ex: `[:name, :title, :address]` or `[['Name',:name],['Post Title', :title],['Address', :address]]`
 
 ### to_xlsx
 **sheet_name** - *String*

data/lib/spreadsheet_architect.rb

@@ -20,27 +20,38 @@ module SpreadsheetArchitect
     end
 
     def self.get_options(options={}, klass)
-      if klass.ancestors.include?(ActiveRecord::Base) && !klass.respond_to?(:spreadsheet_columns) && !options[:spreadsheet_columns]
+      has_custom_columns = klass.instance_methods.include?(:spreadsheet_columns)
+
+      if !options[:data] && klass.ancestors.include?(ActiveRecord::Base)
+        options[:data] = klass.where(options[:where]).order(options[:order]).to_a
+      else
+        raise 'No data option was defined. This is required for plain ruby objects.'
+      end
+
+      if !has_custom_columns && klass.ancestors.include?(ActiveRecord::Base)
         the_column_names = (klass.column_names - ["id","created_at","updated_at","deleted_at"])
         headers = the_column_names.map{|x| str_humanize(x)}
-        columns = the_column_names.map{|x| x.to_s}
-      elsif options[:spreadsheet_columns] || klass.respond_to?(:spreadsheet_columns)
+        columns = the_column_names.map{|x| x.to_sym}
+      elsif has_custom_columns
         headers = []
         columns = []
-
-        array = options[:spreadsheet_columns] || klass.spreadsheet_columns || []
+        array = options[:spreadsheet_columns] || options[:data].first.spreadsheet_columns
         array.each do |x|
           if x.is_a?(Array)
             headers.push x[0].to_s
-            columns.push x[1].to_s
+            columns.push x[1]
           else
             headers.push str_humanize(x.to_s)
-            columns.push x.to_s
+            columns.push x
           end
         end
       else
-        headers = []
-        columns = []
+        raise 'No instance method `spreadsheet_columns` found on this plain ruby object'
+      end
+
+      data = []
+      options[:data].each do |instance|
+        data.push columns.map{|col| col.is_a?(String) ? col : instance.instance_eval(col.to_s)}
       end
 
       headers = (options[:headers] == false ? false : headers)
@@ -59,19 +70,10 @@ module SpreadsheetArchitect
       end
 
       sheet_name = options[:sheet_name] || klass.name
-      
-      if options[:data]
-        data = options[:data].to_a
-      elsif klass.ancestors.include?(ActiveRecord::Base)
-        data = klass.where(options[:where]).order(options[:order]).to_a
-      else
-        # object must have a to_a method 
-        data = klass.to_a
-      end
 
       types = (options[:types] || []).flatten
 
-      return {headers: headers, columns: columns, header_style: header_style, row_style: row_style, types: types, sheet_name: sheet_name, data: data}
+      return {headers: headers, header_style: header_style, row_style: row_style, types: types, sheet_name: sheet_name, data: data}
     end
   end
 
@@ -82,8 +84,8 @@ module SpreadsheetArchitect
       CSV.generate do |csv|
         csv << options[:headers] if options[:headers]
         
-        options[:data].each do |instance|
-          csv << options[:columns].map{|col| instance.instance_eval(col)}
+        options[:data].each do |row_data|
+          csv << row_data
         end
       end
     end
@@ -134,9 +136,9 @@ module SpreadsheetArchitect
             end
           end
         end
-        options[:data].each do |instance|
+        options[:data].each do |row_data|
           row do 
-            options[:columns].map{|col| instance.instance_eval(col)}.each do |y|
+            row_data.each do |y|
               cell y, style: :row_style
             end
           end
@@ -159,7 +161,9 @@ module SpreadsheetArchitect
       header_style[:b] = options[:header_style].delete(:bold)
       header_style[:sz] = options[:header_style].delete(:font_size)
       header_style[:i] = options[:header_style].delete(:italic)
-      header_style[:u] = options[:header_style].delete(:underline)
+      if options[:header_style][:underline]
+        header_style[:u] = options[:header_style].delete(:underline)
+      end
       header_style.delete_if{|x| x.nil?}
 
       row_style = {}
@@ -172,7 +176,9 @@ module SpreadsheetArchitect
       row_style[:b] = options[:row_style].delete(:bold)
       row_style[:sz] = options[:row_style].delete(:font_size)
       row_style[:i] = options[:row_style].delete(:italic)
-      row_style[:u] = options[:row_style].delete(:underline)
+      if options[:row_style][:underline]
+        row_style[:u] = options[:row_style].delete(:underline)
+      end
       row_style.delete_if{|x| x.nil?}
       
       package = Axlsx::Package.new
@@ -184,8 +190,8 @@ module SpreadsheetArchitect
           sheet.add_row options[:headers], style: package.workbook.styles.add_style(header_style)
         end
         
-        options[:data].each do |instance|
-          sheet.add_row options[:columns].map{|col| instance.instance_eval(col)}, style: package.workbook.styles.add_style(row_style), types: options[:types]
+        options[:data].each do |row_data|
+          sheet.add_row row_data, style: package.workbook.styles.add_style(row_style), types: options[:types]
         end
       end
 

data/lib/spreadsheet_architect/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetArchitect
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreadsheet_architect
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Weston Ganger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx