multilang-hstore 1.0.0.rc1 → 1.0.0.rc2

data/.gitignore

@@ -0,0 +1,15 @@
+*~
+*#
+.#*
+.DS_Store
+nbproject/*
+.idea/*
+*.erb~
+*.rb~
+*.yml~
+*.html~
+rdoc/*
+
+
+
+

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'pg', '>= 0.0.1'
+gem 'activerecord', '>= 4.0.0'
+
+group :test, :development do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.9)
+    builder (3.1.4)
+    diff-lcs (1.1.3)
+    i18n (0.6.4)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    pg (0.14.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 4.0.0)
+  pg (>= 0.0.1)
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Arthur Meinart
+Copyright (c) 2012-2013 Heapsource.com
+
+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,134 @@
+# Multilang-hstore
+
+Multilang is a small translation library for translating database values for Rails 3 using the [Hstore datatype](http://www.postgresql.org/docs/9.0/static/hstore.html).
+
+This project is a fork of [artworklv/multilang](https://github.com/artworklv/multilang) with some remarkable differences:
+
+* Replaced YAML text fields in favor of Hstore fields.
+* The translation hash is no longer limited to locales in `I18n.available_locales`.
+
+It uses [engageis/activerecord-postgres-hstore](https://github.com/engageis/activerecord-postgres-hstore)
+
+## Installation
+
+You need configure the multilang gem inside your gemfile:
+
+    gem 'multilang-hstore'
+
+Do not forget to run
+
+    bundle install
+
+## Basic Usage
+
+This is a walkthrough with all steps you need to setup multilang translated attributes, including model and migration.
+
+We're assuming here you want a Post model with some multilang attributes, as outlined below:
+
+    class Post < ActiveRecord::Base
+      multilang :title, :accessible => true
+    end
+
+or
+
+    class Post < ActiveRecord::Base
+      multilang :title, :description, :required => true, :length => 100, :accessible => true
+    end
+
+The multilang translations are stored in the same model attributes (eg. title):
+
+You may need to create migration for Post as usual, but multilang attributes should be in hstore type:
+  
+    create_table(:posts) do |t|
+      t.hstore :title
+      t.timestamps
+    end
+
+Thats it!
+
+Now you are able to translate values for the attributes :title and :description per locale:
+
+    I18n.locale = :en
+    post.title = 'Multilang rocks!'
+    I18n.locale = :lv
+    post.title = 'Multilang rulle!'
+
+    I18n.locale = :en
+    post.title #=> Multilang rocks!
+    I18n.locale = :lv
+    post.title #=> Multilang rulle!
+
+
+You may assign attributes through auto generated methods (this methods depend from I18n.available_locales):
+
+    I18n.available_locales #=> [:en. :lv]
+
+    post.title_en = 'Multilang rocks!'
+    post.title_lv = 'Multilang rulle!'
+
+    post.title_en #=>  'Multilang rocks!'
+    post.title_lv #=>  'Multilang rulle!'
+
+You may use mass assignment on model creation (if :accessible param is defined):
+
+    Post.new(:title => {:en => 'Multilang rocks!', :lv => 'Multilang rulle!'})
+
+or
+
+    Post.new(:title_en => 'Multilang rocks!', :title_lv => 'Multilang rulle!')
+
+Also, you may ise same hashes with setters:
+
+    post.title = {:en => 'Multilang rocks!', :lv => 'Multilang rulle!'} 
+
+## Attribute methods
+
+You may get other translations via attribute translation method:
+
+    post.title.translation[:lv] #=> 'Multilang rocks!'
+    post.title.translation[:en] #=> 'Multilang rulle!'
+  post.title.translation.locales #=> [:en, :lv]
+
+If you have incomplete translations, you can get translation from other locale:
+
+    post.title = {:en => 'Multilang rocks!', :lv => ''}
+    I18n.locale = :lv
+    post.title.any #=> 'Multilang rocks!'
+
+The value from "any" method returns value for I18n.current_locale or, if value is empty, it searches through all locales. It takes searching order from I18n.available_locales array.
+
+## Validations
+Multilang has some validation features:
+
+    multilang :title, :length => 100  #define maximal length validator
+    multilang :title, :required => true #define requirement validator 
+    multilang :title, :format => /regexp/ #define validates_format_of validator
+
+## Tests
+
+Test runs using a temporary database in your local PostgreSQL server:
+
+Create a test database:
+
+    $ createdb multilang-hstore-test
+
+Create the [hstore extension](http://www.postgresql.org/docs/9.1/static/sql-createextension.html):
+
+    psql -d multilang-hstore-test -c "CREATE EXTENSION IF NOT EXISTS hstore"
+
+Create the role *postgres* if necessary:
+
+    $ createuser -s -r postgres 
+
+Finally, you can run your tests:
+  
+    rspec
+
+## Bugs and Feedback
+
+Use [http://github.com/heapsource/multilang-hstore/issues](http://github.com/heapsource/multilang-hstore/issues)
+
+## License(MIT)
+
+* Copyright (c) 2012-2013 Heapsource.com
+* Copyright (c) 2010 Arthur Meinart

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = ["-c"]
+end
+
+desc 'Generate documentation for the multilang plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Multilang'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/multilang-hstore/exceptions.rb

@@ -0,0 +1,5 @@
+module Multilang
+  module Exceptions
+    class DeprecationError < StandardError; end
+  end
+end

data/lib/multilang-hstore/version.rb

@@ -1,3 +1,3 @@
 module Multilang
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end

data/multilang-hstore.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "multilang-hstore/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{multilang-hstore}
+  s.version = Multilang::VERSION
+
+  s.authors = ["Arthur Meinart", "Heapsource"]
+  s.date = %q{2013-07-25}
+  s.description = %q{Model translations for Rails 3 backed by PostgreSQL and Hstore}
+  s.email = %q{hello@heapsource.com}
+  s.files = `git ls-files`.split($/)
+  s.homepage = %q{http://github.com/heapsource/multilang-hstore}
+  s.require_paths = ["lib"]
+  s.summary = %q{Model translations for Rails 3 backed by PostgreSQL and Hstore}
+  s.test_files = [
+    "spec/multilang_spec.rb",
+    "spec/schema.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.add_dependency 'pg', '>= 0.0.1'
+  s.add_dependency 'activerecord', '>= 4.0.0'
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multilang-hstore
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -50,11 +50,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
 - lib/multilang-hstore.rb
 - lib/multilang-hstore/active_record_extensions.rb
+- lib/multilang-hstore/exceptions.rb
 - lib/multilang-hstore/translation_keeper.rb
 - lib/multilang-hstore/translation_proxy.rb
 - lib/multilang-hstore/version.rb
+- multilang-hstore.gemspec
 - spec/multilang_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb