minigl 2.3.9 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7475dd66f98076ad86cc143943c75f186e6b696aba46083b71727ad69e95b0
-  data.tar.gz: 87bec4f94e32553a70ea4ca4318357bbadb71ffc6600859a8c63ec772e708137
+  metadata.gz: a0cbb7ddb129a7fea30f09ad6d5c89b3cef8b9b9b83d5f7f9eeacc76b09227ca
+  data.tar.gz: 7297a8c63e1df8cf85d6d61ccfa4fd80cdf8676dc06fe8467aca522ab10bbe38
 SHA512:
-  metadata.gz: '09094e3898b3a19939f39acf33ba4514db24bb1771b7795769a632e7f7230874058f921609d0760ea5958b42ca70e0a5b2224c974c5d3a80b4f1d2d1e59ad4cc'
-  data.tar.gz: ad1fc0475cee6c71ec019e5f8516b077da8ba4f37fbd95136137acb4716f83fe3fff42f68a5c458841c80732e8117776ac14c696c70b776d06c8b73860b379f5
+  metadata.gz: 0ceda66b6723094d415a11d23cd3c0c5b69a496fe655f7f7a72cb7298bd5606f38d8755d9868a7e878e6a27a56350c2dbe9e513e4d3c247c7ac504a9356bd9b5
+  data.tar.gz: 8d1dd2b962d597547d54f51e18b2332ec201bbbca19f4fc1d3a584b52bb979937366c9f11719b05ce07fba43aade40137df270530e60935f56cc99b9b36d052f

data/README.md

@@ -37,10 +37,9 @@ After installing the Gosu dependencies, you can just `gem install minigl`.
   * The [wiki](https://github.com/victords/minigl/wiki) is a work in progress with tutorials and examples.
   * Test package and examples aren't complete!
 
-## Version 2.3.9
+## Version 2.4.0
 
-  * Fixed click detection for very short clicks.
-  * Allow combining `center` and `margin` for `Button` text.
+  * Added the `Localization` class! Check out [the documentation](http://www.rubydoc.info/gems/minigl/MiniGL/Localization) to learn more.
 
 ## Contributing
 

data/lib/minigl/localization.rb

@@ -0,0 +1,79 @@
+module MiniGL
+  # This class provides methods to easily retrieve string translations from
+  # text files.
+  class Localization
+    class << self
+      # The list of available languages. These are symbols corresponding to the
+      # names of the files in data/text, without the '.txt' extension.
+      attr_reader :languages
+
+      # The current language. It's a symbol corresponding to the name of the
+      # file in data/text for that language, without the '.txt' extension.
+      attr_reader :language
+
+      # Initializes the localization system. If you're using a custom
+      # +Res.prefix+, call this _after_ setting it.
+      #
+      # The localization system will look for files with extension '.txt' in
+      # the <code>[Res.prefix]/data/text</code> folder. In each file,
+      # each string should be specified in one line, with the following format:
+      #
+      # <code>identifier    content content content...</code>
+      #
+      # Use tab characters between the identifier and the text, not white
+      # spaces. This makes it easier to make all the texts aligned and is
+      # required for the localization system to work. The identifiers will be
+      # used as symbols when retrieving strings.
+      #
+      # The text contents support placeholders, i.e., markers that can be
+      # replaced by arguments you pass to +Localization.text+. To specify a
+      # placeholder, simply use the '$' character. For example, if your string
+      # is:
+      #
+      # <code>my_string    Values: $ and $</code>
+      #
+      # the call <code>Localization.text(:my_string, 'test', 10)</code> will
+      # result in "Values: test and 10."
+      #
+      # To include a literal '$'
+      # in the text, use '\\$' (without the quotes). Similarly, use '\\\\' to
+      # represent a literal backslash, and just '\\' to represent a line break
+      # (i.e. a "\\n" in the resulting string).
+      def initialize
+        @languages = []
+        @texts = {}
+        files = Dir["#{Res.prefix}text/*.txt"].sort
+        files.each do |f|
+          lang = f.split('/')[-1].chomp('.txt').to_sym
+          @languages << lang
+          @texts[lang] = {}
+          File.open(f).each do |l|
+            parts = l.split("\t")
+            @texts[lang][parts[0].to_sym] = parts[-1].chomp
+          end
+        end
+
+        @language = @languages[0]
+      end
+
+      # Sets the current language. +value+ must be a symbol corresponding to
+      # the name of a file in data/text, without the '.txt' extension.
+      def language=(value)
+        raise "Can't set to invalid language #{value}" unless @languages.include?(value)
+
+        @language = value
+      end
+
+      # Retrieves the string identified by +id+ in the current language.
+      #
+      # See +Localization.initialize+ for details on how to use +args+.
+      def text(id, *args)
+        value = @texts[@language][id] || '<MISSING STRING>'
+        args.each do |arg|
+          value = value.sub(/(^|[^\\])\$/, "\\1#{arg}")
+        end
+        value.gsub('\\$', '$').gsub(/\\(.|$)/) { |m| m[1] == '\\' ? '\\' : "\n#{m[1]}" }
+      end
+    end
+  end
+end

data/lib/minigl.rb

@@ -2,3 +2,4 @@ require_relative 'minigl/game_object'
 require_relative 'minigl/map'
 require_relative 'minigl/text'
 require_relative 'minigl/forms'
+require_relative 'minigl/localization'

data/test/data/text/english.txt

@@ -0,0 +1,6 @@
+str1	Common string.
+str2	String with \$ dollar sign.
+str3	$ should be replaced.
+str4	Should replace both $ and $.
+str5	String with \\ backslash.
+str6	String with\line breaks.\

data/test/data/text/portuguese.txt

@@ -0,0 +1,6 @@
+str1	String comum.
+str2	String com \$ cifrão.
+str3	$ deve ser substituído.
+str4	Deve substituir $ e $.
+str5	String com \\ barra invertida.
+str6	String com\quebras de linha.\

data/test/localization_tests.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require_relative '../lib/minigl'
+include MiniGL
+
+class LocalizationTest < Test::Unit::TestCase
+  def setup
+    Res.prefix = File.expand_path(File.dirname(__FILE__)) + '/data'
+    Localization.initialize
+  end
+
+  def test_languages
+    assert_equal([:english, :portuguese], Localization.languages)
+  end
+
+  def test_language
+    assert_equal(:english, Localization.language)
+    Localization.language = :portuguese
+    assert_equal(:portuguese, Localization.language)
+    assert_raise { Localization.language = :invalid }
+    assert_equal(:portuguese, Localization.language)
+  end
+
+  def test_strings
+    assert_equal('Common string.', Localization.text(:str1))
+    assert_equal('String with $ dollar sign.', Localization.text(:str2))
+    assert_equal('something should be replaced.', Localization.text(:str3, 'something'))
+    assert_equal('Should replace both 5 and true.', Localization.text(:str4, 5, true))
+    assert_equal('String with \\ backslash.', Localization.text(:str5))
+    assert_equal("String with\nline breaks.\n", Localization.text(:str6))
+    assert_equal('<MISSING STRING>', Localization.text(:str7))
+
+    Localization.language = :portuguese
+    assert_equal('String comum.', Localization.text(:str1))
+    assert_equal('String com $ cifrão.', Localization.text(:str2))
+    assert_equal('algo deve ser substituído.', Localization.text(:str3, 'algo'))
+    assert_equal('Deve substituir 5 e true.', Localization.text(:str4, 5, true))
+    assert_equal('String com \\ barra invertida.', Localization.text(:str5))
+    assert_equal("String com\nquebras de linha.\n", Localization.text(:str6))
+    assert_equal('<MISSING STRING>', Localization.text(:str7))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 2.3.9
+  version: 2.4.0
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -43,6 +43,7 @@ files:
 - lib/minigl/forms.rb
 - lib/minigl/game_object.rb
 - lib/minigl/global.rb
+- lib/minigl/localization.rb
 - lib/minigl/map.rb
 - lib/minigl/movement.rb
 - lib/minigl/text.rb
@@ -70,10 +71,13 @@ files:
 - test/data/img/tile2.svg
 - test/data/img/tile2b.png
 - test/data/sound/1.wav
+- test/data/text/english.txt
+- test/data/text/portuguese.txt
 - test/data/tileset/tileset1.png
 - test/game.rb
 - test/game_object_tests.rb
 - test/iso_game.rb
+- test/localization_tests.rb
 - test/map_tests.rb
 - test/mov_game.rb
 - test/movement_tests.rb
@@ -107,6 +111,7 @@ test_files:
 - test/game.rb
 - test/game_object_tests.rb
 - test/iso_game.rb
+- test/localization_tests.rb
 - test/map_tests.rb
 - test/mov_game.rb
 - test/movement_tests.rb
@@ -136,5 +141,7 @@ test_files:
 - test/data/img/tile2.svg
 - test/data/img/tile2b.png
 - test/data/sound/1.wav
+- test/data/text/english.txt
+- test/data/text/portuguese.txt
 - test/data/tileset/tileset1.png
 - test/data/img/sub/image.png