rapi_doc 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/doc_util.rb

@@ -1,6 +1,8 @@
-class DocUtil
-  # print some  erb code to a template
-  def self.print_erb(str, show=false)
-    (show ? "<%= " : "<% ") + str + " %>"
+module RapiDoc
+  class DocUtil
+    # print some  erb code to a template
+    def self.print_erb(str, show=false)
+      (show ? "<%= " : "<% ") + str + " %>"
+    end
   end
 end

data/lib/method_doc.rb

@@ -1,32 +1,29 @@
-# This class holds methods about a doc.
-class MethodDoc
-  attr_accessor :scope, :content, :request, :response, :code
-  
-  def initialize(type)
-    @scope = type
-    @variables = []
-    @content = ""
-    @code = ""
-    @request = ""
-    @response = ""
-  end
-  
-  
-  def add_variable(name, value)
-    if name == "param"
-      @variables << value
-      return
+module RapiDoc
+  # This class holds methods about a doc.
+  class MethodDoc
+    attr_accessor :scope, :content, :request, :response, :code
+    
+    def initialize(type)
+      @scope = type
+      @variables = []
+      @content = ""
+      @code = ""
+      @request = ""
+      @response = ""
     end
+    
+    
+    def add_variable(name, value)
+      if name == "param"
+        @variables << value
+        return
+      end
 
-    eval("@#{name}= \"#{value}\"")
-
-    if name == "json"
-      puts "Found json:"
-      puts @json
+      eval("@#{name}= \"#{value}\"")
+    end
+    
+    def get_binding
+      binding
     end
   end
-  
-  def get_binding
-    binding
-  end
-end
+end

data/lib/rapi_config.rb

@@ -0,0 +1,27 @@
+module RapiDoc
+  module RapiConfig
+    def config_dir
+      File.join(::Rails.root.to_s, 'config/rapi_doc')
+    end
+
+    def template_dir
+      File.join(File.dirname(__FILE__), '/../templates')
+    end
+
+    def config_file(location)
+      File.join(find_location(location), 'config.yml')
+    end
+
+    def index_layout_file(location)
+      File.join(find_location(location), 'index.html.erb')
+    end
+
+    def resource_layout_file(location)
+      File.join(find_location(location), 'resource.html.erb')
+    end
+
+    def find_location(location)
+      location == :target ? config_dir : template_dir
+    end
+  end
+end

data/lib/rapi_doc/tasks/rapi_doc_tasks.rake

@@ -1,3 +1,5 @@
+include RapiDoc::RapiConfig
+
 desc "Generate the API Documentation"
 task :rapi_doc do
   begin

data/lib/rapi_doc.rb

@@ -2,68 +2,70 @@ require 'erb'
 require 'fileutils'
 require 'doc_util'
 require 'resource_doc'
-require 'config'
+require 'rapi_config'
 require 'rapi_doc/railtie' if defined?(Rails)
 
-include Config # TODO FIXME
+module RapiDoc
+  class RAPIDoc
 
-class RAPIDoc
+    include RapiConfig
 
-  # Initalize the ApiDocGenerator
-  def initialize(resources)
-    puts "Apidoc started..."
-    @resources = resources
-    generate_templates!
-    move_structure!
-    puts "Finished."
-  end
+    # Initalize the ApiDocGenerator
+    def initialize(resources)
+      puts "Apidoc started..."
+      @resources = resources
+      generate_templates!
+      move_structure!
+      puts "Finished."
+    end
 
-  # Iterates over the resources creates views for them.
-  # Creates an index file
-  def generate_templates!
+    # Iterates over the resources creates views for them.
+    # Creates an index file
+    def generate_templates!
 
-    @resources.each do |r|
-      r.parse_apidoc!
-      r.generate_view!(@resources, temp_dir)
+      @resources.each do |r|
+        r.parse_apidoc!
+        r.generate_view!(@resources, temp_dir)
+      end
+      generate_index!
+      copy_styles!
     end
-    generate_index!
-    copy_styles!
-  end
 
-  # generate the index file for the api views
-  def generate_index!
-    template = ""
-    File.open(index_layout_file(:target)).each { |line| template << line }
-    parsed = ERB.new(template).result(binding)
-    File.open(File.join(temp_dir, "index.html"), 'w') { |file| file.write parsed }
-  end
+    # generate the index file for the api views
+    def generate_index!
+      template = ""
+      File.open(index_layout_file(:target)).each { |line| template << line }
+      parsed = ERB.new(template).result(binding)
+      File.open(File.join(temp_dir, "index.html"), 'w') { |file| file.write parsed }
+    end
 
-  def move_structure!
-    target_folder = "#{::Rails.root.to_s}/public/apidoc/"
-    Dir.mkdir(target_folder) if (!File.directory?(target_folder))
+    def move_structure!
+      target_folder = "#{::Rails.root.to_s}/public/apidoc/"
+      Dir.mkdir(target_folder) if (!File.directory?(target_folder))
 
-    Dir.new(temp_dir).each do |d|
-      if d =~ /^[a-zA-Z]+\.(html|css)$/ # Only want to copy over the .html files, not the .erb templates
-        FileUtils.cp  File.join(temp_dir + d), target_folder + d
-      end
+      Dir.new(temp_dir).each do |d|
+        if d =~ /^[a-zA-Z]+\.(html|css)$/ # Only want to copy over the .html files, not the .erb templates
+          FileUtils.cp  File.join(temp_dir + d), target_folder + d
+        end
 
-      #Clean up the no longer needed files
-      filepath = "#{temp_dir}/#{d}"
-      File.delete(filepath) unless File.directory?(filepath)
+        #Clean up the no longer needed files
+        filepath = "#{temp_dir}/#{d}"
+        File.delete(filepath) unless File.directory?(filepath)
+      end
     end
-  end
 
-  def copy_styles!
-    Dir[File.join(File.dirname(__FILE__), '..', 'templates/*')].each do |f|
-      if f =~ /[\/a-zA-Z\.]+\.css$/i
-        FileUtils.cp f, temp_dir
+    def copy_styles!
+      Dir[File.join(File.dirname(__FILE__), '..', 'templates/*')].each do |f|
+        if f =~ /[\/a-zA-Z\.]+\.css$/i
+          FileUtils.cp f, temp_dir
+        end
       end
     end
-  end
 
-  private
+    private
 
-  def temp_dir
-    @temp_dir ||= "#{Dir.mktmpdir("apidoc")}/"
+    def temp_dir
+      @temp_dir ||= "#{Dir.mktmpdir("apidoc")}/"
+    end
   end
-end
+end

data/lib/resource_doc.rb

@@ -1,124 +1,126 @@
 require 'method_doc'
 
-# ResourceDoc holds the information a resource contains. It parses the class header and also the 
-# method documentation, which will be contained in MethodDoc.
-class ResourceDoc
-  
-  attr_reader :name, :resource_location, :controller_name, :function_blocks, :class_block
-  
-  # Initializes RAPIDoc.
-  def initialize(name, resource_location, controller_name, options = {})
-    @name = name
-    @standard_methods = options[:standard_methods] || [:put, :post, :get, :delete]
-    @resource_location, @controller_name = resource_location, controller_name
-    @function_blocks = []
-    @method_codes = []
-    @header_code = ""
+module RapiDoc
+  # ResourceDoc holds the information a resource contains. It parses the class header and also the 
+  # method documentation, which will be contained in MethodDoc.
+  class ResourceDoc
     
-    unless File.exist?(controller_location)
-      raise "Unable to find or open controller. Make sure it's set properly in config/rapidoc/config.yml File: #{controller_location}"
+    attr_reader :name, :resource_location, :controller_name, :function_blocks, :class_block
+    
+    # Initializes RAPIDoc.
+    def initialize(name, resource_location, controller_name, options = {})
+      @name = name
+      @standard_methods = options[:standard_methods] || [:put, :post, :get, :delete]
+      @resource_location, @controller_name = resource_location, controller_name
+      @function_blocks = []
+      @method_codes = []
+      @header_code = ""
+      
+      unless File.exist?(controller_location)
+        raise "Unable to find or open controller. Make sure it's set properly in config/rapidoc/config.yml File: #{controller_location}"
+      end
     end
