yard-api 0.3.4 → 0.3.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -1
- data/lib/yard-api/serializer.rb +14 -1
- data/lib/yard-api/version.rb +2 -2
- data/spec/spec_helper.rb +1 -1
- data/templates/api/fulldoc/json/setup.rb +1 -0
- data/yard-api.gemspec +0 -2
- metadata +2 -30
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9bb31c38d0e0da32afec85858785e0983828d3d6
|
4
|
+
data.tar.gz: 7c9473a9bf603bed99dca94993402e2f4e0e7fb8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 591fbf739b125a4c4a6057f209df2e03f6914b6b6e0b932a8f9bad46387275bb4d0dcea16e91b2885d20d21c0fe6b9cda3871c61f94a37b9a976d712ee44a78e
|
7
|
+
data.tar.gz: 754ef7e03bcdf38789fe330fa62389f240d0b57579d6ef157d9e883647dad3540630ac1e26a660f3d550217c338fbf09e9d972161defe6efca0d61dc33f7dfde
|
data/README.md
CHANGED
@@ -40,6 +40,12 @@ Read that file to view all the available options.
|
|
40
40
|
|
41
41
|
## Changelog
|
42
42
|
|
43
|
+
**6/9/2015 [0.3.5]**
|
44
|
+
|
45
|
+
- In JSON format, an API resource endpoint now contains the name as well.
|
46
|
+
- Changed the `topicize()` helper in a way that makes the IDs (and URLs of
|
47
|
+
some sections) much more readable
|
48
|
+
|
43
49
|
**23/8/2015 [0.3.4]**
|
44
50
|
|
45
51
|
- 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.
|
|
96
102
|
|
97
103
|
## License
|
98
104
|
|
99
|
-
Released under the [AGPLv3](http://www.gnu.org/licenses/agpl-3.0.html) license.
|
105
|
+
Released under the [AGPLv3](http://www.gnu.org/licenses/agpl-3.0.html) license.
|
data/lib/yard-api/serializer.rb
CHANGED
@@ -4,7 +4,20 @@ module YARD::APIPlugin
|
|
4
4
|
FSSEP = '/'
|
5
5
|
|
6
6
|
def self.topicize(str)
|
7
|
-
str.lines.first.gsub(/\W+/, '_')
|
7
|
+
self.str_underscore(str.lines.first.gsub(/\W+/, '_'))
|
8
|
+
end
|
9
|
+
|
10
|
+
# Stolen from rails 4.2, see:
|
11
|
+
#
|
12
|
+
# http://apidock.com/rails/v4.2.1/ActiveSupport/Inflector/underscore
|
13
|
+
def self.str_underscore(camel_cased_word)
|
14
|
+
return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
|
15
|
+
word = camel_cased_word.to_s.gsub(/::/, '/')
|
16
|
+
word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
|
17
|
+
word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
|
18
|
+
word.tr!("-", "_")
|
19
|
+
word.downcase!
|
20
|
+
word
|
8
21
|
end
|
9
22
|
|
10
23
|
def serialize(object, data)
|
data/lib/yard-api/version.rb
CHANGED
data/spec/spec_helper.rb
CHANGED
data/yard-api.gemspec
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard-api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3.
|
4
|
+
version: 0.3.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ahmad Amireh
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2015-
|
11
|
+
date: 2015-09-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: yard
|
@@ -52,34 +52,6 @@ dependencies:
|
|
52
52
|
- - ">="
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: '0'
|
55
|
-
- !ruby/object:Gem::Dependency
|
56
|
-
name: gem-release
|
57
|
-
requirement: !ruby/object:Gem::Requirement
|
58
|
-
requirements:
|
59
|
-
- - ">="
|
60
|
-
- !ruby/object:Gem::Version
|
61
|
-
version: '0'
|
62
|
-
type: :development
|
63
|
-
prerelease: false
|
64
|
-
version_requirements: !ruby/object:Gem::Requirement
|
65
|
-
requirements:
|
66
|
-
- - ">="
|
67
|
-
- !ruby/object:Gem::Version
|
68
|
-
version: '0'
|
69
|
-
- !ruby/object:Gem::Dependency
|
70
|
-
name: byebug
|
71
|
-
requirement: !ruby/object:Gem::Requirement
|
72
|
-
requirements:
|
73
|
-
- - ">="
|
74
|
-
- !ruby/object:Gem::Version
|
75
|
-
version: '0'
|
76
|
-
type: :development
|
77
|
-
prerelease: false
|
78
|
-
version_requirements: !ruby/object:Gem::Requirement
|
79
|
-
requirements:
|
80
|
-
- - ">="
|
81
|
-
- !ruby/object:Gem::Version
|
82
|
-
version: '0'
|
83
55
|
description: |2
|
84
56
|
TBD
|
85
57
|
email: ahmad@instructure.com
|