corefines 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3779e9f17fb899aa96118417ea1426efcdb53d9
-  data.tar.gz: d72b1df9289ae8b439d698af8ae66b469d5aa492
+  metadata.gz: 6ff01826fd1321effe7725bd8de106831ae6400c
+  data.tar.gz: 6441dd63f2e8896861f092fce7c3001258aefdb1
 SHA512:
-  metadata.gz: ca6c1f9221db16740578b134c66820695db1e3ac332e80803c3ff204da2cb77c7ae2374ab43ba0f327c434a3d7399b1dd0b821e45e407a8631e77a86ff4488f8
-  data.tar.gz: e3f0db1ad0602e6e24434d24f17b0a6eeaf0a0173264208aa0e47968d649b178227a9a0cde320a0304b22b65a5cc5637f0e7fc4f2649d79cf0d88da9ac19aee4
+  metadata.gz: 4e3b8f57a51c0c947e9ae175481676b4b2c9423f687533a8d549069d39a3d35cd66b4830fff0430c83f821b15ac312b61db3e99d2de9271bae5dda2f181a0132
+  data.tar.gz: e5d5affb24e366e957d40894bfaec32bd1cd1f59693816fd8777e2cddcf19f5981080a2d5abe0ab6a1e07398d0ad98fe7c7f3aa9ac3d82b39ef3eb9416875db4

data/CHANGELOG.adoc

@@ -3,6 +3,11 @@
 :doc-base-url: http://www.rubydoc.info/github/jirutka/corefines/Corefines
 :issue-uri: {repo-uri}/issues
 
