messages_dictionary 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8553f6876fbb84b53888586d0405beb076319f63
-  data.tar.gz: f2ffe53351402204f081421bc303d606633e5263
+SHA256:
+  metadata.gz: 3a6f7d3a4a63be59119844b7d3139f10b82118a7a726cbfb59f078dc68edb916
+  data.tar.gz: 1884503b8aad4f2c452666833a7a48867c2c0fa55c74854e94ea0a5a6c0bed79
 SHA512:
-  metadata.gz: 4c2cf012d57620c0f2a904743bc9b40b57a509102c0d9b2876561e42cb8f1745cf8a332eca8047b416f7ae10cf0a50d316dd229a063050a6aa27903fde60372e
-  data.tar.gz: 6e7351eb3989b960a5238a496649dd917049dc95f973326a2cfa9635162e88aadb7083609e130c1814fd3c47864156e8fe4052e3d0a3ca18a232cf74fa672552
+  metadata.gz: 2979cbdfacfdfdd47985304f3d6535ce4fe121ca240807e1700a8f9a15aa54e4301e487eeddbcaf9f456f4814f0f51d881e026cdafd65a23ce96d3c539b29057
+  data.tar.gz: eb7c8163836c469604d4fb1af38c84fc9c4d3a450dba73cb429e018a741e55768b0b25fa4f6be2715157e9ec794daf31bd21505db0179f9fe84f23b75cd289d6

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at golosizpru@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/.github/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Don't forget to add specs and make sure they pass by running `rspec .`.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you. Run `rubocop -A` to make it more aggressive.
+6. If necessary, add documentation for your feature or bug fix.
+7. Commit and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
+[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: bodrovis
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Your environment:**
+ - OS
+ - Ruby version
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,13 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: bodrovis
+
+---
+
+**The feature I'd like is...**
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request. Were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. 

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  pull_request:
+
+  push:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby:
+          - 2.7
+          - '3.0'
+          - 3.1
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake rubospec

data/.gitignore

@@ -1,5 +1,13 @@
-# RubyMine config files
-.idea/
+.idea/*
 *.gem
+coverage/*
 Gemfile.lock
-coverage/
+*~
+.bundle
+.rvmrc
+log/*
+measurement/*
+pkg/*
+.DS_Store
+.env
+demo.rb

data/.rubocop.yml

@@ -0,0 +1,46 @@
+require:
+ - rubocop-performance
+ - rubocop-rspec
+ - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/BlockLength:
+  Max: 36
+  Exclude:
+    - spec/**/*.rb
+    - rating-chgk-v2.gemspec
+
+Metrics/BlockNesting:
+  Max: 2
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 10
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    collect:  'map'
+    collect!: 'map!'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+    delete:   'gsub'
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/ExampleLength:
+  Max: 35
+
+RSpec/MessageSpies:
+  EnforcedStyle: have_received

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## 2.1.0 (22-Nov-2022)
+
+* `pou` and `pretty_output` are now available inside class methods
+* `DICTIONARY_CONF` now contains an instance of the `Config` class that takes care of all configuration options
+* Added `lazy` option that enables lazy loading
+* Added `on_key_missing` option which is set to `:raise` by default. You can pass a proc or a lambda to this option in order to provide a custom handler that fires when a given key cannot be found.
+* Added `file_loader` option to handle custom file loading
+
+## 2.0.0 (21-Nov-2022)
+
+This is a major re-write of the gem. All core features stay the same and there should not be any breaking changes, except for one thing: you should not use "destructive" methods when transforming your messages.
+
+Previously you could say:
+
+```ruby
+def greet
+  pou(:welcome) do |msg|
+    puts msg.upcase!
+  end
+end
+```
+
+Now it's recommended to use "safe" `upcase` method:
+
+```ruby
+def greet
+  pou(:welcome) do |msg|
+    puts msg.upcase
+  end
+end
+```

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,46 +1,84 @@
 PATH
   remote: .
   specs:
-    messages_dictionary (1.0.0)
-      hashie (~> 3.4)
+    messages_dictionary (2.1.0)
+      hashie (~> 5.0)
+      zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    codeclimate-test-reporter (1.0.8)
-      simplecov (<= 0.13)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    hashie (3.5.5)
-    json (2.1.0)
-    rake (12.0.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    ast (2.4.2)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    hashie (5.0.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    simplecov (0.13.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
-  ruby
+  x64-mingw-ucrt
+  x86_64-linux
 
 DEPENDENCIES
-  codeclimate-test-reporter (~> 1.0)
+  codecov (~> 0.1)
+  json (~> 2)
   messages_dictionary!
-  rake (~> 12.0)
+  rake (~> 13.0)
   rspec (~> 3.6)
+  rubocop (~> 1.6)
+  rubocop-performance (~> 1.5)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.0)
+  simplecov (~> 0.16)
 
 BUNDLED WITH
-   1.14.6
+   2.3.26

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 Ilya Bodrov
+Copyright 2016 Ilya Krukowski
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,8 +1,9 @@
 # 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)
+![CI](https://github.com/bodrovis-learning/messages_dictionary/actions/workflows/ci.yml/badge.svg)
+[![Test Coverage](https://codecov.io/gh/bodrovis-learning/messages_dictionary/graph/badge.svg)](https://codecov.io/gh/bodrovis-learning/messages_dictionary)
+![Downloads total](https://img.shields.io/gem/dt/messages_dictionary)
 
 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,
@@ -11,11 +12,13 @@ can be specified as well.
 
 [Here is my article](https://www.sitepoint.com/learn-ruby-metaprogramming-for-great-good/) describing how this gem was actually written.
 
-Install it
+This gem requires Ruby 2.7+. Install it by running:
 
-    gem install messages_dictionary
+```
+gem install messages_dictionary
+```
 
-and refer to the next sections to see it in action.
+Refer to the next sections to see it in action.
 
 ## Use Cases
 
@@ -32,9 +35,7 @@ Another, a bit more complex, use case in the [lessons_indexer gem](https://githu
 * [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
-
-### Basic Example
+## Basic usage
 
 Suppose you have the following program:
 
@@ -83,7 +84,7 @@ class MyOtherClass
   def greet
     pretty_output(:welcome)
     # Or simply
-    pou(:welcome)
+    pou :welcome
   end
 end
 ```
@@ -153,9 +154,9 @@ class MyClass
 end
 ```
 
-### Further Customization
+## Further Customization
 
-#### Specifying File Name and Directory
+### Specifying File Name and Directory
 
 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*)
@@ -167,13 +168,29 @@ inside the same directory. However, this behavior can be easily changed with the
 ```ruby
 class MyClass
   include MessagesDictionary
-  has_messages_dictionary file: 'some_file.yml', dir: 'C:\my_docs'
+  has_messages_dictionary file: 'some_file.yml', dir: 'my_docs'
 end
 ```
 
 Both of these options are not mandatory.
 
-#### Specifying Messages Hash
+### Providing a custom file loader
+
+By default the gem a messages file in YAML format. However, you might want to use a different format: for example, JSON. In this case you'll have to provide a custom loader:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary file: 'test_file.json', dir: 'my_dir',
+                          file_loader: ->(file_path) { JSON.parse(File.read(file_path)) }
+end
+```
+
+The `:file_loader` option accepts a proc or a lambda that receives a path to your messages file as an argument. This lambda must return a hash object with keys and the corresponding values.
+
+The default value for the `:file_loader` is `->(f) { YAML.load_file(f) }`.
+
+### Specifying Messages Hash
 
 Instead of loading messages from a file, you can pass hash to the `has_messages_dictionary` using `:messages` option:
 
@@ -186,7 +203,7 @@ end
 
 Nesting and all other features are supported as well.
 
-#### Specifying Output and Display Method
+### Specifying Output and Display Method
 
 By default all messages will be outputted to `STDOUT` using `puts` method, however this can be changed:
 
@@ -201,7 +218,32 @@ class MyClass
 end
 ```
 
-#### Providing Custom Transformation Logic
+### "Lazy" mode
+
+By default this gem will load all messages from the given file. However, you can enable a "lazy" mode so that messages are not loaded until `pou` or `pretty_output` methods have been called. The "lazy" mode can only be enabled when the `:file` option is provided (in other words, `:lazy` has no effect with the `:messages` setting):
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary lazy: true, file: 'my_file.yml'
+
+  def greet
+    pou :hi
+  end
+end
+
+# At this point no messages are loaded from the given file
+
+obj = MyClass.new
+
+# ... doing some other stuff ...
+
+# Messages are still not loaded at this point!
+
+obj.greet # Now all messages will be loaded from the YAML file
+```
+
+### Providing Custom Transformation Logic
 
 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:
@@ -213,8 +255,12 @@ class MyClass
 
   def greet
     pou(:welcome) do |msg|
-      msg.upcase!
+      msg.upcase
     end
+
+    # Or simply:
+
+    pou(:welcome, &:upcase)
   end
 end
 
@@ -228,7 +274,7 @@ option:
 ```ruby
 class MyClass
   include MessagesDictionary
-  has_messages_dictionary transform: ->(msg) {msg.upcase!}
+  has_messages_dictionary transform: ->(msg) {msg.upcase}
 
   def greet
     pou(:welcome)
@@ -248,16 +294,54 @@ it anywhere (for example, when raising a custom error - see use case [here](http
 If you do want to output your message after transformation, you have to do it explicitly:
 
 ```ruby
+def greet
+  pou(:welcome) do |msg|
+    puts msg.upcase # => Prints "WELCOME"
+  end
+end
+```
+
+### Handling missing keys
+
+By default when a non-existent key is requested, an error will be raised:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary messages: {key: 'value'}
+
   def greet
-    pou(:welcome) do |msg|
-      msg.upcase!
-      puts msg # => Prints "WELCOME"
-    end
+    pou :unknown_key # trying to use some unknown key...
   end
+end
+
+obj = MyClass.new
+
+obj.greet # KeyError is raised here!
 ```
 
+However, you can adjust the `:on_key_missing` option and provide a custom proc or lambda to handle all missing keys:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary messages: {key: 'value'},
+                          on_key_missing: ->(key) { key } # We simply return the requested key itself
+
+  def greet
+    pou :unknown_key
+  end
+end
+
+obj = MyClass.new
+
+obj.greet # Prints "unknown_key" to the screen, no errors will be raised
+```
+
+So, in the example above we simply return the key itself if it was not found in the messages hash.
+
 ## License
 
 Licensed under the [MIT License](https://github.com/bodrovis-learning/messages_dictionary/blob/master/LICENSE).
 
-Copyright (c) 2016 [Ilya Bodrov](http://bodrovis.tech)
+Copyright (c) 2022 [Ilya Krukowski](http://bodrovis.tech)

data/Rakefile

@@ -1,6 +1,43 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/clean'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end
+
+CLOBBER.include(FileList['./*.gem'])
+
+namespace :messages_dictionary do
+  desc 'Updates RubyGems, installs dependencies'
+  task :install do
+    puts 'Running bundle install'
+    sh 'gem update --system'
+    sh 'bundle'
+  end
+
+  desc 'Builds the gem'
+  task :build do
+    puts 'Building'
+    sh 'gem build messages_dictionary.gemspec'
+  end
+end
+
+task rubospec: %w[rubocop spec]
+
+task full_build: %w[clobber messages_dictionary:install messages_dictionary:build]
+
+task default: :full_build