mina-dox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6298391a9f7fdf14a14e15687672adb9e29d54a92d45a92c43578bdce370a8b3
+  data.tar.gz: d1e8a19a448910befd98b5702eb838f38595938c6d32f2cf0ab1ce7e1c178418
+SHA512:
+  metadata.gz: 22ff1352722f5c7ab9370db0258b459514f5c0ba883277095c0c7382f9a15a84c5a2c8b81ea9f3d10e7d923414898a40a89b292ebc1a7351b02daa589b1b69a7
+  data.tar.gz: 37bfb9af8d13a58c954c069ab73c41adfb7a159d2bf0485db8ec64247a98f53fae106fe9cafa71ce4f16867d44512213b083facb4ae10f394ad72b9196733ae9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require: rubocop-rspec
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/support/dox/**/*'
+    - '**/tasks.rb'
+
+Documentation:
+  Enabled: False
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+WordArray:
+  Enabled: False
+
+SymbolArray:
+  Enabled: False
+
+AbcSize:
+  Max: 20
+
+Rails:
+  Enabled: true
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'lib/tasks/*.rake'
+
+AllCops:
+  Exclude:
+    - 'db/schema.rb'
+    - 'db/migrate/*.rb'
+    - 'config/**/*.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at d4be4st@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mina-dox.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    mina-dox (0.1.0)
+      mina (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mina (1.2.3)
+      open4 (~> 1.3.4)
+      rake
+    open4 (1.3.4)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mina-dox!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Stjepan Hadjic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# Mina::Dox
+
+This is a mina plugin for [dox](https://github.com/infinum/dox).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mina-dox', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mina-dox
+
+## Usage
+
+Add to your `deploy.rb`
+
+```
+require 'mina-dox'
+```
+
+## Variables
+
+```
+set :dox_version, 'v1'
+set :dox_path, "api/#{fetch(:dox_version)}/docs"
+```
+
+## Tasks
+
+```
+:dox:generate # Assumes you have a rake task called 'dox:html'
+:dox:publish  # Publishes the generated docs
+```
+
+## Dox generating task:
+
+Example:
+```
+namespace :dox do
+  task :md, [:version, :docs_path, :host] do |_, args|
+    require 'rspec/core/rake_task'
+
+    version = args[:version] || :v1
+    docs_path = args[:docs_path] || "api/${version}/docs"
+
+    RSpec::Core::RakeTask.new(:api_spec) do |t|
+      t.pattern = "spec/requests/#{version}/"
+      t.rspec_opts =
+        "-f Dox::Formatter --order defined -t dox -o public/#{docs_path}/apispec.md.erb"
+    end
+
+    Rake::Task['api_spec'].invoke
+  end
+
+  task :html, [:version, :docs_path, :host] => :erb do |_, args|
+    version = args[:version] || :v1
+    docs_path = args[:docs_path] || "api/${version}/docs"
+    `node_modules/.bin/aglio -i public/#{docs_path}/apispec.md -o public/#{docs_path}/index.html --theme-full-width --theme-variables flatly`
+  end
+
+  task :open, [:version, :docs_path, :host] => :html do |_, args|
+    version = args[:version] || :v1
+    docs_path = args[:docs_path] || "api/${version}/docs"
+
+    `open public/#{docs_path}/index.html`
+  end
+
+  task :erb, [:version, :docs_path, :host] => [:environment, :md] do |_, args|
+    require 'erb'
+
+    host = args[:host] || 'http://localhost:3000'
+    version = args[:version] || :v1
+    docs_path = args[:docs_path] || "api/${version}/docs"
+
+    File.open("public/#{docs_path}/apispec.md", 'w') do |f|
+      f.write(ERB.new(File.read("public/#{docs_path}/apispec.md.erb")).result(binding))
+    end
+  end
+end
+```
+
+can be used as:
+
+```
+rake 'api:doc:html[v1, api/v1/docs, https://production.byinfinum.co]'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/mina-dox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mina::Dox project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mina-dox/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mina/dox"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mina/dox.rb

@@ -0,0 +1,8 @@
+require 'mina/dox/version'
+require 'mina/dox/tasks'
+
+module Mina
+  module Dox
+    # Your code goes here...
+  end
+end

data/lib/mina/dox/tasks.rb

@@ -0,0 +1,24 @@
+set :dox_version, 'v1'
+set :dox_path, -> { "api/#{fetch(:dox_version)}/docs" }
+
+namespace :dox do
+  task :generate do
+    ensure!(:dox_version)
+    run :local do
+      command "RAILS_ENV=test bundle exec rake 'dox:html[#{fetch(:dox_version)}, #{fetch(:dox_path)}, https://#{fetch(:domain)}]'"
+    end
+  end
+
+  task publish: :generate do
+    ensure!(:dox_path)
+    run(:remote) do
+      command "mkdir -p #{fetch(:current_path)}/public/#{fetch(:dox_path)}"
+    end
+
+    run(:local) do
+      local_path = "public/#{fetch(:dox_path)}/index.html"
+      remote_path = "#{fetch(:user)}@#{fetch(:domain)}:#{fetch(:current_path)}/public/#{fetch(:dox_path)}"
+      command "scp -P #{fetch(:port)} #{local_path} #{remote_path}"
+    end
+  end
+end

data/lib/mina/dox/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  module Dox
+    VERSION = '0.1.0'
+  end
+end

data/mina-dox.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina/dox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mina-dox'
+  spec.version       = Mina::Dox::VERSION
+  spec.authors       = ['Stjepan Hadjic']
+  spec.email         = ['d4be4st@gmail.com']
+
+  spec.summary       = 'Mina plugin for dox'
+  spec.homepage      = 'https://github.com/infinum/mina-dox'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.add_runtime_dependency 'mina', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: mina-dox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stjepan Hadjic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- d4be4st@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mina/dox.rb
+- lib/mina/dox/tasks.rb
+- lib/mina/dox/version.rb
+- mina-dox.gemspec
+homepage: https://github.com/infinum/mina-dox
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Mina plugin for dox
+test_files: []