messages_dictionary 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8553f6876fbb84b53888586d0405beb076319f63
-  data.tar.gz: f2ffe53351402204f081421bc303d606633e5263
+SHA256:
+  metadata.gz: 270aca02bdc13e851f345d7ce783fbd8329e95f2054c3865fa5b5c1cc2b09c6c
+  data.tar.gz: be5c5615e7c87d7423019fcd96afdf6695ea8527b7c63777c550ca8f6c4fdde7
 SHA512:
-  metadata.gz: 4c2cf012d57620c0f2a904743bc9b40b57a509102c0d9b2876561e42cb8f1745cf8a332eca8047b416f7ae10cf0a50d316dd229a063050a6aa27903fde60372e
-  data.tar.gz: 6e7351eb3989b960a5238a496649dd917049dc95f973326a2cfa9635162e88aadb7083609e130c1814fd3c47864156e8fe4052e3d0a3ca18a232cf74fa672552
+  metadata.gz: 9661d7b64b05ee3d68042938cf05f56b4606107104122e087b39ee86c0b45db79e6ec304e89785d53c1565e7f18a200e542f3ef0cff81acf94afd1cae31aa222
+  data.tar.gz: e401f904c1e3efa0215a0551a33f4dced1a915f7173705232aee7f660c21f04b0f4f6853b2b280a167183d9e8c2960d6287ad0f156f7f54e967f85eba88d2781

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,25 @@
+# Changelog
+
+## 2.0.0
+
+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,83 @@
 PATH
   remote: .
   specs:
-    messages_dictionary (1.0.0)
-      hashie (~> 3.4)
+    messages_dictionary (2.0.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)
   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
 
@@ -213,8 +216,12 @@ class MyClass
 
   def greet
     pou(:welcome) do |msg|
-      msg.upcase!
+      msg.upcase
     end
+
+    # Or simply:
+
+    pou(:welcome, &:upcase)
   end
 end
 
@@ -228,7 +235,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 +255,15 @@ 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|
-      msg.upcase!
-      puts msg # => Prints "WELCOME"
-    end
+def greet
+  pou(:welcome) do |msg|
+    puts msg.upcase # => Prints "WELCOME"
   end
+end
 ```
 
 ## 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

data/lib/messages_dictionary/injector.rb

@@ -1,38 +1,83 @@
+# frozen_string_literal: true
+
 module MessagesDictionary
-  def self.included(klass)
-    klass.class_exec do
-      define_singleton_method :has_messages_dictionary do |opts = {}|
-        if opts[:messages]
-          messages = Dict.new(opts[:messages])
-        else
-          file = opts[:file] || "#{SpecialString.new(klass.name).snake_case}.yml"
-          file = File.expand_path(file, opts[:dir]) if opts[:dir]
-          begin
-            messages = Dict.new(YAML.load_file(file))
-          rescue Errno::ENOENT
-            abort "File #{file} does not exist..."
-          end
+  # Main module that injects all the necessary methods in the target class
+  module Injector
+    using MessagesDictionary::Utils::StringUtils
+
+    def self.included(klass)
+      klass.extend ClassMethods
+      klass.include InstanceMethods
+    end
+
+    # Class methods to be defined in the target (where the module was included)
+    module ClassMethods
+      # rubocop:disable Naming/PredicateName
+      # This is the main method that equips the target class
+      # with all the necesary goodies
+      def has_messages_dictionary(opts = {})
+        # rubocop:enable Naming/PredicateName
+        messages = MessagesDictionary::Utils::Dict.new(
+          opts.fetch(:messages) { __from_file(opts) }
+        )
+
+        const_set(:DICTIONARY_CONF, {msgs: messages,
+                                     output: opts[:output] || $stdout,
+                                     method: opts[:method] || :puts,
+                                     transform: opts[:transform]})
+      end
+
+      private
+
+      def __from_file(opts)
+        file = opts[:file] || "#{name.nil? ? 'unknown' : name.snakecase}.yml"
+        file = File.expand_path(file, opts[:dir]) if opts[:dir]
+
+        begin
+          YAML.load_file(file)
+        rescue Errno::ENOENT
+          abort "File #{file} does not exist..."
         end
-        klass.const_set(:DICTIONARY_CONF, {msgs: messages.extend(Hashie::Extensions::DeepFetch),
-                                           output: opts[:output] || STDOUT,
-                                           method: opts[:method] || :puts,
-                                           transform: opts[:transform]})
       end
+    end
 
-      define_method :pretty_output do |key, values = {}, &block|
-        msg = klass::DICTIONARY_CONF[:msgs].deep_fetch(*key.to_s.split('.')) do
+    # Instance methods to be defined in the target class
+    module InstanceMethods
+      # This method will output your messages, perform interpolation,
+      # and transformations
+      def pretty_output(key, values = {}, &block)
+        msg = self.class::DICTIONARY_CONF[:msgs].deep_fetch(*key.to_s.split('.')) do
           raise KeyError, "#{key} cannot be found in the provided file..."
         end
+
+        __process(
+          __replace(msg, values),
+          &block
+        )
+      end
+
+      private :pretty_output
+      alias pou pretty_output
+
+      private
+
+      def __replace(msg, values)
         values.each do |k, v|
-          msg.gsub!(Regexp.new('\{\{' + k.to_s + '\}\}'), v.to_s)
+          msg.gsub!(Regexp.new("\\{\\{#{k}\\}\\}"), v.to_s)
+        end
+
+        msg
+      end
+
+      def __process(msg, &block)
+        transform = block || self.class::DICTIONARY_CONF[:transform]
+
+        if transform
+          transform.call(msg)
+        else
+          self.class::DICTIONARY_CONF[:output].send(self.class::DICTIONARY_CONF[:method].to_sym, msg)
         end
-        transform = block || klass::DICTIONARY_CONF[:transform]
-        transform ?
-            transform.call(msg) :
-            klass::DICTIONARY_CONF[:output].send(klass::DICTIONARY_CONF[:method].to_sym, msg)
       end
-      private :pretty_output
-      alias_method :pou, :pretty_output
     end
   end
-end
+end

data/lib/messages_dictionary/utils/dict.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module MessagesDictionary
-  class Dict < Hash
-    include Hashie::Extensions::MergeInitializer
-    include Hashie::Extensions::IndifferentAccess
+  module Utils
+    class Dict < Hash
+      include Hashie::Extensions::MergeInitializer
+      include Hashie::Extensions::IndifferentAccess
+      include Hashie::Extensions::DeepFetch
+    end
   end
-end
+end

data/lib/messages_dictionary/utils/string_utils.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MessagesDictionary
+  module Utils
+    # Utility methods for strings
+    module StringUtils
+      refine String do
+        # Underscore a string such that camelcase, dashes and spaces are
+        # replaced by underscores.
+        def snakecase
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+            gsub(/([a-z\d])([A-Z])/, '\1_\2').
+            tr('-', '_').
+            gsub(/\s/, '_').
+            gsub(/__+/, '_').
+            downcase
+        end
+      end
+    end
+  end
+end

data/lib/messages_dictionary/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MessagesDictionary
-  VERSION = '1.0.0'
-end
+  VERSION = '2.0.0'
+end