localer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165de59d1c94a764cc7dbdec0c2327c2f96c75ef608dd86b4ea627ba2ff071cc
-  data.tar.gz: ba9fc37a955d84b70754bc03e894eb01093f9ca231bd0fce2622bf1fc4b19ead
+  metadata.gz: 7a5f69f56228031b0f043199f8dfc2d87a4068fb07b99d1be4e3b541172fa944
+  data.tar.gz: 0aa61fd219e832a2b594b7c2b05ac4e9694970b7a3ea521fd4376157c1e7e061
 SHA512:
-  metadata.gz: 382f19b3867430029b46eeb76f39d9c6366160f5a325170778c825be4160f067ee276afc0047577655c20415db03c11cfcd99b3342668a7c33a64e8f6039aa1d
-  data.tar.gz: eea447818e4ed693cf08e27b656d4a084a6b266dca554af277817532656fc1b304b830ee4dfb4aca97e450fed82f6c27430c89dba49d46b6ac8c3c2eb0dd5762
+  metadata.gz: 82b9a7c4247292d4bc6e8ffed6071a7121d01a390f7fe054e0ade1837220a9f25e5ff7f2669849364da9ec09d570d1eb9ba881d84471d66a720ad4fd7c5c1cc5
+  data.tar.gz: 5768221a0dd1a4c49df22e2af9ea4fb9acca47f23eefc19d117f679fb4dafef5202d952003a6a050c72acd5c2da83d4e1d0b4b95d8e388bc513ebebb4b93a3e2

data/README.md

@@ -1,10 +1,9 @@
 [![Build Status](https://travis-ci.org/aderyabin/localer.svg?branch=master)](https://travis-ci.org/aderyabin/localer) [![Gem Version](https://badge.fury.io/rb/localer.svg)](https://rubygems.org/gems/localer)
 
 # Localer
-Localer is an automatic detecting missing I18n translations tool.
+Localer is a tool that automatically detects missing I18n translations.
 
-The aim is to preserve the integrity of translations.
-Localer parses and merges keys for all locales in an application. At the next step, it searches missed translations for calculated keys.
+The goal is to preserve the integrity of translations. Localer parses and merges all  application locales’ keys. At the next step, it searches for missing translations among the calculated keys.
 
 <p align="center">
   <img align="center" height="500" src="https://gist.githubusercontent.com/aderyabin/cb0512cbcd6cb4c79a4d84a4831109a5/raw/localer2.png">
@@ -36,13 +35,13 @@ Or install it yourself as:
 ## Usage
 
 At the root directory of a Rails app, run:
-```
-localer check .
-```
+
+    $ localer check .
+
 or for specific Rails path:
-```
-localer check /path/to/rails/application
-```
+
+    $ localer check /path/to/rails/application
+
 ## Support
 
 Localer supports Ruby 2.3+, Rails. 4.1+
@@ -79,6 +78,30 @@ Locale:
       - .countries.france
 ```
 
+## Using Rake
+
+Localer ships with a rake task. To use Localers's rake task you simply need to require the task file and define a task with it. Below is a rake task that will run `localer`:
+
+```ruby
+require 'rubygems'
+require 'localer'
+require 'localer/rake_task'
+
+Localer::RakeTask.new(:localer)
+```
+
+When you now run:
+
+    $ rake -T
+
+you should see
+
+```
+rake localer  # Run Localer
+```
+
+####
+
 ## Development
 
 After checking out the repo, run `bundle exec appraisal install` to install dependencies for each appraisal. Then, run `bundle exec appraisal rake` to run the tests.

data/lib/localer/rake_task.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/tasklib'
+require 'localer'
+
+module Localer
+  # Defines a Rake task for running Localer.
+  # The simplest use of it goes something like:
+  #
+  #   Localer::Rakeask.new
+  # This will define a task named <tt>localer</tt> described as 'Run Localer'.
+  class RakeTask < Rake::TaskLib
+    def initialize(name = :localer, *args)
+      @name = name
+      desc 'Run Localer'
+      task(name, *args) do |_, _task_args|
+        sh('localer check') do |ok, res|
+          exit res.exitstatus unless ok
+        end
+      end
+    end
+  end
+end

data/lib/localer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Localer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrey Deryabin
@@ -167,6 +167,7 @@ files:
 - lib/localer/ext/hash.rb
 - lib/localer/ext/string.rb
 - lib/localer/rails.rb
+- lib/localer/rake_task.rb
 - lib/localer/version.rb
 - localer.gemspec
 homepage: https://github.com/aderyabin/localer