vitepress-rails 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3630ebac35f9a3cf3c2ebf4d5c027a7557385efd79a92337a8761bc1494a4bf
-  data.tar.gz: 53358818d780b7aa1131a42ca94fe5c3983405eee9467c2c0fa126cc999bf2c7
+  metadata.gz: d64f48a9f8abd212ee36a355e82e1d7c5ef3597686cf113717a8d8a547bdd2a0
+  data.tar.gz: 96a030364f74346b7d236c6aa83ca97b9ee8289526e514ea155b25e0900f8d46
 SHA512:
-  metadata.gz: 1cc7c0194939b5320f35b037602a0b56f259d0931f2031af775b903e0647941ed03a4c62847c39cd4a6c2a8af9c3c431ef27f6da419afc31674861b37df1866f
-  data.tar.gz: 861167cb94ba5e10704221df08a36feacf44d01881b26e031c615f67a09fbc2c678c19017a4026d4c501a5f09ce5e913cb084a524b1dfbb7556209bd0064a281
+  metadata.gz: 7fe415c7cd6a3fad89df4b595b5ecc6fcbc2f936b4bd90478bfed3e528a13225b76334663fbb32983a11167e303ebf0225e478b309c3d5ed1e7c75923128a7b7
+  data.tar.gz: 5586b99a9a74563f2d69a8c41a72a638c40c24b59d66123fe7b658584cd61693df4a105781b477cadc653fb6e16e49ab1f93c7522278e9be3dfe8ca90425bb17

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vitepress-rails.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "switchcop"

data/README.md

@@ -0,0 +1,62 @@
+# Vitepress::Rails
+
+Integrate [Vitepress](https://vitepress.vuejs.org/) into your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vitepress-rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vitepress-rails
+
+1. Run `rails vitepress:install` to add Vitepress to your Rails application and install the necessary dependencies.
+
+This command creates docs folder that contains the Vitepress default application.
+
+2. Adds the following line to your `config/routes.rb` file:
+
+```ruby
+mount Vitepress::Engine, at: "/"
+```
+***Only works with / path for now***
+
+## Usage
+
+1. Write your `.md` doc inside the `docs` folder. 
+2. Run `rails assets:precompile`.
+3. Your page can be accessed at `/docs/<your-page-name>`
+
+Your `/` path always will be `docs/index.md`
+
+## 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/Switchdreams/vitepress-rails. 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/SwitchDreams/vitepress-rails/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 Vitepress::Rails project's codebases, issue trackers, chat rooms and mailing lists is
+expected to follow the [code of conduct](https://github.com/SwitchDreams/vitepress-rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "vitepress/rails"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]
+
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/app/controllers/concerns/vitepress/page.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Inspired from https://github.com/thoughtbot/high_voltage/blob/main/app/controllers/concerns/high_voltage/static_page.rb
+require "vitepress/rails/finder"
+
+module Vitepress::Page
+  extend ActiveSupport::Concern
+
+  included do
+    layout ->(_) { HighVoltage.layout }
+
+    rescue_from ActionView::MissingTemplate do |exception|
+      if /Missing template #{page_finder.content_path}/.match?(exception.message)
+        invalid_page
+      else
+        raise exception
+      end
+    end
+
+    rescue_from HighVoltage::InvalidPageIdError, with: :invalid_page
+  end
+
+  def show
+    render(
+      template: current_page,
+      locals: { current_page: current_page },
+    )
+  end
+
+  def invalid_page
+    raise ActionController::RoutingError, "No such page: #{params[:id]}"
+  end
+
+  private
+
+  def current_page
+    page_finder.find
+  end
+
+  def page_finder
+    page_finder_factory.new(params[:id])
+  end
+
+  def page_finder_factory
+    Vitepress::Rails::Finder
+  end
+end

data/app/controllers/vitepress/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Vitepress
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/vitepress/pages_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Vitepress::PagesController < ActionController::Base
+  include Vitepress::Page
+
+  layout false
+
+  def index
+    render(
+      template: "pages/index",
+      locals: { current_page: "pages/index" },
+    )
+  end
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "vitepress/rails"
+
+# 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/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+#
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/vitepress/engine", __dir__)
+APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

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/config/initializers/high_voltage.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "high_voltage"
+
+HighVoltage.configure do |config|
+  config.route_drawer = HighVoltage::RouteDrawers::Default
+  config.parent_engine = Vitepress::Engine
+  config.routes = false
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Vitepress::Engine.routes.draw do
+  get "/:id", to: "pages#show", as: :page
+  root to: "pages#index"
+end

data/lib/vitepress/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Vitepress
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/vitepress/tasks/vitepress/build.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+namespace :vitepress do
+  desc "Build your docs"
+  task build: :environment do
+    Dir.chdir("./docs") do
+      unless system "yarn install && yarn docs:build"
+        raise "vitepress: docs:build failed"
+      end
+
+      # Move html files to pages folder
+      Dir.glob(".vitepress/dist/**/*.html").each do |file|
+        dir = File.dirname(file)
+        filename = File.basename(file)
+
+        dest = File.join("../app/views/pages", dir.remove(".vitepress/dist"))
+        FileUtils.mkdir_p(dest)
+
+        FileUtils.copy_file(file, File.join(dest, filename))
+      end
+
+      # Move assets files to public
+      if Dir.exist?(".vitepress/dist/assets")
+        FileUtils.copy_entry(".vitepress/dist/assets", "../public/assets")
+      end
+
+      # Copy public files
+      if Dir.exist?("public")
+        FileUtils.copy_entry("public", "../public")
+      end
+    end
+  end
+end
+
+if Rake::Task.task_defined?("assets:precompile")
+  Rake::Task["assets:precompile"].enhance(["vitepress:build"])
+end

data/lib/vitepress/tasks/vitepress/init/config.js

@@ -0,0 +1,4 @@
+export default {
+  title: 'VitePress Rails',
+  description: 'Docs with vitepress-rails',
+}

data/lib/vitepress/tasks/vitepress/init/index.md

@@ -0,0 +1,25 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+name: "VitePress Rails"
+text: "Docs with vitepress-rails"
+tagline: My great project tagline
+actions:
+- theme: brand
+  text: Markdown Examples
+  link: /markdown-examples
+- theme: alt
+  text: API Examples
+  link: /api-examples
+
+features:
+- title: Feature A
+  details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+- title: Feature B
+  details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+- title: Feature C
+  details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+---
+

data/lib/vitepress/tasks/vitepress/init/install.rb

@@ -4,7 +4,9 @@ if Rails.root.join(".gitignore").exist?
   # High voltage genereated files
   append_to_file(".gitignore", %(\n/app/views/pages/*\n!app/views/pages/.keep\n))
   # Vitepress generated files
-  append_to_file(".gitignore", %(\n.vitepress/dist\n.vitepress/cache\n))
+  append_to_file(".gitignore", %(\ndocs/.vitepress/dist\ndocs/.vitepress/cache\n))
+  # Public assets for rails
+  append_to_file(".gitignore", %(\npublic/assets\n))
 end
 
 unless Rails.root.join("package.json").exist?

data/lib/vitepress/tasks/vitepress/init/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "app",
+  "private": "true"
+}

data/lib/vitepress/tasks/vitepress/install.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :vitepress do
+  desc "Install vitepress"
+  task install: :environment do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("./init/install.rb", __dir__)}"
+  end
+end

data/sig/vitepress/rails.rbs

@@ -0,0 +1,6 @@
+module Vitepress
+  module Rails
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vitepress-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
@@ -45,12 +45,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/concerns/vitepress/page.rb
+- app/controllers/vitepress/application_controller.rb
+- app/controllers/vitepress/pages_controller.rb
+- bin/console
+- bin/rails
+- bin/setup
+- config/initializers/high_voltage.rb
+- config/routes.rb
 - lib/vitepress/engine.rb
 - lib/vitepress/rails.rb
 - lib/vitepress/rails/finder.rb
 - lib/vitepress/rails/version.rb
 - lib/vitepress/railtie.rb
+- lib/vitepress/tasks/vitepress/build.rake
+- lib/vitepress/tasks/vitepress/init/config.js
+- lib/vitepress/tasks/vitepress/init/index.md
 - lib/vitepress/tasks/vitepress/init/install.rb
+- lib/vitepress/tasks/vitepress/init/package.json
+- lib/vitepress/tasks/vitepress/install.rake
+- sig/vitepress/rails.rbs
 homepage: https://github.com/SwitchDreams/rest-api-generator
 licenses:
 - MIT