i18n-migrations 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f368a8f95872f236f752ebee22e0af6d30f8205
-  data.tar.gz: c6cf48397cd39f07d65be2207da0f83f0924af73
+  metadata.gz: 682ef4a62f20bcdffffa20b2f0172e8c9a6f8542
+  data.tar.gz: 4b6c731797c9894f2a8fb92e0566b0147f10e44c
 SHA512:
-  metadata.gz: 78d56421cb1c62ca4f89b9d16c52e9c0f35ecc82d23f58e631bbe21bd14753d8773dcd90456925197fcfa92514efef6811125393c69744237a14abcef091c751
-  data.tar.gz: c86f46c588c42c87ed44f60dabd637d9f4424224f0cc674ab9174e898a26bbba82caee996b837d31d234c2ad869d32c7ad11850e952a95a105d00aecde111588
+  metadata.gz: 3857c51decac0553515d94152aa141133be04f323244e99468aaccbcde7ef21c224bf13d491df9f2b7e579c083657662842f92b3c04e75ee512e0ef6dbd51702
+  data.tar.gz: c038a06ef1bdb0fe5fc9491ffb2f8f807110c57a531592d3e607b40aee3a8e374388c2baf5763de358a67386443e67fe3eade32465fd487ddd8d8f55a1716244

data/lib/i18n/migrations/google_translate_dictionary.rb

@@ -3,7 +3,7 @@ require 'rest-client'
 module I18n
   module Migrations
     class GoogleTranslateDictionary
-      def initialize(from_locale, to_locale, key, do_not_translate)
+      def initialize(from_locale:, to_locale:, key:, do_not_translate:)
         @from_locale, @to_locale, @key, @do_not_translate = from_locale, to_locale, key, do_not_translate
       end
 

data/lib/i18n/migrations/locale.rb

@@ -0,0 +1,249 @@
+require 'fileutils'
+require 'yaml'
+require 'active_support/inflector'
+require 'active_support/core_ext/object'
+require 'colorize'
+
+# this class does all the work, but doesn't hold config or do more than one locale
+module I18n
+  module Migrations
+    class Locale
+      attr_reader :name
+      attr_reader :migrations
+
+      def initialize(name, locales_dir:, main_locale_name:, migrations:, dictionary:)
+        @name, @locales_dir, @main_locale_name, @migrations, @dictionary =
+            name, locales_dir, main_locale_name, migrations, dictionary
+      end
+
+      def validate(data, notes)
+        main_data = main_locale.read_data
+        main_data.each do |key, main_term|
+          old_term = data[key]
+          new_term, errors = @dictionary.fix(main_term, old_term)
+          if new_term != old_term
+            data[key] = new_term
+            puts "#{"Fix".green} #{key.green}:"
+            puts "#{@main_locale_name}: #{main_term}"
+            puts "#{@name} (old): #{old_term}"
+            puts "#{@name} (new): #{new_term}"
+            puts
+          end
+          replace_errors_in_notes(notes, key, errors)
+          if errors.length > 0
+            puts "Error #{errors.join(', ').red} #{key.yellow}"
+            puts "#{@main_locale_name.bold}: #{main_term}"
+            puts "#{@name.bold}: #{old_term}"
+            puts
+          end
+        end
+      end
+
+      def update_info
+        data, notes = read_data_and_notes
+        yield data, notes
+        write_data_and_notes(data, notes)
+      end
+
+      def migrate(data, notes)
+        missing_versions = (@migrations.all_versions - read_versions(data)).sort
+        if missing_versions.empty?
+          puts "#{@name}: up-to-date"
+          return
+        end
+        puts "#{@name}: Migrating #{missing_versions.join(', ')}"
+        missing_versions.each do |version|
+          migrate_to_version(data, notes, version, :up)
+        end
+      end
+
+      def rollback(data, notes)
+        last_version = read_versions(data).last
+        if last_version == nil
+          puts "#{@name}: no more migrations to roll back"
+          return
+        end
+        puts "#{@name}: Rolling back #{last_version}"
+        raise "Can't find #{last_version}.rb to rollback" unless @migrations.all_versions.include?(last_version)
+
+        migrate_to_version(data, notes, last_version, :down)
+      end
+
+      def pull(sheet)
+        puts "Pulling #{@name}"
+        data = {}
+        notes = {}
+        count = 0
+
+        (2..sheet.num_rows).each do |row|
+          key, value, note = sheet[row, 1], sheet[row, 3], sheet[row, 4]
+          if key.present?
+            assign_complex_key(data, key.split('.'), value.present? ? value : '')
+            if note.present?
+              assign_complex_key(notes, key.split('.'), note)
+            end
+            count += 1
+            print '.'
+          end
+        end
+
+        write_data_and_notes(data, notes)
+        write_remote_version(data)
+
+        puts "\n#{count} keys"
+      end
+
+      def push(sheet)
+        main_data = main_locale.read_data
+        data, notes = read_data_and_notes
+        row = 2
+
+        puts "Pushing #{@name}"
+
+        main_data.each do |key, value|
+          sheet[row, 1] = key
+          sheet[row, 2] = value
+          sheet[row, 3] = data[key]
+          sheet[row, 4] = notes[key]
+          row += 1
+          print '.'
+        end
+
+        sheet.synchronize
+        write_remote_version(data)
+
+        puts "\n#{main_data.keys.length} keys"
+      end
+
+      def create(limit = nil)
+        new_data, new_notes = {}, {}
+        count = 0
+        main_data = main_locale.read_data
+        main_data.each do |key, term|
+          new_data[key], new_notes[key] = @dictionary.lookup(term)
+          print '.'.green
+          break if limit && limit < (count += 1)
+        end
+        new_data['VERSION'] = main_data['VERSION']
+        puts
+        write_data_and_notes(new_data, new_notes)
+      end
+
+      def main_locale?
+        @name == @main_locale_name
+      end
+
+      def last_version
+        read_versions(read_data).last
+      end
+
+      private
+
+      def main_locale
+        Locale.new(@main_locale_name,
+                   locales_dir: @locales_dir,
+                   main_locale_name: @main_locale_name,
+                   migrations: @migrations,
+                   dictionary: null) # should not use dictionary on main locale
+      end
+
+      def replace_errors_in_notes(all_notes, key, errors)
+        return if all_notes[key].blank? && errors.empty?
+
+        notes = all_notes[key]
+        notes = notes.present? ? notes.split("\n") : []
+        notes = notes.reject { |n| n.start_with?("[error:") }
+        all_notes[key] = (errors.map { |e| "[error: #{e}]" } + notes).join("\n")
+      end
+
+      def read_data_and_notes
+        data = read_data
+        notes = main_locale? ? {} : read_from_file("../#{@name}_notes.yml")
+        [data, notes]
+      end
+
+      def read_data
+        read_from_file("#{@name}.yml")
+      end
+
+      def write_data_and_notes(data, notes)
+        write_to_file("#{@name}.yml", data)
+        write_to_file("../#{@name}_notes.yml", notes) unless main_locale?
+      end
+
+
+      def write_remote_version(data)
+        write_to_file("../#{@name}_remote_version.yml",
+                      { 'VERSION' => read_versions(data) })
+      end
+
+
+      def migrate_to_version(data, notes, version, direction)
+        migrations.play_migration(version: version,
+                                  locale: @name,
+                                  data: data,
+                                  notes: notes,
+                                  dictionary: @dictionary,
+                                  direction: direction)
+
+        if direction == :up
+          data['VERSION'] = (read_versions(data) + [version]).join("\n")
+        else
+          data['VERSION'] = (read_versions(data) - [version]).join("\n")
+        end
+      end
+
+      def read_versions(data)
+        (data['VERSION'] && data['VERSION'].split("\n")) || []
+      end
+
+      def read_from_file(filename)
+        filename = File.join(@locales_dir, filename)
+        begin
+          hash = {}
+          add_to_hash(hash, YAML.load(File.read(filename))[@name.to_s])
+          hash
+        rescue
+          puts "Error loading #{filename}"
+          raise
+        end
+      end
+
+      def write_to_file(filename, hash)
+        # we have to go from flat keys -> values to a hash that contains other hashes
+        complex_hash = {}
+        hash.keys.sort.each do |key|
+          value = hash[key]
+          assign_complex_key(complex_hash, key.split('.'), value.present? ? value : '')
+        end
+        File.open(File.join(@locales_dir, filename), 'w') do |file|
+          file << { @name => complex_hash }.to_yaml
+        end
+      end
+
+      def assign_complex_key(hash, key, value)
+        if key.length == 0
+          # should never get here
+        elsif key.length == 1
+          hash[key[0]] = value
+        else
+          hash[key[0]] ||= {}
+          assign_complex_key(hash[key[0]], key[1..-1], value)
+        end
+      end
+
+      # flattens new_hash and adds it to hash
+      def add_to_hash(hash, new_hash, prefix = [])
+        return unless new_hash
+
+        new_hash.each do |key, value|
+          if value.is_a?(Hash)
+            add_to_hash(hash, value, prefix + [key])
+          else
+            hash[(prefix + [key]).join('.')] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/migrations/migration_factory.rb

@@ -0,0 +1,29 @@
+require 'active_support/inflector'
+
+module I18n
+  module Migrations
+    class MigrationFactory
+      def initialize(migration_dir)
+        @migration_dir = migration_dir
+      end
+
+      def all_versions
+        Dir[@migration_dir + '/*.rb'].map { |name| File.basename(name).gsub('.rb', '') }
+      end
+
+      def play_migration(version:, locale:, data:, notes:, dictionary:, direction:)
+        filename = File.join(@migration_dir, "#{version}.rb")
+        require filename
+        migration_class_name = version.gsub(/^\d{12}_/, '').camelcase
+
+        migration = begin
+          migration_class_name.constantize.new(locale, data, notes, dictionary, direction)
+        rescue
+          raise "Couldn't load migration #{migration_class_name} in #{filename}"
+        end
+
+        migration.change
+      end
+    end
+  end
+end

data/lib/i18n/migrations/migrator.rb

@@ -8,14 +8,31 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'google_translate_dictionary'
 require 'google_spreadsheet'
 require 'config'
+require 'locale'
+require 'migration_factory'
 
+# this class knows how to do all the things the cli needs done.
+# it mostly delegates to locale to do it, often asking multiple locales to do the same thing
 module I18n
   module Migrations
     class Migrator
+      def locale_for(name)
+        Locale.new(name,
+                   locales_dir: config.locales_dir,
+                   main_locale_name: config.main_locale,
+                   migrations: MigrationFactory.new(config.migration_dir),
+                   dictionary: new_dictionary(name))
+      end
+
       def config
         @config ||= Config.new.read!
       end
 
+      # for testing
+      def config=(config)
+        @config = config
+      end
+
       def new_migration(name)
         name = name.parameterize(separator: '_')
         file_name = "#{Time.now.strftime('%Y%m%d%H%M')}_#{name.downcase.gsub(' ', '_')}.rb"
@@ -39,299 +56,84 @@ end
 
       def migrate(locale_or_all = 'all')
         each_locale(locale_or_all) do |locale|
-          update_locale_info(locale) do |data, notes|
-            migrate_locale(locale, data, notes)
+          locale.update_info do |data, notes|
+            locale.migrate(data, notes)
           end
         end
       end
 
       def rollback(locale_or_all)
         each_locale(locale_or_all) do |locale|
-          update_locale_info(locale) do |data, notes|
-            rollback_locale(locale, data, notes)
+          locale.update_info do |data, notes|
+            locale.rollback(data, notes)
           end
         end
       end
 
       def pull(locale_or_all)
         each_locale(locale_or_all) do |locale|
-          next if locale == config.main_locale
-          sheet = get_google_spreadsheet(locale)
-          pull_locale(locale, sheet)
-          migrate(locale)
+          next if locale.main_locale?
+          sheet = get_google_spreadsheet(locale.name)
+          locale.pull(sheet)
+          migrate(locale.name)
         end
       end
 
       def push(locale_or_all, force = false)
         each_locale(locale_or_all) do |locale|
-          next if locale == config.main_locale
+          next if locale.main_locale?
           sheet = get_google_spreadsheet(locale)
           unless force
-            pull_locale(locale, sheet)
-            migrate(locale)
+            locale.pull(sheet)
+            migrate(locale.name)
           end
-          push_locale(locale, sheet)
+          locale.push(sheet)
         end
       end
 
       def new_locale(new_locale, limit = nil)
-        dictionary = new_dictionary(new_locale)
-        new_data, new_notes = {}, {}
-        count = 0
-        main_data = read_locale_data(config.main_locale)
-        main_data.each do |key, term|
-          new_data[key], new_notes[key] = dictionary.lookup(term)
-          print '.'.green
-          break if limit && limit < count += 1
-        end
-        new_data['VERSION'] = main_data['VERSION']
-        puts
-        write_locale_data_and_notes(new_locale, new_data, new_notes)
+        locale_for(new_locale).create
       end
 
       def version
         each_locale do |locale|
-          puts "#{locale}: #{locale_versions(read_locale_data(locale)).last}"
+          puts "#{locale.name}: #{locale.last_version}"
         end
       end
 
       def validate(locale_or_all)
         each_locale(locale_or_all) do |locale|
-          next if locale == config.main_locale
-          update_locale_info(locale) do |data, notes|
-            validate_locale(locale, data, notes)
+          next if locale.main_locale?
+          locale.update_info do |data, notes|
+            locale.validate(data, notes)
           end
         end
       end
 
       private
 
-      def validate_locale(locale, data, notes)
-        main_data = read_locale_data(config.main_locale)
-        dict = new_dictionary(locale)
-        main_data.each do |key, main_term|
-          old_term = data[key]
-          new_term, errors = dict.fix(main_term, old_term)
-          if new_term != old_term
-            data[key] = new_term
-            puts "#{"Fix".green} #{key.green}:"
-            puts "#{config.main_locale}: #{main_term}"
-            puts "#{locale} (old): #{old_term}"
-            puts "#{locale} (new): #{new_term}"
-            puts
-          end
-          replace_errors_in_notes(notes, key, errors)
-          if errors.length > 0
-            puts "Error #{errors.join(', ').red} #{key.yellow}"
-            puts "#{config.main_locale.bold}: #{main_term}"
-            puts "#{locale.bold}: #{old_term}"
-            puts
-          end
-        end
-      end
-
-      def replace_errors_in_notes(all_notes, key, errors)
-        return if all_notes[key].blank? && errors.empty?
-
-        notes = all_notes[key]
-        notes = notes.present? ? notes.split("\n") : []
-        notes = notes.reject { |n| n.start_with?("[error:") }
-        all_notes[key] = (errors.map{|e| "[error: #{e}]"} + notes).join("\n")
-      end
-
-      def update_locale_info(locale)
-        data, notes = read_locale_data_and_notes(locale)
-        yield data, notes
-        write_locale_data_and_notes(locale, data, notes)
-      end
-
-      def read_locale_data_and_notes(locale)
-        data = read_locale_data(locale)
-        notes = locale == config.main_locale ? {} : read_locale_from_file(locale, "../#{locale}_notes.yml")
-        [data, notes]
-      end
-
-      def read_locale_data(locale)
-        read_locale_from_file(locale, "#{locale}.yml")
-      end
-
-      def write_locale_data_and_notes(locale, data, notes)
-        write_locale_to_file(locale, "#{locale}.yml", data)
-        write_locale_to_file(locale, "../#{locale}_notes.yml", notes) unless locale == config.main_locale
-      end
-
-      def pull_locale(locale, sheet)
-        puts "Pulling #{locale}"
-        data = {}
-        notes = {}
-        count = 0
-
-        (2..sheet.num_rows).each do |row|
-          key, value, note = sheet[row, 1], sheet[row, 3], sheet[row, 4]
-          if key.present?
-            assign_complex_key(data, key.split('.'), value.present? ? value : '')
-            if note.present?
-              assign_complex_key(notes, key.split('.'), note)
-            end
-            count += 1
-            print '.'
-          end
-        end
-
-        write_locale_data_and_notes(locale, data, notes)
-        write_locale_remote_version(locale, data)
-
-        puts "\n#{count} keys"
-      end
-
-      def write_locale_remote_version(locale, data)
-        write_locale_to_file(locale,
-                             "../#{locale}_remote_version.yml",
-                             { 'VERSION' => locale_versions(data) })
-      end
-
-      def push_locale(locale, sheet)
-        main_data = read_locale_data(config.main_locale)
-        data, notes = read_locale_data_and_notes(locale)
-        row = 2
-
-        puts "Pushing #{locale}"
-
-        main_data.each do |key, value|
-          sheet[row, 1] = key
-          sheet[row, 2] = value
-          sheet[row, 3] = data[key]
-          sheet[row, 4] = notes[key]
-          row += 1
-          print '.'
-        end
-
-        sheet.synchronize
-        write_locale_remote_version(locale, data)
-
-        puts "\n#{main_data.keys.length} keys"
-      end
-
-      def migrate_locale(locale, data, notes)
-        missing_versions = (all_versions - locale_versions(data)).sort
-        if missing_versions.empty?
-          puts "#{locale}: up-to-date"
-          return
-        end
-        puts "#{locale}: Migrating #{missing_versions.join(', ')}"
-        missing_versions.each do |version|
-          migrate_locale_to_version(locale, data, notes, version, :up)
-        end
-      end
-
-      def rollback_locale(locale, data, notes)
-        last_version = locale_versions(data).last
-        if last_version == nil
-          puts "#{locale}: no more migrations to roll back"
-          return
-        end
-        puts "#{locale}: Rolling back #{last_version}"
-        raise "Can't find #{last_version}.rb to rollback" unless all_versions.include?(last_version)
-
-        migrate_locale_to_version(locale, data, notes, last_version, :down)
-      end
-
-      def migrate_locale_to_version(locale, data, notes, version, direction)
-        filename = File.join(config.migration_dir, "#{version}.rb")
-        require filename
-        migration_class_name = version.gsub(/^\d{12}_/, '').camelcase
-        dictionary = new_dictionary(locale)
-
-        migration = begin
-          migration_class_name.constantize.new(locale, data, notes, dictionary, direction)
-        rescue
-          raise "Couldn't load migration #{migration_class_name} in #{filename}"
-        end
-
-        migration.change
-
-        if direction == :up
-          data['VERSION'] = (locale_versions(data) + [version]).join("\n")
-        else
-          data['VERSION'] = (locale_versions(data) - [version]).join("\n")
-        end
-      end
-
-      def locale_versions(data)
-        (data['VERSION'] && data['VERSION'].split("\n")) || []
-      end
-
-      def read_locale_from_file(locale, filename)
-        filename = File.join(config.locales_dir, filename)
-        begin
-          hash = {}
-          add_to_hash(hash, YAML.load(File.read(filename))[locale.to_s])
-          hash
-        rescue
-          puts "Error loading #{filename}"
-          raise
-        end
-      end
-
-      def write_locale_to_file(locale, filename, hash)
-        # we have to go from flat keys -> values to a hash that contains other hashes
-        complex_hash = {}
-        hash.keys.sort.each do |key|
-          value = hash[key]
-          assign_complex_key(complex_hash, key.split('.'), value.present? ? value : '')
-        end
-        File.open(File.join(config.locales_dir, filename), 'w') do |file|
-          file << { locale => complex_hash }.to_yaml
+      def each_locale(name = 'all')
+        (name == 'all' ? all_locale_names : [name]).each do |l|
+          yield locale_for(l)
         end
       end
 
