RubyGems - api_yard_parser - Versions diffs - 0.0.1 - Mend

api_yard_parser 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

checksums.yaml +15 -0
data/MIT-LICENSE +20 -0
data/README.rdoc +14 -0
data/Rakefile +38 -0
data/app/controllers/api_yard_parser/api_docs_controller.rb +20 -0
data/app/views/api_yard_parser/api_docs/index.html.erb +150 -0
data/config/routes.rb +5 -0
data/lib/api_yard_parser/api_comment.rb +81 -0
data/lib/api_yard_parser/api_controllers.rb +14 -0
data/lib/api_yard_parser/api_docs.rb +100 -0
data/lib/api_yard_parser/engine.rb +3 -0
data/lib/api_yard_parser/version.rb +3 -0
data/lib/api_yard_parser.rb +18 -0
data/test/api_yard_parser_test.rb +7 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +15 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/config/application.rb +59 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +37 -0
data/test/dummy/config/environments/production.rb +67 -0
data/test/dummy/config/environments/test.rb +37 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +58 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/test_helper.rb +15 -0
metadata +130 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzRkZmIwNjZkOWI3MWYzYTM4MjgyYjVhNTFmNjFlYzcwZTE0MDdmZQ==
+  data.tar.gz: !binary |-
+    YzcxNTI5NDFhZDczZTI5YTRkZjdhNWRiMTY4N2Q4NjI3OGE4N2QyOQ==
+SHA512:
+  metadata.gz: !binary |-
+    YzA2OGYwMGI0YTc5MjhjMzgwNWVhMDk2YjM3ZWMxY2IyMTUyYjQ3ZDQxN2M3
+    ODA0ZDIxMzNiM2M5NDEzZjBmNzkyZjQ1MzVmNmI0M2JjZGQxOWViM2M5MzM2
+    NWQyZTQzOGQ1NGVjMWQwMDA2ZjBlMDdkYjlkMDZmYzk1MTU4Nzg=
+  data.tar.gz: !binary |-
+    Y2Q1MmEwZjA1OTUwMWRiYzI2ZmE2MWI3ZmM4YmY1MTI2YWZhZDMyNjYyNTM0
+    MGIwN2JhZTczZmY5M2RhNTU4MTJjMWJlMWY5ZmQ2ZGE2MjZhMmIwNjEyYWUy
+    YTA5MjkwYWEzNjk1NGNkZjE5OTEwZDhiYTc2ODA2MjUwYmRhZDI=

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2014 Thiago Coutinho
+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.rdoc ADDED Viewed

@@ -0,0 +1,14 @@
+= ApiYardParser
+This project rocks and uses MIT-LICENSE.
+1. REQUIREMENTS
+===============
+Ruby/ApiYardParser requires Ruby version 1.9.1 or newer and Rails ~> 3.2.16.
+2. INSTALLATION
+===============
+gem install api_yard_parser

data/Rakefile ADDED Viewed

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ApiYardParser'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task :default => :test

data/app/controllers/api_yard_parser/api_docs_controller.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module ApiYardParser
+  class ApiDocsController < ::ApplicationController
+    def index
+      if Rails.env == "production" && ApiYardParser.force_no_docs_production
+        render :text => "dont have docs in production"
+        return true
+      end
+      @list_apis = ApiDocs.get_all
+      @without = params[:without].split(",") if !params[:without].nil?
+      if !@without.nil?
+        @list_apis.select!{|api| @without.index(api.name) == nil }
+      end
+      render "index", :layout => false
+    end
+  end
+end

data/app/views/api_yard_parser/api_docs/index.html.erb ADDED Viewed

