simple_toc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc635e459d66becbcdffa4e1818101ea6c8fd853
+  data.tar.gz: 03ae80d42122e13a51059002df1ff4632e69db74
+SHA512:
+  metadata.gz: 619966c04d8b9294ef9e25324c57c57edf89b5c30978850c2482c5e4c5f7a3900bb057bc7f1aebdc4144d908481ee837e7ede89bff690d23a4dc9392b2ca878c
+  data.tar.gz: eb5bbfc22491f18deefc9ead783cbecaed9f21f7021e0c6cdfc005721dfc3782a307fe16856b7f4267bda494a3d501603e1733d68a6f8583a7dc53a0baaa11ab

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp
+/vendor/bundle

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 miraoto
+
+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,52 @@
+# SimpleToc
+
+'simple-toc' makes a simple table of contents from DOM structure.
+
+## Installation
+
+```ruby
+gem 'simple_toc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_toc
+
+## Usage
+
+To require this plguin, add the following to your application.js:
+
+``` javascript
+
+//= require simpleToc
+
+```
+
+This plugin require jQuery.
+
+``` javascript
+$(function() {
+  # simple case
+  $('.toc').simpleToc();
+
+  # advance case
+  $('.toc').simpleToc({
+      listType: '<ol/>',
+      selectors: 'h1,h2,h3',
+      prefix: 'toc',
+  });
+});
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/miraoto/simple_toc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

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

@@ -0,0 +1,3 @@
+module SimpleToc
+  VERSION = "0.1.0"
+end

data/lib/simple_toc.rb

@@ -0,0 +1,8 @@
+require "simple_toc/version"
+
+module SimpleToc
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/simple_toc.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_toc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_toc"
+  spec.version       = SimpleToc::VERSION
+  spec.authors       = ["miraoto"]
+  spec.email         = ["miraoto@gmail.com"]
+
+  spec.summary       = %q{'simple-toc' makes a simple table of contents from DOM structure.}
+  spec.homepage      = "https://github.com/miraoto/simple_toc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/vendor/assets/javascripts/simpleToc.js

@@ -0,0 +1,63 @@
+(function($) {
+  $.simpleToc =function(element, options) {
+    var defaults = {
+      section: 'body',
+      listType: '<ul/>',
+      selectors: 'h2,h3',
+      prefix: 'toc',
+      anchorName: function(i, prefix) {
+        return prefix + '-' + i;
+      },
+      headerText: function($heading) {
+        return $heading.text();
+      },
+      listClass: function(i, heading, $heading, prefix) {
+        return prefix + '-' + $heading[0].tagName.toLowerCase();
+      }
+    }
+
+    var plugin = this;
+        plugin.settings = {}
+
+    var $element = $(element),
+        element = element;
+
+    plugin.init = function() {
+      plugin.settings = $.extend({}, defaults, options);
+
+      var section = $(plugin.settings.section);
+      var headers = $(plugin.settings.selectors, section);
+
+      return $element.each(function() {
+        var ul = $(plugin.settings.listType);
+
+        headers.each(function(i, header) {
+          console.log(header)
+          var $h = $(header);
+          var anchorName = plugin.settings.anchorName(i, plugin.settings.prefix);
+
+          if(header.id !== anchorName) {
+            $('<span/>').attr('id', anchorName).insertBefore($h);
+          }
+
+          var a = $('<a/>').text(plugin.settings.headerText($h))
+                           .attr('href', '#' + anchorName);
+          var li = $('<li/>').addClass(plugin.settings.listClass(i, header, $h, plugin.settings.prefix))
+                             .append(a);
+          ul.append(li);
+        });
+        $element.html(ul);
+      });
+    }
+    plugin.init();
+  }
+
+  $.fn.simpleToc = function(options) {
+    return this.each(function() {
+      if (undefined == $(this).data('simpleToc')) {
+        var plugin = new $.simpleToc(this, options);
+        $(this).data('simpleToc', plugin);
+      }
+    });
+  }
+})(jQuery);

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: simple_toc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- miraoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: 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'
+description: 
+email:
+- miraoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_toc.rb
+- lib/simple_toc/version.rb
+- simple_toc.gemspec
+- vendor/assets/javascripts/.keep
+- vendor/assets/javascripts/simpleToc.js
+homepage: https://github.com/miraoto/simple_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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: "'simple-toc' makes a simple table of contents from DOM structure."
+test_files: []