gdoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72eefce3e6e62bbabaaa0b6a82df1bcb74ea8f71
+  data.tar.gz: fd02ed90e4a65fa1436e62301afc4952c78e0200
+SHA512:
+  metadata.gz: 59de9b0b1e5f663b484fb0087d83446deb76680443fe66745f5265aa63498621b5489d93336d84f8d27df51e8f1c0e9c59c9fc8ebd0237f646be30559c82990e
+  data.tar.gz: 751fee0532c4f3df2bda3b160755d047e87edb6c7d810d47b07d8638f640894ada64b4aa8e429c9fdbe1fd542387c8fb99106399bf04753b5ce070da7b31f8c2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 mj
+
+MIT License
+
+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,29 @@
+# Gdoc
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gdoc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gdoc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/gdoc/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gdoc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/gdoc'
+
+gen = Gdoc::Generate.new ARGV[1]
+gen.to_md ARGV[0]

data/gdoc.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gdoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gdoc"
+  spec.version       = Gdoc::VERSION
+  spec.authors       = ["mjason"]
+  spec.email         = ["tywf91@gmail.com"]
+  spec.summary       = %q{一个文档dsl}
+  spec.description   = %q{简单的方式生成好看的md文档}
+  spec.homepage      = "https://github.com/mjason/gdoc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/gdoc.rb

@@ -0,0 +1,5 @@
+require "gdoc/version"
+
+module Gdoc
+  autoload :Generate, 'gdoc/generate'
+end

data/lib/gdoc/doc.rb

@@ -0,0 +1,7 @@
+module Gdoc
+  
+  class Doc
+    attr_accessor :name, :method, :ok, :params, :desc
+  end
+  
+end

data/lib/gdoc/generate.rb

@@ -0,0 +1,138 @@
+# coding: utf-8
+require 'json'
+
+module Gdoc
+  
+  class Generate
+    
+    def initialize(out_dir)
+      @out_dir = out_dir
+      @doc_md = []
+      @api_list = []
+      @docs = ''
+    end
+
+    # dsl api
+    def root value
+      @root = value
+    end
+
+    def model value
+      @model = value
+    end
+
+    def url value
+      @url = value
+    end
+
+    def get url, &blk
+      gen_api_md 'get', url, &blk
+    end
+
+    def post url, &blk
+      gen_api_md 'post', url, &blk
+    end
+
+    def put url, &blk
+      gen_api_md 'put', url, &blk
+    end
+
+    def del url, &blk
+      gen_api_md 'delete', url, &blk
+    end
+
+    def patch url, &blk
+      gen_api_md 'patch', url, &blk
+    end
+
+    def import source
+      eval(File.read "./#{source}.gdoc")
+      create_file
+    end
+
+    def desc value
+      @desc = value
+    end
+
+    def params typ, json_
+      typ
+      @params = json_
+    end
+
+    def ok code, json_
+      @ok = json_
+    end
+
+    def headers(header_={})
+      @header = header_
+    end
+
+    def auth ison=false
+      @ison = ison
+    end
+
+    def json
+      @typ = 'application/json'
+    end
+
+    # output
+    def to_md source
+      eval(File.read "./#{source}.gdoc")
+      gen_api_list_md
+    end
+
+    def gen_api_list_md
+      file = File.open "#{@out_dir}/Home.md", 'w'
+      file.puts <<-md
+# index
+> api 列表
+
+api 地址: #{@root}
+
+#{@api_list.join "\n"}
+      md
+      file.close
+    end
+
+    def gen_api_md method, url, &blk
+      blk.call
+      @doc_md << <<-md
+### #{@root}#{@url}#{url}
+> #{@desc}
+
+auth: #{@ison}
+
+headers:
+```javascript
+#{JSON.pretty_generate (@header || {})}
+```
+
+content-type: #{@typ}
+
+method: #{method}
+
+params:
+
+```javascript
+#{JSON.pretty_generate @params}
+```
+
+return:
+
+```
+#{JSON.pretty_generate @ok}
+```
+      md
+    end
+
+    def create_file
+      file = File.open "#{@out_dir}/#{@model}.md", 'w'
+      file.puts @doc_md.join("\n* * *\n\n") 
+      file.close
+      @doc_md = []
+      @api_list << "[#{@model}](./wiki/#{@model})"
+    end
+
+  end
+  
+end

data/lib/gdoc/version.rb

@@ -0,0 +1,3 @@
+module Gdoc
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: gdoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mjason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "简单的方式生成好看的md文档"
+email:
+- tywf91@gmail.com
+executables:
+- gdoc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gdoc
+- gdoc.gemspec
+- lib/gdoc.rb
+- lib/gdoc/doc.rb
+- lib/gdoc/generate.rb
+- lib/gdoc/version.rb
+homepage: https://github.com/mjason/gdoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: "一个文档dsl"
+test_files: []