tom_extract 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3618ce8f6b1fb3e83c83aabb49df8d019137dbcf
+  data.tar.gz: d10a68619695b24f2f26928288782b18b4fb23b5
+SHA512:
+  metadata.gz: eee837acbe0963f83c8a4cd46a4f9ca7a5366b0a3c6d9984f513049afcbc48d1bee2d1b3b6810fa37873c9b3ef5d832ffa78d61655f320ed855e85017f5cc692
+  data.tar.gz: 755ac2c01551e2554f0d3bb4dca77dde8e3041026f9d055d2900a9bf650a9cb7d071fb645112d1ecda692a652b738905e6ed0d244e6d1fad87290a44283be82d

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.rspec
+*~
+*\#

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tom_extract.gemspec
+gemspec
+
+gem "sexp_info"
+
+group :debug do
+  gem 'pry_debug'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 svs
+
+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,71 @@
+# TomExtract
+
+TomExtract extracts TomDoc from Ruby source files. It provides the answer as a nice Hash. i.e.
+
+given a source file like this
+
+```ruby
+module Foo
+  class Bar
+
+    # Public: Duplicate some text an arbitrary number of times.
+    #
+    # text  - The String to be duplicated.
+    # count - The Integer number of times to duplicate the text.
+    #
+    # Examples
+    #
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    # Returns the duplicated String.
+    def multiplex(text, count)
+      text * count
+    end
+  end
+end
+```
+it provides the following data
+
+```ruby
+    { "Foo" => {
+        "Bar" => {
+          "multiplex" => "    # Public: Duplicate some text an arbitrary number of times.
+    #
+    # text  - The String to be duplicated.
+    # count - The Integer number of times to duplicate the text.
+    #
+    # Examples
+    #
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    # Returns the duplicated String."
+        }
+      }
+    }
+  }
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tom_extract'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tom_extract
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ""
+end
+
+task :default => ["spec"]

data/lib/tom_extract.rb

@@ -0,0 +1,46 @@
+require "bundler/setup"
+require "sexp_info"
+require "tom_extract/version"
+require "tom_extract/comment_extractor"
+require 'ripper'
+require 'pry_debug'
+
+class TomExtract
+
+  def initialize(pathname)
+    @pathname = Pathname.new(pathname)
+  end
+
+  def result
+    extract_methods
+  end
+
+  private
+
+  attr_reader :pathname
+
+  def source
+    File.read(pathname)
+  end
+
+  def extract_methods(h = sexp_info.to_h)
+    Hash[
+         h.map do |name, item|
+           [name, item.is_a?(SexpThing::Def) ? method_with_comments(item) : (item.is_a?(Hash) ? extract_methods(item) : nil)]
+         end.reject{|k,v| k == :sexp}
+        ]
+  end
+
+  def method_with_comments(m)
+    CommentExtractor.new(pathname, m.line_number).comment
+  end
+
+  def sexp
+    Ripper.sexp(source)
+  end
+
+  def sexp_info
+    @sexp_info ||= SexpInfo.new(sexp)
+  end
+
+end

data/lib/tom_extract/comment_extractor.rb

@@ -0,0 +1,24 @@
+class CommentExtractor
+
+  def initialize(pathname, line_number)
+    @pathname, @line_number = pathname, line_number
+  end
+
+  def comment
+    c = []
+    source[0..(line_number-2)].reverse.each do |l|
+      break if l.gsub(/\s/,'').empty?
+      c << l if l.match(/\A\s*\#/)
+    end
+    c.reverse.join("\n")
+  end
+
+  private
+
+  attr_reader :pathname, :line_number
+
+  def source
+    File.read(pathname).split("\n")
+  end
+
+end

data/lib/tom_extract/version.rb

@@ -0,0 +1,3 @@
+class TomExtract
+  VERSION = "0.0.1"
+end

data/spec/fixtures/source.rb

@@ -0,0 +1,19 @@
+module Foo
+  class Bar
+
+    # Public: Duplicate some text an arbitrary number of times.
+    #
+    # text  - The String to be duplicated.
+    # count - The Integer number of times to duplicate the text.
+    #
+    # Examples
+    #
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    # Returns the duplicated String.
+    def multiplex(text, count)
+      text * count
+    end
+  end
+end

data/spec/lib/comment_extractor_spec.rb

@@ -0,0 +1,20 @@
+require 'tom_extract'
+
+describe CommentExtractor do
+
+  subject { CommentExtractor.new('./spec/fixtures/source.rb', 15) }
+
+
+  its(:comment) { should == "    # Public: Duplicate some text an arbitrary number of times.
+    #
+    # text  - The String to be duplicated.
+    # count - The Integer number of times to duplicate the text.
+    #
+    # Examples
+    #
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    # Returns the duplicated String." }
+
+end

data/spec/lib/tom_extract_spec.rb

@@ -0,0 +1,27 @@
+require 'tom_extract'
+
+
+describe TomExtract do
+
+  subject { TomExtract.new('./spec/fixtures/source.rb') }
+
+  its(:result) { should ==
+    { "Foo" => {
+        "Bar" => {
+          "multiplex" => "    # Public: Duplicate some text an arbitrary number of times.
+    #
+    # text  - The String to be duplicated.
+    # count - The Integer number of times to duplicate the text.
+    #
+    # Examples
+    #
+    #   multiplex('Tom', 4)
+    #   # => 'TomTomTomTom'
+    #
+    # Returns the duplicated String."
+        }
+      }
+    }
+  }
+
+end

data/tom_extract.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tom_extract/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tom_extract"
+  spec.version       = TomExtract::VERSION
+  spec.authors       = ["svs"]
+  spec.email         = ["svs@svs.io"]
+  spec.description   = %q{Extract TomDoc from a source file}
+  spec.summary       = %q{Does what it says on the tin.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "sexp_info"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: tom_extract
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- svs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extract TomDoc from a source file
+email:
+- svs@svs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tom_extract.rb
+- lib/tom_extract/comment_extractor.rb
+- lib/tom_extract/comment_extractor.rb~
+- lib/tom_extract/version.rb
+- spec/fixtures/source.rb
+- spec/lib/comment_extractor_spec.rb
+- spec/lib/tom_extract_spec.rb
+- tom_extract.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Does what it says on the tin.
+test_files:
+- spec/fixtures/source.rb
+- spec/lib/comment_extractor_spec.rb
+- spec/lib/tom_extract_spec.rb