i18n_generators 0.8.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/History.txt

@@ -0,0 +1,104 @@
+== 0.8.0
+
+* major enhancements:
+  * Gemify
+
+== 0.7.0
+
+* major enhancements:
+  * Fix gettext dependency version
+* enhancements:
+  * Add more error checks when loading models
+  * Load gettext only when using it
+
+== 0.6.0
+
+* bugfixes:
+  * Could not load cldr data with short locale names
+* major enhancements:
+  * Include AR association names in model attributes translation
+  * Add 'generated' comment mark (#g) for generated lines in YAML (thanks to t-wada-senpai, Shimura-san, Toyofuku-san, Sezutsu-san and oukayuka-san!)
+  * Add --include-timestamps option and change default bahaviour not to include timestamp columns in translation YAML
+  * Add blank line between each blocks (thanks to Sawayanagi-san!)
+* enhancements:
+  * Avoid generating blank locale file
+  * Change GitHub fetch URL from blob/master/...?raw=true to raw/master
+
+== 0.5.0
+
+* bugfixes:
+  * Could not fetch the locale files via GitHub (GitHub changed the URL?)
+* major enhancements:
+  * Ruby 1.9 ready!
+  * Never connect to CLDR site when the locale file found in Sven's rails-i18n repository
+* enhancements:
+  * Use Ruby 1.9 built-in JSON parser if Ruby 1.9
+
+== 0.4.1
+
+* bugfixes:
+  * i18n_translation abnormally ends when loading a view containing "-%>" (thanks to babie-san!)
+
+== 0.4.0
+
+* major enhancements:
+  * translation generator now preserves any existing extra lines in the YAML file (thanks to Iain Hecker-san!)
+
+== 0.3.4
+
+* enhancements:
+  * Reduce unnecessary request to CLDR site
+
+== 0.3.3
+
+* bugfixes:
+  * Did not work on Ruby 1.8.6 (thanks to akm-san!)
+
+== 0.3.2
+
+* bugfixes:
+  * Trim mode in ERB didn't work on some platforms (thanks to valda-san!)
+
+== 0.3.1
+
+* enhancements:
+  * Translate all keys simultaneously using thread
+  * Translations with :scope is going to be yamlized with proper hierarchy
+
+== 0.3.0
+
+* major enhancements:
+  * Renamed the generators
+      i18n_locales -> i18n_locale (i18n --locale)
+      i18n_models -> i18n_translation (i18n --translation)
+  * Handle all translate keys which appear in view files (thanks to PanosJee-san!)
+
+== 0.2.0
+
+* major enhancements:
+  * Implemented i18n_scaffold generator (thanks to Iain Hecker-san!)
+
+* enhancements:
+  * i18n_models generator can now deal with non AR classes which has content_columns (thanks to Iain Hecker-san!)
+
+== 0.1.0
+
+* major enhancements:
+  * Fetch locale YAML file from rails-i18n project repository first
+
+* bugfixes:
+  * Could not recognize model names with multipie words (thanks to makoto-san!)
+
+== 0.0.8
+
+* major enhancements:
+  * Lots of changes for this commit by DHH http://github.com/rails/rails/commit/d9b92ee11b33fed5c7a94a91415fa846705f7dd3
+
+== 0.0.4
+
+* Gemified on GitHub
+
+== 0.0.1
+
+* Birthday!
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,104 @@
+= I18n generators
+
+This gem plugin generates a set of locale files for Rails 2.2 i18n feature.
+
+* http://github.com/amatsuda/i18n_generators/tree/master
+
+
+== FEATURES
+
+This gem/plugin provides following four script/generate commands.
+
+=== 1. Generate I18n Scaffold
+
+% ./script/generate i18n_scaffold ja (de-AT, pt-BR, etc.)
+
+Generates I18n aware scaffold.
+
+=== 2. Generate Locale Files for ActiveRecord/ActiveSupport/ActionPack
+
+% ./script/generate i18n_locale ja (de-AT, pt-BR, etc.)
+
+or
+
+% ./script/generate i18n --locale ja (de-AT, pt-BR, etc.)
+
+* A. If The Locale File Exists In Rails-I18n Repository
+
+Firstly, the generator checks here.
+http://github.com/svenfuchs/rails-i18n/tree/master/rails/locale
+If the spacified .yml file exists in the repository, the generator downloads and puts the file into your config/locales directory.
+Then the generater sets the application default locale to the specified locale.
+
+This will generate following locale file.
+
+    config/locales/ja.yml
+
+* B. Else
+
+The generator copies the en.yml file (bundled inside Rails framework) into config/locales directory, and one-to-one localizes/translates each attribute value into the specified locale/language.
+Then the generater sets the application default locale to the specified locale.
+
+For example,
+
+% ./script/generate i18n_locale zh
+
+will generate following locale files.
+
+    config/locales/active_support_zh.yml
+    config/locales/active_record_zh.yml
+    config/locales/action_view_zh.yml
+
+=== 3. Generate Translation YAML File For All Models/Attributes and views/**/*.erb
+
+% ./script/generate i18n_translation ja (de-AT, pt-BR, etc.)
+
+or
+
+% ./script/generate i18n --translation ja (de-AT, pt-BR, etc.)
+
+This will generate following YAML file.
+
+    config/locales/translation_ja.yml
+
+The generator scans your app/models directory, and generates a YAML file with all the AR model names and attributes so that you don't have to write the YAML skeleton manually or by copy/paste.
+In addition, the generator scans all the *.erb files in your app/views/** directory, and picks all the keys for I18n.translate, then adds them to the YAML file.
+In addition, the generator tries to translate each of them into the specified language.
+The generator doesn't overwrite the existing value so that you can rerun the generator again and again just like Annotate Model command.
+
+=== 4. Generate All
+
+% ./script/generate i18n ja (de-AT, pt-BR, etc.)
+
+Executes 2 and 3 at once.
+
+
+== REQUIREMENTS:
+
+* Ruby on Rails (>= 2.2)
+* Ruby-GetText-Package ( http://rubyforge.org/projects/gettext/ )
+* high speed Internet connection
+
+
+== INSTALL:
+
+* As a gem
+
+% sudo gem source http://gems.github.com
+
+% sudo gem install amatsuda-i18n_generators
+
+* As a Rails plugin
+
+% ./script/plugin install git://github.com/amatsuda/i18n_generators.git
+
+
+== CAUTION
+
+Current version of this plugin is very very very roughly implemented just for experiment.
+Every time you execute the generate command, the plugin connects to the Unicode CLDR website and scrapes the huge amount of its contents.
+Please be careful not to harm your network environment and CLDR website by running this plugin too many times.
+
+
+Copyright (c) 2008  Akira Matsuda, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+# require 'spec/rake/spectask'
+
+desc 'Default: run the specs.'
+task :default => :spec
+
+# desc 'Run the specs for i18n_generators.'
+# Spec::Rake::SpecTask.new(:spec) do |t|
+#   t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+#   t.spec_files = FileList['spec/**/*_spec.rb']
+# end
+
+desc 'Generate documentation for the i18n_generators plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'I18nGenerators'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('generators/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'i18n_generators'
+    gemspec.summary = 'Generates I18n locale files for Rails 2.2 and 2.3'
+    gemspec.description = 'A Rails generator plugin & gem that generates Rails 2.2 and 2.3 I18n locale files for almost every known locale.'
+    gemspec.email = 'ronnie@dio.jp'
+    gemspec.homepage = 'http://github.com/amatsuda/i18n_generators/'
+    gemspec.authors = ['Akira Matsuda']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler not available. Install it with: gem install jeweler'
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/generators/i18n/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates a config file and locale files and a model/attributes translation file for Rails i18n feature.
+
+Example:
+    ./script/generate i18n locale_name (ja-JP, de-AT, etc.)
+
+    This will create:
+        config/initializers/i18n_config.rb
+        lib/locale/action_view_ja-JP.yml
+        lib/locale/active_record_ja-JP.yml
+        lib/locale/active_support_ja-JP.yml
+        lib/locale/models_ja-JP.yml
+

data/generators/i18n/i18n_generator.rb

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rails_generator'
+require 'rails_generator/commands'
+
+class I18nGenerator < Rails::Generator::NamedBase
+  attr_reader :locale_name, :cldr, :translator, :generate_translation_only, :generate_locale_only, :include_timestamps
+
+  def initialize(runtime_args, runtime_options = {})
+    if options[:scaffold]
+      #TODO invoke scaffold generator
+      puts 'please use generate i18n_scaffold command'
+      exit
+    end
+
+    super
+    unless name =~ /^[a-zA-Z]{2}([-_][a-zA-Z]{2})?$/
+      puts 'ERROR: Wrong locale format. Please input in ?? or ??-?? format.'
+      exit
+    end
+    @locale_name = name.length == 5 ? "#{name[0..1].downcase}-#{name[3..4].upcase}" : "#{name[0..1].downcase}"
+
+    unless options[:generate_translation_only]
+      gem 'gettext', '<2'
+      require 'gettext'
+      @cldr = CldrDocument.new @locale_name
+      GetText.bindtextdomain 'rails'
+      GetText.locale = @locale_name
+    end
+    unless options[:generate_locale_only]
+      lang = @locale_name.sub(/-.*$/, '')
+      @translator = Translator.new lang
+    end
+    @include_timestamps = true if options[:include_timestamps]
+  end
+
+  def manifest
+    record do |m|
+      m.directory 'config/locales'
+      unless options[:generate_translation_only]
+        logger.debug 'updating environment.rb ...'
+        m.generate_configuration
+        if defined_in_rails_i18n_repository?
+          logger.debug "fetching #{locale_name}.yml from rails-i18n repository..."
+          m.fetch_from_rails_i18n_repository
+        else
+          logger.debug "generating #{locale_name} YAML files for Rails..."
+          m.active_support_yaml
+          m.active_record_yaml
+          m.action_view_yaml
+        end
+      end
+      unless options[:generate_locale_only]
+        m.translation_yaml
+      end
+    end
+  end
+
+  protected
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on('--translation',
+           'Generate translations for all models with their attributes and all translation keys in the view files.') {|v| options[:generate_translation_only] = v}
+    opt.on('--locale', 'Generate locale files.') {|v| options[:generate_locale_only] = v}
+    opt.on('--include-timestamps', 'Include timestamp columns in the YAML translation.') {|v| options[:include_timestamps] = v}
+    opt.on('--include-timestamp', 'Include timestamp columns in the YAML translation.') {|v| options[:include_timestamps] = v}
+  end
+
+  private
+  def defined_in_rails_i18n_repository?
+    begin
+      uri = "http://github.com/svenfuchs/rails-i18n/blob/master/rails/locale/#{locale_name}.yml"
+      OpenURI.open_uri(uri) do |res|
+        (res.base_uri.to_s == uri) && (res.status == %w[200 OK])
+      end
+    rescue
+      false
+    end
+  end
+end
+
+require File.join(File.dirname(__FILE__), '../i18n_locale/i18n_locale_command')
+require File.join(File.dirname(__FILE__), '../i18n_translation/i18n_translation_command')
+Rails::Generator::Commands::Create.send :include, I18nGenerator::Generator::Commands::Create
+

data/generators/i18n/lib/yaml.rb

@@ -0,0 +1,187 @@
+require 'yaml'
+
+module I18nLocaleGeneratorModule
+  class Node
+    attr_reader :document, :indent_level
+    attr_accessor :line
+
+    def initialize(parent, line_index, text)
+      @document, @line, @text = parent.document, line_index, text.to_s
+      @text =~ /(^\s*)/
+      @indent_level = $1.nil? ? 0 : $1.size
+      @yaml = YAML.load(@text.to_s + ' ')
+    end
+
+    def parent
+      @parent ||= document.parent_of self
+    end
+
+    def children
+      @children ||= document.children_of(self)
+    end
+    alias :nodes :children
+
+    def [](node_name)
+      if node = nodes.detect {|n| n.key.to_s == node_name.to_s}
+        node
+      else
+        nodes.add "#{' ' * (@indent_level + 2)}#{node_name}: "
+        nodes.last
+      end
+    end
+
+    def key
+      @yaml.is_a?(Hash) ? @yaml.keys.first : nil
+    end
+
+    def value
+      @yaml.is_a?(Hash) ? @yaml.values.first : nil
+    end
+
+    def value=(val)
+      if @yaml[self.key] != val
+        @yaml[self.key] = val
+        @changed = true
+      end
+    end
+
+    def text
+      if @changed
+        v = if self.value.is_a?(Array)
+          "[#{self.value * ', '}]"
+        else
+          %Q["#{self.value}"]
+        end
+        "#{' ' * self.indent_level}#{self.key}: #{v}  #g"  # g is for 'generated'!
+      else
+        @text
+      end
+    end
+    alias :to_s :text
+
+    def changed?
+      @changed
+    end
+
+    def is_blank_or_comment?
+      @text.sub(/#.*$/, '').gsub(/\s/, '').empty?
+    end
+
+    def path
+      @path ||= "#{self.parent.path}/#{self.key}"
+    end
+
+    def descendant_nodes(&block)
+      yield self if self.value
+      self.children.each {|child| child.descendant_nodes(&block)} if self.children
+    end
+
+    def <=>(other)
+      self.line <=> other.line
+    end
+  end
+
+  class YamlDocument < Node
+    attr_accessor :lines
+    alias :nodes :lines
+
+    def initialize(yml_path, locale_name)
+      @locale_name, @lines, @current_line, @indent_level = locale_name, Nodes.new(self), -1, -2
+      if File.exists? yml_path
+        File.open(yml_path) do |file|
+          file.each_with_index do |line_text, i|
+            n = Node.new(self, i, line_text.chomp)
+            @lines << ((((n.key == 'en-US') || (n.key == 'en')) && n.value.blank?) ? Node.new(self, i, "#{locale_name}:") : n)
+          end
+          @lines.delete_at(-1) if @lines[-1].text.blank?
+        end
+      end
+    end
+
+    def next
+      return false if @lines.size == 0
+      @current_line += 1
+      return false if @current_line >= @lines.size
+      @lines[@current_line].is_blank_or_comment? ? self.next : @lines[@current_line]
+    end
+
+    def prev
+      return false if @current_line == 0
+      @current_line -= 1
+      @lines[@current_line].is_blank_or_comment? ? self.prev : @lines[@current_line]
+    end
+
+    def parent_of(child)
+      @current_line = child.line
+      while n = self.prev
+        return n if n.indent_level == child.indent_level - 2
+      end
+      self
+    end
+
+    def children_of(parent)
+      nodes = Nodes.new(parent)
+      @current_line = parent.line
+      while n = self.next
+        if n.indent_level < parent.indent_level + 2
+          break
+        elsif n.indent_level == parent.indent_level + 2
+          nodes << n
+        end
+      end
+      nodes
+    end
+
+    def document
+      self
+    end
+
+    def path
+      ''
+    end
+
+    def line
+      @current_line
+    end
+
+    def to_s(add_blank_line = false)
+      previous_indent_level = 0
+      @lines.inject('') do |ret, n|
+        ret << "\n" if add_blank_line && (n.indent_level < previous_indent_level) && !n.text.blank? && !ret.ends_with?("\n\n")
+        previous_indent_level = n.indent_level
+        ret << (n.text ? n.text.rstrip : '') + "\n"
+      end
+    end
+  end
+
+  class Nodes < Array
+    def initialize(parent)
+      super()
+      @parent = parent
+    end
+
+    def [](index)
+      if index.is_a?(String) || index.is_a?(Symbol)
+        return self.detect {|node| node.key == index} || add(index)
+      end
+      super
+    end
+
+    def last_leaf
+      c = @parent
+      loop do
+        return c if c.children.blank?
+        c = c.children.last
+      end
+    end
+
+    def add(node_name)
+      target_line = self.last_leaf.line + 1
+      @parent.document.nodes.each {|n| n.line += 1 if n.line >= target_line}
+      node = Node.new(@parent, target_line, node_name)
+      @parent.document.lines << node
+      @parent.document.lines.sort!
+      self << node unless @parent.is_a? YamlDocument
+    end
+  end
+end