development-toolbox 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73194980d52600991c585260695b41b5b571a291
-  data.tar.gz: 283c5500828a75862171e119ee27cccfff4586a1
+  metadata.gz: c10a9e633173c4c4aaaa8da134ffd1489db061ce
+  data.tar.gz: 4f84850071b231207ac8bacf02c9057918f07f9a
 SHA512:
-  metadata.gz: a6646b35466611ab2e62c6af5d7126ff65a548d5c9d195a035191b03fa0eb565952a5327e244e793e03979ec3d2d75e0e3c5b7395e77810cc0201f1e394b461c
-  data.tar.gz: 8d63b82b7db8691130c470919432b2e79c044886325375debd521dea2cf8133e10b4dc324547fb44210b0f7e34d92e380cc3d68c368b819463eec3d25fc1ca1c
+  metadata.gz: 3cf0ab05d0508c591c32091bb52cafdd1f3da370b4d7a2a8627cef591868eb5ecaf67733bb55da474df136849b986359b044c94ee2d9c61411036241f40f8b7a
+  data.tar.gz: c865f099320e033e21246068c8276e75448deeca3a376b2db8f10acb98479e16000ae405597b9d8a7908821803190e6c5590b271bf4810d38847deccbf1234a7

data/.gitlab-ci.yml

@@ -1,19 +1,90 @@
-# This file is a template, and might need editing before it works on your project.
-# Official language image. Look for the different tagged releases at:
-image: ruby:latest
-
-# Cache gems in between builds
-cache:
-  paths:
-  - .bundle
-
-# This is a basic example for a gem or script which doesn't use
-# services such as redis or postgres
-before_script:
-- ruby -v                                     # Print out ruby version for debugging
-- gem install bundler --no-ri --no-rdoc       # Bundler is not installed with the image
-- bundle install -j $(nproc) --path=".bundle" # Install dependencies into ./.bundle
-
-rake:
+# See documentation at https://docs.gitlab.com/ee/ci/yaml/README.html
+variables:
+  CI_REGISTRY_IMAGE_LATEST: $CI_REGISTRY_IMAGE:latest
+  CI_REGISTRY_IMAGE_STABLE: $CI_REGISTRY_IMAGE:stable
+
+stages:
+- test
+- deploy
+
+.docker_build: &docker
+  image: docker:latest
+  services:
+  - docker:dind
+  before_script:
+  - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY
+
+.ruby_build: &ruby
+  image: $CI_REGISTRY_IMAGE_LATEST
+  # Cache gems in between builds
+  cache:
+    paths:
+    - /cache
+  # This is a basic example for a gem or script which doesn't use
+  # services such as redis or postgres
+  before_script:
+  - ruby -v                                     # Print out ruby version for debugging
+  - gem install bundler --no-ri --no-rdoc       # Bundler is not installed with the image
+  - bundle install -j $(nproc) --path=".bundle" # Install dependencies into ./.bundle
+
+.release_docker_image: &release_docker_image
+  <<: *docker
+  stage: deploy
   script:
-  - rake
+  - echo "Releasing ${$TARGET_IMAGE} from $CI_REGISTRY_IMAGE_LATEST"
+  - docker pull $CI_REGISTRY_IMAGE_LATEST
+  - docker tag $CI_REGISTRY_IMAGE_LATEST ${$TARGET_IMAGE}
+  - docker push ${$TARGET_IMAGE}
+
+test:
+  <<: *ruby
+  script: bin/rake test
+  stage: test
+  artifacts:
+    paths:
+    - Gemfile.lock
+    - spec/reports
+    - coverage
+
+doc:
+  <<: *ruby
+  script: bin/rake doc
+  stage: test
+  artifacts:
+    paths:
+    - doc
+
+build latest docker:
+  <<: *docker
+  stage: deploy
+  only:
+  - develop
+  dependencies:
+  - test
+  script:
+  - echo "Building $CI_REGISTRY_IMAGE_LATEST"
+  - docker build --pull -t $CI_REGISTRY_IMAGE_LATEST .
+  - docker push $CI_REGISTRY_IMAGE_LATEST
+
+build stable docker:
+  <<: *docker
+  stage: deploy
+  only:
+  - master
+  dependencies:
+  - test
+  script:
+  - echo "Building $CI_REGISTRY_IMAGE_STABLE"
+  - docker build --pull -t $CI_REGISTRY_IMAGE_STABLE .
+  - docker push $CI_REGISTRY_IMAGE_STABLE
+
+build_gem:
+  <<: *ruby
+  script: bin/rake build
+  only:
+  - develop
+  stage: deploy
+  artifacts:
+    paths:
+    - doc
+    - pkg

data/.yardopts

@@ -0,0 +1,4 @@
+--title='Development::Toolbox'
+--load=lib/yard/templates/helpers/markup_helper/commonmarker.rb
+--markup-provider=commonmarker
+--markup=markdown

