doc-digger 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17164d4df2f3a412e76adcfeae6d4d10328f28bc
-  data.tar.gz: be414103a11f78c85ad4d4914a3b96f896045e54
+  metadata.gz: 3e4efff0f3943fa58408708569f8193c93e58003
+  data.tar.gz: 313168a6f88256bd4355963c2f0a410670d2d952
 SHA512:
-  metadata.gz: 3f4de6a9a70659a912341a5a4043a50a9ad7cefddee6164eb6eb481728568fb58d0a0b65da544f76955f040953106a9b03eefa86beb1bb8fbaab4dc62133615c
-  data.tar.gz: d2dcaab2fa40f572334d1f344ad185a475821c3f4a1760256623bd82402dc6757fbfde44731c9fa4f679beafc9e49fe5db86bc62664a5760d62009efeb50c3b7
+  metadata.gz: 80529ae19ab34fe5d4b0cae56546e8a2775b72d52e72c47eaf79a7c5fb636d7e36176fb079d801de9ffa4b1ca42c60b793e4f7b081b8170dbc9162af733e7759
+  data.tar.gz: 17cf1c3a102d8bf785b59279cee95e84658d87b5b05338f7792978b9c8b303aa92e0d5bb2136275a7bbc8fca2d73b9f7d6841b13886801666228ae6f40312474

data/README.md

@@ -1,14 +1,12 @@
 # DocDigger
 
 [![Build Status](https://travis-ci.org/wootaw/doc-digger.svg?branch=master)](https://travis-ci.org/wootaw/doc-digger)
-[![Gem Version](https://badge.fury.io/rb/doc-digger.png)](http://badge.fury.io/rb/doc-digger)
+[![Gem Version](https://badge.fury.io/rb/doc-digger.svg)](https://badge.fury.io/rb/doc-digger)
 [![Code Climate](https://codeclimate.com/github/wootaw/doc-digger/badges/gpa.svg)](https://codeclimate.com/github/wootaw/doc-digger)
 [![Test Coverage](https://codeclimate.com/github/wootaw/doc-digger/badges/coverage.svg)](https://codeclimate.com/github/wootaw/doc-digger/coverage)
 
 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/doc-digger`. 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:
@@ -27,7 +25,7 @@ Or install it yourself as:
 
 ## Basic Usage
 
-DocDigger is a tool for generating RESTful web API documentation by analyzing block comments. Below is a simple example showing some of the more common features of DocDigger in documenting parts of the Twitter API that created by Grape.
+DocDigger is a tool for generating RESTful web API documentation by analyzing block comments in source code. Below is a simple example showing some of the more common features of DocDigger in documenting parts of the Twitter API that created by Grape.
 
 ```ruby
 module Twitter

data/doc-digger.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["wootaw@gmail.com"]
 
   spec.summary       = "This gem generate RESTful web API documentation."
-  spec.description   = "RESTWoods is a tool for generating RESTful web API documentation by analyzing block comments."
+  spec.description   = "DocDigger is a tool for generating RESTful web API documentation by analyzing block comments in source code."
   spec.homepage      = "https://github.com/wootaw/doc-digger"
   spec.license       = "MIT"
 
@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-remote", '~> 0'
   spec.add_development_dependency "pry-nav", '~> 0'
   spec.add_development_dependency "codeclimate-test-reporter", '~> 0.4.8'
+  spec.add_development_dependency "git", '~> 1'
 end

data/lib/doc-digger.rb

@@ -1,9 +1,28 @@
 require "base64"
 require "json"
+require "git"
 require "doc-digger/version"
 require "doc-digger/line_parser"
 require "doc-digger/file_parser"
+require "doc-digger/scan"
 
-module DocDigger
-  # Your code goes here...
+class String
+  # def black;          "\033[30m#{self}\033[0m" end
+  # def red;            "\033[31m#{self}\033[0m" end
+  def green;          "\033[32m#{self}\033[0m" end
+  # def brown;          "\033[33m#{self}\033[0m" end
+  def blue;           "\033[34m#{self}\033[0m" end
+  # def magenta;        "\033[35m#{self}\033[0m" end
+  # def cyan;           "\033[36m#{self}\033[0m" end
+  # def gray;           "\033[37m#{self}\033[0m" end
+  # def bg_black;       "\033[40m#{self}\033[0m" end
+  # def bg_red;         "\033[41m#{self}\033[0m" end
+  # def bg_green;       "\033[42m#{self}\033[0m" end
+  # def bg_brown;       "\033[43m#{self}\033[0m" end
+  # def bg_blue;        "\033[44m#{self}\033[0m" end
+  # def bg_magenta;     "\033[45m#{self}\033[0m" end
+  # def bg_cyan;        "\033[46m#{self}\033[0m" end
+  # def bg_gray;        "\033[47m#{self}\033[0m" end
+  # def bold;           "\033[1m#{self}\033[22m" end
+  # def reverse_color;  "\033[7m#{self}\033[27m" end
 end

data/lib/doc-digger/line_parser.rb

@@ -3,7 +3,7 @@ module DocDigger
 
     PICKS = { java: /\A\s*\*/, erlang: /\A\s*%/, perl: /\A\s*#/ }
     COMMANDS = /\A@(doc(\_state)?|res(\_(param|response|state|bind))?|cmd\_(def|use))\Z/
-    PARAMETER_LOCATIONS = /\Apath|query|header|form|body\Z/
+    PARAMETER_LOCATIONS = /\Apath|query|header|form|body|cookie\Z/
     RESPONSE_LOCATIONS = /\Aheader|body\Z/
 
     def initialize(str, clazz)

data/lib/doc-digger/scan.rb

@@ -0,0 +1,30 @@
+module DocDigger
+
+  def self.scan(root, files='*')
+    all = []
+    Dir[File.join(root, "**/#{files}")].each do |fn|
+      dp = DocDigger::FileParser.new(fn)
+      docs = dp.results
+      if docs.length == 0
+        print ".".blue
+      else
+        all += docs
+        docs.each do |doc|
+          print "#{'*' * doc[:resources].length}".green
+        end
+      end
+    end
+    all
+  end
+
+  def self.scan_current_branch(root)
+    git = Git.open(root)
+
+    current_branch = git.current_branch
+
+    lastest_commit = git.log.first
+
+    files = lastest_commit.diff(git.log[3].sha).stats[:files]
+    # ap files
+  end
+end

data/lib/doc-digger/version.rb

@@ -1,3 +1,3 @@
 module DocDigger
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doc-digger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - wootaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,8 +164,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.8
-description: RESTWoods is a tool for generating RESTful web API documentation by analyzing
-  block comments.
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: DocDigger is a tool for generating RESTful web API documentation by analyzing
+  block comments in source code.
 email:
 - wootaw@gmail.com
 executables: []
@@ -187,6 +201,7 @@ files:
 - lib/doc-digger.rb
 - lib/doc-digger/file_parser.rb
 - lib/doc-digger/line_parser.rb
+- lib/doc-digger/scan.rb
 - lib/doc-digger/version.rb
 homepage: https://github.com/wootaw/doc-digger
 licenses: