babbel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9302d1707f4506bad86066a8f76cdbacc60bc0c2
+  data.tar.gz: ed3515d5c26b2724744bb9beaffe92412f728d92
+SHA512:
+  metadata.gz: 164bb08ee9851ac374aaf95757ba05147bb794d0b3e3d26ac71a0f0c5a4868b7f12afcc585ccad47e7b7c307e06fc9f7f81f7becb04f83dccd75eb06fd59f55d
+  data.tar.gz: 7af49192272997683cc2702dbe79b89980c0845e736a86d76a2ddd52688d1feffdeb12f5a37f726c7fd20f980f05392d8702f74737547d8aa2f6479a7c87ac6c

data/test/babbel_integration_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+class BabbelIntegrationTest < IntegrationTest
+  describe Babbel do
+    setup_model :integration_model
+
+    let(:model) { IntegrationModel.create! column1: "column one", column2: "column2", language: :en }
+
+    setup do
+      @controller ||= Babbel::Controllers::TranslationsController.new
+      IntegrationModel.acts_as_translatable on: [:column1, :column2]
+      Babbel::Translators::Null.stubs(:ready?).returns(true)
+      Babbel::Translators::Null.any_instance.stubs(:translate).returns("this is a translation", "this is another translation")
+    end
+
+    describe "creating translations" do
+      it "can create translations" do
+        post :create, translatable_type: "IntegrationModel", translatable_id: model.id, to: :fr
+
+        created = Translation.where(translatable_type: "IntegrationModel")
+
+        assert_equal created.where(translatable_id: model.id).size, 2
+        assert_equal created.where(language: :fr).size, 2
+        assert_equal created.where(translatable_type: "IntegrationModel").size, 2
+        assert_equal created.where(translation: "this is a translation").size, 1
+        assert_equal created.where(translation: "this is another translation").size, 1
+      end
+    end
+  end
+end

data/test/fixtures/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  define_method :_routes, ->{}
+end

data/test/fixtures/rails.rb

@@ -0,0 +1,36 @@
+module Rails
+  def self.application
+    OpenStruct.new routes: routes,
+                   env_config: {}
+  end
+
+  def self.root
+    Dir['../../../']
+  end
+
+  def self.env
+    OpenStruct.new to_s: "test",
+                   development?: false,
+                   test?: true,
+                   production?: false
+  end
+
+  def self.backtrace_cleaner
+    ActiveSupport::BacktraceCleaner.new
+  end
+
+  class Engine
+  end
+
+  private
+
+  def self.routes
+    @routes ||= ActionDispatch::Routing::RouteSet.new.tap do |routes|
+      routes.draw { resources :translations }
+    end
+  end
+
+  def self.draw_routes
+
+  end
+end

data/test/lib/babbel_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class BabbelTest < UnitTest
+  describe "Babbel version" do
+    it "return the correct version" do
+      Babbel::VERSION.must_equal '0.0.1'
+    end
+  end
+end

data/test/lib/concerns/acts_as_translatable_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class ActsAsTranslatableTest < UnitTest
+  describe Babbel::Concerns::ActsAsTranslatable do
+
+    before do
+      setup_model :concern_model
+      ConcernModel.define_singleton_method(:find_alt) { |id| "found #{id}!" }
+    end
+
+    it "includes Translatable" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2]"
+      assert ConcernModel.included_modules.include?(Babbel::Concerns::Translatable)
+    end
+
+    it "defines a translatable_fields class method" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2]"
+      assert_equal ConcernModel.translatable_fields, [:column1, :column2]
+    end
+
+    it "defines a single translatable_field correctly" do
+      ConcernModel.class_eval "acts_as_translatable on: :column1"
+      assert_equal ConcernModel.translatable_fields, [:column1]
+    end
+
+    it "defines a custom get_instance class method" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2], load_via: :find_alt"
+      assert_equal ConcernModel.get_instance(42), ConcernModel.find_alt(42)
+    end
+
+    it "defines a get_instance class method as :find by default" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2]"
+      model = ConcernModel.create
+      assert_equal ConcernModel.get_instance(model.id), ConcernModel.find(model.id)
+    end
+
+    it "defines an id_field method as :id by default" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2]"
+      model = ConcernModel.new id: 42
+      assert_equal model.id_field, model.id
+    end
+
+    it "defines a custom id_field method" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2], id_field: :id_alt"
+      model = ConcernModel.new id_alt: 42
+      assert_equal model.id_field, model.id_alt
+    end
+
+    it "defines a language_field method as :language by default" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2]"
+      model = ConcernModel.new language: :en
+      assert_equal model.language_field, model.language
+    end
+
+    it "defines a custom language_field method" do
+      ConcernModel.class_eval "acts_as_translatable on: [:column1, :column2], language_field: :language_alt"
+      model = ConcernModel.new language_alt: :en
+      assert_equal model.language_field, model.language_alt
+    end
+  end
+
+end

data/test/lib/concerns/translatable_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+class TranslatableTest < UnitTest
+  describe Babbel::Concerns::Translatable do
+
+    let(:model) { ConcernModel.create column1: "test text" }
+
+    before do
+      setup_model :concern_model
+      include_translatable ConcernModel
+    end
+
+    it "has_many translations" do
+      assert_respond_to model, :translations
+      assert_instance_of Babbel::Models::Translation, model.translations.build
+    end
+
+    it "destroys translations after update" do
+      model.translations.build language: :en, field: :column1, translation: "test translation"
+      model.save
+      assert_equal model.reload.translations.size, 1
+
+      model.update! column1: "changed text"
+      model.save
+
+      assert_equal model.reload.translations.size, 0
+    end
+
+  end
+
+end

data/test/lib/controllers/translations_controller_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class TranslationsControllerTest < ControllerTest
+  describe Babbel::Controllers::TranslationsController do
+    setup_model :controller_model
+    let(:service) { Babbel::Services::TranslationService.new }
+
+    setup do
+      @controller ||= Babbel::Controllers::TranslationsController.new
+    end
+
+    describe "POST create" do
+      it "returns ok for successful translation" do
+        Babbel::Services::TranslationService.any_instance.stubs(:translate).returns(:true)
+        post :create, translatable_type: "ControllerModel"
+        assert_equal response.status, 200
+      end
+
+      it "returns unprocessable entity for unsuccessful translation" do
+        Babbel::Services::TranslationService.any_instance.stubs(:translate).returns(false)
+        post :create
+        assert_equal response.status, 422
+      end
+
+      it "returns unprocessable entity when translatable_type is not defined" do
+        Babbel::Services::TranslationService.any_instance.stubs(:translate).returns(false)
+        post :create
+        assert_equal response.status, 422
+      end
+    end
+  end
+end

data/test/lib/generators/babbel_generator_install_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+require 'generators/babbel/install/install_generator'
+
+class BabbelGeneratorInstallTest < Rails::Generators::TestCase
+  tests Babbel::InstallGenerator
+  setup_destination
+
+  test "generates a migration file" do
+    run_generator
+    assert_migration "db/migrate/add_babbel_translations.rb"
+  end
+
+  test "generates an initializer file" do
+    run_generator
+    assert_file "config/initializers/babbel.rb"
+  end
+end

data/test/lib/helpers/translations_helper_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class TranslationsHelperTest < UnitTest
+  include Babbel::Helpers::TranslationsHelper
+  include Rails.application.routes.url_helpers
+
+  setup_model :helper_model
+
+  let(:model) { HelperModel.new column1: 'a value', language: :en }
+
+  before do
+    I18n.locale = :fr
+  end
+
+  describe ".translate_link_for" do
+    it "returns a link with another locale set" do
+      assert_match /\?to=fr/, translate_link_for(model)
+    end
+
+    it "returns a link with a specified locale" do
+      I18n.locale = :en
+      assert_match /\?to=fr/, translate_link_for(model, to: :fr)
+    end
+
+    it "defaults to 'Translate' for link text" do
+      assert_match /Translate/, translate_link_for(model)
+    end
+
+    it "accepts a text parameter" do
+      assert_match /Other text/, translate_link_for(model, text: 'Other text')
+    end
+
+    it "does not return a link when locale is the same" do
+      I18n.locale = :en
+      refute translate_link_for(model)
+    end
+
+    it "does not return a link when specified locale is the same" do
+      refute translate_link_for(model, to: :en)
+    end
+  end
+
+  describe ".translated_element_for" do
+    it "returns an span with a language class" do
+      assert_match /to-fr/, translated_element_for(model, :column1)
+    end
+
+    it "returns a span with a field class" do
+      assert_match /column1-translated/, translated_element_for(model, :column1)
+    end
+
+    it "returns a span with a babbel class" do
+      assert_match /babbel-translated/, translated_element_for(model, :column1)
+    end
+
+    it "accepts an element parameter" do
+      assert_match /<div/, translated_element_for(model, :column1, element: :div)
+    end
+  end
+
+end

data/test/lib/models/translation_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+require 'babbel/models/translation'
+
+class TranslationTest < UnitTest
+  describe Babbel::Models::Translation do
+
+    setup_model :model_class
+    let(:translation) { Babbel::Models::Translation.new translatable: ModelClass.new, 
+                                                        language: :en,
+                                                        field: :field_name,
+                                                        translation: :translation }
+
+    it "should be valid when all fields are present" do
+      assert translation.valid?
+    end
+
+    it "should have a translatable" do
+      assert_respond_to translation, :translatable
+      assert_instance_of ModelClass, translation.translatable
+    end
+
+    it "should require a translatable" do
+      translation.translatable = nil
+      refute translation.valid?
+    end
+
+    it "should have a language" do
+      assert_equal translation.language, :en
+    end
+
+    it "should require a language" do
+      translation.language = nil
+      refute translation.valid?
+    end
+
+    it "should have a field name" do
+      assert_equal translation.field, :field_name
+    end
+
+    it "should require a field name" do
+      translation.field = nil
+      refute translation.valid?
+    end
+
+    it "should have a translation" do
+      assert_equal translation.translation, :translation
+    end
+
+    it "should require a translation" do
+      translation.translation = nil
+      refute translation.valid?
+    end 
+
+  end
+end

data/test/lib/services/translation_service_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+require 'babbel/services/translation_service'
+require 'babbel/models/translation'
+
+class BabbelTranslationServiceTest < UnitTest
+  setup_model :service_model
+  setup_translation
+
+  let(:translator_class) { Babbel::Translators::Base }
+  let(:service)      { Babbel::Services::TranslationService.new(translator_class) }
+  let(:translatable) { ServiceModel.new column1: "translatable text", column2: "more text", language: :en }
+
+  before do
+    ServiceModel.class_eval "acts_as_translatable on: [:column1, :column2]"
+    include_translatable ServiceModel
+    translator_class.stubs(:ready?).returns(true)
+    service.translator.stubs(:can_translate?).returns(true)
+    service.translator.stubs(:translate).returns("translation")
+  end
+
+  describe "initialize" do
+    it "sets a translator object on initialize" do
+      assert_equal service.translator.class, translator_class
+    end
+    it "raises an error on initialize if translator is not ready" do
+      translator_class.stubs(:ready?).returns(false)
+      ->{ Babbel::Services::TranslationService.new(translator_class) }.must_raise Babbel::Services::InvalidTranslatorError
+    end
+  end
+
+  describe "invalid translator error" do
+    it "has an error message" do
+      assert_match /Unable to instantiate translator/, Babbel::Services::InvalidTranslatorError.new.to_s
+    end
+  end
+
+  describe "translate" do
+    it "returns the results of translate!" do
+      service.stubs(:translate!).returns("translation result")
+      assert_equal service.translate(translatable), "translation result"
+    end
+  end
+
+  describe "translate!" do
+    it "builds all translations using translate_field" do
+      service.translate!(translatable)
+      assert_equal translatable.translations.size, 2
+    end
+
+    it "does not build an invalid translation" do
+      service.translator.stubs(:can_translate?).returns(false)
+      service.translate!(translatable)
+      assert_equal translatable.translations.size, 0
+    end
+  end
+
+  describe "translate_field" do
+    it "builds a translation with translate_field" do
+      service.translate_field(translatable, :column1)
+      assert_equal translatable.translations.size, 1
+    end
+    it "does not build an invalid translation" do
+      service.translator.stubs(:can_translate?).returns(false)
+      service.translate_field(translatable, :column1)
+      assert_equal translatable.translations.size, 0
+    end
+  end
+
+end

data/test/lib/translators/base_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+require 'babbel/translators/base'
+
+class BaseTest < UnitTest
+  describe Babbel::Translators::Base do
+    setup_model :translator_model
+
+    let(:translator_class) { Babbel::Translators::Base }
+    let(:translator) { translator_class.new }
+    let(:translatable) { TranslatorModel.new column1: "column one", language: :en }
+
+    setup do
+      TranslatorModel.acts_as_translatable on: :column1
+    end
+
+    it "returns false on ready?" do
+      refute translator_class.ready?
+    end
+
+    describe ".can_translate?" do
+
+      it "returns false if the translator is not ready" do
+        refute translator.can_translate? translatable, :column1, :fr
+      end
+
+      it "returns false if 'to' is not set" do
+        translator.stubs(:ready?).returns(:true)
+        refute translator.can_translate? translatable, :column1, nil
+      end
+
+      it "returns false if translatable's language is not set" do
+        translator.stubs(:ready?).returns(:true)
+        translatable.language = nil
+        refute translator.can_translate? translatable, :column1, :fr
+      end
+
+      it "returns false if the from and to language are the same" do
+        translator.stubs(:ready?).returns(:true)
+        refute translator.can_translate? translatable, :column1, :en
+      end
+
+      it "returns false if a translation already exists" do
+        translator.stubs(:ready?).returns(:true)
+        translatable.save
+        translatable.translations.create field: :column1, language: :fr
+        refute translator.can_translate? translatable, :column1, :fr
+      end
+
+      it "returns false if the field is not found on translatable" do
+        translator_class.stubs(:ready?).returns(:true)
+        refute translator.can_translate? translatable, :notacolumn, :fr
+      end
+
+      it "returns true otherwise" do
+        translator_class.stubs(:ready?).returns(:true)
+        assert translator.can_translate? translatable, :column1, :fr
+      end
+    end
+
+    it "raises an error on translate" do
+      assert_raises NotImplementedError do translator.translate(nil) end
+    end
+
+  end
+end

data/test/lib/translators/bing_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'babbel/translators/base'
+require 'babbel/translators/bing'
+require 'bing_translator'
+
+class BingTest < UnitTest
+  describe Babbel::Translators::Bing do
+
+    let(:translator_class) { Babbel:: Translators::Bing }
+    let(:translator) { translator_class.new }
+
+    before do
+      setup_bing_translator_env
+    end
+
+    it "initializes a BingTranslator" do
+      assert_instance_of BingTranslator, translator.translator
+    end
+
+    it "returns ready if ENV variables are set" do
+      assert translator_class.ready?
+    end
+
+    it "returns not ready if app id is not set" do
+      ENV['BING_TRANSLATOR_APP_ID'] = nil
+      refute translator_class.ready?
+    end
+
+    it "returns not ready if secret is not set" do
+      ENV['BING_TRANSLATOR_SECRET'] = nil
+      refute translator_class.ready?
+    end
+
+    it "can translate a translatable" do
+      translator.translator.stubs(:translate).returns("translation")
+      assert_equal translator.translate("original"), "translation"
+    end
+  end
+end

data/test/lib/translators/null_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+require 'babbel/translators/base'
+require 'babbel/translators/null'
+
+class NullTest < UnitTest
+  describe Babbel::Translators::Null do
+
+    let(:translator_class) { Babbel::Translators::Null }
+    let(:translator) { translator_class.new }
+
+    it "returns ready as true" do
+      assert translator_class.ready?
+    end
+
+    it "returns nil as a translation" do
+      assert_nil translator.translate("anything")
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,74 @@
+ENV['RAILS_ENV'] = 'test'
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'byebug'
+require 'bundler/setup'
+require 'active_record'
+require 'temping'
+ActiveRecord::Base.establish_connection adapter: :sqlite3, database: ':memory:'
+
+require 'action_controller'
+
+require 'fixtures/rails'
+require 'fixtures/application_controller'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha/mini_test'
+require 'rails/test_help'
+
+require 'test_types/unit_test'
+require 'test_types/controller_test'
+require 'test_types/integration_test'
+
+require 'babbel'
+
+I18n.enforce_available_locales = false
+
+def setup_destination
+  destination File.expand_path '../../../tmp', __FILE__
+  setup :prepare_destination
+end
+
+def setup_model(model = :test_model)
+  constantized = model.to_s.split("_").collect(&:capitalize).join
+  unless Object.const_defined?(constantized)
+    Temping.create model do
+      with_columns do |t|
+        t.integer :id_alt
+        t.string :column1, :column2, :language, :language_alt
+      end
+    end
+    include_acts_as_translatable Object.const_get(constantized)
+  end
+end
+
+def setup_translation
+  unless Object.const_defined?("Translation")
+    Temping.create :translation do
+      with_columns do |t|
+        t.integer :translatable_id
+        t.string  :translatable_type
+        t.string  :field
+        t.string  :language
+        t.text    :translation
+        t.timestamps
+      end
+    end
+  end
+end
+
+def setup_bing_translator_env
+  ENV['BING_TRANSLATOR_APP_ID'] = 'set'
+  ENV['BING_TRANSLATOR_SECRET'] = 'set'
+end
+
+def include_acts_as_translatable(model)
+  model.class_eval "include Babbel::Concerns::ActsAsTranslatable"
+end
+
+def include_translatable(model)
+  model.class_eval "include Babbel::Concerns::Translatable"
+end

data/test/test_types/controller_test.rb

@@ -0,0 +1,6 @@
+require 'action_controller'
+
+class ControllerTest < UnitTest
+  include ActionController::TestCase::Behavior
+  before { @routes = Rails.application.routes }
+end

data/test/test_types/integration_test.rb

@@ -0,0 +1,2 @@
+class IntegrationTest < ControllerTest
+end

data/test/test_types/unit_test.rb

@@ -0,0 +1,3 @@
+class UnitTest < MiniTest::Spec
+  include ActiveSupport::Testing::SetupAndTeardown
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: babbel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Kiesel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bing_translator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Sets up a framework for allowing inline translation of database content
+email:
+- james.kiesel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- test/babbel_integration_test.rb
+- test/fixtures/application_controller.rb
+- test/fixtures/rails.rb
+- test/lib/babbel_test.rb
+- test/lib/concerns/acts_as_translatable_test.rb
+- test/lib/concerns/translatable_test.rb
+- test/lib/controllers/translations_controller_test.rb
+- test/lib/generators/babbel_generator_install_test.rb
+- test/lib/helpers/translations_helper_test.rb
+- test/lib/models/translation_test.rb
+- test/lib/services/translation_service_test.rb
+- test/lib/translators/base_test.rb
+- test/lib/translators/bing_test.rb
+- test/lib/translators/null_test.rb
+- test/test_helper.rb
+- test/test_types/controller_test.rb
+- test/test_types/integration_test.rb
+- test/test_types/unit_test.rb
+homepage: http://www.github.com/gdpelican/babbel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- app
+- lib
+- test
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Store on-the-fly translations using Bing (or others!)
+test_files:
+- test/test_types/controller_test.rb
+- test/test_types/integration_test.rb
+- test/test_types/unit_test.rb
+- test/babbel_integration_test.rb
+- test/lib/models/translation_test.rb
+- test/lib/helpers/translations_helper_test.rb
+- test/lib/generators/babbel_generator_install_test.rb
+- test/lib/translators/bing_test.rb
+- test/lib/translators/null_test.rb
+- test/lib/translators/base_test.rb
+- test/lib/services/translation_service_test.rb
+- test/lib/concerns/translatable_test.rb
+- test/lib/concerns/acts_as_translatable_test.rb
+- test/lib/controllers/translations_controller_test.rb
+- test/lib/babbel_test.rb
+- test/test_helper.rb
+- test/fixtures/rails.rb
+- test/fixtures/application_controller.rb