apipie-rails 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -2,6 +2,14 @@
  Changelog
 ===========
 
+v0.1.2
+------
+
+* reloading works correctly with to_prepare blocks in the app
+  [#228](https://github.com/Apipie/apipie-rails/pull/228) [@iNecas][]
+* documentation bootstrapping now respects api_controllers_matcher
+  [#227](https://github.com/Apipie/apipie-rails/pull/227) [@clamoris][]
+
 v0.1.1
 ------
 
@@ -104,3 +112,4 @@ v0.0.15
 [@yonpols]: https://github.com/yonpols
 [@mkrajewski]: https://github.com/mkrajewski
 [@iNecas]: https://github.com/iNecas
+[@clamoris]: https://github.com/clamoris

data/README.rst

@@ -519,6 +519,9 @@ reload_controllers
 api_controllers_matcher
   For reloading to work properly you need to specify where your API controllers are. Can be an array if multiple paths are needed
 
+api_routes
+  Set if your application uses custom API router, different from Rails default
+
 markup
   You can choose markup language for descriptions of your application,
   resources and methods. RDoc is the default but you can choose from
@@ -566,6 +569,7 @@ Example:
      config.markup = Apipie::Markup::Markdown.new
      config.reload_controllers = Rails.env.development?
      config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
+     config.api_routes = Rails.application.routes
      config.app_info = "
        This is where you can inform user about your application and API
        in general.

data/lib/apipie/application.rb

@@ -259,13 +259,7 @@ module Apipie
     end
 
     def reload_documentation
-      if rails_mark_classes_for_reload
-        # if we are not able to mark classes for reload, we
-        # can't reinit the env, as we would loose the data that were
-        # already loaded
-        init_env
-        reload_examples
-      end
+      rails_mark_classes_for_reload
 
       api_controllers_paths.each do |f|
         load_controller_from_file f
@@ -359,9 +353,10 @@ module Apipie
     # as this would break loading of the controllers.
     def rails_mark_classes_for_reload
       unless Rails.application.config.cache_classes
-        ActiveSupport::DescendantsTracker.clear
-        ActiveSupport::Dependencies.clear
-        return true
+        ActionDispatch::Reloader.cleanup!
+        init_env
+        reload_examples
+        ActionDispatch::Reloader.prepare!
       end
     end
 

data/lib/apipie/configuration.rb

@@ -22,6 +22,11 @@ module Apipie
     # properly.
     attr_writer :reload_controllers
 
+    # specify routes if used router differ from default e.g.
+    #
+    # Api::Engine.routes
+    attr_accessor :api_routes
+
     def reload_controllers?
       @reload_controllers = Rails.env.development? unless defined? @reload_controllers
       return @reload_controllers && @api_controllers_matcher
@@ -110,6 +115,10 @@ module Apipie
       @api_base_url[version] = url
     end
 
+    def api_routes
+      @api_routes || Rails.application.routes
+    end
+
     def initialize
       @markup = Apipie::Markup::RDoc.new
       @app_name = "Another API"

data/lib/apipie/extractor.rb

@@ -55,41 +55,54 @@ module Apipie
         Writer.new(@collector).write_examples if @collector
       end
 
-      # TODO: this is a loooooooooong method :)
       def apis_from_routes
         return @apis_from_routes if @apis_from_routes
 
-        api_prefix = Apipie.api_base_url.sub(/\/$/,"")
-        all_routes = Rails.application.routes.routes.map do |r|
-          {
-            :verb => case r.verb
-                     when Regexp then r.verb.source[/\w+/]
-                     else r.verb.to_s
-                     end,
-            :path => case
-                     when r.path.respond_to?(:spec) then r.path.spec.to_s
-                     else r.path.to_s
-                     end,
-            :controller => r.requirements[:controller],
-            :action => r.requirements[:action]
-          }
+        @api_prefix = Apipie.api_base_url.sub(/\/$/,"")
+        populate_api_routes
+        update_api_descriptions
+
+        @apis_from_routes
+      end
+
+      def controller_path(name)
+        Apipie.api_controllers_paths.detect { |p| p.include?("#{name}_controller.rb") }
+      end
 
+      private
 
+      def all_api_routes
+        all_routes = Apipie.configuration.api_routes.routes.map do |r|
+          {
+              :verb => case r.verb
+                         when Regexp then r.verb.source[/\w+/]
+                         else r.verb.to_s
+                       end,
+              :path => case
+                         when r.path.respond_to?(:spec) then r.path.spec.to_s
+                         else r.path.to_s
+                       end,
+              :controller => r.requirements[:controller],
+              :action => r.requirements[:action]
+          }
         end
-        api_routes = all_routes.find_all do |r|
+
+        return all_routes.find_all do |r|
           r[:path].starts_with?(Apipie.api_base_url)
         end
+      end
 
+      def populate_api_routes
         @apis_from_routes = Hash.new { |h, k| h[k] = [] }
 
-        api_routes.each do |route|
+        all_api_routes.each do |route|
           controller_path, action = route[:controller], route[:action]
           next unless controller_path && action
 
           controller_path = controller_path.split('::').map(&:camelize).join('::')
           controller = "#{controller_path}Controller"
 
-          path = if /^#{Regexp.escape(api_prefix)}(.*)$/ =~ route[:path]
+          path = if /^#{Regexp.escape(@api_prefix)}(.*)$/ =~ route[:path]
                    $1.sub!(/\(\.:format\)$/,"")
                  else
                    nil
@@ -99,11 +112,13 @@ module Apipie
             @apis_from_routes[[controller, action]] << {:method => route[:verb], :path => path}
           end
         end
-        @apis_from_routes
+      end
 
+      def all_apis_from_docs
         resource_descriptions = Apipie.resource_descriptions.values.map(&:values).flatten
         method_descriptions = resource_descriptions.map(&:method_descriptions).flatten
-        apis_from_docs = method_descriptions.reduce({}) do |h, desc|
+
+        return method_descriptions.reduce({}) do |h, desc|
           apis = desc.method_apis_to_json.map do |api|
             { :method => api[:http_method],
               :path => api[:api_url],
@@ -111,21 +126,23 @@ module Apipie
           end
           h.update(desc.id => apis)
         end
+      end
 
+      def update_api_descriptions
+        apis_from_docs = all_apis_from_docs
         @apis_from_routes.each do |(controller, action), new_apis|
           method_key = "#{Apipie.get_resource_name(controller.constantize)}##{action}"
           old_apis = apis_from_docs[method_key] || []
           new_apis.each do |new_api|
             new_api[:path].sub!(/\(\.:format\)$/,"")
             old_api = old_apis.find do |api|
-              api[:path] == "#{api_prefix}#{new_api[:path]}"
+              api[:path] == "#{@api_prefix}#{new_api[:path]}"
             end
             if old_api
               new_api[:desc] = old_api[:desc]
             end
           end
         end
-        @apis_from_routes
       end
 
     end

data/lib/apipie/extractor/collector.rb

@@ -13,7 +13,7 @@ module Apipie
       end
 
       def controller_full_path(controller)
-        File.join(Rails.root, "app", "controllers", "#{controller.controller_path}_controller.rb")
+        Apipie::Extractor.controller_path controller.controller_path
       end
 
       def ignore_call?(record)

data/lib/apipie/extractor/writer.rb

@@ -205,11 +205,11 @@ module Apipie
       end
 
       def controller_path
-        @controller_path ||= File.join(Rails.root, "app", "controllers", "#{@controller.controller_path}_controller.rb")
+        @controller_path ||= Apipie::Extractor.controller_path(@controller.controller_path)
       end
 
       def controller_content
-        raise ControllerNotFound.new unless File.exists? controller_path
+        raise ControllerNotFound.new unless controller_path && File.exists?(controller_path)
         @controller_content ||= File.read(controller_path)
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/dummy/config/initializers/apipie.rb

@@ -30,6 +30,9 @@ Apipie.configure do |config|
   # for reloading to work properly you need to specify where your api controllers are (like in Dir.glob):
   config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
 
+  # specify routes if your application uses router differ from Rails default one
+  config.api_routes = Rails.application.routes
+
   # config.markup = choose one of:
   #   Apipie::Markup::RDoc.new [default]
   #   Apipie::Markup::Markdown.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails