tbpgr_utils 0.0.38 → 0.0.39

data/README.md

@@ -69,6 +69,7 @@ Or install it yourself as:
 |[TbpgrUtils Object#my_methods](#objectmy_methods)                                                                  |return public/protected/private self define methods                                                                  |
 |[TbpgrUtils Object#to_bool](#objectto_bool)                                                                        |syntax sugar of !!. convert [false, nil] => fasel, other => true.                                                    |
 |[TbpgrUtils String#justify_table](#stringjustify_table)                                                            |justify pipe format table string                                                                                     |
+|[TbpgrUtils String#surround](#stringsurround)                                                                      |surround string                                                                                                      |
 |[Templatable module](#templatable)                                                                                 |get result from template + placeholder                                                                               |
 |[TemplateMethodable module](#templatemethodable)                                                                   |for Template Method Pattern                                                                                          |
 
@@ -1364,6 +1365,55 @@ output
 
 [back to list](#list)
 
+### String#surround
+single line, no option case
+
+~~~ruby
+require 'tbpgr_utils'
+'hoge'.surround
+~~~
+
+result
+
+~~~
+------
+|hoge|
+------
+~~~
+
+multi line, no option case
+
+~~~ruby
+require 'tbpgr_utils'
+"hoge\na".surround
+~~~
+
+result
+
+~~~
+------
+|hoge|
+|a   |
+------
+~~~
+
+single line, both option case
+
+~~~ruby
+require 'tbpgr_utils'
+'hoge'.surround top_bottom: '=', side: '!'
+~~~
+
+result
+
+~~~
+======
+!hoge!
+======
+~~~
+
+[back to list](#list)
+
 ### Templatable
 * include Templatable
 * set template by here-document
@@ -1464,6 +1514,7 @@ if you are Sublime Text2 user, you can use snippet for TbpgrUtils.
 https://github.com/tbpgr/tbpgr_utils_snippets
 
 ## History
+* version 0.0.39 : add String#surround.
 * version 0.0.38 : add Array#together_shuffle(alias tshuffle).
 * version 0.0.37 : add Array#together_sample(alias tsample).
 * version 0.0.36 : add Array#together_reverse,Array#together_reverse!(alias treverse, alias treverse!).

data/lib/open_classes/string/justify_table.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+# String
+class String
+  # Justify pipe using table format
+  #
+  # before justify
+  #
+  #   |* first name|* family name|
+  #   |eiichiro|oda|
+  #   |akira|toriyama|
+  #   |yusei|matsui|
+  #
+  # after justify
+  #
+  #   |* first name|* family name|
+  #   |eiichiro    |oda          |
+  #   |akira       |toriyama     |
+  #   |yusei       |matsui       |
+  def justify_table
+    return self if self.empty?
+    max_sizes = get_column_maxes
+    return self if max_sizes.nil?
+    justify_lines max_sizes
+  end
+
+  private
+
+  def get_column_maxes
+    max_sizes = []
+    each_line do |line|
+      return nil unless table? line
+      columns = get_columuns(line)
+      max_sizes = get_column_max(columns, max_sizes)
+    end
+    max_sizes
+  end
+
+  def justify_lines(max_sizes)
+    ret = []
+    each_line do |line|
+      columns = get_columuns(line)
+      line_ret = []
+      columns.each_with_index do |column, cnt|
+        line_ret << column.ljust(max_sizes[cnt])
+      end
+      ret << "|#{line_ret.join('|')}|"
+    end
+    ret.join("\n") + "\n"
+  end
+
+  def get_columuns(line)
+    line.split('|')[1..-2]
+  end
+
+  def get_column_max(columns, max_sizes)
+    columns.each_with_index do |column, index|
+      current_size = column.size
+      if max_sizes[index].nil?
+        max_sizes << current_size
+        next
+      end
+      max_sizes[index] = current_size if current_size > max_sizes[index]
+    end
+    max_sizes
+  end
+
+  def table?(text)
+    text.count('|') > 0
+  end
+end

data/lib/open_classes/string/surround.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+# String
+class String
+  # surround string.
+  #
+  # ==== Options
+  #
+  # * <tt>:top_bottom</tt> - set top and bottom charactor
+  # * <tt>:side</tt> - set right and left charactor
+  #
+  # ==== Examples
+  #
+  # single line, no option case
+  #
+  #   'hoge'.surround
+  #
+  # result
+  #
+  #   ------
+  #   |hoge|
+  #   ------
+  #
+  # multi line, no option case
+  #
+  #   "hoge\na".surround
+  #
+  # result
+  #
+  #   ------
+  #   |hoge|
+  #   |a   |
+  #   ------
+  #
+  # single line, both option case
+  #
+  #   'hoge'.surround top_bottom: '=', side: '!'
+  #
+  # result
+  #
+  #   ======
+  #   !hoge!
+  #   ======
+  #
+  def surround(options = { top_bottom: '-', side: '|' })
+    top_bottom = init_top_bottom(options)
+    side = init_side(options)
+    inner_width = line_max
+    top_bottom = top_bottoms(top_bottom, inner_width)
+    ret = *each_line.reduce(["#{top_bottom}"]) { |ret, line|ret << "#{side}#{line.chomp.ljust(inner_width)}#{side}" }
+    ret.push("#{top_bottom}").join("\n")
+  end
+
+  private
+
+  def init_top_bottom(options)
+    options[:top_bottom].nil? ? '-' : options[:top_bottom]
+  end
+
+  def init_side(options)
+    options[:side].nil? ? '|' : options[:side]
+  end
+
+  def top_bottoms(top_bottom, inner_width)
+    top_bottom * (inner_width + 2)
+  end
+
+  def line_max
+    return 0 if self.empty?
+    each_line.max_by { |v|v.size }.chomp.size
+  end
+end

data/lib/open_classes/string.rb

@@ -1,71 +1,3 @@
 # encoding: utf-8
-
-# String
-class String
-  # Justify pipe using table format
-  #
-  # before justify
-  #
-  #   |* first name|* family name|
-  #   |eiichiro|oda|
-  #   |akira|toriyama|
-  #   |yusei|matsui|
-  #
-  # after justify
-  #
-  #   |* first name|* family name|
-  #   |eiichiro    |oda          |
-  #   |akira       |toriyama     |
-  #   |yusei       |matsui       |
-  def justify_table
-    return self if self.empty?
-    max_sizes = get_column_maxes
-    return self if max_sizes.nil?
-    justify_lines max_sizes
-  end
-
-  private
-
-  def get_column_maxes
-    max_sizes = []
-    each_line do |line|
-      return nil unless table? line
-      columns = get_columuns(line)
-      max_sizes = get_column_max(columns, max_sizes)
-    end
-    max_sizes
-  end
-
-  def justify_lines(max_sizes)
-    ret = []
-    each_line do |line|
-      columns = get_columuns(line)
-      line_ret = []
-      columns.each_with_index do |column, cnt|
-        line_ret << column.ljust(max_sizes[cnt])
-      end
-      ret << "|#{line_ret.join('|')}|"
-    end
-    ret.join("\n") + "\n"
-  end
-
-  def get_columuns(line)
-    line.split('|')[1..-2]
-  end
-
-  def get_column_max(columns, max_sizes)
-    columns.each_with_index do |column, index|
-      current_size = column.size
-      if max_sizes[index].nil?
-        max_sizes << current_size
-        next
-      end
-      max_sizes[index] = current_size if current_size > max_sizes[index]
-    end
-    max_sizes
-  end
-
-  def table?(text)
-    text.count('|') > 0
-  end
-end
+require 'open_classes/string/justify_table'
+require 'open_classes/string/surround'

data/lib/tbpgr_utils/version.rb

@@ -2,5 +2,5 @@
 
 # Tbpgr Utilities
 module TbpgrUtils
-  VERSION = '0.0.38'
+  VERSION = '0.0.39'
 end

data/rubocop-todo.yml

@@ -5,9 +5,6 @@
 AccessModifierIndentation:
   Enabled: false
 
-ClassLength:
-  Enabled: false
-
 Documentation:
   Enabled: false
 
@@ -41,7 +38,7 @@ ParenthesesAroundCondition:
 RaiseArgs:
   Enabled: false
 
-Semicolon:
+ReduceArguments:
   Enabled: false
 
 ShadowingOuterLocalVariable:

data/spec/open_classes/string/surround_spec.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'tbpgr_utils'
+
+describe String do
+  context :surround do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'single line, no option case',
+        input: 'hoge',
+        expected: <<-EOS
+------
+|hoge|
+------
+        EOS
+      },
+      {
+        case_no: 2,
+        case_title: 'multi line, no option case',
+        input: "hoge\na",
+        expected: <<-EOS
+------
+|hoge|
+|a   |
+------
+        EOS
+      },
+      {
+        case_no: 3,
+        case_title: 'empty, no option case',
+        input: '',
+        expected: <<-EOS
+--
+--
+        EOS
+      },
+      {
+        case_no: 4,
+        case_title: 'single line, both option case',
+        input: 'hoge',
+        options: { top_bottom: '=', side: '!' },
+        expected: <<-EOS
+======
+!hoge!
+======
+        EOS
+      },
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          # nothing
+
+          # -- when --
+          actual = c[:options] ? c[:input].surround(c[:options]) : c[:input].surround
+
+          # -- then --
+          expect(actual).to eq(c[:expected].chop)
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tbpgr_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.38
+  version: 0.0.39
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &26179104 !ruby/object:Gem::Requirement
+  requirement: &27926328 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 4.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *26179104
+  version_requirements: *27926328
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &26178816 !ruby/object:Gem::Requirement
+  requirement: &27926040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *26178816
+  version_requirements: *27926040
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &26178588 !ruby/object:Gem::Requirement
+  requirement: &27925812 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *26178588
+  version_requirements: *27925812
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &26178264 !ruby/object:Gem::Requirement
+  requirement: &27925488 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *26178264
+  version_requirements: *27925488
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &26177964 !ruby/object:Gem::Requirement
+  requirement: &27925188 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *26177964
+  version_requirements: *27925188
 description: Utilities
 email:
 - tbpgr@tbpgr.jp
@@ -116,6 +116,8 @@ files:
 - lib/open_classes/module.rb
 - lib/open_classes/object.rb
 - lib/open_classes/string.rb
+- lib/open_classes/string/justify_table.rb
+- lib/open_classes/string/surround.rb
 - lib/tbpgr_utils.rb
 - lib/tbpgr_utils/version.rb
 - lib/templatable.rb
@@ -154,7 +156,8 @@ files:
 - spec/open_classes/kernel_spec.rb
 - spec/open_classes/module_spec.rb
 - spec/open_classes/object_spec.rb
-- spec/open_classes/string_spec.rb
+- spec/open_classes/string/justify_table_spec.rb
+- spec/open_classes/string/surround_spec.rb
 - spec/spec_helper.rb
 - spec/templatable_spec.rb
 - spec/template_methodable_spec.rb
@@ -217,7 +220,8 @@ test_files:
 - spec/open_classes/kernel_spec.rb
 - spec/open_classes/module_spec.rb
 - spec/open_classes/object_spec.rb
-- spec/open_classes/string_spec.rb
+- spec/open_classes/string/justify_table_spec.rb
+- spec/open_classes/string/surround_spec.rb
 - spec/spec_helper.rb
 - spec/templatable_spec.rb
 - spec/template_methodable_spec.rb