messages_dictionary 1.0.0 → 2.0.0

data/lib/messages_dictionary.rb

@@ -1,10 +1,26 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'hashie'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
-require_relative 'messages_dictionary/utils/snake_case'
-require_relative 'messages_dictionary/utils/dict'
-require_relative 'messages_dictionary/injector'
+# Store your messages anywhere and fetch them anytime.
+# For example:
+#
+#   class MyClass
+#     include MessagesDictionary
+#     has_messages_dictionary
 
+#     def calculate(a)
+#       result = a ** 2
+#       pretty_output(:show_result, result: result)
+#     end
+#   end
 module MessagesDictionary
+  def self.included(klass)
+    klass.include MessagesDictionary::Injector
+  end
 end
-

data/messages_dictionary.gemspec

@@ -1,24 +1,35 @@
-require File.expand_path("../lib/messages_dictionary/version", __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/messages_dictionary/version', __dir__)
 
 Gem::Specification.new do |spec|
-  spec.name             = "messages_dictionary"
+  spec.name             = 'messages_dictionary'
   spec.version          = MessagesDictionary::VERSION
-  spec.authors          = ["Ilya Bodrov", "anilika"]
-  spec.email            = ["golosizpru@gmail.com"]
-  spec.summary          = %q{Store your messages anywhere and fetch them anytime.}
-  spec.description      = %q{This gem allows you to store some text in a simple-key value format and fetch it whenever you need from your methods. Various classes may have different messages attached and apply different fetching logic. Messages also support interpolation and can be stored in separate YAML files.}
-  spec.homepage         = "https://github.com/bodrovis-learning/messages_dictionary"
-  spec.license          = "MIT"
+  spec.authors          = ['Ilya Krukowski', 'anilika']
+  spec.email            = ['golosizpru@gmail.com']
+  spec.summary          = 'Store your messages anywhere and fetch them anytime.'
+  spec.description      = 'This gem allows you to store some text in a simple-key value format and fetch ' \
+                          'it whenever you need from your methods. Various classes may have different ' \
+                          'messages attached and apply different fetching logic. Messages also support ' \
+                          'interpolation and can be stored in separate YAML files.'
+  spec.homepage         = 'https://github.com/bodrovis-learning/messages_dictionary'
+  spec.license          = 'MIT'
   spec.platform         = Gem::Platform::RUBY
-
+  spec.required_ruby_version = '>= 2.7.0'
   spec.files            = `git ls-files`.split("\n")
-  spec.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.extra_rdoc_files = ["README.md"]
-  spec.require_paths    = ["lib"]
+  spec.extra_rdoc_files = ['README.md']
+  spec.require_paths    = ['lib']
 
-  spec.add_dependency 'hashie', '~> 3.4'
+  spec.add_dependency 'hashie', '~> 5.0'
+  spec.add_dependency 'zeitwerk', '~> 2.4'
 
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
-end
+  spec.add_development_dependency 'codecov', '~> 0.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop',             '~> 1.6'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rake',        '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec',       '~> 2.0'
+  spec.add_development_dependency 'simplecov',           '~> 0.16'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/spec/lib/messages_dictionary/injector_spec.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+RSpec.describe MessagesDictionary::Injector do
+  let(:dummy) { Class.new { include MessagesDictionary::Injector } }
+
+  context 'with messages' do
+    context 'when outputting' do
+      it 'uses STDOUT by default' do
+        dummy.class_eval do
+          has_messages_dictionary messages: {test: 'string'}
+        end
+
+        expect(dummy::DICTIONARY_CONF[:output]).to eq($stdout)
+      end
+
+      it 'uses puts method by default' do
+        dummy.class_eval do
+          has_messages_dictionary messages: {test: 'string'}
+        end
+
+        expect(dummy::DICTIONARY_CONF[:method]).to eq(:puts)
+      end
+
+      it 'allows customizing output and method' do
+        output = instance_double(IO)
+
+        allow(output).to receive(:print)
+
+        dummy.class_eval do
+          has_messages_dictionary messages: {test: 'string'}, output: output, method: :print
+        end
+
+        object = dummy.new
+
+        object.send(:pretty_output, :test)
+
+        expect(output).to have_received(:print).with('string').exactly(1).time
+      end
+
+      it 'aliases pretty_output as pou' do
+        output = instance_double(IO)
+
+        allow(output).to receive(:puts)
+
+        dummy.class_eval do
+          has_messages_dictionary messages: {test: 'string'}, output: output
+        end
+
+        object = dummy.new
+
+        object.send(:pou, :test)
+
+        expect(output).to have_received(:puts).with('string').exactly(1).time
+      end
+    end
+
+    context 'when passed as hash' do
+      it 'supports nesting' do
+        dummy.class_eval do
+          has_messages_dictionary messages: {parent: {child: 'child_string'}}
+        end
+
+        object = dummy.new
+        expect(object.send(:pretty_output, 'parent.child') { |msg| msg }).to eq('child_string')
+      end
+    end
+
+    context 'when passed in file' do
+      it 'works with anonymous classes' do
+        in_dir 'unknown.yml' do
+          dummy.class_eval do
+            has_messages_dictionary
+          end
+
+          object = dummy.new
+          expect(object.send(:pretty_output, :test) { |msg| msg }).to eq('string')
+        end
+      end
+
+      it 'searches file named after class name by default' do
+        in_dir 'fake_class.yml' do
+          stub_const 'FakeClass', dummy
+
+          FakeClass.class_eval do
+            has_messages_dictionary
+          end
+
+          object = FakeClass.new
+          expect(object.send(:pretty_output, :test) { |msg| msg }).to eq('string')
+        end
+      end
+
+      it 'allows passing path and file' do
+        in_dir 'my_test_file.yml', 'my_test_dir' do
+          dummy.class_eval do
+            has_messages_dictionary file: 'my_test_file.yml', dir: 'my_test_dir'
+          end
+
+          object = dummy.new
+          expect(object.send(:pretty_output, :test) { |msg| msg }).to eq('string')
+          expect(object.send(:pretty_output, :interpolated, a: 42) { |msg| msg }).to eq('Value is 42')
+        end
+      end
+    end
+  end
+
+  context 'with error' do
+    it 'is raised when key is not found' do
+      dummy.class_eval do
+        has_messages_dictionary messages: {test: 'string'}
+      end
+
+      object = dummy.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
+      expect do
+        dummy.class_eval do
+          has_messages_dictionary dir: 'random', file: 'not_exist.yml'
+        end
+      end.to raise_error(
+        an_instance_of(SystemExit).
+        and(having_attributes(message: "File #{File.expand_path('random/not_exist.yml')} does not exist..."))
+      )
+    end
+  end
+
+  context 'with transformations' do
+    it 'applies per-method transformations' do
+      dummy.class_eval do
+        has_messages_dictionary messages: {test: 'string'}
+      end
+
+      object = dummy.new
+      expect(object.send(:pretty_output, :test, &:upcase)).to eq('STRING')
+    end
+
+    it 'applies per-class transformations' do
+      dummy.class_eval do
+        has_messages_dictionary messages: {test: 'string'},
+                                transform: ->(msg) { puts msg.upcase }
+
+        define_method :run do
+          pou(:test)
+        end
+      end
+
+      object = dummy.new
+
+      allow($stdout).to receive(:puts).with('STRING')
+
+      object.run
+
+      expect($stdout).to have_received(:puts).exactly(1).time
+    end
+
+    it 'per-method takes higher priority than per-class' do
+      dummy.class_eval do
+        has_messages_dictionary messages: {test: 'string'},
+                                transform: ->(msg) { msg.reverse }
+      end
+
+      object = dummy.new
+      expect(object.send(:pretty_output, :test, &:upcase)).to eq('STRING')
+    end
+  end
+end

data/spec/lib/messages_dictionary/utils/dict_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.describe MessagesDictionary::Utils::Dict do
+  let(:dummy) { described_class.new key: 'value' }
+
+  it 'allows indifferent access' do
+    expect(dummy[:key]).to eq('value')
+    expect(dummy['key']).to eq('value')
+  end
+end

data/spec/lib/messages_dictionary_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe MessagesDictionary do
+  let(:dummy) { Class.new { include MessagesDictionary } }
+
+  it 'includes the necessary methods' do
+    dummy.class_eval do
+      has_messages_dictionary messages: {parent: {child: 'child_string'}}
+
+      define_method :run do
+        pou('parent.child', &:upcase)
+      end
+    end
+
+    object = dummy.new
+    expect(object.send(:pou, 'parent.child') { |msg| msg }).to eq('child_string')
+    expect(object.send(:pretty_output, 'parent.child') { |msg| msg }).to eq('child_string')
+    expect(object.run).to eq('CHILD_STRING')
+  end
+end

data/spec/spec_helper.rb

@@ -1,16 +1,25 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 SimpleCov.start do
-  add_filter "/spec/"
-  add_filter "/bin/"
+  add_filter '/spec/'
+  add_filter '/bin/'
+end
+
+if ENV.fetch('CI', nil) == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
-$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+$LOAD_PATH << File.expand_path('../../lib', __dir__)
+
+RSPEC_ROOT = File.dirname __FILE__
+
+Dir["#{RSPEC_ROOT}/support/**/*.rb"].sort.each { |f| require f }
 
 require 'messages_dictionary'
 
 RSpec.configure do |config|
-  config.include SpecAddons
   config.include SpecFilesSetup
   config.include SpecUtils
-end
+end

data/spec/support/spec_files_setup.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 module SpecFilesSetup
   def setup_env!(path, file)
-    FileUtils.mkdir_p(path)
-    f = File.new("#{path}/#{file}", 'w+')
-    f.write('test: string')
+    full_path = "#{RSPEC_ROOT}/dummy/#{path}"
+
+    FileUtils.mkdir_p full_path
+
+    f = File.new(File.join(full_path, file), 'w+')
+    f.write("test: string\ninterpolated: Value is {{a}}")
     f.close
   end
 
   def clear_env!(path)
-    FileUtils.remove_entry(path)
+    FileUtils.remove_entry("#{RSPEC_ROOT}/dummy/#{path}")
   end
-end
+end

data/spec/support/spec_utils.rb

@@ -1,23 +1,19 @@
+# frozen_string_literal: true
+
 module SpecUtils
-  def capture_stderr(&block)
-    original_stderr = $stderr
-    $stderr = fake = StringIO.new
-    begin
-      yield
-    ensure
-      $stderr = original_stderr
-    end
-    fake.string
-  end
+  def in_dir(file, path = '')
+    return unless block_given?
+
+    setup_env!(path, file)
+
+    initial_path = Dir.getwd
+
+    Dir.chdir "#{RSPEC_ROOT}/dummy"
+
+    yield
+
+    Dir.chdir initial_path
 
-  def capture_stdout(&block)
-    original_stdout = $stdout
-    $stdout = fake = StringIO.new
-    begin
-      yield
-    ensure
-      $stdout = original_stdout
-    end
-    fake.string
+    clear_env!(path)
   end
-end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: messages_dictionary
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Ilya Bodrov
+- Ilya Krukowski
 - anilika
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -17,28 +17,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -54,19 +82,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: This gem allows you to store some text in a simple-key value format and
   fetch it whenever you need from your methods. Various classes may have different
   messages attached and apply different fetching logic. Messages also support interpolation
@@ -78,9 +162,17 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -89,21 +181,21 @@ files:
 - 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/utils/string_utils.rb
 - lib/messages_dictionary/version.rb
 - messages_dictionary.gemspec
-- spec/injector_spec.rb
+- spec/lib/messages_dictionary/injector_spec.rb
+- spec/lib/messages_dictionary/utils/dict_spec.rb
+- spec/lib/messages_dictionary_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
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,16 +203,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Store your messages anywhere and fetch them anytime.
 test_files: []

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.1.5
-  - 2.2.5
-  - 2.3.4
-  - ruby-head
-
-install: bundle install --retry=3
-
-after_success:
-  - bundle exec codeclimate-test-reporter

data/lib/messages_dictionary/utils/snake_case.rb

@@ -1,17 +0,0 @@
-module MessagesDictionary
-  class SpecialString
-    attr_accessor :string
-
-    def initialize(string)
-      @string = string
-    end
-
-    def snake_case
-      string.gsub(/::/, '/').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          tr("-", "_").
-          downcase
-    end
-  end
-end