rocx 0.5.8 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4eeb08bee13a8278c055c33dd6c18a6dad0fc8d
-  data.tar.gz: 3b733fe765443f5e4b56e9794b66f9bae84af56d
+  metadata.gz: e9bb4b4bab84d40e70d311607aa9fcf27ede7b44
+  data.tar.gz: d2f2f6aa0ddf9e421ac86e31296554e68f53f8a9
 SHA512:
-  metadata.gz: 1fb231ad17a78eccddf31d2c3fc7373d0004a5a5cad0412875d0e50dfc6ac268af1891161e3ed05805ae14f2b38f22629fd694ae79a627924b09256219671b46
-  data.tar.gz: ee68b316c2ba4c1b87cd1f5d3ca1ceaeb6d791881f064267bbdb59b1be775353fd24ddfbe999554ab83d99fa572e33e2ca04d29c718a89da735e9a0573dd932a
+  metadata.gz: dabe3d744f0c26832981c7c9bd9b265ef6684645a892cb190eb5c67d7e01a926234d370e9e8aa76839b3e2c0920a323bd567bd08234c96aa46b3db1663e615ed
+  data.tar.gz: 558350fdb7d8bd5de5ba2c36cc5f3a2f49f3b5fcf8f38198d07f6d8ad6d6325471c0df7ce180ac59ec5e09afef00afc7e00a95fd61fa325ef7156719a5849a34

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rocx (0.5.8)
+    rocx (0.6.0)
       nokogiri
       open_xml_package
 

data/README.md

@@ -1,34 +1,67 @@
 # Rocx [![Code Climate](https://codeclimate.com/github/genebot/rocx.png)](https://codeclimate.com/github/genebot/rocx)
 
-Rocx is a gem for creating .docx (Microsoft Word 2007) files. Using a simple API, you can create Word documents with:
+Rocx 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).
 
-  - Paragraphs
-  - Titles
-  - Headings
-  - Page breaks
-  - Bullet points
-  - Tables
-  
-And, coming soon, images and more.
+An example:
+
+```ruby
+require "rocx"
+
+text = Rocx::Elements::Text.new("Some text that I want to include in my new OOXML document")
+run = Rocx::Elements::Run.new
+run.bold = true
+run << text
+paragraph = Rocx::Elements::Paragraph.new
+paragraph << run
+
+document = Rocx::Package.new
+document.document << paragraph
+document.save("/path/where/i/save/things/test.docx")
+```
 
 ## Installation
 
-Add to your Rails application in the Gemfile:
+You can install Rocx by running `gem install rocx`, or if you like Rails, include `gem "rocx"` in your Gemfile.
+
+## Current features
 
-    gem 'rocx'
-    
-And then run:
+  - Paragraphs
+  - Runs and text
+  - Formatting and styles for the paragraphs, runs, and text
 
-    bundle install
-    
-Or install it yourself:
+## 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
 
-    gem install rocx
-   
 ## Contribute!
 
+Want to help? Thanks, friend! Here's how:
+
   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
+  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

@@ -2,3 +2,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new
 task default: :spec
+task test: :spec

data/lib/rocx.rb

@@ -1,3 +1,4 @@
+require "rocx/attribute_builder"
 require "rocx/properties"
 require "rocx/elements"
 require "rocx/package"

data/lib/rocx/attribute_builder.rb

@@ -0,0 +1,296 @@
+module Rocx
+  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

data/lib/rocx/elements.rb

@@ -3,8 +3,9 @@ module Rocx
   end
 end
 
-require "rocx/elements/base_element"
-require "rocx/elements/base_container"
+require "rocx/elements/element"
+require "rocx/elements/container"
+require "rocx/elements/text"
 Dir.glob("#{File.join(File.dirname(__FILE__), "elements", "*.rb")}").each do |file|
   require file
 end

data/lib/rocx/elements/absolute_position_tab.rb

@@ -0,0 +1,29 @@
+module Rocx
+  module Elements
+    class AbsolutePositionTab < Element
+      tag :ptab
+      attribute :alignment, expects: :valid_ptab_alignment
+      attribute :leader, expects: :valid_ptab_leader
+      attribute :relativeTo, expects: :valid_ptab_relative_to
+
+      VALID_PTAB_ALIGNMENTS = %i(center left right)
+      VALID_PTAB_LEADERS = %i(dot hyphen middleDot none underscore)
+      VALID_PTAB_RELATIVE_TOS = %i(indent margin)
+
+    private
+
+      def valid_ptab_alignment(value)
+        valid_in? value, VALID_PTAB_ALIGNMENTS
+      end
+
+      def valid_ptab_leader(value)
+        valid_in? value, VALID_PTAB_LEADERS
+      end
+
+      def valid_ptab_relative_to(value)
+        valid_in? value, VALID_PTAB_RELATIVE_TOS
+      end
+
+    end
+  end
+end