+== 1.6.0 (2015-05-16)
+
+* Add new refinement {doc-base-url}/String/Camelcase[String#camelcase].
+* Add new refinement {doc-base-url}/String/SnakeCase[String#snake_case].
+
 
 == 1.5.0 (2015-05-03)
 

data/README.adoc

@@ -41,12 +41,12 @@ TODO
 Add this line to your application’s Gemfile:
 
 [source]
-gem 'corefines', '~> 1.5'
+gem 'corefines', '~> 1.6'
 
 or to your gemspec:
 
 [source]
-s.add_runtime_dependency 'corefines', '~> 1.5'
+s.add_runtime_dependency 'corefines', '~> 1.6'
 
 and then execute:
 
@@ -162,6 +162,7 @@ Not ideal indeed, but probably the best of what we can achieve.
 ** {doc-base-url}/Object/Try[#try]
 ** {doc-base-url}/Object/Try[#try!]
 * {doc-base-url}/String[String]
+** {doc-base-url}/String/Camelcase[#camelcase]
 ** {doc-base-url}/String/Color[#color]
 ** {doc-base-url}/String/Concat[#concat!]
 ** {doc-base-url}/String/Decolor[#decolor]
@@ -170,6 +171,7 @@ Not ideal indeed, but probably the best of what we can achieve.
 ** {doc-base-url}/String/Indent[#indent]
 ** {doc-base-url}/String/RelativePathFrom[#relative_path_from]
 ** {doc-base-url}/String/Remove[#remove]
+** {doc-base-url}/String/SnakeCase[#snake_case]
 ** {doc-base-url}/String/ToB[#to_b]
 ** {doc-base-url}/String/ToRe[#to_re]
 ** {doc-base-url}/String/Unindent[#unindent] (alias `#strip_heredoc`)

data/lib/corefines/string.rb

@@ -7,6 +7,61 @@ module Corefines
     ESCAPE_SEQUENCE = /\033\[([0-9]+);([0-9]+);([0-9]+)m(.+?)\033\[0m|([^\033]+)/m
     private_constant :ESCAPE_SEQUENCE
 
+    ##
+    # @!method camelcase
+    #   Returns a copy of the _str_ converted to camelcase. When no +:upper+ or
+    #   +:lower+ is specified, then it leaves the first character of a word
+    #   (after camelization) unchanged.
+    #
+    #   @example
+    #     "camel case".camelcase          # => "camelCase"
+    #     "Camel case".camelcase          # => "CamelCase"
+    #     "camel_case__4you!".camelcase   # => "camelCase4you!"
+    #     "camel_case__4_you!".camelcase  # => "camelCase4You!"
+    #
+    #   @overload camelcase(*separators)
+    #     @example
+    #       "camel-case yay!".camelcase('-')          # => "camelCase yay!"
+    #       "camel::ca-se-y".camelcase(':', '-')      # => "camelCaSeY"
+    #       "camel42case".camelcase(/[0-9]+/)         # => "camelCase"
+    #
+    #   @overload camelcase(first_letter, *separators)
+    #     @example
+    #       "camel case".camelcase(:upper)            # => "CamelCase"
+    #       "camel-case yay!".camelcase(:upper, '-')  # => "CamelCase Yay!"
+    #
+    #     @param first_letter [:upper, :lower] desired case of the first
+    #            character of a word - +:upper+ to be upcased, or +:lower+ to
+    #            be downcased.
+    #
+    #   @param *separators [String, Regexp] the patterns used to determine
+    #          where capitalization should occur. Defaults to <tt>/_+/</tt> and
+    #          <tt>\s+</tt>.
+    #   @return [String] a copy of the _str_ converted to camelcase.
+    #
+    module Camelcase
+      refine ::String do
+        def camelcase(*separators)
+          first_letter = separators.shift if ::Symbol === separators.first
+          separators = [/_+/, /\s+/] if separators.empty?
+
+          self.dup.tap do |str|
+            separators.compact.each do |s|
+              s = "(?:#{::Regexp.escape(s)})+" unless s.is_a? ::Regexp
+              str.gsub!(/#{s}([a-z\d])/i) { $1.upcase }
+            end
+
+            case first_letter
+            when :upper
+              str.gsub!(/(\A|\s)([a-z])/) { $1 + $2.upcase }
+            when :lower
+              str.gsub!(/(\A|\s)([A-Z])/) { $1 + $2.downcase }
+            end
+          end
+        end
+      end
+    end
+
     ##
     # @!method color
     #   @example
@@ -286,6 +341,40 @@ module Corefines
       end
     end
 
+    ##
+    # @!method snake_case
+    #   @example
+    #     "snakeCase".snake_case       # => "snake_case"
+    #     "SNAkeCASe".snake_case       # => "sn_ake_ca_se"
+    #     "Snake2Case".snake_case      # => "snake2_case"
+    #     "snake2case".snake_case      # => "snake2case"
+    #     "snake-Ca-se".snake_case     # => "snake_ca_se"
+    #     "snake  ca se".snake_case    # => "snake__ca_se"
+    #     "__snake-case__".snake_case  # => "__snake_case__"
+    #
+    #   @return [String] a copy of the _str_ converted to snake_case.
+    #
+    # @!method snakecase
+    #   Alias for {#snake_case}.
+    #
+    #   @return (see #snake_case)
+    #
+    module SnakeCase
+      refine ::String do
+        def snake_case
+          self.dup.tap do |s|
+            s.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+            s.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+            s.tr!('-', '_')
+            s.gsub!(/\s/, '_')
+            s.downcase!
+          end
+        end
+
+        alias_method :snakecase, :snake_case
+      end
+    end
+
     ##
     # @!method to_b
     #   Interprets common affirmative string meanings as +true+, otherwise
@@ -421,6 +510,7 @@ module Corefines
       alias_method :force_utf8!, :force_utf8
       alias_method :indent!, :indent
       alias_method :remove!, :remove
+      alias_method :snakecase, :snake_case
     end
   end
 end

data/lib/corefines/version.rb

@@ -1,3 +1,3 @@
 module Corefines
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/spec/string/camelcase_spec.rb

@@ -0,0 +1,69 @@
+describe String do
+  using Corefines::String::camelcase
+
+  describe '#camelcase' do
+
+    it "doesn't modify the original string" do
+      str = 'camel_case'
+      origo = str.dup
+      expect( str.camelcase ).to eq "camelCase"
+      expect( str ).to eq origo
+    end
+
+    context "default" do
+
+      it "capitalizes at underscore(s)" do
+        expect( 'camel__case_4you!'.camelcase ).to eq 'camelCase4you!'
+      end
+
+      it "capitalizes at white space(s)" do
+        expect( 'camel case  4 you!'.camelcase ).to eq 'camelCase4You!'
+        expect( "camel\tcase\t\t4you!".camelcase ).to eq 'camelCase4you!'
+      end
+    end
+
+    context "with string separator" do
+
+      it "capitalizes at the separator" do
+        expect( 'camel/case'.camelcase('/') ).to eq 'camelCase'
+      end
+
+      it "capitalizes at all of the given separators" do
+        expect( 'camel/case;allons-y!'.camelcase('/', ';', '-') ).to eq 'camelCaseAllonsY!'
+      end
+
+      it "capitalizes at multiple occurrences of the separator" do
+        expect( 'camel--case-here'.camelcase('-') ).to eq 'camelCaseHere'
+        expect( '-Camel--case-here-'.camelcase('-') ).to eq 'CamelCaseHere-'
+      end
+
+      it "capitalizes at occurrences of the multichar separator" do
+        expect( 'camel->case'.camelcase('->') ).to eq 'camelCase'
+      end
+    end
+
+    context "with regexp separator" do
+      it "capitalizes at matches of the regexp" do
+        expect( 'camel22case'.camelcase(/[0-9]+/) ).to eq 'camelCase'
+      end
+    end
+
+    context "with :lower" do
+      it "capitalizes and converts the first letter to lower case" do
+        expect( 'CAmeL Case'.camelcase(:lower) ).to eq 'cAmeLCase'
+      end
+    end
+
+    context "with :upper" do
+      it "capitalizes at default separators and converts the first letter to upper case" do
+        expect( 'camel_case yay'.camelcase(:upper) ).to eq 'CamelCaseYay'
+      end
+
+      context "and separator" do
+        it "capitalizes at the separator and converts the first letter to upper case" do
+          expect( 'camel-case'.camelcase(:upper, '-') ).to eq 'CamelCase'
+        end
+      end
+    end
+  end
+end

data/spec/string/snake_case_spec.rb

@@ -0,0 +1,40 @@
+describe String do
+  using Corefines::String[:snake_case, :snakecase]
+
+  describe '#snake_case' do
+
+    {
+      'snakeCase'  => 'snake_case',
+      'SnakeCase'  => 'snake_case',
+      'SNAkeCASe'  => 'sn_ake_ca_se',
+      'Snake2Case' => 'snake2_case',
+      'snake2case' => 'snake2case'
+    }
+    .each do |str, expected|
+      it "converts CamelCase to snake_case: #{str} => #{expected}" do
+        expect( str.snake_case ).to eq expected
+      end
+    end
+
+    it "converts white spaces to underscores" do
+      ["Sssnake Case  Yay!", "Sssnake\tCase\t\tYay!"].each do |str|
+        expect( str.snake_case ).to eq 'sssnake_case__yay!'
+      end
+    end
+
+    it "converts hyphens to underscores" do
+      expect( 'Sss-nake--case!'.snake_case ).to eq 'sss_nake__case!'
+    end
+
+    it "doesn't squeeze underscores" do
+      expect( '__snake__case__'.snake_case ).to eq '__snake__case__'
+    end
+
+    it "doesn't modify the original string" do
+      str = 'SnakeCase'
+      origo = str.dup
+      expect( str.snake_case ).to eq 'snake_case'
+      expect( str ).to eq origo
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corefines
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-03 00:00:00.000000000 Z
+date: 2015-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -141,6 +141,7 @@ files:
 - spec/object/then_spec.rb
 - spec/object/try_spec.rb
 - spec/spec_helper.rb
+- spec/string/camelcase_spec.rb
 - spec/string/color_spec.rb
 - spec/string/concat_spec.rb
 - spec/string/decolor_spec.rb
@@ -148,6 +149,7 @@ files:
 - spec/string/indent_spec.rb
 - spec/string/relative_path_from_spec.rb
 - spec/string/remove_spec.rb
+- spec/string/snake_case_spec.rb
 - spec/string/to_b_spec.rb
 - spec/string/to_re_spec.rb
 - spec/string/unindent_spec.rb