bluedoc-toc 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f70a76b50ad3ef91b561ebd2d39d53e3388aa1c599ab97525b5cfbd1a165ada
+  data.tar.gz: c9d94dc3cda4bfce1f3e184f10a347a7cb545598ca37764bccdb806f573feeac
+SHA512:
+  metadata.gz: debd730297d4f5bad7626501d58dd90bb581f62e9ec602bbf1fe73b59249f11a47922c0f90992ec192a23e891edaf02ad3a5b69b624387c8f8f60867d970de8c
+  data.tar.gz: c5ff460102f494469457864d533672346f9376ec47a42e2d29b0731a5c59e58c7f5b548e4aca8fa15f0ce1ca39d9187c9c8b832002d4ff9d7207783a6b3376bd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Jason Lee
+
+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,42 @@
+# BlueDoc::Toc
+
+Book TOC read/write tool.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bluedoc-toc'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+```rb
+@content = BlueDoc::Toc.parse(read_file("sample.yml"))
+@content.each do |item|
+  puts item.id
+  puts item.title
+  puts item.url
+  puts item.depth
+end
+
+@content = BlueDoc::Toc.parse(read_file("sample.json"), format: :json)
+@content.to_html
+@content.to_markdown
+@content.to_json
+@content = BlueDoc::Toc.parse(read_file("sample.md"), format: :markdown)
+@content.to_html(prefix: "https://bluedoc.io/bluedoc/docs/")
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Barboon'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/views/booklab/toc/_content.html.erb

@@ -0,0 +1,7 @@
+<%- if format == :html -%>
+<ul class="toc-items">
+<%= render partial: "bluedoc/toc/#{format}/list_item", collection: items, as: :item -%>
+</ul>
+<% else %>
+<%= render partial: "bluedoc/toc/#{format}/list_item", collection: items, as: :item -%>
+<% end %>

data/app/views/booklab/toc/html/_list_item.erb

@@ -0,0 +1,11 @@
+<li class="toc-item toc-item-<%= item.depth %>" data-id="<%= item.id %>">
+  <%- if item.url -%>
+  <a href="<%= item.url %>" class="item-link">
+    <span class="item-title"><%= item.title %></span>
+  </a>
+  <a href="<%= item.url %>" class="item-slug"><%= item.slug %></a>
+  <%- else -%>
+  <span class="item-link"><span class="item-title"><%= item.title %></span></span>
+  <span class="item-slug"><%= item.slug %></span>
+  <%- end -%>
+</li>

data/app/views/booklab/toc/markdown/_list_item.erb

@@ -0,0 +1,8 @@
+<%-
+  indent = "  " * item.depth
+-%>
+<%- if item.url -%>
+<%= indent %>- [<%= item.title %>](<%= item.url %>)
+<%- else -%>
+<%= indent %>- <%= item.title %>
+<%- end -%>

data/lib/bluedoc-toc.rb

@@ -0,0 +1,43 @@
+require "bluedoc/toc/engine"
+require "bluedoc/toc/list_item"
+require "bluedoc/toc/content"
+require "bluedoc/toc/format/markdown"
+
+module BlueDoc
+  module Toc
+    class FormatError < Exception; end
+
+    extend ActiveSupport::Autoload
+
+    class << self
+      delegate :logger, to: Rails
+
+      def parse(raw, format: :yml, strict: false)
+        items = []
+        datas = []
+
+        case format
+        when :yml
+          datas = YAML.load(raw)
+        when :json
+          datas = JSON.load(raw)
+        when :markdown
+          datas = Format::Markdown.load(raw)
+        else
+          raise "format: #{format} not implement"
+        end
+
+        datas.each do |obj|
+          item_hash = obj.to_hash
+          item_hash.deep_symbolize_keys!
+          items << ListItem.new(id: item_hash[:id], title: item_hash[:title], url: item_hash[:url], depth: item_hash[:depth])
+        end
+        Content.new(items)
+      rescue => e
+        raise FormatError.new(e.message) if strict
+        logger.warn "BlueDoc::Toc.parse error:\n#{e.inspect}"
+        Content.new([])
+      end
+    end
+  end
+end

data/lib/bluedoc/toc/content.rb

