fn_document 0.9.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Nathan Colgate Clark
+
+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.rdoc

@@ -0,0 +1,19 @@
+= fn_document
+
+Description goes here.
+
+== Contributing to fn_document
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Nathan Colgate Clark. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fn_document"
+  gem.homepage = "http://github.com/nathancolgate/fn_document"
+  gem.license = "MIT"
+  gem.summary = "Gem for handling documents within FASI AMS"
+  gem.description = "Gem for handling documents within FASI AMS"
+  gem.email = "nathancolgate@gmail.com"
+  gem.authors = ["Nathan Colgate Clark","Kyle Maxwell"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fn_document #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.2

data/fn_document.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fn_document}
+  s.version = "0.9.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Colgate Clark", "Kyle Maxwell"]
+  s.date = %q{2011-07-14}
+  s.description = %q{Gem for handling documents within FASI AMS}
+  s.email = %q{nathancolgate@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fn_document.gemspec",
+    "lib/fn/block.rb",
+    "lib/fn/document.rb",
+    "lib/fn/migrate.xslt",
+    "lib/fn/node/base.rb",
+    "lib/fn/node/context.rb",
+    "lib/fn/node/root.rb",
+    "lib/fn/pdf/node/begin_document.rb",
+    "lib/fn/pdf/node/begin_page_ext.rb",
+    "lib/fn/pdf/node/create_textflow.rb",
+    "lib/fn/pdf/node/end_page_ext.rb",
+    "lib/fn/pdf/node/fit_image.rb",
+    "lib/fn/pdf/node/fit_pdi_page.rb",
+    "lib/fn/pdf/node/fit_textflow.rb",
+    "lib/fn/pdf/node/invert.rb",
+    "lib/fn/pdf/node/load_image.rb",
+    "lib/fn/pdf/node/open_pdi.rb",
+    "lib/fn/pdf/node/open_pdi_page.rb",
+    "lib/fn/pdf/node/resume_page.rb",
+    "lib/fn/pdf/node/set_parameter.rb",
+    "lib/fn/pdf/node/watermark.rb",
+    "lib/fn/pdf/struct.rb",
+    "lib/fn/pdf/writer.rb",
+    "lib/fn/resource.rb",
+    "lib/fn/swf/node/break.rb",
+    "lib/fn/swf/node/flash.rb",
+    "lib/fn/swf/node/font.rb",
+    "lib/fn/swf/node/frame.rb",
+    "lib/fn/swf/node/hot_spot.rb",
+    "lib/fn/swf/node/image.rb",
+    "lib/fn/swf/node/page.rb",
+    "lib/fn/swf/node/photo_block.rb",
+    "lib/fn/swf/node/text.rb",
+    "lib/fn/swf/struct.rb",
+    "lib/fn/swf/writer.rb",
+    "lib/fn/util.rb",
+    "lib/fn/validation.rng",
+    "lib/fn_document.rb",
+    "test/helper.rb",
+    "test/test_fn_document.rb"
+  ]
+  s.homepage = %q{http://github.com/nathancolgate/fn_document}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Gem for handling documents within FASI AMS}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/fn/block.rb

@@ -0,0 +1,27 @@
+module FN
+  module Block
+    def page_number
+      find_first("ancestor::page")["number"].to_i
+    end
+    
+    def content?
+      content && !content.empty?
+    end
+    
+    def text
+      self["text"]
+    end
+    
+    def src
+      self["src"]
+    end
+    
+    def index
+      self["index"] && self["index"].to_i
+    end
+    
+    def sort_key
+      "#{text}-#{index}"
+    end
+  end
+end

data/lib/fn/document.rb

@@ -0,0 +1,204 @@
+require_dependency File.dirname(__FILE__) + '/util'
+require_dependency File.dirname(__FILE__) + '/resource'
+require_dependency File.dirname(__FILE__) + '/block'
+require_dependency File.dirname(__FILE__) + '/pdf/writer'
+require_dependency File.dirname(__FILE__) + '/swf/writer'
+
+XML.default_keep_blanks = false
+
+module FN
+  class ItemNotFoundError < RuntimeError; end
+  class Document
+    module ClassMethods
+      include Util
+      
+      # Creates a new FN::Document from an XML object that is in the old-
+      # school (original) style
+      def migrate_from(xml)
+        raise_unless_xml_doc xml
+        @xslt ||= XSLT::Stylesheet.new(
+                  XML::Document.file(
+                  File.dirname(__FILE__) + "/migrate.xslt"
+                ))
+        return FN::Document.new(@xslt.apply(xml))
+      end
+      
+      # Reads XML from a file, and returns the FN::Document
+      def file(file, options = {})
+        new(XML::Document.file(file), options)
+      end
+      
+      # Reads XML from a string, and returns the FN::Document
+      def string(string, options = {})
+        new(XML::Document.string(string), options)
+      end
+    end    
+    extend ClassMethods
+    
+    include Util
+    
+    SPACE = /\s+/
+    
+    attr_accessor :resource_root
+    attr_reader :xml
+    
+    def initialize(xml, options = {})
+      raise_unless_xml_doc xml
+      @xml = xml
+      update_resources options
+      # validate!
+    end
+    
+    def update_resources(options = {})
+      @resource_root = options[:resource_root]      if options[:resource_root]
+      mapping = string_keys(options[:resources])    or return
+      resources.each do |resource|
+        path = mapping[resource.key.to_s]
+        resource.path = path                        if path
+      end
+    end
+    
+    def menu_item(path)
+      xpath = "//" + path.
+                      split("/").
+                      map{|label| "item[@label='#{label}']"}.
+                      join("/")
+      @xml.find_first(xpath) or raise ItemNotFoundError.new(xpath + "\n\n" + @xml.to_s)
+    end
+    
+    def edit_menu_items
+      @xml.find("//item[@label='Edit']/item")
+    end
+    
+    def string_keys(hash)
+      return nil unless hash
+      hash.inject({}) do |m, (k, v)|
+        m[k.to_s] = v
+        m
+      end
+    end
+    
+    def remove_menu_items(*args)
+      args.flatten.each do |arg|
+        remove_menu_item arg
+      end
+    end
+    
+    def remove_menu_item(name)
+      node = @xml.find_first("//item[@label='#{name}']")
+      node.remove! unless node.nil?
+      #@xml.find("//item[@label='#{name}']").each do |node|
+      #  node.remove! # mongrels keep dying -> bug caused by finding two items named "Download"
+      #end
+    end
+    
+    def to_pdf(options = {})
+      update_resources(options)
+      @pdf ||= PDF::Writer.new
+      @pdf.write(self, options)      
+    end
+        
+    def to_swf(options = {})
+      update_resources(options)
+      @swf ||= SWF::Writer.new
+      @swf.write(self, options)      
+    end
+    
+    def blocks
+      extend_block @xml.find("//block")
+    end
+    
+    def text_blocks
+      extend_block(@xml.find("//block[@type='text']")).sort_by{|b| b.sort_key }
+    end
+    
+    def text_blocks_by(page)
+      typed_blocks_by(page, "text")
+    end
+    
+    def photo_blocks_by(page)
+      typed_blocks_by(page, "photo")
+    end
+    
+    def typed_blocks_by(page, type)
+      query = "//page[@number='#{page}']//block[@type='#{type}']
+              |//block[@type='#{type}' and @multipage='yes']".gsub(SPACE, '')
+      extend_block(@xml.find(query)).sort_by{|b| b.sort_key }
+    end
+    
+    def photo_blocks
+      extend_block @xml.find("//block[@type='photo']")
+    end
+    
+    def extend_block(blox)
+      blox.map do |blk|
+        blk.extend(FN::Block)
+        blk
+      end
+    end
+    
+    def textflows
+      @xml.find("//text")
+    end
+    
+    def pages
+      @xml.find("//page")
+    end
+    
+    def dependencies?
+      resources.all?{|r| r.complete? }
+    end
+    
+    def printable?
+      dependencies? && @resource_root
+    end
+    
+    def resource_hash
+      @resources ||= @xml.find("//resource").inject({}) {|memo, r|
+        res = Resource.new(r)
+        memo[res.key].delete      if memo[res.key]
+        memo[res.key] = res
+        memo
+      }
+    end
+    
+    def images
+      photos + backgrounds
+    end
+    
+    def photos
+      resources.select{|r| r.type == "photo"}
+    end
+    
+    def backgrounds
+      resources.select{|r| r.type == "bkg"}
+    end
+    alias_method :bkgs, :backgrounds
+    
+    def fonts
+     resources.select{|r| r.type == "font"}
+    end
+    
+    def resources
+      resource_hash.values.sort_by {|x| x.key }
+    end
+    
+    def resource(key)
+      resource_hash[key] || Resource.new(LibXML::XML::Node.new("anon", key))
+    end
+    
+    # Raise unless this document matches an internal schema
+    def validate!
+      @schema ||= XML::RelaxNG.document(
+                   XML::Document.file(
+                   File.dirname(__FILE__) + "/validation.rng"
+                 ))
+      @xml.validate_relaxng(@schema)
+    end
+    
+    # String representation of the internal XML document
+    def xml_to_s
+      @xml.to_s
+    end
+  end
+end