activeadmin-translate 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# ActiveAdmin Translate Changelog
+
+## 0.1.0 - November 15, 2012
+
+- Initial version

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+Contribute to ActiveAdmin Translate
+===================================
+
+File an issue
+-------------
+
+You can report bugs and feature requests to [GitHub Issues](https://github.com/netzpirat/activeadmin-globalize/issues).
+
+**Please don't ask question in the issue tracker**, instead ask them at Stackoverflow and use the
+[activeadmin](http://stackoverflow.com/questions/tagged/activeadmin) tag.
+
+When you file a bug, please try to follow these simple rules if applicable:
+
+* Make sure you've read the README carefully.
+* Give as much information about your environment, like Ruby and ActiveAdmin version.
+* Make sure that the issue is reproducible with your description.
+
+**It's most likely that your bug gets resolved faster if you provide as much information as possible!**
+
+Development
+-----------
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/netzpirat/activeadmin-globalize/master/frames).
+* Source hosted at [GitHub](https://github.com/netzpirat/activeadmin-globalize).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the [README](https://github.com/netzpirat/haml_coffee_assets/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/netzpirat/haml_coffee_assets/blob/master/CHANGELOG.md) for noteworthy changes.
+* Please **do not change** the version number.

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dmitrii Soltis, Michael Kessler
+
+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,178 @@
+# ActiveAdmin Translate
+
+Translate your [Globalize3](https://github.com/svenfuchs/globalize3) ActiveModel translations in
+[ActiveAdmin](https://github.com/gregbell/active_admin), using [jQueryUI tabs](http://jqueryui.com/tabs/) to switch
+between the locales.
+
+## Installation
+
+Add the gem to your `Gemfile`
+
+```ruby
+gem 'activeadmin-translate`
+```
+
+and install it with Bundler:
+
+```Bash
+$ bundle
+```
+
+## Configuration
+
+### Set available languages
+
+ActiveAdmin Translate takes the available languages from `I18n.available_locales`, so you want to configure them in
+your `application.rb` like
+
+```ruby
+config.i18n.available_locales = [:en, :de, :fr, :it]
+```
+
+### Include ActiveAdmin Translate
+
+You need to include the ActiveAdmin JavaScript by adding it to your manifest in
+`app/assets/javascripts/active_admin.js`:
+
+```javascript
+//= require active_admin/translate
+```
+
+Then you also need to import the SASS customizations in `app/assets/stylesheets/active_admin.css.scss`:
+
+```css
+@import "active_admin/translate";
+```
+
+## Usage
+
+### Make your translations accessible
+
+In order to access the translations of your model and be able to write them on save, you need to make attributes
+accessible in your model. Globalize3 stores the model translations in a separate table that is accessible as
+`translations` in your model:
+
+```ruby
+class GlobalizedModel < ActiveRecord::Base
+  attr_accessible :translations, :translations_attributes
+  accepts_nested_attributes_for :translations
+end
+```
+
+### Translate your ActiveAdmin forms
+
+To translate your form you need to use the `translate_inputs` form helper:
+
+```ruby
+form do |f|
+  f.translate_inputs do |t|
+    t.input :title
+    t.input :description
+  end
+end
+```
+
+### Translate your ActiveAdmin show action
+
+To show the attributes for all locales, you use the `translate_attributes_table_for` view helper:
+
+```ruby
+show do |model|
+  panel 'Globalized Model' do
+    translate_attributes_table_for model do
+      row :title
+      row :description do |p|
+        BlueCloth.new(p.teaser).to_html.html_safe
+      end
+    end
+  end
+end
+```
+
+### Localize the languages
+
+To localize your locale names, use the following I18n key structure per locale:
+
+```yml
+en:
+  active_admin:
+    translate:
+      en: "English"
+```
+
+and add more translations with the registered locale symbol.
+
+## Author
+
+Developed by Michael Kessler, [mksoft.ch](https://mksoft.ch).
+
+If you like ActiveAdmin Translate, you can watch the repository at
+[GitHub](https://github.com/netzpirat/activeadmin-globalize) and follow [@netzpirat](https://twitter.com/#!/netzpirat)
+on Twitter for project updates.
+
+## Contribute to ActiveAdmin Translate
+
+### File an issue
+
+You can report bugs and feature requests to [GitHub Issues](https://github.com/netzpirat/activeadmin-globalize/issues).
+
+**Please don't ask question in the issue tracker**, instead ask them at Stackoverflow and use the
+[activeadmin](http://stackoverflow.com/questions/tagged/activeadmin) tag.
+
+When you file a bug, please try to follow these simple rules if applicable:
+
+* Make sure you've read the README carefully.
+* Give as much information about your environment, like Ruby and ActiveAdmin version.
+* Make sure that the issue is reproducible with your description.
+
+**It's most likely that your bug gets resolved faster if you provide as much information as possible!**
+
+### Development
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/netzpirat/activeadmin-globalize/master/frames).
+* Source hosted at [GitHub](https://github.com/netzpirat/activeadmin-globalize).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the [README](https://github.com/netzpirat/activeadmin-globalize/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/netzpirat/activeadmin-globalize/blob/master/CHANGELOG.md) for noteworthy changes.
+* Please **do not change** the version number.
+
+## Contributors
+
+See the [CHANGELOG](https://github.com/netzpirat/activeadmin-globalize/blob/master/CHANGELOG.md) and the GitHub list of
+[contributors](https://github.com/netzpirat/activeadmin-globalize/contributors).
+
+## Acknowledgment
+
+This project has taken some ideas and code from the following projects:
+
+- [activeadmin-globalize3](https://github.com/stefanoverna/activeadmin-globalize3) from [Stefano Verna](https://github.com/stefanoverna)
+- [ActiveAdmin-Globalize3-inputs](https://github.com/mimimi/ActiveAdmin-Globalize3-inputs) from [Dmitrii Soltis](https://github.com/mimimi)
+
+## License
+
+Copyright (c) 2012 Dmitrii Soltis, Michael Kessler
+
+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/app/assets/javascripts/active_admin/translate.js

@@ -0,0 +1,3 @@
+$(function() {
+  $('.activeadmin-translate').tabs()
+});

data/app/assets/stylesheets/active_admin/translate.css.scss

@@ -0,0 +1,81 @@
+.active_admin {
+
+  .activeadmin-translate .locales {
+    overflow: auto;
+    margin-right: 10px;
+
+    li {
+      @include section-header;
+
+      border-top-left-radius: 10px;
+      border-top-right-radius: 10px;
+
+      float: right !important;
+
+      &.ui-state-active {
+        background: white;
+      }
+    }
+  }
+
+  .has_many_fields .activeadmin-translate .locales {
+    padding-top: 10px !important;
+  }
+
+  .activeadmin-translate .locale {
+    clear: left;
+  }
+
+  .activeadmin-translate .ui-tabs-hide {
+    display: none !important;
+  }
+
+  .ui-tabs {
+    position: relative;
+    padding: .2em;
+    zoom: 1;
+  }
+
+  .ui-tabs .ui-tabs-nav {
+    margin: 0;
+    padding: .2em .2em 0;
+  }
+
+  .ui-tabs .ui-tabs-nav li {
+    list-style: none;
+    float: left;
+    position: relative;
+    top: 0;
+    margin: 1px .2em 0 0;
+    border-bottom: 0;
+    padding: 0;
+    white-space: nowrap;
+  }
+
+  .ui-tabs .ui-tabs-nav li a {
+    float: left;
+    padding: .5em 1em;
+    text-decoration: none;
+  }
+
+  .ui-tabs .ui-tabs-nav li.ui-tabs-active {
+    margin-bottom: -1px;
+    padding-bottom: 1px;
+  }
+
+  .ui-tabs .ui-tabs-nav li.ui-tabs-active a, .ui-tabs .ui-tabs-nav li.ui-state-disabled a, .ui-tabs .ui-tabs-nav li.ui-tabs-loading a {
+    cursor: text;
+  }
+
+  .ui-tabs .ui-tabs-nav li a, .ui-tabs-collapsible .ui-tabs-nav li.ui-tabs-active a {
+    cursor: pointer;
+  }
+
+  .ui-tabs .ui-tabs-panel {
+    display: block;
+    border-width: 0;
+    padding: 1em 1.4em;
+    background: none;
+  }
+
+}

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  active_admin:
+    translate:
+      en: "English"

data/lib/active_admin/translate/engine.rb

@@ -0,0 +1,14 @@
+module ActiveAdmin
+  module Translate
+
+    # ActiveAdmin Translate engine to provide the needed assets.
+    #
+    class Engine < ::Rails::Engine
+
+      initializer 'ActiveAdmin Translate precompile' do |app|
+        app.config.assets.precompile += %w(active_admin/translate.css active_admin/translate.js)
+      end
+
+    end
+  end
+end

data/lib/active_admin/translate/form_builder.rb

@@ -0,0 +1,71 @@
+module ActiveAdmin
+  module Translate
+
+    # Form builder to build input fields that are arranged by locale in tabs.
+    #
+    module FormBuilder
+
+      # Create the local field sets to enter the inputs per locale
+      #
+      # @param [Symbol] name the name of the translation association
+      # @param [Proc] block the block for the additional inputs
+      #
+      def translate_inputs(name = :translations, &block)
+        form_buffers.last << template.content_tag(:div, :class => "activeadmin-translate #{ translate_id }") do
+          locale_tabs << locale_fields(name, block)
+        end
+      end
+
+      protected
+
+      # Create the local field sets to enter the inputs per locale.
+      #
+      # @param [Symbol] name the name of the translation association
+      # @param [Proc] block the block for the additional inputs
+      #
+      def locale_fields(name, block)
+        ::I18n.available_locales.map do |locale|
+          translation = object.method(name).call.find_or_initialize_by_locale(locale)
+          translation.instance_variable_set(:@errors, object.errors) if locale == I18n.default_locale
+
+          fields = proc do |form|
+            form.input(:locale, :as => :hidden)
+            block.call(form)
+          end
+
+          inputs_for_nested_attributes(:for => [name, translation], :id => field_id(locale), :class => "inputs locale locale-#{ locale }", &fields)
+        end.join.html_safe
+      end
+
+
+      # Create the locale tab to switch the translations.
+      #
+      # @return [String] the HTML for the locale tabs
+      #
+      def locale_tabs
+        template.content_tag(:ul, :class => 'locales') do
+          ::I18n.available_locales.map do |locale|
+            template.content_tag(:li) do
+              template.content_tag(:a, ::I18n.t("active_admin.translate.#{ locale }"), :href => "##{ field_id(locale) }")
+            end
+          end.join.html_safe
+        end
+      end
+
+      # Get the unique id for the translation field
+      #
+      def field_id(locale)
+        "locale-#{ locale }-#{ translate_id }"
+      end
+
+      # Get the unique id for the translation
+      #
+      # @return [String] the id
+      #
+      def translate_id
+        "#{ self.object.class.to_s.underscore.dasherize }-#{ self.object.object_id }"
+      end
+
+    end
+  end
+end

data/lib/active_admin/translate/version.rb

@@ -0,0 +1,6 @@
+module ActiveAdmin
+  module Translate
+    # The current released version
+    VERSION = '0.0.1'
+  end
+end

data/lib/active_admin/views/translate_attributes_table.rb

@@ -0,0 +1,41 @@
+module ActiveAdmin
+  module Translate
+
+    # Adds a builder method `translate_attributes_table_for` to build a
+    # table with translations for a model that has been localized with
+    # Globalize3.
+    #
+    class TranslateAttributesTable < ::ActiveAdmin::Views::AttributesTable
+
+      builder_method :translate_attributes_table_for
+
+      def row(attr, &block)
+        ::I18n.available_locales.each_with_index do |locale, index|
+          @table << tr do
+            if index == 0
+              th :rowspan => ::I18n.available_locales.length do
+                header_content_for(attr)
+              end
+            end
+            td do
+              ::I18n.with_locale locale do
+                content_for(block || attr)
+              end
+            end
+          end
+        end
+      end
+
+      protected
+
+      def default_id_for_prefix
+        'attributes_table'
+      end
+
+      def default_class_name
+        'attributes_table'
+      end
+
+    end
+  end
+end

data/lib/activeadmin-translate.rb

@@ -0,0 +1,9 @@
+require 'active_admin'
+require 'globalize3'
+
+require 'active_admin/version'
+require 'active_admin/translate/engine'
+require 'active_admin/translate/form_builder'
+require 'active_admin/views/translate_attributes_table'
+
+ActiveAdmin::FormBuilder.send(:include, ::ActiveAdmin::Translate::FormBuilder)

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin-translate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Kessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: globalize3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Translate your models in ActiveAdmin with Globalize3.
+email:
+- michi@netzpiraten.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/active_admin/translate.js
+- app/assets/stylesheets/active_admin/translate.css.scss
+- lib/active_admin/translate/engine.rb
+- lib/active_admin/translate/form_builder.rb
+- lib/active_admin/translate/version.rb
+- lib/active_admin/views/translate_attributes_table.rb
+- lib/activeadmin-translate.rb
+- config/locales/en.yml
+- LICENSE
+- README.md
+- CHANGELOG.md
+- CONTRIBUTING.md
+homepage: https://github.com/netzpirat/activeadmin-translate
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Translate models with ActiveAdmin.
+test_files: []
+has_rdoc: