nomener 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a5d4f2bd5060c45197d9b93c147ecf4975b66a4
-  data.tar.gz: 82d2f6e476c9fab3b3c18e1203fb7fc57cb7fe5d
+  metadata.gz: 8430696642a5042737102794198c6230189398ac
+  data.tar.gz: 997182835347c5b6aaee8ab4efdc115552708b5d
 SHA512:
-  metadata.gz: a84f031b213de553071f89fbfc16d0efab68e2b69471e32c2c92aa35598c80f2e2a1520a0ecbd0b88c4262c605f77c879b57a085ee33578bfa548483b1ccee54
-  data.tar.gz: 0783c6281f125eb7808772518e7bc3d0a26335625b3bb7d3340c59e4eb5f4c0ebcc1355864660d6550ffcbc66183133f2ccce0756e3c4322e27b9b829644b87e
+  metadata.gz: 76a55f700bc0664352a3d81c97ddc62d2fe52172c70b3bd30fd4a1b721e878dc8bd60bb4b3cff5bc36e2434781b5792a0333dc1490c89f8242c7947acb9f9041
+  data.tar.gz: b0efa1c9f181100140196ebefddb392afba225e5b5e498c6a61fab751c98168b7fe5d29be03672067eeb0157956511c277718eed89ba721173e12ca81775f4a3

data/lib/nomener.rb

@@ -1,9 +1,13 @@
 #-- encoding: UTF-8
-require 'nomener/version'
+require 'nomener/configuration'
 require 'nomener/name'
+require 'nomener/version'
 
 # Base module for our names
 module Nomener
+  # hold the configuration object Nomener::Configuration
+  @@config = nil
+
   # Error class raised for the few times we aren't able to parse a name
   class ParseError < StandardError
   end
@@ -16,4 +20,30 @@ module Nomener
   def self.parse(name)
     Name.new(name).parse
   end
+
+  # Public: to configure the Nomener object
+  #   can set individually or by block
+  #   See Nomener::Configuration for more details on what may be set
+  #
+  # Returns the configuration object
+  def self.configure
+    @@config ||= Nomener::Configuration.new
+    yield config if block_given?
+    @@config
+  end
+
+  # Public: set the configuration to the Nomener::Configuration defaults
+  #
+  # Returns the configuration object
+  def self.reset
+    @@config = Nomener::Configuration.new
+  end
+
+  # Internal: Read accessor for configuration
+  #
+  # Returns the configuration
+  def self.config
+    self.configure unless @@config
+    @@config
+  end
 end

data/lib/nomener/cleaner.rb

@@ -26,22 +26,20 @@ module Nomener
     #  Needs to be fixed up for matching and non-english quotes
     #
     # name - the string to clean
-    # double - the double quotes to replace others with "" by default
-    # single - the single quotes to replace others with '' by default
     #
     # Returns a string which is (ideally) pretty much the same as it was given.
-    def self.reformat(name, double = '""', single = "''")
+    def self.reformat(name)
       @@allowable = %r![^\p{Alpha}\-&\/\ \.\,\'\"\(\)
-        #{double[0] || '"'}
-        #{double[1] || '"'}
-        #{single[0] || "'"}
-        #{single[1] || "'"}] !x unless @@allowable
+        #{Nomener.config.left}
+        #{Nomener.config.right}
+        #{Nomener.config.single}
+        ] !x unless @@allowable
 
       # remove illegal characters, translate fullwidth down
       nomen = name.dup.scrub.tr("\uFF02\uFF07", "\u0022\u0027")
 
-      nomen = replace_doubles(nomen, double)
-      replace_singles(nomen, single)
+      nomen = replace_doubles(nomen)
+      replace_singles(nomen)
         .gsub(/@@allowable/, ' ')
         .squeeze(' ')
         .strip
@@ -69,11 +67,10 @@ module Nomener
     # Internal: Replace various double quote characters with given char
     #
     # str - the string to find replacements in
-    # double - string with two characters, the left and right quotes
     #
     # Returns the string with the quotes replaced
-    def self.replace_doubles(str, double)
-      left, right = quotes_from double
+    def self.replace_doubles(str)
+      left, right = [Nomener.config.left, Nomener.config.right]
 
       # replace left and right double quotes
       str.tr("\u0022\u00AB\u201C\u201E\u2036\u300E\u301D\u301F\uFE43", left)
@@ -84,19 +81,18 @@ module Nomener
     # Internal: Replace various single quote characters with given chars
     #
     # str - the string to find replacements in
-    # double - string with two characters, the left and right quotes
     #
     # Returns the string with the quotes replaced
-    def self.replace_singles(str, single)
-      left, right = quotes_from single
+    def self.replace_singles(str)
 
       # replace left and right single quotes
-      str.tr("\u0027\u2018\u201A\u2035\u2039\u300C\uFE41\uFF62", left)
-        .tr("\u0027\u2019\u201B\u2032\u203A\u300D\uFE42\uFF62", right)
+      str.tr("\u0027\u2018\u201A\u2035\u2039\u300C\uFE41\uFF62", Nomener.config.single)
+        .tr("\u0027\u2019\u201B\u2032\u203A\u300D\uFE42\uFF62", Nomener.config.single)
     end
     private_class_method :replace_singles
 
     # Internal: Get the quotes from a string
+    #  Currently unused. To Be Removed.
     #
     # str - the string of two characters for the left and right quotes
     #

data/lib/nomener/configuration.rb

@@ -0,0 +1,39 @@
+#-- encoding: UTF-8
+
+# configuration module for our names
+module Nomener
+  class Configuration
+    attr_accessor :lquote, :rquote, :squote, :language, :direction, :format
+    
+    # initializes the configuration object
+    def initialize
+      @lquote = '"'
+      @rquote = '"'
+      @squote = '\''
+      @language = :en
+      @direction = :ltr
+      @format = '%f %m %l'
+    end
+
+    alias_method :left_quote=, :lquote=
+    alias_method :left_quote, :lquote
+    alias_method :left=, :lquote=
+    alias_method :left, :lquote
+
+    alias_method :right_quote=, :rquote=
+    alias_method :right_quote, :rquote
+    alias_method :right=, :rquote=
+    alias_method :right, :rquote
+
+    alias_method :single_quote=, :squote=
+    alias_method :single_quote, :squote
+    alias_method :single=, :squote=
+    alias_method :single, :squote
+
+    alias_method :lang=, :language=
+    alias_method :lang, :language
+
+    alias_method :dir=, :direction=
+    alias_method :dir, :direction
+  end
+end

data/lib/nomener/name.rb

@@ -31,24 +31,25 @@ module Nomener
     #
     # Returns a string of the full name in a proper (western) case
     def properlike
-      [capit(title), capit(first),
-        (nick.to_s.empty? ? '' : "\"#{nick}\""),
-        capit(middle), capit(last),
+      [capit(title),
+        capit(first),
+        (nick.to_s.empty? ? '' : "#{Nomener.config.left}#{nick}#{Nomener.config.right}"),
+        capit(middle),
+        capit(last),
         suffix
       ].join(' ').strip.squeeze ' '
     end
 
-    # Internal: try to capitalize last names with Mac and Mc and D' and such
+    # Internal: try to capitalize names including tough ones like Mac and Mc and D' and such
     #
-    # last - string of the name to capitalize
+    # nomen - string of the name to capitalize
     #
     # Returns a string of the capitalized name
-    def capit(last)
-      fix = last.to_s.dup
-
-      # if there are multiple last names separated by a dash
-      fix = fix.split('-')
-        .map { |outer| outer.split(' ').map(&:capitalize).join ' ' }.join '-'
+    def capit(nomen)
+      # if there are multiple names separated by a dash
+      fix = nomen.to_s.dup.split('-').map do |outer|
+        outer.split(' ').map(&:capitalize).join ' '
+      end.join '-'
 
       # anything begining with Mac and not ending in [aciozj], except for a few
       fix.sub!(/Mac(?!
@@ -131,7 +132,7 @@ module Nomener
     #
     # Returns the full name
     def full
-      name '%f %m %l'
+      name Nomener.config.format
     end
     alias_method :fullname, :full
 

data/lib/nomener/version.rb

@@ -1,5 +1,5 @@
 #-- encoding: UTF-8
 # Module defining the Nomener version
 module Nomener
-  VERSION = '0.2.9'
+  VERSION = '0.2.10'
 end

data/spec/nomener/nomener_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 RSpec.describe "Nomener" do
   it "has the class method parse" do
-    expect(Nomener.singleton_methods).to match_array [:parse]
+    expect(Nomener.singleton_methods).to include :parse
   end
 
   context "with the method parse" do
@@ -29,4 +29,70 @@ RSpec.describe "Nomener" do
       expect(parser.last).to eq "Smith"
     end
   end
+
+  context "with configure" do
+    after(:each) do
+      Nomener.reset
+    end
+
+    it "can be configured" do
+      config = Nomener.configure
+      expect(config).to be_a Nomener::Configuration
+    end
+
+    it "can be reset" do
+      config = Nomener.reset
+      expect(config.left).to eq '"'
+      expect(config.right).to eq '"'
+      expect(config.single).to eq '\''
+      expect(config.lang).to eq :en
+    end
+
+    it "can configure the left quote" do
+      Nomener.config.left = ':'
+      expect(Nomener.config.left).to eq ':'
+    end
+
+    it "can configure the right quote" do
+      Nomener.config.right = ':'
+      expect(Nomener.config.right).to eq ':'
+    end
+
+    it "can configure the single quote" do
+      Nomener.config.single = ':'
+      expect(Nomener.config.single).to eq ':'
+    end
+
+    it "can configure the language" do
+      Nomener.config.lang = :fr
+      expect(Nomener.config.lang).to eq :fr
+    end
+
+    it "can configure the direction" do
+      Nomener.config.dir = :rtl
+      expect(Nomener.config.dir).to eq :rtl
+    end
+
+    it "can configure the name format" do
+      Nomener.config.format = '%f %l'
+      expect(Nomener.config.format).to eq '%f %l'
+    end
+
+    it "can be configured with a block" do
+      Nomener.configure do |con|
+        con.left = '-'
+        con.right = '*'
+        con.single = '^'
+        con.format = '%f'
+        con.dir = :rtl
+        con.lang = :de
+      end
+      expect(Nomener.config.left).to eq '-'
+      expect(Nomener.config.right).to eq '*'
+      expect(Nomener.config.single).to eq '^'
+      expect(Nomener.config.format).to eq '%f'
+      expect(Nomener.config.dir).to eq :rtl
+      expect(Nomener.config.lang).to eq :de
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nomener
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Dante Piombino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - lib/nomener/base.rb
 - lib/nomener/cleaner.rb
 - lib/nomener/compounders.rb
+- lib/nomener/configuration.rb
 - lib/nomener/name.rb
 - lib/nomener/parser.rb
 - lib/nomener/suffixes.rb