mongo-i18n 0.0.1

data/LICENSE

@@ -0,0 +1,190 @@
+Copyright 2010 Alexander <alexander@ulizko.com> Ulizko
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.rdoc

@@ -0,0 +1,24 @@
+= Mongo-I18n
+
+MongoDB backend implementation for I18n gem.
+
+== Supports
+
+* Ruby 1.8.7 (Ruby 1.9+ untested but should work).
+* I18n 0.5.0
+* Rails 3.0.3
+
+== Usage with Rails 3
+
+  connection = Mongo::Connection.new['my_app_related_db'].collection('i18n')
+  I18n.backend = I18n::Backend::KeyValue.new(MongoI18n::Store.new(collection))
+
+Or if you already use mongodb in your app, say, via MongoMapper[https://github.com/jnunemaker/mongomapper] I recommend to reuse already existed connection. 
+Like this (assume that MongoMapper version is 0.8.6 and it is already initialized):
+
+  collection = MongoMapper.database.collection('i18n')
+  I18n.backend = I18n::Backend::KeyValue.new(MongoI18n::Store.new(collection))
+
+== License
+
+Mongo-I18n is licensed under Apache license. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+require File.expand_path('../lib/mongo-i18n/version', __FILE__)
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:all) do |t|
+    t.rspec_opts = %w[--color]
+    t.verbose = true
+  end
+end
+
+task :default => :'spec:all'
+
+desc 'Builds the gem'
+task :build do
+  sh "gem build mongo-i18n.gemspec"
+end
+
+desc 'Builds and installs the gem'
+task :install => :build do
+  sh "gem install mongo-i18n-#{MongoI18n::Version}"
+end
+
+desc 'Tags version, pushes to remote, and pushes gem'
+task :release => :build do
+  sh "git tag v#{MongoI18n::Version}"
+  sh "git push origin master"
+  sh "git push origin v#{MongoI18n::Version}"
+  sh "gem push mongo-i18n-#{MongoI18n::Version}.gem"
+end

data/lib/mongo-i18n/store.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+module MongoI18n
+  class Store
+    attr_reader :collection
+
+    def initialize(collection, options={})
+      @collection, @options = collection, options
+    end
+
+    def []=(key, value, options = {})
+      key = key.to_s
+      doc = {:_id => key, :value => value}
+      collection.save(doc)
+    end
+
+    # alias for read
+    def [](key, options=nil)
+      if doc = collection.find_one(:_id => key.to_s)
+        doc["value"].to_s
+      end
+    end
+
+    def keys
+      keys = []
+      collection.find({}, :fields => ["_id"]).each do |row|
+        keys.push(row["_id"])
+      end
+      keys
+    end
+    
+    # Thankfully borrowed from Jodosha's redis-store
+    # https://github.com/jodosha/redis-store/blob/master/lib/i18n/backend/redis.rb
+    def available_locales
+      locales = self.keys.map { |k| k =~ /\./; $` }
+      locales.uniq!
+      locales.compact!
+      locales.map! { |k| k.to_sym }
+      locales
+    end
+  end
+end

data/lib/mongo-i18n/version.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+module MongoI18n
+  Version = '0.0.1'
+end

data/lib/mongo-i18n.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+require 'mongo'
+require 'mongo-i18n/store'
+
+module MongoI18n
+end

data/spec/helper.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'mongo-i18n'
+require 'rspec'
+
+connection = Mongo::Connection.new
+DB = connection.db('mongo-i18n-store-test')

data/spec/mongo-i18n/store_spec.rb

@@ -0,0 +1,95 @@
+require 'helper'
+
+describe MongoI18n::Store do
+  before(:each) do
+    DB.collections.each do |collection|
+      collection.remove
+      collection.drop_indexes
+    end
+  end
+
+  let(:collection)  { DB.collection('mongo_i18n') }
+  let(:store)       { MongoI18n::Store.new(collection) }
+
+  it "has a collection" do
+    store.collection.should == collection
+  end
+
+  describe "write" do
+    before(:each) do
+      store['foo'] = 'bar'
+    end
+    
+    let(:document) { collection.find_one(:_id => 'foo') }
+
+    it "should set _id to key" do
+      document['_id'].should == 'foo'
+    end
+
+    it "should set value key to value" do
+      store['foo'].should == 'bar'
+    end
+
+    it "should always set key as string" do
+      store[:baz] = 'wick'
+      doc = collection.find_one(:_id => 'baz')
+      doc.should_not be_nil
+      doc['_id'].should be_instance_of(String)
+    end
+  end
+
+  describe "read" do
+    before(:each) do
+      store['foo'] = 'bar'
+    end
+    let(:document) { collection.find_one(:_id => 'foo') }
+
+    it "should return nil for key not found" do
+      store['non:existent:key'].should be_nil
+    end
+
+    it "should return value for existing key" do
+      store['foo'] = 'bar'
+      store['foo'].should == 'bar'
+    end
+
+    it "should be able to work with symbol" do
+      store[:foo].should == 'bar'
+    end
+  end
+  
+  describe 'keys' do
+    before(:each) do
+      store['foo'] = 'bar'
+    end
+    
+    it "should return array of existing keys" do
+      store.keys.size.should == 1
+      store.keys.include?('foo').should be_true
+    end
+    
+    it "should return empty array if there is not any records" do
+      collection.remove
+      store.keys.size.should == 0
+    end
+  end
+  
+  describe 'available_locales' do
+    before(:each) do
+      store['en.foo'] = 'bar'
+      store['ru.foo'] = 'russian_bar'
+    end 
+    
+    it "should return proper locales array" do
+      locales = store.available_locales
+      locales.size.should == 2
+      locales.include?(:en).should be_true
+      locales.include?(:ru).should be_true
+    end
+    
+    it "should return empty array if there is now records with proper keys" do
+      collection.remove
+      store.available_locales.size.should == 0
+    end
+  end
+end

data/spec/mongo_i18n_spec.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+describe MongoI18n do
+  it "autoloads Store" do
+    lambda { MongoI18n::Store }.should_not raise_error(NameError)
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: mongo-i18n
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexander Ulizko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-28 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 1
+        - 4
+        version: 1.1.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- alexander@ulizko.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mongo-i18n/store.rb
+- lib/mongo-i18n/version.rb
+- lib/mongo-i18n.rb
+- spec/helper.rb
+- spec/mongo-i18n/store_spec.rb
+- spec/mongo_i18n_spec.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/aulizko/mongo-i18n
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: MongoDB backend implementation for I18n gem.
+test_files: []
+