rubyxls 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 916fc2dfc59c54e0b7b0418f704e98d5c5b82035
-  data.tar.gz: 632abe4a09d98fc68e92e98517898d20a12b5593
+  metadata.gz: eb3630d44053544b4a5943ee6f3ffb26e21bddae
+  data.tar.gz: 89bb16cdd9d467525549d901937aa3747b1c3d11
 SHA512:
-  metadata.gz: 88ccdab6fe99bd83a28fccc9b6d48eb8b7c644be8cd50067fa7787b3d42f99864f154349223e0db6ba61eb0b39474a7863cdc6ad3ac30bf6b6ed383f084857b0
-  data.tar.gz: e099d55019ad9074bc82a6b8b30ea071f94d589c706512b2cb154b25999d2fc5e886cd91bc6b524cd9184ecab54b403b981c9c9bc1f55bdf83c5e46a70789365
+  metadata.gz: 26a1793e58dbb39221afd293339a1eb0b59b1a5e226347b878448492c3f6c21d8ac03a62f3b73f79ef57db40197aed12de95bd4a69067e62452b0880edfff6e6
+  data.tar.gz: 6782d5f75f510bee6af778b092bcb9753ab1aa5e8c6e47481760e9b17e0d37596ba2657b7ae983a0afb89cf718bb529ddf37b02cc195cfa1c478e9f357f1cd5f

data/README.md

