immosquare-yaml 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b52683e890b1d956eae3105cea9e41abf49ddd14d549fb76a4490f8f851d0855
-  data.tar.gz: fb4b1fe155dd11b4a13c7b4dcd88e91839a1b9d9af8e5aeb2205ffa86c925f6c
+  metadata.gz: a2841e06b484ab63541fde122db5b67873fed11ace07d10423eae10ac4eb32b0
+  data.tar.gz: ca15c7313768d2c70597370cf4121becd73d4afd32b70735d80572c66daabbbb
 SHA512:
-  metadata.gz: eee507c91cb95ac3ff5e87f15570f664622c0be05f449bad60823687e3f7cd71e54b9aef52a74b6799e04a7fdc8a4b855e3f217cbc6fef20861898c957433374
-  data.tar.gz: 7f05834fc1b5e22c25d021b7eed1f6b77e3575a6a86d3c2794cf2c1b8bc0e193443b50c770acf0af5f5deb1dbc9001574242272d0b5065476dd42978daca56a4
+  metadata.gz: 89eafa27859e41e9a61ae861b746157dc010af7a29ecaffa8a42f0fc612d30c4637eea21aadad5293abafe670b5c5b317b861902fb7c2e8cbb858d40074fe5a8
+  data.tar.gz: 48b27854d7f28c95f98a4f5bdbe04674a08407699c4ae27f5623571ec1a98fb8751e70fba844bf1dfe3f423bd9fae16a30b497233cc0536f8ef965e3a91f40e9

data/lib/immosquare-yaml/flatten.rb

@@ -0,0 +1,152 @@
+module ImmosquareYaml
+  ##============================================================##
+  ## Flatten — turns one (or several) i18n YAML file(s), or a hash
+  ## already in memory, into a list of dot-separated paths pointing
+  ## to leaf values.
+  ##
+  ## Segments matching RESERVED_KEYS (yes/no/true/false/...) or
+  ## purely numeric segments are quoted ("true", "42") so they stay
+  ## compatible with I18n.t, which would otherwise interpret them
+  ## as booleans / integers.
+  ##
+  ## Array and nil values are treated as leaves (no descent).
+  ## Empty Hashes are skipped (no leaf emitted).
+  ##============================================================##
+  class << self
+
+    ##============================================================##
+    ## flatten_keys(input, with_values: false, with_file: false)
+    ##
+    ## input :
+    ##   - Hash             : flattened in memory (no I/O). File
+    ##                        column is nil in the resulting tuples.
+    ##   - String           : a single YAML file path.
+    ##   - Array<String>    : a list of YAML file paths.
+    ##
+    ## Globs are NOT expanded — the caller is expected to expand
+    ## them upstream (e.g. with Dir.glob) and pass an Array<String>.
+    ## Mixing a Hash with file paths in the same Array is not
+    ## supported.
+    ##
+    ## No option         → Array<String> sorted + deduplicated
+    ## with_values: true → Array<[path, value]> not deduplicated
+    ## with_file:   true → adds the source file_path to each entry
+    ##                     (nil for Hash inputs)
+    ##
+    ## Missing / empty / unreadable file: silently ignored.
+    ##============================================================##
+    def flatten_keys(input, **options)
+      options = {
+        :with_values => false,
+        :with_file   => false
+      }.merge(options)
+
+      entries = []
+
+      if input.is_a?(Hash)
+        flatten_hash(input, [], entries, nil) if !input.empty?
+      else
+        paths = input.is_a?(Array) ? input : [input]
+        paths.each do |path|
+          path = path.to_s
+          next if path.empty? || !File.exist?(path)
+
+          parsed = parse(path, :sort => false)
+          next if parsed == false || !parsed.is_a?(Hash) || parsed.empty?
+
+          flatten_hash(parsed, [], entries, path)
+        end
+      end
+
+      format_entries(entries, options)
+    end
+
+    ##============================================================##
+    ## parse_path(dot_path) → Array<String>
+    ##
+    ## Symmetric inverse of the quoting done by flatten_keys: splits
+    ## on "." and strips wrapping quotes from reserved or numeric
+    ## segments. The result can be passed directly to Hash#dig on a
+    ## hash returned by ImmosquareYaml.parse.
+    ##
+    ## Limitation : keys containing a literal "." in their name are
+    ## not supported (the path would be split into two segments).
+    ##
+    ## Examples :
+    ##   parse_path("fr.statuses.\"yes\"")  # => ["fr", "statuses", "yes"]
+    ##   parse_path("fr.counts.\"42\"")     # => ["fr", "counts", "42"]
+    ##   parse_path("fr.app.title")         # => ["fr", "app", "title"]
+    ##============================================================##
+    def parse_path(dot_path)
+      dot_path.to_s.split(".").map {|segment| unquote_segment(segment) }
+    end
+
+
+    private
+
+
+    ##============================================================##
+    ## Recursive walk over the hash. Array and nil are treated as
+    ## leaves. Empty Hashes are skipped. Entries are accumulated as
+    ## [path, value, file].
+    ##============================================================##
+    def flatten_hash(node, segments, entries, file_path)
+      if node.is_a?(Hash)
+        return if node.empty?
+
+        node.each do |key, value|
+          flatten_hash(value, segments + [quote_segment(key.to_s)], entries, file_path)
+        end
+      else
+        entries << [segments.join("."), node, file_path]
+      end
+    end
+
+    ##============================================================##
+    ## Quotes a path segment if it matches RESERVED_KEYS or if it
+    ## is purely numeric (consistent with clean_key in the dump).
+    ##============================================================##
+    def quote_segment(segment)
+      if SharedMethods::RESERVED_KEYS.include?(segment) || segment.match?(/\A[-+]?\d+\z/)
+        "\"#{segment}\""
+      else
+        segment
+      end
+    end
+
+    ##============================================================##
+    ## Inverse of quote_segment: strips wrapping quotes when the
+    ## segment is enclosed in " ... ". Other segments are returned
+    ## unchanged.
+    ##============================================================##
+    def unquote_segment(segment)
+      if segment.start_with?("\"") && segment.end_with?("\"") && segment.length >= 2
+        segment[1..-2]
+      else
+        segment
+      end
+    end
+
+    ##============================================================##
+    ## Formats the output according to the options. Without
+    ## with_values, paths are deduplicated (useful when flattening
+    ## multiple locales sharing the same key). Otherwise, all
+    ## entries are kept.
+    ##============================================================##
+    def format_entries(entries, options)
+      if options[:with_values] && options[:with_file]
+        entries.sort_by {|path, _value, file| [path, file.to_s] }
+      elsif options[:with_values]
+        entries.sort_by {|path, _value, file| [path, file.to_s] }
+               .map {|path, value, _file| [path, value] }
+      elsif options[:with_file]
+        entries.map  {|path, _value, file| [path, file] }
+               .uniq
+               .sort_by {|path, file| [path, file.to_s] }
+      else
+        entries.map(&:first).uniq.sort
+      end
+    end
+
+  end
+end