@@ -0,0 +1,57 @@
+module BlueDoc
+  module Toc
+    class Content
+      extend Forwardable
+
+      attr_accessor :items
+
+      def_delegators :@items, :[], :size, :<<, :map, :each, :each_with_index, :as_json, :find, :sort, :sort_by, :take, :first
+
+      def _dump
+        YAML.dump(items.as_json)
+      end
+
+      def to_yaml
+        _dump
+      end
+
+      def to_html(prefix: nil, suffix: nil)
+        _render(format: :html, prefix: prefix, suffix: suffix)
+      end
+
+      def to_markdown(prefix: nil, suffix: nil)
+        _render(format: :markdown, prefix: prefix, suffix: suffix)
+      end
+
+      def to_json
+        items.to_json
+      end
+
+      def _render(format: :html, prefix: nil, suffix: nil)
+        render_items = []
+        items.each do |item|
+          new_item = item.dup
+
+          new_item.slug = new_item.url
+          if new_item.url && !new_item.slug.include?("/")
+            new_item.url = "#{prefix.to_s}#{new_item.slug}#{suffix.to_s}"
+          end
+          render_items << new_item
+        end
+
+        ApplicationController.renderer.render(partial: "bluedoc/toc/content", locals: {
+          format: format,
+          items: render_items,
+        })
+      end
+
+      def find_by_url(url)
+        items.find { |item| item.url&.strip == url&.strip }
+      end
+
+      def initialize(items)
+        @items = items
+      end
+    end
+  end
+end

data/lib/bluedoc/toc/engine.rb

@@ -0,0 +1,9 @@
+require "rails/engine"
+
+module BlueDoc
+  module Toc
+    class Engine < Rails::Engine
+      isolate_namespace BlueDoc::Toc
+    end
+  end
+end

data/lib/bluedoc/toc/format/markdown.rb

@@ -0,0 +1,46 @@
+module BlueDoc
+  module Toc
+    module Format
+      class Markdown
+        class << self
+          def load(raw)
+            items = []
+
+            # check indent style, 2 spaces/4 spaces/1 tab
+            space_size = 4
+            if raw.match(/^[\t]{1}[\s]?[-\*]/m)
+              space_size = 1
+            elsif raw.match(/^[\s]{2}[\s]?[-\*]/m)
+              space_size = 2
+            end
+
+            lines = raw.split("\n")
+            lines.each do |line|
+              item = { "title" => nil, "url" => nil, "depth" => 0 }
+              # replace * prefix to - prefix
+              line = line.gsub(/^([\s]+)\*/, "\\1-")
+              # calculate indent as depth
+              item["depth"] = (line.match(/^([\s]+)/).to_s.length / space_size).round
+
+              # check line is include link
+              m = line.match(/\[(?<title>.+?)\]\((?<url>.+?)\)/)
+
+              if m
+                item["title"] = m[:title]
+                # pick up link
+                item["url"] = m[:url].split(" ")[0]
+              else
+                # use chars after "-" as title
+                item["title"] = line.gsub(/^[\s]?\-[\s]?/, "").strip
+              end
+
+              items << item
+            end
+
+            items
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bluedoc/toc/list_item.rb

@@ -0,0 +1,14 @@
+module BlueDoc
+  module Toc
+    class ListItem
+      attr_accessor :title, :url, :slug, :depth, :id
+
+      def initialize(title:, url: nil, depth: 0, id: nil)
+        @title = title
+        @url = url
+        @depth = depth
+        @id = id
+      end
+    end
+  end
+end

data/lib/bluedoc/toc/version.rb

@@ -0,0 +1,5 @@
+module BlueDoc
+  module Toc
+    VERSION = '0.3.1'
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: bluedoc-toc
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Toc format read/write for BlueDoc
+email:
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/booklab/toc/_content.html.erb
+- app/views/booklab/toc/html/_list_item.erb
+- app/views/booklab/toc/markdown/_list_item.erb
+- lib/bluedoc-toc.rb
+- lib/bluedoc/toc/content.rb
+- lib/bluedoc/toc/engine.rb
+- lib/bluedoc/toc/format/markdown.rb
+- lib/bluedoc/toc/list_item.rb
+- lib/bluedoc/toc/version.rb
+homepage: https://github.com/thebluedoc/bluedoc-toc
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Toc format read/write for BlueDoc
+test_files: []