yamlfish 0.1.0.alpha2 → 0.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d12427d97a7ae3df74fd9eb9506e000bd5d4769c9d3e8c3bf403c03eebae4b40
-  data.tar.gz: 1a5ce410afd9e1944b42d9b8840ad48a4980537aa19be9bbe5cc7f53139e0806
+  metadata.gz: f39e202ade947987febfd14899b18b537a9545ef093d4a8ecf6b45cabf980bd4
+  data.tar.gz: f4efc6422f4d8526d8ae5203ff2569ccb0d1a25c71d128f98f4a4079c57d6d80
 SHA512:
-  metadata.gz: 1441f3a45996505674ca21af113a5b4704da38de26b599f1afa35244d598f57358aecbd6546ddc6fc48e9bf9c12c57541cc2a907f879bd412bf6823a49f26be7
-  data.tar.gz: 445bb5b1a86a9b7c43cd8f64f8987944e50517f7579d3d7b5a499c9ed849ca188b99986fb14fb7e0c5902bf4357b428ff8d637e10da97f629386195bf318a36f
+  metadata.gz: 34a6c43f12db61c42e218cdc5e5e43d7dd6d85b88738deb86c40cec8ed3059df219b44e24caa5fe248f9f99b34cbebc6bc1a96fa3dca038963744c5a25736fc9
+  data.tar.gz: 440223976ca8416174716d2bda1994929592a53747445aef8fea82da78a6fc4647614bc0784f25c39e27c59cb8f1ddc4bd9736ef0dddc0f07f81b878325fb398

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yamlfish (0.1.0.alpha1)
+    yamlfish (0.1.0.rc1)
       activesupport (>= 6)
       faraday (~> 2.0)
       rainbow (~> 3.1)
@@ -10,57 +10,58 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
-    concurrent-ruby (1.2.3)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
     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)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      logger
+    faraday-net_http (3.3.0)
       net-http
-    i18n (1.14.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.22.2)
-    mutex_m (0.2.0)
+    logger (1.6.0)
+    minitest (5.25.1)
     net-http (0.4.1)
       uri
     rainbow (3.1.1)
