spreadsheet_architect 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b706fe5b3df6da7cfc18655f49969b0192621f17
-  data.tar.gz: 293780f00057fa57874e20d05508454f14002502
+  metadata.gz: 43f9f29b01120f3411da214e7077dda8bb04c3ec
+  data.tar.gz: 53d0343559d21e70b02bd16eb7aefdd7bdea3bb4
 SHA512:
-  metadata.gz: 47960159b14e086c77dcab8786cebd0e6b19b976aab59c04caef2535755fc5f62cb3cada580481db15ab3dfd70b2677da14186cc76937b47fe4cc2405fda13cf
-  data.tar.gz: fbb2f328e8f3f47509f4e8e4f80c8da20fb249fe70bc70f33dd8a93dd825d650f619c7b6da58e8abd7d67aed8cccce0f439aa710a6c8aced80fb4566acabc961
+  metadata.gz: 2a54100454ba15e3de07052e102ae1847407f811c95c75297f0cd272247798db640f7654f948ff4e89a78d572eb0eaa1b97293f1c43a442cb853e1c4f76f5a95
+  data.tar.gz: 46ca8c7ffdb8f899eeba54241fb69d2c0c19f89743fa2861578a1b2f950ddac8fffd4610d61de31f5ec7cee11cc41e7aeac245b895df5275675303d7e3a3d795

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 CHANGELOG
 ---------
 
+- **May.3.2016**: 1.5.0
+  - Add to_axlsx_package, to_rodf_spreadsheet methods for the item to be further manipulated. Ex. axlsx_styler
+- **May.2.2016**: 1.4.1
+  - Add rails generator for project defaults initializer
 - **April.29.2016**: 1.4.0
   - Add to_xlsx, to_ods, & to_csv to SpreadsheetArchitect model for direct calling by passing in cell data
 - **April.21.2016**: 1.3.0

data/README.md

@@ -1,5 +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>
+<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="Buy Me A Coffee"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="Buy Me A Coffee"/></a>
 
 Spreadsheet Architect is a library that allows you to create XLSX, ODS, or CSV spreadsheets easily from ActiveRecord relations, Plain Ruby classes, or predefined data.
 
@@ -12,7 +12,7 @@ Key Features:
 - Model/Class or Project specific defaults
 - Simple to use ActionController renderers
 
-Spreadsheet Architect adds the following methods to your class:
+Spreadsheet Architect adds the following methods:
 ```ruby
 # Rails ActiveRecord Model
 Post.order(name: :asc).where(published: true).to_xlsx
@@ -30,6 +30,12 @@ data = [[1,2,3], [4,5,6], [7,8,9]]
 SpreadsheetArchitect.to_xlsx(data: data, headers: headers)
 SpreadsheetArchitect.to_ods(data: data, headers: headers)
 SpreadsheetArchitect.to_csv(data: data, header: false)
+
+# These return a ruby object that can be further manipulated
+# These methods may also be used on models/classes
+SpreadsheetArchitect.to_axlsx('package', {data: data, headers: headers})
+SpreadsheetArchitect.to_axlsx('sheet', {data: data, headers: headers})
+SpreadsheetArchitect.to_rodf_spreadsheet(data: data, headers: headers)
 ```
 
 # Install
@@ -37,7 +43,6 @@ SpreadsheetArchitect.to_csv(data: data, header: false)
 gem install spreadsheet_architect
 ```
 
-
 # Class/Model Setup
 
 ### Model
@@ -162,7 +167,7 @@ end
 |**headers**|Boolean|`true`|Pass false to skip the header row.|
 |**sheet_name**|String|Class name||
 |**header_style**|Hash|`{background_color: "AAAAAA", color: "FFFFFF", align: :center, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false}`||
-|**row_style**|Hash|`{background_color: nil, color: "FFFFFF", align: :left, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false}`|Styles for non-header rows.|
+|**row_style**|Hash|`{background_color: nil, color: "FFFFFF", align: :left, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false, number_format_code: nil}`|Styles for non-header rows.|
   
 <br>
 #### `.to_ods` - (on custom class/model)
@@ -191,7 +196,7 @@ end
 |**headers**|Array|`false`|2D Array of data for the header rows cells. Pass false to skip the header row.|
 |**sheet_name**|String|`SpreadsheetArchitect`||
 |**header_style**|Hash|`{background_color: "AAAAAA", color: "FFFFFF", align: :center, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false}`||
-|**row_style**|Hash|`{background_color: nil, color: "FFFFFF", align: :left, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false}`|Styles for non-header rows.|
+|**row_style**|Hash|`{background_color: nil, color: "FFFFFF", align: :left, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false, number_format_code: nil}`|Styles for non-header rows.|
   
 <br> 
 #### `SpreadsheetArchitect.to_ods`
@@ -211,7 +216,6 @@ end
 |**headers**|Array|`false`|2D Array of data for the header rows cells. Pass false to skip the header row.|
 
 
-
 # Change model default method options
 ```ruby
 class Post
