duckstrings 0.0.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,48 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2@duckstrings

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)

data/README.md

@@ -0,0 +1,10 @@
+# duckstrings
+
+Hardcore docstrings for Ruby.
+
+
+
+# Copyright
+
+Copyright (c) 2011 fogus.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "duckstrings"
+  gem.homepage = "http://fogus.me/fun"
+  gem.license = "MIT"
+  gem.summary = %Q{Hardcore docstrings for Ruby}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "me[at]fogus[dot]me"
+  gem.authors = ["fogus"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "duckstrings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/duckstrings.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require File.expand_path('../lib/duckstrings/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'duckstrings'
+  gem.description = %q{Hardcore docstrings for Ruby.}
+  gem.authors = ['Fogus']
+  gem.email = ['me-at-fogus-dot-me']
+
+  gem.version = Duckstrings::VERSION
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'http://github.com/fogus/Duckstrings'
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if gem.respond_to? :required_rubygems_version=
+  gem.summary = gem.description
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/duckstrings.rb

@@ -0,0 +1,60 @@
+class Module
+  def ___ ds
+    @last_docstring = ds
+  end
+
+  def describe &printer
+    printer_impl = printer || lambda { |method_name|
+      20.times { print '-' }
+      puts
+      
+      puts "#{self.inspect}##{method_name.to_s}"
+      puts "(args go here)"
+      puts "  #{self.doc_for method_name}"
+      puts
+    }
+
+    puts "Instance Methods"
+    (self.instance_methods - Object.instance_methods).sort.each &printer_impl
+
+    puts "Class Methods"
+    (self.methods - Object.methods).sort.each &printer_impl
+
+    @docstrings.count
+  end
+
+  def doc_for method_name
+    @docstrings[method_name] # || (class << self; self; end).ancestors.find do |kind|
+    #   if desc = kind.doc_for(method_name)
+    #     return desc
+    #   end
+    # end
+  end
+
+  private 
+
+  alias old_method_added method_added
+
+  def do_magic method_name
+    if defined? @last_docstring
+      (@docstrings ||= {})[method_name] = @last_docstring
+      @last_docstring = nil
+    end
+
+    old_method_added method_name    
+  end  
+
+  def singleton_method_added method_name
+    do_magic method_name
+  end
+
+  def method_added method_name
+    do_magic method_name    
+  end
+end
+
+<<-philos
+Fogus refers first to Nietzsche and his figure of thought that all interactions and interpretations of the external world through the lens of an individual perspective are completed. Even something like "truth" is therefore subject to constant interpretation, occupational change, and the intake of alternative viewpoints is essential in order to reach a higher level of knowledge.
+
+For the transmission of this figure of thought on the IT world Fogus notes that just a software developer of industry-high standards and best practices are shaped, are ultimately subjective in nature. Were strongly dependent on the subjective views of the developers of one's own history of the learned languages, and here comes again programming pioneer Alan Perlis into play...
+philos

data/lib/duckstrings/version.rb

@@ -0,0 +1,3 @@
+module Duckstrings
+  VERSION = "0.0.3"
+end

data/spec/duckstrings_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Foo
+  ___ "Ants!"
+  def self.bar
+    "blah"
+  end
+
+  ___ "Monkeys!"
+  def baz
+    "boop"
+  end
+
+  def qux x
+    [x]
+  end
+
+  class << self
+    ___ "Chins!"
+    def frob x, y
+      [x,y]
+    end
+  end
+end
+
+describe "Foo" do
+  it "has the expected docstrings" do
+    Foo.doc_for(:bar).should == "Ants!"
+    Foo.doc_for(:baz).should == "Monkeys!"
+    Foo.doc_for(:qux).should be_nil
+    Foo.describe
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'duckstrings'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: duckstrings
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Fogus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-22 00:00:00.000000000 -05:00
+default_executable: 
+dependencies: []
+description: Hardcore docstrings for Ruby.
+email:
+- me-at-fogus-dot-me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- duckstrings.gemspec
+- lib/duckstrings.rb
+- lib/duckstrings/version.rb
+- spec/duckstrings_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/fogus/Duckstrings
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Hardcore docstrings for Ruby.
+test_files:
+- spec/duckstrings_spec.rb
+- spec/spec_helper.rb