sc2md 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08ffc90e06c5e78fca5aece37673ce50c266d3a649649602cb5e19a963385b1f'
-  data.tar.gz: 8d56680acbccf7327cfeec94d33efeef45ba4f89d4bfa02c458297039af1afeb
+  metadata.gz: fcf0d136870976d4f48bf1c71e2558d8faa225e109c588efa6c837962ac30261
+  data.tar.gz: 625b45e31301ff37ff35cfab2542ec684d688f508cc358efbaa68719ded1cc4a
 SHA512:
-  metadata.gz: 9ce3730fb018005809b8a7f21bf9434876b331aa68ed2fe09dba99e830f27244ef3f3c61d2b42c8129a0241081009f8f4e881db998d89fc11940858d46a8036b
-  data.tar.gz: 78380838d9eba3a20a1c7cbae9f276f0dd236a5bded5e7f8e26206b89318e0790b9953414476da0a167ee9a5ff97e07cdf66efece5bae440034237a766db1d54
+  metadata.gz: 0da1540ec755f0c55267253c4f475b1986e0c0d91c6632f7376d4a14845e732d25587c05e3530f4c25d073a6b4b6554eddf6be19bf3bc72de9aa29d86d24f9cd
+  data.tar.gz: 1ce7161e45700745a6ff18f987689c1d956d10f50bd807ae06304315db96cc33353f1941db99f8024fd12dbf490e9049375d4ee910b73991dd81424c0661411a

data/.rubygems.url

@@ -1 +1 @@
-https://rubygems.org/gems/script2md
+https://rubygems.org/gems/sc2md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sc2md (1.1.3)
+    sc2md (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,8 @@
-# Script2md
+# sc2md
 
-It is a Simple Ruby gem.
+Simple Ruby gem.
+
+It means **Script to Markdown**.
 
 Convert script file ( e.g `.sh` `.rb` ) to Markdown file.
 
@@ -11,17 +13,9 @@ It just only replace script comment line with markdown plain text, and script co
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'script2md'
+gem 'sc2md'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install script2md
-
 ## Usage
 
 ### Command 
@@ -33,10 +27,16 @@ sc2md spec/fixtures/example.sh
 or
 
 ```
-sc2md https://raw.githubusercontent.com/YumaInaura/script2md/master/spec/fixtures/example.sh
+sc2md https://raw.githubusercontent.com/YumaInaura/sc2md/master/spec/fixtures/example.sh
 ```
 
-### IN FILE
+#### Output to file
+
+```
+sc2md spec/fixtures/example.sh > converted.md
+```
+
+### Input file example
 
 ```sh
 #!/bin/bash -eu
@@ -58,7 +58,7 @@ echo some command
 echo "i wanna conver to markdown this file"
 ```
 
-### OUT FILE
+### Output file example
 
     ```
     # Header1
@@ -91,4 +91,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-

data/example.sh

@@ -1,3 +1,16 @@
-#!/bin/bash -eux
+#!/bin/bash -eu
 
-bundle exec ruby exe/sc2md spec/fixtures/example.sh
+for script_file in $(find ./spec/fixtures -type f -maxdepth 1 | grep -v '\.md'); do
+  echo "============================"
+  echo "Convert $script_file"
+
+  echo "----------------------------"
+  echo "Input"
+  echo "----------------------------"
+  cat "$script_file"
+
+  echo "----------------------------"
+  echo "Output"
+  echo "----------------------------"
+  bundle exec ruby exe/sc2md "$script_file"
+done

data/lib/script2md.rb

@@ -2,17 +2,14 @@ require "script2md/version"
 
 module Script2md
   def self.convert(text, language_type: nil)
-    # FIXME: Prevent gsub! break original text value
-    original_script_text = text.clone
-
     output = Convert.new(text, language_type: language_type).convert.text
-    output = Fill.new(output, script: original_script_text).convert.text
+    output = Fill.new(output, script: text).convert.text
     output
   end
 
   class Convert
     def initialize(text, language_type: nil)
-      @text = text
+      @text = text.clone
       @language_type = language_type
     end
 
@@ -35,12 +32,12 @@ module Script2md
     end
 
     def code_into_codeblock!
-      text.gsub!(/(^(?!#).+$\n?)((^(?!#).*$\n?)*(^(?!#).+$))?/, "```#{language_type}\n\\0\n```")
+      text.gsub!(/(^(?!##).+$\n?)((^(?!##).*$\n?)*(^(?!##).+$))?/, "```#{language_type}\n\\0\n```")
     end
 
     def headling_comment_to_plaintext!
-      text.gsub!(/^#\s+?$/, "")
-      text.gsub!(/^#\s+?([^\n\r]+)$/, "\\1")
+      text.gsub!(/^##\s+?$/, "")
+      text.gsub!(/^##\s+?([^\n\r]+)$/, "\\1")
     end
 
     def format!
@@ -50,7 +47,7 @@ module Script2md
 
   class Fill
     def initialize(text, script: nil)
-      @text = text
+      @text = text.clone
       @script = script
     end
 

data/lib/script2md/version.rb

@@ -1,3 +1,3 @@
 module Script2md
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sc2md
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Yumainaura
@@ -74,7 +74,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- "+x"
 - ".github.url"
 - ".gitignore"
 - ".rspec"