data/lib/immosquare-yaml/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareYaml
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.2".freeze
 end

data/lib/immosquare-yaml.rb

@@ -1,9 +1,8 @@
 require          "psych"
 require          "fileutils"
 require          "immosquare-extensions"
-require_relative "immosquare-yaml/configuration"
 require_relative "immosquare-yaml/shared_methods"
-require_relative "immosquare-yaml/railtie" if defined?(Rails)
+require_relative "immosquare-yaml/flatten"
 
 ##============================================================##
 ## ImmosquareYaml — post-processeur Psych dédié aux fichiers
@@ -27,16 +26,6 @@ module ImmosquareYaml
 
   class << self
 
-    attr_writer :configuration
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def config
-      yield(configuration)
-    end
-
     ##============================================================##
     ## clean(file_path, sort: true, output: file_path)
     ## Charge le fichier, le re-écrit propre et trié.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-yaml
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - immosquare
@@ -39,11 +39,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/immosquare-yaml.rb
-- lib/immosquare-yaml/configuration.rb
-- lib/immosquare-yaml/railtie.rb
+- lib/immosquare-yaml/flatten.rb
 - lib/immosquare-yaml/shared_methods.rb
 - lib/immosquare-yaml/version.rb
-- lib/tasks/immosquare-yaml.rake
 homepage: https://github.com/immosquare/immosquare-yaml
 licenses:
 - MIT

data/lib/immosquare-yaml/configuration.rb

@@ -1,12 +0,0 @@
-module ImmosquareYaml
-  class Configuration
-
-    attr_accessor :openai_api_key, :openai_model
-
-    def initialize
-      @openai_api_key = nil
-      @openai_model   = nil
-    end
-
-  end
-end

data/lib/immosquare-yaml/railtie.rb

@@ -1,9 +0,0 @@
-module ImmosquareYaml
-  class Railtie < Rails::Railtie
-
-    rake_tasks do
-      load "tasks/immosquare-yaml.rake"
-    end
-
-  end
-end

data/lib/tasks/immosquare-yaml.rake

@@ -1,11 +0,0 @@
-namespace :immosquare_yaml do
-  ##============================================================##
-  ## Function to clean translation files in rails app
-  ##============================================================##
-  desc "Clean translation files in rails app"
-  task :clean => :environment do
-    Dir.glob("#{Rails.root}/config/locales/**/*.yml").each do |file|
-      ImmosquareYaml.clean(file)
-    end
-  end
-end