openxml-docx 0.8.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c77fba73aae87283550220c6d7280217775712e1
+  data.tar.gz: 208f20c30d545a257a58e6a2b4faec8a585bee92
+SHA512:
+  metadata.gz: 300b5cb3789fa19a67b760dbdc654fe1fb3f9953913f25c2722966559e7c22fbeb0072b37057cb0251cf8fa014b3b27d5cf76e8d30c8e9778b83141cd4dcfaa5
+  data.tar.gz: 9c9be7e6653c7fb60331a0e14be73e4d84c5fe191ac8a7db5475996c16b34132976598b38c7373d9230e94ac16f59ade2138a084d43eff3804100d14b82a9eca

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+rocx-0.1.0.gem
+*.gem
+.rspec-local
+/coverage
+TODO.md

data/.travis.yml

@@ -0,0 +1,6 @@
+# .travis.yml
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    openxml-docx (0.8.0.beta1)
+      nokogiri
+      open_xml_package (= 0.1.0.beta1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.9)
+    diff-lcs (1.2.5)
+    method_source (0.8.1)
+    mini_portile (0.6.2)
+    multi_json (1.7.2)
+    nokogiri (1.6.6.4)
+      mini_portile (~> 0.6.0)
+    open_xml_package (0.1.0.beta1)
+      nokogiri
+      rubyzip (~> 1.1.0)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rr (1.1.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubyzip (1.1.7)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.4)
+    timecop (0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  openxml-docx!
+  pry
+  rake
+  rr
+  rspec
+  simplecov
+  timecop
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Gene Doyel
+
+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,67 @@
+# OpenXml::Docx [![Code Climate](https://codeclimate.com/github/openxml/openxml-docx.png)](https://codeclimate.com/github/openxml/openxml-docx)
+
+OpenXml::Docx is a gem for creating .docx (Office Open XML) files. It's designed to validate _before_ the document is generated, so (hopefully) any errors are caught prior to opening the file using software that can handle OOXML (like Microsoft Word, Apache Open Office, Google Docs, etc).
+
+An example:
+
+```ruby
+require "openxml/docx"
+
+text = OpenXml::Docx::Elements::Text.new("Some text that I want to include in my new OOXML document")
+run = OpenXml::Docx::Elements::Run.new
+run.bold = true
+run << text
+paragraph = OpenXml::Docx::Elements::Paragraph.new
+paragraph << run
+
+document = OpenXml::Docx::Package.new
+document.document << paragraph
+document.save("/path/where/i/save/things/test.docx")
+```
+
+## Installation
+
+You can install OpenXml::Docx by running `gem install openxml-docx`, or if you like Rails, include `gem "openxml-docx"` in your Gemfile.
+
+## Current features
+
+  - Paragraphs
+  - Runs and text
+  - Formatting and styles for the paragraphs, runs, and text
+
+## Roadmap
+
+It's important to note that lists goes off into the future quite a bit, therefore it's very likely that it will change. That being said, this is the plan for future releases:
+
+  - 0.7.0: Sections
+  - 0.8.0: Increased support for styles and fonts
+  - 0.9.0: Images and movies
+  - 0.10.0: Numbering and lists
+  - 0.11.0: Headers and footers
+  - 0.12.0: Footnotes and endnotes
+  - 0.13.0: Glossary documents
+  - 0.14.0: Annotations
+  - 0.15.0: Increased support for document-level settings
+  - 0.16.0: Tables
+  - 0.17.0: Embedded custom markup
+  - 0.18.0: Fields and hyperlinks
+  - 0.19.0: Mail merge
+  - 0.20.0: Layer on a DSL for making the whole thing smoother
+
+## Contribute!
+
+Want to help? Thanks, friend! Here's how:
+
+  1. Fork it
+  2. Make your changes on a topic branch
+  3. Create new a pull request
+  4. Receive many thank-yous
+
+## Changelog
+
+  - 0.6.0: Added additional run content
+  - 0.5.8: Added run properties
+  - 0.5.7: Added paragraph properties
+  - 0.5.0: First version with document content (i.e. paragraphs)
+  - 0.4.0: Rudimentary support for styles
+  - 0.3.0: First version supporting outputting in target format

data/Rakefile

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

data/example

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+# require "rails" # workaround: openxml-package uses `extract_options!`
+$:.push Dir.pwd + "/lib"
+require "openxml/docx"
+
+document = OpenXml::Docx::Package.new
+
+include OpenXml::Docx::Elements
+
+text = Text.new("Some text that I want to include in my new OOXML document")
+
+run = Run.new
+run << text
+paragraph = Paragraph.new
+paragraph << run
+
+document.document << paragraph
+
+filename = "gemtest1.docx"
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+document.save File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/lib/openxml-docx.rb

@@ -0,0 +1 @@
+require "openxml/docx"

data/lib/openxml/docx.rb

@@ -0,0 +1,20 @@
+module OpenXml
+  module Docx
+    REL_DOCUMENT = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument".freeze
+    REL_STYLES = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles".freeze
+    REL_SETTINGS = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings".freeze
+
+    TYPE_STYLES = "application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml".freeze
+    TYPE_SETTINGS = "application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml".freeze
+    TYPE_XML = "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml".freeze
+  end
+end
+
+require "openxml/docx/attribute_builder"
+require "openxml/docx/property_builder"
+require "openxml/docx/properties"
+require "openxml/docx/elements"
+require "openxml/docx/package"
+require "openxml/docx/parts"
+require "openxml/docx/section"
+require "openxml/docx/style"

data/lib/openxml/docx/attribute_builder.rb

@@ -0,0 +1,298 @@
+module OpenXml
+  module Docx
+    module AttributeBuilder
+
+      VALID_THEME_COLORS = %i(accent1 accent2 accent3 accent4 accent5 accent6 background1 background2 dark1 dark2 followedHyperlink hyperlink light1 light2 none text1 text2)
+
+      VALID_TYPES = %i(apples
+                       archedScallops
+                       babyPacifier
+                       babyRattle
+                       balloons3Colors
+                       balloonsHotAir
+                       basicBlackDashes
+                       basicBlackDots
+                       basicBlackSquares
+                       basicThinLines
+                       basicWhiteDashes
+                       basicWhiteDots
+                       basicWhiteSquares
+                       basicWideInline
+                       basicWideMidline
+                       basicWideOutline
+                       bats
+                       birds
+                       birdsFlight
+                       cabins
+                       cakeSlice
+                       candyCorn
+                       celticKnotwork
+                       certificateBanner
+                       chainLink
+                       champagneBottle
+                       checkedBarBlack
+                       checkedBarColor
+                       checkered
+                       christmasTree
+                       circlesLines
+                       circlesRectangles
+                       classicalWave
+                       clocks
+                       compass
+                       confetti
+                       confettiGrays
+                       confettiOutlines
+                       confettiStreamers
+                       confettiWhite
+                       cornerTriangles
+                       couponCutoutDashes
+                       couponCutoutDots
+                       crazyMaze
+                       creaturesButterfly
+                       creaturesFish
+                       creaturesInsects
+                       creaturesLadyBug
+                       crossStitch
+                       cup
+                       custom
+                       dashDotStroked
+                       dashed
+                       dashSmallGap
+                       decoArch
+                       decoArchColor
+                       decoBlocks
+                       diamondsGray
+                       dotDash
+                       dotDotDash
+                       dotted
+                       double
+                       doubleD
+                       doubleDiamonds
+                       doubleWave
+                       earth1
+                       earth2
+                       earth3
+                       eclipsingSquares1
+                       eclipsingSquares2
+                       eggsBlack
+                       fans
+                       film
+                       firecrackers
+                       flowersBlockPrint
+                       flowersDaisies
+                       flowersModern1
+                       flowersModern2
+                       flowersPansy
+                       flowersRedRose
+                       flowersRoses
+                       flowersTeacup
+                       flowersTiny
+                       gems
+                       gingerbreadMan
+                       gradient
+                       handmade1
+                       handmade2
+                       heartBalloon
+                       heartGray
+                       hearts
+                       heebieJeebies
+                       holly
+                       houseFunky
+                       hypnotic
+                       iceCreamCones
+                       inset
+                       lightBulb
+                       lightning1
+                       lightning2
+                       mapleLeaf
+                       mapleMuffins
+                       mapPins
+                       marquee
+                       marqueeToothed
+                       moons
+                       mosaic
+                       musicNotes
+                       nil
+                       none
+                       northwest
+                       outset
+                       ovals
+                       packages
+                       palmsBlack
+                       palmsColor
+                       paperClips
+                       papyrus
+                       partyFavor
+                       partyGlass
+                       pencils
+                       people
+                       peopleHats
+                       peopleWaving
+                       poinsettias
+                       postageStamp
+                       pumpkin1
+                       pushPinNote1
+                       pushPinNote2
+                       pyramids
+                       pyramidsAbove
+                       quadrants
+                       rings
+                       safari
+                       sawtooth
+                       sawtoothGray
+                       scaredCat
+                       seattle
+                       shadowedSquares
+                       shapes1
+                       shapes2
+                       sharksTeeth
+                       shorebirdTracks
+                       single
+                       skyrocket
+                       snowflakeFancy
+                       snowflaskes
+                       sombrero
+                       southwest
+                       stars
+                       stars3d
+                       starsBlack
+                       starsShadowed
+                       starsTop
+                       sun
+                       swirligig
+                       thick
+                       thickThinLargeGap
+                       thickThinMediumGap
+                       thickThinSmallGap
+                       thinThickLargeGap
+                       thinThickMediumGap
+                       thinThickSmallGap
+                       thinThickThinLargeGap
+                       thinThickThinMediumGap
+                       thinThickThinSmallGap
+                       threeDEmboss
+                       threeDEngrave
+                       tornPaper
+                       tornPaperBlack
+                       trees
+                       triangle1
+                       triangle2
+                       triangleCircle1
+                       triangleCircle2
+                       triangleParty
+                       triangle
+                       triple
+                       twistedLines1
+                       twistedLines2
+                       vine
+                       wave
+                       waveline
+                       weavingAngles
+                       weavingBraid
+                       weavingRibbon
+                       weavingStrips
+                       whiteFlowers
+                       woodwork
+                       xIllusions
+                       zanyTriangles
+                       zigZag
+                       zigZagStitch)
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def attribute(name, expects: nil, displays_as: nil, namespace: nil)
+          bad_names = %w(tag name namespace properties_tag)
+          raise ArgumentError if bad_names.member? name
+
+          attr_reader name
+
+          define_method "#{name}=" do |value|
+            send(expects, value)
+            instance_variable_set "@#{name}", value
+          end
+
+          camelized_name = name.to_s.gsub(/_([a-z])/i) { $1.upcase }.to_sym
+          attributes[name] = [displays_as || camelized_name, namespace || :w]
+        end
+
+        def attributes
+          @attributes ||= {}
+        end
+      end
+
+      def render?
+        attributes.keys.map(&method(:send)).any?
+      end
+
+      def attributes
+        self.class.attributes
+      end
+
+    private
+
+      def xml_attributes
+        attributes.each_with_object({}) do |(name, options), attrs|
+          display, namespace = options
+          value = send(name)
+          attrs["#{namespace}:#{display}"] = value if value
+        end
+      end
+
+      def true_or_false(value)
+        message = "Invalid #{name}: frame must be true or false"
+        raise ArgumentError, message unless [true, false].member? value
+      end
+
+      def hex_color(value)
+        message = "Invalid #{name}: must be :auto or a hex color, e.g. 4F1B8C"
+        raise ArgumentError, message unless value == :auto || value =~ /[0-9A-F]{6}/
+      end
+
+      def hex_digit(value)
+        message = "Invalid #{name}: must be a two-digit hex number, e.g. BF"
+        raise ArgumentError, message unless value =~ /[0-9A-F]{2}/
+      end
+
+      def hex_digit_4(value)
+        message = "Invalid #{name}: must be a four-digit hex number, e.g. BF12"
+        raise ArgumentError, message unless value =~ /[0-9A-F]{4}/
+      end
+
+      def integer(value)
+        message = "Invalid #{name}: must be an integer"
+        raise ArgumentError, message unless value.is_a?(Integer)
+      end
+
+      def positive_integer(value)
+        message = "Invalid #{name}: must be a positive integer"
+        raise ArgumentError, message unless value.is_a?(Integer) && value >= 0
+      end
+
+      def string(value)
+        message = "Invalid #{name}: must be a string"
+        raise ArgumentError, message if !value.is_a?(String) || value.length.zero?
+      end
+
+      def on_or_off(value)
+        valid_in? value, [:on, :off]
+      end
+
+      def valid_theme_color(value)
+        valid_in? value, VALID_THEME_COLORS
+      end
+
+      def valid_type(value)
+        valid_in? value, VALID_TYPES
+      end
+
+      def valid_in?(value, list)
+        message = "Invalid #{name}: must be one of #{list.join(", ")} (was #{value.inspect})"
+        raise ArgumentError, message unless list.member?(value)
+      end
+
+    end
+  end
+end