jekyll-version-docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04f1fddddd249527b6e62b5ee7b22ede906a95f0949c338aa13457d5137b5879
+  data.tar.gz: cfff8af486963a9c9b67a44c9025331385b5ca9c40f11872dd81f22af06c2e82
+SHA512:
+  metadata.gz: b9de75c2a83f34f77d2673f397befecde70ad4fa31509b81f5e4fae678efaa26c5b79741791956ec468e240361b2ebc7ed05e86ae4811a4fb006d71a69bd693a
+  data.tar.gz: 857f2d6186b557ecd6c4434ec2cd35a85211ebd7c32037b08203c71359f28fd8d67c57d5c62cff26cd09bc6ba95e0ae454911f1792dad24fb8896c3d386da0ae

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 reinangabriel1520@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-version-docs.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ReinanHS
+
+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,55 @@
+# Jekyll::Version::Docs
+
+> :warning: Please note that this plugin is **NOT** supported by GitHub pages. Here is a [list of all plugins supported](https://pages.github.com/versions/). However you can follow [this GitHub guide](https://help.github.com/articles/adding-jekyll-plugins-to-a-github-pages-site/) to enable it or by using [Travis CI](https://ayastreb.me/deploy-jekyll-to-github-pages-with-travis-ci/). GitLab supposedly supports [any plugin](https://about.gitlab.com/comparison/gitlab-pages-vs-github-pages.html).
+
+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/jekyll/version/docs`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+This gem was made specifically for Jekyll 3 or higher. This plugin aims to facilitate the documentation of projects with multiple versions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-version-docs'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll-version-docs
+
+## Usage
+
+The main commands of this plugin are:
+
+`bundle exec jekyll vdoc <VERSION>`
+
+Creates a version to be used as documentation
+
+See the main tags:
+
+- `{% doc_version %}` Shows the latest version
+- `{% doc_versions %}` Shows all versions
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/reinanhs/jekyll-version-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/reinanhs/jekyll-version-docs/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Jekyll::Version::Docs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/reinanhs/jekyll-version-docs/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/version/docs"
+
+# 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/jekyll-version-docs.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/jekyll/version/docs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-version-docs"
+  spec.version       = Jekyll::Version::Docs::VERSION
+  spec.authors       = ["ReinanHS"]
+  spec.email         = ["reinangabriel1520@gmail.com"]
+
+  spec.summary       = "Control your documentation"
+  spec.description   = "Provides your documentation with a version control system"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/jekyll/version/build/build-doc.rb

@@ -0,0 +1,111 @@
+require 'kramdown'
+module Jekyll
+  class PageWithoutAFile < Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+  class PageBuildDocs < Page
+    def initialize(site, base, dir, filename, version)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = 'index.html'
+
+      self.process(@name)
+      self.read_yaml(File.join(base, "_docs/#{version}"), filename)
+
+      self.content = Kramdown::Document.new(self.content).to_html
+    end
+  end
+  class BuildDoc < Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll-core
+    def generate(site)
+      return Jekyll.logger.warn "\tJekyll Version Doc: The basic structure for the plugin's operation was not found" if !File.directory?("#{Dir.pwd}/_docs/")
+     
+      @site = site
+
+      path = "#{Dir.pwd}/_docs/*"
+      Dir[path].each do |filename|
+        Jekyll.logger.info "\tSource: #{filename}"
+
+        version = self.getFileVersion(filename)
+        summaryFile = "#{filename}/Summary.md"
+        summaryList = []
+
+        if File.exists? summaryFile
+          summaryList = self.extractInformation(summaryFile, version)
+        else
+          summaryList = self.extractInformationDir(filename, version)
+        end
+
+        filePath = "#{Dir.pwd}/_site/docs/#{version}"
+        FileUtils.mkpath(filePath) unless File.exists?(filePath)
+
+
+        summary_json = PageWithoutAFile.new(site, site.source, "/docs/#{version}", "summary.json")
+        summary_json.content = summaryList.to_json
+        site.pages << summary_json
+        
+        page = Jekyll::PageBuildDocs.new(site, site.source, "/docs/#{version}/", "#{summaryList[0].values[0]}.md", version)
+        page.data["sitemap"] = false
+        site.pages << page
+      end
+    end
+
+    def extractInformation(filename, version)
+      summaryList = []
+      summary = File.read(filename).split('-')
+      summary.each do |string|
+        title = string[(string.index("[").to_i)+1..(string.index("]").to_i)-1]
+        link = string[(string.index("(").to_i)+1..(string.index(")").to_i)-1]
+        link.to_s.sub! '.md', ''
+        link.to_s.sub! './', ''
+        # Link without the need for JavaScript
+        # link = self.getUrl("/docs/#{version}/#{link}")
+        if !title.nil? 
+          summaryList.push({ title: title, link: link })
+        end
+      end
+
+      return summaryList
+    end
+
+    def extractInformationDir(dir, version)
+      summaryList = []
+      summary = Dir["#{dir}/*.md"]
+      summary.each do |filename|
+        filename = filename.split('/').last()
+        title = filename.to_s.sub! '.md', ''
+        link = filename
+        # Link without the need for JavaScript
+        # link = self.getUrl("/docs/#{version}/#{link}") 
+        if !title.nil? && title != 'Summary.md'
+          summaryList.push({ title: title, link: link })
+        end
+      end
+
+      return summaryList
+    end
+
+    def getFileVersion(filename)
+      version = filename.split('/')
+      return version[(version.length-1)]
+    end
+
+    def getLastVersion
+      path = "#{Dir.pwd}/_docs/*"
+      return Dir[path].last().to_s.split("/").last()
+    end
+
+    def getUrl(input)
+      return if input.nil?
+      return Addressable::URI.parse(
+        @site.config["url"].to_s + @site.config["baseurl"] + input
+      ).normalize.to_s
+    end
+  end
+end

data/lib/jekyll/version/commands/vdoc.rb

@@ -0,0 +1,69 @@
+require 'fileutils'
+
+module Jekyll
+  module Commands
+    class VDoc < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:vdoc) do |c|
+
+            c.syntax "vdoc VERSION"
+            c.description "Create a new version for the documentation"
+
+            c.action do |args, options|
+              if args.length != 1
+                Jekyll.logger.error "You entered the command with invalid parameters, See example: jekyll vdoc 1.0"
+              else
+                lastVersion = self.getLestVersion.to_s.split("/").last()
+                newVersion = args[0] ? args[0] : '0.0.1'
+                if !self.checkIncompatibility(lastVersion, newVersion)
+                  self.createVersion(newVersion)
+                  Jekyll.logger.info "Version #{newVersion} was successfully created"
+                end
+              end
+            end
+          end
+        end
+
+        def getLestVersion
+
+          path = "#{Dir.pwd}/_docs"
+
+          if !File.directory?(path)
+            Dir.mkdir(path) unless Dir.exist?(path)            
+          end
+
+          return Dir["#{path}/*"].last()
+        end
+
+        def createVersion(newVersion)
+          lastVersion_dir = Dir["#{self.getLestVersion}/*.md"]
+          path = "#{Dir.pwd}/_docs/#{newVersion.to_s}"
+
+          if !File.directory?(path)
+            Dir.mkdir(path) unless Dir.exist?(path)            
+          end
+
+          lastVersion_dir.each do |filename|
+            name = File.basename('filename', '.md')[0,4]
+            dest_folder = "#{path}/"
+            FileUtils.cp(filename, dest_folder)
+          end
+        end
+
+        def checkIncompatibility(lastVersion, newVersion)
+          path = "#{Dir.pwd}/_docs"
+
+          raise ArgumentError.new("A version already exists at #{path}/#{newVersion}") if(lastVersion == newVersion)
+
+          versions = Dir["#{path}/*"]
+          result = versions.find {|item| item == "#{path}/#{newVersion}" }
+          
+          raise ArgumentError.new("A version already exists at #{path}/#{newVersion}") if(result)
+
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/version/docs.rb

@@ -0,0 +1,14 @@
+require "jekyll/version/docs/version"
+
+module Jekyll
+  module Version
+    module Docs
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end
+
+require "jekyll/version/commands/vdoc"
+require "jekyll/version/build/build-doc"
+require "jekyll/version/tags/render-last-version"

data/lib/jekyll/version/docs/version.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module Version
+    module Docs
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/jekyll/version/tags/render-last-version.rb

@@ -0,0 +1,38 @@
+module Jekyll
+  class RenderLastVersion < Liquid::Tag
+
+    def initialize(tag_name, text, tokens)
+      super
+      path = "#{Dir.pwd}/_docs/*"
+      @lastVersion = Dir[path].last().to_s.split("/").last()
+    end
+
+    def render(context)
+      "#{@lastVersion}"
+    end
+  end
+
+  class RenderVersions < Liquid::Tag
+
+    include Jekyll::Filters::URLFilters
+
+    def initialize(tag_name, text, tokens)
+      super
+      path = "#{Dir.pwd}/_docs/*"
+      @versions = Dir[path]
+    end
+
+    def render(context)
+      list = ''
+      @versions.each do |filename|
+        version = filename.to_s.split("/").last()
+        list = list + '<a class="dropdown-item" href="'+version+'">'+"#{version}"+'</a>'
+      end
+
+      return list
+    end
+  end
+end
+
+Liquid::Template.register_tag('doc_version', Jekyll::RenderLastVersion)
+Liquid::Template.register_tag('doc_versions', Jekyll::RenderVersions)

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-version-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ReinanHS
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-06 00:00:00.000000000 Z
+dependencies: []
+description: Provides your documentation with a version control system
+email:
+- reinangabriel1520@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-version-docs.gemspec
+- lib/jekyll/version/build/build-doc.rb
+- lib/jekyll/version/commands/vdoc.rb
+- lib/jekyll/version/docs.rb
+- lib/jekyll/version/docs/version.rb
+- lib/jekyll/version/tags/render-last-version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Control your documentation
+test_files: []