dogestrings 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc928ed9814e34916e5b4a036d9d8d88be5f2db7
+  data.tar.gz: a247bb3fff8cd7cd3239f09c07d4c01733e6e644
+SHA512:
+  metadata.gz: 201e1abcdd81f4184bb3fa9cd9505328d9a017db82f293a2a387667a0e87f8d06c0af15325969d733364df7030844e38c12c233eb2ccac7b83a2b1ba5b4d4cba
+  data.tar.gz: cd2da77c415be293bc89b0d49ce99c361d5c7f9c56e502de61d5e9d52b1f2bbe3a16e6aaca9e05470f1b70672727c92571abd670c8ee64eddc018d4b34255b35

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-2.1.1@dogestrings

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 3.3.0"
+  gem "bundler", "~> 1.10.5"
+  gem "jeweler", "~> 1.6.4"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    git (1.2.9.1)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10.5)
+  jeweler (~> 1.6.4)
+  rspec (~> 3.3.0)
+
+BUNDLED WITH
+   1.10.5

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.markdown

@@ -0,0 +1,11 @@
+# Dogestrings
+
+Hardcore docstrings for Ruby.
+
+<img src="https://raw.githubusercontent.com/fogus/dogestrings/master/docs/logo.jpg" height="300px" width="300px">
+
+# License
+
+Copyright 2015 Mike Fogus
+
+Licensed under the LGPL v3.0. https://www.gnu.org/licenses/lgpl-3.0.en.html

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 = "dogestrings"
+  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 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dogestrings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/dogestrings.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require File.expand_path('../lib/dogestrings/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'dogestrings'
+  gem.description = %q{Hardcore docstrings for Ruby.}
+  gem.authors = ['Fogus']
+  gem.email = ['me-at-fogus-dot-me']
+
+  gem.version = Dogestrings::VERSION
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'http://github.com/fogus/dogestrings'
+  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/dogestrings.rb

@@ -0,0 +1,67 @@
+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]
+  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/dogestrings/version.rb

@@ -0,0 +1,3 @@
+module Dogestrings
+  VERSION = "0.0.1"
+end

data/spec/dogestrings_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
+    expect(Foo.doc_for(:bar)).to eq "Ants!"
+    expect(Foo.doc_for(:baz)).to eq "Monkeys!"
+    expect(Foo.doc_for(:qux)).to 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 'dogestrings'
+
+# 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,59 @@
+--- !ruby/object:Gem::Specification
+name: dogestrings
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fogus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies: []
+description: Hardcore docstrings for Ruby.
+email:
+- me-at-fogus-dot-me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- docs/logo.jpg
+- dogestrings.gemspec
+- lib/dogestrings.rb
+- lib/dogestrings/version.rb
+- spec/dogestrings_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/fogus/dogestrings
+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.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Hardcore docstrings for Ruby.
+test_files:
+- spec/dogestrings_spec.rb
+- spec/spec_helper.rb