odf 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c618b4ea9d37d5b03a96097f0de0e3b9abc3056c
+  data.tar.gz: 4f2517bbd3c2db27744ccec7dfcf9cf9cef02f9a
+SHA512:
+  metadata.gz: 6cd614592cc7f05e84bfcadc5432195f14f044b930f47f3062b5eb790c7b8e6f1c3f76415c42c24719876b164fcc191e9b41280e9edbc125a66b8092a086f3b7
+  data.tar.gz: 4b7230485ef33647135a49dd09843d8dfe9839d43fa25ea983765d28f46d6d9f6c7bd32e623e3d80bd553d0ad8fbeea4307e2fc006b0373cb29a00ad5cd5457c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mehmet Emin İNAÇ
+
+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,76 @@
+# Odf(open document format)
+
+Create `.odt`, `.ods` and `.odp` files with Ruby! For the information what is ODF please have a look at the specification [page](https://www.oasis-open.org/committees/tc_home.php).
+
+**Note: ** This gem is still in progress and the API may change even in minor version update!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'odf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install odf
+
+## Usage
+
+This gem provides 3 main classes for each document type. `Odf::Document::Text`, `Odf::Document::Spreadsheet` and `Odf::Document::Presentation`. You can instantiate any of them like so:
+
+```ruby
+document = Odf::Document::Text.new
+```
+
+After you create the document, you can add elements to it. Here we add a paragraph to our document:
+
+```ruby
+document = Odf::Document::Text.new
+document.add_paragraph('Tülaay, ne olursun geri dön.')
+```
+
+For available elements you can add into your document please have a look at the `lib/element` directory.
+
+You can also add meta information to your document like so:
+
+```ruby
+document = Odf::Document::Text.new
+document.creator = 'Twentify'
+```
+
+### Serialization?
+
+You can either serialize your document directly to file system like so: 
+
+```ruby
+document = Odf::Document::Text.new
+document.serialize('path_to_serialize')
+```
+
+or get an output stream to work on it like so:
+
+```ruby
+document = Odf::Document::Text.new
+document.to_blob
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meinac/odf.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "odf"
+
+# 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

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/lib/odf.rb

@@ -0,0 +1,65 @@
+require 'open-uri'
+require 'set'
+require 'openssl'
+require 'zip'
+require 'nokogiri'
+require 'mimemagic'
+
+require 'odf/version'
+require 'odf/utils/file'
+require 'odf/utils/xml'
+
+require 'odf/element/abstract'
+require 'odf/element/abstract_contenteable'
+require 'odf/element/binary_data'
+require 'odf/element/draw_page'
+require 'odf/element/draw_frame'
+require 'odf/element/draw_text_box'
+require 'odf/element/heading'
+require 'odf/element/image'
+require 'odf/element/number'
+require 'odf/element/paragraph'
+require 'odf/element/table'
+require 'odf/element/table_cell'
+require 'odf/element/table_row'
+require 'odf/element/text_list'
+require 'odf/element/text_list_item'
+
+require 'odf/component/xml_component'
+require 'odf/component/abstract'
+require 'odf/component/content'
+require 'odf/component/image_set'
+require 'odf/component/manifest'
+require 'odf/component/meta'
+require 'odf/component/mime_type'
+require 'odf/component/settings'
+require 'odf/component/styles'
+
+require 'odf/document/abstract'
+require 'odf/document/presentation'
+require 'odf/document/spreadsheet'
+require 'odf/document/text'
+
+module Odf
+
+  ROOT_PATH = File.expand_path("../..", __FILE__)
+  TEMPLATE_PATH = "#{ROOT_PATH}/templates".freeze
+  DEFAULT_STYLE = "#{TEMPLATE_PATH}/default_style.xml".freeze
+
+  def self.configure(&block)
+    block.call
+  end
+
+  def self.styles=(val)
+    @styles = val
+  end
+
+  def self.styles
+    File.read(@styles || DEFAULT_STYLE)
+  end
+
+  def self.creator
+    @creator
+  end
+
+end

data/lib/odf/component/abstract.rb

@@ -0,0 +1,23 @@
+module Odf::Component
+  class Abstract
+
+    attr_reader :document
+
+    def initialize(document)
+      @document = document
+    end
+
+    def content
+      raise NotImplementedError.new('Subclasess should implement this method!')
+    end
+
+    def name
+      self.class::NAME
+    end
+
+    def inspect
+      to_s
+    end
+
+  end
+end

data/lib/odf/component/content.rb

@@ -0,0 +1,35 @@
+# Holds the xml of content.xml file
+module Odf::Component
+  class Content < Abstract
+    include XmlComponent
+
+    NAME = 'content.xml'.freeze
+
+    attr_reader :root
+
+    private
+      def initialize_xml
+        super
+        xml.root = xml.create_element(
+          'office:document-content',
+          {
+            'xmlns:office'    => 'urn:oasis:names:tc:opendocument:xmlns:office:1.0',
+            'xmlns:style'     => 'urn:oasis:names:tc:opendocument:xmlns:style:1.0',
+            'xmlns:text'      => 'urn:oasis:names:tc:opendocument:xmlns:text:1.0',
+            'xmlns:table'     => 'urn:oasis:names:tc:opendocument:xmlns:table:1.0',
+            'xmlns:draw'      => 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
+            'xmlns:fo'        => 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
+            'xmlns:xlink'     => 'http://www.w3.org/1999/xlink',
+            'xmlns:dc'        => 'http://purl.org/dc/elements/1.1/',
+            'xmlns:meta'      => 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0',
+            'xmlns:number'    => 'urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0',
+            'xmlns:svg'       => 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0'
+          }
+        )
+        body = xml.create_element('office:body')
+        @root = body.add_child(xml.create_element(document.wrapper))
+        xml.root.add_child(body)
+      end
+
+  end
+end

data/lib/odf/component/image_set.rb

@@ -0,0 +1,42 @@
+module Odf::Component
+  class ImageSet < Abstract
+    class Image
+
+      attr_reader :uri, :path, :content_type
+
+      def initialize(uri)
+        @uri   = uri
+        digest = OpenSSL::Digest::MD5.hexdigest(uri)
+        @path = "Pictures/#{digest}"
+      end
+
+      def save
+        @content, @content_type = Odf::Utils::File.fetch_image(self)
+      end
+
+      def content
+        @content || (save && @content)
+      end
+    end
+
+    attr_reader :images
+
+    def initialize(*args)
+      super
+      @images = Set.new
+    end
+
+    def <<(path)
+      image = Image.new(path)
+      images << image
+      image.path
+    end
+
+    def each(&block)
+      images.each do |image|
+        block.call(image)
+      end
+    end
+
+  end
+end

data/lib/odf/component/manifest.rb

@@ -0,0 +1,33 @@
+module Odf::Component
+  class Manifest < Abstract
+    include XmlComponent
+
+    NAME = 'META-INF/manifest.xml'.freeze
+
+    private
+      def initialize_xml
+        super
+        xml.root = xml.create_element('manifest:manifest', 'xmlns:manifest' => 'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0')
+        self_element = xml.create_element('manifest:file-entry', 'manifest:media-type' => document.media_type, 'manifest:full-path' => '/')
+        xml.root.add_child(self_element)
+        content_element = xml.create_element('manifest:file-entry', 'manifest:media-type' => 'text/xml', 'manifest:full-path' => 'content.xml')
+        xml.root.add_child(content_element)
+        styles_xml = xml.create_element('manifest:file-entry', 'manifest:media-type' => 'text/xml', 'manifest:full-path' => 'styles.xml')
+        xml.root.add_child(styles_xml)
+        settings_xml = xml.create_element('manifest:file-entry', 'manifest:media-type' => 'text/xml', 'manifest:full-path' => 'settings.xml')
+        xml.root.add_child(settings_xml)
+        meta_xml = xml.create_element('manifest:file-entry', 'manifest:media-type' => 'text/xml', 'manifest:full-path' => 'meta.xml')
+        xml.root.add_child(meta_xml)
+      end
+
+      # Finalize XML
+      def wrap_xml
+        # Insert document images
+        document.image_set.images.each do |image|
+          image_element = xml.create_element('manifest:file-entry', 'manifest:media-type' => image.content_type, 'manifest:full-path' => image.path)
+          xml.root.add_child(image_element)
+        end
+      end
+
+  end
+end

data/lib/odf/component/meta.rb

@@ -0,0 +1,25 @@
+module Odf::Component
+  class Meta < Abstract
+    include XmlComponent
+
+    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S'.freeze
+    NAME = 'meta.xml'.freeze
+
+    private
+      def wrap_xml
+        xml.root = xml.create_element(
+          'office:document-meta',
+          {
+            'xmlns:office' => 'urn:oasis:names:tc:opendocument:xmlns:office:1.0',
+            'xmlns:dc'     => 'http://purl.org/dc/elements/1.1/',
+            'xmlns:meta'   => 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0'
+          }
+        )
+        meta_element = xml.add_element('office:meta')
+        xml.add_element_into(meta_element, 'meta:generator', 'Ruby-ODF-Gem')
+        xml.add_element_into(meta_element, 'dc:creator', document.creator) if document.creator
+        xml.add_element_into(meta_element, 'meta:creation-date', Time.now.strftime(TIME_FORMAT))
+      end
+
+  end
+end

data/lib/odf/component/mime_type.rb

@@ -0,0 +1,11 @@
+module Odf::Component
+  class MimeType < Abstract
+
+    NAME = 'mimetype'.freeze
+
+    def content
+      document.media_type
+    end
+
+  end
+end

data/lib/odf/component/settings.rb

@@ -0,0 +1,15 @@
+module Odf::Component
+  class Settings < Abstract
+    include XmlComponent
+
+    NAME = 'settings.xml'.freeze
+
+    private
+      def initialize_xml
+        super
+        xml.root = xml.create_element('office:document-settings', 'xmlns:office' => 'urn:oasis:names:tc:opendocument:xmlns:office:1.0')
+        xml.add_element('office:settings')
+      end
+
+  end
+end

data/lib/odf/component/styles.rb

@@ -0,0 +1,26 @@
+module Odf::Component
+  class Styles < Abstract
+    include XmlComponent
+
+    NAME = 'styles.xml'.freeze
+
+    def content
+      Odf.styles
+    end
+
+    private
+      def initialize_xml
+        super
+        xml.root = xml.create_element('office:document-styles', 'xmlns:office' => 'urn:oasis:names:tc:opendocument:xmlns:office:1.0')
+        font_decls = xml.create_element('office:font-face-decls')
+        times_nr   = xml.create_element('style:font-face', { 'style:name' => 'Times New Roman', 'svg:font-family' => '&apos;Times New Roman&apos;', 'style:font-family-generic' => 'roman', 'style:font-pitch' => 'variable' })
+        arial      = xml.create_element('style:font-face', { 'style:name' => 'Arial', 'svg:font-family' => '&apos;Arial&apos;', 'style:font-family-generic' => 'swiss', 'style:font-pitch' => 'variable' })
+        arial_uc   = xml.create_element('style:font-face', { 'style:name' => 'Arial Unicode MS', 'svg:font-family' => '&apos;Arial Unicode MS&apos;', 'style:font-family-generic' => 'system', 'style:font-pitch' => 'variable' })
+        font_decls.add_child(times_nr)
+        font_decls.add_child(arial)
+        font_decls.add_child(arial_uc)
+        xml.root.add_child(font_decls)
+      end
+
+  end
+end