twine-flutter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 586677a3df54ba426027489178ca89aaf7afb56237e679c85a9ca22685d5a08c
+  data.tar.gz: 8fc4f010b07820cd403f27a716e54f83c134178e10fd8ed3e99090bb2fb9278f
+SHA512:
+  metadata.gz: 346c7568b35680f03335f050a9618d569d1e0b1a2705b333ce2778be9374ad6ffc46800bed4df08fef8bb1167463d83206016736be1780da8edbdae83b423803
+  data.tar.gz: 502b267c3bc039c7435504efa81ef6c0f2d6ad444295e69b6691253dc24f911046c028eb034709426ba6d298135bb2db3ce87c900de21e5db0d47496050f0f70

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, Tiknil
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,11 @@
+# Twine Flutter formatter plugin
+This [twine](https://github.com/scelis/twine) plugin provide a formatter for `.arb` files, used by Flutter projects.
+
+## Installation
+Install this gem:
+
+```gem install twine-flutter```
+
+Then setup twine to use it as described [here](https://github.com/scelis/twine/blob/main/documentation/formatters.md#plugins).
+
+```gems: twine-flutter```

data/lib/formatter.rb

@@ -0,0 +1,90 @@
+module Twine
+    module Formatters
+        class Flutter < Abstract
+            def format_name
+                'flutter'
+            end
+            
+            def extension
+                '.arb'
+            end
+            
+            def default_file_name
+                'app.arb'
+            end
+            
+            def determine_language_given_path(path)
+                match = /^.+_([^-]{2})\.arb$/.match File.basename(path)
+                return match[1] if match
+                
+                return super
+            end
+            
+            def read(io, lang)
+                begin
+                    require "json"
+                rescue LoadError
+                    raise Twine::Error.new "You must run `gem install json` in order to read or write flutter files."
+                end
+                
+                json = JSON.load(io)
+                json.each do |key, value|
+                    if key == "@@locale"
+                        # Ignore because it represents the file lang
+                    elsif key[0,1] == "@"
+                        description_value = "{\n        \"description\":\"#{value}\"\n    }"
+                        if value["description"]
+                            set_comment_for_key(key[1..-1], value["description"])
+                        end
+                    else
+                        set_translation_for_key(key, lang, value)
+                    end
+                end
+            end
+            
+            def format_file(lang)
+                result = super
+                return result unless result
+                "{\n    \"@@locale\": \"#{lang}\",\n\n#{super}\n}"
+            end
+            
+            def format_sections(twine_file, lang)
+                sections = twine_file.sections.map { |section| format_section(section, lang) }
+                sections.delete_if(&:empty?)
+                sections.join(",\n\n")
+            end
+            
+            def format_section_header(section)
+                "\n"
+            end
+            
+            def format_section(section, lang)
+                definitions = section.definitions.dup
+                
+                definitions.map! { |definition| format_definition(definition, lang) }
+                definitions.compact! # remove nil definitions
+                definitions.join(",\n")
+            end
+
+            def format_definition(definition, lang)
+                [format_key_value(definition, lang), format_comment(definition, lang)].compact.join(",\n")
+            end
+            
+            def key_value_pattern
+                "    \"%{key}\": \"%{value}\""
+            end
+
+            def format_comment(definition, lang)
+                "    \"@#{definition.key}\": {\n        \"description\": \"#{definition.comment}\"\n    }" if definition.comment
+              end
+            
+            def format_key(key)
+                escape_quotes(key)
+            end
+            
+            def format_value(value)
+                escape_quotes(value)
+            end
+        end
+    end
+end

data/lib/twine-flutter.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'twine'
+
+require_relative 'formatter'
+
+Twine::Formatters.formatters << Twine::Formatters::Flutter.new

data/test/fixtures/flutter_format.arb

@@ -0,0 +1,15 @@
+{
+    "@@locale": "en",
+
+    "key1": "value1-english",
+    "@key1": {
+        "description": "comment key1"
+    },
+    "key2": "value2-english",
+
+    "key3": "value3-english",
+    "key4": "value4-english",
+    "@key4": {
+        "description": "comment key4"
+    }
+}

data/test/fixtures/twine.txt

@@ -0,0 +1,13 @@
+[[Section A]]
+    [key1]
+        en = value1-english
+        comment = comment key1
+    [key2]
+        en = value2-english
+        
+[[Section B]]
+    [key3]
+        en = value3-english
+    [key4]
+        en = value4-english
+        comment = comment key4

data/test/test_flutter_formatter.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'twine-flutter'
+
+class TestFlutterFormatter < Minitest::Test
+    def setup
+        formatter = Twine::Formatters::Flutter.new
+        formatter.twine_file = Twine::TwineFile.new
+        formatter.options = { consume_all: true, consume_comments: true }
+    end
+
+    def test_twine_to_arb
+        assert true #TODO
+    end
+
+    def test_arb_to_twine
+        assert true #TODO
+    end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: twine-flutter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabio Butti
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Plugin for twine that enables .arb generation for use with Flutter.
+email:
+- butti.fabio@tiknil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/formatter.rb
+- lib/twine-flutter.rb
+- test/fixtures/flutter_format.arb
+- test/fixtures/twine.txt
+- test/test_flutter_formatter.rb
+homepage: https://github.com/tiknil/twine-flutter
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Plugin for twine that enables .arb generation for use with Flutter
+test_files:
+- test/test_flutter_formatter.rb