l10nizer 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c42cf69ad08d236a007080c7098673a6c9b673b73c73e8005ebe91355f7fe4e
+  data.tar.gz: dfc6b968ca72ceb531856ce406f95abe860e200a9c469af1a35c22860b236a25
+SHA512:
+  metadata.gz: bc3ae7a90574b9645e0dffacc7dce9f496641cda62ad549105b5b095c4f63e2ad178bdfd27a30d7e1b80fda038ccfa951fa9897600c46ccb50c046903ac12d58
+  data.tar.gz: '009657cc294a0e4f66c42bfcc56d3200835721ca5150281070125b384f02fc03d52e4bc85208d1d012a4082d0ca9444a8ccc859553e8f8d8fa0c5b7938dbfb4e'

data/bin/l10nizer

@@ -2,31 +2,89 @@
 require "l10nizer"
 require "yaml"
 require "fileutils"
+require "optparse"
 
-Dir.chdir(ARGV.first) if ARGV.first
-templates = Dir["app/views/**/*.html.erb"]
-raise "Can't find any templates in app/views." unless templates.any?
+executable = File.basename(__FILE__)
+
+options = {
+  mode: :check,
+  path: "."
+}
+
+parser = OptionParser.new { |opts|
+  opts.banner = "Usage: #{executable} [options]"
+  opts.separator <<~STRING
+
+    #{executable} performs Automatic ex post facto localisation of Rails
+    templates.
+
+    By default, it will check for unlocalised text in templates, returning 0
+    if no such text is found, or returning 1 if it is found.
+
+    If the --extract option is passed, this text will be extracted from the
+    templates and deposited in a new file in config/locales/l10nized.yml.
+
+  STRING
+
+  opts.on(
+    "-e", "--extract",
+    "Replace strings with t() and write a locale file"
+  ) do
+    options[:mode] = :extract
+  end
+  opts.on(
+    "-p", "--path", String,
+    "Path to Rails app (default: #{options[:path]})"
+  ) do |str|
+    options[:path] = str
+  end
+  opts.on(
+    "-h", "--help",
+    "Display this help message and exit"
+  ) do
+    puts opts
+    exit
+  end
+
+  opts.separator ""
+}
+
+parser.parse!
+
+Dir.chdir(options[:path])
+templates = Dir[File.join("app", "views", "**", "*.html.erb")]
+raise "Can't find any templates in #{options[:path]}" unless templates.any?
 
 keygen = L10nizer::KeyGenerator.new
+namespacer = L10nizer::Namespacer.new
+files_with_text = []
 l10ns = {}
 
 templates.each do |path|
-  keygen.namespace = path.split("/")[2]
-  source = File.read(path)
-  l10nizer = L10nizer::Processor.new(source, keygen)
-  l10ns.merge!(l10nizer.l10ns)
-  File.open(path, "w") do |f|
-    f << l10nizer.reformed
-  end
+  keygen.namespace = namespacer.call(path)
+  l10nizer = L10nizer::Processor.new(File.read(path), keygen)
+  next unless l10nizer.l10ns.any?
+
+  files_with_text << path
+  next unless options[:mode] == :extract
+
+  l10ns.merge! l10nizer.l10ns
+  File.write path, l10nizer.reformed
 end
 
-l10ns = l10ns.inject({}){ |hash, (key, value)|
-  parts = key.split(".")
-  parts[0 .. -2].inject(hash){ |h, k| h[k] ||= {} }[parts.last] = value
-  hash
-}
+if files_with_text.any?
+  warn "Found unlocalised text in the following files:",
+    *files_with_text
 
-FileUtils.mkdir_p("config/locales")
-File.open("config/locales/l10nized.yml", "w") do |f|
-  f << l10ns.to_yaml
+  case options[:mode]
+  when :extract
+    tree = L10nizer::LocaleGenerator.new.call(l10ns)
+    path = File.join("config", "locales", "l10nized.yml")
+    FileUtils.mkdir_p File.dirname(path)
+    File.write path, YAML.dump(tree)
+  when :check
+    exit 1
+  end
+else
+  warn "No unlocalised text found."
 end

