ooodt 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f670a5de3fb4a1c1ae35f5951538491662a5b355
+  data.tar.gz: 998fc889961ce58f63d7a8cd396a56fd0817f0ac
+SHA512:
+  metadata.gz: 845030abc2b1364d2fc0aba913c47f0496586db9d07825e5f3b5bbae3d875ab6819689bf05b7da0c5b459474c9295368fd63659d9f385ccea7a45f5d126f1038
+  data.tar.gz: 05bdf6cf0ac0501f8f9cf715c2bc575b12d35f863b26e82e862ed7baa4a56969524e0fe666b0a25b93fe6c59a02c5ec3fc6e88c955248438c02586e45f14f3ec

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    ooodt (0.0.1.alpha)
+      builder (~> 3.2.2)
+      rubyzip (~> 1.1.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.2.2)
+    rake (10.4.2)
+    rubyzip (1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ooodt!
+  rake (~> 10.4.2)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andor Chen
+
+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,50 @@
+# ooodt
+
+ooodt is a Ruby .odt file packager.
+
+## Usage
+
+```ruby
+odt = Ooodt.make do
+  title         'Sample Title'
+  creator       'Andor Chen'
+  keyword       'key1, key2'
+  creation_date '2010-05-06'
+
+  content_file  '/path/to/content.xml'
+  styles_file   '/path/to/styles.xml'
+
+  pictures      ['/path/to/foo.jpg', '/path/to/bar.png']
+end
+odt.save('sample.odt')
+```
+
+## Installation
+
+```sh
+$ gem install ooodt
+```
+
+or, in `Gemfile`:
+
+```ruby
+gem 'ooodt'
+```
+
+## Requirements
+
+* `content.xml`: the `<office:document-content>` ([ref](http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os-part1.html#__RefHeading__1415004_253892949))
+* `styles.xml`: the `<office:document-styles>` ([ref](http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os-part1.html#__RefHeading__1415006_253892949))
+* LibreOffice or OpenOffice to open `.odt` file
+
+## Resources
+
+- [OASIS Open Document Format for Office Applications](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office)
+
+## Thanks to
+
+- [eeepub](https://github.com/jugyo/eeepub/)
+
+## Copyright
+
+Copyright (c) 2015 Andor Chen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+$:.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+require_relative 'lib/ooodt/version'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  Ooodt::VERSION
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc 'Release the gem, push to github and rubygems.org'
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc 'Build the gem and then move to /pkg'
+task :build do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+

data/lib/ooodt.rb

@@ -0,0 +1,10 @@
+require_relative 'ooodt/maker'
+
+module Ooodt
+  # Make .odt file
+  #
+  # @param [Proc] block the block for initialize Ooodt::Maker
+  def self.make(&block)
+    Ooodt::Maker.new(&block)
+  end
+end

data/lib/ooodt/container_item.rb

@@ -0,0 +1,101 @@
+require 'builder'
+
+module Ooodt
+  # Abstract base class for container item of .oddt file.
+  # Provides some helper methods.
+  #
+  # @abstract
+  class ContainerItem
+    class << self
+
+      private
+
+      # Set default value to attribute
+      #
+      # @param [Symbol] name the attribute name
+      # @param [Object] default the default value
+      def default_value(name, default)
+        instance_variable_name = "@#{name}"
+        define_method(name) do
+          self.instance_variable_get(instance_variable_name) ||
+            self.instance_variable_set(instance_variable_name, default)
+        end
+      end
+
+      # Define alias of attribute accessor
+      #
+      # @param [Symbol] name the attribute name as alias
+      # @param [Symbol] name the attribute name as source
+      def attr_alias(name, src)
+        alias_method name, src
+        alias_method :"#{name}=", :"#{src}="
+      end
+    end
+
+    # @param [Hash<Symbol, Object>] values the hash of symbols and objects for attributes
+    def initialize(values)
+      set_values(values)
+    end
+
+    # Set values for attributes
+    #
+    # @param [Hash<Symbol, Object>] values the hash of symbols and objects for attributes
+    def set_values(values)
+      values.each do |k, v|
+        self.send(:"#{k}=", v)
+      end
+    end
+
+    # Convert to xml of container item
+    #
+    # @return [String] the xml of container item
+    def to_xml
+      out = ""
+      builder = Builder::XmlMarkup.new(:target => out, :indent => 0)
+      builder.instruct!
+      build_xml(builder)
+      out
+    end
+
+    # Save as container item
+    #
+    # @param [String] filepath the file path for container item
+    def save(filepath)
+      File.open(filepath, 'w') do |file|
+        file << self.to_xml
+      end
+    end
+
+    private
+
+    # Guess media type from file name
+    #
+    # @param [String] filename the file name
+    # @return [String] the media-type
+    def guess_media_type(filename)
+      case filename
+      when /.*\.(jpeg|jpg)$/
+        'image/jpeg'
+      when /.*\.png$/i
+        'image/png'
+      when /.*\.gif$/i
+        'image/gif'
+      when /.*\.svg$/i
+        'image/svg+xml'
+      end
+    end
+
+    # Convert options for xml attributes
+    #
+    # @param [Hash<Symbol, Object>] hash the hash of symbols and objects for xml attributes
+    # @return [Hash<String, Object>] the options for xml attributes
+    def convert_to_xml_attributes(hash)
+      result = {}
+      hash.each do |k, v|
+        key = k.to_s.gsub('_', '-').to_sym
+        result[key] = v
+      end
+      result
+    end
+  end
+end

data/lib/ooodt/maker.rb

@@ -0,0 +1,87 @@
+require_relative 'container_item'
+require_relative 'manifest'
+require_relative 'meta'
+require_relative 'odf'
+
+require 'tmpdir'
+require 'fileutils'
+
+module Ooodt
+  # The class to make .odt file easily
+  #
+  # @example
+  #   odt = Ooodt.make do
+  #     title         'sample'
+  #     creator       'Andor Chen'
+  #     keyword       'key1, key2'
+  #     creation_date '2010-05-06'
+  #
+  #     pictures ['/path/to/foo.jpg', '/path/to/bar.png']
+  #   end
+  #   odt.save('sample.odt')
+  class Maker
+
+    # @param [Proc] block the block for initialize
+    def initialize(&block)
+      @pictures ||= []
+      @content_file ||= 'content.xml'
+      @meta_file ||= 'meta.xml'
+      @styles_file ||= 'styles.xml'
+
+      instance_eval(&block) if block_given?
+    end
+
+    [
+      :title,
+      :creator,
+      :creation_date,
+      :keyword,
+      :pictures,
+      :content_file,
+      :meta_file,
+      :styles_file
+    ].each do |name|
+      define_method(name) do |arg|
+        instance_variable_set("@#{name}", arg)
+      end
+    end
+
+    # Save as .odt file
+    #
+    # @param [String] filename the .odt file name to save
+    def save(filename)
+      create_odt.save(filename)
+    end
+
+    private
+
+    def create_odt
+      dir = Dir.mktmpdir
+
+      FileUtils.cp(@content_file, File.join(dir, 'content.xml'))
+      FileUtils.cp(@styles_file, File.join(dir, 'styles.xml'))
+
+      @pictures.each do |pic|
+        dest_dir = File.join(dir, 'Pictures')
+        FileUtils.mkdir_p(dest_dir)
+        FileUtils.cp(pic, dest_dir)
+      end
+
+      Meta.new(
+        :creator => @creator,
+        :title => @title,
+        :creation_date => @creation_date,
+        :keyword => @keyword
+      ).save(File.join(dir, @meta_file))
+
+      manifest = Manifest.new(
+        :pictures => @pictures
+      )
+
+      ODF.new(
+        :dir => dir,
+        :manifest => manifest
+      )
+    end
+  end
+end

data/lib/ooodt/manifest.rb

@@ -0,0 +1,26 @@
+module Ooodt
+  class Manifest < ContainerItem
+    attr_accessor :pictures
+
+    def build_xml(builder)
+      builder.tag!('manifest:manifest',
+                   'xmlns:manifest' => 'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0',
+                   'manifest:version' => '1.2') do
+        builder.tag!('manifest:file-entry', 'manifest:full-path' => '/',
+                                            'manifest:version' => '1.2',
+                                            'manifest:media-type' => 'application/vnd.oasis.opendocument.text')
+
+        ['content.xml', 'meta.xml', 'styles.xml'].each do |file|
+          builder.tag!('manifest:file-entry', 'manifest:full-path' => file,
+                                              'manifest:media-type' => 'text/xml')
+        end
+
+        pictures.each do |pic|
+          pic = File.basename(pic)
+          builder.tag!('manifest:file-entry', 'manifest:full-path' => "Pictures/#{pic}",
+                                              'manifest:media-type' => guess_media_type(pic))
+        end
+      end
+    end
+  end
+end

data/lib/ooodt/meta.rb

@@ -0,0 +1,30 @@
+require_relative 'version'
+
+module Ooodt
+  class Meta < ContainerItem
+    attr_accessor :creator, :title, :creation_date, :keyword
+
+    default_value :title, 'Untitled'
+    default_value :creation_date, Time.now # FIXME: time format
+    default_value :keyword, ''
+
+    def build_xml(builder)
+      builder.tag!('office:document-meta', 'xmlns:office'   => "urn:oasis:names:tc:opendocument:xmlns:office: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:ooo'      => "http://openoffice.org/2004/office",
+                                           'xmlns:grddl'    => "http://www.w3.org/2003/g/data-view#",
+                                           'office:version' => "1.2") do
+        builder.tag!('office:meta') do
+          builder.tag!('dc:creator') { builder.text! creator }
+          builder.tag!('dc:date') { builder.text! Time.now.strftime('%Y-%m-%dT%H:%M:%S.%N') }
+          builder.tag!('dc:title') { builder.text! title }
+          builder.tag!('meta:creation-date') { builder.text! creation_date }
+          builder.tag!('meta:keyword') { builder.text! keyword }
+          builder.tag!('meta:generator') { builder.text! "ooodt/#{Ooodt::VERSION}" }
+        end
+      end
+    end
+  end
+end

data/lib/ooodt/odf.rb

@@ -0,0 +1,56 @@
+require 'zip'
+
+module Ooodt
+  # Class to create ODF
+  class ODF
+
+    attr_accessor :dir, :manifest
+
+    # @param [Hash<Symbol, Object>] values the values of symbols and objects for ODF
+    #
+    # @example
+    #   EeePub::ODF.new(
+    #     :dir => '/path/to/dir',
+    #     :manifest => 'manifest.odf'
+    #   )
+    def initialize(values)
+      values.each do |k, v|
+        self.send(:"#{k}=", v)
+      end
+    end
+
+    # Save as ODF
+    #
+    # @param [String] output_path the output file path of .odt file
+    def save(output_path)
+      output_path = File.expand_path(output_path)
+
+      create_odt do
+        mimetype = Zip::OutputStream::open(output_path) do |os|
+          os.put_next_entry('mimetype', nil, nil, Zip::Entry::STORED, Zlib::NO_COMPRESSION)
+          os << 'application/vnd.oasis.opendocument.text'
+        end
+        zipfile = Zip::File.open(output_path)
+        Dir.glob('**/*').each do |path|
+          zipfile.add(path, path)
+        end
+        zipfile.commit
+      end
+      FileUtils.remove_entry_secure dir
+    end
+
+    private
+
+    def create_odt
+      FileUtils.chdir(dir) do
+        meta_inf = 'META-INF'
+        FileUtils.mkdir_p(meta_inf)
+
+        manifest.save(File.join(meta_inf, 'manifest.xml'))
+
+        yield
+      end
+
+    end
+  end
+end

data/lib/ooodt/version.rb

@@ -0,0 +1,3 @@
+module Ooodt
+  VERSION = '0.0.1.alpha'
+end

data/ooodt.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/ooodt/version'
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '2.2.2'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.name        = 'ooodt'
+  s.version     = Ooodt::VERSION
+  s.license     = 'MIT'
+
+  s.authors     = ['Andor Chen']
+  s.email       = ['andor.chen.27@gmail.com']
+  s.homepage    = 'http://github.com/andorchen/ooodt'
+  s.summary     = %q{.odt file packager}
+  s.description = %q{ooodt is a Ruby .odt file packager.}
+
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('builder', '~> 3.2.2')
+  s.add_runtime_dependency('rubyzip', '~> 1.1.7')
+
+  s.add_development_dependency('rake',     '~> 10.4.2')
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ooodt
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Andor Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: ooodt is a Ruby .odt file packager.
+email:
+- andor.chen.27@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/ooodt.rb
+- lib/ooodt/container_item.rb
+- lib/ooodt/maker.rb
+- lib/ooodt/manifest.rb
+- lib/ooodt/meta.rb
+- lib/ooodt/odf.rb
+- lib/ooodt/version.rb
+- ooodt.gemspec
+homepage: http://github.com/andorchen/ooodt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 2
+summary: ".odt file packager"
+test_files: []