i18n_flow 0.1.0

data/lib/i18n_flow/cli/lint_command/ascii.erb

@@ -0,0 +1,45 @@
+<%- errors.each do |file, errs| -%>
+=== <%= file %>
+  <%- errs.each do |full_key, err| -%>
+    <%= full_key %>  #<%= err.line %>
+    <%- case err when nil -%>
+    <%- when I18nFlow::Validator::InvalidTypeError -%>
+      <%- if err.single? -%>
+        A file must start with scopes that derive from its file path
+        reason: it must not have a scalar value
+      <%- else -%>
+        Structure mismatches with the master file
+      <%- end -%>
+    <%- when I18nFlow::Validator::MissingKeyError -%>
+      <%- if err.single? -%>
+        A file must start with scopes that derive from its file path
+        reason: missing key
+      <%- else -%>
+        The key is missing
+      <%- end -%>
+    <%- when I18nFlow::Validator::ExtraKeyError -%>
+      <%- if err.single? -%>
+        A file must start with scopes that derive from its file path
+        reason: extra key
+      <%- else -%>
+        An extra key found
+      <%- end -%>
+    <%- when I18nFlow::Validator::InvalidTodoError -%>
+        Todo cannot be annotated on a mapping/sequence
+    <%- when I18nFlow::Validator::TodoContentError -%>
+        It has "!todo" but the content diverges from the master file
+        master:  <%= err.expect %>
+        foreign: <%= err.actual %>
+    <%- when I18nFlow::Validator::InvalidLocaleError -%>
+        It has "!only" but the locale is invalid
+        valid: [<%= err.expect.join(', ') %>]
+        got:   <%= err.actual %>
+    <%- when I18nFlow::Validator::AsymmetricArgsError -%>
+        Interpolation arguments diverge from the master file
+        master:  [<%= err.expect.join(', ') %>]
+        foreign: [<%= err.actual.join(', ') %>]
+    <%- end -%>
+  <%- end -%>
+
+<%- end -%>
+<%= summary_line %>

data/lib/i18n_flow/cli/lint_command/ascii_renderer.rb

@@ -0,0 +1,58 @@
+require 'erb'
+require_relative '../../validator/errors'
+require_relative '../color'
+
+class I18nFlow::CLI::LintCommand
+  class AsciiRenderer
+    include I18nFlow::CLI::Color
+
+    FILE = __dir__ + '/ascii.erb'
+
+    attr_reader :errors
+
+    def initialize(errors, color: true)
+      @errors = errors
+      @color_enabled = !!color
+    end
+
+    def render
+      with_color(erb.result(binding))
+    end
+
+    def color_enabled?
+      @color_enabled
+    end
+
+    def file_count
+      @file_count ||= errors.size
+    end
+
+    def error_count
+      @error_count ||= errors.sum { |_, errs| errs.size }
+    end
+
+    def summary_line
+      @summary_line ||= 'Found %d %s in %d %s' % [
+        error_count,
+        error_count == 1 ? 'violation' : 'violations',
+        file_count,
+        file_count == 1 ? 'file' : 'files',
+      ]
+    end
+
+  private
+
+    def with_color(str)
+      return str unless color_enabled?
+
+      str = str.gsub(/^(=== )(.+)$/) { $1 + color($2, :yellow) }
+      str = str.gsub(/(#\d+)$/) { color($1, :yellow) }
+      str = str.gsub(/^([ ]{8})(.+)$/) { $1 + color($2, :red) }
+      str
+    end
+
+    def erb
+      @erb ||= ERB.new(File.read(FILE), 0, '-')
+    end
+  end
+end

data/lib/i18n_flow/cli/lint_command/markdown.erb

@@ -0,0 +1,49 @@
+[I18nFlow] <%= summary_line %>
+[→ Lint rules and how to fix](https://github.com/creasty/i18n_flow/blob/master/doc/rules.md)
+
+<%- errors.each do |file, errs| -%>
+## [<%= file %>](@<%= file %>)
+  <%- errs.each do |full_key, err| -%>
+
+### <%= full_key %> [L<%= err.line %>](@<%= err.file %>:<%= err.line %>)
+
+    <%- case err when nil -%>
+    <%- when I18nFlow::Validator::InvalidTypeError -%>
+      <%- if err.single? -%>
+A file must start with scopes that derive from its file path
+reason: it must not have a scalar value
+      <%- else -%>
+Structure mismatches with the master file
+      <%- end -%>
+    <%- when I18nFlow::Validator::MissingKeyError -%>
+      <%- if err.single? -%>
+A file must start with scopes that derive from its file path
+reason: missing key
+      <%- else -%>
+The key is missing
+      <%- end -%>
+    <%- when I18nFlow::Validator::ExtraKeyError -%>
+      <%- if err.single? -%>
+A file must start with scopes that derive from its file path
+reason: extra key
+      <%- else -%>
+An extra key found
+      <%- end -%>
+    <%- when I18nFlow::Validator::InvalidTodoError -%>
+Todo cannot be annotated on a mapping/sequence
+    <%- when I18nFlow::Validator::TodoContentError -%>
+It has "!todo" but the content diverges from the master file
+master: `<%= err.expect %>`
+foreign: `<%= err.actual %>`
+    <%- when I18nFlow::Validator::InvalidLocaleError -%>
+It has "!only" but the locale is invalid
+valid: `[<%= err.expect.join(', ') %>]`
+got: `<%= err.actual %>`
+    <%- when I18nFlow::Validator::AsymmetricArgsError -%>
+Interpolation arguments diverge from the master file
+master: `[<%= err.expect.join(', ') %>]`
+foreign: `[<%= err.actual.join(', ') %>]`
+    <%- end -%>
+  <%- end -%>
+
+<%- end -%>

data/lib/i18n_flow/cli/lint_command/markdown_renderer.rb

@@ -0,0 +1,55 @@
+require 'erb'
+require_relative '../../validator/errors'
+
+class I18nFlow::CLI::LintCommand
+  class MarkdownRenderer
+    FILE = __dir__ + '/markdown.erb'
+
+    attr_reader :errors
+    attr_reader :url_formatter
+
+    def initialize(errors, url_formatter:)
+      @errors = errors
+      @url_formatter = url_formatter
+    end
+
+    def render
+      with_link(erb.result(binding))
+    end
+
+    def file_count
+      @file_count ||= errors.size
+    end
+
+    def error_count
+      @error_count ||= errors.sum { |_, errs| errs.size }
+    end
+
+    def summary_line
+      @summary_line ||= 'Found %d %s in %d %s' % [
+        error_count,
+        error_count == 1 ? 'violation' : 'violations',
+        file_count,
+        file_count == 1 ? 'file' : 'files',
+      ]
+    end
+
+  private
+
+    def with_link(str)
+      str.gsub(/\[([^\]]+)\]\(@([^\):]+)(?::(\d+))?\)/) do
+        '[%s](%s)' % [$1, format_link(path: $2, line: $3)]
+      end
+    end
+
+    def format_link(path:, line:)
+      url_formatter
+        .gsub(/%f\b/, path)
+        .gsub(/%l\b/, line.to_s)
+    end
+
+    def erb
+      @erb ||= ERB.new(File.read(FILE), 0, '-')
+    end
+  end
+end

data/lib/i18n_flow/cli/lint_command.rb

@@ -0,0 +1,55 @@
+require_relative 'command_base'
+require_relative '../repository'
+require_relative '../validator/multiplexer'
+
+class I18nFlow::CLI
+  class LintCommand < CommandBase
+    require_relative 'lint_command/ascii_renderer'
+    require_relative 'lint_command/markdown_renderer'
+
+    DEFAULT_FORMAT = 'ascii'
+
+    def invoke!
+      validator.validate!
+
+      case output_format
+      when 'ascii'
+        puts AsciiRenderer.new(validator.errors, color: color_enabled?).render
+      when 'markdown'
+        puts MarkdownRenderer.new(validator.errors, url_formatter: url_formatter).render
+      else
+        exit_with_message(1, 'Unsupported format: %s' % [output_format])
+      end
+
+      exit validator.errors.size.zero? ? 0 : 1
+    end
+
+    def output_format
+      @output_format ||= options['format'] || DEFAULT_FORMAT
+    end
+
+    def url_formatter
+      return @url_formatter if @url_formatter
+      @url_formatter = options['url-formatter']
+      @url_formatter ||= "file://#{I18nFlow.config.base_path}/%f#%l"
+    end
+
+  private
+
+    def repository
+      @repository ||= I18nFlow::Repository.new(
+        base_path:     I18nFlow.config.base_path,
+        glob_patterns: I18nFlow.config.glob_patterns,
+      )
+    end
+
+    def validator
+      @validator ||= I18nFlow::Validator::Multiplexer.new(
+        repository:    repository,
+        valid_locales: I18nFlow.config.valid_locales,
+        locale_pairs:  I18nFlow.config.locale_pairs,
+        linters:       I18nFlow.config.linters,
+      )
+    end
+  end
+end

data/lib/i18n_flow/cli/read_config_command.rb

@@ -0,0 +1,20 @@
+require_relative 'command_base'
+
+class I18nFlow::CLI
+  class ReadConfigCommand < CommandBase
+    def invoke!
+      unless key
+        exit_with_message(1, 'usage: i18n_flow read_config KEY')
+      end
+
+      case key
+      when 'base_path'
+        puts I18nFlow.config.base_path
+      end
+    end
+
+    def key
+      args[0]
+    end
+  end
+end

data/lib/i18n_flow/cli/search_command/default.erb

@@ -0,0 +1,11 @@
+<%- results.each do |key, matches| -%>
+=== <%= key %>
+  <%- matches.each do |m| -%>
+    <%= m.locale %> (<%= m.file %>:<%= m.line %>)
+    <%- if m.value -%>
+<%= m.value.gsub(/^/, '    ') %>
+    <%- end -%>
+  <%- end -%>
+
+<%- end -%>
+<%= results.size %> <%= results.size == 1 ? 'hit' : 'hits' %>

data/lib/i18n_flow/cli/search_command/default_renderer.rb

@@ -0,0 +1,67 @@
+require 'erb'
+require_relative '../../validator/errors'
+require_relative '../color'
+
+class I18nFlow::CLI::SearchCommand
+  class DefaultRenderer
+    include I18nFlow::CLI::Color
+
+    FILE = __dir__ + '/default.erb'
+
+    attr_reader :results
+
+    def initialize(results, color: true)
+      @results = results
+      @color_enabled = !!color
+    end
+
+    def render
+      with_color(erb.result(binding))
+    end
+
+    def color_enabled?
+      @color_enabled
+    end
+
+  private
+
+    def with_color(str)
+      return str unless color_enabled?
+
+      state = nil
+
+      str.each_line.map do |l|
+        case l
+        when /^(=== )(.+)$/
+          state = :header if state == nil
+        when /^(    )([^\s]+)( \(.+:\d+\))$/
+          state = :location if %i[header content].include?(state)
+        when /^(    )(.+)/
+          state = :content if %i[location content].include?(state)
+        else
+          state = nil
+        end
+
+        case state
+        when :header
+          l = $~[1]
+          l << color($~[2], :yellow)
+          l << "\n"
+        when :location
+          l = $~[1]
+          l << color($~[2], :blue)
+          l << $~[3]
+          l << "\n"
+        when :content
+          l = color(l, :green)
+        end
+
+        l
+      end.join
+    end
+
+    def erb
+      @erb ||= ERB.new(File.read(FILE), 0, '-')
+    end
+  end
+end

data/lib/i18n_flow/cli/search_command/oneline.erb

@@ -0,0 +1,5 @@
+<%- results.each do |key, matches| -%>
+  <%- matches.each do |m| -%>
+<%= key %> [<%= m.locale %>] (<%= m.file %>:<%= m.line %>:<%= m.column %>) <%= m.value&.gsub(/\s+/, ' ')&.strip %>
+  <%- end -%>
+<%- end -%>

data/lib/i18n_flow/cli/search_command/oneline_renderer.rb

@@ -0,0 +1,39 @@
+require 'erb'
+require_relative '../../validator/errors'
+require_relative '../color'
+
+class I18nFlow::CLI::SearchCommand
+  class OnelineRenderer
+    include I18nFlow::CLI::Color
+
+    FILE = __dir__ + '/oneline.erb'
+
+    attr_reader :results
+
+    def initialize(results, color: true)
+      @results = results
+      @color_enabled = !!color
+    end
+
+    def render
+      with_color(erb.result(binding))
+    end
+
+    def color_enabled?
+      @color_enabled
+    end
+
+  private
+
+    def with_color(str)
+      return str unless color_enabled?
+
+      str.gsub!(/^(\S+)( \[)([^\]]+)(\] \([^\)]+\))(.*)/) { color($1, :yellow) + $2 + color($3, :blue) + $4 + color($5, :green) }
+      str
+    end
+
+    def erb
+      @erb ||= ERB.new(File.read(FILE), 0, '-')
+    end
+  end
+end

data/lib/i18n_flow/cli/search_command.rb

@@ -0,0 +1,59 @@
+require_relative 'command_base'
+require_relative 'color'
+require_relative '../repository'
+require_relative '../search'
+
+class I18nFlow::CLI
+  class SearchCommand < CommandBase
+    require_relative 'search_command/default_renderer'
+    require_relative 'search_command/oneline_renderer'
+
+    DEFAULT_FORMAT = 'default'
+
+    def invoke!
+      unless pattern
+        exit_with_message(1, 'usage: i18n_flow search PATTERN')
+      end
+
+      search.search!
+
+      case output_format
+      when 'default'
+        puts DefaultRenderer.new(search.results, color: color_enabled?).render
+      when 'oneline'
+        puts OnelineRenderer.new(search.results, color: color_enabled?).render
+      else
+        exit_with_message(1, 'Unsupported format: %s' % [output_format])
+      end
+    end
+
+    def pattern
+      args[0]
+    end
+
+    def output_format
+      @output_format ||= options['format'] || DEFAULT_FORMAT
+    end
+
+    def include_all?
+      !!(options['all'] || options['a'])
+    end
+
+  private
+
+    def repository
+      @repository ||= I18nFlow::Repository.new(
+        base_path:     I18nFlow.config.base_path,
+        glob_patterns: I18nFlow.config.glob_patterns,
+      )
+    end
+
+    def search
+      @search ||= I18nFlow::Search.new(
+        repository:  repository,
+        pattern:     pattern,
+        include_all: include_all?,
+      )
+    end
+  end
+end

