form_translation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 353ea97f8b6fd74b339836ee6ed39e92ba380218
+  data.tar.gz: b3475b5d28a56fc1cf45f65323f0c34ca6fdc6bc
+SHA512:
+  metadata.gz: ac6386bb7109c47ccadee963145a211557cf2388b7dd4be27648c4e99e5a255299470f3ea45483f635a740ddd1d81906fc5751da9a1904dd68e191bc79c43791
+  data.tar.gz: 2c187a1d4696ba30842d08830449dda1da234c0d64a6e12633b5bbc35e798730bddc1d746fad75b308fb6dab3f43e2803e4b3faed5a9af43d59d41e15d5883b9

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - '2.0.0'
+  - '2.1.0'
+before_script: "bundle exec rake db:migrate RAILS_ENV=test"
+script: "bundle exec rake test"
+

data/Gemfile

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in form_translation.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+gem 'jquery-rails'
+gem 'sass-rails', '~> 4.0.0'
+gem 'bootstrap-sass', '~> 3.0.3.0'
+
+group :development do
+  gem "better_errors"
+  gem "binding_of_caller"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Florian Thomas
+
+MIT License
+
+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,71 @@
+# FormTranslation
+[![Code Climate](https://codeclimate.com/github/Crunch09/form_translation.png)](https://codeclimate.com/github/Crunch09/form_translation)
+[![Build Status](https://travis-ci.org/Crunch09/form_translation.png?branch=master)](https://travis-ci.org/Crunch09/form_translation)
+**Not ready, don't use it in production yet.**
+
+It uses `ActiveRecord::Store` to store language specific values and adds
+tabs to your forms for each language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'form_translation', github: 'Crunch09/form_translation'
+```
+
+And then execute:
+
+```
+$ bundle
+$ rails g form_translation:install
+```
+
+## Usage
+
+* In your model include `FormTranslation::ForModel* and specify which attributes
+should be translated.
+```ruby
+class Article < ActiveRecord::Base
+      include FormTranslation::ForModel
+
+      translate_me :subject, :body
+end
+```
+* Within your `simple_form`-Form specify where to put your translation-tabs
+with a `languagify` block.
+
+```erb
+<%= simple_form_for(@article) do |f| %>
+      <div class="form-inputs">
+        <%= f.input :date %>
+      </div>
+      <div>
+        <%= f.languagify do |l| %>
+          <%= l.input :subject %>
+          <%= l.input :body %>
+        <% end %>
+      </div>
+      <div class="form-actions">
+        <%= f.button :submit %>
+      </div>
+<% end %>
+```
+
+Lastly, make sure to add the translated attributes to your permitted parameters
+so they can be stored. The convention for the attribute name is as follows:
+`language_shortname`_`attribute_name`
+
+```ruby
+def article_params
+  params.require(:article).permit(:subject, :body, :de_subject, :de_body)
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FormTranslation'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/form_translation/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/form_translation.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'form_translation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "form_translation"
+  spec.version       = FormTranslation::VERSION
+  spec.authors       = ["Florian Thomas"]
+  spec.email         = ["flo@florianthomas.net"]
+  spec.description   = %q{Include fields for multiple languages in your forms.}
+  spec.summary       = %q{Include fields for multiple languages in your forms.}
+  spec.homepage      = "https://github.com/Crunch09/form_translation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_dependency "rails", "~>  4.0.0"
+  spec.add_dependency "simple_form", "~> 3.1.0.rc1"
+end

data/lib/form_translation.rb

@@ -0,0 +1,26 @@
+require "form_translation/version"
+require "form_translation/engine"
+require "form_translation/for_model"
+require "form_translation/custom_form_builder"
+require "form_translation/errors"
+require "form_translation/active_record"
+
+module FormTranslation
+
+  mattr_accessor :default_language
+  @@default_language = :de
+
+  mattr_accessor :foreign_languages
+  @@foreign_languages = [:en]
+
+  mattr_accessor :translation_column
+  @@translation_column = :translation
+
+  def self.config
+    yield self
+  end
+
+  def self.languages
+    (Array(self.default_language) + Array(self.foreign_languages)).uniq
+  end
+end

data/lib/form_translation/active_record.rb

@@ -0,0 +1,27 @@
+module FormTranslation::SwitchLocale
+  extend ActiveSupport::Concern
+
+  def with_locale(loc, &block)
+    self.class.with_locale(loc, &block)
+  end
+
+  included do
+    @@_form_translation_locale = nil
+  end
+
+  module ClassMethods
+    def with_locale(loc, &block)
+      raise "unsupported language #{loc}" unless FormTranslation.languages.member? loc
+      t = self.class_variable_get(:@@_form_translation_locale)
+      @@_form_translation_locale = loc
+      yield
+      @@_form_translation_locale = t
+    end
+
+    def form_translation_locale
+      @@_form_translation_locale ||= nil
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, FormTranslation::SwitchLocale

data/lib/form_translation/custom_form_builder.rb

@@ -0,0 +1,22 @@
+require 'simple_form'
+require 'simple_form/form_builder'
+require 'form_translation/languages_form_builder'
+
+module FormTranslation
+  class CustomFormBuilder < SimpleForm::FormBuilder
+
+    def languagify &block
+      return unless block_given?
+      LanguagesFormBuilder.new(self).render &block
+    end
+  end
+
+  begin
+    require 'nested_form/builder_mixin'
+    class NestedCustomFormBuilder < CustomFormBuilder
+      include ::NestedForm::BuilderMixin
+    end
+  rescue LoadError
+  end
+end
+

data/lib/form_translation/engine.rb

@@ -0,0 +1,10 @@
+module FormTranslation
+  class Engine < ::Rails::Engine
+    initializer 'form_translation' do |app|
+      ActiveSupport.on_load(:action_view) do
+        require 'form_translation/view_helper'
+        ActionView::Base.send(:include, FormTranslation::ViewHelper)
+      end
+    end
+  end
+end

data/lib/form_translation/errors.rb

@@ -0,0 +1,5 @@
+module FormTranslation
+  module Errors
+    class InvalidColumnException < StandardError; end
+  end
+end

data/lib/form_translation/for_model.rb

@@ -0,0 +1,76 @@
+module FormTranslation
+  module ForModel
+    def values_given_for? lng
+      self.class.translated_attrs.each do |a|
+        begin
+          result = send "#{lng}_#{a}"
+        rescue
+          raise FormTranslation::Errors::InvalidColumnException,
+            'You need to specify an existing and valid column to store your translations in.'
+        end
+        return true if result.present?
+      end
+      false
+    end
+
+    def translate! language = I18n.locale
+      unless language == FormTranslation.default_language
+        self.class.translated_attrs.each do |a|
+          send "#{a}=", send("#{language}_#{a}")
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def translate_me *methods
+        store FormTranslation.translation_column
+        methods.each do |m|
+          FormTranslation.foreign_languages.each do |l|
+            store_accessor FormTranslation.translation_column, "#{l}_#{m}".to_sym
+          end
+        end
+
+        self.class.class_exec do
+          define_method :translated_attrs do
+            methods
+          end
+
+          define_method :form_translations do
+            FormTranslation.foreign_languages.collect do |f|
+              methods.collect do |m|
+                "#{f}_#{m}".to_sym
+              end
+            end.flatten
+          end
+        end
+        create_translated_getters(methods)
+      end # translate_me
+
+      def create_translated_getters(methods)
+        mod = Module.new
+        methods.each do |nam|
+          mod.send(:define_method, nam) do
+            return super() unless self.class.form_translation_locale
+            return super() if self.class.form_translation_locale == FormTranslation.default_language
+            a = self.send "#{self.class.form_translation_locale}_#{nam}"
+            a.presence || self[nam]
+          end # define_method
+        end #methods.each
+
+        prepend mod
+      end # create_translated_getters
+
+      def translation_names_for *attributes
+        Array(attributes).flatten.collect do |a|
+          FormTranslation.foreign_languages.collect do |f|
+            "#{f}_#{a}".to_sym
+          end
+        end.flatten
+      end
+    end
+  end
+end

data/lib/form_translation/languages_form_builder.rb

@@ -0,0 +1,73 @@
+module FormTranslation
+  class LanguagesFormBuilder
+
+    attr_accessor :form_builder, :language
+    delegate :object, :template, :find_wrapper, to: :form_builder
+
+    def initialize(form_builder)
+      @form_builder = form_builder
+    end
+
+    def render(&block)
+      rnd = SecureRandom.hex(8)
+      template.content_tag(:div, '') do
+        divs = ''
+        divs += template.content_tag(:ul, class: 'nav nav-tabs') do
+          li_content rnd
+        end
+        divs += template.content_tag(:div, class: 'tab-content') do
+          language_tabs rnd, &block
+        end
+        divs.html_safe
+      end
+    end
+
+
+    def association(*args)
+      raise "not implemented!"
+    end
+
+    def input(attribute_name, options={}, &block)
+      # @language is set and not default.
+      options = @defaults.deep_dup.deep_merge(options) if @defaults
+      input   = form_builder.send(:find_input, attribute_name, options, &block)
+      input.instance_variable_set("@attribute_name", "#{self.language}_#{input.attribute_name}".to_sym)
+
+      chosen =
+        if name = options[:wrapper] || form_builder.send(:find_wrapper_mapping, input.input_type)
+          name.respond_to?(:render) ? name : SimpleForm.wrapper(name)
+        else
+          form_builder.wrapper
+        end
+
+      chosen.render input
+    end
+
+    private
+
+    def li_content rnd
+      FormTranslation.languages.collect do |l|
+        listyle = 'empty_tab' if l != FormTranslation.default_language && !object.values_given_for?(l)
+        listyle = 'active' if l == FormTranslation.default_language
+
+        template.content_tag(:li, class: (listyle || '')) do
+          template.link_to(l, "##{l}_#{rnd}", data: {toggle: 'tab'})
+        end
+      end.join.html_safe
+    end
+
+    def language_tabs rnd
+      FormTranslation.languages.collect do |l|
+        @language = l
+        active = 'active' if l == FormTranslation.default_language
+        template.content_tag(:div, class: "tab-pane #{active}", id: "#{l}_#{rnd}") do
+          if l == FormTranslation.default_language
+            yield form_builder
+          else
+            yield self
+          end
+        end
+      end.join.html_safe
+    end
+  end
+end