xliffer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea276a483651e8f0e534280a3fef9329a52c4321
+  data.tar.gz: 141a20279f0de253021ecc64d8d7427b40ab4aec
+SHA512:
+  metadata.gz: ce7148866423e954f0febc89505518ad0110a8bc075fea789f25174f0b2ca27dcda2339f3c393f20ddf7d63eabf3c053610fb7e03ae9f47dcea0c24641127c7c
+  data.tar.gz: 334fed09e496be5d4770ae67ab3113491458e7f58acf744121ffeaab221220532078c4e225d9ebfb8157bd332d405ec1a2ac2e22afa6966343c60b96499d3f44

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.rvmrc
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'nokogiri'
+
+group :development do
+  gem 'rspec', '~> 2'
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    nokogiri (1.5.9)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nokogiri
+  rspec (~> 2)

data/README.md

@@ -0,0 +1,39 @@
+xliffer
+=======
+
+A XLIFF parser gem.
+
+Currently implementing the [version 1.2](http://docs.oasis-open.org/xliff/xliff-core/xliff-core.html) from xliff. It is on a very alpha phase.
+
+Usage
+-----
+
+```ruby
+require 'xliffer'
+
+# Opens a xliff file - can be a file descriptor or a string.
+xliff = XLIFFer::XLIFF.new(File.open('file.xml'))
+
+# get the first file definition on this XLIFF.
+file = xliff.files.first
+
+# prints the name of this file
+puts file.original
+
+# Prints the source and target languages from this file.
+puts file.source_language
+puts file.target_language
+
+# Prints all string and the translations on this file.
+file.strings.each do |string| 
+  puts  "#{string.source} => #{string.target}"
+end
+```
+
+
+Roadmap
+------
+
+* Read all fields according to 1.2 specification
+* Be able to modify/add contents on the xliff files
+* Regenerate the XML from the file

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/xliffer.rb

@@ -0,0 +1,4 @@
+require 'xliffer/exceptions'
+require 'xliffer/xliff'
+require 'xliffer/xliff/file'
+require 'xliffer/xliff/string'

data/lib/xliffer/exceptions.rb

@@ -0,0 +1,5 @@
+module XLIFFer
+  class FormatError < StandardError; end
+  class MultipleElement < FormatError; end
+  class NoElement < FormatError; end
+end

data/lib/xliffer/version.rb

@@ -0,0 +1,3 @@
+module XLIFFer
+  VERSION = "0.0.2"
+end

data/lib/xliffer/xliff.rb

@@ -0,0 +1,43 @@
+require 'nokogiri'
+require 'xliffer/xliff/file'
+
+module XLIFFer
+  class XLIFF
+    attr_reader :version, :files
+    def initialize(xliff = nil)
+      text = case xliff
+             when ::IO then xliff.read
+             when ::String then xliff
+             else fail ArgumentError, "Expects an IO or String"
+             end
+
+      parse(text)
+    end
+
+    private
+    def parse(text)
+      begin
+        xml = Nokogiri::XML(text)
+      rescue
+        fail FormatError, "Not a XML file"
+      end
+
+      xml.remove_namespaces!
+      root = xml.xpath('/xliff')
+      raise FormatError, "Not a XLIFF file" unless root.any?
+
+      @version = get_version(root)
+      @files = parse_files(root)
+    end
+
+    def get_version(root)
+      version = root.attr('version')
+      version ? version.value : nil
+    end
+
+    def parse_files(root)
+      root.xpath('//file').map{|f| File.new(f)}
+    end
+
+  end
+end

data/lib/xliffer/xliff/file.rb

@@ -0,0 +1,32 @@
+require 'xliffer/xliff'
+require 'nokogiri'
+
+module XLIFFer
+  class XLIFF
+    class File
+      attr_reader :source_language, :target_language, :original, :strings
+      alias_method :file_name, :original
+      def initialize(xml)
+        unless xml_element?(xml) and file?(xml)
+          raise ArgumentError, "can't create a File without a file subtree"
+        end
+
+        @original = xml.attr("original")
+        @source_language = xml.attr("source-language")
+        @target_language = xml.attr("target-language")
+        @strings = xml.xpath('.//trans-unit').map{|tu| String.new(tu)}
+      end
+
+
+      private
+      # TODO: move to public method on XLIFF
+      def xml_element?(xml)
+        xml.kind_of? Nokogiri::XML::Element
+      end
+
+      def file?(xml)
+        xml.name.downcase == "file"
+      end
+    end
+  end
+end

data/lib/xliffer/xliff/string.rb

@@ -0,0 +1,46 @@
+module XLIFFer
+  class XLIFF
+    class String
+      attr_reader :id, :source, :target, :note
+      def initialize(xml)
+        unless xml_element?(xml) and trans_unit?(xml)
+          raise ArgumentError, "can't create a String without a trans-unit subtree"
+        end
+
+        @id = xml.attr('id')
+        @source = get_source(xml)
+        @target = get_target(xml)
+        @note   = get_note(xml)
+      end
+
+      private
+      # TODO: move to public method on XLIFF
+      def xml_element?(xml)
+        xml.kind_of? Nokogiri::XML::Element
+      end
+
+      def trans_unit?(xml)
+        xml.name.downcase == "trans-unit"
+      end
+
+      def get_source(xml)
+        sources = xml.xpath("./source")
+        raise MultipleElement, "Should have only one source tag" if sources.size > 1
+        raise NoElement, "Should have one source tag" unless sources.size == 1
+        sources.first.text
+      end
+
+      def get_target(xml)
+        targets = xml.xpath("./target")
+        raise MultipleElement, "Should have only one target tag" if targets.size > 1
+        targets.first ? targets.first.text : ''
+      end
+
+      def get_note(xml)
+        notes = xml.xpath("./note")
+        raise MultipleElement, "Should have only one target tag" if notes.size > 1
+        notes.first ? notes.first.text : ''
+      end
+    end
+  end
+end

data/spec/files/empty.xliff

@@ -0,0 +1 @@
+<xliff version="1.2"></xliff> 

data/spec/files/file.foobar

@@ -0,0 +1 @@
+foobar

data/spec/files/wiki.xliff

@@ -0,0 +1,36 @@
+<xliff version="1.2">
+ <file original="Graphic Example.psd"
+  source-language="en-US" target-language="ja-JP"
+  tool="Rainbow" datatype="photoshop">
+  <header>
+   <skl>
+    <external-file uid="3BB236513BB24732" href="Graphic Example.psd.skl"/>
+   </skl>
+   <phase-group>
+    <phase phase-name="extract" process-name="extraction"
+     tool="Rainbow" date="20010926T152258Z"
+     company-name="NeverLand Inc." job-id="123"
+     contact-name="Peter Pan" contact-email="ppan@example.com">
+     <note>Make sure to use the glossary I sent you yesterday.
+      Thanks.</note>
+    </phase>
+   </phase-group>
+  </header>
+  <body>
+   <trans-unit id="1" maxbytes="14">
+    <source xml:lang="en-US">Quetzal</source>
+    <target xml:lang="ja-JP">Quetzal</target>
+   </trans-unit>
+   <trans-unit id="3" maxbytes="114">
+    <source xml:lang="en-US">An application to manipulate and 
+     process XLIFF documents</source>
+    <target xml:lang="ja-JP">XLIFF 文書を編集、または処理
+     するアプリケーションです。</target>
+   </trans-unit>
+   <trans-unit id="4" maxbytes="36">
+    <source xml:lang="en-US">XLIFF Data Manager</source>
+    <target xml:lang="ja-JP">XLIFF データ・マネージャ</target>
+   </trans-unit>
+  </body>
+ </file>
+</xliff>

data/spec/files/xliffspec1.xliff

@@ -0,0 +1,15 @@
+<xliff version='1.2'
+  xmlns='urn:oasis:names:tc:xliff:document:1.2'>
+  <file original='hello.txt' source-language='en' target-language='fr'
+    datatype='plaintext'>
+    <body>
+      <trans-unit id='hi'>
+        <source>Hello world</source>
+        <target>Bonjour le monde</target>
+        <alt-trans>
+          <target xml:lang='es'>Hola mundo</target>
+        </alt-trans>
+      </trans-unit>
+    </body>
+  </file>
+</xliff>

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'xliffer'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/xliffer/file_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'nokogiri'
+
+module XLIFFer
+  describe XLIFF::File do
+    context "#new" do
+      it "is created with a nokogiri file node" do
+        file_node = Nokogiri::XML.parse("<file></file>").xpath("/file").first
+        XLIFF::File.new(file_node).should be
+      end
+
+      it "can't be created with a string" do
+        expect{XLIFF::File.new("<file></file>")}.to raise_error ArgumentError
+      end
+
+      it "can't be created with a node that is not a file node" do
+        file_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("/xliff").first
+        expect{XLIFF::File.new(file_node)}.to raise_error ArgumentError
+      end
+    end
+
+    context "#original" do
+      it "is nil if not defined" do
+        file_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).original.should be nil
+      end
+
+      it "is the original attribute on file tag" do
+        file_node = Nokogiri::XML.parse('<xliff><file original="neat file.c"></file></xliff>').xpath("//file").first
+        XLIFF::File.new(file_node).original.should eql("neat file.c")
+      end
+    end
+
+    context "#original" do
+      it "is nil if not defined" do
+        file_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).original.should be nil
+      end
+
+      it "is the original attribute on file tag" do
+        file_node = Nokogiri::XML.parse('<xliff><file original="neat file.c"></file></xliff>').xpath("//file").first
+        XLIFF::File.new(file_node).original.should eql("neat file.c")
+      end
+    end
+
+    context "#source_language" do
+      it "is nil if not defined" do
+        file_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).source_language.should be nil
+      end
+
+      it "is the original attribute on file tag" do
+        file_node = Nokogiri::XML.parse('<xliff><file source-language="en"></file></xliff>').xpath("//file").first
+        XLIFF::File.new(file_node).source_language.should eql("en")
+      end
+    end
+
+    context "#target_language" do
+      it "is nil if not defined" do
+        file_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).target_language.should be nil
+      end
+
+      it "is the original attribute on file tag" do
+        file_node = Nokogiri::XML.parse('<xliff><file target-language="fr"></file></xliff>').xpath("//file").first
+        XLIFF::File.new(file_node).target_language.should eql("fr")
+      end
+    end
+
+    context "#strings" do
+      before(:all) do
+        @trans_unit = <<-EOF
+        <trans-unit id="my id">
+          <source>Hello World</source>
+          <target>Bonjour le monde</target>
+        </trans-unit>
+        EOF
+      end
+      it "is an array " do
+        file_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).strings.should be_kind_of(Array)
+      end
+
+      it "can be empty" do
+        file_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).strings.should be_empty
+      end
+
+      it "should have a string" do
+        file_node = Nokogiri::XML.parse("<xliff><file>#{@trans_unit}</file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).strings.size.should eql(1)
+      end
+
+      it "should have multiple strings" do
+        file_node = Nokogiri::XML.parse("<xliff><file>#{@trans_unit * 10}</file></xliff>").xpath("//file").first
+        XLIFF::File.new(file_node).strings.size.should eql(10)
+      end
+    end
+  end
+end

data/spec/xliffer/string_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'nokogiri'
+
+module XLIFFer
+  describe XLIFF::String do
+    context "#new" do
+      before(:all) do
+        @minimal_trans_unit = <<-EOF
+        <trans-unit id="my id">
+          <source>Hello World</source>
+          <target>Bonjour le monde</target>
+        </trans-unit>
+        EOF
+      end
+      it "is created with a nokogiri trans-unit node" do
+        trans_unit_node = Nokogiri::XML.parse(@minimal_trans_unit).xpath("//trans-unit").first
+        XLIFF::String.new(trans_unit_node).should be
+      end
+
+      it "can't be created with a string" do
+        expect{XLIFF::String.new("<file></file>")}.to raise_error ArgumentError
+      end
+
+      it "can't be created with a node that is not a file node" do
+        trans_unit_node = Nokogiri::XML.parse("<xliff></xliff>").xpath("/xliff").first
+        expect{XLIFF::String.new(trans_unit_node)}.to raise_error ArgumentError
+      end
+
+      it "have one source" do
+        xml = "<trans-unit><target></target></trans-unit>"
+        trans_unit_node = Nokogiri::XML.parse(xml).xpath("//trans-unit").first
+        expect{XLIFF::String.new(trans_unit_node)}.to raise_error NoElement
+      end
+
+      it "don't have multiple sources tag" do
+        xml = "<trans-unit>#{"<source></source>"*2}<target></target></trans-unit>"
+        trans_unit_node = Nokogiri::XML.parse(xml).xpath("//trans-unit").first
+        expect{XLIFF::String.new(trans_unit_node)}.to raise_error MultipleElement
+      end
+
+      it "don't have multiple targets tag" do
+        xml = "<trans-unit><source></source>#{"<target></target>"*2}</trans-unit>"
+        trans_unit_node = Nokogiri::XML.parse(xml).xpath("//trans-unit").first
+        expect{XLIFF::String.new(trans_unit_node)}.to raise_error MultipleElement
+      end
+    end
+
+    context "#id" do
+      it "is nil if not defined" do
+        xml = "<trans-unit><source></source><target></target></trans-unit>"
+        trans_unit_node = Nokogiri::XML.parse(xml).xpath("//trans-unit").first
+        XLIFF::String.new(trans_unit_node).id.should be nil
+      end
+
+      it "is the id attribute on trans-unit tag" do
+        xml = "<trans-unit id='my id'><source></source><target></target></trans-unit>"
+        trans_unit_node = Nokogiri::XML.parse(xml).xpath("//trans-unit").first
+        XLIFF::String.new(trans_unit_node).id.should eql("my id")
+      end
+    end
+
+
+    #context "#strings" do
+    #  before(:all) do
+    #    @trans_unit = <<-EOF
+    #    <trans-unit id="my id">
+    #      <source>Hello World</source>
+    #      <target>Bonjour le monde</target>
+    #    </trans-unit>
+    #    EOF
+    #  end
+    #  it "is an array " do
+    #    trans_unit_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+    #    XLIFF::File.new(trans_unit_node).strings.should be_kind_of(Array)
+    #  end
+
+    #  it "can be empty" do
+    #    trans_unit_node = Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+    #    XLIFF::File.new(trans_unit_node).strings.should be_empty
+    #  end
+
+    #  it "should have a string" do
+    #    trans_unit_node = Nokogiri::XML.parse("<xliff><file>#{@trans_unit}</file></xliff>").xpath("//file").first
+    #    XLIFF::File.new(trans_unit_node).strings.size.should eql(1)
+    #  end
+
+    #  it "should have multiple strings" do
+    #    trans_unit_node = Nokogiri::XML.parse("<xliff><file>#{@trans_unit * 10}</file></xliff>").xpath("//file").first
+    #    XLIFF::File.new(trans_unit_node).strings.size.should eql(10)
+    #  end
+    #end
+  end
+end

data/spec/xliffer/xliff_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module XLIFFer
+  describe XLIFF do
+    context "#new" do
+      it "accepts a xliff file" do
+        XLIFF.new(::File.open("spec/files/empty.xliff")).should be
+      end
+
+      it "accepts a xliff string" do
+        XLIFF.new(::File.open("spec/files/empty.xliff").read).should be
+      end
+
+      it "doesn't accept a number" do
+        expect{XLIFF.new(123)}.to raise_error ArgumentError
+      end
+
+      it "doesn't accept a random string" do
+        expect{XLIFF.new("foobar")}.to raise_error FormatError
+      end
+
+      it "doesn't accept a random file" do
+        expect{XLIFF.new(::File.new("spec/files/file.foobar"))}.to raise_error FormatError
+      end
+    end
+
+    context "#version" do
+      it "is the xliff version" do
+        XLIFF.new('<xliff version="9.8"></xliff>').version.should eql("9.8")
+      end
+
+      it "is nil when it is not present" do
+        XLIFF.new('<xliff></xliff>').version.should be_nil
+      end
+
+      it "is a string when there is a xliff version" do
+        XLIFF.new('<xliff version="9.8"></xliff>').version.should be_kind_of(String)
+      end
+    end
+
+    context "#files" do
+      it "is an array " do
+        XLIFF.new('<xliff></xliff>').files.should be_kind_of(Array)
+      end
+
+      it "can be empty" do
+        XLIFF.new('<xliff></xliff>').files.should be_empty
+      end
+
+      it "should have a file" do
+        XLIFF.new('<xliff><file></file></xliff>').files.first.should be_kind_of(XLIFF::File)
+      end
+
+      it "should have multiple files" do
+        XLIFF.new('<xliff><file></file><file></file></xliff>').files.size.should eql(2)
+      end
+    end
+  end
+end

data/spec/xliffer_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe XLIFFer do
+end

data/xliffer.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'xliffer/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'xliffer'
+  s.version     = XLIFFer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses   = ["MIT"]
+  s.date        = '2012-01-01'
+  s.summary     = "A XLIFF parser"
+  s.description = "A parser for XLIFF files"
+  s.authors     = ["Felipe Tanus"]
+  s.email       = 'fotanus@gmail.com'
+  s.homepage    = 'http://github.com/fotanus/xliff'
+
+  s.add_development_dependency "rspec", "~> 2"
+  s.rubyforge_project = "xliffer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: xliffer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Felipe Tanus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A parser for XLIFF files
+email: fotanus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/xliffer.rb
+- lib/xliffer/exceptions.rb
+- lib/xliffer/version.rb
+- lib/xliffer/xliff.rb
+- lib/xliffer/xliff/file.rb
+- lib/xliffer/xliff/string.rb
+- spec/files/empty.xliff
+- spec/files/file.foobar
+- spec/files/wiki.xliff
+- spec/files/xliffspec1.xliff
+- spec/spec_helper.rb
+- spec/xliffer/file_spec.rb
+- spec/xliffer/string_spec.rb
+- spec/xliffer/xliff_spec.rb
+- spec/xliffer_spec.rb
+- xliffer.gemspec
+homepage: http://github.com/fotanus/xliff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: xliffer
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A XLIFF parser
+test_files: []