data/Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:2.4-alpine
+
+RUN apk --update --upgrade add --no-cache \
+    build-base \
+    cmake \
+    coreutils \
+    git
+
+RUN mkdir /app
+WORKDIR /app
+
+RUN gem install bundler --no-ri --no-rdoc
+
+ADD lib/development/toolbox/version.rb /app/lib/development/toolbox/version.rb
+ADD development-toolbox.gemspec /app/development-toolbox.gemspec
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+
+RUN bundle install
+
+ADD . /app

data/README.md

@@ -11,7 +11,7 @@ Set of tools every Ruby developer needs to provide quality Ruby code.
                 `spec.add_development_dependency 'development-toolbox'`
         * _developing an app:_
             1. Add this line to your application's Gemfile:
-               `gem 'development-toolbox'`
+               `gem 'development-toolbox', group: %i[development test]`
     1. And then execute: `bundle` to install required dependencies.
 *   _Or install it yourself if you have no code yet:_
     1. Execute `gem install development-toolbox`

data/development-toolbox.gemspec

@@ -24,9 +24,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'bundler', '~> 1.13'
+  spec.add_runtime_dependency 'bundler-audit', '~> 0.5'
+  spec.add_runtime_dependency 'commonmarker', '~> 0.14'
+  spec.add_runtime_dependency 'github-markup', '~> 1.6'
   spec.add_runtime_dependency 'rake', '~> 12.0'
   spec.add_runtime_dependency 'rspec', '~> 3.5'
   spec.add_runtime_dependency 'rubocop', '~> 0.48'
   spec.add_runtime_dependency 'yard', '~> 0.9'
-  spec.add_runtime_dependency 'kramdown', '~> 1.13'
 end

data/docker-compose.yml

@@ -0,0 +1,4 @@
+version: '2'
+services:
+  gem:
+    image: registry.gitlab.com/alsemyonov/development-toolbox:latest

data/lib/commonmarker/compat.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'commonmarker/compat_renderer'
+
+Markdown = CommonMarker::CompatRenderer unless defined? Markdown

data/lib/commonmarker/compat_renderer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'commonmarker'
+
+module CommonMarker
+  # Compatibility with the RedCloth API.
+  # @see https://github.com/vmg/redcarpet/blob/master/lib/redcarpet/compat.rb#L1
+  class CompatRenderer
+    attr_accessor :text
+
+    GITHUB_EXTENSIONS = %i[tagfilter autolink table strikethrough].freeze
+
+    def initialize(text, exts = GITHUB_EXTENSIONS, options: :GITHUB_PRE_LANG)
+      @text = text
+      @extensions = GITHUB_EXTENSIONS | exts
+      @options = options
+    end
+
+    def to_html(*_dummy)
+      CommonMarker.render_html(text, options, extensions)
+    end
+
+    private
+
+    # @return [String]
+    attr_reader :text
+
+    # @return [Symbol]
+    attr_reader :options
+
+    # @return [<Symbol>]
+    attr_reader :extensions
+  end
+end

data/lib/development/toolbox/version.rb

@@ -2,6 +2,6 @@
 
 module Development
   module Toolbox
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/yard/templates/helpers/markup_helper/commonmarker.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'yard/templates/helpers/markup_helper'
+require 'commonmarker/compat_renderer'
+require 'github-markup'
+require 'github/markup'
+
+# @see https://github.com/lsegal/yard/blob/master/lib/yard/templates/helpers/markup_helper.rb#L26
+YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown] <<
+  { lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }

data/rakelib/audit.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/audit/cli'
+
+namespace :audit do
+  desc 'Updates the ruby-advisory-db'
+  task :update do
+    Bundler::Audit::CLI.start %w[update]
+  end
+
+  desc 'Check bundle for vulnerable dependencies'
+  task test: :update do
+    Bundler::Audit::CLI.start %w[check]
+  end
+end

data/rakelib/test.rake

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 desc 'Test and check style'
-task test: %i[spec style]
+task test: %i[spec audit:test style]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: development-toolbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Semyonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: kramdown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 description: Efficient Developer tools
 email:
 - alex@semyonov.us
@@ -109,7 +137,9 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE
 - README.md
@@ -131,10 +161,15 @@ files:
 - bin/yardoc
 - bin/yri
 - development-toolbox.gemspec
+- docker-compose.yml
 - exe/development-toolbox
+- lib/commonmarker/compat.rb
+- lib/commonmarker/compat_renderer.rb
 - lib/development/tasks.rb
 - lib/development/toolbox.rb
 - lib/development/toolbox/version.rb
+- lib/yard/templates/helpers/markup_helper/commonmarker.rb
+- rakelib/audit.rake
 - rakelib/default.rake
 - rakelib/doc.rake
 - rakelib/spec.rake
@@ -160,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Development toolbox for a Ruby programmer