-    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)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       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)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    securerandom (0.3.1)
+    thor (1.3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    uri (0.13.0)
+    uri (0.13.1)
 
 PLATFORMS
-  x86_64-darwin-21
-  x86_64-darwin-22
+  arm64-darwin-23
+  ruby
 
 DEPENDENCIES
   rake (~> 13.0)
@@ -68,4 +69,4 @@ DEPENDENCIES
   yamlfish!
 
 BUNDLED WITH
-   2.2.32
+   2.5.18

data/README.md

@@ -1 +1,33 @@
-# Yamlfish
+# YAMLFish CLI
+
+This is the command line interface for [YAMLFish](https:s://yamlfish.dev), the simple and powerful translation management platform.
+
+## Installation
+
+The YAMLFish CLI is available as a Ruby gem.
+First, make sure you have Ruby installed on your machine. You can follow the [official Ruby installation guide](https://www.ruby-lang.org/en/documentation/installation/) for your operating system.
+
+Then, to install the YAMLFish CLI, run:
+
+```bash
+gem install yamlfish --pre
+```
+
+YAMLFish is still in beta, hence the `--pre` flag to install the latest RC.
+
+## Configuration
+
+Before you can use the YAMLFish CLI, you need to configure it with your API key and project token.
+
+To do this, create a `.yamlfish.yml` file in your project's root directory with the following content:
+
+```yaml
+api_key: YOUR_API_KEY
+project_token: YOUR_PROJECT_TOKEN
+```
+
+Those secrets can be found in the footer of your project's page on YAMLFish.
+
+## Usage
+
+For usage instructions, please refer to the [official documentation](https://yamlfish.dev/docs/).

data/exe/yamlfish

@@ -9,6 +9,9 @@ class YamlfishExe < Thor
   option :branch, type: :string, default: "main"
   def push(locale)
     Yamlfish::Cli::Push.new(locale, branch: options[:branch]).call
+  rescue Errno::ENOENT => e
+    puts Rainbow("Could not push: #{e.message}").red.bright
+    exit 1
   end
 
   desc "pull", "Pulls translations from yamlfish"
@@ -17,6 +20,14 @@ class YamlfishExe < Thor
   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
+  rescue Errno::ENOENT => e
+    puts Rainbow("Could not pull: #{e.message}").red.bright
+    exit 1
+  end
+
+  desc "version", "Prints the version"
+  def version
+    puts Yamlfish::Cli::VERSION
   end
 end
 

data/lib/yamlfish/cli/pull.rb

@@ -28,7 +28,7 @@ module Yamlfish
 
         if response.status != 200
           puts Rainbow("Failed to pull, unexpected HTTP status #{response.status}").red.bright
-          return
+          exit 1
         end
 
         translations = JSON.parse(response.body)
@@ -45,7 +45,7 @@ module Yamlfish
       private
 
       def replace_inplace(translations)
-        Dir.glob("./config/locales/**/*.yml").each do |filename|
+        Dir.glob("./#{Yamlfish::Cli.configuration.locales_path}/**/*.yml").each do |filename|
           file = YAML.load_file(filename).dot_flatten
           update = false
 
@@ -61,7 +61,7 @@ module Yamlfish
       end
 
       def dump_translations(translations)
-        File.write("./config/locales/#{@locale_identifier}.yml", Yamlfish::Cli::YamlDumper.dump(translations.dot_unflatten))
+        File.write("./#{Yamlfish::Cli.configuration.locales_path}/#{@locale_identifier}.yml", Yamlfish::Cli::YamlDumper.dump(translations.dot_unflatten))
       end
     end
   end

data/lib/yamlfish/cli/push.rb

@@ -12,7 +12,7 @@ module Yamlfish
       end
 
       def call
-        translations = Dir.glob("./config/locales/**/*.yml").each_with_object({}) do |filename, translations|
+        translations = Dir.glob("./#{Yamlfish::Cli.configuration.locales_path}/**/*.yml").each_with_object({}) do |filename, translations|
           translations.deep_merge!(YAML.load_file(filename))
         end
 
@@ -31,6 +31,7 @@ module Yamlfish
           puts "Successfully pushed translations for locale #{Rainbow(@locale_identifier).magenta.bright} on branch #{Rainbow(@branch).magenta.bright}"
         else
           puts Rainbow("Failed to push, unexpected HTTP status #{response.status}").red.bright
+          exit 1
         end
       end
     end

data/lib/yamlfish/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Yamlfish
   module Cli
-    VERSION = "0.1.0.alpha2"
+    VERSION = "0.1.0.rc2"
   end
 end

data/lib/yamlfish/cli.rb

@@ -16,9 +16,10 @@ module Yamlfish
     end
 
     class Configuration
-      attr_accessor :api_key, :project_token, :base_url
+      attr_accessor :api_key, :project_token, :base_url, :locales_path
 
       DEFAULT_BASE_URL = "https://yamlfish.dev/api/v1"
+      DEFAULT_LOCALES_PATH = "config/locales"
 
       def initialize
         configuration = begin
@@ -30,6 +31,7 @@ module Yamlfish
         @api_key = configuration["api_key"]
         @project_token = configuration["project_token"]
         @base_url = configuration["base_url"] || DEFAULT_BASE_URL
+        @locales_path = configuration["locales_path"] || DEFAULT_LOCALES_PATH
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yamlfish
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha2
+  version: 0.1.0.rc2
 platform: ruby
 authors:
 - Adrien Siami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,7 @@ homepage: https://yamlfish.dev
 licenses:
 - MIT
 metadata:
+  source_code_uri: https://github.com/yamlfish/yamlfish-cli
   homepage_uri: https://yamlfish.dev
 post_install_message:
 rdoc_options: []
@@ -106,11 +107,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Easily manage your translations with yamlfish