data/lib/i18n_flow/cli/split_command.rb

@@ -0,0 +1,20 @@
+require_relative 'command_base'
+require_relative '../repository'
+require_relative '../splitter'
+
+class I18nFlow::CLI
+  class SplitCommand < CommandBase
+    def invoke!
+      exit_with_message(1, 'not implemented')
+    end
+
+  private
+
+    def repository
+      @repository ||= I18nFlow::Repository.new(
+        base_path:     I18nFlow.config.base_path,
+        glob_patterns: I18nFlow.config.glob_patterns,
+      )
+    end
+  end
+end

data/lib/i18n_flow/cli/version_command.rb

@@ -0,0 +1,9 @@
+require_relative 'command_base'
+
+class I18nFlow::CLI
+  class VersionCommand < CommandBase
+    def invoke!
+      puts 'i18n_flow v%s' % I18nFlow::VERSION
+    end
+  end
+end

data/lib/i18n_flow/cli.rb

@@ -0,0 +1,42 @@
+require_relative 'util'
+
+class I18nFlow::CLI
+  require_relative 'cli/lint_command'
+  require_relative 'cli/split_command'
+  require_relative 'cli/copy_command'
+  require_relative 'cli/search_command'
+  require_relative 'cli/version_command'
+  require_relative 'cli/help_command'
+  require_relative 'cli/read_config_command'
+
+  COMMANDS = {
+    'lint'        => LintCommand,
+    'search'      => SearchCommand,
+    'split'       => SplitCommand,
+    'copy'        => CopyCommand,
+    'version'     => VersionCommand,
+    'help'        => HelpCommand,
+    'read_config' => ReadConfigCommand,
+  }
+
+  attr_reader :args
+  attr_reader :command
+  attr_reader :global_options
+
+  def initialize(args)
+    @global_options = I18nFlow::Util.parse_options(args)
+    @command, *@args = args
+  end
+
+  def run
+    if global_options['v'] || global_options['version']
+      @command = 'version'
+    end
+    if global_options['h']
+      @command = 'help'
+    end
+
+    command_class = COMMANDS[command] || COMMANDS['help']
+    command_class.new(args).invoke!
+  end
+end