tbpgr_utils 0.0.107 → 0.0.108

data/README.md

@@ -99,7 +99,8 @@ Or install it yourself as:
 |[MarkdownString.heading4](#markdownstringheading4)                                                                 |Return markdown heading level4 from text                                                                             |
 |[MarkdownString.heading5](#markdownstringheading5)                                                                 |Return markdown heading level5 from text                                                                             |
 |[MarkdownString.heading6](#markdownstringheading6)                                                                 |Return markdown heading level6 from text                                                                             |
-|[MarkdownString.ul](#markdownstringul)                                                                             |Return markdown ul from arrau                                                                                        |
+|[MarkdownString.ol](#markdownstringol)                                                                             |Return markdown ol from array                                                                                        |
+|[MarkdownString.ul](#markdownstringul)                                                                             |Return markdown ul from array                                                                                        |
 |[MetasyntacticVariable](#metasyntacticvariable)                                                                    |META variable, META variable for classes                                                                             |
 |[TbpgrUtils Module.alias_methods](#modulealias_methods)                                                            |create alias methods                                                                                                 |
 |[TbpgrUtils Numeric#dice_back](#numericdice_back)                                                                  |return dice back number                                                                                              |
@@ -2352,6 +2353,45 @@ MarkdownString.heading6(12345) # => "###### 12345"
 
 [back to list](#list)
 
+### MarkdownString.ol
+case list  
+~~~ruby
+require 'markdown_string'
+MarkdownString.ol(%w{a b c})
+~~~
+
+result  
+~~~
+1. a
+1. b
+1. c
+~~~
+
+case not list  
+~~~ruby
+require 'markdown_string'
+MarkdownString.ol("test") # => "test"
+
+case nil list  
+~~~ruby
+require 'markdown_string'
+MarkdownString.ol([nil, nil])
+~~~
+
+result  
+~~~
+1. 
+1. 
+~~~
+
+case empty list  
+~~~ruby
+require 'markdown_string'
+MarkdownString.ol([]) # => ""
+~~~
+
+[back to list](#list)
+
 ### MarkdownString.ul
 case list  
 ~~~ruby
@@ -2374,7 +2414,7 @@ MarkdownString.ul("test") # => "test"
 case nil list  
 ~~~ruby
 require 'markdown_string'
-  MarkdownString.ul([nil, nil])
+MarkdownString.ul([nil, nil])
 ~~~
 
 result  
@@ -3385,6 +3425,7 @@ if you are Sublime Text2 user, you can use snippet for TbpgrUtils.
 https://github.com/tbpgr/tbpgr_utils_snippets
 
 ## History
+* version 0.0.108 : add MarkdownString#ol
 * version 0.0.107 : add MarkdownString#ul
 * version 0.0.106 : add MarkdownString#heading3, heading4, heading5, heading6
 * version 0.0.105 : add MarkdownString#heading2

data/lib/markdown/ol.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+class MarkdownString
+  # Return markdown heading level1-6 from text
+  #
+  # === Example
+  #
+  # case list
+  #
+  #   MarkdownString.ol(%w{a b c})
+  #
+  # resolt
+  #
+  #   1. a
+  #   1. b
+  #   1. c
+  #
+  # case not list
+  #
+  #   MarkdownString.ol("test") # => "test"
+  #
+  # case nil list
+  #
+  #   MarkdownString.ol([nil, nil])
+  #
+  # resolt
+  #
+  #   1.
+  #   1.
+  #
+  # case empty list
+  #
+  #   MarkdownString.ol([]) # => ""
+  #
+  def self.ol(list)
+    return list unless list.is_a?(Array)
+    return '' if list.empty?
+    list.reduce([]) do |ret, elm|
+      elm = '' if elm.nil?
+      ret << "1. #{elm}"
+      ret
+    end.join("\n") + "\n"
+  end
+end

data/lib/markdown_string.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
 
 require 'markdown/heading'
+require 'markdown/ol'
 require 'markdown/ul'

data/lib/tbpgr_utils/version.rb

@@ -2,5 +2,5 @@
 
 # Tbpgr Utilities
 module TbpgrUtils
-  VERSION = '0.0.107'
+  VERSION = '0.0.108'
 end

data/spec/markdown/ol_spec.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'markdown/ol'
+
+describe MarkdownString do
+  context :ol do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'array case',
+        input: %w{a b c},
+        expected: <<-EOS
+1. a
+1. b
+1. c
+        EOS
+      },
+      {
+        case_no: 2,
+        case_title: 'not list case',
+        input: 'hoge',
+        expected: 'hoge',
+      },
+      {
+        case_no: 3,
+        case_title: 'empty list case',
+        input: [],
+        expected: '',
+      },
+      {
+        case_no: 4,
+        case_title: 'each element nil case',
+        input: [nil, nil, nil],
+        expected: <<-EOS
+1. 
+1. 
+1. 
+        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 = MarkdownString.ol c[:input]
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        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

data/spec/markdown/ul_spec.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'markdown/ul'
+
+describe MarkdownString do
+  context :ul do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'array case',
+        input: %w{a b c},
+        expected: <<-EOS
+* a
+* b
+* c
+        EOS
+      },
+      {
+        case_no: 2,
+        case_title: 'not list case',
+        input: 'hoge',
+        expected: 'hoge',
+      },
+      {
+        case_no: 3,
+        case_title: 'empty list case',
+        input: [],
+        expected: '',
+      },
+      {
+        case_no: 4,
+        case_title: 'each element nil case',
+        input: [nil, nil, nil],
+        expected: <<-EOS
+* 
+* 
+* 
+        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 = MarkdownString.ul c[:input]
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        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.107
+  version: 0.0.108
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &21118152 !ruby/object:Gem::Requirement
+  requirement: &24532488 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 4.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *21118152
+  version_requirements: *24532488
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &21117864 !ruby/object:Gem::Requirement
+  requirement: &24532200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *21117864
+  version_requirements: *24532200
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21117636 !ruby/object:Gem::Requirement
+  requirement: &24531972 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21117636
+  version_requirements: *24531972
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21117312 !ruby/object:Gem::Requirement
+  requirement: &24531648 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *21117312
+  version_requirements: *24531648
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &21117012 !ruby/object:Gem::Requirement
+  requirement: &24531348 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *21117012
+  version_requirements: *24531348
 description: Utilities
 email:
 - tbpgr@tbpgr.jp
@@ -109,6 +109,7 @@ files:
 - lib/familyable/person.rb
 - lib/ghostable.rb
 - lib/markdown/heading.rb
+- lib/markdown/ol.rb
 - lib/markdown/ul.rb
 - lib/markdown_string.rb
 - lib/metasyntactic_variable.rb
@@ -233,6 +234,8 @@ files:
 - spec/familyable/familyable_spec.rb
 - spec/ghostable_spec.rb
 - spec/markdown/heading_spec.rb
+- spec/markdown/ol_spec.rb
+- spec/markdown/ul_spec.rb
 - spec/metasyntactic_variable_spec.rb
 - spec/open_classes/array/to_html_table_spec.rb
 - spec/open_classes/array/to_table_spec.rb
@@ -371,6 +374,8 @@ test_files:
 - spec/familyable/familyable_spec.rb
 - spec/ghostable_spec.rb
 - spec/markdown/heading_spec.rb
+- spec/markdown/ol_spec.rb
+- spec/markdown/ul_spec.rb
 - spec/metasyntactic_variable_spec.rb
 - spec/open_classes/array/to_html_table_spec.rb
 - spec/open_classes/array/to_table_spec.rb