rails_admin_globalize_field 0.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f25ef423bdedceaeefca32547f96d98ab86a37
-  data.tar.gz: 98a810b823e43070961a4dc85e246e5de6199634
+  metadata.gz: 0d82bc91b1dd15c273b5ad94992e73fe84727ac7
+  data.tar.gz: d6a33c0602ec69e2e834968680ae506b228019f2
 SHA512:
-  metadata.gz: 054d7f5706d372d4e60e00476a1863626d8b2300370368ea72b06c5115548469c4d4e5fb69a9b7fc4c2d1d2cabec8eb6171297ab6b9f1db248bb2d3bc1f1f862
-  data.tar.gz: d78d0a1a2e4bcf564ee2db90d46354fdaa1dd53409d1c6028ee2e84183b70aaa937b33a8a27c673eb09f3185560991d64f9e237c8928f2de1c3e0ef0eba7fe68
+  metadata.gz: 96c391c828ef19e44b1c865e3fc0899d406e14f388631f5a4f60a8c11b344b1b0284b92d3881983f13835e93d68b2670e0ba64149d62f45dc340f6dc0289d18c
+  data.tar.gz: 0f7c9aa056831121efff474a6988226089be4e89ebc811f3f720f4511f7c961ea7c90da9b8888aa38c4ba35569e3b0771cf28fa950433f9896126a4da0c7a6dd

data/README.md

@@ -1,34 +1,25 @@
 # RailsAdminGlobalizeField
 
-  RailsAdminGlobalizeField adds tabbed interface to [rails_admin](https://github.com/sferik/rails_admin) for multilingual models (using [globalize3](https://github.com/svenfuchs/globalize3) gem)
+  RailsAdminGlobalizeField adds tabbed interface to [rails_admin](https://github.com/sferik/rails_admin) for multilingual models (using [globalize](https://github.com/globalize/globalize) gem)
 
-  It creates custom field type for globalize3 translations that you can use on any translations asssociation to translated models.
+  It adds custom field type that you can use for globalize translations association.
+
+  This gem uses Translation models generated by globalize, so you don't need to add any additional model to your app (as some older globalize3 gists suggested).
 
-  This gem uses Translation models generated by globalize3, so you don't need to add any additional models to your project (as some older globalize3 gists suggested).
 
 ## Installation
 
-> rails-4.0 compatible only for now!
+Add and configure globalize gem first.
 
-Add and configure globalize3 gem first. **You need to use rails4 branch.**
 ``` ruby
-  gem 'paper_trail', github: 'airblade/paper_trail'
-  gem 'globalize3', github: 'svenfuchs/globalize3', branch: 'rails4'
+  gem 'globalize', '~> 4.0'
 ```
 
-
-Add this line to your application's Gemfile:
+Then add this gem and run `bundle`
 ``` ruby
-    gem 'rails_admin_globalize_field'
+  gem 'rails_admin_globalize_field'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rails_admin_globalize_field
 
 ## Usage
 
@@ -37,35 +28,54 @@ Add **translation** models to `config.included_models` in `initializers/rails_ad
   config.included_models = ['Model','Model::Translation']
 ```
 
-Add `accepts_nested_attributes_for` for translations to your **translated** model
+Add `accepts_nested_attributes_for` for translations to your **translated** model.
+
 ``` ruby
   class Model < ActiveRecord::Base
     translates :title, :desc
-    accepts_nested_attributes_for :translations, :allow_destroy => true
+    accepts_nested_attributes_for :translations, allow_destroy: true
   end
 ```
 
-Add configuration to associated **translation** model:
+Add configuration to your **translated** model and associated **translation** model. `:locale` field is always required.
 ``` ruby
+  config.model 'Post' do
+    configure :translations, :globalize_tabs
+  end
+
   config.model 'Model::Translation' do
     visible false
-    configure :locale, :hidden
+    configure :locale, :hidden do
+      help ''
+    end
     include_fields :locale, :title, :desc
   end
 ```
-`:locale` field is always required.
 
 
-Add additional stylesheet in app/assets/stylesheets/rails_admin/theming.scss:
-``` ruby
+Add this stylesheet into app/assets/stylesheets/rails_admin/theming.scss:
+``` css
   /*
    *= require rails_admin/ra.globalize_tabs
   */
 ```
 
+
+If you need to add validation to the translation class, you can add it on `translation_class` inside **translated** model:
+```ruby
+  translation_class.validates :title, presence: true
+```
+
+
+## Known issues
+
+If you need to use `null: false` options on any column in translations table, you'll have to use [this globalize fork](https://github.com/scarfacedeb/globalize/tree/before_callbacks) for now.
+See: https://github.com/globalize/globalize/issues/325
+
+
 ## Screenshot
 
-![Screenshot](screenshots/screenshots/shot1.png)
+![Screenshot](https://raw.github.com/scarfaceDeb/rails_admin_globalize_field/screenshots/screenshots/shot1.png)
 
 ## Contributing
 

data/app/assets/stylesheets/rails_admin/ra.globalize_tabs.scss

@@ -1,14 +1,17 @@
+
+// scope all selectors (it's awful, but it's safer)
 .globalize_tabs_type {
-  & > .help-block {
-    margin-left: 180px;
-    padding-top: 5px;
-    border-top: 1px solid #ddd;
-  }
-  & > .controls > .help-inline {
+
+  // Generic adjustments
+
+  .globalize-errors {
     float: right;
     margin-left: 15px;
+    line-height: 36px; // tabs height
+  }
+  .globalize-help {
+    margin-top: 10px;
+    margin-left: 180px; // == .form-horizontal .controls indent
   }
-}
-body.rails_admin .form-horizontal.denser .globalize_tabs_type > .help-block {
-  margin-top: 10px;
+
 }

data/app/views/rails_admin/main/_form_globalize_tabs.html.haml

@@ -1,11 +1,16 @@
+- field.translations(true) # fetch translations and memoize them
+
 .controls
-  = form.errors_for(field)
+  .globalize-errors
+    = form.errors_for(field)
   %ul.nav.nav-tabs{ :style => 'margin-top:5px' }
     - field.available_locales.each do |locale|
       %li{ class: ( 'active' if locale == field.current_locale ) }
         %a{ href: "##{locale}", data: { toggle: "tab" } }= locale
 .tab-content
-  = form.fields_for field.name, field.translations, wrapper: false do |nested_form|
-    .fields.tab-pane{ id: nested_form.object.locale, class: ( 'active' if nested_form.object.locale == field.current_locale ) }
-      = nested_form.generate({:action => :nested, :model_config => field.associated_model_config, :nested_in => field.name })
-= form.help_for(field)
+  - field.available_locales.each do |locale|
+    = form.fields_for field.name, field.translations[locale], wrapper: false do |nested_form|
+      .fields.tab-pane{ id: locale, class: ( 'active' if locale == field.current_locale ) }
+        = nested_form.generate({:action => :nested, :model_config => field.associated_model_config, :nested_in => field.name })
+.globalize-help
+  = form.help_for(field)

data/lib/rails_admin_globalize_field.rb

@@ -1,8 +1,4 @@
 require "rails_admin_globalize_field/engine"
-
-module RailsAdminGlobalizeField
-end
-
 require 'rails_admin/config/fields/association'
 
 module RailsAdmin
@@ -12,6 +8,12 @@ module RailsAdmin
         class GlobalizeTabs < RailsAdmin::Config::Fields::Association
           RailsAdmin::Config::Fields::Types::register(:globalize_tabs, self)
 
+          # A workaround for https://github.com/sferik/rails_admin/pull/1726
+          def initialize(parent, name, properties)
+            properties = parent.abstract_model.associations.detect { |p| name == p[:name] }
+            super
+          end
+
           register_instance_option :partial do
             :form_globalize_tabs
           end
@@ -20,6 +22,10 @@ module RailsAdmin
             "#{super}_attributes".to_sym
           end
 
+          def generic_help
+            "" # false is ignored by I18n.translate
+          end
+
           # Reader for validation errors of the bound object
           def errors
             bindings[:object].errors[name]
@@ -32,14 +38,20 @@ module RailsAdmin
             I18n.locale
           end
 
-          # Returns array of Translation objects
-          # It gets existing or creates new empty translation for every locale
-          # It's used in fields_for method in partial
-          def translations
-            translated_locales = @bindings[:object].translated_locales
-            available_locales.collect do |locale|
-              translated_locales.include?(locale) ? @bindings[:object].translation_for(locale) : @bindings[:object].translations.new({ locale: locale })
+          # Returns array of Translation objects.
+          # It gets existing or creates new empty translation for every locale.
+          # Call the first time with reset_cache == true to update memoized translations.
+          def translations reset_cache=false
+            return @translations if @translations && !reset_cache
+
+            translations = @bindings[:object].translations_by_locale
+            new_locales = available_locales - translations.keys.map(&:to_sym)
+
+            new_locales.map do |locale|
+              translations[locale] = @bindings[:object].translations.new({ locale: locale })
             end
+
+            @translations = translations
           end
         end
       end
@@ -48,13 +60,11 @@ module RailsAdmin
 end
 
 
-# TODO: apply it only on `configure :translations, :globalize_tabs` fields?
-# see: https://github.com/sferik/rails_admin/pull/1726
-RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
-  if properties[:name] == :translations
-    fields << RailsAdmin::Config::Fields::Types::GlobalizeTabs.new(parent, properties[:name], properties)
-    true
-  else
-    false
-  end
-end
+# RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
+#   if properties[:name] == :translations
+#     fields << RailsAdmin::Config::Fields::Types::GlobalizeTabs.new(parent, properties[:name], properties)
+#     true
+#   else
+#     false
+#   end
+# end

data/lib/rails_admin_globalize_field/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminGlobalizeField
-  VERSION = "0.2"
+  VERSION = "0.3.0"
 end

data/rails_admin_globalize_field.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = RailsAdminGlobalizeField::VERSION
   spec.authors       = ["Andrew Volozhanin"]
   spec.email         = ["linuxheadrus@gmail.com"]
-  spec.description   = %q{Adds tabbed interface and custom field type for globalize3 translations to Rails_admin}
-  spec.summary       = %q{Tabbed interface and custom field type for globalize3 translations for Rails_admin}
+  spec.description   = %q{Adds tabbed interface and custom field type for globalize translations to Rails_admin}
+  spec.summary       = %q{Tabbed interface and custom field type for globalize translations for Rails_admin}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rails_admin', '>= 0.5'
 
   # TODO: uncomment later, when globalize3 rails4 branch would be commited to rubygems
-  #spec.add_runtime_dependency 'globalize3', '>= 0.3'
+  spec.add_runtime_dependency 'globalize', '>= 4.0'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,72 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_globalize_field
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Volozhanin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rails_admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: globalize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Adds tabbed interface and custom field type for globalize3 translations
+description: Adds tabbed interface and custom field type for globalize translations
   to Rails_admin
 email:
 - linuxheadrus@gmail.com
@@ -74,7 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,18 +110,18 @@ 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.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Tabbed interface and custom field type for globalize3 translations for Rails_admin
+summary: Tabbed interface and custom field type for globalize translations for Rails_admin
 test_files: []