data/lib/l10nizer/keygen.rb

@@ -9,19 +9,21 @@ module L10nizer
     def call(string)
       provisional = [make_safe(namespace), make_safe(string)].compact * "."
 
-      until try(provisional, string)
+      until distinct?(provisional, string)
         match = provisional.match(/_(\d+)$/)
         if match
-          provisional.sub! /\d+$/, match[1].to_i.succ.to_s
+          provisional = provisional.sub(/\d+$/, match[1].to_i.succ.to_s)
         else
-          provisional << "_1"
+          provisional += "_1"
         end
       end
 
-      return provisional
+      provisional
     end
 
-    def try(key, string)
+    private
+
+    def distinct?(key, string)
       if [nil, string].include?(@seen[key])
         @seen[key] = string
         true
@@ -32,13 +34,13 @@ module L10nizer
 
     def make_safe(string)
       return nil if string.nil?
-      safe = string.
-             downcase.
-             gsub(/&[a-z0-9]{1,20};/, ""). # entities
-             gsub(/<[^>]*>/, "").          # html
-             gsub(/[^a-z0-9]+/, "_").      # non alphanumeric
-             slice(0, 40).
-             gsub(/^_|_$/, "")             # leading/trailing _
+      safe = string
+        .downcase
+        .gsub(/&[a-z0-9]{1,20};/, "") # entities
+        .gsub(/<[^>]*>/, "")          # html
+        .gsub(/[^a-z0-9.]+/, "_")     # non alphanumeric
+        .slice(0, 40)                 # limit length
+        .gsub(/^_|_$/, "")            # leading/trailing _
       safe = "unknown" if safe.empty?
       safe
     end

data/lib/l10nizer/locale_generator.rb

@@ -0,0 +1,11 @@
+module L10nizer
+  class LocaleGenerator
+    def call(l10ns, lang: "en")
+      lang_tree = l10ns.each_with_object({}) { |(key, value), hash|
+        parts = key.split(".")
+        parts[0..-2].inject(hash) { |h, k| h[k] ||= {} }[parts.last] = value
+      }
+      {lang => lang_tree}
+    end
+  end
+end

data/lib/l10nizer/namespacer.rb

@@ -0,0 +1,7 @@
+module L10nizer
+  class Namespacer
+    def call(path)
+      path.sub(/\.html\.erb$/, "").split(/\/_?/).drop(2).join(".")
+    end
+  end
+end

data/lib/l10nizer/node.rb

@@ -1,6 +1,6 @@
 module L10nizer
   class NodeWrapperFactory
-    def self.wrap(node, keygen=nil)
+    def self.wrap(node, keygen = nil)
       case node
       when HtmlErb::Text
         TextNode.new(node, keygen)
@@ -15,8 +15,8 @@ module L10nizer
   end
 
   class BasicNode
-    def initialize(node, keygen=nil)
-      @node   = node
+    def initialize(node, keygen = nil)
+      @node = node
       @keygen = keygen
     end
 
@@ -47,7 +47,7 @@ module L10nizer
       vars, _ = vars_and_text
       return super unless vars
 
-      params = ['"' + key + '"']
+      params = ['".' + key.split(".").last + '"']
       vars.each_with_index do |v, i|
         params << %{#{variable_name(i)}: (#{v})}
       end
@@ -55,34 +55,35 @@ module L10nizer
       %{<%= t(#{params * ", "}) %>}
     end
 
-  private
+    private
+
     def children
-      @node.children.map{ |e| NodeWrapperFactory.wrap(e) }
+      @node.children.map { |e| NodeWrapperFactory.wrap(e) }
     end
 
     def variable_name(index)
-      ("a" .. "z").to_a[index]
+      ("a".."z").to_a[index]
     end
 
+    # rubocop:disable Metrics/MethodLength
     def vars_and_text
-      @vars_and_text ||= (
-        if children.all?{ |c| c.evaluated? } || !children.any?{ |c| c.string? }
-          []
-        else
-          l10n = ""
-          vars = []
-          children.each do |e|
-            if e.evaluated?
-              l10n << "%{#{variable_name(vars.length)}}"
-              vars << e.to_s
-            else
-              l10n << e.to_s
-            end
+      @vars_and_text ||= if children.all?(&:evaluated?) || children.none?(&:string?)
+        []
+      else
+        l10n = ""
+        vars = []
+        children.each do |e|
+          if e.evaluated?
+            l10n << "%{#{variable_name(vars.length)}}"
+            vars << e.to_s
+          else
+            l10n << e.to_s
           end
-          [vars, l10n]
         end
-      )
+        [vars, l10n]
+      end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def key
       _, text = vars_and_text

data/lib/l10nizer/parser.rb

@@ -8,7 +8,7 @@ module HtmlErb
 
   class Text < Treetop::Runtime::SyntaxNode
     def children
-      elements.map{ |e| e.elements }.flatten
+      elements.flat_map(&:elements)
     end
   end
 

data/lib/l10nizer/processor.rb

@@ -9,19 +9,19 @@ module L10nizer
     end
 
     def l10ns
-      processed.inject({}){ |hash, node| hash.merge(node.l10n) }
+      processed.inject({}) { |hash, node| hash.merge(node.l10n) }
     end
 
     def reformed
-      processed.map{ |e| e.to_s }.join
+      processed.map(&:to_s).join
     end
 
     def processed
       @processed ||=
-        HtmlErbParser.new.
-        parse(@html).
-        elements.
-        map{ |e| NodeWrapperFactory.wrap(e, @keygen) }
+        HtmlErbParser.new
+          .parse(@html)
+          .elements
+          .map { |e| NodeWrapperFactory.wrap(e, @keygen) }
     end
   end
 end

data/lib/l10nizer/version.rb

@@ -1,9 +1,9 @@
-module L10nizer #:nodoc:
-  module VERSION #:nodoc:
+module L10nizer # :nodoc:
+  module VERSION # :nodoc:
     MAJOR = 1
-    MINOR = 0
-    TINY  = 0
+    MINOR = 1
+    TINY = 0
 
-    STRING = [MAJOR, MINOR, TINY].join('.')
+    STRING = [MAJOR, MINOR, TINY].join(".")
   end
 end

data/lib/l10nizer.rb

@@ -1,2 +1,4 @@
 require "l10nizer/processor"
 require "l10nizer/keygen"
+require "l10nizer/namespacer"
+require "l10nizer/locale_generator"

metadata

@@ -1,81 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: l10nizer
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Battley
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
   name: treetop
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.6
-    none: false
+        version: '1.6'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.6
-    none: false
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  type: :runtime
   name: polyglot
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-    none: false
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-    none: false
+        version: 0.3.5
 - !ruby/object:Gem::Dependency
-  type: :development
-  name: shoulda
-  prerelease: false
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: '13'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    none: false
+        version: '13'
 - !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
-  name: rake
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-description: 
 email: pbattley@gmail.com
 executables:
 - l10nizer
@@ -84,35 +87,32 @@ extra_rdoc_files: []
 files:
 - bin/l10nizer
 - lib/l10nizer.rb
-- lib/l10nizer/version.rb
-- lib/l10nizer/processor.rb
 - lib/l10nizer/grammar.treetop
-- lib/l10nizer/parser.rb
-- lib/l10nizer/node.rb
 - lib/l10nizer/keygen.rb
-homepage: 
+- lib/l10nizer/locale_generator.rb
+- lib/l10nizer/namespacer.rb
+- lib/l10nizer/node.rb
+- lib/l10nizer/parser.rb
+- lib/l10nizer/processor.rb
+- lib/l10nizer/version.rb
 licenses: []
-post_install_message: 
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.6.2
+specification_version: 4
 summary: Automatically extract strings from ERB templates and replace with calls to
   t()
 test_files: []