apipie-rails 0.2.1 → 0.2.2

data/CHANGELOG.md

@@ -2,6 +2,21 @@
  Changelog
 ===========
 
+v0.2.2
+------
+
+* prevent rspec 3 from being used. It is not compatible.
+  [#255](https://github.com/Apipie/apipie-rails/pull/255) [@lsylvester][]
+* fixed extractor root route (handle nil path)
+  [#257](https://github.com/Apipie/apipie-rails/pull/257) [@ctria][]
+* reduced rails dependency to development only
+  [#266](https://github.com/Apipie/apipie-rails/pull/266) [@klobuczek][]
+* reduced rails dependency to development only
+  [#266](https://github.com/Apipie/apipie-rails/pull/266) [@klobuczek][]
+* add more options to apipie:cache to generate only parts of the
+  static pages
+  [#262](https://github.com/Apipie/apipie-rails/pull/262) [@mbacovsky][]
+
 v0.2.1
 ------
 
@@ -156,3 +171,6 @@ v0.0.15
 [@johanneswuerbach]: https://github.com/johanneswuerbach
 [@richardsondx]: https://github.com/richardsondx
 [@alem0lars]: https://github.com/alem0lars
+[@lsylvester]: https://github.com/lsylverster
+[@ctria]: https://github.com/ctria
+[@klobuczek]: https://github.com/klobuczek

data/README.rst

@@ -849,7 +849,7 @@ keyword. It specifies the versions the example is used for. When not
 specified, it's shown in all versions with given method.
 
 When referencing or quering the resource/method descripion, this
-format should be used: "verson#resource#method". When not specified,
+format should be used: "version#resource#method". When not specified,
 the default version is used instead.
 
 
@@ -979,6 +979,10 @@ When you want to avoid any unnecessary computation in production mode,
 you can generate a cache with ``rake apipie:cache`` and configure the
 app to use it in production with ``config.use_cache = Rails.env.production?``
 
+If, for some complex casese, you need to generate/re-generate just part of the cache
+use ``rake apipie:cache cache_part=index`` resp. ``rake apipie:cache cache_part=resources``
+To generate it to different location for further processing use ``rake apipie:cache OUT=/tmp/apipie_cache``.
+
 ===================
  JSON checksums
 ===================

data/apipie-rails.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", ">= 3.0.10"
+  s.add_development_dependency "rails", ">= 3.0.10"
   s.add_dependency 'json'
-  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rspec-rails", "~> 2.14.2"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest"
   s.add_development_dependency "maruku"

data/app/views/apipie/apipies/index.html.erb

@@ -1,5 +1,5 @@
 <ul class='breadcrumb'>
-  <li class='active'><a href='<%= @doc[:doc_url] %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @doc[:resources].values.first[:version] %></a></li>
+  <li class='active'><a href='<%= @doc[:doc_url] %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @doc[:resources].values.first && @doc[:resources].values.first[:version] %></a></li>
   <%= render(:partial => "languages", :locals => {:doc_url => @doc[:doc_url]}) %>
   <% if @versions && @versions.size > 1 %>
   <li class='pull-right'>

data/lib/apipie/extractor.rb

@@ -157,7 +157,7 @@ module Apipie
           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\)$/,"")
+            new_api[:path].sub!(/\(\.:format\)$/,"") if new_api[:path]
             old_api = old_apis.find do |api|
               api[:path] == "#{@api_prefix}#{new_api[:path]}"
             end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/lib/tasks/apipie.rake

@@ -51,32 +51,44 @@ namespace :apipie do
     end
   end
 
+  # By default the full cache is built.
+  # It is possible to generate index resp. resources only with
+  # rake apipie:cache cache_part=index (resources resp.)
+  # Default output dir ('public/apipie_cache') can be changed with OUT=/some/dir
   desc "Generate cache to avoid production dependencies on markup languages"
   task :cache => :environment do
     puts "#{Time.now} | Started"
+    cache_part = ENV['cache_part']
+    generate_index = (cache_part == 'resources' ? false : true)
+    generate_resources = (cache_part == 'index' ? false : true)
     with_loaded_documentation do
       puts "#{Time.now} | Documents loaded..."
       ([nil] + Apipie.configuration.languages).each do |lang|
         I18n.locale = lang || Apipie.configuration.default_locale
         puts "#{Time.now} | Processing docs for #{lang}"
-        cache_dir = Apipie.configuration.cache_dir
+        cache_dir = ENV["OUT"] || Apipie.configuration.cache_dir
         subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"")
-
         file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
-        Apipie.url_prefix = "./#{subdir}"
-        doc = Apipie.to_json(Apipie.configuration.default_version, nil, nil, lang)
-        doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
-        generate_index_page(file_base, doc, true, false, lang)
+
+        if generate_index
+          Apipie.url_prefix = "./#{subdir}"
+          doc = Apipie.to_json(Apipie.configuration.default_version, nil, nil, lang)
+          doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
+          generate_index_page(file_base, doc, true, false, lang)
+        end
         Apipie.available_versions.each do |version|
           file_base_version = File.join(file_base, version)
           Apipie.url_prefix = "../#{subdir}"
           doc = Apipie.to_json(version, nil, nil, lang)
           doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
-          generate_index_page(file_base_version, doc, true, true, lang)
-          Apipie.url_prefix = "../../#{subdir}"
-          generate_resource_pages(version, file_base_version, doc, true, lang)
-          Apipie.url_prefix = "../../../#{subdir}"
-          generate_method_pages(version, file_base_version, doc, true, lang)
+
+          generate_index_page(file_base_version, doc, true, true, lang) if generate_index
+          if generate_resources
+            Apipie.url_prefix = "../../#{subdir}"
+            generate_resource_pages(version, file_base_version, doc, true, lang)
+            Apipie.url_prefix = "../../../#{subdir}"
+            generate_method_pages(version, file_base_version, doc, true, lang)
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -20,7 +20,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.10
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -49,17 +49,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement