messages_dictionary 0.0.1.rc2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9c2443ad99393ac68dd66fd8311f93a22e6c990
+  data.tar.gz: 62ed879f27e7be5be35ce595b7e8d87498937fa0
+SHA512:
+  metadata.gz: 482c06deceb1b6db8d5b21752400417dfa1f8c7ea6ae9f9eefa0d8d6349d133c01aa1dd16b28964800d5b4871b133c96109e1fed6823f1b11ff97e4d551a524e
+  data.tar.gz: 02a34c68b32170ba8172a089066273389f7690b84a06e379fadeab4d292a12234f8ab339df89e3cc2afbe529c8a3f0bdc1e111098549a700de1a8d2e3a170e29

data/.gitignore

@@ -0,0 +1,3 @@
+# RubyMine config files
+.idea/
+*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    messages_dictionary (0.0.1.rc2)
+      hashie (~> 3.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    hashie (3.4.3)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  messages_dictionary!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Ilya Bodrov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# MessagesDictionary
+
+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.
+
+## Usage
+
+### Basic Example
+
+Suppose you have the following program:
+
+```ruby
+class MyClass
+  def calculate(a)
+    result = a ** 2
+    puts "The result is #{result}"
+  end
+end
+
+class MyOtherClass
+  def some_action(a, b)
+    puts "The first value is #{a}, the second is #{b}"
+  end
+
+  def greet
+    puts "Welcome!"
+  end
+end
+```
+
+With `messages_dictionary` you can transform it into
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary
+
+  def calculate(a)
+    result = a ** 2
+    pretty_output(:show_result, result: result)
+  end
+end
+
+class MyOtherClass
+  include MessagesDictionary
+  has_messages_dictionary
+
+  def some_action(a, b)
+    pretty_output(:show_values, first: a, second: b)
+  end
+
+  def greet
+    pretty_output(:welcome)
+  end
+end
+```
+
+The only thing you have to do is create two *.yml* files named after your classes:
+
+*my_class.yml*
+
+```yaml
+show_result: "The result is {{result}}"
+```
+
+*my_other_class.yml*
+
+```yaml
+show_values: "The first value is {{a}}, the second is {{b}}"
+welcome: "Welcome!"
+```
+
+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?
+
+### Further Customization
+
+#### Specifying File Name and Directory
+
+By default `messages_dictionary` will search for a *.yml* file named after your class (converted snake case)
+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).
+* `:dir` (`string`) - specifies the directory to load file from.
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary file: 'some_file.yml', dir: 'C:\my_docs'
+end
+```
+
+#### Specifying Output and Display Method
+
+By default all messages will be outputted to `STDOUT` using `puts` method, however this can be changed as well:
+
+* `: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.
+* `:method` (`symbol` or `string`) - specify method to use (like `warn` or `abort`, for example).
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary output: STDOUT, method: :warn
+end
+```
+
+#### Providing Custom Transformation Logic
+
+Suppose you want to transform your message somehow or even return it instead of printing on the screen.
+`pretty_output` method accepts an optional block for this purpose:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary
+
+  def greet
+    pretty_output(:welcome) do |msg|
+      msg.upcase!
+    end
+  end
+end
+
+my_object = MyClass.new
+my_object.greet # Will return "WELCOME", nothing will be put on the screen
+```
+
+You can also specify transformation logic globally by assigning a procedure or lambda to the `:transform`
+option:
+
+```ruby
+class MyClass
+  include MessagesDictionary
+  has_messages_dictionary transform: ->(msg) {msg.upcase!}
+
+  def greet
+    pretty_output(:welcome)
+  end
+end
+
+my_object = MyClass.new
+my_object.greet # Will return "WELCOME", nothing will be put on the screen
+```
+
+## License
+
+Licensed under the [MIT License](https://github.com/bodrovis-learning/messages_dictionary/blob/master/LICENSE).
+
+Copyright (c) 2016 [Ilya Bodrov](http://radiant-wind.com)

data/lib/messages_dictionary/injector.rb

@@ -0,0 +1,39 @@
+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
+        end
+        klass.const_set(:DICTIONARY_CONF, {msgs: messages.extend(Hashie::Extensions::DeepFetch),
+                                           output: opts[:output] || STDOUT,
+                                           method: opts[:method] || :puts,
+                                           transform: opts[:transform]})
+      end
+
+      define_method :pretty_output do |key, values = {}, &block|
+        msg = klass::DICTIONARY_CONF[:msgs].deep_fetch(*key.to_s.split('.')) do
+          raise KeyError, "#{key} cannot be found in the provided file..."
+        end
+        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
+end

data/lib/messages_dictionary/utils/dict.rb

@@ -0,0 +1,6 @@
+module MessagesDictionary
+  class Dict < Hash
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::IndifferentAccess
+  end
+end

data/lib/messages_dictionary/utils/snake_case.rb

@@ -0,0 +1,17 @@
+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

data/lib/messages_dictionary/version.rb

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

data/lib/messages_dictionary.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+require 'hashie'
+
+require_relative 'messages_dictionary/utils/snake_case'
+require_relative 'messages_dictionary/utils/dict'
+require_relative 'messages_dictionary/injector'
+
+module MessagesDictionary
+end
+

data/messages_dictionary.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path("../lib/messages_dictionary/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  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 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.}
+  spec.homepage         = "https://github.com/bodrovis-learning/messages_dictionary"
+  spec.license          = "MIT"
+  spec.platform         = Gem::Platform::RUBY
+
+  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.add_dependency 'hashie', '~> 3.4'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: messages_dictionary
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc2
+platform: ruby
+authors:
+- Ilya Bodrov
+- anilika
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+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.
+email:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- 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
+homepage: https://github.com/bodrovis-learning/messages_dictionary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Store your messages anywhere and fetch them anytime.
+test_files: []