greed-summary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d98d96635d6ddcee1a888c3ac3f094b3f9bc6978
+  data.tar.gz: a5cda2b08b6646751be0ef990c34167e6a317746
+SHA512:
+  metadata.gz: 4f1c3184be4f671988e1805b2aab0fbd99b675984c893a5921871fe8cd9e4281e986f68655e044cfb321e76588eb82ce66eed7497406ae6b8cb62868d9205d9c
+  data.tar.gz: 174d7e7fd303f69d3acca74aab5cb2891df44f12dc7d4334880c7ed23565aa2d412bb7c3d915f90523eaccbee9225e33bfd588b390f68727a0988484510583fb

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Mac OS X
+
+*.DS_Store
+*.Spotlight-V100
+*.Trashes
+
+# RubyMine
+
+.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in greed-summary.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Bell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'greed-summary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install greed-summary
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/greed-summary.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "greed/summary"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/greed-summary

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "greed/summary"
+
+require 'getoptlong'
+
+opts = GetoptLong.new(
+    ['--title', '-t', GetoptLong::OPTIONAL_ARGUMENT],
+    ['--directory', '-d', GetoptLong::OPTIONAL_ARGUMENT],
+    ['--output', '-o', GetoptLong::OPTIONAL_ARGUMENT],
+    ['--ignore', '-i', GetoptLong::OPTIONAL_ARGUMENT],
+    ['--suffix', '-s', GetoptLong::OPTIONAL_ARGUMENT],
+    ['--style', '-S', GetoptLong::OPTIONAL_ARGUMENT],
+    ['--encode', '-e', GetoptLong::NO_ARGUMENT],
+    ['--autotitle', '-a', GetoptLong::NO_ARGUMENT],
+    ['--help', '-h', GetoptLong::NO_ARGUMENT],
+    ['--version', '-v', GetoptLong::NO_ARGUMENT]
+)
+
+$title = 'SUMMARY'
+$output = './SUMMARY.md'
+$directory = './'
+$ignore = ['resource', 'Resource']
+$suffix = ['.md', '.markdown']
+$encode = false
+$autotitle = false
+$style = 'github'
+
+opts.each do |opt, arg|
+  case opt
+    when '--title'
+      $title = arg
+    when '--directory'
+      $directory = arg
+    when '--output'
+      $output = arg
+    when '--ignore'
+      $ignore = arg
+    when '--suffix'
+      $suffix = arg
+    when '--style'
+      $style = arg
+    when '--autotitle'
+      $autotitle = true
+    when '--encode'
+      $encode = true
+    when '--help'
+      puts <<-EOF
+summary.rb [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
+      EOF
+      exit 0
+    when '--version'
+      puts  Greed::Summary::VERSION
+      exit 0
+  end
+end
+
+summary = Greed::Summary::GreedSummary.new($title,$output,$directory,$ignore,$suffix,$encode,$autotitle,$style)
+summary.run

data/greed-summary.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'greed/summary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "greed-summary"
+  spec.version       = Greed::Summary::VERSION
+  spec.authors       = ["Bell"]
+  spec.email         = ["bell@greedlab.com"]
+
+  spec.summary       = "generate summary for markdown."
+  spec.homepage      = "https://github.com/greedlab/greed-summary"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/greed/summary.rb

@@ -0,0 +1,161 @@
+require "greed/summary/version"
+require 'open-uri'
+
+module Greed
+  module Summary
+    # Your code goes here...
+    class GreedSummary
+      $readme = 'readme'
+        def initialize(title='SUMMARY', output='./SUMMARY.md', directory='./', ignore=['resource', 'Resource'],
+           suffix=['.md', '.markdown'], encode=false, autotitle=false, style='github')
+           @title = title
+           @output = output
+           @directory = directory
+           @ignore = ignore
+           @suffix = suffix
+           @encode = encode
+           @autotitle = autotitle
+           @style = style
+        end
+
+        def run
+          summary_file=File.new(File.join($output), "w+")
+          if !summary_file
+            puts "Unable to whrite summary_file!"
+            exit
+          end
+          unless File.directory? $directory
+            puts "Unable to open target_directory!"
+            exit
+          end
+          if $title != ""
+            summary_file.syswrite("# " + $title + "\n\n")
+          end
+          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|
+              readme = $readme + suffix
+              # puts("debug" + readme + " " + file.downcase)
+              if file.downcase.== readme
+                return file
+              end
+            end
+          end
+        end
+
+        def get_title(source_file)
+          # puts source_file
+          File.open(source_file, "r") do |file|
+            line = file.gets
+            while line && line == "\n"
+              line = file.gets
+            end
+            if !line
+              return nil
+            end
+            line = line.strip
+            if line[0, 1] == "#"
+              line = line[1, line.length - 1]
+            end
+            # puts line.strip
+            return line.strip
+          end
+        end
+
+        def summary_one_directory(summary, base, directory, ignore, deep)
+          # puts directory
+          if !File.directory?(directory)
+            return
+          end
+          Dir.foreach(directory) do |file|
+            # puts file
+            if file.index(".") == 0
+              next
+            end
+            fullPath = directory + "/" + file
+
+            baseLength = base.length
+            if base[baseLength - 1, 1] != "/"
+              baseLength += 1
+            end
+            relativePath = fullPath[baseLength, fullPath.length - baseLength]
+
+            # puts fullPath
+            if File.directory?(fullPath) # directory
+              if ignore.include?(file)
+                next
+              end
+
+              string = "    " * deep
+              if $style == "gitbook"
+                readme = get_readme(fullPath)
+                if readme
+                  relativePath = relativePath + "/" + readme
+                else
+                  relativePath = nil
+                end
+              end
+
+              if relativePath
+                if $encode
+                  relativePath = URI::encode(relativePath)
+                end
+                # puts("debug" + readme)
+                string = string + "* [" + file + "](" + relativePath + ")"
+              else
+                string = string + "* " + file
+              end
+
+              summary.syswrite(string + "\n")
+              # puts string
+              summary_one_directory(summary, base, fullPath, ignore, deep + 1)
+            else # file
+              if deep == 0 && file == "SUMMARY.md"
+                next
+              end
+              $suffix.each do |suffix|
+                length = suffix.length
+                if file[-length, length] != suffix
+                  next
+                end
+                # puts "debug" + file
+                name = file[0, file.length - length]
+                if name.downcase == $readme
+                  next
+                end
+                if ignore.include?(name)
+                  next
+                end
+
+                if $autotitle
+                  title = get_title(fullPath)
+                end
+
+                if !title || title.length == 0
+                  title = name
+                end
+                # puts fullPath
+                # puts title
+                baseLength = base.length
+                if base[baseLength - 1, 1] != "/"
+                  baseLength += 1
+                end
+                relativePath = fullPath[baseLength, fullPath.length - baseLength]
+                if $encode
+                  relativePath = URI::encode(relativePath)
+                end
+                string = "    " * deep + "* [" + title + "](" + relativePath + ")"
+                # puts string
+                summary.syswrite(string + "\n")
+              end
+            end
+          end
+        end
+    end
+  end
+end

data/lib/greed/summary/version.rb

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: greed-summary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- bell@greedlab.com
+executables:
+- greed-summary
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/greed-summary
+- greed-summary.gemspec
+- lib/greed/summary.rb
+- lib/greed/summary/version.rb
+homepage: https://github.com/greedlab/greed-summary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: generate summary for markdown.
+test_files: []
+has_rdoc: