voltron-translate 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9f22fea96122996488662651bfa7c633845525b
+  data.tar.gz: c48a44d4d9b69eadfd354a84ee257a613c567f8a
+SHA512:
+  metadata.gz: 2782a7f25f514aee929750704f9790fddf6788647e14cd450028fa594e8d650606dbf109e7c180700660ace9f9d3fead82d2458e287458192dec1156f5a780aa
+  data.tar.gz: 3ce6ab9f0d85a48083d2507cc70a3ad8b72ddadbaa0c1f3d3cc350c70bafb374874ea88e2658f4c452fb92fad42c214988052877fba7074e7ee66eee570d6d43

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+tmp/
+log/
+voltron-*.gem
+*.bak

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at eric.hainer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'http://gem.minow.io'
+
+# Specify your gem's dependencies in voltron-translate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eric Hainer
+
+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,124 @@
+[![Build Status](https://travis-ci.org/ehainer/voltron-translate.svg?branch=master)](https://travis-ci.org/ehainer/voltron-translate)
+
+# Voltron::Translate
+
+Voltron Translate is a different, in my mind more logical way of dealing with internationalization in rails, largely inspired by the Magento framework's __() method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voltron-translate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voltron-translate
+
+Then run the following to create the voltron.rb initializer (if not exists already) and add the translate config:
+
+    $ rails g voltron:translate:install
+
+## Usage
+
+Voltron Translate extends ActiveRecord::Base, ActionController::Base, ActionMailer::Base, and ActionView::Base with a __ (double underscore) method that makes internationalization and/or translating static phrases easier.
+
+Once installed, from any class that extends from any of the three rails classes you can use the double underscore method to allow for real time text translation. For example:
+
+```ruby
+@user = User.new(user_params)
+
+if @user.save
+  redirect_to @user, notice: __("User has been saved successfully.")
+else
+  flash.now[:alert] = __("User could not be saved.")
+  render :new
+end
+```
+
+or to use interpolation to support dynamic phrases:
+
+```ruby
+@user = User.new(user_params)
+
+if @user.save
+  redirect_to @user, notice: __("User with name %{person_name} has been saved successfully.", person_name: @user.name)
+else
+  flash.now[:alert] = __("User with name %{person_name} could not be saved.", person_name: [user_params[:first_name], user_params[:last_name]].join(" "))
+  render :new
+end
+```
+
+If the value of `Voltron.config.translate.enabled` is `true` and the code was running under one of the environments specified in `Voltron.config.translate.build_environment` (default: "development") then the line of text will be written to a each locale file you've configured. i.e. - If `Voltron.config.translate.locales == [:en, :es, :de]` then the phrase will be written to en.csv, es.csv, de.csv
+
+## Translating
+
+To translate a phrase, you only need to open the locale file you wish to translate the text for and change the value in the second column. For example, given en.csv with the following contents:
+
+```
+"User with name %{person_name} has been saved successfully.","User with name %{person_name} has been saved successfully."
+```
+
+Changing it to this:
+
+```
+"User with name %{person_name} has been saved successfully.","Welcome, %{person_name}! You're all ready to go."
+```
+
+Will cause any instance of `__("User with name %{person_name} has been saved successfully.", person_name: "Carl")` to output `Welcome, Carl! You're all ready to go.`
+
+Note that if a phrase does not exist in the CSV, you can always add it manually just so long as it matches exactly the text contained within the first argument of a __("") method. Voltron Translate uses `Voltron.config.translate.build_environment` to determine what environments it's allowed to auto-generate translations for, but it only writes to locale files whenever a __() is actually reached. Consider:
+
+```ruby
+if 1 == 1
+  __("Hello World")
+else
+  __("Goodbye World")
+end
+```
+
+In a case like the above, "Goodbye World" will never be written to any locale file. If you still want to translate that phrase however you can just add the following to the csv:
+
+```
+"Goodbye World","Goodbye World, nice to know ya."
+```
+
+Then consider changing your if condition to something a little less absurd so that code could be reached.
+
+## Choosing a translation locale
+
+By default, the file Voltron Translate will pull the translations from is determined by the value of `I18n.locale` If you set the value to `:de` it will look for translations in de.csv
+
+If you need a specific __() call to use a specific locale, you may specify it as the second argument:
+
+```ruby
+__("User with name %{person_name} has been saved successfully.", :de, person_name: @user.name)
+```
+
+Will always look for the above translation within de.csv
+
+## Things to Note
+
+Setting `Voltron.config.translate.enabled` to `false` will never break any __() call, it simply causes it to ignore the locale argument (if specified) and return the interpolated string using the latter arguments (again, if any)
+
+Disabling translations simply disables any IO related actions that would occur normally, like building or looking up translations when __() methods are called.
+
+## 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/ehainer/voltron-translate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "voltron/translate"
+
+# 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

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/lib/generators/voltron/translate/install_generator.rb

@@ -0,0 +1,42 @@
+module Voltron
+  module Translate
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+
+        desc "Add Voltron Translate initializer"
+
+        def inject_initializer
+
+          voltron_initialzer_path = Rails.root.join("config", "initializers", "voltron.rb")
+
+          unless File.exist? voltron_initialzer_path
+            unless system("cd #{Rails.root.to_s} && rails generate voltron:install")
+              puts "Voltron initializer does not exist. Please ensure you have the 'voltron' gem installed and run `rails g voltron:install` to create it"
+              return false
+            end
+          end
+
+          current_initiailzer = File.read voltron_initialzer_path
+
+          unless current_initiailzer.match(Regexp.new(/^# === Voltron Translate Configuration ===/))
+            inject_into_file(voltron_initialzer_path, after: "Voltron.setup do |config|\n") do
+<<-CONTENT
+
+  # === Voltron Translate Configuration ===
+
+  # Whether or not translation is enabled
+  # config.translate.enabled = true
+
+  # Which locales to build translation files for
+  # config.translate.locales << :en
+
+  # In what environments can translation generation occur. Recommended to keep this as development (default)
+  # config.translate.build_environment << :development
+CONTENT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/voltron/config/translate.rb

@@ -0,0 +1,27 @@
+module Voltron
+  class Config
+
+    def translate
+      @translate ||= Translate.new
+    end
+
+    class Translate
+
+      attr_accessor :build_environment, :enabled, :locales
+
+      def initialize
+        @build_environment ||= [:development]
+        @enabled ||= true
+        @locales ||= [:en]
+      end
+
+      def enabled?
+        enabled == true
+      end
+
+      def buildable?
+        [build_environment].flatten.map(&:to_s).include?(Rails.env.to_s)
+      end
+    end
+  end
+end

data/lib/voltron/translate.rb

@@ -0,0 +1,106 @@
+require "voltron"
+require "voltron/translate/version"
+require "voltron/config/translate"
+require "digest"
+require "csv"
+require "google_hash"
+
+module Voltron
+  module Translate
+
+    def __(text, locale = I18n.locale, **args)
+      return (text % args) unless Voltron.config.translate.enabled?
+
+      begin
+        raise "Locale can only contain the characters A-Z, and _" unless locale.to_s =~ /^[A-Z_]+$/i
+
+        # If app is running in one of the environments where translations can be created
+        if Voltron.config.translate.buildable?
+          Voltron.config.translate.locales.each { |locale| translator(locale).write text }
+        end
+
+        # Translate the text and return it
+        translator(locale).translate text, **args
+      rescue => e
+        # If any errors occurred, log the error and just return the default interpolated text
+        Voltron.log e.message.to_s + " (Original Translation Text: #{text})", "Translate", :light_red
+        text % args
+      end
+    end
+
+    def translator(locale = I18n.locale)
+      @translators ||= {}
+      @translators[locale.to_s] ||= Translation.new(locale)
+      @translators[locale.to_s]
+    end
+
+    class Translation
+
+      attr_accessor :locale, :list, :last_modified
+
+      def initialize(locale)
+        @locale = locale.to_s
+        load_list # Load the list of translations into a dense google hash object for retrieval
+      end
+
+      def translate(text, **args)
+        phrase(text, args) % args
+      end
+
+      def []=(text, translation)
+        unless list.has_key?(text)
+          CSV.open(path, "a", force_quotes: true) { |f| f.puts [text, translation] }
+          list[text] = translation
+        end
+      end
+
+      def destroy
+        File.unlink(path) if File.exists?(path)
+        load_list
+      end
+
+      def path
+        @path ||= Rails.root.join("config", "locales", "#{locale}.csv")
+      end
+
+      def write(text)
+        unless list.has_key?(text)
+          CSV.open(path, "a", force_quotes: true) { |f| f.puts [text, text] }
+          list[text] = text
+          Voltron.log "Added translation for text '#{text}' (Locale: #{locale})", "Translate", :light_blue
+        end
+      end
+
+      private
+
+        def load_list
+          @list = ::GoogleHashDenseRubyToRuby.new
+          @last_modified = modified
+          Rails.cache.delete_matched("translations/phrase") if Rails.cache.respond_to?(:delete_matched)
+          CSV.foreach(path, force_quotes: true) { |row| list[row.first] = row.last unless list.has_key?(row.first) } if File.exists?(path)
+        end
+
+        def phrase(text, args)
+          load_list if modified > last_modified
+          write(text) if Voltron.config.translate.buildable?
+          key = phrase_key(text, args)
+          Rails.cache.fetch(key) { list[text] } || text
+        end
+
+        def modified
+          if File.exists? path
+            File.mtime(path).to_i
+          else
+            Time.now.to_i
+          end
+        end
+
+        def phrase_key(text, args)
+          key = Digest::SHA256.hexdigest [text, locale, modified].map(&:to_s).join + args.map { |k,v| "#{k}#{v}" }.join
+          "translations/phrase/#{key}"
+        end
+    end
+  end
+end
+
+require "voltron/translate/railtie" if defined?(Rails)

data/lib/voltron/translate/railtie.rb

@@ -0,0 +1,14 @@
+require "voltron"
+
+module Voltron
+  module Translate
+    class Railtie < Rails::Railtie
+      initializer "voltron.translate.initialize" do
+        ::ActionController::Base.send :include, ::Voltron::Translate
+        ::ActiveRecord::Base.send :include, ::Voltron::Translate
+        ::ActionView::Base.send :include, ::Voltron::Translate
+        ::ActionMailer::Base.send :include, ::Voltron::Translate
+      end
+    end
+  end
+end

data/lib/voltron/translate/version.rb

@@ -0,0 +1,5 @@
+module Voltron
+  module Translate
+    VERSION = "0.1.2".freeze
+  end
+end

data/voltron-translate.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voltron/translate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "voltron-translate"
+  spec.version       = Voltron::Translate::VERSION
+  spec.authors       = ["Eric Hainer"]
+  spec.email         = ["eric@commercekitchen.com"]
+
+  spec.summary       = %q{Implements double underscore method for translating and interpolating phrases}
+  spec.homepage      = "https://github.com/ehainer/voltron-translate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 4.2"
+  spec.add_dependency "voltron", ">= 0.1.0"
+  spec.add_dependency "google_hash", ">= 0.9.0"
+
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "rspec-rails", ">= 3.4"
+  spec.add_development_dependency "sqlite3", ">= 1.2"
+  spec.add_development_dependency "simplecov", "0.11.0"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: voltron-translate
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Eric Hainer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: voltron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: google_hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: 
+email:
+- eric@commercekitchen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/voltron/translate/install_generator.rb
+- lib/voltron/config/translate.rb
+- lib/voltron/translate.rb
+- lib/voltron/translate/railtie.rb
+- lib/voltron/translate/version.rb
+- voltron-translate.gemspec
+homepage: https://github.com/ehainer/voltron-translate
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Implements double underscore method for translating and interpolating phrases
+test_files: []