macmillan-utils 1.0.18 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acc95b947ca749c2078f77ca59d7744f65c685c5
-  data.tar.gz: 23b579c7ff8f10f37d4029f86712f0d33fcaccc2
+  metadata.gz: 00268cd5e517f8817ee7515c2bd5c1d94df9e242
+  data.tar.gz: f5252d519821c65a1eea390284b5f092ac7c232d
 SHA512:
-  metadata.gz: c4cee43c55460edfc8eb646256b95d53ed7fd48fa902cca3f8073cee3c046bdcb50e7a630c75f362eeee870ea1bf22b93c4a26987d1c6d7d568488dcc8a7ed46
-  data.tar.gz: 60e29f0eae35b3d2a959b31c92de73770da61f56db07e518ddd29eebe2599c7b2b8f1b1c4e6291714cf1a4c76edac3d57510382e1876ef4296e50f9c381bb40f
+  metadata.gz: cf346d7f3a5035e0f51bdfe2e06f18a2f9fc4b8329c36f3d30609db4ebb3ece48c2247e9977e5b843d49a33560955d104d7d56a60f9c3dc19ad0d950d96367b0
+  data.tar.gz: 09352c5f41b7ccb073e3f51e6f05e137d296531d78317973550fd39c2b1cfa6cd0516eeba73e2df733acd3dff29d5c77b92881082ecf4dca190866bcfd6b51cb

data/lib/macmillan/utils.rb

@@ -12,5 +12,6 @@ module Macmillan
     autoload :StatsdDecorator,        'macmillan/utils/statsd_decorator'
     autoload :StatsdMiddleware,       'macmillan/utils/statsd_middleware'
     autoload :StatsdControllerHelper, 'macmillan/utils/statsd_controller_helper'
+    autoload :Helper,                 'macmillan/utils/helper'
   end
 end

data/lib/macmillan/utils/helper.rb

@@ -0,0 +1,11 @@
+module Macmillan
+  module Utils
+    ##
+    # Namespace for helpers classes
+    #
+    module Helper
+      autoload :HashKeyHelper,          'macmillan/utils/helper/hash_key_helper'
+      autoload :StringConversionHelper, 'macmillan/utils/helper/string_conversion_helper'
+    end
+  end
+end

data/lib/macmillan/utils/helper/hash_key_helper.rb

@@ -0,0 +1,46 @@
+module Macmillan
+  module Utils
+    module Helper
+      module HashKeyHelper
+        include StringConversionHelper
+
+        def convert_keys_to_snakecase_and_symbols(obj)
+          case obj
+          when Array
+            obj.reduce([]) do |res, val|
+              res << case val
+                     when Hash, Array
+                       convert_keys_to_snakecase_and_symbols(val)
+                     else
+                       val
+                     end
+              res
+            end
+          when Hash
+            obj.reduce({}) do |res, (key, val)|
+              nkey = snakecase_string(key.to_s).to_sym
+              nval = case val
+                     when Hash, Array
+                       convert_keys_to_snakecase_and_symbols(val)
+                     else
+                       val
+                     end
+              res[nkey] = nval
+              res
+            end
+          else
+            obj
+          end
+        end
+
+        def convert_key_to_singular(key)
+          if key.to_s == 'summaries'
+            :summary
+          else
+            key.to_s.chomp('s').to_sym
+          end
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/helper/string_conversion_helper.rb

@@ -0,0 +1,35 @@
+module Macmillan
+  module Utils
+    module Helper
+      module StringConversionHelper
+        module_function
+
+        # shamelessly ripped out of the 'facets' gem
+        def snakecase_string(string)
+          string
+            .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+            .tr('-', '_')
+            .gsub(/\s/, '_')
+            .gsub(/__+/, '_')
+            .downcase
+        end
+
+        # also shamelessly ripped out of the 'facets' gem
+        def upper_camelcase_string(string)
+          separators = ['_', '\s']
+
+          separators.each do |s|
+            string = string.gsub(/(?:#{s}+)([a-z])/){ $1.upcase }
+          end
+
+          string.gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+        end
+
+        def camelcase_to_snakecase_symbol(string)
+          snakecase_string(string).to_sym
+        end
+      end
+    end
+  end
+end

data/spec/lib/macmillan/utils/helper/hash_key_helper_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe Macmillan::Utils::Helper::HashKeyHelper do
+  include Macmillan::Utils::Helper::HashKeyHelper
+
+  describe '#convert_keys_to_snakecase_and_symbols' do
+    context 'when it is a flat hash' do
+      let(:example) do
+        { 'aKey' => 'woo', '_debug' => {} }
+      end
+
+      let(:expected) do
+        { a_key: 'woo', _debug: {} }
+      end
+
+      it 'converts all the keys to snake_case and symbols' do
+        result = convert_keys_to_snakecase_and_symbols(example)
+        expect(result).to eq(expected)
+      end
+    end
+
+    context 'a hash containing child hashes' do
+      let(:example) do
+        { 'aKey' => { 'someKey' => 'woo', 'someKey2' => 'woo' } }
+      end
+
+      let(:expected) do
+        { a_key: { some_key: 'woo', some_key2: 'woo' } }
+      end
+
+      it 'converts all the keys to snake_case and symbols' do
+        result = convert_keys_to_snakecase_and_symbols(example)
+        expect(result).to eq(expected)
+      end
+    end
+
+    context 'a hash containing arrays of hashes as values' do
+      let(:example) do
+        {
+          'aKey' => [
+            { 'someKey' => 'woo' },
+            { 'someKey2' => 'waa' }
+          ]
+        }
+      end
+
+      let(:expected) do
+        {
+          a_key: [
+            { some_key: 'woo' },
+            { some_key2: 'waa' }
+          ]
+        }
+      end
+
+      it 'converts all the keys to snake_case and symbols' do
+        result = convert_keys_to_snakecase_and_symbols(example)
+        expect(result).to eq(expected)
+      end
+    end
+
+    context 'with a monster' do
+      let(:example) do
+        {
+          'aKey' => [
+            { 'someKey' => 'woo' },
+            { 'someKey2' => 'waa' },
+            [
+              { 'someKey' => 'woo' },
+              {
+                'argh' => [
+                  { 'someKey' => 'woo' }
+                ]
+              }
+            ]
+          ]
+        }
+      end
+
+      let(:expected) do
+        {
+          a_key: [
+            { some_key: 'woo' },
+            { some_key2: 'waa' },
+            [
+              { some_key: 'woo' },
+              {
+                argh: [
+                  { some_key: 'woo' }
+                ]
+              }
+            ]
+
+          ]
+        }
+      end
+
+      it 'converts all the keys to snake_case and symbols' do
+        result = convert_keys_to_snakecase_and_symbols(example)
+        expect(result).to eq(expected)
+      end
+    end
+  end
+
+  describe '#convert_key_to_singular' do
+    context 'when the key is :summaries' do
+      let(:key) { :summaries }
+
+      it 'converts the key to :summary' do
+        expect(convert_key_to_singular(key)).to eq(:summary)
+      end
+    end
+
+    context 'when the key is NOT :summaries' do
+      let(:articles_key)              { :articles }
+      let(:primary_article_types_key) { :primary_article_types }
+
+      it 'converts the key to singular' do
+        expect(convert_key_to_singular(articles_key)).to eq(:article)
+        expect(convert_key_to_singular(primary_article_types_key)).to eq(:primary_article_type)
+      end
+    end
+  end
+end

data/spec/lib/macmillan/utils/helper/string_conversion_helper_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Macmillan::Utils::Helper::StringConversionHelper do
+  include Macmillan::Utils::Helper::StringConversionHelper
+
+  describe '#snakecase_string' do
+    it 'downcases' do
+      expect(snakecase_string('URI')).to eq('uri')
+    end
+
+    it 'converts spaces' do
+      expect(snakecase_string('MyStuff  HisStuff')).to eq('my_stuff_his_stuff')
+    end
+
+    it 'does not alter path dividers' do
+      expect(snakecase_string('/my_module/my_class/')).to eq('/my_module/my_class/')
+    end
+  end
+
+  describe '#upper_camelcase_string' do
+    let(:spacey_string)      {'I feel spaced out'}
+    let(:underscorey_string) {'i_feel_under_scored'}
+
+    it 'converts a string containing spaces to upper camelcase' do
+      expect(upper_camelcase_string(spacey_string)).to eq('IFeelSpacedOut')
+    end
+
+    it 'converts a string containing underscores to upper camelcase' do
+      expect(upper_camelcase_string(underscorey_string)).to eq('IFeelUnderScored')
+    end
+  end
+
+  describe '#camelcase_to_snakecase_symbol' do
+    let(:camel) {'LookAtThisHumpyOldCamel'}
+
+    it 'converts a camelcase string to a snakecase symbol equivalent' do
+      expect(camelcase_to_snakecase_symbol(camel)).to eq(:look_at_this_humpy_old_camel)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macmillan-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.18
+  version: 1.0.19
 platform: ruby
 authors:
 - Macmillan Science and Education (New Publsihing Platforms)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -226,6 +226,9 @@ files:
 - lib/macmillan/utils/bundler/gem_helper.rb
 - lib/macmillan/utils/cucumber/cucumber_defaults.rb
 - lib/macmillan/utils/cucumber/webmock_helper.rb
+- lib/macmillan/utils/helper.rb
+- lib/macmillan/utils/helper/hash_key_helper.rb
+- lib/macmillan/utils/helper/string_conversion_helper.rb
 - lib/macmillan/utils/logger.rb
 - lib/macmillan/utils/logger/factory.rb
 - lib/macmillan/utils/logger/formatter.rb
@@ -251,6 +254,8 @@ files:
 - lib/macmillan/utils/test_helpers/simplecov_helper.rb
 - macmillan-utils.gemspec
 - spec/fixtures/config/application.yml
+- spec/lib/macmillan/utils/helper/hash_key_helper_spec.rb
+- spec/lib/macmillan/utils/helper/string_conversion_helper_spec.rb
 - spec/lib/macmillan/utils/logger/factory_spec.rb
 - spec/lib/macmillan/utils/logger/formatter_spec.rb
 - spec/lib/macmillan/utils/middleware/uuid_spec.rb
@@ -287,6 +292,8 @@ summary: A collection of useful patterns we (Macmillan Science and Education) us
   in our Ruby applications.
 test_files:
 - spec/fixtures/config/application.yml
+- spec/lib/macmillan/utils/helper/hash_key_helper_spec.rb
+- spec/lib/macmillan/utils/helper/string_conversion_helper_spec.rb
 - spec/lib/macmillan/utils/logger/factory_spec.rb
 - spec/lib/macmillan/utils/logger/formatter_spec.rb
 - spec/lib/macmillan/utils/middleware/uuid_spec.rb