xliffer 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b50380a2269eafb1911a8f06333d9c2c3aac05ad
-  data.tar.gz: d5d440b6d59e7720be43382854672c001a4148a8
+  metadata.gz: f2c02d93b1d9d6bab91e7f11acc68b009627647a
+  data.tar.gz: 47287acd5be0ca4262a2bdcfaf6e10f48ec0ce70
 SHA512:
-  metadata.gz: ae05afe6a609feb192e2f8eb116012514d8ad9d7e156653bb065bbe9c0f7b777f4c1ea9a73d8c5d4926fd02b067e74813df2cf953e6b08078de9cf36937b0ccb
-  data.tar.gz: 50740ecc58ee40c41cca7693ef2d539ddc25b580a2008761e3d3712a5fa2c150ed20db6a7ff9cefb630c3d2f47e188b5ab81311e0660b2747266fa962e910783
+  metadata.gz: f877905bc87525bd2771c8bd9f68ebfdf893147e73813ee8999f0c73636456d38e51aadca814874adf22bb5a34708600642e9e02e511ad4173f9cad28ea6040c
+  data.tar.gz: 3679c4fd443dd9c93788f758f55b09988ea31c252ff3a3dc75ad0e88676b59ab95575221ffca152fe95b3333cea82e9304bf19cb435bb164a59b7b848c1f21a4

data/Gemfile

@@ -10,6 +10,6 @@ group :test do
 end
 
 group :development do
-  gem 'rspec', '~> 2'
+  gem 'rspec', '~> 3'
   gem 'simplecov', '>= 0.9.0'
 end

data/README.md

@@ -6,9 +6,7 @@
 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.
+XLIFFer helps you to parse xliff files and get their content. You can read and modify your xliff files with it.
 
 Usage
 -----
@@ -30,9 +28,21 @@ puts file.source_language
 puts file.target_language
 
 # Prints all string and the translations on this file.
-file.strings.each do |string| 
+file.strings.each do |string|
   puts  "#{string.source} => #{string.target}"
 end
+
+# Changes the translation of texts "hi" to "oi"
+file.strings.find_all { |s| s.source = "hi" }.each do |string|
+  string.target = "oi"
+end
+
+# Modifies the translation of a string in the file with the given id,
+# or add the translation if don't exist
+file['target-string-id'].target = "new translation to this id"
+
+# Generate the new xml file with the change
+puts xliff.to_s
 ```
 
 
@@ -40,5 +50,3 @@ 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/lib/xliffer/version.rb

@@ -1,3 +1,3 @@
 module XLIFFer
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/xliffer/xliff.rb

@@ -20,11 +20,7 @@ module XLIFFer
 
     private
     def parse(text)
-      begin
-        @xml = Nokogiri::XML(text)
-      rescue
-        fail FormatError, "Not a XML file"
-      end
+      @xml = Nokogiri::XML(text)
 
       @xml.remove_namespaces!
       root = @xml.xpath('/xliff')

data/lib/xliffer/xliff/file.rb

@@ -11,13 +11,31 @@ module XLIFFer
           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) }
+        @xml = xml
+
+        @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
+
+      def [](id)
+        @strings.find { |s| s.id == id }
       end
 
+      def []=(id, target)
+        self[id].target = target
+      end
 
+      def source_language=(val)
+        @source_language = val
+        @xml['source-language'] = val
+      end
+
+      def target_language=(val)
+        @target_language = val
+        @xml['target-language'] = val
+      end
       private
 
       def file?(xml)

data/lib/xliffer/xliff/string.rb

@@ -20,6 +20,12 @@ module XLIFFer
         @target = val
       end
 
+      def source=(val)
+        source = @xml.xpath('./source')
+        source.first.content = val
+        @source = val
+      end
+
       private
 
       def trans_unit?(xml)

data/spec/files/simple.xliff

@@ -0,0 +1,11 @@
+<xliff version='1.2'>
+  <file original='hello.txt' source-language='en' target-language='fr' datatype='plaintext'>
+    <trans-unit id='hi'>
+      <source>Hello world</source>
+      <target>Bonjour le monde</target>
+      <alt-trans>
+        <target lang='es'>Hola mundo</target>
+      </alt-trans>
+    </trans-unit>
+  </file>
+</xliff>

data/spec/spec_helper.rb

@@ -11,7 +11,6 @@ require 'equivalent-xml/rspec_matchers'
 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'

data/spec/xliffer/file_spec.rb

@@ -3,10 +3,10 @@ require 'nokogiri'
 
 module XLIFFer
   describe XLIFF::File do
-    context "#new" do
+    describe "#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
+        expect(XLIFF::File.new(file_node)).to be
       end
 
       it "can't be created with a string" do
@@ -19,57 +19,137 @@ module XLIFFer
       end
     end
 
-    context "#original" do
+    describe "#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
+        expect(XLIFF::File.new(file_node).original).to 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")
+        expect(XLIFF::File.new(file_node).original).to eql("neat file.c")
       end
     end
 
-    context "#original" do
+    describe "#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
+        expect(XLIFF::File.new(file_node).original).to 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")
+        expect(XLIFF::File.new(file_node).original).to eql("neat file.c")
       end
     end
 
-    context "#source_language" do
+    describe "#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
+        expect(XLIFF::File.new(file_node).source_language).to 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")
+        expect(XLIFF::File.new(file_node).source_language).to eql("en")
       end
     end
 
-    context "#target_language" do
+    describe "#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
+        expect(XLIFF::File.new(file_node).target_language).to 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")
+        expect(XLIFF::File.new(file_node).target_language).to eql("fr")
       end
     end
 
-    context "#strings" do
-      before(:all) do
-        @trans_unit = <<-EOF
+    describe "attribute accessors" do
+      let(:subject) do
+        XLIFF::File.new Nokogiri::XML.parse("<xliff><file></file></xliff>").xpath("//file").first
+      end
+
+      describe "source_language=" do
+        it "changes the source language" do
+          file_node = Nokogiri::XML.parse('<xliff><file source-language="fr"></file></xliff>').xpath("//file").first
+          subject = XLIFF::File.new file_node
+          subject.source_language = 'en'
+          expect(subject.source_language).to eq('en')
+        end
+
+        it "adds source language if don't exist" do
+          subject.source_language = 'en'
+          expect(subject.source_language).to eq('en')
+        end
+      end
+
+      describe "target_language=" do
+        it "changes the target language" do
+          file_node = Nokogiri::XML.parse('<xliff><file target-language="fr"></file></xliff>').xpath("//file").first
+          subject = XLIFF::File.new file_node
+          subject.target_language = 'en'
+          expect(subject.target_language).to eq('en')
+        end
+
+        it "adds target language if don't exist" do
+          subject.target_language = 'en'
+          expect(subject.target_language).to eq('en')
+        end
+      end
+    end
+
+    describe "string accessors" do
+      let(:xml) do
+        <<-EOF
+        <file>
+          <trans-unit id="hello">
+            <source>Hello World</source>
+            <target>Bonjour le monde</target>
+          </trans-unit>
+          <trans-unit id="bye">
+            <source>Bye World</source>
+            <target>Au revoir le monde</target>
+          </trans-unit>
+          <trans-unit id="missing">
+            <source>Missing</source>
+          </trans-unit>
+        </file>
+        EOF
+      end
+
+      let(:subject) do
+        XLIFF::File.new(Nokogiri::XML.parse(xml).xpath("//file").first)
+      end
+
+      describe "[]" do
+        it "gets the string with this id" do
+          expect(subject['hello'].target).to eq("Bonjour le monde")
+        end
+
+        it "returns nil if no string found" do
+          expect(subject['non-existent id']).to be_nil
+        end
+      end
+
+      describe "[]=" do
+        it "changes the string target" do
+          subject['hello'] = 'changed text'
+          expect(subject['hello'].target).to eq('changed text')
+        end
+
+        it "adds a text if don't exist" do
+          subject['missing'] = 'new text'
+          expect(subject['missing'].target).to eq('new text')
+        end
+      end
+    end
+
+    describe "#strings" do
+      let(:trans_unit) do
+        <<-EOF
         <trans-unit id="my id">
           <source>Hello World</source>
           <target>Bonjour le monde</target>
@@ -78,22 +158,22 @@ module XLIFFer
       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)
+        expect(XLIFF::File.new(file_node).strings).to 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
+        expect(XLIFF::File.new(file_node).strings).to 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)
+        file_node = Nokogiri::XML.parse("<xliff><file>#{trans_unit}</file></xliff>").xpath("//file").first
+        expect(XLIFF::File.new(file_node).strings.size).to 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)
+        file_node = Nokogiri::XML.parse("<xliff><file>#{trans_unit * 10}</file></xliff>").xpath("//file").first
+        expect(XLIFF::File.new(file_node).strings.size).to eql(10)
       end
     end
   end

data/spec/xliffer/string_spec.rb

@@ -3,18 +3,19 @@ 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
+    let(:trans_unit) do
+      <<-EOF
+      <trans-unit id="my id">
+        <source>Hello World</source>
+        <target>Bonjour le monde</target>
+      </trans-unit>
+      EOF
+    end
+
+    describe "#new" do
       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
+        trans_unit_node = Nokogiri::XML.parse(trans_unit).xpath("//trans-unit").first
+        expect(XLIFF::String.new(trans_unit_node)).to be
       end
 
       it "can't be created with a string" do
@@ -45,63 +46,46 @@ module XLIFFer
       end
     end
 
-    context "#id" do
+    describe "#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
+        expect(XLIFF::String.new(trans_unit_node).id).to 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")
+        expect(XLIFF::String.new(trans_unit_node).id).to 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
-
+    describe "#target=" do
       it 'Modify target' do
-        trans_unit_node = Nokogiri::XML.parse(@trans_unit).xpath("//trans-unit").first
+        trans_unit_node = Nokogiri::XML.parse(trans_unit).xpath("//trans-unit").first
         string = XLIFF::String.new(trans_unit_node)
         string.target = 'Hola Mundo'
-        string.target.should eq 'Hola Mundo'
+        expect(string.target).to eq 'Hola Mundo'
       end
 
-      it 'Modify target if xml doensnt contain target initially' do
-        xml = "<trans-unit id='my id'><source>Value</source></trans-unit>"
-        trans_unit_node = Nokogiri::XML.parse(xml).xpath("//trans-unit").first
-        string = XLIFF::String.new(trans_unit_node)
-        string.target = 'Hola Mundo'
-        string.target.should eq 'Hola Mundo'
+      context 'when target do not exist' do
+        it 'add a new target' do
+          xml = "<trans-unit id='my id'><source>Value</source></trans-unit>"
+          trans_unit_node = Nokogiri::XML.parse(xml).xpath("//trans-unit").first
+          string = XLIFF::String.new(trans_unit_node)
+          string.target = 'Hola Mundo'
+          expect(string.target).to eq 'Hola Mundo'
+        end
       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
+    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
+    describe "#source=" do
+      it 'Modify source' do
+        trans_unit_node = Nokogiri::XML.parse(trans_unit).xpath("//trans-unit").first
+        string = XLIFF::String.new(trans_unit_node)
+        string.source = 'Hola Mundo'
+        expect(string.source).to eq 'Hola Mundo'
+      end
     end
   end
 end

data/spec/xliffer/xliff_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 
 module XLIFFer
   describe XLIFF do
-    context "#new" do
+    describe "#new" do
       it "accepts a xliff file" do
-        XLIFF.new(::File.open("spec/files/empty.xliff")).should be
+        expect(XLIFF.new(::File.open("spec/files/empty.xliff"))).to be
       end
 
       it "accepts a xliff string" do
-        XLIFF.new(::File.open("spec/files/empty.xliff").read).should be
+        expect(XLIFF.new(::File.open("spec/files/empty.xliff").read)).to be
       end
 
       it "doesn't accept a number" do
@@ -24,43 +24,60 @@ module XLIFFer
       end
     end
 
-    context "#version" do
+    describe "#version" do
       it "is the xliff version" do
-        XLIFF.new('<xliff version="9.8"></xliff>').version.should eql("9.8")
+        expect(XLIFF.new('<xliff version="9.8"></xliff>').version).to eql("9.8")
       end
 
       it "is nil when it is not present" do
-        XLIFF.new('<xliff></xliff>').version.should be_nil
+        expect(XLIFF.new('<xliff></xliff>').version).to 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)
+        expect(XLIFF.new('<xliff version="9.8"></xliff>').version).to be_kind_of(String)
       end
     end
 
-    context "#files" do
+    describe "#files" do
       it "is an array " do
-        XLIFF.new('<xliff></xliff>').files.should be_kind_of(Array)
+        expect(XLIFF.new('<xliff></xliff>').files).to be_kind_of(Array)
       end
 
       it "can be empty" do
-        XLIFF.new('<xliff></xliff>').files.should be_empty
+        expect(XLIFF.new('<xliff></xliff>').files).to be_empty
       end
 
       it "should have a file" do
-        XLIFF.new('<xliff><file></file></xliff>').files.first.should be_kind_of(XLIFF::File)
+        expect(XLIFF.new('<xliff><file></file></xliff>').files.first).to 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)
+        expect(XLIFF.new('<xliff><file></file><file></file></xliff>').files.size).to eql(2)
       end
     end
 
-    context "#regenate" do
-      it 'should output an xml' do
-        xml = ::File.open("spec/files/empty.xliff").read
+    describe "#to_s" do
+      it 'outputs a xml' do
+        xml = ::File.open("spec/files/simple.xliff").read
         xliff = XLIFF.new(xml)
-        expect(xliff.to_s).to be_equivalent_to(xml)
+        expect(Nokogiri::XML(xliff.to_s)).to be
+      end
+
+      context 'when xml is not changed' do
+        it 'outputs the same xml' do
+          xml = ::File.open("spec/files/simple.xliff").read
+          xliff = XLIFF.new(xml)
+          expect(xliff.to_s).to be_equivalent_to(xml)
+        end
+      end
+
+      context 'when xml is changed' do
+        it 'outputs a different xml' do
+          xml = ::File.open("spec/files/simple.xliff").read
+          xliff = XLIFF.new(xml)
+          xliff.files.first.strings.first.target = "My brand new target"
+          expect(xliff.to_s).not_to be_equivalent_to(xml)
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xliffer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Felipe Tanus
@@ -73,6 +73,7 @@ files:
 - lib/xliffer/xliff/string.rb
 - spec/files/empty.xliff
 - spec/files/file.foobar
+- spec/files/simple.xliff
 - spec/files/wiki.xliff
 - spec/files/xliffspec1.xliff
 - spec/spec_helper.rb