toc_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24146c23f3abca6dbf9981eef9dacec5667b3005
+  data.tar.gz: 8256afb234def8284dd21dc1b3c2f171993413d2
+SHA512:
+  metadata.gz: 0c55c0c4c86f3184eb0f526d6ebf1b5cfab727e4b45ac3f62e84acce579c175b58e1e257316c972dbb6ffe672a16b9a4fabb7c01ba3361e276bbe1a257f89cdd
+  data.tar.gz: 6de53eff5cda2ab2ed9efb786c8747d68f1b7410186cbf67665d9f305b283cd542bacf2b8df0eca86ab2f087cc812806868fcd94fe4ddcb1ec3f168172fe739f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.6

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in toc_list.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 ken
+
+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,84 @@
+# TocList
+
+Convert hash like this:
+
+```ruby
+hash = {'table of content' => [
+  {'Platform features' => ['Scalability', 'Fault-tolerance']},
+  {'Language features' => ['Functional programming', 'Extensibility and DSLs']},
+  {'Tooling features' => ['A growing ecosystem', 'Interactive development', 'Erlang compatible']}]
+}
+```
+
+into html list fragment like this (by default):
+
+```html
+<div class="toc_container">
+    <a href="#table_of_content">table of content</a>
+    <ol>
+        <li>
+            <a href="#Platform_features">Platform features</a>
+            <ol>
+                <li>
+                    <a href="#Scalability">Scalability</a>
+                </li>
+                <li>
+                    <a href="#Fault-tolerance">Fault-tolerance</a>
+                </li>
+            </ol>
+        </li>
+        <li>
+            <a href="#Language_features">Language features</a>
+            <ol>
+                <li>
+                    <a href="#Functional_programming">Functional programming</a>
+                </li>
+                <li>
+                    <a href="#Extensibility_and_DSLs">Extensibility and DSLs</a>
+                </li>
+            </ol>
+        </li>
+        <li>
+            <a href="#Tooling_features">Tooling features</a>
+            <ol>
+                <li>
+                    <a href="#A_growing_ecosystem">A growing ecosystem</a>
+                </li>
+                <li>
+                    <a href="#Interactive_development">Interactive development</a>
+                </li>
+                <li>
+                    <a href="#Erlang_compatible">Erlang compatible</a>
+                </li>
+            </ol>
+        </li>
+    </ol>
+</div>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toc_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install toc_list
+
+## Usage
+
+```ruby
+TocList.new(hash).render
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'toc_list'
+
+# 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

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/lib/toc_list.rb

@@ -0,0 +1,78 @@
+require "toc_list/version"
+require "toc_list/hash_method"
+require 'erb'
+
+class TocList
+
+  def initialize toc_hash, tmpl={}
+    @toc = toc_hash
+
+    @title_tmpl_path = optional tmpl, :title
+    @sections_tmpl_path = optional tmpl, :sections
+    @container_tmpl_path = optional tmpl, :container
+
+    @hash_method = block_given? ? hash_method : HashMethod
+  end
+
+  def title
+    @toc.keys[0]
+  end
+
+  def sections
+    @toc.values[0]
+  end
+
+  def render
+    @sections_tmpl ||= parse_tmpl @sections_tmpl_path
+    toc = @sections_tmpl.result binding
+    toc = wrap toc if parent.nil?
+    toc
+  end
+
+  protected
+
+  attr_writer :title_tmpl, :sections_tmpl
+  attr_accessor :parent
+
+  private
+
+  def optional tmpl, key
+    tmpl.fetch(key, def_tmpl(key.to_s + '.erb'))
+  end
+
+  def wrap toc
+    ctnr_tmpl = parse_tmpl @container_tmpl_path
+    ctnr_tmpl.result binding
+  end
+
+  def render_item item
+    @title_tmpl ||= parse_tmpl @title_tmpl_path
+    @title_tmpl.result binding
+  end
+
+  def hash_link item
+    @hash_method.call item
+  end
+
+  def render_section section
+    if section.is_a? String
+      render_item(section)
+    else
+      sec = self.class.new section
+      sec.title_tmpl = @title_tmpl
+      sec.sections_tmpl = @sections_tmpl
+      sec.parent = self
+      sec.render
+    end
+  end
+
+  def parse_tmpl path
+    ERB.new File.read path
+  end
+
+  def def_tmpl filename
+    sub_lib_dir = File.expand_path(__FILE__).sub(/\..*/, '')
+    File.join sub_lib_dir, filename
+  end
+
+end

data/lib/toc_list/container.erb

@@ -0,0 +1 @@
+<div class="toc_container"><%= toc %></div>

data/lib/toc_list/hash_method.rb

@@ -0,0 +1,5 @@
+class TocList
+  HashMethod = lambda do |item|
+    item.gsub(/\s/, '_')
+  end
+end

data/lib/toc_list/sections.erb

@@ -0,0 +1,8 @@
+<%= render_item title %>
+<ol>
+  <% sections.each do |section| %>
+    <li>
+      <%= render_section section  %>
+    </li>
+  <% end %>
+</ol>

data/lib/toc_list/title.erb

@@ -0,0 +1 @@
+<a href="#<%= hash_link item %>"><%= item %></a>

data/lib/toc_list/version.rb

@@ -0,0 +1,3 @@
+class TocList
+  VERSION = '0.1.0'
+end

data/toc_list.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'toc_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'toc_list'
+  spec.version       = TocList::VERSION
+  spec.authors       = ['ken']
+  spec.email         = ['block24block@gmail.com']
+
+  spec.summary       = 'convert table of content hash into <li>'
+  spec.homepage      = 'https://github.com/turnon/toc_list'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'nokogiri', '~> 1.6'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: toc_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ken
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- block24block@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/toc_list.rb
+- lib/toc_list/container.erb
+- lib/toc_list/hash_method.rb
+- lib/toc_list/sections.erb
+- lib/toc_list/title.erb
+- lib/toc_list/version.rb
+- toc_list.gemspec
+homepage: https://github.com/turnon/toc_list
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: convert table of content hash into <li>
+test_files: []