spreadsheet_architect 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 155a653969b09467dd11207dee1a4b4a208b316b
-  data.tar.gz: d7c94501ad36264f26e9285d21ebef0546e89067
+  metadata.gz: 64aee8164ace0ace168a8468abd18bee0fa75ab4
+  data.tar.gz: 340b7cb21f836d507c11a16b870b2774fa209fd7
 SHA512:
-  metadata.gz: c801aa14de7c5f8c10b7c20aaecb59cb50fbf956ef7a59cccd8e04c3d9cc69ad1773254b296e90c96c786a1c8e387eb49586106a681416a9e7fa7b1941c7978f
-  data.tar.gz: 0732d0406412a5aec37a37c2558a3bce488fa66c5118d08893bdac9d5dac242d9142a7bb8f5112f16e071115702f05c818f96fedbaaa1deb37026477420daf38
+  metadata.gz: 545b1ebbd6c0cf59a1841a4e60b3a61c5de90d6fdc8a8b8fa8f370833b1e52abf0e0610e001b888b2a61743540d948b1ec68c2aedfb421121e694ca78f0082ab
+  data.tar.gz: 5adc741b06b52e70e6c3c73c192a36920631ffeca5c13791cf8d8eec9adf34a6097cfa1dad74f62c56d71e6afda03a9020f9125bff1260bb266073c4d6d5dd89

data/README.md

@@ -47,39 +47,57 @@ end
 
 # Usage
 
-### Method 1: Controller for a Rails Model
+### Method 1: Controller (for Rails)
 ```ruby
+
 class PostsController < ActionController::Base
+  respond_to :html, :xlsx, :ods, :csv
+
+  # Using respond_with
   def index
     @posts = Post.order(published_at: :asc)
-  
+
+    respond_with @posts
+  end
+
+  # Using respond_with with custom options
+  def index
+    @posts = Post.order(published_at: :asc)
+
+    if ['xlsx','ods','csv'].include?(request.format)
+      respond_with @posts.to_xlsx(row_style: {bold: true}), filename: 'Posts'
+    else
+      respond_with @posts
+    end
+  end
+
+  # Using responders
+  def index
+    @posts = Post.order(published_at: :asc)
+
     respond_to do |format|
       format.html
-      format.xlsx { render xlsx: @posts.to_xlsx, filename: "posts.xlsx" }
-      format.ods { render ods: @posts.to_ods, filename: "posts.ods" }
-      format.csv { render csv: @posts.to_csv, filename: "posts.csv" }
+      format.xlsx { render xlsx: @posts }
+      format.ods { render ods: @posts }
+      format.csv{ render csv: @posts }
     end
   end
-end
-```
 
-### Method 2: Controller for a Plain Ruby Model
-```ruby
-class PostsController < ActionController::Base
+  # Using responders with custom options
   def index
-    posts_array = [Post.new, Post.new, Post.new]
+    @posts = Post.order(published_at: :asc)
 
     respond_to do |format|
       format.html
-      format.xlsx { render xlsx: Post.to_xlsx(data: posts_array), filename: "posts.xlsx" }
-      format.ods { render ods: Post.to_ods(data: posts_array), filename: "posts.ods" }
-      format.csv { render csv: Post.to_csv(data: posts_array), filename: "posts.csv" }
+      format.xlsx { render xlsx: @posts.to_xlsx(headers: false) }
+      format.ods { render ods: Post.to_odf(data: @posts) }
+      format.csv{ render csv: @posts.to_csv(headers: false), file_name: 'articles' }
     end
   end
 end
 ```
 
-### Method 3: Save to a file manually
+### Method 2: Save to a file manually
 ```ruby
 File.open('path/to/file.xlsx') do |f|
   f.write{ Post.order(published_at: :asc).to_xlsx }
@@ -90,6 +108,11 @@ end
 File.open('path/to/file.csv') do |f|
   f.write{ Post.order(published_at: :asc).to_csv }
 end
+
+# Ex. with plain ruby class
+File.open('path/to/file.xlsx') do |f|
+  f.write{ Post.to_xlsx(data: posts_array) }
+end
 ```
 
 

data/lib/spreadsheet_architect.rb

@@ -10,8 +10,8 @@ module SpreadsheetArchitect
     base.send :extend, ClassMethods
   end
 
-  module ClassMethods
-    def sa_str_humanize(str, capitalize = true)
+  module Helpers
+    def self.str_humanize(str, capitalize = true)
       str = str.sub(/\A_+/, '').gsub(/[_\.]/,' ').sub(' rescue nil','')
       if capitalize
         str = str.gsub(/(\A|\ )\w/){|x| x.upcase}
@@ -19,22 +19,22 @@ module SpreadsheetArchitect
       str
     end
 
-    def sa_get_options(options={})
-      if self.ancestors.include?(ActiveRecord::Base) && !self.respond_to?(:spreadsheet_columns) && !options[:spreadsheet_columns]
-        the_column_names = (self.column_names - ["id","created_at","updated_at","deleted_at"])
-        headers = the_column_names.map{|x| sa_str_humanize(x)}
+    def self.get_options(options={}, klass)
+      if klass.ancestors.include?(ActiveRecord::Base) && !klass.respond_to?(:spreadsheet_columns) && !options[:spreadsheet_columns]
+        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] || self.respond_to?(:spreadsheet_columns)
+      elsif options[:spreadsheet_columns] || klass.respond_to?(:spreadsheet_columns)
         headers = []
         columns = []
 
-        array = options[:spreadsheet_columns] || self.spreadsheet_columns || []
+        array = options[:spreadsheet_columns] || klass.spreadsheet_columns || []
         array.each do |x|
           if x.is_a?(Array)
             headers.push x[0].to_s
             columns.push x[1].to_s
           else
-            headers.push sa_str_humanize(x.to_s)
+            headers.push str_humanize(x.to_s)
             columns.push x.to_s
           end
         end
@@ -58,51 +58,38 @@ module SpreadsheetArchitect
         row_style.merge!(options[:row_style])
       end
 
-      sheet_name = options[:sheet_name] || self.name
+      sheet_name = options[:sheet_name] || klass.name
       
       if options[:data]
         data = options[:data].to_a
-      elsif self.ancestors.include?(ActiveRecord::Base)
-        data = where(options[:where]).order(options[:order]).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 = self.to_a
+        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}
     end
+  end
 
-    def sa_get_row_data(the_columns=[], instance)
-      row_data = []
-      the_columns.each do |col|
-        col.split('.').each_with_index do |x,i| 
-          if i == 0
-            col = instance.instance_eval(x)
-          else
-            col = col.instance_eval(x)
-          end
-        end
-        row_data.push col.to_s
-      end
-      return row_data
-    end
-
+  module ClassMethods
     def to_csv(opts={})
-      options = sa_get_options(opts)
+      options = SpreadsheetArchitect::Helpers.get_options(opts, self)
 
       CSV.generate do |csv|
         csv << options[:headers] if options[:headers]
         
-        options[:data].each do |x|
-          csv << sa_get_row_data(options[:columns], x)
+        options[:data].each do |instance|
+          csv << options[:columns].map{|col| instance.instance_eval(col)}
         end
       end
     end
 
     def to_ods(opts={})
-      options = sa_get_options(opts)
+      options = SpreadsheetArchitect::Helpers.get_options(opts, self)
 
       spreadsheet = ODF::Spreadsheet.new
 
@@ -139,7 +126,6 @@ module SpreadsheetArchitect
         end
       end
 
-      this_class = self
       spreadsheet.table options[:sheet_name] do 
         if options[:headers]
           row do
@@ -148,9 +134,9 @@ module SpreadsheetArchitect
             end
           end
         end
-        options[:data].each do |x|
+        options[:data].each do |instance|
           row do 
-            this_class.sa_get_row_data(options[:columns], x).each do |y|
+            options[:columns].map{|col| instance.instance_eval(col)}.each do |y|
               cell y, style: :row_style
             end
           end
@@ -161,7 +147,7 @@ module SpreadsheetArchitect
     end
 
     def to_xlsx(opts={})
-      options = sa_get_options(opts)
+      options = SpreadsheetArchitect::Helpers.get_options(opts, self)
     
       header_style = {}
       header_style[:fg_color] = options[:header_style].delete(:color)
@@ -198,8 +184,8 @@ module SpreadsheetArchitect
           sheet.add_row options[:headers], style: package.workbook.styles.add_style(header_style)
         end
         
-        options[:data].each do |x|
-          sheet.add_row sa_get_row_data(options[:columns], x), style: package.workbook.styles.add_style(row_style), types: options[:types]
+        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]
         end
       end
 

data/lib/spreadsheet_architect/version.rb

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

metadata

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