spectat-jekyll 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a2af09733c117d98f58c5fd80df8991958dca719da576c810588ba55e965eb1
+  data.tar.gz: 2c473294983f3136afa34635e9b39a1eb86194a7b3aac01a113e3b903812c609
+SHA512:
+  metadata.gz: 8e0f4f87b7944852b374311a57fcad730e0c2dd75109d39afe9871af93616e4500ddf23cc855affce7deb36043684722b784f80ecc90d20793a7b2291d70b170
+  data.tar.gz: 232e53aee11431a856d867ef256584235920666bf613b781c83d31b6768dd83d3c0d505fd114d406c948f65fca0b8ef61e8434cb01c3a9caff135b8057a1b937

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,6 @@
+test:
+  image: ruby:2.5
+  script:
+    - bundle install
+    - bundle exec rake
+    - bundle exec rake build

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - spec/**/*.rb
+Metrics/LineLength:
+  Max: 110

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 spectat-jekyll.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# Spectat::Jekyll
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/spectat/jekyll`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spectat-jekyll'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spectat-jekyll
+
+## Usage
+
+### Capistrano Config
+
+Create a file `Capfile`:
+
+```ruby
+require 'spectat/jekyll/deploy'
+```
+
+Create the `config` directory:
+
+```
+$ mkdir config
+```
+
+For instance, given an FQDN `www.spectatdesigns.co.uk`, sourced from https://gitlab.com/spectat/spectat/spectatdesigns.co.uk/, create the file `config/deploy.rb`:
+
+```ruby
+set :application, 'www.spectatdesigns.co.uk'
+set :full_repo_path, 'spectat/spectat/spectatdesigns.co.uk'
+```
+
+## 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/[USERNAME]/spectat-jekyll.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new :lint
+
+task default: %i[lint spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'spectat/jekyll'
+
+# 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/spectat/jekyll/deploy/stages/production.rb

@@ -0,0 +1,6 @@
+require 'spectat/fqdn'
+
+fqdn_helper = Spectat::Fqdn.new(fetch(:application), 'production')
+set :deploy_to, fqdn_helper.site_dir
+
+server fqdn_helper.fqdn, user: fqdn_helper.user, roles: %(app)

data/lib/spectat/jekyll/deploy/stages/review.rb

@@ -0,0 +1,8 @@
+require 'spectat/fqdn'
+
+fqdn_str = Spectat::Fqdn.review_apps_fqdn(fetch(:application))
+fqdn_helper = Spectat::Fqdn.new(fqdn_str, 'staging')
+
+set :deploy_to, "#{fqdn_helper.site_dir}/#{fetch :tag}"
+
+server fqdn_helper.fqdn, user: fqdn_helper.user, roles: %(app)

data/lib/spectat/jekyll/deploy/stages/staging.rb

@@ -0,0 +1,6 @@
+require 'spectat/fqdn'
+
+fqdn_helper = Spectat::Fqdn.new(fetch(:application), 'staging')
+set :deploy_to, fqdn_helper.site_dir
+
+server fqdn_helper.fqdn, user: fqdn_helper.user, roles: %(app)

data/lib/spectat/jekyll/deploy/tasks/deploy.rake

@@ -0,0 +1,30 @@
+namespace :deploy do
+  desc 'Deploy the site'
+
+  task :pull do
+    desc 'Pull the latest image'
+    on roles(:app) do
+      execute "docker pull #{fetch :image_to_deploy}"
+    end
+  end
+
+  task :copy do
+    desc 'Copy the files from the new image to the release_path'
+    on roles(:app) do
+      within(release_path) do
+        container_id = capture("docker create #{fetch :image_to_deploy} echo")
+        # make the top-level directory, so we can copy into it
+        execute "mkdir #{release_path}/_dist"
+        # copy built site into the `html` folder
+        execute "docker cp #{container_id}:/site #{release_path}/_dist/html"
+        # ensure permissions are correct
+        execute "chmod -R o-rwX #{release_path}"
+        # remove the created container, as we don't need it any more
+        execute "docker rm #{container_id}"
+      end
+    end
+  end
+
+  after :updated, :pull
+  after :pull, :copy
+end

data/lib/spectat/jekyll/deploy/tasks/review.rake

@@ -0,0 +1,7 @@
+task :stop do
+  on roles(:app) do
+    within(release_path) do
+      execute "rm -rf #{fetch :deploy_to}"
+    end
+  end
+end

data/lib/spectat/jekyll/deploy.rb

@@ -0,0 +1,47 @@
+set :stage_config_path, File.join(File.dirname(__FILE__), 'deploy', 'stages')
+
+require 'capistrano/setup'
+require 'capistrano/deploy'
+
+lock '~> 3.7.1'
+
+require 'capistrano/scm/git'
+install_plugin Capistrano::SCM::Git
+
+# pick up any custom Capistrano tasks
+Dir.glob(File.join(File.dirname(__FILE__), 'deploy/tasks/*.rake')).each { |r| import r }
+
+set :stages, %w[staging production review]
+set :default_stage, 'staging'
+
+# `:full_repo_path` should be set within `config/deploy.rb`. Note that we use a
+# lambda (`->{ }`) to lazy load the value, once other config files have been
+# parsed
+set :repo_url, -> { "git@gitlab.com:#{fetch(:full_repo_path)}.git" }
+
+# Branch for Capistrano checkout {{{
+if ENV['CI_BUILD_REF_NAME']
+  set :branch, ENV['CI_BUILD_REF_NAME']
+else
+  set :branch, 'master'
+end
+# }}}
+
+# Docker registry {{{
+set :registry_url, 'registry.gitlab.com'
+
+set :tag, 'master'
+set :tag, ENV['CI_COMMIT_REF_SLUG'] if ENV['CI_COMMIT_REF_SLUG']
+if fetch(:tag) == 'master'
+  if fetch(:stage) == :production
+    set :tag, 'latest'
+  elsif fetch(:stage) == :staging
+    set :tag, 'master'
+  end
+end
+
+# `:full_repo_path` should be set within `config/deploy.rb`. Note that we use a
+# lambda (`->{ }`) to lazy load the value, once other config files have been
+# parsed
+set :image_to_deploy, -> { "#{fetch(:registry_url)}/#{fetch(:full_repo_path)}:#{fetch(:tag)}" }
+# }}}

data/lib/spectat/jekyll/version.rb

@@ -0,0 +1,5 @@
+module Spectat
+  module Jekyll
+    VERSION = '0.1.3'.freeze
+  end
+end

data/lib/spectat/jekyll.rb

@@ -0,0 +1 @@
+require 'spectat/jekyll/version'

data/spectat-jekyll.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spectat/jekyll/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spectat-jekyll'
+  spec.version       = Spectat::Jekyll::VERSION
+  spec.authors       = ['Jamie Tanna']
+  spec.email         = ['rubygems@jamietanna.co.uk']
+
+  spec.summary       = 'Opinionated Jekyll + Capistrano configuration for Spectat Designs sites'
+  spec.description   = 'Opinionated Jekyll + Capistrano configuration for Spectat Designs sites'
+  spec.homepage      = 'https://gitlab.com/spectat/gems/spectat-jekyll-gem'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  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.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.55.0'
+
+  spec.add_runtime_dependency 'capistrano', '~> 3.7.1'
+  spec.add_runtime_dependency 'jekyll', '~> 3.7.3'
+  # https://github.com/jekyll/jekyll/issues/4838
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'spectat', '~> 0.1.0'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: spectat-jekyll
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Jamie Tanna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spectat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Opinionated Jekyll + Capistrano configuration for Spectat Designs sites
+email:
+- rubygems@jamietanna.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spectat/jekyll.rb
+- lib/spectat/jekyll/deploy.rb
+- lib/spectat/jekyll/deploy/stages/production.rb
+- lib/spectat/jekyll/deploy/stages/review.rb
+- lib/spectat/jekyll/deploy/stages/staging.rb
+- lib/spectat/jekyll/deploy/tasks/deploy.rake
+- lib/spectat/jekyll/deploy/tasks/review.rake
+- lib/spectat/jekyll/version.rb
+- spectat-jekyll.gemspec
+homepage: https://gitlab.com/spectat/gems/spectat-jekyll-gem
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: Opinionated Jekyll + Capistrano configuration for Spectat Designs sites
+test_files: []