inline_translation 0.1.0 → 0.1.1

data/lib/inline_translation/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :translations, only: :create
+end

data/lib/inline_translation/engine.rb

@@ -0,0 +1,4 @@
+module InlineTranslation
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/inline_translation/helpers/translations_helper.rb

@@ -0,0 +1,26 @@
+require 'action_view/helpers'
+
+module InlineTranslation
+  module Helpers
+    module TranslationsHelper
+      include ActionView::Helpers
+
+      def translate_link_for(translatable, to: I18n.locale, text: "Translate")
+        link_to text, path_for(translatable, to), method: :post, remote: true if translatable.language != to
+      end
+
+      def translated_element_for(translatable, field, element: :span, to: I18n.locale)
+        content_tag element, '', class: "#{field}-translated to-#{to} inline-translation-translated"
+      end
+
+      private
+
+      def path_for(translatable, to)
+        translations_path translatable_id: translatable.id,
+                          translatable_type: translatable.class.to_s,
+                          to: to,
+                          action: :create
+        end
+    end
+  end
+end

data/lib/inline_translation/models/translation.rb

@@ -0,0 +1,9 @@
+module InlineTranslation
+  module Models
+    class Translation < ActiveRecord::Base
+      belongs_to :translatable, polymorphic: true
+      scope :to_language, ->(language) { where language: language }
+      validates_presence_of :translatable, :language, :field, :translation
+    end
+  end
+end

data/lib/inline_translation/services/translation_service.rb

@@ -0,0 +1,36 @@
+module InlineTranslation
+  module Services
+    class TranslationService
+      attr_reader :translator
+
+      def initialize(translator_class = InlineTranslation.translator)
+        raise InvalidTranslatorError.new unless translator_class.ready?
+        @translator = translator_class.new
+      end
+
+      def translate(translatable, to: I18n.locale)
+        translate!(translatable, to: to) rescue false
+      end
+
+      def translate!(translatable, to: I18n.locale)
+        translatable.class.translatable_fields.map { |field| translate_field(translatable, field, to: to) }
+        translatable.save
+      end
+
+      def translate_field(translatable, field, to: I18n.locale)
+        translatable.translations.build(
+          field: field,
+          language: to,
+          translation: @translator.translate(translatable.send(field), from: translatable.language_field, to: to)
+        ) if @translator.can_translate?(translatable, field, to)
+      end
+
+    end
+
+    class InvalidTranslatorError < StandardError
+      def to_s
+        "Unable to instantiate translator: Please ensure that the appropriate ENV variables are set"
+      end
+    end
+  end
+end

data/lib/inline_translation/translators/base.rb

@@ -0,0 +1,25 @@
+module InlineTranslation
+  module Translators
+    class Base
+      attr_reader :translator
+
+      def self.ready?
+        false
+      end
+
+      def can_translate?(translatable, field, to)
+        self.class.ready? &&
+        to.present? &&
+        translatable.respond_to?(field) &&
+        translatable.language_field.present? &&
+        translatable.language_field.to_s != to.to_s &&
+        translatable.translations.where(field: field, language: to).empty?
+      end
+
+      def translate(text, from: nil, to: I18n.locale)
+        raise NotImplementedError.new
+      end
+
+    end
+  end
+end

data/lib/inline_translation/translators/bing.rb

@@ -0,0 +1,21 @@
+require 'bing_translator'
+
+module InlineTranslation
+  module Translators
+  	class Bing < Base
+
+      def self.ready?
+        ENV['BING_TRANSLATOR_APP_ID'] && ENV['BING_TRANSLATOR_SECRET'] && true
+      end
+
+      def initialize
+        @translator = ::BingTranslator.new ENV['BING_TRANSLATOR_APP_ID'], ENV['BING_TRANSLATOR_SECRET']
+      end
+
+      def translate(text, from: nil, to: I18n.locale)
+        @translator.translate text, from: from, to: to
+      end
+
+  	end
+  end
+end

data/lib/inline_translation/translators/null.rb

@@ -0,0 +1,18 @@
+module InlineTranslation
+  module Translators
+    class Null < Base
+
+      def self.ready?
+        true
+      end
+
+      def initialize
+      end
+
+      def translate(text, from: nil, to: I18n.locale)
+        nil
+      end
+
+    end
+  end
+end

data/lib/inline_translation/version.rb

@@ -0,0 +1,3 @@
+module InlineTranslation
+  VERSION = "0.1.1"
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: inline_translation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - James Kiesel (gdpelican)
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bing_translator
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: bing_translator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,32 +66,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
 description: Sets up a framework for allowing inline translation of database content
 email:
-- james.kiesel@gmail.com
+- james@loomio.org
 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/InlineTranslation
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/translations_controller.rb
+- config/initializers/babbel.rb
+- config/routes.rb
+- inline_translation.gemspec
+- lib/generators/inline_translation/install/install_generator.rb
+- lib/generators/inline_translation/install/templates/add_inline_translations.rb
+- lib/generators/inline_translation/install/templates/create.js.erb
+- lib/generators/inline_translation/install/templates/inline_translation.rb
+- lib/inline_translation.rb
+- lib/inline_translation/concerns/acts_as_translatable.rb
+- lib/inline_translation/concerns/translatable.rb
+- lib/inline_translation/config/routes.rb
+- lib/inline_translation/engine.rb
+- lib/inline_translation/helpers/translations_helper.rb
+- lib/inline_translation/models/translation.rb
+- lib/inline_translation/services/translation_service.rb
+- lib/inline_translation/translators/base.rb
+- lib/inline_translation/translators/bing.rb
+- lib/inline_translation/translators/null.rb
+- lib/inline_translation/version.rb
+homepage: http://www.github.com/gdpelican/inline_translation
 licenses:
 - MIT
 metadata: {}
@@ -100,7 +121,6 @@ rdoc_options: []
 require_paths:
 - app
 - lib
-- test
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -117,22 +137,4 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Store on-the-fly translations using Bing (or others!)
-test_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
+test_files: []

data/test/babbel_integration_test.rb

@@ -1,34 +0,0 @@
-require 'test_helper'
-class InlineTranslationIntegrationTest < IntegrationTest
-  describe InlineTranslation do
-    setup_model :integration_model
-
-    let(:model) { IntegrationModel.create! column1: "column one", column2: "column2", language: :en }
-
-    setup do
-      @controller ||= InlineTranslation::Controllers::TranslationsController.new
-      IntegrationModel.acts_as_translatable on: [:column1, :column2]
-      InlineTranslation::Translators::Null.stubs(:ready?).returns(true)
-      InlineTranslation::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, format: :json
-
-        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
-
-
-        before_count = Translation.count
-        post :create, translatable_type: "IntegrationModel", translatable_id: model.id, to: :fr, format: :json
-        assert_equal Translation.count, before_count
-      end
-    end
-  end
-end

data/test/fixtures/application_controller.rb

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

data/test/fixtures/rails.rb

@@ -1,36 +0,0 @@
-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

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

data/test/lib/concerns/acts_as_translatable_test.rb

@@ -1,62 +0,0 @@
-require 'test_helper'
-
-class ActsAsTranslatableTest < UnitTest
-  describe InlineTranslation::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?(InlineTranslation::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