countrizable 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '039886e40e62d429443e1ade142f7ed8a6b5b3e83a12b7a7fca4fa109b5b3aff'
-  data.tar.gz: 51e4c3986a33eef57b917eceaa7fd6fb882ffcaabd66ff796fa2e33e72fd48bc
+  metadata.gz: b287c8afcc3d89e7f91103d41201f55a19a34ab15716964725655ce2e3d365e9
+  data.tar.gz: 891078d325870c2cffefab2acb7a4dcef8e914ce250c286a95615ffb72d0d7ce
 SHA512:
-  metadata.gz: d76198119c24f64c9c77b27bd0c45d77c224001f2c443b8ffacc1e8913406fbb09ae72b4c115c28ba46e98fa04f320389b3f8b1b735fd8c14d90ed083fb7eba1
-  data.tar.gz: 0ffc9b2df18f3d71f878f2ddde6eaea2f4c0d65a33aeb67dd5965ca4a704b8bdba8866be1bf997f63eb864a035bd05d74b5d54c53893b841fb1424f3583af110
+  metadata.gz: 417b5795c7316d93a180248288769ccbdf938268d6c23cb51d79146b1f7865bad61940cffb75055447d8eb53651038917f1d86d2c5053875b96c34c80ea26d78
+  data.tar.gz: dc8663b7b6d86f8c27e879c4a4a23badc2efefa3df11c4cc993d0d2cd4cc049765f7c1b4f8d836d8c9e4171cdf35e8b510923ab5d035e933bbe91cb561b26791

data/README.md

@@ -1,28 +1,98 @@
 # Countrizable
-Short description and motivation.
+Countrizable is a gem to use on top of ruby on rails to add model contents depending on country.
+Inspired in [![Globalize]](https://github.com/globalize/globalize)
 
-## Usage
-How to use my plugin.
+## Requirements
+
+* ActiveRecord >= 4.2.0 (see below for installation with ActiveRecord 3.x)
+* I18n
 
 ## Installation
-Add this line to your application's Gemfile:
+
+To install the ActiveRecord 4.2.x compatible version of Globalize with its default setup, just use:
+
+```ruby
+gem install countrizable
+```
+
+When using bundler put this in your Gemfile:
 
 ```ruby
 gem 'countrizable'
 ```
 
-And then execute:
-```bash
-$ bundle
+## Model country attributes
+
+Model translations allow you to translate your models' attribute values. E.g.
+
+```ruby
+class Product < ActiveRecord::Base
+  country_attribure :price
+  country_attribure :currency
+end
 ```
 
-Or install it yourself as:
-```bash
-$ gem install countrizable
+Allows you to translate the attributes :title and :text per locale:
+
+```ruby
+Countrizable.country_code = :uk
+product.price # =>  3.00
+product.currency # => Pound
+
+Countrizable.country_code = :de
+product.price # =>  3.60
+product.currency # => Euro
 ```
 
-## Contributing
-Contribution directions go here.
+You can also set translations with mass-assignment by specifying the locale:
+
+```ruby
+product.attributes = { price: 4.5, country_code: :uk }
+```
+
+In order to make this work, you'll need to add the appropriate country attribute tables.
+Countrizable comes with a handy helper method to help you do this.
+It's called `create_country_value_table!`. Here's an example:
+
+Note that your migrations can use `create_country_value_table!` and `drop_country_value_table!`
+only inside the `up` and `down` instance methods, respectively. You cannot use `create_country_value_table!`
+and `drop_country_value_table!` inside the `change` instance method.
+
+### Creating country value tables
+
+Also note that before you can create a translation table, you have to define the translated attributes via `country_attribute` in your model as shown above.
+
+```ruby
+class CreateProducts < ActiveRecord::Migration
+  def change
+    create_table :products do |t|
+      t.timestamps
+    end
+    
+    #creating country value tables
+    reversible do |dir|
+      dir.up do
+        Post.create_country_value_table!({
+          :price => :decimal, default: 0, :precision => 8, :scale => 2,
+          :currency => :string
+        })
+      end
+
+      dir.down do
+        Post.drop_country_value_table!
+      end
+    end
+
+    #compatible with globalize gem
+    reversible do |dir|
+      dir.up do
+        Post.create_translation_table! :title => :string, :text => :text
+      end
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+      dir.down do
+        Post.drop_translation_table!
+      end
+    end
+  end
+end
+```

data/lib/countrizable/active_record/migration.rb

@@ -7,7 +7,7 @@ module Countrizable
         @countrizable_migrator ||= Migrator.new(self)
       end
 
-      delegate :create_country_values_table!, :add_country_value_fields!,
+      delegate :create_country_value_table!, :add_country_value_fields!,
         :drop_country_value_table!, :country_value_index_name,
         :country_value_country_code_index_name, :to => :countrizable_migrator
 

data/lib/countrizable/version.rb

@@ -1,3 +1,3 @@
 module Countrizable
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: countrizable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Iván Guillén
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord