yard-api 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d00eca05fb8b95040018871a831a81f6386b966d
-  data.tar.gz: 6b63e8bb9ec6a9d2ae60b9f69c09bf353a2c381d
+  metadata.gz: 9bb31c38d0e0da32afec85858785e0983828d3d6
+  data.tar.gz: 7c9473a9bf603bed99dca94993402e2f4e0e7fb8
 SHA512:
-  metadata.gz: f5a622aa5b1b3ccd2f5f8b1109c9c52849a216c3635754ead6678fbd4d8f6d8b29bb95396f44c1783fc330b856636765d69032a9df4d92a38ee11e7f7cbacb5b
-  data.tar.gz: 2a64c4471f631d75f3c6e87e84c6fb8b512be4da427a5df0c0b2cd16ae998414cac7a2f97e3ebe05f8c2cd9a1cfcbab510f84497f99e3a85ca41f595d9d14d2a
+  metadata.gz: 591fbf739b125a4c4a6057f209df2e03f6914b6b6e0b932a8f9bad46387275bb4d0dcea16e91b2885d20d21c0fe6b9cda3871c61f94a37b9a976d712ee44a78e
+  data.tar.gz: 754ef7e03bcdf38789fe330fa62389f240d0b57579d6ef157d9e883647dad3540630ac1e26a660f3d550217c338fbf09e9d972161defe6efca0d61dc33f7dfde

data/README.md

@@ -40,6 +40,12 @@ Read that file to view all the available options.
 
 ## Changelog
 
+**6/9/2015 [0.3.5]**
+
+- In JSON format, an API resource endpoint now contains the name as well.
+- Changed the `topicize()` helper in a way that makes the IDs (and URLs of
+  some sections) much more readable
+
 **23/8/2015 [0.3.4]**
 
 - Fixed an issue that prevented overriding the Rake task's options at runtime.
@@ -96,4 +102,4 @@ Read that file to view all the available options.
 
 ## License
 
-Released under the [AGPLv3](http://www.gnu.org/licenses/agpl-3.0.html) license.
+Released under the [AGPLv3](http://www.gnu.org/licenses/agpl-3.0.html) license.

data/lib/yard-api/serializer.rb

@@ -4,7 +4,20 @@ module YARD::APIPlugin
     FSSEP = '/'
 
     def self.topicize(str)
-      str.lines.first.gsub(/\W+/, '_').downcase
+      self.str_underscore(str.lines.first.gsub(/\W+/, '_'))
+    end
+
+    # Stolen from rails 4.2, see:
+    #
+    # http://apidock.com/rails/v4.2.1/ActiveSupport/Inflector/underscore
+    def self.str_underscore(camel_cased_word)
+      return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+      word = camel_cased_word.to_s.gsub(/::/, '/')
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
     end
 
     def serialize(object, data)

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.3.4"
+    VERSION = "0.3.5"
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'byebug'
+require 'byebug' if RUBY_VERSION > '1.9.3'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/templates/api/fulldoc/json/setup.rb

@@ -74,6 +74,7 @@ def dump_endpoint(endpoint)
   {
     id: topicize(endpoint.path),
     scoped_id: topicize(title),
+    name: endpoint.name,
     title: title,
     text: endpoint.base_docstring,
     controller: endpoint.namespace.path,

data/yard-api.gemspec

@@ -18,6 +18,4 @@ Gem::Specification.new do |s|
   s.add_dependency 'yard', '0.8.7'
   s.add_dependency 'yard-appendix'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'gem-release'
-  s.add_development_dependency 'byebug' if RUBY_VERSION > "1.9.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-23 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -52,34 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: gem-release
-  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'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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: |2
       TBD
 email: ahmad@instructure.com