puttext 0.1.0

data/spec/unit/po_entry_spec.rb

@@ -0,0 +1,327 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'unindent'
+
+describe PutText::POEntry do
+  describe '#initialize' do
+    context 'creating a simple PO entry' do
+      let(:entry) { described_class.new(msgid: 'An error occurred!') }
+
+      it 'sets the passed msgid attribute' do
+        expect(entry.msgid).to eq('An error occurred!')
+      end
+
+      it 'sets msgid_plural to nil' do
+        expect(entry.msgid_plural).to be nil
+      end
+
+      it 'sets msgctxt to nil' do
+        expect(entry.msgctxt).to be nil
+      end
+
+      it 'sets references to an empty array' do
+        expect(entry.references).to eq([])
+      end
+    end
+
+    context 'creating a pluralized entry' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          msgid_plural: '%d errors occurred!'
+        )
+      end
+
+      it 'sets the passed msgid attribute' do
+        expect(entry.msgid).to eq('An error occurred!')
+      end
+
+      it 'sets the passed msgid_plural attribute' do
+        expect(entry.msgid_plural).to eq('%d errors occurred!')
+      end
+    end
+
+    context 'creating an entry with a context' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          msgctxt: 'Error modal'
+        )
+      end
+
+      it 'sets the passed msgid attribute' do
+        expect(entry.msgid).to eq('An error occurred!')
+      end
+
+      it 'sets the passed msgctxt attribute' do
+        expect(entry.msgctxt).to eq('Error modal')
+      end
+    end
+
+    context 'creating an entry with references' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          references: ['errors.rb:15']
+        )
+      end
+
+      it 'sets the passed msgid attribute' do
+        expect(entry.msgid).to eq('An error occurred!')
+      end
+
+      it 'sets the passed msgctxt attribute' do
+        expect(entry.references).to eq(['errors.rb:15'])
+      end
+    end
+
+    context 'creating an entry with a context in msgid' do
+      context 'context is separated by the default separator' do
+        let(:entry) do
+          described_class.new(
+            msgid: 'Error modal|An error occurred!'
+          )
+        end
+
+        it 'sets the correct separated msgid' do
+          expect(entry.msgid).to eq('An error occurred!')
+        end
+
+        it 'sets the passed msgctxt attribute' do
+          expect(entry.msgctxt).to eq('Error modal')
+        end
+      end
+
+      context 'context is separated by a custom separator' do
+        let(:entry) do
+          described_class.new(
+            msgid: 'Error modal;;An error occurred!',
+            separator: ';;'
+          )
+        end
+
+        it 'sets the correct separated msgid' do
+          expect(entry.msgid).to eq('An error occurred!')
+        end
+
+        it 'sets the passed msgctxt attribute' do
+          expect(entry.msgctxt).to eq('Error modal')
+        end
+      end
+    end
+  end
+
+  describe '#references?' do
+    context 'entry has references' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          references: ['errors.rb:15']
+        )
+      end
+
+      it 'returns true' do
+        expect(entry.references?).to be true
+      end
+    end
+
+    context 'entry does not have references' do
+      let(:entry) { described_class.new(msgid: 'An error occurred!') }
+
+      it 'returns false' do
+        expect(entry.references?).to be false
+      end
+    end
+  end
+
+  describe '#plural?' do
+    context 'entry is a pluralized entry' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          msgid_plural: '%d errors occurred!'
+        )
+      end
+
+      it 'returns true' do
+        expect(entry.plural?).to be true
+      end
+    end
+
+    context 'entry is not pluralized entry' do
+      let(:entry) { described_class.new(msgid: 'An error occurred!') }
+
+      it 'returns false' do
+        expect(entry.plural?).to be false
+      end
+    end
+  end
+
+  describe '#merge' do
+    let(:entry) do
+      described_class.new(
+        msgid: 'An error occurred!',
+        references: ['errors.rb:15']
+      )
+    end
+
+    let(:other_entry) do
+      described_class.new(
+        msgid: 'An error occurred!',
+        references: [
+          'subfolder/random_file.rb:5',
+          'subfolder/another_file.rb:168'
+        ]
+      )
+    end
+
+    let(:merged_entry) { entry.merge(other_entry) }
+
+    it 'merges references of both entries' do
+      expect(merged_entry.references).to eq(
+        [
+          'errors.rb:15',
+          'subfolder/random_file.rb:5',
+          'subfolder/another_file.rb:168'
+        ]
+      )
+    end
+  end
+
+  describe '#unique_key' do
+    let(:entry_1) { described_class.new(msgid: 'An error occurred!') }
+    let(:entry_2) { described_class.new(msgid: 'Another message') }
+
+    let(:ctxt_entry_1) do
+      described_class.new(
+        msgid: 'An error occurred!',
+        msgctxt: 'Error modal'
+      )
+    end
+
+    let(:ctxt_entry_2) do
+      described_class.new(
+        msgid: 'An error occurred!',
+        msgctxt: 'Error modal'
+      )
+    end
+
+    context 'comparing the key from the same entry' do
+      it 'returns the same key' do
+        expect(entry_1.unique_key).to eq(entry_1.unique_key)
+      end
+    end
+
+    context 'comparing keys of entries with the same message and context' do
+      it 'returns the same key' do
+        expect(ctxt_entry_1.unique_key).to eq(ctxt_entry_2.unique_key)
+      end
+    end
+
+    context 'comparing keys of entries with different messages' do
+      it 'returns different keys' do
+        expect(entry_1.unique_key).not_to eq(entry_2.unique_key)
+      end
+    end
+
+    context 'comparing keys of entries with same message, different contexts' do
+      it 'returns different keys' do
+        expect(entry_1.unique_key).not_to eq(ctxt_entry_1.unique_key)
+      end
+    end
+  end
+
+  describe '#to_s' do
+    context 'with a simple PO entry' do
+      let(:entry) { described_class.new(msgid: 'An error occurred!') }
+
+      it 'generates correct string' do
+        expect(entry.to_s).to eq(<<-PO.unindent)
+          msgid "An error occurred!"
+          msgstr ""
+        PO
+      end
+    end
+
+    context 'with a pluralized entry' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          msgid_plural: '%d errors occurred!'
+        )
+      end
+
+      it 'generates correct string' do
+        expect(entry.to_s).to eq(<<-PO.unindent)
+          msgid "An error occurred!"
+          msgid_plural "%d errors occurred!"
+          msgstr[0] ""
+          msgstr[1] ""
+        PO
+      end
+    end
+
+    context 'with an entry with a context' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          msgctxt: 'Error modal'
+        )
+      end
+
+      it 'generates correct string' do
+        expect(entry.to_s).to eq(<<-PO.unindent)
+          msgctxt "Error modal"
+          msgid "An error occurred!"
+          msgstr ""
+        PO
+      end
+    end
+
+    context 'with an entry with references' do
+      let(:entry) do
+        described_class.new(
+          msgid: 'An error occurred!',
+          references: ['errors.rb:15', 'another/file.rb:168']
+        )
+      end
+
+      it 'generates correct string' do
+        expect(entry.to_s).to eq(<<-PO.unindent)
+          #: errors.rb:15 another/file.rb:168
+          msgid "An error occurred!"
+          msgstr ""
+        PO
+      end
+    end
+
+    context 'with multiline msgid' do
+      let(:entry) do
+        described_class.new(
+          msgid: "An error occurred!\nHorrible error description"
+        )
+      end
+
+      it 'generates correct string' do
+        expect(entry.to_s).to eq(<<-PO.unindent)
+          msgid ""
+          "An error occurred!\\n"
+          "Horrible error description"
+          msgstr ""
+        PO
+      end
+    end
+
+    context 'with characters in msgid that need to be escaped' do
+      let(:entry) { described_class.new(msgid: "\tAn \"error\" occurred!") }
+
+      it 'generates correct string' do
+        expect(entry.to_s).to eq(<<-PO.unindent)
+          msgid "\\tAn \\"error\\" occurred!"
+          msgstr ""
+        PO
+      end
+    end
+  end
+end

data/spec/unit/po_file_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'unindent'
+
+describe PutText::POFile do
+  describe '#initialize' do
+    let(:entry_1) { PutText::POEntry.new(msgid: 'One error occurred') }
+    let(:entry_2) { PutText::POEntry.new(msgid: 'Another error occurred') }
+    let(:file) { described_class.new([entry_1, entry_2]) }
+
+    it 'creates a POFile with the specified entries' do
+      expect(file.entries).to eq([entry_1, entry_2])
+    end
+  end
+
+  describe '#to_s' do
+    let(:entry_1) do
+      PutText::POEntry.new(
+        msgid: 'Error #1 occurred',
+        references: ['error1.rb:1']
+      )
+    end
+
+    let(:entry_2) do
+      PutText::POEntry.new(
+        msgid: 'Error #2 occurred',
+        references: ['error2.rb:2']
+      )
+    end
+
+    let(:entry_3) do
+      PutText::POEntry.new(
+        msgid: 'Error #2 occurred',
+        references: ['error2.rb:8']
+      )
+    end
+
+    let(:file) { described_class.new([entry_1, entry_2, entry_3]) }
+
+    it 'generates correct string' do
+      expect(file.to_s).to eq(<<-PO.unindent)
+        #: error1.rb:1
+        msgid "Error #1 occurred"
+        msgstr ""
+
+        #: error2.rb:2 error2.rb:8
+        msgid "Error #2 occurred"
+        msgstr ""
+      PO
+    end
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: puttext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mantas Norvaiša
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: unindent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email: mntnorv@gmail.com
+executables:
+- puttext
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitattributes"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/puttext
+- lib/puttext.rb
+- lib/puttext/cmdline.rb
+- lib/puttext/extractor.rb
+- lib/puttext/parser/base.rb
+- lib/puttext/parser/ruby.rb
+- lib/puttext/parser/slim.rb
+- lib/puttext/po_entry.rb
+- lib/puttext/po_file.rb
+- puttext.gemspec
+- spec/fixtures/extractor_fixtures/another_file.php
+- spec/fixtures/extractor_fixtures/file_1.rb
+- spec/fixtures/extractor_fixtures/file_2.rb
+- spec/fixtures/extractor_fixtures/random_file.txt
+- spec/fixtures/extractor_fixtures/subfolder/subfile.py
+- spec/fixtures/extractor_fixtures/subfolder/subfile_1.rb
+- spec/fixtures/extractor_fixtures/subfolder/subfile_2.rb
+- spec/fixtures/parser_base_shared_fixture.rb
+- spec/shared/parser_base_shared.rb
+- spec/spec_helper.rb
+- spec/unit/extractor_spec.rb
+- spec/unit/parser/ruby_spec.rb
+- spec/unit/parser/slim_spec.rb
+- spec/unit/po_entry_spec.rb
+- spec/unit/po_file_spec.rb
+homepage: https://github.com/mntnorv/puttext
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Extract gettext strings from Ruby source
+test_files: []