Skip to content

Commit

Permalink
Initial files
Browse files Browse the repository at this point in the history
  • Loading branch information
rphillips-nz committed Nov 4, 2019
0 parents commit c1e6654
Show file tree
Hide file tree
Showing 57 changed files with 1,987 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
spec/dest/
25 changes: 25 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
require: rubocop-jekyll

inherit_gem:
rubocop-jekyll: .rubocop.yml

AllCops:
TargetRubyVersion: 2.5
Include:
- lib/**/*.rb

Exclude:
- .gitignore
- .rspec
- .rubocop.yml
- .travis.yml
- Gemfile.lock
- HISTORY.md
- LICENSE.txt
- README.md
- script/**/*
- vendor/**/*

Naming/MemoizedInstanceVariableName:
Exclude:
- lib/cloudcannon-jekyll/page-without-a-file.rb
17 changes: 17 additions & 0 deletions Appraisals
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# frozen_string_literal: true

appraise "jekyll-2" do
gem "jekyll", "2.4.0"
end

appraise "jekyll-3-0-0" do
gem "jekyll", "3.0.0"
end

appraise "jekyll-3-8-5" do
gem "jekyll", "3.8.5"
end

appraise "jekyll-4" do
gem "jekyll", "4.0.0"
end
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
source "https://rubygems.org"

gemspec
115 changes: 115 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
PATH
remote: .
specs:
cloudcannon-jekyll (0.0.1)
jekyll (>= 2.4.0, < 5)

GEM
remote: https://rubygems.org/
specs:
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
appraisal (2.2.0)
bundler
rake
thor (>= 0.14.0)
ast (2.4.0)
colorator (1.1.0)
concurrent-ruby (1.1.5)
diff-lcs (1.3)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.11.1)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (1.7.0)
concurrent-ruby (~> 1.0)
jaro_winkler (1.5.4)
jekyll (4.0.0)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (>= 0.9.5, < 2)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 1.8)
jekyll-sass-converter (2.0.1)
sassc (> 2.0.1, < 3.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.1.0)
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.2.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
parallel (1.18.0)
parser (2.6.5.0)
ast (~> 2.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.1)
rainbow (3.0.0)
rake (13.0.0)
rb-fsevent (0.10.3)
rb-inotify (0.10.0)
ffi (~> 1.0)
rouge (3.12.0)
rspec (3.9.0)
rspec-core (~> 3.9.0)
rspec-expectations (~> 3.9.0)
rspec-mocks (~> 3.9.0)
rspec-core (3.9.0)
rspec-support (~> 3.9.0)
rspec-expectations (3.9.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.9.0)
rspec-mocks (3.9.0)
diff-lcs (>= 1.2.0, < 2.0)
rspec-support (~> 3.9.0)
rspec-support (3.9.0)
rubocop (0.71.0)
jaro_winkler (~> 1.5.1)
parallel (~> 1.10)
parser (>= 2.6)
rainbow (>= 2.2.2, < 4.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 1.4.0, < 1.7)
rubocop-jekyll (0.10.0)
rubocop (>= 0.68.0, < 0.72.0)
rubocop-performance (~> 1.2)
rubocop-performance (1.5.0)
rubocop (>= 0.71.0)
ruby-progressbar (1.10.1)
safe_yaml (1.0.5)
sassc (2.2.1)
ffi (~> 1.9)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thor (0.20.3)
unicode-display_width (1.6.0)

PLATFORMS
ruby

DEPENDENCIES
appraisal (~> 2.2)
cloudcannon-jekyll!
rake (~> 13.0)
rspec (~> 3.9)
rubocop (~> 0.71)
rubocop-jekyll (~> 0.10)

BUNDLED WITH
2.0.2
3 changes: 3 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 0.0.1

* Initial version
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 CloudCannon

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.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# CloudCannon Jekyll plugin

A Jekyll plugin to create CloudCannon editor details.


## Usage

1. Add `gem 'cloudcannon-jekyll'` to your site's `Gemfile`
2. Run `bundle install`
3. Add the following to your site's `_config.yml`:

```yaml
plugins:
- cloudcannon-jekyll
```
💡 If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.
## Releasing new version
1. Increase version in lib/cloudcannon-jekyll/version.rb
2. Update HISTORY.md
3. Create a release and tag in GitHub
4. Build new gem with `gem build cloudcannon-jekyll.gemspec`
5. Push new version to rubygems.org with `gem push cloudcannon-jekyll-{{ VERSION HERE }}.gem`


## Testing

```
bundle exec rake test
```
Test multiple Jekyll versions with Appraisal:
```
bundle exec appraisal install
bundle exec appraisal rake test
bundle exec appraisal jekyll-2 rake test
bundle exec appraisal jekyll-4 rake test
```
7 changes: 7 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :test => :spec
task :default => :spec
25 changes: 25 additions & 0 deletions cloudcannon-jekyll.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# coding: utf-8

lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

require "cloudcannon-jekyll/version"

Gem::Specification.new do |spec|
spec.name = "cloudcannon-jekyll"
spec.summary = "CloudCannon Jekyll integration"
spec.description = "Creates CloudCannon editor details for Jekyll"
spec.version = CloudCannonJekyll::VERSION
spec.authors = ["CloudCannon"]
spec.email = ["[email protected]"]
spec.homepage = "https://github.com/cloudcannon/cloudcannon-jekyll"
spec.licenses = ["MIT"]
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
spec.require_paths = ["lib"]
spec.add_dependency "jekyll", ">= 2.4.0", "< 5"
spec.add_development_dependency "appraisal", "~> 2.2"
spec.add_development_dependency "rake", "~> 13.0"
spec.add_development_dependency "rspec", "~> 3.9"
spec.add_development_dependency "rubocop", "~> 0.71"
spec.add_development_dependency "rubocop-jekyll", "~> 0.10"
end
2 changes: 2 additions & 0 deletions gemfiles/.bundle/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
BUNDLE_RETRY: "1"
7 changes: 7 additions & 0 deletions gemfiles/jekyll_2.gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# This file was generated by Appraisal

source "https://rubygems.org"

gem "jekyll", "2.4.0"

gemspec path: "../"
Loading

0 comments on commit c1e6654

Please sign in to comment.