greed-summary 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d98d96635d6ddcee1a888c3ac3f094b3f9bc6978
-  data.tar.gz: a5cda2b08b6646751be0ef990c34167e6a317746
+  metadata.gz: 4fb76e1dd7fd4e72fbbd3d2a78e9dc93a3d316c1
+  data.tar.gz: 72974b2ad6420d553ff29d459dde02bc98db683b
 SHA512:
-  metadata.gz: 4f1c3184be4f671988e1805b2aab0fbd99b675984c893a5921871fe8cd9e4281e986f68655e044cfb321e76588eb82ce66eed7497406ae6b8cb62868d9205d9c
-  data.tar.gz: 174d7e7fd303f69d3acca74aab5cb2891df44f12dc7d4334880c7ed23565aa2d412bb7c3d915f90523eaccbee9225e33bfd588b390f68727a0988484510583fb
+  metadata.gz: d0697a34cf9497ecf005ac8d44da1e17672c82df21fe781574d70696318a2d919b5cfab2bb542380f344428172a022247fbae67ec348b5578f42c6e73bbc37f4
+  data.tar.gz: 3602c8fcd1108461d86389e3ae8a281744b5b3c4cb02116581630097e64fc85ec37f6b1822caa271a1356b9d10a43e8c39f24b6ec7e9768770d279a00d64681a

data/README.md

@@ -1,8 +1,6 @@
 # Greed::Summary
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/greed/summary`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+generate `SUMMARY.md` for Github or Gitbook
 
 ## Installation
 
@@ -22,7 +20,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+greed-summary [OPTION]
+
+-t, --title [string]:
+   title ,default 'SUMMARY'
+
+-d, --directory [directory path]:
+   target directory path ,default './'
+
+-o, --output [file path]:
+   output file path ,default './SUMMARY.md'
+
+-i, --ignore [array]:
+   ignore string array ,default '['resource', 'Resource']'
+
+-s, --suffix [array]:
+   suffix string array ,default '['.md', '.markdown']'
+
+-S, --style [string]:
+   output style ,could be 'github' or 'gitbook', default 'github'
+
+-a, --autotitle:
+   auto set title through file content
+
+-e, --encode:
+   url encode
+
+-h, --help:
+   show help
+
+-v, --version:
+   show version
+```
 
 ## Development
 
@@ -32,7 +62,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/greed-summary.
+Bug reports and pull requests are welcome on GitHub at https://github.com/greedlab/greed-summary.
 
 
 ## License

data/exe/greed-summary

@@ -47,7 +47,7 @@ opts.each do |opt, arg|
       $encode = true
     when '--help'
       puts <<-EOF
-summary.rb [OPTION]
+greed-summary [OPTION]
 
 -t, --title [string]:
    title ,default 'SUMMARY'

data/lib/greed/summary/version.rb

@@ -1,5 +1,5 @@
 module Greed
   module Summary
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

data/lib/greed/summary.rb

@@ -19,26 +19,26 @@ module Greed
         end
 
         def run
-          summary_file=File.new(File.join($output), "w+")
+          summary_file=File.new(File.join(@output), "w+")
           if !summary_file
             puts "Unable to whrite summary_file!"
             exit
           end
-          unless File.directory? $directory
+          unless File.directory? @directory
             puts "Unable to open target_directory!"
             exit
           end
-          if $title != ""
-            summary_file.syswrite("# " + $title + "\n\n")
+          if @title != ""
+            summary_file.syswrite("# " + @title + "\n\n")
           end
-          summary_one_directory(summary_file, $directory, $directory, $ignore, 0)
-          puts $output
+          summary_one_directory(summary_file, @directory, @directory, @ignore, 0)
+          puts @output
         end
 
         def get_readme(directory)
           # puts("debug" + directory)
           Dir.foreach(directory) do |file|
-            $suffix.each do |suffix|
+            @suffix.each do |suffix|
               readme = $readme + suffix
               # puts("debug" + readme + " " + file.downcase)
               if file.downcase.== readme
@@ -92,7 +92,7 @@ module Greed
               end
 
               string = "    " * deep
-              if $style == "gitbook"
+              if @style == "gitbook"
                 readme = get_readme(fullPath)
                 if readme
                   relativePath = relativePath + "/" + readme
@@ -102,7 +102,7 @@ module Greed
               end
 
               if relativePath
-                if $encode
+                if @encode
                   relativePath = URI::encode(relativePath)
                 end
                 # puts("debug" + readme)
@@ -118,7 +118,7 @@ module Greed
               if deep == 0 && file == "SUMMARY.md"
                 next
               end
-              $suffix.each do |suffix|
+              @suffix.each do |suffix|
                 length = suffix.length
                 if file[-length, length] != suffix
                   next
@@ -132,7 +132,7 @@ module Greed
                   next
                 end
 
-                if $autotitle
+                if @autotitle
                   title = get_title(fullPath)
                 end
 
@@ -146,7 +146,7 @@ module Greed
                   baseLength += 1
                 end
                 relativePath = fullPath[baseLength, fullPath.length - baseLength]
-                if $encode
+                if @encode
                   relativePath = URI::encode(relativePath)
                 end
                 string = "    " * deep + "* [" + title + "](" + relativePath + ")"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greed-summary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler