doc2json 1.0.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 762219781b46ca4db9d85ca3d83a798a31021744
+  data.tar.gz: fb798ecaf0c747cd1bed1f4d348f68d59eac5643
+SHA512:
+  metadata.gz: 637cccc00eed782c08e77baebb448da382cc558fcbecab9ca070a128de95aba8bf18df8e9f6adfa85924be8350381ae2acfea544ea6690e658a1b5f372e72520
+  data.tar.gz: ea1ff7a5a0ffde423286c3c183e52473938c19ecc1e85499544f9ac22e998417be59ea8fcc339af70c00f53e35bd0996f827c4308452fca4b4620e0f9c3ac2a4

data/.gitignore

@@ -0,0 +1,8 @@
+.yardoc/
+doc/
+Gemfile.lock
+*.swp
+rdoc/
+.bundle/
+coverage
+tags

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+Overview
+========
+doc2json generates a JSON based ruby documentation with YARD. 
+
+Installation
+============
+
+```bash
+  gem install doc2json
+```
+
+Afterwards you can generate a machine friendly documentation for
+your project.
+
+Usage
+=====
+
+```bash
+  doc2json "lib/**/.rb" "doc/json"
+```
+This will generate a json based documentation for all `*.rb` files inside
+your `lib` directory and outputs the files in `./doc/json`
+
+License
+=======
+Licensed under the MIT License
+(c) Jens Nazarenus, 2014

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+# Returns the name of the project
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+# Returns the version number of the project
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+task :default => [:test]
+
+# << test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# << rdoc
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/doc2json

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'doc2json'
+
+input = [ARGV[0]]
+generator = Doc2Json::Generator.new(input, ARGV[1])
+generator.generate

data/doc2json.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "doc2json/version"
+
+Gem::Specification.new do |s|
+  s.name        = "doc2json"
+  s.version     = Doc2Json::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jens Nazarenus"]
+  s.email       = ["me@jens-na.de"]
+  s.homepage    = "https://github.com/jens-na/doc2json"
+  s.summary     = %q{Generate JSON based Ruby documentation}
+  s.description = %q{Generate JSON based Ruby documentations with yard}
+
+  s.add_runtime_dependency("yard", "~> 0.8.7.4")
+  s.add_runtime_dependency("json", "~> 1.8.1")
+
+  s.add_development_dependency("rspec", "~>2.14.1")
+  s.add_development_dependency('rake', "~> 10.1.1")
+  s.add_development_dependency('redgreen', "~> 1.2.2")
+  s.add_development_dependency('shoulda-context', "~> 1.1.6") 
+  s.add_development_dependency('rr', "~> 1.1.2")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/lib/doc2json.rb

@@ -0,0 +1,2 @@
+require 'doc2json/generator'
+require 'doc2json/version'

data/lib/doc2json/generator.rb

@@ -0,0 +1,72 @@
+module Doc2Json
+
+  require 'yard'
+  require 'json'
+  require 'fileutils'
+
+  class Generator
+
+    attr_reader :input
+    attr_reader :output
+    attr_reader :options
+
+    # Creates a new generator to output documentation in JSON
+    #
+    # input- the input file pattern as an array which will be passed to Yard
+    # output - the output directory where to store the JSON files, defaults to doc/json
+    # options - an options hash
+    def initialize(input = ["{lib,app}/**/*.rb", "ext/**/*.c"], output = "doc/json", options = {})
+      @input = input
+      @output = output
+      @options = options
+    end
+
+    # Generates the JSON API and outputs the data to the output
+    # directory.
+    def generate
+      classes = registry.all(:class)
+      classes.each do |c|
+        data = methods(c)
+        output(data, c.to_s)
+      end
+    end
+
+    private
+
+    # Outputs the data for the given class name to file.
+    # Creates directories where neccessary.
+    #
+    # data - the data to write (a hash)
+    # classname - the classname which is used as filename
+    def output(data, classname)
+      sanitized = File.join(@output, classname.gsub('::', '/')).downcase
+      path = Pathname(sanitized).dirname
+      FileUtils.mkdir_p path.to_s unless path.exist?
+
+      File.open("#{sanitized}.json", "w") do |f|
+        f.write(JSON.pretty_generate(data))
+      end
+    end
+
+    # Creates a hash with all the methods inside a class
+    #
+    # c - the class object of Yard
+    #
+    # Returns a hash. For example:
+    #   "generate" => "Generates the JSON API"
+    def methods(c)
+      data = Hash.new
+      c.children.each do |m|
+        data[m.name] = m.base_docstring
+      end
+      data
+    end
+
+    # Generates a Yard registry with the specified input file pattern,
+    # passed in the constructor
+    def registry
+      YARD::Registry.load(@input, true)
+    end
+
+  end
+end

data/lib/doc2json/version.rb

@@ -0,0 +1,3 @@
+module Doc2Json
+  VERSION = "1.0.0-alpha.1"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: doc2json
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha.1
+platform: ruby
+authors:
+- Jens Nazarenus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: redgreen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Generate JSON based Ruby documentations with yard
+email:
+- me@jens-na.de
+executables:
+- doc2json
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/doc2json
+- doc2json.gemspec
+- lib/doc2json.rb
+- lib/doc2json/generator.rb
+- lib/doc2json/version.rb
+- test/.keep
+homepage: https://github.com/jens-na/doc2json
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate JSON based Ruby documentation
+test_files:
+- test/.keep
+has_rdoc: