yard-mruby 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67619c176c6d3eac1b48180db76798a1904f24e8
-  data.tar.gz: 7500da8ca06456e333cd484bdbc63f1a7ebb8436
+  metadata.gz: 190f5ff1d85a7da50b2cf177931e3cabb4def6c8
+  data.tar.gz: 51db17c11ee8a3cd9f09e97f8f6681e070c61fdd
 SHA512:
-  metadata.gz: 1a38d3bbe50d358eb3d2d1e6f90ac09189b453ef828c8086b6b2e06623196642efda390196b50ddaec2d51ddc93aca4ae123c2105988c037b6c62d6d15f6fb3f
-  data.tar.gz: 7b29d3f900dd59db364a8b02e7d6e16b4abbb08999de3d4424dae80131b701344b79828faaba3d76ac4bffc9c46ce5e1ea577c54e08348687ab00e2d31dd751e
+  metadata.gz: b458bfb91fde2f55187fc990206c9006dc743452d47da17db0ff4127ffcca29b3519d0a5fe7d169d14ddec8c155a6a9e0224bde9a0c64bd7a2ded62f6a6775e8
+  data.tar.gz: 3dd0739fc2a4ad829ebb55fdc19ede5db7f9321f8bd37083cc5ebf6b5833422ed7edcdfb6285c1da6f04a9789f3ba8d446d8bb387863e6aa1965731da11cc595

data/.gitignore

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

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
---color
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,13 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Seba Gamboa
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2015 Seba Gamboa
+
+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

@@ -1,31 +1,31 @@
-# yard-mruby
-
-[![Gem](https://img.shields.io/gem/v/yard-mruby.svg)](https://rubygems.org/gems/yard-mruby)
-[![Travis](https://img.shields.io/travis/sagmor/yard-mruby.svg)](https://travis-ci.org/sagmor/yard-mruby)
-
-This is a plugin that allows YARD to parse and generate documentation for MRuby sources as well as documenting it's C APIs.
-
-It still has it's [rough edges and missing features](https://github.com/sagmor/yard-mruby/issues) but you can see a [sample from it's current state when executed on MRuby's core here](https://sagmor.com/mruby/)
-
-## Usage
-
-Install with rubygems
-
-    $ gem install yard-mruby
-
-And execute `mrbdoc` to generate the docs
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-To install this gem onto your local machine, run `bundle exec rake install`.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/sagmor/yard-mruby. 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).
-
+# yard-mruby
+
+[![Gem](https://img.shields.io/gem/v/yard-mruby.svg)](https://rubygems.org/gems/yard-mruby)
+[![Travis](https://img.shields.io/travis/sagmor/yard-mruby.svg)](https://travis-ci.org/sagmor/yard-mruby)
+
+This is a plugin that allows YARD to parse and generate documentation for MRuby sources as well as documenting it's C APIs.
+
+It still has it's [rough edges and missing features](https://github.com/sagmor/yard-mruby/issues) but you can see a [sample from it's current state when executed on MRuby's core here](https://sagmor.com/mruby/)
+
+## Usage
+
+Install with rubygems
+
+    $ gem install yard-mruby
+
+And execute `mrbdoc` to generate the docs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sagmor/yard-mruby. 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

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "yard/mruby"
-
-# 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
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yard/mruby"
+
+# 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

@@ -1,7 +1,7 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mrbdoc

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/yard/mruby'
-
-YARD::CLI::Yardoc.run(*ARGV)
+#!/usr/bin/env ruby
+
+require_relative '../lib/yard/mruby'
+
+YARD::CLI::Yardoc.run(*ARGV)

data/lib/yard-mruby.rb

@@ -1 +1 @@
-require 'yard/mruby' unless Kernel.const_defined?(:YARD) && YARD.const_defined?(:MRuby)
+require 'yard/mruby' unless Kernel.const_defined?(:YARD) && YARD.const_defined?(:MRuby)

data/lib/yard/mruby.rb

@@ -1,9 +1,9 @@
-require 'yard'
-
-require_relative "mruby/version"
-require_relative "mruby/code_objects"
-require_relative "mruby/parser"
-require_relative "mruby/handlers"
-require_relative "mruby/tags"
-require_relative "mruby/templates"
-require_relative "mruby/cli"
+require 'yard'
+
+require_relative "mruby/version"
+require_relative "mruby/code_objects"
+require_relative "mruby/parser"
+require_relative "mruby/handlers"
+require_relative "mruby/tags"
+require_relative "mruby/templates"
+require_relative "mruby/cli"

data/lib/yard/mruby/cli.rb

@@ -1 +1 @@
-require_relative 'cli/yardoc'
+require_relative 'cli/yardoc'

data/lib/yard/mruby/cli/yardoc.rb

@@ -1,14 +1,14 @@
-module YARD::MRuby::CLI
-  module Yardoc
-
-    # Redefines default files for YARD::CLI::Yardoc
-    def parse_arguments(*args)
-      super(*args)
-      self.files = %w{src/**/*.c mrblib/**/*.rb include/**/*.h} if self.files.empty?
-    end
-  end
-
-  # Load Above modifications into YARD::CLI::Yardoc
-  YARD::CLI::Yardoc.include Yardoc
-end
-
+module YARD::MRuby::CLI
+  module Yardoc
+
+    # Redefines default files for YARD::CLI::Yardoc
+    def parse_arguments(*args)
+      super(*args)
+      self.files = %w{src/**/*.c mrblib/**/*.rb include/**/*.h} if self.files.empty?
+    end
+  end
+
+  # Load Above modifications into YARD::CLI::Yardoc
+  YARD::CLI::Yardoc.include Yardoc
+end
+

data/lib/yard/mruby/code_objects.rb

@@ -1,6 +1,6 @@
-require_relative 'code_objects/headers_root'
-require_relative 'code_objects/header_base_object'
-require_relative 'code_objects/header_object'
-require_relative 'code_objects/function_object'
-require_relative 'code_objects/define_object'
-require_relative 'code_objects/typedef_object'
+require_relative 'code_objects/headers_root'
+require_relative 'code_objects/header_base_object'
+require_relative 'code_objects/header_object'
+require_relative 'code_objects/function_object'
+require_relative 'code_objects/define_object'
+require_relative 'code_objects/typedef_object'

data/lib/yard/mruby/code_objects/define_object.rb

@@ -1,8 +1,8 @@
-module YARD::MRuby::CodeObjects
-
-  # A DefineObject represents a MRuby C API define macro declaration inside a header inside an include directory
-  class DefineObject < HeaderBaseObject
-  end
-end
-
-
+module YARD::MRuby::CodeObjects
+
+  # A DefineObject represents a MRuby C API define macro declaration inside a header inside an include directory
+  class DefineObject < HeaderBaseObject
+  end
+end
+
+

data/lib/yard/mruby/code_objects/function_object.rb

@@ -1,72 +1,72 @@
-module YARD::MRuby::CodeObjects
-
-  # A FunctionObject represents a MRuby C API function declaration inside a header inside an include directory
-  class FunctionObject < HeaderBaseObject
-    ParameterType = Struct.new(:type,:name)
-
-    # Returns the list of parameters parsed out of the method signature
-    # with their default values.
-    #
-    # @return [Array<Array(String, String)>] a list of parameter names followed
-    #   by their default values (or nil)
-    attr_accessor :parameters
-
-    def initialize(header, name, &block)
-      super
-    end
-
-    def attr_info
-      nil
-    end
-
-    def scope
-      ''
-    end
-
-    def return_type
-      @return_type
-    end
-
-    def return_type=(type)
-      @return_type = (type == 'void' ? nil : type)
-    end
-
-    # Returns the list of parameters parsed out of the method signature
-    # with their default values.
-    #
-    # @return [Array<Array(String, String)>] a list of parameter names followed
-    #   by their default values (or nil)
-    def parameters
-      parameter_types.map{|t| [(t.type == '...' ? '...' : t.name), nil] }
-    end
-
-    def parameter_types
-      @parameter_types || []
-    end
-
-    def parse_parameter_types(parameters)
-      @parameter_types = []
-      return if parameters.match /^\s*void\s*$/
-
-      parameters.split(',').each do |parameter|
-        parameter.scan(/((?:const\s+)?(?:struct\s+)?(?:\w+|\.\.\.)(?:\s*\*)?)\s*(\w+)?/) do |type,name|
-          @parameter_types << ParameterType.new(type,name)
-        end
-      end
-
-    end
-
-
-    # Returns all alias names of the object
-    # @return [Array<Symbol>] the alias names
-    def aliases
-      list = []
-      return list unless namespace.is_a?(HeaderObject)
-      namespace.aliases.each do |o, aname|
-        list << o if aname == name && o.scope == scope
-      end
-      list
-    end
-  end
-end
-
+module YARD::MRuby::CodeObjects
+
+  # A FunctionObject represents a MRuby C API function declaration inside a header inside an include directory
+  class FunctionObject < HeaderBaseObject
+    ParameterType = Struct.new(:type,:name)
+
+    # Returns the list of parameters parsed out of the method signature
+    # with their default values.
+    #
+    # @return [Array<Array(String, String)>] a list of parameter names followed
+    #   by their default values (or nil)
+    attr_accessor :parameters
+
+    def initialize(header, name, &block)
+      super
+    end
+
+    def attr_info
+      nil
+    end
+
+    def scope
+      ''
+    end
+
+    def return_type
+      @return_type
+    end
+
+    def return_type=(type)
+      @return_type = (type == 'void' ? nil : type)
+    end
+
+    # Returns the list of parameters parsed out of the method signature
+    # with their default values.
+    #
+    # @return [Array<Array(String, String)>] a list of parameter names followed
+    #   by their default values (or nil)
+    def parameters
+      parameter_types.map{|t| [(t.type == '...' ? '...' : t.name), nil] }
+    end
+
+    def parameter_types
+      @parameter_types || []
+    end
+
+    def parse_parameter_types(parameters)
+      @parameter_types = []
+      return if parameters.match /^\s*void\s*$/
+
+      parameters.split(',').each do |parameter|
+        parameter.scan(/((?:const\s+)?(?:struct\s+)?(?:\w+|\.\.\.)(?:\s*\*)?)\s*(\w+)?/) do |type,name|
+          @parameter_types << ParameterType.new(type,name)
+        end
+      end
+
+    end
+
+
+    # Returns all alias names of the object
+    # @return [Array<Symbol>] the alias names
+    def aliases
+      list = []
+      return list unless namespace.is_a?(HeaderObject)
+      namespace.aliases.each do |o, aname|
+        list << o if aname == name && o.scope == scope
+      end
+      list
+    end
+  end
+end
+