messages_dictionary 0.0.1.rc2 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9c2443ad99393ac68dd66fd8311f93a22e6c990
-  data.tar.gz: 62ed879f27e7be5be35ce595b7e8d87498937fa0
+  metadata.gz: 36034266259848faccc844f5b655b8afae375e05
+  data.tar.gz: 9585e85d023b9531ba57f43c59931da54ffefc4f
 SHA512:
-  metadata.gz: 482c06deceb1b6db8d5b21752400417dfa1f8c7ea6ae9f9eefa0d8d6349d133c01aa1dd16b28964800d5b4871b133c96109e1fed6823f1b11ff97e4d551a524e
-  data.tar.gz: 02a34c68b32170ba8172a089066273389f7690b84a06e379fadeab4d292a12234f8ab339df89e3cc2afbe529c8a3f0bdc1e111098549a700de1a8d2e3a170e29
+  metadata.gz: cfa579275d388efe14516ea0374459dc152ada66803e2b37165f301d13c0ef939ba58cba9c4f8c0733f5d593836579395283a58d5b5a809b611134ee8c1be04a
+  data.tar.gz: a3abcb0af2d095b7a8a938c445aab3d64db900ea31b004d99ff02f63da2009ebd28db6f26dc96632b1fba98e2ec06bac4eed1e781e0fea5cfef7db6348c81a1b

data/.rspec

@@ -0,0 +1 @@
+--color --format doc --order rand --require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+  - rbx
+
+install: bundle install --retry=3

data/Gemfile

@@ -1,3 +1,3 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,20 +1,55 @@
 PATH
   remote: .
   specs:
-    messages_dictionary (0.0.1.rc2)
+    messages_dictionary (0.0.1)
       hashie (~> 3.4)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
     hashie (3.4.3)
+    json (1.8.3)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
 
 PLATFORMS
   ruby
   x86-mingw32
 
 DEPENDENCIES
+  codeclimate-test-reporter (~> 0.5)
   messages_dictionary!
+  pry
+  rake (~> 11.1)
+  rspec (~> 3.4)
 
 BUNDLED WITH
    1.11.2

data/README.md

@@ -1,11 +1,25 @@
 # MessagesDictionary
+[![Gem Version](https://badge.fury.io/rb/messages_dictionary.svg)](https://badge.fury.io/rb/messages_dictionary)
+[![Build Status](https://travis-ci.org/bodrovis-learning/messages_dictionary.svg?branch=master)](https://travis-ci.org/bodrovis-learning/messages_dictionary)
+[![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
 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.
 
-Refer to the next section to see it in action.
+Some use-cases can be found, for example, 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
+
+and refer to the next section to see it in action.
 
 ## Usage
 
@@ -32,9 +46,11 @@ class MyOtherClass
 end
 ```
 
-With `messages_dictionary` you can transform it into
+These messages are scattered all over the program and can be hard to maintain. With `messages_dictionary` you can transform it into
 
 ```ruby
+require 'messages_dictionary' # For brevity this line will be omitted in other examples
+
 class MyClass
   include MessagesDictionary
   has_messages_dictionary
@@ -74,14 +90,62 @@ show_values: "The first value is {{a}}, the second is {{b}}"
 welcome: "Welcome!"
 ```
 
+**Please note**, that if your class is named `MyModule::MyClass`, then by default the program will search
+for a file named `my_class.yml` inside `my_module` directory. This can be further customized, refer
+the "Further Customization" section for more info.
+
 So by saying `pretty_output(:show_result, result: result)` you are fetching a message under the key
 `show_result` and replace the `{{result}}` part with the value of the `result` variable. Simple, eh?
 
+### Nesting
+
+MessagesDictionary supports nesting (similar to localization files in Rails):
+
+*my_class.yml*
+
+```yaml
+show_result: "The result is {{result}}"
+nested:
+  value: 'Nested value'
+```
+
+Nested messages can be easily accessed with dot notation:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary
+
+  def do_something
+    pretty_output('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:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary
+
+  def calculate(a)
+    result = a ** 2
+    pretty_output(:show_result, result: result)
+    # OR
+    pretty_output('show_result', result: result)
+  end
+end
+```
+
 ### Further Customization
 
 #### Specifying File Name and Directory
 
-By default `messages_dictionary` will search for a *.yml* file named after your class (converted snake case)
+By default `messages_dictionary` will search for a *.yml* file named after your class (converted to snake case,
+so for the `MyClass` the file should be named *my_class.yml*)
 inside the same directory. However, this behavior can be easily changed with the following options:
 
 * `:file` (`string`) - specifies the file name to load messages from (extension has to be provided).
@@ -94,9 +158,24 @@ class MyClass
 end
 ```
 
+Both of these options are not mandatory.
+
+#### Specifying Messages Hash
+
+Instead of loading messages from a file, you can pass hash to the `has_messages_dictionary` using `:messages` option:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary messages: {key: 'value'}
+end
+```
+
+Nesting and all other features are supported as well.
+
 #### Specifying Output and Display Method
 
-By default all messages will be outputted to `STDOUT` using `puts` method, however this can be changed as well:
+By default all messages will be outputted to `STDOUT` using `puts` method, however this can be changed:
 
 * `:output` (`object`) - specify your own output. The object you provide has to implement `puts` method
 or any other method you provide for the `:method` option.
@@ -111,7 +190,7 @@ end
 
 #### Providing Custom Transformation Logic
 
-Suppose you want to transform your message somehow or even return it instead of printing on the screen.
+Suppose you want to transform your message somehow or even simply return it instead of printing on the screen.
 `pretty_output` method accepts an optional block for this purpose:
 
 ```ruby
@@ -147,6 +226,21 @@ my_object = MyClass.new
 my_object.greet # Will return "WELCOME", nothing will be put on the screen
 ```
 
+**Please note** that by default MessagesDictionary **does not output anything** when you provide transformation
+block. This is done to allow more control, because sometimes you may want to fetch a message, but not output
+it anywhere (for example, when raising a custom error - see use case [here](https://github.com/bodrovis/Guesser/blob/master/lib/guesser.rb#L25)).
+
+If you do want to output your message after transformation, you have to do it explicitly:
+
+```ruby
+  def greet
+    pretty_output(:welcome) do |msg|
+      msg.upcase!
+      puts msg # => Prints "WELCOME"
+    end
+  end
+```
+
 ## License
 
 Licensed under the [MIT License](https://github.com/bodrovis-learning/messages_dictionary/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/messages_dictionary/injector.rb

@@ -26,13 +26,11 @@ module MessagesDictionary
         values.each do |k, v|
           msg.gsub!(Regexp.new('\{\{' + k.to_s + '\}\}'), v.to_s)
         end
-
         transform = klass::DICTIONARY_CONF[:transform] || block
         transform ?
             transform.call(msg) :
             klass::DICTIONARY_CONF[:output].send(klass::DICTIONARY_CONF[:method].to_sym, msg)
       end
-
       private :pretty_output
     end
   end

data/lib/messages_dictionary/version.rb

@@ -1,3 +1,3 @@
 module MessagesDictionary
-  VERSION = '0.0.1.rc2'
+  VERSION = '0.0.1'
 end

data/messages_dictionary.gemspec

@@ -17,4 +17,9 @@ Gem::Specification.new do |spec|
   spec.require_paths    = ["lib"]
 
   spec.add_dependency 'hashie', '~> 3.4'
+
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.5"
 end

data/spec/injector_spec.rb

@@ -0,0 +1,125 @@
+RSpec.describe MessagesDictionary do
+  before :all do
+    @subject = SpecAddons::TestClass
+    @subject.class_eval do
+      include MessagesDictionary
+    end
+  end
+
+  before :each do
+    @subject.class_eval do
+      remove_const(:DICTIONARY_CONF) if const_defined?(:DICTIONARY_CONF)
+    end
+  end
+
+  context "messages" do
+    context "outputting" do
+      it "uses STDOUT by default" do
+        @subject.class_eval do
+          has_messages_dictionary messages: {test: 'string'}
+        end
+
+        expect(@subject::DICTIONARY_CONF[:output]).to eq(STDOUT)
+      end
+
+      it "uses puts method by default" do
+        @subject.class_eval do
+          has_messages_dictionary messages: {test: 'string'}
+        end
+
+        expect(@subject::DICTIONARY_CONF[:method]).to eq(:puts)
+      end
+
+      it "allows customizing output and method" do
+        output = double('output')
+        @subject.class_eval do
+          has_messages_dictionary messages: {test: 'string'}, output: output, method: :custom_puts
+        end
+
+        object = @subject.new
+        expect(output).to receive(:custom_puts).with('string')
+        object.send(:pretty_output, :test)
+      end
+    end
+
+    context "passed as hash" do
+      it "supports nesting" do
+        @subject.class_eval do
+          has_messages_dictionary messages: {parent: {child: 'child_string'} }
+        end
+
+        object = @subject.new
+        expect( object.send(:pretty_output, 'parent.child') {|msg| msg} ).to eq('child_string')
+      end
+    end
+
+    context "passed in file" do
+      it "searches file named after class name by default" do
+        setup_env!('spec_addons', 'test_class.yml')
+
+        @subject.class_eval do
+          has_messages_dictionary
+        end
+
+        object = @subject.new
+        expect( object.send(:pretty_output, :test) {|msg| msg} ).to eq('string')
+        clear_env!('spec_addons')
+      end
+
+      it "allows passing path and file" do
+        setup_env!('my_test_dir', 'my_test_file.yml')
+
+        @subject.class_eval do
+          has_messages_dictionary file: 'my_test_file.yml', dir: 'my_test_dir'
+        end
+
+        object = @subject.new
+        expect( object.send(:pretty_output, :test) {|msg| msg} ).to eq('string')
+        clear_env!('my_test_dir')
+      end
+    end
+  end
+
+  context "error" do
+    it "is raised when key is not found" do
+      @subject.class_eval do
+        has_messages_dictionary messages: {test: 'string'}
+      end
+
+      object = @subject.new
+      expect( -> {object.send(:pretty_output, :does_not_exist)} ).to raise_error(KeyError)
+    end
+
+    it "is raised when file is not found and the program aborts" do
+      err = capture_stderr do
+        expect(-> {
+          @subject.class_eval do
+            has_messages_dictionary dir: 'random', file: 'not_exist.yml'
+          end
+        }).to raise_error(SystemExit)
+      end.strip
+      expect(err).to eq("File #{File.expand_path('random/not_exist.yml')} does not exist...")
+    end
+  end
+
+  context "transformations" do
+    it "applies per-method transformations" do
+      @subject.class_eval do
+        has_messages_dictionary messages: {test: 'string'}
+      end
+
+      object = @subject.new
+      expect( object.send(:pretty_output, :test) {|msg| msg.upcase!} ).to eq('STRING')
+    end
+
+    it "applies per-class transformations" do
+      @subject.class_eval do
+        has_messages_dictionary messages: {test: 'string'},
+                                transform: ->(msg) {msg.upcase!}
+      end
+
+      object = @subject.new
+      expect( object.send(:pretty_output, :test) ).to eq('STRING')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "pry"
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+require 'messages_dictionary'
+
+RSpec.configure do |config|
+  config.include SpecAddons
+  config.include SpecFilesSetup
+  config.include SpecUtils
+end

data/spec/support/spec_files_setup.rb

@@ -0,0 +1,14 @@
+require 'fileutils'
+
+module SpecFilesSetup
+  def setup_env!(path, file)
+    FileUtils.mkdir_p(path)
+    f = File.new("#{path}/#{file}", 'w+')
+    f.write('test: string')
+    f.close
+  end
+
+  def clear_env!(path)
+    FileUtils.remove_entry(path)
+  end
+end

data/spec/support/spec_utils.rb

@@ -0,0 +1,23 @@
+module SpecUtils
+  def capture_stderr(&block)
+    original_stderr = $stderr
+    $stderr = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stderr = original_stderr
+    end
+    fake.string
+  end
+
+  def capture_stdout(&block)
+    original_stdout = $stdout
+    $stdout = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stdout = original_stdout
+    end
+    fake.string
+  end
+end

data/spec/support/test_class.rb

@@ -0,0 +1,4 @@
+module SpecAddons
+  class TestClass
+  end
+end

data/spec/utils/dict_spec.rb

@@ -0,0 +1,8 @@
+RSpec.describe MessagesDictionary::Dict do
+  subject { described_class.new key: 'value' }
+
+  it "allows indifferent access" do
+    expect(subject[:key]).to eq('value')
+    expect(subject['key']).to eq('value')
+  end
+end

data/spec/utils/snake_case_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe MessagesDictionary::SpecialString do
+  subject { described_class.new('MyTestString') }
+
+  specify "#snake_case" do
+    expect(subject.snake_case).to eq('my_test_string')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: messages_dictionary
 version: !ruby/object:Gem::Version
-  version: 0.0.1.rc2
+  version: 0.0.1
 platform: ruby
 authors:
 - Ilya Bodrov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -25,6 +25,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: This gem allows you to store messages in a simple-key value format and
   fetch whenever you need. Classes can have different messages and apply different
   fetching logic. Messages also support interpolation.
@@ -36,16 +92,26 @@ extra_rdoc_files:
 - README.md
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - lib/messages_dictionary.rb
 - lib/messages_dictionary/injector.rb
 - lib/messages_dictionary/utils/dict.rb
 - lib/messages_dictionary/utils/snake_case.rb
 - lib/messages_dictionary/version.rb
 - messages_dictionary.gemspec
+- spec/injector_spec.rb
+- spec/spec_helper.rb
+- spec/support/spec_files_setup.rb
+- spec/support/spec_utils.rb
+- spec/support/test_class.rb
+- spec/utils/dict_spec.rb
+- spec/utils/snake_case_spec.rb
 homepage: https://github.com/bodrovis-learning/messages_dictionary
 licenses:
 - MIT
@@ -61,13 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Store your messages anywhere and fetch them anytime.
 test_files: []
+has_rdoc: