yard-serverspec-plugin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3e37f5ebfdba1bad7c77509d7822ac58eb5d4f6
+  data.tar.gz: d6ac0e811c7614a9bb304256476b1790151163b6
+SHA512:
+  metadata.gz: 694b76b28c87ac1033fb7d6361727b78373f54c97846f6608f358143ad12a9344c0c8a0baf44b78cfb1e044ebf13835d235b90ce8b2212811eb90dc29f0211f2
+  data.tar.gz: fcdbbf51807dee7e80a10a9421fedf8aa7ba115ae0fde3fadbbf1d1d30cafc7406c55cafeda95ed9ee1575c5f48183f71af4db21e38088b5a20238bc1e215bb4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 YOSHIKAWA Ryota
+
+MIT License
+
+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,69 @@
+# Yard::Serverspec::Plugin
+
+This plugin adds [Serverspec](http://serverspec.org/) specs to YARD output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-serverspec-plugin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-serverspec-plugin
+
+## Usage
+
+Add comments to your specs.
+
+```
+# @param kernel.panic Kernel behaviour on panic: delay
+# @note default: 0 (wait forever). Check 30 seconds before rebooting.
+context linux_kernel_parameter('kernel.panic') do
+  its(:value) { should <= 30 }
+end
+```
+
+You're ready to go:
+
+```
+yardoc -e yard-serverspec spec/*_spec.rb
+```
+
+or You can do this by adding the following to your ``Rakefile``:
+
+```
+namespace :doc do
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+    require 'yard/serverspec/plugin'
+  rescue LoadError
+    raise 'YARD is not available. Try installing it.'
+  end
+  YARD::Config.load_plugin('serverspec-plugin')
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['spec/*_spec.rb']
+  end
+end
+```
+
+and type:
+
+```
+rake doc:yard
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rrreeeyyy/yard-serverspec-plugin/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/yard-serverspec-plugin.rb

@@ -0,0 +1 @@
+require 'yard/serverspec/plugin/handler.rb'

data/lib/yard/serverspec/plugin.rb

@@ -0,0 +1,9 @@
+require "yard/serverspec/plugin/version"
+
+module Yard
+  module Serverspec
+    module Plugin
+      # Your code goes here...
+    end
+  end
+end

data/lib/yard/serverspec/plugin/handler.rb

@@ -0,0 +1,51 @@
+require 'yard'
+
+module YARD
+  module CodeObjects
+    # SpecObjectClass
+    class SpecObject < MethodObject
+      attr_accessor :target
+      def type
+        :method
+      end
+    end
+  end
+
+  module Handlers
+    module Serverspec
+      # AbstractSpecHandler
+      module AbstractSpecHandler
+        def process
+          register_spec(target)
+          parse_block(statement.last.last)
+        end
+
+        def register_file
+          file_name = parser.file.split('/').last.gsub('_spec.rb', '')
+          CodeObjects::ClassObject.new(namespace, file_name)
+        end
+
+        def register_spec(target, _doc = nil)
+          register CodeObjects::SpecObject.new(register_file, target.source, :instance) do |o|
+            o.visibility = 'public'
+            o.source     = statement.source
+            o.signature  = target.source
+            o.explicit   = true
+            o.docstring  = statement.comments
+          end
+        end
+      end
+
+      # Describe handler for YARD's source parser.
+      class DescribeHandler < Ruby::Base
+        include AbstractSpecHandler
+        handles method_call(:describe)
+        handles method_call(:context)
+
+        def target
+          statement.parameters.first
+        end
+      end
+    end
+  end
+end

data/lib/yard/serverspec/plugin/version.rb

@@ -0,0 +1,7 @@
+module Yard
+  module Serverspec
+    module Plugin
+      VERSION = "0.0.1"
+    end
+  end
+end

data/yard-serverspec-plugin.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yard/serverspec/plugin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yard-serverspec-plugin"
+  spec.version       = Yard::Serverspec::Plugin::VERSION
+  spec.authors       = ["YOSHIKAWA Ryota"]
+  spec.email         = ["yoshikawa@topotal.com"]
+  spec.summary       = %q{Displays Serverspec specs in YARD output.}
+  spec.description   = %q{Displays Serverspec specs in YARD output.}
+  spec.homepage      = "http://github.com/rrreeeyyy/#{spec.name}"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yard", "~> 0.7"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: yard-serverspec-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- YOSHIKAWA Ryota
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: Displays Serverspec specs in YARD output.
+email:
+- yoshikawa@topotal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yard-serverspec-plugin.rb
+- lib/yard/serverspec/plugin.rb
+- lib/yard/serverspec/plugin/handler.rb
+- lib/yard/serverspec/plugin/version.rb
+- yard-serverspec-plugin.gemspec
+homepage: http://github.com/rrreeeyyy/yard-serverspec-plugin
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Displays Serverspec specs in YARD output.
+test_files: []
+has_rdoc: