added format_message, removed lots of explicit returns

Author: vanwagonet

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.0.2
+
+* **New Feature**
+  * added `MessageFormat.format_message` class method
+* **Polish**
+  * better follow community style conventions
+
+## 0.0.1
+
+* Initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

lib/message_format.rb

@@ -15,15 +15,23 @@ def initialize ( pattern, locale=nil )
     end
 
     def format ( args=nil )
-      return @format.call(args)
+      @format.call(args)
     end
 
   end
 
   class << self
 
     def new ( pattern, locale=nil )
-      return MessageFormat.new(pattern, locale)
+      MessageFormat.new(pattern, locale)
+    end
+
+    def format_message ( pattern, args=nil, locale=nil )
+      locale ||= TwitterCldr.locale
+      Interpreter.interpret(
+        Parser.parse(pattern),
+        { :locale => locale.to_sym }
+      ).call(args)
     end
 
   end

lib/message_format/interpreter.rb

@@ -26,7 +26,7 @@ def initialize ( options=nil )
     end
 
     def interpret ( elements )
-      return interpret_subs(elements)
+      interpret_subs(elements)
     end
 
     def interpret_subs ( elements, parent=nil )
@@ -39,14 +39,14 @@ def interpret_subs ( elements, parent=nil )
         return elements[0]
       end
 
-      return lambda do |args|
+      lambda do |args|
         elements.map { |element| element.call(args) }.join ''
       end
     end
 
     def interpret_element ( element, parent=nil )
       if element.is_a?(String)
-        return lambda { |args=nil| element }
+        return lambda { |_=nil| element }
       end
 
       id, type, style = element
@@ -63,57 +63,57 @@ def interpret_element ( element, parent=nil )
 
       case type
         when 'number'
-          return interpret_number(id, offset, style)
+          interpret_number(id, offset, style)
         when 'date', 'time'
-          return interpret_date_time(id, type, style)
+          interpret_date_time(id, type, style)
         when 'plural', 'selectordinal'
           offset = element[2]
           options = element[3]
-          return interpret_plural(id, type, offset, options)
+          interpret_plural(id, type, offset, options)
         when 'select'
-          return interpret_select(id, style)
+          interpret_select(id, style)
         when 'spellout', 'ordinal', 'duration'
-          return interpret_number(id, offset, type)
+          interpret_number(id, offset, type)
         else
-          return interpret_simple(id)
+          interpret_simple(id)
       end
     end
 
     def interpret_number ( id, offset, style )
       locale = @locale
-      return lambda do |args|
+      lambda do |args|
         number = TwitterCldr::Localized::LocalizedNumber.new(args[id] - offset, locale)
         if style == 'integer'
-          return number.to_decimal(:precision => 0).to_s
+          number.to_decimal(:precision => 0).to_s
         elsif style == 'percent'
-          return number.to_percent.to_s
+          number.to_percent.to_s
         elsif style == 'currency'
-          return number.to_currency.to_s
+          number.to_currency.to_s
         elsif style == 'spellout'
-          return number.spellout
+          number.spellout
         elsif style == 'ordinal'
-          return number.to_rbnf_s('OrdinalRules', 'digits-ordinal')
+          number.to_rbnf_s('OrdinalRules', 'digits-ordinal')
         else
-          return number.to_s
+          number.to_s
         end
       end
     end
 
     def interpret_date_time ( id, type, style='medium' )
       locale = @locale
-      return lambda do |args|
+      lambda do |args|
         datetime = TwitterCldr::Localized::LocalizedDateTime.new(args[id], locale)
         datetime = type == 'date' ? datetime.to_date : datetime.to_time
         if style == 'medium'
-          return datetime.to_medium_s
+          datetime.to_medium_s
         elsif style == 'long'
-          return datetime.to_long_s
+          datetime.to_long_s
         elsif style == 'short'
-          return datetime.to_short_s
+          datetime.to_short_s
         elsif style == 'full'
-          return datetime.to_full_s
+          datetime.to_full_s
         else
-          return datetime.to_additional_s(style)
+          datetime.to_additional_s(style)
         end
       end
     end
@@ -127,15 +127,15 @@ def interpret_plural ( id, type, offset, children )
 
       locale = @locale
       plural_type = type == 'selectordinal' ? :ordinal : :cardinal
-      return lambda do |args|
+      lambda do |args|
         arg = args[id]
         exactSelector = ('=' + arg.to_s).to_sym
         keywordSelector = TwitterCldr::Formatters::Plurals::Rules.rule_for(arg - offset, locale, plural_type)
         func =
           options[exactSelector] ||
           options[keywordSelector] ||
           options[:other]
-        return func.call(args)
+        func.call(args)
       end
     end
 
@@ -144,23 +144,21 @@ def interpret_select ( id, children )
       children.each do |key, value|
         options[key.to_sym] = interpret_subs(value, nil)
       end
-      return lambda do |args|
+      lambda do |args|
         selector = args[id].to_sym
         func =
           options[selector] ||
           options[:other]
-        return func.call(args)
+        func.call(args)
       end
     end
 
     def interpret_simple ( id )
-      return lambda do |args|
-        return args[id].to_s
-      end
+      lambda { |args| args[id].to_s }
     end
 
     def self.interpret ( elements, options=nil )
-      return Interpreter.new(options).interpret(elements)
+      Interpreter.new(options).interpret(elements)
     end
 
   end

lib/message_format/parser.rb

@@ -32,36 +32,32 @@ def parse ( pattern )
       @pattern = pattern
       @length = pattern.length
       @index = 0
-      return parse_message("message")
+      parse_message("message")
     end
 
     def is_digit ( char )
-      return (
-        char == '0' or
-        char == '1' or
-        char == '2' or
-        char == '3' or
-        char == '4' or
-        char == '5' or
-        char == '6' or
-        char == '7' or
-        char == '8' or
-        char == '9'
-      )
+      char == '0' or
+      char == '1' or
+      char == '2' or
+      char == '3' or
+      char == '4' or
+      char == '5' or
+      char == '6' or
+      char == '7' or
+      char == '8' or
+      char == '9'
     end
 
     def is_whitespace ( char )
-      return (
-        char == "\s" or
-        char == "\t" or
-        char == "\n" or
-        char == "\r" or
-        char == "\f" or
-        char == "\v" or
-        char == "\u00A0" or
-        char == "\u2028" or
-        char == "\u2029"
-      )
+      char == "\s" or
+      char == "\t" or
+      char == "\n" or
+      char == "\r" or
+      char == "\f" or
+      char == "\v" or
+      char == "\u00A0" or
+      char == "\u2028" or
+      char == "\u2029"
     end
 
     def skip_whitespace ()
@@ -120,7 +116,7 @@ def parse_text ( parent_type )
         end
       end
 
-      return text
+      text
     end
 
     def parse_argument ()
@@ -175,7 +171,7 @@ def parse_argument ()
       end
       @index += 1 # move passed
 
-      return (type == 'plural' or type == 'selectordinal') ?
+      (type == 'plural' or type == 'selectordinal') ?
         [ id, type, offset, format ] :
         [ id, type, format ]
     end
@@ -198,7 +194,7 @@ def parse_arg_id ()
         raise_expected('argument id')
       end
       skip_whitespace()
-      return id
+      id
     end
 
     def parse_arg_type ()
@@ -218,7 +214,7 @@ def parse_arg_type ()
         raise_expected(types.join(', '))
       end
       skip_whitespace()
-      return arg_type
+      arg_type
     end
 
     def parse_simple_format ()
@@ -228,7 +224,7 @@ def parse_simple_format ()
         raise_expected('argument style name')
       end
       skip_whitespace()
-      return style
+      style
     end
 
     def parse_plural_offset ()
@@ -250,7 +246,7 @@ def parse_plural_offset ()
         offset = @pattern[start..@index].to_i
         skip_whitespace()
       end
-      return offset
+      offset
     end
 
     def parse_sub_messages ( parent_type )
@@ -273,7 +269,7 @@ def parse_sub_messages ( parent_type )
       if !options.has_key?('other') # does not have an other selector
         raise_expected(nil, nil, '"other" option must be specified in ' + parent_type)
       end
-      return options
+      options
     end
 
     def parse_selector ()
@@ -293,7 +289,7 @@ def parse_selector ()
         raise_expected('selector')
       end
       skip_whitespace()
-      return selector
+      selector
     end
 
     def parse_sub_message ( parent_type )
@@ -308,7 +304,7 @@ def parse_sub_message ( parent_type )
         raise_expected('}')
       end
       @index += 1 # move passed }
-      return message
+      message
     end
 
     def parse_message ( parent_type )
@@ -330,7 +326,7 @@ def parse_message ( parent_type )
           elements.push(text)
         end
       end
-      return elements
+      elements
     end
 
     def raise_expected ( expected=nil, found=nil, message=nil )
@@ -349,14 +345,13 @@ def raise_expected ( expected=nil, found=nil, message=nil )
     end
 
     def error_message ( expected=nil, found )
-      if !expected
-        return "Unexpected \"#{ found }\" found"
-      end
-      return "Expected \"#{ expected }\" but found \"#{ found }\""
+      expected ?
+        "Expected \"#{ expected }\" but found \"#{ found }\"" :
+        "Unexpected \"#{ found }\" found" 
     end
 
     def self.parse ( pattern )
-      return Parser.new().parse(pattern)
+      Parser.new().parse(pattern)
     end
 
     #

lib/message_format/version.rb

@@ -1,3 +1,3 @@
 module MessageFormat
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end