jekyll-sketchviz 0.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 966e409936c2d7cfbdc57bd2cf0557543faf453ae7d8dde79ad84918acabf48c
+  data.tar.gz: 3236702c589ef5f2c7411828a358377e97fdac67bf67a6aae4c2a593f28dd98f
+SHA512:
+  metadata.gz: c852fd0feca4cb4bfc093203b38012bf0de7e122e2051f773d3059c3e21c659b07743e748d44f86a793d0b37e50311ea8968f20bf8bdaed11a69a9b783901543
+  data.tar.gz: 3e8bc9a3874699a867d8a2371bfee4e1741b705ccb1db18b3d4a4a5978852fff6274d158fb52bbd9fd44c07f6615686ae55d732fc9d1ec6416bf41008619b74a

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-22
+
+- Initial release

data/README.md

@@ -0,0 +1,35 @@
+# Jekyll::Sketchviz
+
+TODO: Delete this and the text below, and describe your gem
+
+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/sketchviz`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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]/jekyll-sketchviz.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/jekyll-sketchviz.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/sketchviz/version"
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/cprima/jekyll-sketchviz'
+
+  spec.name = "jekyll-sketchviz"
+  spec.version = "0.0.0.alpha"
+  spec.authors = ["Christian Prior-Mamulyan"]
+  spec.email = ["cprior@gmail.com"]
+
+  spec.summary = 'A Jekyll plugin to transform Graphviz .dot files into sketch-style SVGs using Rough.js.'
+  spec.description = <<~END_DESC
+    jekyll-sketchviz is a Jekyll plugin that integrates Graphviz and Rough.js to process .dot files into SVG diagrams during the site build. It supports configurable output formats, including unstyled filesystem SVGs and inline SVGs styled via CSS. The plugin leverages Jekyll collections for input management and provides a Liquid tag API for flexible inclusion in site content.
+  END_DESC
+  spec.homepage = host
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  spec.metadata["homepage_uri"] = host
+  spec.metadata["source_code_uri"] = "#{host}"
+  spec.metadata["changelog_uri"] = "#{host}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "jekyll", ">= 3.0" # Example dependency
+
+end

data/lib/jekyll/sketchviz/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Sketchviz
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/sketchviz.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "sketchviz/version"
+
+module Jekyll
+  module Sketchviz
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/spec/jekyll/sketchviz_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.describe Jekyll::Sketchviz do
+  it "has a version number" do
+    expect(Jekyll::Sketchviz::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "jekyll/sketchviz"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-sketchviz
+version: !ruby/object:Gem::Version
+  version: 0.0.0.alpha
+platform: ruby
+authors:
+- Christian Prior-Mamulyan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-22 00:00:00.000000000 Z
+dependencies: []
+description: 'jekyll-sketchviz is a Jekyll plugin that integrates Graphviz and Rough.js
+  to process .dot files into SVG diagrams during the site build. It supports configurable
+  output formats, including unstyled filesystem SVGs and inline SVGs styled via CSS.
+  The plugin leverages Jekyll collections for input management and provides a Liquid
+  tag API for flexible inclusion in site content.
+
+  '
+email:
+- cprior@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- jekyll-sketchviz.gemspec
+- lib/jekyll/sketchviz.rb
+- lib/jekyll/sketchviz/version.rb
+- spec/jekyll/sketchviz_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cprima/jekyll-sketchviz
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cprima/jekyll-sketchviz
+  source_code_uri: https://github.com/cprima/jekyll-sketchviz
+  changelog_uri: https://github.com/cprima/jekyll-sketchviz/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A Jekyll plugin to transform Graphviz .dot files into sketch-style SVGs using
+  Rough.js.
+test_files: []