-  end
-  
-  # returns the location of the controller that is to be parsed
-  def controller_location
-    "#{::Rails.root.to_s}/app/controllers/#{controller_name}"
-  end
-  
-  def get_binding
-    binding
-  end
-  
-  # parse the controller
-  def parse_apidoc!
-    current_api_block = nil
-    current_scope = :none
-    block_holder = []
-    lineno = 0
-    inclass = false
     
-    File.open(controller_location).each do |line|
-      if line =~ /=begin apidoc/
-        current_scope = !inclass ? :class : :function
-        current_api_block = MethodDoc.new(current_scope)
-      elsif line =~ /=end/
-        if current_api_block.nil?
-          puts "#{controller_location}:#{lineno} - No starttag for =end found"
-          exit
-        elsif current_api_block.scope == :class
-          @class_block = current_api_block
-        elsif current_api_block.scope == :function
-          @function_blocks << current_api_block
-        end
-        current_api_block = nil
-        current_scope = :none
-      elsif line =~ /class/
-        inclass = true
-      elsif line =~ /::response-end::/
-        current_scope = :function
-      elsif line =~ /::request-end::/
-        current_scope = :function
-      elsif current_scope == :response
-        current_api_block.response += "#{line}"
-      elsif current_scope == :request
-        current_api_block.request += "#{line}"
-      elsif current_scope == :class || current_scope == :function # check if we are looking at a api block
-        # strip the # on the line
-        #line = line[1..line.length].lstrip.rstrip
-        # check if we are dealing with a variable
-        # something in the format: # varname:: sometext
-        if result = /(\w+)\:\:\s*(.+)/.match(line)
-          if result[1] == "response" || result[1] == "request"
-            puts "="*30
-            puts "found response"
-            puts "="*30; puts ""
-            puts line
-            current_scope = result[1].to_sym
+    # returns the location of the controller that is to be parsed
+    def controller_location
+      "#{::Rails.root.to_s}/app/controllers/#{controller_name}"
+    end
+    
+    def get_binding
+      binding
+    end
+    
+    # parse the controller
+    def parse_apidoc!
+      current_api_block = nil
+      current_scope = :none
+      block_holder = []
+      lineno = 0
+      inclass = false
+      
+      File.open(controller_location).each do |line|
+        if line =~ /=begin apidoc/
+          current_scope = !inclass ? :class : :function
+          current_api_block = MethodDoc.new(current_scope)
+        elsif line =~ /=end/
+          if current_api_block.nil?
+            puts "#{controller_location}:#{lineno} - No starttag for =end found"
+            exit
+          elsif current_api_block.scope == :class
+            @class_block = current_api_block
+          elsif current_api_block.scope == :function
+            @function_blocks << current_api_block
+          end
+          current_api_block = nil
+          current_scope = :none
+        elsif line =~ /class/
+          inclass = true
+        elsif line =~ /::response-end::/
+          current_scope = :function
+        elsif line =~ /::request-end::/
+          current_scope = :function
+        elsif current_scope == :response
+          current_api_block.response += "#{line}"
+        elsif current_scope == :request
+          current_api_block.request += "#{line}"
+        elsif current_scope == :class || current_scope == :function # check if we are looking at a api block
+          # strip the # on the line
+          #line = line[1..line.length].lstrip.rstrip
+          # check if we are dealing with a variable
+          # something in the format: # varname:: sometext
+          if result = /(\w+)\:\:\s*(.+)/.match(line)
+            if result[1] == "response" || result[1] == "request"
+              puts "="*30
+              puts "found response"
+              puts "="*30; puts ""
+              puts line
+              current_scope = result[1].to_sym
+            else
+              current_api_block.add_variable(result[1], result[2])
+            end
           else
-            current_api_block.add_variable(result[1], result[2])
+            # add line to block
+            current_api_block.content << line
           end
-        else
-          # add line to block
-          current_api_block.content << line
         end
+        lineno += 1
       end
-      lineno += 1
-    end
 
-    puts "Generated #{name}.html"
-  end
-  
-  def generate_view!(resources, temp_dir)
-     @resources = resources
-     @header_code = get_parsed_header unless @class_block.nil?
-     function_blocks.each do |mb|
-       @method_codes << get_parsed_method(mb)
-     end
-     # write it to a file
-     template = ""
-     File.open(resource_layout_file(:target)).each { |line| template << line }
-     parsed = ERB.new(template).result(binding)
-     File.open(File.join(temp_dir, name + ".html"), 'w') { |file| file.write parsed }
-  end
+      puts "Generated #{name}.html"
+    end
+    
+    def generate_view!(resources, temp_dir)
+       @resources = resources
+       @header_code = get_parsed_header unless @class_block.nil?
+       function_blocks.each do |mb|
+         @method_codes << get_parsed_method(mb)
+       end
+       # write it to a file
+       template = ""
+       File.open(resource_layout_file(:target)).each { |line| template << line }
+       parsed = ERB.new(template).result(binding)
+       File.open(File.join(temp_dir, name + ".html"), 'w') { |file| file.write parsed }
+    end
 
 
-  def get_parsed_header
-    template = ""
-    File.open(File.join(File.dirname(__FILE__), '..', 'templates', '_resource_header.html.erb')).each { |line| template << line }
+    def get_parsed_header
+      template = ""
+      File.open(File.join(File.dirname(__FILE__), '..', 'templates', '_resource_header.html.erb')).each { |line| template << line }
 
-    puts "-"*30
-    puts ">>> inside: get_parsed_header"
-    puts ERB.new(template).result(@class_block.get_binding)
-    puts "-"*30; puts ""
+      puts "-"*30
+      puts ">>> inside: get_parsed_header"
+      puts ERB.new(template).result(@class_block.get_binding)
+      puts "-"*30; puts ""
 
-    return ERB.new(template).result(@class_block.get_binding)
-  end
+      return ERB.new(template).result(@class_block.get_binding)
+    end
 
 
-  def get_parsed_method(method_block)
-    template = ""
-    File.open(File.join(File.dirname(__FILE__), '..', 'templates', '_resource_method.html.erb')).each { |line| template << line }
-    return ERB.new(template).result(method_block.get_binding)
+    def get_parsed_method(method_block)
+      template = ""
+      File.open(File.join(File.dirname(__FILE__), '..', 'templates', '_resource_method.html.erb')).each { |line| template << line }
+      return ERB.new(template).result(method_block.get_binding)
+    end
+      
   end
-    
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: rapi_doc
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Husein Choroomi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-31 00:00:00 Z
+date: 2011-11-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
@@ -75,9 +75,9 @@ files:
 - VERSION
 - init.rb
 - install.rb
-- lib/config.rb
 - lib/doc_util.rb
 - lib/method_doc.rb
+- lib/rapi_config.rb
 - lib/rapi_doc.rb
 - lib/rapi_doc/railtie.rb
 - lib/rapi_doc/tasks/rapi_doc_tasks.rake
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2005719792368905649
+      hash: 4485947497076302486
       segments: 
       - 0
       version: "0"

data/lib/config.rb

@@ -1,25 +0,0 @@
-module Config
-  def config_dir
-    File.join(::Rails.root.to_s, 'config/rapi_doc')
-  end
-
-  def template_dir
-    File.join(File.dirname(__FILE__), '/../templates')
-  end
-
-  def config_file(location)
-    File.join(find_location(location), 'config.yml')
-  end
-
-  def index_layout_file(location)
-    File.join(find_location(location), 'index.html.erb')
-  end
-
-  def resource_layout_file(location)
-    File.join(find_location(location), 'resource.html.erb')
-  end
-
-  def find_location(location)
-    location == :target ? config_dir : template_dir
-  end
-end