glossync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd9b544462c2d05d9ff02e06db91b943cc322f1e9cbee1ac4a14f8b287e06996
+  data.tar.gz: cac223ba8b7ed1be058a16f22de5665eba2d5cee63cba8c9ff93224dfef6dbb5
+SHA512:
+  metadata.gz: ea8951faccca78562cb5c648b60971222c2b1bc845d2260f7319394a378ed6e8f04241b89d9189b37d375cc80c079fb78b526911d385ffb33bb76e4f896cdd73
+  data.tar.gz: 03db39e6f1c9ce3e4f7332e79487bb27e703b929fffc39b6094207d72e99dae17eae73594764719dda026c4370b3981ba3f9f971929d11a687ad316dc7636ce8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in glossync.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    glossync (0.1.0)
+      i18n (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.3.0)
+      concurrent-ruby (~> 1.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  glossync!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Stone Tickle
+
+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.md

@@ -0,0 +1,56 @@
+# Glossync
+[![Build Status](https://travis-ci.org/annacrombie/glossync.svg?branch=master)](https://travis-ci.org/annacrombie/glossync)
+
+Easily manage multiple translations for models in your database.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'glossync'
+```
+
+And then execute:
+
+``
+bundle
+``
+
+Or install it yourself as:
+
+``sh
+gem install glossync
+``
+
+## Usage
+
+```ruby
+class Question < ApplicationRecord
+  include Glossync
+  has_translations_for :question
+end
+
+I18n.locale = :en
+Question.first.question #=> "What si your name?"
+Question.first.update(question: "What is your name?")
+I18n.locale = :ja
+Question.first.update(question: "お名前はなんですか")
+Question.first.question #=> "お名前はなんですか"
+I18n.locale = :en
+Question.first.question #=> "What is your name?"
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/annacrombie/glossync.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'glossync'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/glossync.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'glossync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'glossync'
+  spec.version       = Glossync::VERSION
+  spec.authors       = ['Stone Tickle']
+  spec.email         = ['lattis@mochiro.moe']
+
+  spec.summary       = "A simple mixin to help make ActiveRecord models with
+  localized strings easier to deal with"
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'i18n', '~> 1.1'
+end

data/lib/glossync/railtie.rb

@@ -0,0 +1,9 @@
+module Glossync
+  # A railtie to add rake tasks in to rails
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir.glob(File.join(__dir__, '../tasks/*'))
+         .each { |task| load task }
+    end
+  end
+end

data/lib/glossync/tl_adapter.rb

@@ -0,0 +1,36 @@
+module Glossync
+  class TlAdapter
+    include I18n::Backend::Base
+
+    TlElem = Struct.new(:value) do
+      def update(value:)
+        self.value = value
+      end
+    end
+
+    def initialize
+      super
+
+      @db = {}
+    end
+
+    def exists?(locale:, key:)
+      @db.key?(key) && @db[key].key?(locale)
+    end
+
+    def find_by(locale:, key:)
+      return nil unless exists?(locale: locale, key: key)
+
+      @db[key][locale]
+    end
+
+    def create(locale:, key:, value:)
+      @db[key] ||= {}
+      @db[key][locale] = TlElem.new(value)
+    end
+
+    def lookup(locale, key, *)
+      find_by(locale: locale, key: key).value
+    end
+  end
+end

data/lib/glossync/version.rb

@@ -0,0 +1,3 @@
+module Glossync
+  VERSION = '0.1.0'.freeze
+end

data/lib/glossync.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'glossync/version'
+require 'glossync/tl_adapter'
+require 'glossync/railtie' if defined?(Rails)
+
+# Include into ActiveRecords to obtain some nice I18n features
+module Glossync
+  # methods that match this pattern will be responded to in method_missing()
+  METHOD_PATTERN = /_translated$/.freeze
+
+  class << self
+    attr_writer :tl_store
+
+    def tl_store
+      return @tl_store unless @tl_store.nil?
+
+      Translation
+    rescue NameError
+      raise 'No Translation store'
+    end
+
+    # Should we call I18n.backend.reload! on each call to tl_update that
+    # modifies data?
+    def reload_backend_on_tl_update?
+      @reload_backend_on_tl_update ||= true
+    end
+
+    # :nodoc:
+    def reload_backend_on_tl_update=(bool)
+      @reload_backend_on_tl_update = !!bool
+    end
+
+    # called when a module is included, add methods to the base class
+    def append_features(rcvr)
+      super
+
+      # attr_writer for @glossync
+      rcvr.define_singleton_method(:has_translations_for) do |*keys|
+        @glossync =
+          keys.map(&:to_sym).reject { |k| glossync.include?(k) }.map do |k|
+            # overwrite the reader method for the specified key to just return
+            # the translation.
+            rcvr.define_method(k) do
+              tl(k)
+            end
+
+            # overwrite the writer method for the specified key to update the
+            # translation for the key as well as update the key
+            rcvr.define_method(:"#{k}=") do |val|
+              tl_update(k, val)
+              defined?(super) ? super(val) : val
+            end
+
+            k
+          end + glossync
+      end
+
+      # attr_reader for @glossync
+      rcvr.define_singleton_method(:glossync) do
+        @glossync || []
+      end
+    end
+  end
+
+  # This sticks some code in front of #update that also updates any
+  # translations that were modified
+  def update(hash)
+    hash.to_h.map { |k, v| [k, v] }.to_h # really convert it to a hash
+        .transform_keys(&:to_sym)
+        .select { |k, _| self.class.glossync.include?(k) }
+        .each { |k, v| tl_update(k, v) }
+
+    super if defined?(super)
+  end
+
+  # If you add _translated to the end of a glossync field, call tl_key
+  # on that field automatically
+  def method_missing(method, *args, &block)
+    if respond_to_missing?(method)
+      tl(method.to_s.gsub(METHOD_PATTERN, ''))
+    else
+      super
+    end
+  end
+
+  # Determines is a missing method name can be handled
+  def respond_to_missing?(method, include_private = false)
+    (METHOD_PATTERN.match?(method) &&
+      self.class
+          .glossync
+          .include?(method.to_s.gsub(METHOD_PATTERN, '').to_sym)) ||
+      super
+  end
+
+  # Creates a key for the translation of a field, suitable for I18n.t()
+  #
+  # The key consists of the name of the model downcased, the id of the model,
+  # and the name of the field translated, joined with a '.'
+  #
+  # @example QuizAnswer.first.tl_key(:answer) => "quizanswer.1.answer"
+  #
+  # @param field the field to generate a key for
+  # @return [String] a key
+  def tl_key(field)
+    [
+      self.class.name.split('::').last.downcase,
+      id,
+      field.to_s
+    ].join('.')
+  end
+
+  # Call I18n.translate for the key corresponding to field
+  #
+  # @example QuizAnswer.first.tl_key(:answer) => "True"
+  #
+  # @param field the field to translate
+  # @return [String] the translated string
+  def tl(field)
+    I18n.translate(tl_key(field))
+  end
+
+  # Update the translation associated with a field and locale
+  #
+  # This method creates a new Translation if no pre-existing translation is
+  # found
+  #
+  # @param field the field to update the translation of
+  # @param value the new translation
+  # @param locale the locale of the new translation, if none is specified, the
+  #   default locale will be used
+  # @return [Boolean] wether or not an update was performed
+  def tl_update(field, value, locale = nil)
+    locale ||= I18n.locale
+    tls = Glossync.tl_store
+
+    h = { locale: locale, key: tl_key(field) }
+
+    if tls.exists?(h)
+      tl = tls.find_by(h)
+      return false if tl.value == value
+
+      tl.update(value: value)
+    else
+      tls.create(h.merge(value: value))
+    end
+
+    I18n.backend.reload! if Glossync.reload_backend_on_tl_update?
+
+    true
+  end
+end

data/lib/tasks/setup_model_translations.rake

@@ -0,0 +1,90 @@
+desc 'Extract and insert Translations for Glossync models'
+task setup_model_translations: :environment do
+
+  # eager load all the rails constants
+  Rails.application.eager_load!
+  # don't reload the I18n backend on each tl_update
+  Glossync.reload_backend_on_tl_update = false
+  # require 'io/console' so we can get the terminal's width
+  require 'io/console'
+
+  # a lambda to insert translations, returns true if a translation was inserted
+  # or false otherwise
+  insert_translation = lambda do |locale|
+    lambda do |key, value|
+      if Translation.exists?(key: key)
+        false
+      else
+        Translation.create(locale: locale, key: key, value: value)
+        true
+      end
+    end
+  end
+
+  # handy lambda to calculate percents
+  pct = ->(y) { ->(x) { (x * 100.0) / y } }
+
+  # lambda to display a pretty log of our progress
+  log = ->(m, i, t, pct, a) do
+    graphw = ($stdout.winsize[1] - 70)
+    printf(
+      "\r[\e[35m%5.1f%%\e[0m] -- processing " +
+        "\e[34m%-20.20s\e[0m (\e[35m%5d\e[0m/\e[37m%5d\e[0m) " +
+        "\e[%sm%-8.8s\e[0m [\e[35m%-#{graphw}.#{graphw}s\e[0m]\e[K",
+      pct, m.to_s, i + 1, t, a == 'skipping' ? '33' : '32', a,
+      graphw.positive? ? ('#' * (graphw * pct / 100).round) : ''
+    )
+  end
+
+  # setup the translation lambda to insert english translations
+  tl = insert_translation.('en')
+
+  # get a list of models that include Glossync
+  models = ActiveRecord::Base.descendants.select do |c|
+    c.included_modules.include?(Glossync)
+  end
+
+  # setup some variables for displaying information
+  pct = pct.(models.map(&:count).reduce(0, :+))
+  x = 0
+  actions = { 'skipping' => 0, 'adding' => 0 }
+  start_time = Time.now
+
+  # this is the main logic of the task, for each model and each key within that
+  # model that is translatable, insert a new translation
+
+  # for each model that includes Glossync
+  models.each do |model|
+    # get a list of the keys that module ``has_translations_for''
+    keys = model.translatable
+    # c is the number of instances of this particular model (used later in
+    # printing the progress bar)
+    c = model.count
+
+    # for each instance of the model,
+    model.all.each_with_index do |e, i|
+      # for each key that has a translatoin call the above tl Proc an get an
+      # array of bools indicating wether or not the translation was inserted or
+      # skipped
+      status = keys.map {|k| tl.(e.tl_key(k), e[k]) }
+
+      # make a message indicating wether we added anything
+      msg = status.any? ? 'adding' : 'skipping'
+
+      # record the action count
+      actions[msg] += 1
+
+      # print some info
+      log.(model, i, c, pct.(x += 1), msg)
+    end
+  end
+
+  # print a summary
+  printf(
+    "\r[\e[35m100.0%%\e[0m] -- done, " +
+      "processed \e[35m%d\e[0m models " +
+      "(\e[33mskipped %d\e[0m, \e[32madded %d\e[0m) " +
+      "in \e[34m%.1f\e[0m seconds\e[K\n",
+    x, actions['skipping'], actions['adding'], Time.now - start_time
+  )
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: glossync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stone Tickle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- lattis@mochiro.moe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- glossync.gemspec
+- lib/glossync.rb
+- lib/glossync/railtie.rb
+- lib/glossync/tl_adapter.rb
+- lib/glossync/version.rb
+- lib/tasks/setup_model_translations.rake
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple mixin to help make ActiveRecord models with localized strings easier
+  to deal with
+test_files: []