yamlfish 0.1.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5aa65ba0ad01cac58be18f2ff437609fa1c7009e586be2bf16e9a2828b80f8fa
+  data.tar.gz: 550c2d63e56849b9efa83e05f73b84f983026233f378beab1287096939c88480
+SHA512:
+  metadata.gz: bef480f8b6fed17353e2b1e46f7894b54f0b16eca8c37e379f4b805fc804c042bfe4b33338edf454adc0e3c3cfc167b1637ff59a1821730c7b492c41fc292060
+  data.tar.gz: 3dc0cfed2cf7b244b924a3a4485aa081b3f640e5f232393da93db46e2aa38ac200d02a8c7bab416b6cdd06c1b3e5ffabbe0d61c0af230516fed7a9c7bde99f7e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-16
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yamlfish-cli.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    yamlfish (0.1.0.alpha1)
+      activesupport (>= 6)
+      faraday (~> 2.0)
+      thor (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    net-http (0.4.1)
+      uri
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
+    thor (1.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (0.13.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  yamlfish!
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Adrien Siami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# Yamlfish

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yamlfish/cli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/yamlfish

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "thor"
+require_relative "../lib/yamlfish/cli"
+
+class YamlfishExe < Thor
+  desc "push", "Pushes translations to yamlfish"
+  option :branch, type: :string, default: "main"
+  def push(locale)
+    Yamlfish::Cli::Push.new(locale, branch: options[:branch]).call
+  end
+
+  desc "pull", "Pulls translations from yamlfish"
+  option :inplace, type: :boolean, default: false
+  option :force_update, type: :boolean, default: false
+  option :branch, type: :string, default: "main"
+  def pull(locale)
+    Yamlfish::Cli::Pull.new(locale, inplace: options[:inplace], force_update: options[:force_update], branch: options[:branch]).call
+  end
+end
+
+YamlfishExe.start(ARGV)

data/lib/refinements/dot_flatten.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Refinements
+  module DotFlatten
+    refine Hash do
+      def dot_flatten
+        each_with_object({}) do |(k, v), h|
+          if v.is_a? Hash
+            v.dot_flatten.map do |h_k, h_v|
+              h["#{k}.#{h_k}"] = h_v
+            end
+          else
+            h[k] = v
+          end
+        end
+      end
+
+      def dot_unflatten
+        each_with_object({}) do |(k, v), h|
+          parts = k.split(".")
+          data = h
+          parts[...-1].each do |part|
+            data = (data[part] ||= {})
+          end
+          data[parts.last] = v
+        end
+      end
+    end
+  end
+end

data/lib/yamlfish/cli/pull.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require_relative "../../refinements/dot_flatten"
+require_relative "yaml_dumper"
+
+module Yamlfish
+  module Cli
+    class Pull
+      using Refinements::DotFlatten
+
+      def initialize(locale_identifier, inplace: false, force_update: false, branch: "main")
+        @locale_identifier = locale_identifier
+        @inplace = inplace
+        @force_update = force_update
+        @branch = branch
+      end
+
+      def call
+        response = Faraday.get(
+          "#{Yamlfish::Cli.configuration.base_url}/projects/#{Yamlfish::Cli.configuration.project_token}/#{@branch}/locales/#{@locale_identifier}/export",
+          {},
+          {
+            "Authorization": "Bearer #{Yamlfish::Cli.configuration.api_key}"
+          }
+        )
+        translations = JSON.parse(response.body)
+
+        if @inplace
+          replace_inplace(translations)
+        else
+          dump_translations(translations)
+        end
+      end
+
+      private
+
+      def replace_inplace(translations)
+        Dir.glob("./config/locales/**/*.yml").each do |filename|
+          file = YAML.load_file(filename).dot_flatten
+          update = false
+
+          file.each do |key, value|
+            if translations.has_key?(key) && translations[key] != value
+              update = true
+              file[key] = translations[key]
+            end
+          end
+
+          File.write(filename, Yamlfish::Cli::YamlDumper.dump(file.dot_unflatten)) if update || @force_update
+        end
+      end
+
+      def dump_translations(translations)
+        File.write("./config/locales/#{@locale_identifier}.yml", Yamlfish::Cli::YamlDumper.dump(translations.dot_unflatten))
+      end
+    end
+  end
+end

data/lib/yamlfish/cli/push.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/deep_merge"
+require "faraday"
+
+module Yamlfish
+  module Cli
+    class Push
+      def initialize(locale_identifier, branch: "main")
+        @locale_identifier = locale_identifier
+        @branch = branch
+      end
+
+      def call
+        translations = Dir.glob("./config/locales/**/*.yml").each_with_object({}) do |filename, translations|
+          translations.deep_merge!(YAML.load_file(filename))
+        end
+
+        translations = translations[@locale_identifier]
+
+        raise "No translations" unless translations&.any?
+
+        response = Faraday.post(
+          "#{Yamlfish::Cli.configuration.base_url}/projects/#{Yamlfish::Cli.configuration.project_token}/#{@branch}/locales/#{@locale_identifier}/import",
+          { data: JSON.dump(translations) },
+          {
+            "Authorization": "Bearer #{Yamlfish::Cli.configuration.api_key}"
+          }
+        )
+        puts response.status
+      end
+    end
+  end
+end

data/lib/yamlfish/cli/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yamlfish
+  module Cli
+    VERSION = "0.1.0.alpha1"
+  end
+end

data/lib/yamlfish/cli/yaml_dumper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yamlfish
+  module Cli
+    class YamlDumper
+      # We want to dump strings that contain newlines as literal scalars for readability
+      # Inspired by https://github.com/ruby/psych/issues/322#issuecomment-328408276
+      def self.dump(object)
+        str = YAML.dump(object)
+
+        ast = Psych.parse_stream(str)
+        ast.grep(Psych::Nodes::Scalar).each do |node|
+          node.style  = Psych::Nodes::Scalar::LITERAL if node.value.include?("\n")
+        end
+
+        ast.yaml(nil, {line_width: -1})
+      end
+    end
+  end
+end

data/lib/yamlfish/cli.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "cli/version"
+require_relative "cli/push"
+require_relative "cli/pull"
+require "yaml"
+
+module Yamlfish
+  module Cli
+    class Error < StandardError; end
+    # Your code goes here...
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    class Configuration
+      attr_accessor :api_key, :project_token, :base_url
+
+      DEFAULT_BASE_URL = "https://yamlfish.dev/api/v1"
+
+      def initialize
+        configuration = begin
+          YAML.load_file(File.expand_path(".yamlfish.yml"))
+        rescue Errno::ENOENT
+          {}
+        end
+
+        @api_key = configuration["api_key"]
+        @project_token = configuration["project_token"]
+        @base_url = configuration["base_url"] || DEFAULT_BASE_URL
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: yamlfish
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha1
+platform: ruby
+authors:
+- Adrien Siami
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- adrien@siami.fr
+executables:
+- yamlfish
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/yamlfish
+- lib/refinements/dot_flatten.rb
+- lib/yamlfish/cli.rb
+- lib/yamlfish/cli/pull.rb
+- lib/yamlfish/cli/push.rb
+- lib/yamlfish/cli/version.rb
+- lib/yamlfish/cli/yaml_dumper.rb
+homepage: https://yamlfish.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://yamlfish.dev
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Easily manage your translations with yamlfish
+test_files: []