documentize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab38f8045075ee564fe9b48cb2e69bc2fec8a478
+  data.tar.gz: b82635f46ad6f81f7d512c81ecabdbadbf062bf3
+SHA512:
+  metadata.gz: 8cb432194f5ee2611f7a5191fe30a38acc37539d5785625b3d25261c25fa8a53789d3af3114b5f2dfd8e5fcc4b6ae0bd5e1464c792d4135ce2eab88655a681f9
+  data.tar.gz: 3548c0f2037a5d3e59d4f41fb02f3cbedc79f085012721970a33217f92b29bc567213b093bc3feada716a008c010c5fd0f6a6ba04e583dc0873d7efe4477ad55

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,32 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'rake', :task => 'spec' do
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  watch(%r{^lib/gameboard/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sampson Crowley
+
+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,41 @@
+# Documentize
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/documentize`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'documentize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install documentize
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake true` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/documentize.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+task :default => :spec
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "documentize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/documentize.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'documentize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "documentize"
+  spec.version       = Documentize::VERSION
+  spec.authors       = ["Sampson Crowley"]
+  spec.email         = ["sampsonsprojects@gmail.com"]
+
+  spec.summary       = %q{Generates a ruby file with a TomDoc skeletons from existing ruby files}
+  spec.description   = %q{Pass in a cluttered, or just undocumented ruby file and get back a well-spaced file with a TomDoc Skeleton for easy doc writing}
+  spec.homepage      = "https://github.com/SampsonCrowley/documentize"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rake"
+end

data/lib/documentize.rb

@@ -0,0 +1,42 @@
+require "documentize/version"
+require "documentize/collector"
+require "documentize/generator"
+
+
+module Documentize
+  class Documentize
+    REGEX = {
+      ext:         /\.rb$|\.ru$/,
+      shbang:      /^#!.*?ruby$/
+    }
+
+    attr_reader :collector, :file, :header, :tree
+
+    def initialize(file_name)
+      @file = load_file(file_name)
+      @collector = Collector.new
+      @generator = Generator.new
+    end
+
+    def load_file(file_name)
+      file = File.readlines(file_name).map {|line| line.strip} - [""]
+      raise ArgumentError unless valid?(file_name, file[0])
+      file
+    end
+
+    def run
+      @tree, @header = collector.run(@file)
+      # generator.gen_docs(tree)
+    end
+
+    private
+
+      def valid?(file_name, shebang)
+        if file_name =~ REGEX[:ext] || shebang =~ REGEX[:shbang]
+          true
+        else
+          false
+        end
+      end
+  end
+end

data/lib/documentize/collector.rb

@@ -0,0 +1,104 @@
+module Documentize
+  class Collector
+
+    REGEX = {
+      args:        /(.*?)[\(|\s](.*?)\)/,
+      header:      /^require/,
+      block:       /\sdo[\s\|.*]/,
+      inline_do:   /\sdo.*?end/,
+      is_class:    /^class/,
+      is_method:   /^def/,
+      is_module:   /^module/,
+      comment:      /^#/
+    }
+
+    def run(lines)
+      queue, header = remove_headers(lines)
+      [build(queue), header]
+    end
+
+    private
+
+      def build(queue)
+        content = []
+        skips = 0
+        until queue.length == 0
+
+          item = queue.shift
+
+          if item =~ REGEX[:is_class] ||
+             item =~ REGEX[:is_method] ||
+             item =~ REGEX[:is_module]
+
+            item = parse_command(item)
+
+            item[:content], queue = build(queue)
+
+          elsif item =~ REGEX[:block]
+
+            skips += 1 unless item =~ REGEX[:inline_do]
+
+          elsif item =~ /end/
+
+            return content, queue if skips <= 0
+            skips -= 1
+
+          end
+
+          content  << item
+
+        end
+
+        content
+
+      end
+
+      def get_args(cmd)
+        if cmd !~ REGEX[:args]
+          [cmd, nil]
+        else
+          matches = cmd.match(REGEX[:args])
+          [matches[1], parse_args(matches[2])]
+        end
+      end
+
+      def parse_args(arg_list)
+        breakup = arg_list.split(",").map{|arg| arg.strip}
+        breakup.map do |arg|
+          items = arg.split("=").map{ |item| item.strip }
+          {
+            name: items[0],
+            default: items[1]
+          }
+        end
+      end
+
+      def parse_command(cmd)
+        breakup = cmd.split(" ", 2)
+        if breakup[0] == "def"
+          type = "method"
+          cmd, args = get_args(breakup[1])
+        else
+          type = breakup[0]
+          cmd = breakup[1]
+        end
+        {
+            type: type,
+            name: cmd,
+            args: args,
+            content: [],
+            doc: nil
+          }
+      end
+
+      def remove_headers(file)
+        header = ""
+        until file[0] !~ REGEX[:header] && file[0] !~ REGEX[:comment]
+          header << "#{file.shift}\n"
+        end
+        header = header.length == 0 ? nil : header.strip
+        [file, header]
+      end
+
+  end
+end

data/lib/documentize/generator.rb

@@ -0,0 +1,4 @@
+module Documentize
+  class Generator
+  end
+end

data/lib/documentize/version.rb

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

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: documentize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sampson Crowley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-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'
+description: Pass in a cluttered, or just undocumented ruby file and get back a well-spaced
+  file with a TomDoc Skeleton for easy doc writing
+email:
+- sampsonsprojects@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- documentize.gemspec
+- lib/documentize.rb
+- lib/documentize/collector.rb
+- lib/documentize/generator.rb
+- lib/documentize/version.rb
+- tasks/rspec.rake
+homepage: https://github.com/SampsonCrowley/documentize
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Generates a ruby file with a TomDoc skeletons from existing ruby files
+test_files: []