@@ -1,8 +1,13 @@
+[![CircleCI](https://circleci.com/gh/viewthespace/rubyxls.svg?style=svg)](https://circleci.com/gh/viewthespace/rubyxls) [![Code Climate](https://codeclimate.com/repos/576ddc37553f02006c008f07/badges/718e1d902d9467fa7145/gpa.svg)](https://codeclimate.com/repos/576ddc37553f02006c008f07/feed)
+
 # Rubyxls
 
-Generate XLS files using ruby. Rubyxls provides a simple DSL :o express anything from simple ruby strings to complex Active Record models.
+Generate XLS files using ruby. Rubyxls provides a simple DSL to express anything from simple ruby strings to complex Active Record models.
 Support for multi-sheet workbooks, chart generation, and formula based cells included.
 
+**This would not have been possible without the hard work of the Axlsx team. Thanks for creating the foundation
+that Rubyxls is built on top of! Please be sure to check out their repo here: https://github.com/randym/axlsx.**
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -55,8 +60,8 @@ class YourVeryOwnReport < Rubyxls::Report
   end
 end
 ```
-- **Inherit from Rubyxls::Report** - this will give you all the functionality a report needs to build itself.
-- **Call super() in #initialize** - this will create an instance variable `@workbooks` to hold all of the beautfiul workbooks you are about to create!
+- **Extend `Rubyxls::Report`** - this will give you all the functionality a report needs to build itself.
+- **Call `super()` in `#initialize`** - this will create an instance variable `@workbooks` to hold all of the beautfiul workbooks you are about to create!
 - **#build_workbooks!** - append any workbooks that you create into `@workbooks` so that your report "has_many" workbooks just like the real excel!
 
 #### Workbook
@@ -76,8 +81,8 @@ class YourVeryOwnWorkbook < Rubyxls::Workbook
 
 end
 ```
-- **Inherit from Rubyxls::Workbook** - get all of that groovy (not the programming language) functionality that Rubyxls gives your Workbook.
-- **Call super() in #initialize passing in a "name" parameter** - this will create an instance variable `@sheets` to hold all of your sheets and will name the workbook you are creating.
+- **Extend `Rubyxls::Workbook`** - get all of that groovy (not the programming language) functionality that Rubyxls gives your Workbook.
+- **Call `super()` in `#initialize` passing in a "`name`" parameter** - this will create an instance variable `@sheets` to hold all of your sheets and will name the workbook you are creating.
 - **#build_sheets!** - append any sheets that you create into `@sheets` so that your workbook "has_many" sheets!
 
 #### Sheet
@@ -98,8 +103,8 @@ class YourVeryOwnSheet < Rubyxls::Sheet
 
 end
 ```
-- **Inherit from Rubyxls::Sheet** - gotta get that sheet functionality
-- **Call super() in #initialize passing in a "name" parameter** - this will give your sheet a name
+- **Extend `Rubyxls::Sheet`** - gotta get that sheet functionality
+- **Call `super()` in `#initialize` passing in a "`name`" parameter** - this will give your sheet a name
 - **#build_cells!** - this is the dumping ground for all of your data. The CellBuilder, which takes in a view model as a parameter will break apart your view models / tables into invidual
 cells and organize them properly. Don't forget to specify where on the sheet you would like your view models to be drawn using `start_row` and `start_column`!
 Behind the scenes, we are taking all of your modularized view models, breaking them apart into individual cells, throwing all of those cells into one LARGE pot and re-arranging them in the
@@ -111,7 +116,7 @@ class YourVeryOwnViewModel < Rubyxls::ViewModel
 
   def initialize(whatever_data_you_need)
     @data = whatever_data_you_need
-    super()                             # Call #super passing in no parameters
+    super() # Call #super passing in no parameters
   end
 
   private
@@ -124,9 +129,9 @@ class YourVeryOwnViewModel < Rubyxls::ViewModel
 
 end
 ```
-- **Inherit from Rubyxls::ViewModel**
-- **Call super() in #initialize passing**
-- **#build_data_rows!** - this is where you decide what data goes into the workbook and how it looks. Let's break it down by describing the ruby version of each excel component that makes up a row.
+- **Extend `Rubyxls::ViewModel`**
+- **Call `super()` in `#initialize`**
+- **`#build_data_rows!`** - this is where you decide what data goes into the workbook and how it looks. Let's break it down by describing the ruby version of each excel component that makes up a row.
   ```
   | Ruby  | Excel | Desciption                                             |
   | -----  -------  ------------------------------------------------------ |
@@ -143,6 +148,21 @@ end
   ```
   A list of default styles is provided below!
 
+
+#### Generating a report file
+
+  Once a `Report` object and all of its associated components are initialized, generating an output file is straightforward.
+
+  `Rubyxls::Report#download!` returns an IO stream that can be written to a file.
+
+  If a `Report` has more than one workbook, the generated output file will be a `zip` file (containing multiple spreadsheets) instead of an `xslx` (Excel) file. The `#file_extension` method will return the expected file extension for the file.
+
+````ruby
+File.open("myfile.#{my_report.file_extension}", 'w') do |f|
+  f << report.download!.read
+end
+````
+
 ### Styling
 #### Default Styles
 - :bold
@@ -157,10 +177,10 @@ end
 - :bottom_align
 - :middle_align
 - :border_right
-- :boder_left
-- :boder_top
-- :boder_bottom
-- :boder_all
+- :border_left
+- :border_top
+- :border_bottom
+- :border_all
 - :number
 - :decimal
 - :date
@@ -191,8 +211,8 @@ class YourVeryOwnCustomStyleManager < Rubyxls::StyleManager
 
 end
 ```
-- **Inherit from Rubyxls::StyleManager**
-- **Call super in #initialize passing** - in order to get all of those default styles that Rubyxls provides.
+- **Extend `Rubyxls::StyleManager`**
+- **Call `super` in `#initialize`** - in order to get all of those default styles that Rubyxls provides.
 - **#initialize_base_styles!** - define your own styles according the the excel specification. Each style only needs a set of attributes.
 
 Now you can apply your newly defined styles inside of any sheet.
@@ -218,7 +238,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/alexanderfrankel/rubyxls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/viewthespace/rubyxls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/rubyxls/version.rb

@@ -1,3 +1,3 @@
 module Rubyxls
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/rubyxls.gemspec

@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_runtime_dependency "axlsx", "~> 2.0.1"
+  spec.add_runtime_dependency "axlsx", "~> 2.0"
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyxls
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Alexander Frankel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '2.0'
 description: |-
   Generate XLS files using ruby. Rubyxls provides a simple DSL to
                             express anything from simple ruby strings to complex Active Record models.
@@ -120,9 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A simple DSL for generating XLS files in plain-old ruby.
 test_files: []
-has_rdoc: