virtus-localized 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c94bc7cbbc1d0ef5f77e2fbc9dbb8cf625f57159
-  data.tar.gz: d7545c61768606335cc656556becb22a53a757d9
+  metadata.gz: 299fc7e7428bc14c45bc23a528540be2049a624f
+  data.tar.gz: eb43371c5408514c52e9dfd764e33367ea222468
 SHA512:
-  metadata.gz: 3388c4512efb4e19703ded5a30119a88111c0952bd68201d6f7d748b6c0f3bbdb7f6050d98dbed0f88b6d7faa0e8b1f3987e8dd8b41624c00eb78b0403594fcf
-  data.tar.gz: 4e9c0923a3d17905baa396eff43db65149786e44173e1fd2a143b95b76cb9931e0cf8267e0d300fbc3f25852ec6ae682057afc3b318c42ade5fa973114443482
+  metadata.gz: 49b183a67d0c95b759a7aedb4c83ad0bb8c3ecc9bc91e1ff37ab95d01e3845a17c8ac82b713bd32e7f043d18ebb8eb519ac42895b3b5ce3023a7ae7f57bd904e
+  data.tar.gz: 0b9a371b3c15e7978bbba76821c94b3555dcbfd6b5b138b8f7be25d82dfaab67568a9c9fc02ed80cd54d6056c31c7d1805f7c2f7904ac22e50ec996ca42f9311

data/README.md

@@ -1,8 +1,8 @@
 # Virtus::Localized
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/virtus/localized`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status][travis-image]][travis-url]
 
-TODO: Delete this and the text above, and describe your gem
+Virtus::Localized is an extension for [virtus][travis-url] that adds the `localized` feature. It's based on the `localized` feature of [MongoID][mongoID-url] and was requested via this [issue][issue-url]
 
 ## Installation
 
@@ -22,13 +22,53 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You need to require it first:
 
-## Development
+```ruby
+  require 'virtus/localized'
+```
+
+Then it gives you the following flag when definig the `attribute`:
+
+```ruby
+  class Post
+    include Virtus.model
+
+    attribute :title, String, localized: true
+    attribute :body, String, localized: true
+  end
+
+```
+
+It uses the [i18n](https://github.com/svenfuchs/i18n) to detect the `locale` and creates an internal hash for the attribute:
+
+```ruby
+  post = Post.new(title: 'Hello', body: 'English')
+
+  p post.title
+  # => 'Hello'
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+  p post.body
+  # => 'English'
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  I18n.locale = :es
+
+  post.title = 'Hola'
+  post.body = 'Español'
+
+  p post.title
+  # => 'Hola'
+
+  p post.body
+  # => 'Español'
+
+  p post.instance_variable_get('@title')
+  # { "en" => "Hello", "es" => "Hola" }
+
+  p post.instance_variable_get('@body')
+  # { "en" => "English", "es" => "Español" }
+
+```
 
 ## Contributing
 
@@ -37,3 +77,14 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+
+[MIT](LICENSE)
+
+[travis-image]: https://travis-ci.org/XescuGC/virtus-localized.svg?branch=maste
+[travis-url]: https://travis-ci.org/XescuGC/virtus-localized
+[virtus-url]: https://github.com/solnic/virtus
+[mongoID-url]: https://travis-ci.org/XescuGC/virtus-localized
+[issue-url]: https://travis-ci.org/XescuGC/virtus-localized
+

data/lib/virtus/localized/version.rb

@@ -1,5 +1,5 @@
 module Virtus
   module Localized
-    VERSION = "0.1.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virtus-localized
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - xescuGC