docx_generator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f32f9709d0ce194476a9904032ce4e06130f61e
-  data.tar.gz: 9b3dc472bb8ad9a5d4c080e29806c242507391d7
+  metadata.gz: 9bc3cbf1c52c84cee2dd817473aa0a8882dcf549
+  data.tar.gz: ef2326f448ea1e8c8fad204e93cafe18df284a1e
 SHA512:
-  metadata.gz: 353b0025fae8f672ca3077f0c26a2755019d0d24494d1eac247a68e3c63451621ae18d7e2ea54bcb03101f35f35196f4605760f1ccf376e0c6a2f8c571f87a65
-  data.tar.gz: ae2034b6683efba44a5cdfccafb8229d2f31476131a9b6703739c09e47c51da09c85f9bd35ee9882853093d3b0d2353c7a2ff80648d7b6b31596b11c0fce75a6
+  metadata.gz: 2ffef6f8f98d48635e29c18438696bf5c688cf90b1d37762b3632215ffe496f27e7ae5f36ce9fbcc81a74c660194f8dc6f8895ec56cb0f7f96c698f815b34edd
+  data.tar.gz: cdb04b317c6715a0ce40ed8172e916a9812c7377ee665bb08252d53c1f75a0eddde2d77716dd3b54aec32a8be630a4c064920314f2c0b0f7b71876ce94000d6a

data/.gitignore

@@ -1,18 +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
-*.docx
+*.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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in docx_generator.gemspec
-gemspec
+source 'https://rubygems.org'
+
+ruby "2.0.0"
+
+# 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,41 +1,41 @@
-# 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)
+# 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,36 +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 "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
+# 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", '>= 1'
+
+  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

@@ -1,37 +1,41 @@
-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
+require 'docx_generator'
+
+DocxGenerator::DSL::Document.new("basic_paragraph") do |doc|
+  doc.paragraph do |par|
+    par.alignment :center
+    par.text "Title" do |t|
+      t.underline style: "double"
+      t.size 20
+      t.caps true
+    end
+    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, small_caps: true
+    par.text "How are you today?"
+  end
+
+  doc.paragraph do |par|
+    par.text "John", bold: true, small_caps: 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

data/examples/basic_document_without_blocks.rb

@@ -1,10 +1,10 @@
-require 'docx_generator'
-include DocxGenerator::DSL
-
-doc = Document.new("basic_paragraph")
-doc.add Paragraph.new(alignment: "center").add(Text.new("Title", underline: { style: "double" }, size: 20))#, DocxGenerator::Word::Extensions::Newline.new)
-doc.add Paragraph.new.add(Text.new("Simple string of text and"), Text.new("some formatted text"), bold: true, italics: true, underline: { style: "single" })
-doc.add Paragraph.new.add(Text.new("Antoine", bold: true), Text.new("How are you today?"))
-doc.add Paragraph.new.add(Text.new("John", bold: true), Text.new("(whispering)", bold: true, italics: true), Text.new("How are you today"))
-doc.add Paragraph.new(alignment: "center").add(Text.new("A simple chemical formula: CO"), DocxGenerator::Word::Extensions::NoSpace.new, Text.new("2", subscript: true))
+require 'docx_generator'
+include DocxGenerator::DSL
+
+doc = Document.new("basic_paragraph")
+doc.add Paragraph.new(alignment: "center").add(Text.new("Title", underline: { style: "double" }, size: 20, caps: true), DocxGenerator::Word::Extensions::Newline.new)
+doc.add Paragraph.new.add(Text.new("Simple string of text and"), Text.new("some formatted text"), bold: true, italics: true, underline: { style: "single" })
+doc.add Paragraph.new.add(Text.new("Antoine", bold: true, small_caps: true), Text.new("How are you today?"))
+doc.add Paragraph.new.add(Text.new("John", bold: true, small_caps: true), Text.new("(whispering)", bold: true, italics: true), Text.new("How are you today"))
+doc.add Paragraph.new(alignment: "center").add(Text.new("A simple chemical formula: CO"), DocxGenerator::Word::Extensions::NoSpace.new, Text.new("2", subscript: true))
 doc.save

data/generators.thor

@@ -0,0 +1,10 @@
+class Generate < Thor
+
+  desc "word_base", "Generate the word/base.rb file with its spec file."
+  def word_base
+    require './generators/word_base'
+
+    invoke 'word_base:code'
+    invoke 'word_base:spec'
+  end
+end

data/generators/word_base.rb

@@ -0,0 +1,106 @@
+# I should test my code generator!
+class WordBase < Thor
+  include Thor::Actions
+
+  # Data structure
+  # An array of elements
+  # Each element can have up to 4 properties
+  # - class: The name of the Ruby class (required)
+  # - element: The name of the element in the specification.
+  #   If not provided, then it is the class name in lowercase
+  # - attributes: Wheter it should accept attributes or not (default: true)
+  # - content: Wheter it should accept content
+
+  @@elements = [
+    { class: "Document" },
+    { class: "Body", attributes: false },
+    { class: "Paragraph", element: "p" },
+    { class: "ParagraphProperties", element: "pPr", attributes: false },
+    { class: "Run", element: "r" },
+    { class: "RunProperties", element: "rPr", attributes: false },
+    { class: "Text", element: "t" },
+    { class: "Break", element: "br", content: false }
+  ]
+
+  def self.root
+    File.expand_path('.')
+  end
+
+  desc "code", "Generate the implementation code."
+  def code
+    # Change that to be a template (ERB?) with helpers
+    code =  "# Warning: This file has been automatically generated from generator/word_base.rb.\n" +
+            "# It should not be edited by hand. Instead, modify the code generator.\n" +
+            "\n" +
+            "module DocxGenerator\n" +
+            "  module Word\n"
+
+    @@elements.each do |element|
+      element = normalize(element)
+
+      code += "    # Represent the `#{element[:element]}` element from Office Open XML specification. This class should not be used directly by the users of the library.\n" +
+              "    class #{element[:class]} < Element\n" +
+              "      # Create a new `#{element[:element]}` XML element.\n"
+
+      if element[:attributes]
+        code += "      # @param attributes [Hash] The attributes of the XML element. Check the specification of the `#{element[:element]}` element for the possible attributes.\n"
+      end
+      if element[:content]
+        code += "      # @param content [Array] An array of the children of the XML element (other XML elements).\n"
+      end
+
+      code += "      def initialize("
+      code += "attributes = {}" if element[:attributes]
+      code += ", " if element[:attributes] && element[:content]
+      code += "content = []" if element[:content]
+      code += ")\n"
+
+      code += "        super(\"#{element[:element]}\""
+      code += element[:attributes] ? ", attributes" : ", {}"
+      code += ", content" if element[:content]
+      code += ")\n"
+      code += "      end\n"
+
+      code += "    end\n\n"
+    end
+
+    code += "  end\n"
+    code += "end"
+
+    create_file "lib/docx_generator/word/base.rb", code
+  end
+
+  desc "spec", "Generate the tests."
+  def spec
+    code  = "require 'spec_helper'\n\n"
+
+    @@elements.each do |element|
+      element = normalize(element)
+
+      code += "describe DocxGenerator::Word::#{element[:class]} do\n" +
+              "  it \"should render a #{element[:element]} element\" do\n"
+
+      code += "    DocxGenerator::Word::#{element[:class]}.new.to_s.should eq('<#{element[:element]} />')\n"
+      if element[:content]
+        code += "    DocxGenerator::Word::#{element[:class]}.new("
+        code += "{}, " if element[:attributes]
+        code += "[\"Text\"]).to_s.should eq('<#{element[:element]}>Text</#{element[:element]}>')\n"
+      end
+
+      code += "  end\n" +
+              "end\n\n"
+    end
+
+    create_file "spec/docx_generator/word/base_spec.rb", code
+  end
+
+  private
+    # Add default values to the element
+    def normalize(element)
+      base = { attributes: true, content: true }
+      new_element = base.merge(element)
+      new_element[:element] = new_element[:class].downcase if new_element[:element].nil?
+      new_element[:element] = "w:" + new_element[:element]
+      return new_element
+    end
+end