corefines 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82c26f93d1bc1ddcc3dcb1c97969c68e8c0cef6f
-  data.tar.gz: 6054a13281a7d9fa3b271e0b0346807ad544ae13
+  metadata.gz: c7839672b793a5df3d5ffa892272260eccf0c0db
+  data.tar.gz: 0a263d7e00645c8451d93461bfe9ed81cd8ccc1c
 SHA512:
-  metadata.gz: c610bd41cde34fdb019703195c19e634581da8aea88ee5453e777f4479fc7d800b4a02fede7d99ef55c8cd17ec6dc3b26b63ccd4e2e514c02575265e84b4e2fe
-  data.tar.gz: 6bbc9e703f2e9f705340c7be511950f81d5e443cb3143cd2928d2c66dc14b330bbea79c0333100dd3015c2bd36b7797ee09663a8407a3c55621b74edf20396de
+  metadata.gz: 93f5a5a21061dea9e9aaddf7ea5520e7743a0c84c9635d42c63cdaed032fae12e328e141a60d40ac22ea7d986b3cda8a258374a583df7fdbcafbf7d8856bc317
+  data.tar.gz: 7b31c6b28bb018d1b0ee9fd9368922a0a282a545e461c0e6f488111ea0837abcdee533249d97560c7f31adc47aaf8cc2698fd4dc03bf353ce2435b226aef7e2d

data/CHANGELOG.adoc

@@ -3,6 +3,11 @@
 :doc-base-url: http://www.rubydoc.info/github/jirutka/corefines/Corefines
 :issue-uri: {repo-uri}/issues
 
+== 1.2.0 (2015-04-27)
+
+* Add new refinement {doc-base-url}/String/Indent[String#indent].
+
+
 == 1.1.0 (2015-04-25)
 
 * Add new refinement {doc-base-url}/String/ToB[String#to_b].

data/README.adoc

@@ -41,12 +41,12 @@ TODO
 Add this line to your application’s Gemfile:
 
 [source]
-gem 'corefines', '~> 1.0'
+gem 'corefines', '~> 1.2'
 
 or to your gemspec:
 
 [source]
-s.add_runtime_dependency 'corefines', '~> 1.0'
+s.add_runtime_dependency 'corefines', '~> 1.2'
 
 and then execute:
 
@@ -161,6 +161,7 @@ Not ideal indeed, but probably the best of what we can achieve.
 ** {doc-base-url}/String/Color[#color]
 ** {doc-base-url}/String/Concat[#concat]
 ** {doc-base-url}/String/Decolor[#decolor]
+** {doc-base-url}/String/Indent[#indent]
 ** {doc-base-url}/String/Remove[#remove]
 ** {doc-base-url}/String/ToB[#to_b]
 ** {doc-base-url}/String/Unindent[#unindent] (alias `#strip_heredoc`)

data/lib/corefines/string.rb

@@ -126,6 +126,50 @@ module Corefines
       end
     end
 
+    ##
+    # @!method indent(amount, indent_str = nil, indent_empty_lines = false)
+    #   Returns an indented copy of this string.
+    #
+    #   @example
+    #     "foo".indent(2)           # => "  foo"
+    #     "  foo".indent(2)         # => "    foo"
+    #     "foo\n\t\tbar".indent(2)  # => "\t\tfoo\n\t\t\t\tbar"
+    #     "foo".indent(2, '.')      # => "..foo"
+    #     "foo\n\nbar".indent(2)    # => "  foo\n\n  bar"
+    #     "foo\n\nbar".indent(2, nil, true)  # => "  foo\n  \n  bar"
+    #
+    #   @param amount [Fixnum] the indent size.
+    #   @param indent_str [String, nil] the indent character to use.
+    #          The default is +nil+, which tells the method to make a guess by
+    #          peeking at the first indented line, and fallback to a space if
+    #          there is none.
+    #   @param indent_empty_lines [Boolean] whether empty lines should be indented.
+    #   @return [String] a new string.
+    #
+    # @!method indent!(amount, indent_str = nil, indent_empty_lines = false)
+    #   Returns the indented string, or +nil+ if there was nothing to indent.
+    #   This is same as {#indent}, except it indents the receiver in-place.
+    #
+    #   @see #indent
+    #   @param amount (see #indent)
+    #   @param indent_str (see #indent)
+    #   @param indent_empty_lines (see #indent)
+    #   @return [String] self
+    #
+    module Indent
+      refine ::String do
+        def indent(amount, indent_str = nil, indent_empty_lines = false)
+          dup.tap { |str| str.indent! amount, indent_str, indent_empty_lines }
+        end
+
+        def indent!(amount, indent_str = nil, indent_empty_lines = false)
+          indent_str = indent_str || self[/^[ \t]/] || ' '
+          re = indent_empty_lines ? /^/ : /^(?!$)/
+          gsub! re, indent_str * amount
+        end
+      end
+    end
+
     ##
     # @!method remove(*patterns)
     #   Returns a copy of this string with *all* occurrences of the _patterns_
@@ -232,6 +276,7 @@ module Corefines
 
     class << self
       alias_method :concat!, :concat
+      alias_method :indent!, :indent
       alias_method :remove!, :remove
     end
   end

data/lib/corefines/version.rb

@@ -1,3 +1,3 @@
 module Corefines
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/string/indent_spec.rb

@@ -0,0 +1,48 @@
+describe String do
+  using Corefines::String::indent
+
+  describe '#indent' do
+
+    context "with default indent_str" do
+      context "string already indented with spaces" do
+        it "indents with spaces" do
+          expect( "foo\n  bar".indent(2) ).to eql "  foo\n    bar"
+        end
+      end
+
+      context "string already indented with tabs" do
+        it "indents with tabs" do
+          expect( "foo\n\tbar".indent(2) ).to eql "\t\tfoo\n\t\t\tbar"
+        end
+      end
+
+      context "string without indentation" do
+        it "indents with space" do
+          expect( "foo\nbar".indent(3) ).to eql "   foo\n   bar"
+        end
+      end
+
+      context "string that only contain newlines (edge cases)" do
+        it "doesn't indent at all" do
+          ['', "\n", "\n" * 7].each do |str|
+            expect( str.indent(8) ).to eql str
+            expect( str.indent(1, "\t") ).to eql str
+            expect( str.indent!(8) ).to be_nil
+          end
+        end
+      end
+    end
+
+    context "with indent_str" do
+      it "indents lines with the specified string" do
+        expect( "foo\n  bar".indent(2, '.') ).to eql "..foo\n..  bar"
+      end
+    end
+
+    context "with indent_empty_lines" do
+      it "indents all lines including empty ones" do
+        expect( "foo\n\nbar".indent(2, nil, true) ).to eql "  foo\n  \n  bar"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corefines
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -142,6 +142,7 @@ files:
 - spec/string/color_spec.rb
 - spec/string/concat_spec.rb
 - spec/string/decolor_spec.rb
+- spec/string/indent_spec.rb
 - spec/string/remove_spec.rb
 - spec/string/to_b_spec.rb
 - spec/string/unindent_spec.rb