translator_with_localeapp 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 787b142325f9c37a78279d612dcbf9c2907869da
-  data.tar.gz: c02c9a17a1da150c276c8e8443d8fdb523d65cf2
+  metadata.gz: 125c26c160ea1d1f7b8442bc822580d19e3a50b1
+  data.tar.gz: 0488e7568c19cfe839b34cce0996770e4807d0c7
 SHA512:
-  metadata.gz: 50f25f941e07140ebe6b68c4acbe3e3d0d0fe8e2a689f1ea54e95df83c162a42a63bc2faa2cd9e66b461e40455bd1997c84e55e98d1dabb6542fc396280c8c84
-  data.tar.gz: eb32d162808540c111d63453d6b5dab8fee822bfd62fa532c530f24f3837a0ff687f562e5e5241739b594e6d747c4ec1f985c30fc3facf8c920f77f6862790c7
+  metadata.gz: 061145c7ee07caded3a7f430f6e2ab1282d8a7bfab117a6d1ecf1063a7c9bf78e85d59732906d145850a4813015827ba9fb2e20669f725f1b46f9ce3131de320
+  data.tar.gz: 15fa0dc7bc88a19d08d057f742665c49ef5784a09807957fe615faf4f70dc0760b9798709e4a1e0f739aa92957ff07cd1a955909c92509a342314f62ea21d187

data/README.md

@@ -1,2 +1,114 @@
 Translator
 -------
+
+It is an utility through which you can synchronize your locales with [Localapp](https://www.localeapp.com).
+
+Installation
+-------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'translator_with_localeapp', '~> 1.0.1'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install translator_with_localeapp
+```
+
+
+Usage
+-------
+With _Redis_:
+
+```ruby
+require 'redis'
+require 'translator'
+
+
+Translator.setup do |config|
+  # ==> Storage Configurations
+  # config.storage = :Redis
+  # config.storage_options = { host: 'localhost', port: 6379, db: 1 }
+
+  # ==> Output Configuration
+  # By default there is no logging, you can set it to any output
+  # stream which respond to `puts`.
+  # config.output_stream = nil
+
+  # ==> Localeapp Configuration
+  config.localeapp_api_key = ENV['LOCALEAPP_API_KEY']
+  # It is the directory where localeapp will sync all the locales files.
+  config.data_directory = Rails.root.join('config', 'locales')
+end
+
+file_paths = <paths of yml files>
+Translator.load!(file_paths)
+
+```
+
+## Storage
+
+Uses [moneta](https://github.com/minad/moneta) gem to wrap various Key/Value stores
+Docs for moneta can be found [here](http://www.rubydoc.info/gems/moneta/frames)
+
+Parameters:
+- `name` (Symbol) — Name of adapter (See [Moneta::Adapters](http://www.rubydoc.info/gems/moneta/Moneta/Adapters))
+- `options` (Hash) (defaults to: {})
+
+Options Hash (options):
+- `:expires` (Boolean/Integer) — Ensure that store supports expiration by inserting Expires if the underlying adapter doesn't support it natively and set default expiration time
+- `:threadsafe` (Boolean) — default: false — Ensure that the store is thread safe by inserting Moneta::Lock
+- `:logger` (Boolean/Hash) — default: false — Add logger to proxy stack (Hash is passed to logger as options)
+- `:compress` (Boolean/Symbol) — default: false — If true, compress value with zlib, or specify custom compress, e.g. :quicklz
+- `:serializer` (Symbol) — default: :marshal — Serializer used for key and value, disable with nil
+- `:key_serializer` (Symbol) — default: options[:serializer] — Serializer used for key, disable with nil
+- `:value_serializer` (Symbol) — default: options[:serializer] — Serializer used for value, disable with nil
+- `:prefix` (String) — Key prefix used for namespacing (default none)
+
+### Redis
+
+See [redis-db](https://github.com/redis/redis-rb) for options
+
+#### Install Redis
+
+`brew install redis`(Mac)
+
+OR
+
+`sudo apt-get install redis`(Ubuntu)
+
+#### Start Redis
+
+`redis-server`
+
+Testing
+-------
+
+Ensure Redis server is installed and started.
+
+```shell
+$ bundle install
+$ bundle exec rspec spec
+```
+
+
+Contributing
+-------
+
+```
+1. Fork it ( https://github.com/kuldeepaggarwal/translator/fork ).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Add test cases and verify all tests are green.
+4. Commit your changes (`git commit -am 'Add some feature'`).
+5. Push to the branch (`git push origin my-new-feature`).
+6. Create new Pull Request.
+```

data/lib/translator/store.rb

@@ -12,7 +12,9 @@ module Translator
       @options = options # can be removed
       @storage = Moneta.new(type, options)
     end
-    def_delegators :@storage, :key?, :clear
+    def_delegators :@storage, :key?, :clear, :adapter
+    def_delegators :adapter, :backend
+    def_delegators :backend, :keys
 
     def write(key, value)
       @storage[key] = value

data/lib/translator/version.rb

@@ -1,5 +1,5 @@
 module Translator
   module Version
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.0.2'.freeze
   end
 end

data/spec/translator/store_spec.rb

@@ -57,4 +57,14 @@ describe Translator::Store do
       expect(store[:pa]).to eq(first_name: 'ਕੁਲਦੀਪ')
     end
   end
+
+  describe 'Delegations' do
+    it 'responds to key?, clear, adapter, backend, keys' do
+      expect(store).to respond_to(:key?)
+      expect(store).to respond_to(:clear)
+      expect(store).to respond_to(:adapter)
+      expect(store).to respond_to(:keys)
+      expect(store).to respond_to(:backend)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translator_with_localeapp
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Kuldeep Aggarwal