portable-writers-spreadsheet 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2140b1eb7619ec9c3a073c36b8a48cf3685f49e401eae47672c8b99bec3ad6ac
+  data.tar.gz: a8119842484821bd55c9bcc174ec21280f1235c99c33185872b7c418463b3482
+SHA512:
+  metadata.gz: 05d0b5d8c3f5b833ce3b07577d20bd3cf9dca4b559047eb3d18848e7265e2eba2d7861f42973b36357249b77a16fa5fc6ed415c1c973d301fcfad6e92ad78ba5
+  data.tar.gz: 6374384f2f31ec4851d36dc0e3c011ede1364d073362d311b77b147ef0c4fade0d888ac29527b7b84f636ebb44e87b1fbd907a589d09549a05d8fa1a5a50aa28

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - '*.gemspec'
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 125
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -0,0 +1,24 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=55ab3825e20978c06f86c9a5aaaa414ad9cedc95f5ed1f11b84695e52e20b059
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0 (TBD)
+
+Initial implementation.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Blue Marble Payroll, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Portable Spreadsheet Writer
+
+[![Gem Version](https://badge.fury.io/rb/portable-writers-spreadsheet.svg)](https://badge.fury.io/rb/portable-writers-spreadsheet) [![Build Status](https://travis-ci.org/bluemarblepayroll/portable-writers-spreadsheet.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/portable-writers-spreadsheet) [![Maintainability](https://api.codeclimate.com/v1/badges/3984ca34a23267b3ea0a/maintainability)](https://codeclimate.com/github/bluemarblepayroll/portable-writers-spreadsheet/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/3984ca34a23267b3ea0a/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/portable-writers-spreadsheet/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This library is a plugin for [Portable](https://github.com/bluemarblepayroll/portable) and provides a new document writer for rendering spreadsheets.  It currently is limited to Microsoft Excel Open XML Spreadsheets (.xlsx) and uses the library [fast_excel](https://github.com/Paxa/fast_excel) under the hood.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install portable-writers-spreadsheet
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add portable-writers-spreadsheet
+````
+
+## Examples
+
+See the main [Portable](https://github.com/bluemarblepayroll/portable) repository for examples.  The only difference is if you wish to use this library then render documents with Portable::Writers::Spreadsheet (instead of Portable::Writers::Csv).
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check portable-writers-spreadsheet.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/portable-writers-spreadsheet.git)
+4. Navigate to the root folder (cd portable-writers-spreadsheet)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````bash
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````bash
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````bash
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update `lib/portable-writers-spreadsheet/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/portable-writers-spreadsheet/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'bundler/setup'
+require 'portable/writers/spreadsheet'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/lib/portable/writers/spreadsheet.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'fast_excel'
+require 'portable'
+
+module Portable
+  module Writers
+    # Can write documents to an Excel file.
+    class Spreadsheet < Base
+      def write!(filename:, data_provider: Data::Provider.new, time: Time.now.utc)
+        raise ArgumentError, 'filename is required' if filename.to_s.empty?
+
+        ensure_directory_exists(filename)
+
+        workbook = FastExcel.open(filename, constant_memory: true)
+
+        document.sheets.map do |sheet|
+          data_source = data_provider.data_source(sheet.name)
+
+          worksheet = workbook.add_worksheet(sheet.name)
+
+          write_head(worksheet, sheet, data_source)
+          write_data_table(worksheet, sheet, data_source, time)
+          write_foot(worksheet, sheet, data_source)
+        end
+
+        workbook.close
+
+        time_in_seconds = 1.0
+
+        [Result.new(filename, time_in_seconds)]
+      end
+
+      private
+
+      def write_head(worksheet, sheet, data_source)
+        sheet.header_rows.each { |row| worksheet.append_row(row) }
+
+        data_source.header_rows.each { |row| worksheet.append_row(row) }
+      end
+
+      def write_data_table(worksheet, sheet, data_source, time)
+        row_renderer = sheet_renderer.row_renderer(sheet.name, data_source.fields)
+
+        worksheet.append_row(row_renderer.headers) if sheet.include_headers?
+
+        data_source.data_rows.each do |row|
+          worksheet.append_row(row_renderer.render(row, time).values)
+        end
+      end
+
+      def write_foot(worksheet, sheet, data_source)
+        data_source.footer_rows.each { |row| worksheet.append_row(row) }
+
+        sheet.footer_rows.each { |row| worksheet.append_row(row) }
+      end
+    end
+  end
+end

data/lib/portable/writers/spreadsheet/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'portable'
+
+module Portable
+  module Writers
+    class Spreadsheet < Base
+      VERSION = '1.0.0-alpha'
+    end
+  end
+end

data/portable-writers-spreadsheet.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require './lib/portable/writers/spreadsheet/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'portable-writers-spreadsheet'
+  s.version     = Portable::Writers::Spreadsheet::VERSION
+  s.summary     = 'Plugs in a spreadsheet writer for the Portable library'
+
+  s.description = <<-DESCRIPTION
+    Portable is a virtual document object modeling library that only contains basic writers by default.  This library extends Portable and adds a Spreadsheet Writer implementation.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir      = 'exe'
+  s.executables = []
+  s.homepage    = 'https://github.com/bluemarblepayroll/portable-writers-spreadsheet'
+  s.license     = 'MIT'
+  s.metadata    = {
+    'bug_tracker_uri' => 'https://github.com/bluemarblepayroll/portable-writers-spreadsheet/issues',
+    'changelog_uri' => 'https://github.com/bluemarblepayroll/portable-writers-spreadsheet/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/portable-writers-spreadsheet',
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => s.homepage
+  }
+
+  s.required_ruby_version = '>= 2.5'
+
+  s.add_dependency('fast_excel', '~>0.3')
+  s.add_dependency('portable', '=1.0.0-alpha.5')
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rake', '~> 13')
+  s.add_development_dependency('roo', '~> 2.8')
+  s.add_development_dependency('rspec', '~> 3.8')
+  s.add_development_dependency('rubocop', '~>0.88.0')
+  s.add_development_dependency('simplecov', '~>0.18.5')
+  s.add_development_dependency('simplecov-console', '~>0.7.0')
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: portable-writers-spreadsheet
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fast_excel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: portable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.alpha.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.alpha.5
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: "    Portable is a virtual document object modeling library that only
+  contains basic writers by default.  This library extends Portable and adds a Spreadsheet
+  Writer implementation.\n"
+email:
+- mruggio@bluemarblepayroll.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- exe/.gitkeep
+- lib/portable/writers/spreadsheet.rb
+- lib/portable/writers/spreadsheet/version.rb
+- portable-writers-spreadsheet.gemspec
+homepage: https://github.com/bluemarblepayroll/portable-writers-spreadsheet
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/bluemarblepayroll/portable-writers-spreadsheet/issues
+  changelog_uri: https://github.com/bluemarblepayroll/portable-writers-spreadsheet/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/portable-writers-spreadsheet
+  homepage_uri: https://github.com/bluemarblepayroll/portable-writers-spreadsheet
+  source_code_uri: https://github.com/bluemarblepayroll/portable-writers-spreadsheet
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Plugs in a spreadsheet writer for the Portable library
+test_files: []