docx_generator 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24ad7dac74a46bba80074d78c61c3036b3edc4b0
-  data.tar.gz: 04ac19428d41ec7102c40f7906483b624f1c776b
+  metadata.gz: 1f32f9709d0ce194476a9904032ce4e06130f61e
+  data.tar.gz: 9b3dc472bb8ad9a5d4c080e29806c242507391d7
 SHA512:
-  metadata.gz: 1cae7f9f66f6db08762573726408bf48ec5133e59e67a27f75c757a5d2c03f53c173303714c639d8b5033638a8a1af1ac55db729a7188660550249d33738d301
-  data.tar.gz: bc8f8b9857b4e64168da542135aaab693bab4105b0ed28ddf06d2f8d3d3bdd0d9c3f6c8cc61bab214eeafd8e26e0f36e358d5b26dd6abe19e6f16f588e9c1060
+  metadata.gz: 353b0025fae8f672ca3077f0c26a2755019d0d24494d1eac247a68e3c63451621ae18d7e2ea54bcb03101f35f35196f4605760f1ccf376e0c6a2f8c571f87a65
+  data.tar.gz: ae2034b6683efba44a5cdfccafb8229d2f31476131a9b6703739c09e47c51da09c85f9bd35ee9882853093d3b0d2353c7a2ff80648d7b6b31596b11c0fce75a6

data/.gitignore

@@ -1,17 +1,18 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.docx

data/.rvmrc

@@ -1,60 +1,60 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 2.0.0" > .rvmrc
-environment_id="ruby-2.0.0-p0@docx_generator"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.20.5 (stable)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
-  do
-    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
-    then \. "${__hook}" || true
-    fi
-  done
-  unset __hook
-  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
-  then
-    if [[ $- == *i* ]] # check for interactive shells
-    then echo "Using: \E[32m$GEM_HOME\E[0m" # show the user the ruby and gemset they are using in green
-    else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
-    fi
-  fi
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
-# fi
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.0.0" > .rvmrc
+environment_id="ruby-2.0.0-p0@docx_generator"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.20.5 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then echo "Using: \E[32m$GEM_HOME\E[0m" # show the user the ruby and gemset they are using in green
+    else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in docx_generator.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docx_generator.gemspec
+gemspec

data/Guardfile

@@ -1,11 +1,11 @@
-guard 'bundler' do
-  watch('Gemfile')
-  watch(/^.+\.gemspec/)
-end
-
-guard :rspec, cli: "--color" do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
-
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cli: "--color" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2013 Antoine Proulx
-
-MIT License
-
-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.
+Copyright (c) 2013 Antoine Proulx
+
+MIT License
+
+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

@@ -1,49 +1,41 @@
-# DocxGenerator
-
-A gem to generate docx files.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'docx_generator'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install docx_generator
-
-## Usage
-
-To create a new docx file and save it, just type:
-
-```ruby
-require 'docx_generator'
-
-DocxGenerator::Document.new("filename").save # Will save the document to filename.docx
-```
-
-To create a paragraph and add formatted text to it:
-
-```ruby
-require 'docx_generator'
-
-document = DocxGenerator::Document.new("filename")
-document.add_paragraph("Simple string of text and", document.text("some formatted text", bold: true, italics: true)) # The fragments will be separated by a space when they will be rendered
-document.save
-```
-
-You can see more examples in the `examples` directory.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/557c5048ed09993a48f60e0aa0869ab3 "githalytics.com")](http://githalytics.com/magicienap/docx_generator)
+# DocxGenerator
+
+A gem to generate docx files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docx_generator'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install docx_generator
+```
+
+## Usage
+
+DocxGenerator can be used with blocks or without. See `examples/basic_document_with_block.rb` and `examples/basic_document_without_block.rb` for the basic usage.
+
+## Documentation
+
+The documentation can be found at [Rubydoc.info](http://rubydoc.info/github/magicienap/docx_generator/frames).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/557c5048ed09993a48f60e0aa0869ab3 "githalytics.com")](http://githalytics.com/magicienap/docx_generator)

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new
-
-task default: :spec
-task test: :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/docx_generator.gemspec

@@ -1,30 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'docx_generator/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "docx_generator"
-  spec.version       = DocxGenerator::VERSION
-  spec.authors       = ["Antoine Proulx"]
-  spec.email         = ["proulx.antoine@gmail.com"]
-  spec.description   = %q{A gem to generate docx files.}
-  spec.summary       = %q{A gem to generate docx files.}
-  spec.homepage      = "http://magicienap.github.io/docx_generator"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-  
-  spec.add_runtime_dependency "zipruby"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-bundler"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "libnotify"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docx_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docx_generator"
+  spec.version       = DocxGenerator::VERSION
+  spec.authors       = ["Antoine Proulx"]
+  spec.email         = ["proulx.antoine@gmail.com"]
+  spec.description   = %q{A gem to generate docx files.}
+  spec.summary       = %q{A gem to generate docx files.}
+  spec.homepage      = "http://magicienap.github.io/docx_generator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_runtime_dependency "rubyzip"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "libnotify"
+  spec.add_development_dependency "yard"
+
+  if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+    spec.add_development_dependency "wdm"
+    spec.add_development_dependency "win32console"
+  end
+end

data/examples/basic_document_with_blocks.rb

@@ -0,0 +1,37 @@
+require 'docx_generator'
+
+DocxGenerator::DSL::Document.new("basic_paragraph") do |doc|
+  doc.paragraph do |par|
+    par.alignment :center
+    par.text "Title", underline: { style: "double" }, size: 20
+    # par.newline
+  end
+
+  doc.paragraph do |par|
+    par.text "Simple string of text and"
+    par.text "some formatted text" do |t|
+      t.bold true
+      t.italics true
+      t.underline style: "single"
+    end
+  end
+
+  doc.paragraph do |par|
+    par.text "Antoine", bold: true
+    par.text "How are you today?"
+  end
+
+  doc.paragraph do |par|
+    par.text "John", bold: true
+    par.text "(whispering)", bold: true, italics: true
+    par.text "How are you today?"
+  end
+
+  doc.paragraph(alignment: :center) do |par|
+    par.text "A simple chemical formula: CO"
+    par.no_space
+    par.text "2", subscript: true
+  end
+  
+  doc.save
+end