gettext-slim 1.0.0

data/doc/text/lgpl-3.0.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/doc/text/news.md

@@ -0,0 +1,5 @@
+# News
+
+## 1.0.0: 2020-01-11 {#version-1.0.0}
+
+Initial release!!!

data/gettext-slim.gemspec

@@ -0,0 +1,50 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2020  Sutou Kouhei <kou@clear-code.com>
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "lib/gettext-slim/version"
+
+Gem::Specification.new do |s|
+  s.name = "gettext-slim"
+  s.version = GetTextSlim::VERSION
+  s.summary = "This is a gettext plugin to support Slim."
+  s.description = <<-DESCRIPTION
+You can extract messages from Slim files with this library.
+  DESCRIPTION
+  s.authors = ["Kouhei Sutou"]
+  s.email = ["kou@clear-code.com"]
+  s.homepage = "https://ruby-gettext.github.io/"
+  s.license = "LGPLv3+"
+
+  s.require_paths = ["lib"]
+  s.files = Dir.glob("lib/**/*.rb")
+  s.files += Dir.glob("doc/text/**/*.*")
+  s.files += [
+    "#{s.name}.gemspec",
+    ".yardopts",
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+  ]
+  s.test_files = Dir.glob("test/**/*.rb")
+
+  s.add_runtime_dependency("gettext")
+  s.add_runtime_dependency("slim")
+  s.add_development_dependency("kramdown")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("test-unit")
+  s.add_development_dependency("yard")
+end

data/lib/gettext-slim.rb

@@ -0,0 +1,20 @@
+# Copyright (C) 2020  Sutou Kouhei <kou@clear-code.com>
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "gettext-slim/parser"
+require_relative "gettext-slim/version"
+
+require "gettext/tools/xgettext"
+GetText::Tools::XGetText.add_parser(GetTextSlim::Parser)

data/lib/gettext-slim/parser.rb

@@ -0,0 +1,88 @@
+# Copyright (C) 2020  Sutou Kouhei <kou@clear-code.com>
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+require "gettext/tools/parser/ruby"
+require "slim"
+
+module GetTextSlim
+  class Parser
+    @config = {
+      :extnames => [".slim"]
+    }
+
+    class << self
+      # Sets some preferences to parse Slim files.
+      # * config: a Hash of the config. It can takes some values below:
+      #   * :extnames: An Array of target files extension. Default is [".slim"].
+      def init(config)
+        config.each do |key, value|
+          @config[key] = value
+        end
+      end
+
+      def target?(file) # :nodoc:
+        @config[:extnames].each do |extname|
+          return true if File.extname(file) == extname
+        end
+        false
+      end
+
+      # Parses Slim file located at `path`.
+      #
+      # This is a short cut method. It equals to `new(path,
+      # options).parse`.
+      #
+      # @return [Array<POEntry>] Extracted messages
+      # @see #initialize and #parse
+      def parse(path, options={})
+        parser = new(path, options)
+        parser.parse
+      end
+    end
+
+    # @param path [String] Slim file path to be parsed
+    # @param options [Hash]
+    def initialize(path, options={})
+      @path = path
+      @options = options
+    end
+
+    # Extracts messages from @path.
+    #
+    # @return [Array<POEntry>] Extracted messages
+    def parse
+      content = File.open(@path, "rb", &:read)
+      encoding = detect_encoding(content) || content.encoding
+      content.force_encoding(encoding)
+
+      template = Slim::Template.new(@path) do
+        content
+      end
+      source = template.precompiled_template
+
+      ruby_parser = GetText::RubyParser.new(@path, @options)
+      ruby_parser.parse_source(source)
+    end
+
+    private
+    def detect_encoding(content)
+      if /\A-#.*coding:\s*([^\s]*)/ =~ content
+        $1
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/gettext-slim/version.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2020  Sutou Kouhei <kou@clear-code.com>
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+module GetTextSlim
+  VERSION = "1.0.0"
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2020  Sutou Kouhei <kou@clear-code.com>
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+require "tempfile"
+
+require "gettext-slim"

data/test/run-test.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2020  Sutou Kouhei <kou@clear-code.com>
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+$VERBOSE = true
+
+base_dir = File.expand_path(File.join(__dir__, ".."))
+lib_dir = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "test")
+
+$LOAD_PATH.unshift(lib_dir)
+
+require "test-unit"
+
+require_relative "helper"
+
+exit(Test::Unit::AutoRunner.run(true, test_dir))

data/test/test-parser.rb

@@ -0,0 +1,86 @@
+# Copyright (C) 2020  Sutou Kouhei <kou@clear-code.com>
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+class ParserTest < Test::Unit::TestCase
+  def setup
+    @slim_file = Tempfile.new(["test", ".slim"])
+  end
+
+  def parse(content)
+    @slim_file.rewind
+    @slim_file.print(content)
+    @slim_file.rewind
+    GetTextSlim::Parser.parse(@slim_file.path)
+  end
+
+  def assert_parse(expected, content)
+    assert_equal(normalize_expected(expected),
+                 normalize_actual(parse(content)))
+  end
+
+  def normalize_expected(messages)
+    messages.collect do |message|
+      default = {
+        :msgid        => nil,
+        :msgid_plural => nil,
+        :msgctxt      => nil,
+        :msgstr       => nil,
+        :separator    => nil,
+        :references   => nil,
+      }
+      default.merge(message)
+    end
+  end
+
+  def normalize_actual(po)
+    po.collect do |po_entry|
+      {
+        :msgid        => po_entry.msgid,
+        :msgid_plural => po_entry.msgid_plural,
+        :msgctxt      => po_entry.msgctxt,
+        :msgstr       => po_entry.msgstr,
+        :separator    => po_entry.separator,
+        :references   => po_entry.references,
+      }
+    end
+  end
+
+  def test_encoding_magic_comment
+    assert_parse([
+                   {
+                     :msgid => "こんにちは".encode("cp932"),
+                     :references => ["#{@slim_file.path}:3"],
+                   }
+                 ],
+                 <<-SLIM.encode("cp932"))
+-# -*- coding: cp932 -*-
+p
+  = _("こんにちは")
+                 SLIM
+  end
+
+  def test_no_paren
+    assert_parse([
+                   {
+                     :msgid => "Hello",
+                     :references => ["#{@slim_file.path}:2"],
+                   }
+                 ],
+                 <<-SLIM.encode("cp932"))
+p
+  = _ "Hello"
+                 SLIM
+  end
+end