excel_templating 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5456436639ebbd5a99cc15d6b20cd329ebf65dc3e72a0f478bf435ae8691f58c
+  data.tar.gz: 1e255a1c7d76652157b28fa1c5c40cf7a04b2b81e395f8b81268625531891c5e
+SHA512:
+  metadata.gz: d5d583cc68348314463f974f37cbfec702bde8e2e51756717dc8f5fe439cce2ef592d865655d8e325826c48322b7f181156dcd66ac8cc77576c1f0b1e0ee35b1
+  data.tar.gz: 2027fbc895ec3f659a39a48aaa5775cdf39b6709132d52413abe4d2b737ece0703fc2a806e48165dad0b6c7b372f19d01b05a4d53aab154cc95d18678d92640e

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.hound.yml

@@ -0,0 +1,261 @@
+# this is the default from hound's github, do not modify
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+AccessorMethodName:
+  Enabled: false
+
+ActionFilter:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+InlineComment:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 120
+  AllowURI: true
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+Next:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false

data/.rubocop.ph.yml

@@ -0,0 +1,44 @@
+# Older version
+Style/EmptyLinesAroundBody:
+  Enabled: false
+
+# Newer version (3 for the 1 above)
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+# Other
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/RedundantException:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+# PH Coding Rules
+Style/Blocks:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    detect: find
+
+# Github's PR width is 120 characters
+Metrics/LineLength:
+  Max: 120
+  AllowURI: true
+
+# Align with the style guide, we don't prefer anything
+Style/CollectionMethods:
+  Enabled: false

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+ - .rubocop.hound.yml
+ - .rubocop.ph.yml

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "excel_templating Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,8 @@
+### 0.3.0 / 2015-07-21
+
+* Adding feature to be able to lock specific row and/or column in the Excel document.
+
+### 0.1 / 2015-03-09
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+  gem 'rubocop'
+  gem 'byebug'
+  gem 'gemfury'
+end

data/LICENSE.txt

@@ -0,0 +1,3 @@
+Copyright (c) 2015 payrollhero
+
+CLOSED LICENSE

data/README.md

@@ -0,0 +1,133 @@
+# excel_templating
+
+* [Homepage](https://github.com/payrollhero/excel_templating)
+* [Documentation](http://rubydoc.info/gems/excel_templating/frames)
+* [Email](mailto:bramski at gmail.com)
+
+## Description
+
+A library that does excel templating using mustaching.
+
+## Features
+
+## Examples
+```ruby
+    require 'excel_templating'
+
+    class MyTemplate < ExcelTemplating::Document
+      template "my_template.mustache.xlsx")
+      title "My fancy report {{year}}"
+      organization "{{organization_name}}"
+      default_styling(
+        text_wrap: 0,
+        font: "Calibri",
+        size: 10,
+        align: :left,
+      )
+      sheet 1 do
+        repeat_row 17, with: :repeating_data
+
+        style_columns(
+          default: {
+            width: inches(1.98)
+          },
+          columns: {
+            3 => { width: inches(1.98) },
+            4 => { width: inches(1.98) },
+            5 => { width: inches(0.39) }
+          }
+        )
+      end
+    end
+```
+
+## Cell Validation
+You may validate that cells belong to a particular set of values 'dropdown'
+this is done by specifying data sources for your sheet and then referencing
+them in your template.
+``` ruby
+    class MyTemplate < ExcelTemplating::Document
+      template 'my_template.mustache.xlsx'
+
+      list_source :valid_foos, title: "Foos", list: ["foo", "bar"]
+      sheet 1 do
+        validate_cell row: 5, column: 1, with: :valid_foos
+        repeat_row 17, with :repeating_data do
+          validate_column 1, with: :valid_foos
+        end
+      end
+    end
+```
+
+The 'list' item may be an Array or :from_data, if it says :from_data, the list
+will be sourced from the same key in the 'all_sheets' data portion.
+
+The excel templater will add an additional sheet to your generated xls
+file called 'Data Sources' and 'foo' and 'bar' will be written to that sheet.
+If you don't want a sheet to be created, use inline: true to write the validation
+directly to the cell, NOTE there are limits on the size of the list
+you may write inline.
+
+## Protecting document
+You can specify locking for any row or column. By default all cells are marked as locked.
+Locking is applied when you call `protect_document` method.
+``` ruby
+    class MyTemplate < ExcelTemplating::Document
+      template 'my_template.mustache.xlsx'
+      default_styling locked: 0 # default set to not locked
+
+      list_source :valid_foos, title: "Foos", list: ["foo", "bar"]
+      sheet 1 do
+        validate_cell row: 5, column: 1, with: :valid_foos
+        repeat_row 17, with :repeating_data do
+          validate_column 1, with: :valid_foos
+        end
+
+        # Lets lock the first row
+        style_rows(
+          default: { },
+          rows: {
+            1 => { format: { locked: 1 } }
+          }
+        )
+      end
+
+      # add call `protect_document` to lock specified row
+      protect_document
+    end
+```
+
+## Rspec Excel Matching
+The library also adds an excel rspec matcher.
+```ruby
+    require 'excel_templating/rspec_excel_matcher'
+
+    describe MyTemplate do
+      subject { described_class.new }
+      it do
+        expect do
+          subject.render do |path|
+            expect(path).to match_excel_content('my_expected_file.xlsx')
+          end
+        end.not_to raise_error
+      end
+    end
+```
+
+## Deploying
+
+1. Update lib/excel_templating/version.rb
+2. Update ChangeLog.md
+3. Commit the 2 changed files with the version number
+5. Push this to git
+6. Run `rake release`
+
+## Install
+
+    $ gem install excel_templating
+
+## Copyright
+
+Copyright (c) 2015 payrollhero
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+require 'gemfury/tasks'
+
+require 'rubygems/tasks'
+Gem::Tasks.new(release: false)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task test: :spec
+task default: :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task doc: :yard
+
+task :release do
+  Rake::Task['fury:release'].invoke(nil, 'payrollhero')
+  Dir['*.gem'].each do |fn|
+    puts "Removing: #{fn}"
+    File.unlink(fn)
+  end
+end

data/excel_templating.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/excel_templating/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "excel_templating"
+  gem.version       = ExcelTemplating::VERSION
+  gem.summary       = "A library which allows you to slam data into excel files using mustaching."
+  gem.description   = "."
+  gem.license       = "MIT"
+  gem.authors       = ["bramski", "Mykola Kyryk"]
+  gem.email         = "bramski@gmail.com"
+  gem.homepage      = "https://github.com/payrollhero/excel_templating"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "mustache"
+  gem.add_dependency "roo", ">= 2.0.0beta1", "< 3"
+  gem.add_dependency "roo-xls"
+  gem.add_dependency "write_xlsx"
+  gem.add_dependency "writeexcel"
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rspec', '~> 3.3'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'yard', '~> 0.8'
+  gem.add_development_dependency 'rspec-its'
+end

data/lib/excel_templating/document/data_source_registry/registry_list.rb

@@ -0,0 +1,48 @@
+module ExcelTemplating
+  # Represents a data source list used for validation of cell information
+  class Document::DataSourceRegistry::RegistryList
+    # @param [Integer] order
+    # @param [Symbol] symbol
+    # @param [String] title
+    # @param [Array<String>|Symbol] list
+    # @param [TrueClass|FalseClass] inline
+    def initialize(order, symbol, title, list, inline)
+      @title = title
+      @list = list
+      @inline = inline
+      @order = order
+      @symbol = symbol
+      pre_validate!
+    end
+
+    attr_reader :title, :order, :symbol, :list
+
+    # @return [Boolean] Is this to be rendered inline?
+    def inline?
+      @inline
+    end
+
+    # @return [Boolean] Is this to be rendered on the data sheet?
+    def data_sheet?
+      !inline?
+    end
+
+    # @param [Hash] data The data object from which the document is being rendered
+    # @return [Array<String>] The validation objects
+    def items(data)
+      if list == :from_data
+        data[symbol]
+      else
+        list
+      end
+    end
+
+    private
+
+    def pre_validate!
+      unless list.is_a?(Array) || list == :from_data
+        raise ArgumentError, "List must be an array or :from_data"
+      end
+    end
+  end
+end

data/lib/excel_templating/document/data_source_registry/registry_renderer.rb

@@ -0,0 +1,74 @@
+module ExcelTemplating
+  # In charge of rendering the data source registry to the excel document
+  class Document::DataSourceRegistry::RegistryRenderer
+    def initialize(registry, data)
+      @registry = registry
+      @data = data
+    end
+
+    # @param [Symbol] source_symbol
+    # @return [Hash] Gives back a hash of options which adds the validation options for the symbol
+    def absolute_reference_for(source_symbol)
+      unless registry.has_registry?(source_symbol)
+        raise ArgumentError, "#{source_symbol} is not a defined data_source.  Defined data sources are " +
+              "#{registry.supported_registries}"
+      end
+      registry_info = registry[source_symbol]
+      validation_options_for(registry_info)
+    end
+
+    # Wrote this registry to the specified workbook.  Uses the sheet name 'DataSource'
+    # @param [ExcelAbstraction::Workbook] workbook
+    def write_sheet(workbook)
+      return unless registry.any_data_sheet_symbols?
+
+      data_sheet = workbook.add_worksheet(sheet_name)
+      registry.each do |registry_info|
+        write_data_source_to_sheet(data_sheet, registry_info)
+      end
+    end
+
+    private
+
+    attr_reader :data, :registry
+
+    def write_data_source_to_sheet(data_sheet, registry_info)
+      column_letter = RenderHelper.letter_for(registry_info.order)
+      data_sheet.write "#{column_letter}1", registry_info.title
+      registry_info.items(data).each_with_index do |item, item_index|
+        row_offset = item_index + 2
+        data_sheet.write("#{column_letter}#{row_offset}", item)
+      end
+    end
+
+    def validation_options_for(registry_info)
+      if registry_info.inline?
+        inline_validation_options(registry_info)
+      else
+        data_sheet_validation_options(registry_info)
+      end
+    end
+
+    def data_sheet_validation_options(registry_info)
+      row_letter = RenderHelper.letter_for(registry_info.order)
+      start_column = 2
+      end_column = registry_info.items(data).length + 1
+      list_validation(source: "#{sheet_name}!$#{row_letter}$#{start_column}:$#{row_letter}$#{end_column}")
+    end
+
+    def inline_validation_options(registry_info)
+      list_validation(source: registry_info.items(data).map(&:to_s))
+    end
+
+    def list_validation(source:)
+      {
+        validate: 'list',
+        source: source
+      }
+    end
+
+    def sheet_name
+      "DataSource"
+    end
+  end
+end