localizable_model 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2cfa395a30db8062f472845636f6fbfe118c7d5
-  data.tar.gz: 8d6e6c2b743b69648ef92990260e18de313c6672
+  metadata.gz: f922dccacb3ed524ee9c233afff9e824b5b08533
+  data.tar.gz: b1dc4c6662be10b0037206349e0ae0e116a31ee2
 SHA512:
-  metadata.gz: bb2536b98ca7556e2fcbdfe26faadfd13b8912fd9e9499f2a4858fa3be2e8f1a289a57aaa59ca0128ca9982a54099017941b8b50d3371c402ed1fc4ea29badb3
-  data.tar.gz: 35a202be39a802512a60f138acbd56a23f74de8d8118a205fbb8aedbdc9ca7d9a518bf8dd91538d9d957a3f99a281db13afe41f209e77e3ca2459251dbae5a56
+  metadata.gz: 6e5c1418be91c5a6bdecc7aaaae5a8e17f645777cce32ae1b8a5faf58b10511dc2f18d3223850540716de6a881c34d753f8393e013a75e4f4ae5cda314aae4a7
+  data.tar.gz: 8b813cb237e9a622802e9576639303d87b1d72c00b3326b25e84d2108d8f8bd615c60820daaf81c18ebbdbcb2babe3b6337a1c76c6ce2a9134cd3fe63532525c

data/README.md

@@ -1,8 +1,10 @@
 # LocalizableModel
 
+LocalizableModel allows any ActiveRecord model to have localized attributes.
+
 [![Build Status](https://travis-ci.org/kord-as/localizable_model.svg?branch=master)](https://travis-ci.org/kord-as/localizable_model) [![Code Climate](https://codeclimate.com/github/kord-as/localizable_model/badges/gpa.svg)](https://codeclimate.com/github/kord-as/localizable_model) [![Test Coverage](https://codeclimate.com/github/kord-as/localizable_model/badges/coverage.svg)](https://codeclimate.com/github/kord-as/localizable_model) [![Dependency Status](https://gemnasium.com/kord-as/localizable_model.svg)](https://gemnasium.com/kord-as/localizable_model)
 
-## Usage
+## Installation
 
 Add the `localizable_model` gem to your Gemfile:
 
@@ -16,6 +18,64 @@ Generate the migration:
 bin/rails g localizable_model:migration
 ```
 
+## Usage
+
+You can now define localizable attributes on your model:
+
+``` ruby
+class Page < ActiveRecord::Base
+  localizable do
+    attribute :name
+    attribute :body
+  end
+end
+```
+
+You can also use a dictionary. This will let you define attributes dynamically
+at runtime.
+
+``` ruby
+class Page < ActiveRecord::Base
+  localizable do
+    dictionary lambda { Page.localizable_attrs }
+  end
+
+  class << self
+    def localizable_attrs
+      [:foo, :bar, :baz]
+    end
+  end
+end
+```
+
+Usage examples:
+
+``` ruby
+page = Page.create(locale: "en", name: "Hello")
+page.name? # => true
+page.name.to_s # => "Hello"
+```
+
+To get a localized version of a page, call `.localize` on it:
+
+``` ruby
+page = Page.first.localize("en")
+```
+
+`.localize` can also take a block argument:
+
+``` ruby
+page.localize("nb") do |p|
+  p.locale # => "nb"
+end
+p.locale # => "en"
+```
+
+Multiple locales can be updated at the same time:
+
+``` ruby
+page.name = { en: "Hello", fr: "Bonjour" }
+```
 
 ## License
 

data/lib/localizable_model/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module LocalizableModel
-  VERSION = "0.0.1".freeze unless LocalizableModel.const_defined?("VERSION")
+  VERSION = "0.5.0".freeze unless LocalizableModel.const_defined?("VERSION")
 end

data/lib/rails/generators/localizable_model/migration/templates/create_localizations.rb

@@ -6,6 +6,9 @@ class CreateLocalizations < ActiveRecord::Migration
       t.string :locale
       t.text :value, limit: 16_777_215
       t.timestamps null: false
+      t.index([:localizable_id, :localizable_type, :name, :locale],
+              name: "index_localizations_on_locale")
+      t.index [:localizable_id, :localizable_type]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localizable_model
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Inge Jørgensen