docxgen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33216029e3163b1ccb7bfb7dbfe4511efb1978ce526d89b37e5b970ab4c9bc31
+  data.tar.gz: 7e688cae088640535ad46f016df63682e79d5ec4a51d73b18da02fd026bfefe8
+SHA512:
+  metadata.gz: 0df11f03ebd605943e971dd9431c52ff30268d93375255b6807e2d7f41b36626be09a1deec9a67ce36d9cd636e27f3925192a24e2b416470f18282876680d90d
+  data.tar.gz: a01a03568bee419fc6b0ba827cfe5cf7c2c53d76739a30bf357670a1ec4e628801b96f2915c37448dac5428253d212254af922e8950c4afc4c4e92e07e752f9e

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store
+
+# Libreoffice
+.~lock*
+
+# Spec tmp
+/spec/tmp/*
+!/spec/tmp/.keep

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,244 @@
+#
+# Copied from Rails official rubocop config, with minor changes
+#
+
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.4
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  # Exclude:
+    # - '**/templates/**/*'
+    # - '**/vendor/**/*'
+    # - 'actionpack/lib/action_dispatch/journey/parser.rb'
+    # - 'railties/test/fixtures/tmp/**/*'
+    # - 'actionmailbox/test/dummy/**/*'
+    # - 'actiontext/test/dummy/**/*'
+    # - '**/node_modules/**/*'
+    # - 'db/schema.rb'
+
+Performance:
+  Exclude:
+    - '**/test/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstArgumentIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - 'actionview/test/**/*.builder'
+    - 'actionview/test/**/*.ruby'
+    - 'actionpack/test/**/*.builder'
+    - 'actionpack/test/**/*.ruby'
+    - 'activestorage/db/migrate/**/*.rb'
+    - 'activestorage/db/update_migrate/**/*.rb'
+    - 'actionmailbox/db/migrate/**/*.rb'
+    - 'actiontext/db/migrate/**/*.rb'
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+  EnforcedStyle: spaces
+  IndentationWidth: 2
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/UnfreezeString:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+dist: trusty
+sudo: false
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+cache: bundler
+bundler_args: --jobs=2
+
+before_install:
+  - gem update --system
+
+script:
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# docxgen
+
+## 1.0.0
+
+- First release
+- Basic variables substitution support

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in docxgen.gemspec
+gemspec
+
+gem "docx", "~> 0.5"
+
+group :development, :test do
+  gem "rake", "~> 12.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop"
+  gem "rubocop-performance"
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    docxgen (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    docx (0.5.0)
+      nokogiri (~> 1.10, >= 1.10.4)
+      rubyzip (~> 2.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    rubyzip (2.3.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  docx (~> 0.5)
+  docxgen!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrey Viktorov
+
+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,108 @@
+# docxgen
+
+[![Build Status](https://travis-ci.org/4ndv/docxgen.svg?branch=master)](https://travis-ci.org/4ndv/docxgen)
+
+Docxgen is a Ruby library for templating docx files based on [ruby-docx](https://github.com/ruby-docx/docx).
+
+## Features
+
+- Validates if there is any variables without provided values
+- Supports arrays
+- Preserves formatting
+- Supports non-latin variable names (cyrillic, for example)
+
+## Requirements
+
+Ruby 2.4+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "docxgen"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install docxgen
+```
+
+## Usage
+
+### Variables
+
+Example of variables and corresponding hashes:
+
+```ruby
+# {{ hello }} => world
+
+{ hello: "world" }
+
+# {{ hello.world }} => wow
+
+{ hello: { world: "wow" } }
+
+# {{ array.0.name }} => Wow
+
+{ array: [ { name: "Wow" } ]}
+
+# {{ Привет.Мир }} => 123
+
+{ "Привет": { "Мир": "123" } }
+```
+
+### Reading file
+
+```ruby
+generator = Docxgen::Generator.new("template.docx")
+```
+
+### Rendering
+
+```ruby
+generator.render({ variable: "Value" }, remove_missing: true)
+```
+
+Options:
+
+`remove_missing` [default: true] - Replaces variables without provided values with empty string
+
+### Checking render results
+
+```ruby
+generator.valid? # Returns true if there is no errors
+
+puts generator.errors # Returns array of the errors
+```
+
+### Saving file
+
+```ruby
+generator.save("result.docx")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then 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).
+
+## TODO
+
+- Add error objects
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/4ndv/docxgen](https://github.com/4ndv/docxgen).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "docxgen"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docxgen.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/docxgen/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "docxgen"
+  spec.version       = Docxgen::VERSION
+  spec.authors       = ["Andrey Viktorov"]
+  spec.email         = ["andv@outlook.com"]
+
+  spec.summary       = "docxgen allows generating docx files based on templates with variables"
+  spec.homepage      = "https://github.com/4ndv/docxgen"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/4ndv/docxgen"
+  spec.metadata["changelog_uri"] = "https://github.com/4ndv/docxgen/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/docxgen.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "docxgen/version"
+require "docxgen/generator"
+require "docxgen/templates/parser"
+
+module Docxgen
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/docxgen/generator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "json"
+require "docx"
+
+module Docxgen
+  class Generator
+    attr_reader :doc
+
+    def initialize(document)
+      @doc = Docx::Document.open(document)
+      @errors = []
+      @rendered = false
+    end
+
+    def render(data, remove_missing: true)
+      raise "Already rendered" if @rendered
+
+      variables = JSON.parse(data.to_json, symbolize_names: true)
+
+      paragraphs = @doc.paragraphs + collect_table_paragraphs
+
+      paragraphs.each do |p|
+        p.each_text_run do |tr|
+          _, sub_errors = Templates::Parser.tr_substitute!(tr, variables, remove_missing: remove_missing)
+
+          @errors.push(*sub_errors)
+        end
+      end
+
+      @rendered = true
+
+      valid?
+    end
+
+    def errors
+      raise "Wasn't rendered" unless @rendered
+
+      @errors
+    end
+
+    def valid?
+      errors.size.zero?
+    end
+
+    def save(to)
+      raise "Wasn't rendered" unless @rendered
+
+      @doc.save(to)
+    end
+
+    private
+
+      def collect_table_paragraphs
+        # TODO: Refactor, maybe?
+
+        @doc
+          .tables
+          .map(&:rows).flatten
+          .map(&:cells).flatten
+          .map(&:paragraphs).flatten
+      end
+  end
+end

data/lib/docxgen/templates/parser.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Docxgen
+  module Templates
+    class Parser
+      VARIABLE_REGEX = /({{[[:space:]]?(([[:alpha:]]|_)+([[:alnum:]]|_|\.)*(?<!\.))[[:space:]]?}})/
+
+      def self.tr_substitute!(tr, data, remove_missing: true)
+        found_variables = self.find_variables(tr)
+
+        errors = []
+
+        found_variables.each do |var|
+          value = data.dig(*var[:path])
+
+          errors.push("No value provided for variable: #{var[:src]}") if value.nil?
+
+          next if value.nil? && !remove_missing # Don't replace variables with empty string if remove_missing is false
+
+          tr.substitute(var[:src], value || "")
+        end
+
+        [tr, errors]
+      end
+
+      def self.find_variables(tr)
+        tr.to_s.scan(VARIABLE_REGEX).map do |match|
+          src, path, *_ = match
+
+          {
+            src: src,
+            path: path.split(".").reject(&:empty?).map do |p|
+              Integer(p) rescue next p.to_sym
+
+              p.to_i
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/docxgen/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Docxgen
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: docxgen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Viktorov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-11 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- andv@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docxgen.gemspec
+- lib/docxgen.rb
+- lib/docxgen/generator.rb
+- lib/docxgen/templates/parser.rb
+- lib/docxgen/version.rb
+homepage: https://github.com/4ndv/docxgen
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/4ndv/docxgen
+  source_code_uri: https://github.com/4ndv/docxgen
+  changelog_uri: https://github.com/4ndv/docxgen/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: docxgen allows generating docx files based on templates with variables
+test_files: []