@@ -0,0 +1,150 @@
+<%
+def class_by_verb(verb)
+  items ={
+    "GET"=>"label-success",
+    "POST" => "label-info",
+    "PUT" => "label-warning",
+    "DELETE" => "label-important",
+  }
+  items[verb]
+end
+%>
+<!DOCTYPE html>
+<html class="colorNavyBlue">
+<head>
+  <title>ApiDocs - <%=Rails.application.class.to_s.split("::").first%></title>
+  <link rel="stylesheet" type="text/css" href="https://assets.locaweb.com.br/locastyle/1.1.9/locastyle.css">
+  <script type="text/javascript" src="https://assets.locaweb.com.br/locastyle/1.1.9/locastyle.js"></script>
+  <link rel="stylesheet" type="text/css" href="https://assets.locaweb.com.br/locastyle/1.1.9/bootstrap.css">
+  <script type="text/javascript" src="https://assets.locaweb.com.br/locastyle/1.1.9/bootstrap.js"></script>
+</head>
+<body>
+  <header class="headerPrincipal">
+    <div class="limite">
+      <h1 class="serviceName"><a href="/">ApiDocs - <%=Rails.application.class.to_s.split("::").first%></a></h1>
+    </div>
+    <menu id="menuPrincipal">
+      <ul>
+        <li class=''>
+          <a href="#">Docs by Controllers</a>
+        </li>
+      </ul>
+    </menu>
+  </header>
+  <div id="main">
+    <div class="limite">
+      <% @list_apis.each do |api| %>
+      <% if api.routes.count > 0  %>
+      <!--  init ###<%= api.name %>####   -->
+      <div class="row">
+        <div class="span12">
+          <div class="alert alert-warning" style="display:none">
+            <a class="close" data-dismiss="alert">×</a>
+            <strong>Informação!</strong> Uma informação qualquer do seu sistema. <a href="#">Um link qualquer</a>.
+          </div>
+          <div class="">
+            <h2><%= api.name %></h2>
+            <% api.routes.each do |route| %>
+            <div class="boxCollapse">
+              <header data-target="#api_routes_<%=route.object_id%>" data-toggle="collapse">
+                <h4><span class="label <%=class_by_verb(route.type)%>" style="color:white;"><%=route.type%></span>
+                  <strong>&nbsp;&nbsp;&nbsp;<%=route.url%> </strong> - <%=route.description%></h4>
+                </header>
+                <div class="collapse" id="api_routes_<%=route.object_id%>">
+                  <% if !route.params.nil? && route.params.count>0%>
+                    <p>
+                      <div class="alert alert-success">
+                        <h3> Params </h3>
+                        <div>
+                          <% route.params.each do |param| %>
+                          <p>
+                            <span><b>  <%=param[:name]%> </b> </span> -
+                            <span ><%=param[:type]%></span> -
+                            <span><%=param[:description]%></span>
+                          </p>
+                          <%end%>
+                        </div>
+                      </div>
+                    </p>
+                  <%end%>
+                  <% if !route.returns.nil? && route.returns.count>0%>
+                    <% route.returns.each do |myreturn| %>
+                      <p>
+                        <div class="alert alert-info">
+                          <h4> Return </h4>
+                          <div>
+                            <%=myreturn[:name]%> - <%=myreturn[:description]%>
+                            <br>
+                            <%=myreturn[:type]%>:
+                              <%if !myreturn[:body].nil? %>
+                                <pre class="lang-json prettyprint linenums"><%=myreturn[:body]%></pre>
+                              <%end%>
+                          </div>
+                        </div>
+                      </p>
+                    <%end%>
+                  <%end%>
+                  <% if !route.example.nil? %>
+                  <p>
+                    <div class="alert">
+                      <h3> Example </h3>
+                      <div>
+                        <%= route.example%>
+                      </div>
+                    </div>
+                  </p>
+                  <%end%>
+                  <% if !route.notes.nil? && route.notes.count>0%>
+                  <p>
+                    <div class="alert">
+                      <h3> Notes </h3>
+                      <div>
+                        <% route.notes.each do |note|%>
+                        <p><%=note%></p>
+                        <%end%>
+                      </div>
+                    </div>
+                  </p>
+                  <%end%>
+                </div>
+              </div>
+              <% end #end collapse%>
+            </div>
+          </div>
+        </div><!-- FIM ROW -->
+        <!--  end ###<%= api.name %>####   -->
+        <% end
+        end # end list_apis.each %>
+    </div><!-- FIM LIMITE -->
+        <footer id="rodape">
+          <div class="footerTop">
+            <div class="limite">
+            </div>
+          </div>
+          <div class="subfooter">
+            <div class="limite">
+              <p class="copyRight fright">Copyright © 2014 Thiago Coutinho thiago+@+osfeio.com</p>
+            </div>
+          </div>
+        </footer>
+      </div>
+    </div>
+  </body>
+  </html>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+	unless Rails.env == 'production'
+	  get "/docs" => "api_yard_parser/api_docs#index" , :as => :docs_page
+	end
+end

data/lib/api_yard_parser/api_comment.rb ADDED Viewed

@@ -0,0 +1,81 @@
+module ApiYardParser
+  class ApiComment
+    attr_reader :url, :type, :params, :returns, :description, :example, :notes
+    def initialize(text)
+      @text = text
+      @params = []
+      @returns = []
+      parse
+    end
+    def parse
+      items = @text.split("# @")
+      parse_text(items[0])
+      items.each do |item|
+        res = item.scan(/^(\S+)\s/)
+        if res.count > 0
+          type = res[0][0]
+          send("parse_#{type}",item) if ["url","type","param","return","note"].index(type)
+          parse_auto_example if type == "auto-example"
+        end
+      end
+    end
+    def parse_text(text)
+      lines = ""
+      text.split("\n").each{|line| lines += line.sub(/^\s+#/,"")}
+      @description = lines.strip
+    end
+    def parse_url(text)
+      @url = text.split[1]
+    end
+    def parse_type(text)
+      @type = text.split[1]
+    end
+    def parse_param(text)
+      res = text.scan(/^\S+\s+\[(\S+)\]\s+(\S+)(\s+->|\s+)(.+)/)[0]
+      if !res.nil?
+        @params += [{:type => res[0], :name=>res[1], :description=>res[3] } ]
+        return true
+      end
+      res = text.scan(/^\S+\s+\[(\S+)\]/)[0]
+      if !res.nil?
+        @params += [{:type => res[0], :name=>" ", :description=>" " } ]
+      end
+    end
+    def parse_return(text)
+      lines = ""
+      text.split("\n").each{|line| lines += line.sub(/^\s+#/,"") + "\n"}
+      res = lines.scan(/^\S+\s+\[(\S+)\]\s+([a-zA-Z\s\d]+)-(.+)\n([\s\{:\S\}]*)/)
+      if !res.nil? && !res[0].nil? && res[0][3].strip != ""
+        @returns += [{:type => res[0][0], :name=>res[0][1], :description=>res[0][2], :body => res[0][3] } ]
+        return
+      end
+      res = lines.scan(/^\S+\s+\[(\S+)\]\s+([a-zA-Z\s\d]+)-(.+)/)
+      if !res.nil? && res.count > 0
+        @returns += [{:type => res[0][0], :name=>res[0][1], :description=>res[0][2],:body => nil} ] if !res.nil?
+      end
+    end
+    def parse_note(text)
+      lines = ""
+      text.split("\n").each{|line| lines += line.sub(/^\s+#/,"") + "\n"}
+      res = lines.scan(/(GET|POST|PUT|DELETE).+\n+\s+(http.+)/)[0]
+      if !res.nil?
+        @type = res[0]
+        @url = res[1]
+      end
+    end
+    def parse_auto_example
+    end
+  end
+end

data/lib/api_yard_parser/api_controllers.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module ApiYardParser
+  class ApiControllers
+    attr_accessor :name, :routes
+    def initialize(name)
+      @name = name
+      @routes = []
+    end
+    def add_route(route)
+      @routes += [route]
+    end
+  end
+end

data/lib/api_yard_parser/api_docs.rb ADDED Viewed

@@ -0,0 +1,100 @@
+module ApiYardParser
+  class ApiDocs
+    attr_accessor :controller_dirs
+    def self.get_all
+      @controller_dirs = ["#{Rails.root}/app/controllers"]
+      files = []
+      @controller_dirs.each do |dir|
+        files += Dir["#{dir}/**/*.rb"]
+      end
+      content = []
+      #files = ["#{Rails.root}/app/controllers/clients_controller.rb"] #TEMP!!!!!!!!
+      files.each do |file|
+        content += [ApiDocs.new(file).contents]
+      end
+      content
+    end
+    def initialize(file)
+      @file = file
+    end
+    def contents
+      @file_content = File.new(@file).read
+      name = @file_content.scan(/class\s(\S+)Controller/ )
+      name = (name.count > 0) ? name[0][0] : ""
+      controller = ApiControllers.new(name)
+      comments.each do |my_method|
+        controller.add_route ApiComment.new(my_method) unless my_method =~ /^# -\*- coding: UTF-8 -\*-/
+      end
+      controller
+      # [
+      #   {
+      #     :name => "clients",
+      #     :routes => [
+      #       {
+      #         :description => "Show information about client by :id",
+      #         :url => "/clients/:id",
+      #         :params => [
+      #           {
+      #             :name => "id",
+      #             :type => "String",
+      #             :description => "",
+      #           },
+      #         ],
+      #         :returns => [
+      #           '{json { :id => x , :name => "John", :email => "john@teste.com"}'
+      #         ],
+      #         :example => 'curl -l -X GET "http://api.com.br/clients/1" ',
+      #         :notes=>[],
+      #       }
+      #     ]
+      #   }
+      # ]
+    end
+    private
+    def comments
+      my_methods = []
+      same = false
+      method = ""
+      inside_def = false
+      inside_count = 0
+      @file_content.split("\n").each do |line|
+        next if line =~ /# TODO:/
+        if line=~/^(\s+#|#\s)(.+|)/ && inside_def == false
+          if same==false
+            same = true
+          end
+          method += line + "\n" if same == true
+        else
+          if same == true
+            my_methods.append(method)
+            method = ""
+            same =false
+          end
+        end
+        if line.scan(/(^\s+def)/).count > 0
+          inside_def = true
+          inside_count = line.scan(/(^\s+def)/)[0][0].length
+        end
+        if line.scan(/(^\s+end)/).count > 0 && inside_count == line.scan(/(^\s+end)/)[0][0].length && inside_def ==  true
+          inside_def = false
+        end
+      end
+      my_methods
+    end
+  end
+end