bond-yard 0.1.0

data/.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless Object.const_defined?(:Gem)
+require File.dirname(__FILE__) + "/lib/bond/yard"
+
+Gem::Specification.new do |s|
+  s.name        = "bond-yard"
+  s.version     = Bond::Yard::VERSION
+  s.authors     = ["Gabriel Horner"]
+  s.email       = "gabriel.horner@gmail.com"
+  s.homepage    = "http://github.com/cldwalker/bond-yard"
+  s.summary = "Generate completions from yard docs"
+  s.description = "This bond plugin generates completions for gems that have been documented with yard."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = 'tagaholic'
+  s.has_rdoc = 'yard'
+  s.rdoc_options = ['--title', "bond-yard #{Bond::Yard::VERSION} Documentation"]
+  s.add_dependency 'yard', '>= 0.5.2'
+  s.add_development_dependency 'bacon', '>= 1.1.0'
+  s.add_development_dependency 'mocha', '>= 0.9.8'
+  s.add_development_dependency 'mocha-on-bacon'
+  s.add_development_dependency 'bacon-bits'
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+  s.license = 'MIT'
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== 0.1.0
+* Extracted from bond

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2010 Gabriel Horner
+
+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.rdoc

@@ -0,0 +1,27 @@
+== Description
+This bond plugin generates completions for gems that have been documented with yard.
+
+== Install
+Install the gem with:
+
+    sudo gem install bond-yard
+
+== Usage
+
+Add to your ~/.irbrc
+
+    require 'bond/yard'
+
+In your .irbrc or in the console, load completions for gems that have been documented with yard:
+
+    >> Bond.load_yard_gems 'bond'
+    Bond: Building/loading bond's .yardoc database ...
+    => ['bond']
+    >> Bond.start :[TAB]
+    :bare  :debug  :default_mission  :default_search  :eval_binding :eval_debug  :gems  :readline_plugin
+
+For more examples, {see
+here}[http://tagaholic.me/2010/05/19/documentation-generated-irb-autocompletions-with-bond-and-yard.html#yard_based_irb_autocompletions].
+
+== Todo
+* Generate method autocompletions for any arguments based on yard docs

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run tests'
+task :test do |t|
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
+end
+
+task :default => :test

data/deps.rip

@@ -0,0 +1 @@
+yard >=0.5.2

data/lib/bond/yard.rb

@@ -0,0 +1,85 @@
+require 'bond'
+require 'yard'
+
+module Bond
+  # Adds class methods to Bond
+  module Yard
+    VERSION = '0.1.0'
+
+    # Generates and loads completions for yardoc documented gems.
+    # @param *gems Gem(s) with optional options hash at the end
+    # @option *gems :verbose[Boolean] (false) Displays additional information when building yardoc.
+    # @option *gems :reload[Boolean] (false) Rebuilds yard databases. Use when gems have changed versions.
+    def load_yard_gems(*gems)
+      Loader.load_yard_gems(*gems)
+    end
+
+    # Generates and loads completions for methods that take a hash of options and have been
+    # documented with @option.
+    module Loader
+      extend self
+
+      def load_yard_gems(*gems)
+        @options = gems[-1].is_a?(Hash) ? gems.pop : {}
+        gems.select {|e| load_yard_gem(e) }
+      end
+
+      def load_yard_gem(rubygem)
+        raise("Unable to find gem.") unless (yardoc = find_yardoc(rubygem))
+        completion_file = File.join(dir('yard_completions'), rubygem+'.rb')
+        create_completion_file(yardoc, completion_file) if !File.exists?(completion_file) || @options[:reload]
+        M.load_file completion_file
+      rescue
+        $stderr.puts "Bond Error: Didn't load yard completions for gem '#{rubygem}'. #{$!.message}"
+      end
+
+      def create_completion_file(yardoc, completion_file)
+        YARD::Registry.load!(yardoc)
+        methods_hash = find_methods_with_options
+        body = generate_method_completions(methods_hash)
+        File.open(completion_file, 'w') {|e| e.write body }
+      end
+
+      def find_yardoc(rubygem)
+        (file = YARD::Registry.yardoc_file_for_gem(rubygem) rescue nil) and return(file)
+        if (file = M.find_gem_file(rubygem, rubygem+'.rb'))
+          output_dir = File.join(dir('.yardocs'), rubygem)
+          cmd = ['yardoc', '-n', '-b', output_dir]
+          cmd << '-q' unless @options[:verbose]
+          cmd += ['-c', output_dir] unless @options[:reload]
+          cmd += [file, File.expand_path(file+'/..')+"/#{rubygem}/**/*.rb"]
+          puts "Bond: "+cmd.join(' ') if @options[:verbose]
+          puts "Bond: Building/loading #{rubygem}'s .yardoc database ..."
+          system *cmd
+          output_dir
+        end
+      end
+
+      def dir(subdir)
+        (@dirs ||= {})[subdir] ||= begin
+          require 'fileutils'
+          FileUtils.mkdir_p File.join(M.home, '.bond', subdir)
+          File.join(M.home, '.bond', subdir)
+        end
+      end
+
+      def find_methods_with_options
+        YARD::Registry.all(:method).inject({}) {|a,m|
+          opts = m.tags.select {|e| e.is_a?(YARD::Tags::OptionTag) }.map {|e| e.pair.name }
+          a[m.path] = opts if !opts.empty? && m.path
+          a
+        }
+      end
+
+      def generate_method_completions(methods_hash)
+        methods_hash.map do |meth, options|
+          options.map! {|e| e.sub(/^:/, '') }
+          meth = meth.sub(/#initialize$/, '.new')
+          %Q[complete(:method=>'#{meth}') {\n  #{options.inspect}\n}]
+        end.join("\n")
+      end
+    end
+  end
+end
+
+Bond.extend Bond::Yard

data/test/deps.rip

@@ -0,0 +1,4 @@
+bacon >=1.1.0
+mocha >=0.9.8
+mocha-on-bacon >=0
+bacon-bits >=0

data/test/yard_test.rb

@@ -0,0 +1,128 @@
+require 'bacon'
+require 'bacon/bits'
+require 'mocha'
+require 'mocha-on-bacon'
+require 'bond/yard'
+require 'rbconfig'
+
+class Bacon::Context
+  def capture_stderr(&block)
+    original_stderr = $stderr
+    $stderr = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stderr = original_stderr
+    end
+    fake.string
+  end
+
+  def capture_stdout(&block)
+    original_stdout = $stdout
+    $stdout = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stdout = original_stdout
+    end
+    fake.string
+  end
+end
+include Bond
+
+describe 'Bond.load_yard_gems' do
+  def load_yard_gems(*args)
+    args = ['blah'] if args.empty?
+    Bond.load_yard_gems(*args)
+  end
+
+  it 'prints error if no yardoc found' do
+    Yard::Loader.expects(:find_yardoc).returns(nil)
+    capture_stderr { load_yard_gems('bond') }.should =~ /Didn't.*'bond'.* Unable to find/
+  end
+
+  describe 'loads yardoc found by' do
+    before {
+      Yard::Loader.expects(:create_completion_file)
+      M.expects(:load_file)
+    }
+
+    it 'registry' do
+      YARD::Registry.expects(:yardoc_file_for_gem).returns('/dir/.yardoc')
+      load_yard_gems
+    end
+
+    describe 'find_gem_file and' do
+      before {
+        YARD::Registry.expects(:yardoc_file_for_gem).returns(nil)
+        M.expects(:find_gem_file).returns('/dir/blah.rb')
+      }
+
+      it 'prints building message' do
+        Yard::Loader.expects(:system)
+        capture_stdout { load_yard_gems('blah') }.should =~ /Building.*blah's/
+      end
+
+      it "caches yardoc by default" do
+        Yard::Loader.expects(:system).with {|*args| args.include?('-c') }
+        capture_stdout { load_yard_gems }
+      end
+
+      it "doesn't cache yardoc with :reload option" do
+        Yard::Loader.expects(:system).with {|*args| !args.include?('-c') }
+        capture_stdout { load_yard_gems('blah', :reload=>true) }
+      end
+
+      it "prints multiple messages with :verbose option" do
+        Yard::Loader.expects(:system).with {|*args| !args.include?('-q') }
+        capture_stdout { load_yard_gems('blah', :verbose=>true) }.should =~ /yardoc -n/
+      end
+    end
+  end
+
+  describe 'creates completion file' do
+    before {
+      Yard::Loader.expects(:find_yardoc).returns('/dir/.yardoc')
+      M.expects(:load_file)
+    }
+
+    # rubinius implements Kernel#require with File.exists? which is different than MRI
+    unless Config::CONFIG["RUBY_SO_NAME"].to_s[/rubinius/i]
+    it "with :reload option" do
+      File.expects(:exists?).returns(true)
+      Yard::Loader.expects(:create_completion_file)
+      load_yard_gems 'blah', :reload=>true
+    end
+
+    it "with new completion file" do
+      File.expects(:exists?).returns(false)
+      Yard::Loader.expects(:create_completion_file)
+      load_yard_gems
+    end
+    end
+
+    describe 'which has' do
+      before { YARD::Registry.expects(:load!) }
+
+      it 'methods' do
+        Yard::Loader.expects(:find_methods_with_options).returns({"Bond::M.start"=>[':one', 'two']})
+        expected_body = %[complete(:method=>'Bond::M.start') {\n  ["one", "two"]\n}]
+        File.expects(:open).yields mock('block') { expects(:write).with(expected_body) }
+        load_yard_gems
+      end
+
+      it 'no methods' do
+        Yard::Loader.expects(:find_methods_with_options).returns({})
+        File.expects(:open).yields mock('block') { expects(:write).with('') }        
+        load_yard_gems
+      end
+
+      it 'methods that map from #initialize to .new' do
+        Yard::Loader.expects(:find_methods_with_options).returns({"Bond::Agent#initialize"=>[':one', 'two']})
+        expected_body = %[complete(:method=>'Bond::Agent.new') {\n  ["one", "two"]\n}]
+        File.expects(:open).yields mock('block') { expects(:write).with(expected_body) }
+        load_yard_gems
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: bond-yard
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha-on-bacon
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bacon-bits
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: This bond plugin generates completions for gems that have been documented with yard.
+email: gabriel.horner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+files: 
+- lib/bond/yard.rb
+- test/yard_test.rb
+- LICENSE.txt
+- CHANGELOG.rdoc
+- README.rdoc
+- deps.rip
+- test/deps.rip
+- Rakefile
+- .gemspec
+has_rdoc: yard
+homepage: http://github.com/cldwalker/bond-yard
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --title
+- bond-yard 0.1.0 Documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: tagaholic
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generate completions from yard docs
+test_files: []
+