messages_dictionary 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b4ac7e798bed0281aae5e9d5268d5ef6bbbc4c1
-  data.tar.gz: 6b0f0b8d32d49aa64520afceb2fbea2f828c7885
+  metadata.gz: 006a1d75edd683d26bb9ffae6490e2820fc764d0
+  data.tar.gz: 53fac182dd60a6e5ed9fba049e540ab0e8c8546a
 SHA512:
-  metadata.gz: e148950f11fe0156f3d4172e11347dd164fbb6a8864c2c1d546e1930eb0062f3072502e56212580b53f8bcfa7aef7ba614445cbf2f84ff1465538a4fd9cc3d98
-  data.tar.gz: 908d398bcbf553537312123ef035fb5829a4af388089b106bb7a6fb8ddb9747198c491679683e9254d0af662e1974355c392e82121f5f633f52791a863e543b9
+  metadata.gz: 6fc44f71ab01840fbf419cf8b5f98dee6738e482d80454e4c81e43bc7f4740481f7d30bb8d7d0fecd7c0875d165895ddd158eea9ca34537be29c4c029c9bbc48
+  data.tar.gz: 7febb682b3f7b49f18a86b20da043fe1cfa5f7f840f9e5fa9e053d9eb22a47c7619c3dde4fd3eaad827c03a42dfb7f3b864f380d931f4707ad440f404076cf0e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    messages_dictionary (0.0.2)
+    messages_dictionary (0.1.1)
       hashie (~> 3.4)
 
 GEM

data/README.md

@@ -4,22 +4,31 @@
 [![Code Climate](https://codeclimate.com/github/bodrovis-learning/messages_dictionary/badges/gpa.svg)](https://codeclimate.com/github/bodrovis-learning/messages_dictionary)
 [![Dependency Status](https://gemnasium.com/bodrovis-learning/messages_dictionary.svg)](https://gemnasium.com/bodrovis-learning/messages_dictionary)
 
-This gem was created as an educational project for my student. The idea behind this gem is to organize
+This gem started as an educational project for my student. The idea behind this gem is to organize
 various messages in a simple key-value format that can be fetched later. Messages support interpolation,
 can be stored inside files or passed as hashes (nested hashes are supported as well). Custom fetching rules
 can be specified as well.
 
-Some use-cases can be found, for example, in the [Guesser](https://github.com/bodrovis/Guesser) game:
+Install it
+
+    gem install messages_dictionary
+
+and refer to the next sections to see it in action.
+
+## Use Cases
+
+Wanna see it in action? Some use-cases can be found, in the [Guesser](https://github.com/bodrovis/Guesser) game:
 
 * [Messages are stored inside files](https://github.com/bodrovis/Guesser/tree/master/lib/guesser/messages)
 * [Displaying errors](https://github.com/bodrovis/Guesser/blob/master/lib/guesser.rb#L25)
 * [Displaying informational messages](https://github.com/bodrovis/Guesser/blob/master/lib/guesser/game.rb#L29)
 
-Install it
-
-    gem install messages_dictionary
+Another, a bit more complex, use case in the [lessons_indexer gem](https://github.com/bodrovis/lessons_indexer):
 
-and refer to the next section to see it in action.
+* [Messages are stored in a single file](https://github.com/bodrovis/lessons_indexer/blob/master/lib/lessons_indexer/messages/messages.yml)
+* [Messenger class equipped with messages_dictionary magic is defined](https://github.com/bodrovis/lessons_indexer/blob/master/lib/lessons_indexer.rb#L7)
+* [Other classes simply inherit from it](https://github.com/bodrovis/lessons_indexer/blob/master/lib/lessons_indexer/indexer.rb#L2)
+* [Messages are fetched easily](https://github.com/bodrovis/lessons_indexer/blob/master/lib/lessons_indexer/indexer.rb#L45)
 
 ## Usage
 
@@ -71,6 +80,8 @@ class MyOtherClass
 
   def greet
     pretty_output(:welcome)
+    # Or simply
+    pou(:welcome)
   end
 end
 ```
@@ -117,14 +128,14 @@ class MyClass
   has_messages_dictionary
 
   def do_something
-    pretty_output('nested.value') # => 'Nested value'
+    pou('nested.value') # => 'Nested value'
   end
 end
 ```
 
 ### Indifferent Access
 
-Keys can be passed to the `pretty_output` method as symbols or strings - it does not really matter:
+Keys can be passed to the `pou` method as symbols or strings - it does not really matter:
 
 ```ruby
 class MyClass
@@ -133,9 +144,9 @@ class MyClass
 
   def calculate(a)
     result = a ** 2
-    pretty_output(:show_result, result: result)
+    pou(:show_result, result: result)
     # OR
-    pretty_output('show_result', result: result)
+    pou('show_result', result: result)
   end
 end
 ```
@@ -199,7 +210,7 @@ class MyClass
   has_messages_dictionary
 
   def greet
-    pretty_output(:welcome) do |msg|
+    pou(:welcome) do |msg|
       msg.upcase!
     end
   end
@@ -218,7 +229,7 @@ class MyClass
   has_messages_dictionary transform: ->(msg) {msg.upcase!}
 
   def greet
-    pretty_output(:welcome)
+    pou(:welcome)
   end
 end
 
@@ -234,7 +245,7 @@ If you do want to output your message after transformation, you have to do it ex
 
 ```ruby
   def greet
-    pretty_output(:welcome) do |msg|
+    pou(:welcome) do |msg|
       msg.upcase!
       puts msg # => Prints "WELCOME"
     end

data/lib/messages_dictionary/injector.rb

@@ -32,6 +32,7 @@ module MessagesDictionary
             klass::DICTIONARY_CONF[:output].send(klass::DICTIONARY_CONF[:method].to_sym, msg)
       end
       private :pretty_output
+      alias_method :pou, :pretty_output
     end
   end
 end

data/lib/messages_dictionary/version.rb

@@ -1,3 +1,3 @@
 module MessagesDictionary
-  VERSION = '0.0.2'
+  VERSION = '0.1.1'
 end

data/spec/injector_spec.rb

@@ -40,6 +40,17 @@ RSpec.describe MessagesDictionary do
         expect(output).to receive(:custom_puts).with('string')
         object.send(:pretty_output, :test)
       end
+
+      it "aliases pretty_output as pou" do
+        output = double('output')
+        @subject.class_eval do
+          has_messages_dictionary messages: {test: 'string'}, output: output
+        end
+
+        object = @subject.new
+        expect(output).to receive(:puts).with('string')
+        object.send(:pou, :test)
+      end
     end
 
     context "passed as hash" do

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-require "pry"
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messages_dictionary
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Ilya Bodrov