mina-dox 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6298391a9f7fdf14a14e15687672adb9e29d54a92d45a92c43578bdce370a8b3
4
- data.tar.gz: d1e8a19a448910befd98b5702eb838f38595938c6d32f2cf0ab1ce7e1c178418
3
+ metadata.gz: 1b184dc899ddbba9293879fbeef84644b72244e52cbdad64ffd829e4606beb51
4
+ data.tar.gz: 516a46a0cec8d923cc62b923936ffd0e525ebeb08a5688d78b36c2fb60e5a735
5
5
  SHA512:
6
- metadata.gz: 22ff1352722f5c7ab9370db0258b459514f5c0ba883277095c0c7382f9a15a84c5a2c8b81ea9f3d10e7d923414898a40a89b292ebc1a7351b02daa589b1b69a7
7
- data.tar.gz: 37bfb9af8d13a58c954c069ab73c41adfb7a159d2bf0485db8ec64247a98f53fae106fe9cafa71ce4f16867d44512213b083facb4ae10f394ad72b9196733ae9
6
+ metadata.gz: 707d1cbbcc24bc51d8fcd4b49689ce77068564c56ef927c05119641865c21f836cbdda948d18cbbfb6c497e79ecfb7d291439984a98d05c9048a5d41af72465b
7
+ data.tar.gz: e0b9649739d265bb1e8a2aa0e79afbe1d1894e54ebd894aa692e96218521f776819bc4d0d42d6d41e06c381954c7d34d0349f6c8c753dbc0494141e2cb92a8bf
data/Gemfile.lock CHANGED
@@ -1,40 +1,38 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mina-dox (0.1.0)
4
+ mina-dox (0.2.0)
5
5
  mina (~> 1.0)
6
6
 
7
7
  GEM
8
8
  remote: https://rubygems.org/
9
9
  specs:
10
- diff-lcs (1.3)
11
- mina (1.2.3)
12
- open4 (~> 1.3.4)
10
+ diff-lcs (1.6.1)
11
+ mina (1.2.5)
13
12
  rake
14
- open4 (1.3.4)
15
- rake (10.5.0)
16
- rspec (3.7.0)
17
- rspec-core (~> 3.7.0)
18
- rspec-expectations (~> 3.7.0)
19
- rspec-mocks (~> 3.7.0)
20
- rspec-core (3.7.1)
21
- rspec-support (~> 3.7.0)
22
- rspec-expectations (3.7.0)
13
+ rake (13.2.1)
14
+ rspec (3.13.0)
15
+ rspec-core (~> 3.13.0)
16
+ rspec-expectations (~> 3.13.0)
17
+ rspec-mocks (~> 3.13.0)
18
+ rspec-core (3.13.3)
19
+ rspec-support (~> 3.13.0)
20
+ rspec-expectations (3.13.4)
23
21
  diff-lcs (>= 1.2.0, < 2.0)
24
- rspec-support (~> 3.7.0)
25
- rspec-mocks (3.7.0)
22
+ rspec-support (~> 3.13.0)
23
+ rspec-mocks (3.13.3)
26
24
  diff-lcs (>= 1.2.0, < 2.0)
27
- rspec-support (~> 3.7.0)
28
- rspec-support (3.7.1)
25
+ rspec-support (~> 3.13.0)
26
+ rspec-support (3.13.3)
29
27
 
30
28
  PLATFORMS
31
29
  ruby
32
30
 
33
31
  DEPENDENCIES
34
- bundler (~> 1.16)
32
+ bundler
35
33
  mina-dox!
36
- rake (~> 10.0)
37
- rspec (~> 3.0)
34
+ rake
35
+ rspec
38
36
 
39
37
  BUNDLED WITH
40
- 1.16.1
38
+ 2.6.8
data/README.md CHANGED
@@ -22,7 +22,7 @@ Or install it yourself as:
22
22
 
23
23
  Add to your `deploy.rb`
24
24
 
25
- ```
25
+ ```ruby
26
26
  require 'mina-dox'
27
27
  ```
28
28
 
@@ -35,7 +35,7 @@ set :dox_path, "api/#{fetch(:dox_version)}/docs"
35
35
 
36
36
  ## Tasks
37
37
 
38
- ```
38
+ ```ruby
39
39
  :dox:generate # Assumes you have a rake task called 'dox:html'
40
40
  :dox:publish # Publishes the generated docs
41
41
  ```
@@ -43,13 +43,13 @@ set :dox_path, "api/#{fetch(:dox_version)}/docs"
43
43
  ## Dox generating task:
44
44
 
45
45
  Example:
46
- ```
46
+ ```ruby
47
47
  namespace :dox do
48
48
  task :md, [:version, :docs_path, :host] do |_, args|
49
49
  require 'rspec/core/rake_task'
50
50
 
51
51
  version = args[:version] || :v1
52
- docs_path = args[:docs_path] || "api/${version}/docs"
52
+ docs_path = args[:docs_path] || "api/#{version}/docs"
53
53
 
54
54
  RSpec::Core::RakeTask.new(:api_spec) do |t|
55
55
  t.pattern = "spec/requests/#{version}/"
@@ -62,13 +62,13 @@ namespace :dox do
62
62
 
63
63
  task :html, [:version, :docs_path, :host] => :erb do |_, args|
64
64
  version = args[:version] || :v1
65
- docs_path = args[:docs_path] || "api/${version}/docs"
65
+ docs_path = args[:docs_path] || "api/#{version}/docs"
66
66
  `node_modules/.bin/aglio -i public/#{docs_path}/apispec.md -o public/#{docs_path}/index.html --theme-full-width --theme-variables flatly`
67
67
  end
68
68
 
69
69
  task :open, [:version, :docs_path, :host] => :html do |_, args|
70
70
  version = args[:version] || :v1
71
- docs_path = args[:docs_path] || "api/${version}/docs"
71
+ docs_path = args[:docs_path] || "api/#{version}/docs"
72
72
 
73
73
  `open public/#{docs_path}/index.html`
74
74
  end
@@ -78,7 +78,7 @@ namespace :dox do
78
78
 
79
79
  host = args[:host] || 'http://localhost:3000'
80
80
  version = args[:version] || :v1
81
- docs_path = args[:docs_path] || "api/${version}/docs"
81
+ docs_path = args[:docs_path] || "api/#{version}/docs"
82
82
 
83
83
  File.open("public/#{docs_path}/apispec.md", 'w') do |f|
84
84
  f.write(ERB.new(File.read("public/#{docs_path}/apispec.md.erb")).result(binding))
@@ -89,7 +89,7 @@ end
89
89
 
90
90
  can be used as:
91
91
 
92
- ```
92
+ ```sh
93
93
  rake 'api:doc:html[v1, api/v1/docs, https://production.byinfinum.co]'
94
94
  ```
95
95
 
@@ -18,7 +18,7 @@ namespace :dox do
18
18
  run(:local) do
19
19
  local_path = "public/#{fetch(:dox_path)}/index.html"
20
20
  remote_path = "#{fetch(:user)}@#{fetch(:domain)}:#{fetch(:current_path)}/public/#{fetch(:dox_path)}"
21
- command "scp -P #{fetch(:port)} #{local_path} #{remote_path}"
21
+ command "scp -P #{fetch(:port)} #{fetch(:ssh_options)} #{local_path} #{remote_path}"
22
22
  end
23
23
  end
24
24
  end
@@ -1,5 +1,5 @@
1
1
  module Mina
2
2
  module Dox
3
- VERSION = '0.1.0'
3
+ VERSION = '0.2.0'
4
4
  end
5
5
  end
data/mina-dox.gemspec CHANGED
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
24
24
 
25
25
  spec.add_runtime_dependency 'mina', '~> 1.0'
26
26
 
27
- spec.add_development_dependency 'bundler', '~> 1.16'
28
- spec.add_development_dependency 'rake', '~> 10.0'
29
- spec.add_development_dependency 'rspec', '~> 3.0'
27
+ spec.add_development_dependency 'bundler'
28
+ spec.add_development_dependency 'rake'
29
+ spec.add_development_dependency 'rspec'
30
30
  end
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mina-dox
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stjepan Hadjic
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2018-02-02 00:00:00.000000000 Z
10
+ date: 2025-05-05 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: mina
@@ -28,45 +27,44 @@ dependencies:
28
27
  name: bundler
29
28
  requirement: !ruby/object:Gem::Requirement
30
29
  requirements:
31
- - - "~>"
30
+ - - ">="
32
31
  - !ruby/object:Gem::Version
33
- version: '1.16'
32
+ version: '0'
34
33
  type: :development
35
34
  prerelease: false
36
35
  version_requirements: !ruby/object:Gem::Requirement
37
36
  requirements:
38
- - - "~>"
37
+ - - ">="
39
38
  - !ruby/object:Gem::Version
40
- version: '1.16'
39
+ version: '0'
41
40
  - !ruby/object:Gem::Dependency
42
41
  name: rake
43
42
  requirement: !ruby/object:Gem::Requirement
44
43
  requirements:
45
- - - "~>"
44
+ - - ">="
46
45
  - !ruby/object:Gem::Version
47
- version: '10.0'
46
+ version: '0'
48
47
  type: :development
49
48
  prerelease: false
50
49
  version_requirements: !ruby/object:Gem::Requirement
51
50
  requirements:
52
- - - "~>"
51
+ - - ">="
53
52
  - !ruby/object:Gem::Version
54
- version: '10.0'
53
+ version: '0'
55
54
  - !ruby/object:Gem::Dependency
56
55
  name: rspec
57
56
  requirement: !ruby/object:Gem::Requirement
58
57
  requirements:
59
- - - "~>"
58
+ - - ">="
60
59
  - !ruby/object:Gem::Version
61
- version: '3.0'
60
+ version: '0'
62
61
  type: :development
63
62
  prerelease: false
64
63
  version_requirements: !ruby/object:Gem::Requirement
65
64
  requirements:
66
- - - "~>"
65
+ - - ">="
67
66
  - !ruby/object:Gem::Version
68
- version: '3.0'
69
- description:
67
+ version: '0'
70
68
  email:
71
69
  - d4be4st@gmail.com
72
70
  executables: []
@@ -94,7 +92,6 @@ licenses:
94
92
  - MIT
95
93
  metadata:
96
94
  allowed_push_host: https://rubygems.org
97
- post_install_message:
98
95
  rdoc_options: []
99
96
  require_paths:
100
97
  - lib
@@ -109,9 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
109
106
  - !ruby/object:Gem::Version
110
107
  version: '0'
111
108
  requirements: []
112
- rubyforge_project:
113
- rubygems_version: 2.7.3
114
- signing_key:
109
+ rubygems_version: 3.6.2
115
110
  specification_version: 4
116
111
  summary: Mina plugin for dox
117
112
  test_files: []