@@ -244,6 +248,23 @@ SpreadsheetArchitect.module_eval do
 end
 ```
 
+# Format all numbers, money, or currency in xlsx only
+
+Unfortunately so far I have only been successful in applying the format_code to all numbers in the entire spreadsheet.
+
+```
+# Ex. dollar sign, comma's, and minumum two decimal places
+Product.to_xlsx(headers: headers, data: data, number_format_code: "$#,##0.00")
+```
+
+# TODO
+
+Would love for any help with new features for this projects. Some desired features are:
+
+- More ODS style options
+- Apply format codes to only certain columns (xlsx)
+- Add Columns styles (xlsx & ods)
+- Create multiple sheets (xlsx & ods)
 
 # Credits
 Created by Weston Ganger - @westonganger
@@ -251,4 +272,4 @@ Created by Weston Ganger - @westonganger
 Heavily influenced by the dead gem `acts_as_xlsx` by @randym but adapted to work for more spreadsheet types and plain ruby models.
 
 
-<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>
+<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="Buy Me A Coffee"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="Buy Me A Coffee"/></a>

data/lib/spreadsheet_architect.rb

@@ -203,7 +203,7 @@ module SpreadsheetArchitect
       end
     end
 
-    def to_ods(opts={})
+    def to_rodf_spreadsheet
       opts = SpreadsheetArchitect::Helpers.get_cell_data(opts, self)
       options = SpreadsheetArchitect::Helpers.get_options(opts, self)
 
@@ -259,10 +259,14 @@ module SpreadsheetArchitect
         end
       end
 
-      return spreadsheet.bytes
+      return spreadsheet
+    end
+    
+    def to_ods(opts={})
+      return to_rodf_spreadsheet(opts).bytes
     end
 
-    def to_xlsx(opts={})
+    def to_axlsx(which='sheet', opts={})
       opts = SpreadsheetArchitect::Helpers.get_cell_data(opts, self)
       options = SpreadsheetArchitect::Helpers.get_options(opts, self)
     
@@ -304,18 +308,28 @@ module SpreadsheetArchitect
 
       return package if options[:data].empty?
 
-      package.workbook.add_worksheet(name: options[:sheet_name]) do |sheet|
+      the_sheet = package.workbook.add_worksheet(name: options[:sheet_name]) do |sheet|
         if options[:headers]
           sheet.add_row options[:headers], style: package.workbook.styles.add_style(header_style)
         end
         
         options[:data].each do |row_data|
+          row_style.merge!(number_format_code) if opts[:row_style][:number_format_code]
           sheet.add_row row_data, style: package.workbook.styles.add_style(row_style), types: options[:types]
         end
       end
 
-      return package.to_stream.read
+      if which.to_sym == :sheet
+        return the_sheet
+      else
+        return package
+      end
     end
+
+    def to_xlsx(opts={})
+      return to_axlsx('package', opts).to_stream.read
+    end
+
   end
 
   extend SpreadsheetArchitect::ClassMethods

data/lib/spreadsheet_architect/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetArchitect
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreadsheet_architect
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Weston Ganger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx
@@ -153,6 +153,6 @@ signing_key:
 specification_version: 4
 summary: Spreadsheet Generator for ActiveRecord Models and Ruby Classes/Modules
 test_files:
-- test/database.yml
 - test/helper.rb
+- test/database.yml
 - test/tc_spreadsheet_architect.rb