crystal-dash-docset-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80ccd5f37e0ccaecedffac9dec9b90e6f271f86b
+  data.tar.gz: 290aeed6e3cb0b5b3e97bf8803c25ea0b3cd428b
+SHA512:
+  metadata.gz: 4a34c055775e4b66e49b632850d1f8e3784ee4eb430a9b731167e9965f6f413505869b281a2c14ccfcb4f621259406d699ba408d64d1ad911b6f6faf3b2cc09f
+  data.tar.gz: 661e6fe5350d1a87f2b0f1330d254d5d81e7068cd320ee8416a820e275c348f37a9a9654ab87de3dc0ef62df40ed2447e8023196a83d2ec700876145183a4901

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,3 @@
+# Crystal::Dash::Docset::Generator
+
+This is a docset generator for Crystal API documents using [Dashing](https://github.com/technosophos/dashing).

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 "crystal/dash/docset/generator"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crystal-dash-docset-generator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crystal/dash/docset/generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crystal-dash-docset-generator"
+  spec.version       = Crystal::Dash::Docset::Generator::VERSION
+  spec.authors       = ["Hirofumi Wakasugi"]
+  spec.email         = ["baenej@gmail.com"]
+
+  spec.summary       = "This is a docset generator for Crystal API documents using Dashing"
+  spec.description   = "Run crystal-dash-docset-generator to build the crystal docset from the latest Crystal API documents."
+  spec.homepage      = "https://github.com/5t111111/crystal-dash-docset-generator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/exe/crystal-dash-docset-generator

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "crystal/dash/docset/generator"
+
+@generator = Crystal::Dash::Docset::Generator::Generator.new(
+  root_url: "http://crystal-lang.org/api/",
+  package_name: "crystal"
+)
+@generator.prepare_directory
+@generator.create_css
+@generator.set_page_urls
+@generator.create_source_docs { |file| puts file }
+@generator.copy_dashing_config
+@generator.generate_dash_docset

data/lib/crystal/dash/docset/dashing.json

@@ -0,0 +1,18 @@
+{
+    "name": "Crystal",
+    "package": "crystal",
+    "index": "index.html",
+    "selectors": {
+      "title": {
+        "type":"Class",
+        "regexp": " - github.com/manastech/crystal",
+        "replacement": ""
+      },
+      "div.signature": "Method"
+    },
+    "ignore": [
+        "ABOUT"
+    ],
+    "icon32x32": "crystal-icon.png",
+    "allowJS": false
+}

data/lib/crystal/dash/docset/generator.rb

@@ -0,0 +1,94 @@
+require "crystal/dash/docset/generator/version"
+require "open-uri"
+require "nokogiri"
+require "fileutils"
+
+module Crystal::Dash::Docset::Generator
+  class Generator
+    attr_accessor :root_url
+    attr_accessor :package_name
+    attr_accessor :output_directory
+
+    def initialize(root_url: nil, package_name: nil)
+      @root_url = root_url
+      @package_name = package_name
+      @path_to_this = File.expand_path(File.dirname(__FILE__))
+      @output_directory = File.expand_path(File.join(Dir.pwd, @package_name))
+    end
+
+    def dashing_installed?
+      system("hash dashing 2>/dev/null")
+      $?.exitstatus == 0 ? true : false
+    end
+
+    def prepare_directory
+      return nil if File.exist?(@package_name)
+      Dir.mkdir(@package_name)
+      Dir.chdir(@package_name)
+    end
+
+    def create_css
+      Dir.chdir(@output_directory)
+      Dir.mkdir("css")
+      open("css/style.css", "wb") do |output|
+        open("#{root_url}css/style.css") do |f|
+          content = f.read
+          # Remove unwanted styles
+          content.gsub!(/left: 20%;/, "")
+          content.gsub!(/right: 0;/, "")
+          content.gsub!(/position: absolute;/, "")
+          content.gsub!(/overflow: hidden;/, "")
+          output.write(content)
+        end
+      end
+    end
+
+    def set_page_urls
+      charset = nil
+      root_html = open(@root_url) do |f|
+        charset = f.charset
+        f.read
+      end
+      root_doc = Nokogiri::HTML.parse(root_html, nil, charset)
+      types_list = root_doc.css("div#types-list")
+      @page_urls = types_list.css('a').inject([]) do |result, anchor|
+        result << anchor[:href]
+      end
+    end
+
+    def create_source_docs
+      Dir.chdir(@output_directory)
+      @page_urls.each do |url|
+        yield url if block_given?
+        charset = nil
+        FileUtils.mkdir_p(File.dirname(url))
+        open(url, "wb") do |output|
+          html = open(URI.join(@root_url, url)) do |f|
+            charset = f.charset
+            f.read
+          end
+          doc = Nokogiri::HTML.parse(html, nil, charset)
+          doc.css("div#types-list").remove
+          doc.css("a.method-permalink").remove
+          doc.css("script").remove
+          doc.css("a").each do |node|
+            node.remove if node.attr("href") == "https://travis-ci.org/manastech/crystal"
+            node.remove if node.attr("href") == "https://www.bountysource.com/teams/crystal-lang/fundraisers/702-crystal-language"
+          end
+          output.write(doc.to_html)
+        end
+      end
+    end
+
+    def copy_dashing_config
+      Dir.chdir(@output_directory)
+      FileUtils.cp(File.join(@path_to_this, "dashing.json"), "dashing.json")
+      FileUtils.cp(File.join(@path_to_this, "crystal-icon.png"), "crystal-icon.png")
+    end
+
+    def generate_dash_docset
+      Dir.chdir(@output_directory)
+      `dashing build #{@package_name}`
+    end
+  end
+end

data/lib/crystal/dash/docset/generator/version.rb

@@ -0,0 +1,9 @@
+module Crystal
+  module Dash
+    module Docset
+      module Generator
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: crystal-dash-docset-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hirofumi Wakasugi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-03 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run crystal-dash-docset-generator to build the crystal docset from the
+  latest Crystal API documents.
+email:
+- baenej@gmail.com
+executables:
+- crystal-dash-docset-generator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crystal-dash-docset-generator.gemspec
+- exe/crystal-dash-docset-generator
+- lib/crystal/dash/docset/crystal-icon.png
+- lib/crystal/dash/docset/dashing.json
+- lib/crystal/dash/docset/generator.rb
+- lib/crystal/dash/docset/generator/version.rb
+homepage: https://github.com/5t111111/crystal-dash-docset-generator
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This is a docset generator for Crystal API documents using Dashing
+test_files: []