-      def assign_complex_key(hash, key, value)
-        if key.length == 0
-          # should never get here
-        elsif key.length == 1
-          hash[key[0]] = value
-        else
-          hash[key[0]] ||= {}
-          assign_complex_key(hash[key[0]], key[1..-1], value)
-        end
-      end
-
-      # flattens new_hash and adds it to hash
-      def add_to_hash(hash, new_hash, prefix = [])
-        return unless new_hash
-
-        new_hash.each do |key, value|
-          if value.is_a?(Hash)
-            add_to_hash(hash, value, prefix + [key])
-          else
-            hash[(prefix + [key]).join('.')] = value
-          end
-        end
-      end
-
-      def each_locale(locale = 'all')
-        (locale == 'all' ? all_locales : [locale]).each do |l|
-          yield l
-        end
-      end
-
-      def all_locales
+      def all_locale_names
         [config.main_locale] + config.other_locales
       end
 
-      def all_versions
-        Dir[config.migration_dir + '/*.rb'].map { |name| File.basename(name).gsub('.rb', '') }
-      end
-
-      def new_dictionary(locale)
-        GoogleTranslateDictionary.new(config.main_locale, locale, config.google_translate_api_key, config.do_not_translate)
-      end
-
       def get_google_spreadsheet(locale)
         GoogleSpreadsheet.new(locale,
                               config.google_spreadsheets[locale],
                               config.google_service_account_key_path).sheet
       end
+
+      def new_dictionary(locale)
+        GoogleTranslateDictionary.new(from_locale: config.main_locale,
+                                      to_locale: locale,
+                                      key: config.google_translate_api_key,
+                                      do_not_translate: config.do_not_translate)
+      end
     end
   end
 end

data/lib/i18n/migrations/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Migrations
-    VERSION = "0.1.4"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-migrations
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Lightsmith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,9 @@ files:
 - lib/i18n/migrations/config.rb
 - lib/i18n/migrations/google_spreadsheet.rb
 - lib/i18n/migrations/google_translate_dictionary.rb
+- lib/i18n/migrations/locale.rb
 - lib/i18n/migrations/migration.rb
+- lib/i18n/migrations/migration_factory.rb
 - lib/i18n/migrations/migrator.rb
 - lib/i18n/migrations/version.rb
 homepage: https://github.com/transparentclassroom/i18n-migrations