fetcher-documentator 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fetcher-documentator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Luciano Bertenasco
+
+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,29 @@
+# Fetcher::Documentator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fetcher-documentator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fetcher-documentator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/documentator

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+require 'fetcher-documentator'
+
+Dir["**/*.rb"].each do |file|
+  Fetcher::Documentator.new file
+end

data/fetcher-documentator.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fetcher-documentator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "fetcher-documentator"
+  gem.version       = Fetcher::Documentator::VERSION
+  gem.authors       = ["Luciano Bertenasco", "Xavier Via"]
+  gem.email         = ["lbertenasco@gmail.com", "fernando.via@gmail.com"]
+  gem.description   = %q{A documentator gem for Fetcher}
+  gem.summary       = %q{A documentator gem for Fetcher}
+  gem.homepage      = "https://github.com/Fetcher/documentator"
+
+  gem.add_dependency 'fast'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/fetcher-documentator/version.rb

@@ -0,0 +1,5 @@
+module Fetcher
+  class Documentator
+    VERSION = "0.0.1"
+  end
+end

data/lib/fetcher-documentator.rb

@@ -0,0 +1,92 @@
+require 'fast'
+require 'fetcher-documentator/version'
+
+module Fetcher
+
+  class Documentator
+    def initialize path
+      @name = "doc/" + path[4..-4] + ".md"
+
+      @text_flat = flatten File.read path
+
+      @doc = []
+      class_name_parts = path[0..-4].split("/").last.split "_"
+      class_name = ""
+      class_name_parts.each do |part|
+        class_name += part.capitalize
+      end
+      
+      @text_flat.length.times do |i|
+        if @text_flat[i].start_with? "##"
+          if @text_flat[i].start_with? "###"
+            method = @text_flat[i][4..-1].split(" ").first
+            @doc << ""
+            @doc << method
+            @doc << ("-" * method.length)
+            @doc << ""
+            @doc << ("    " + @text_flat[i][4..-1])
+          elsif @text_flat[i].start_with? "## @"
+            transform_to_link(@text_flat[i][4..-1]).each do |line|
+              @doc << line
+            end
+          else
+            @doc << @text_flat[i][3..-1] 
+            if @doc.last.nil?
+              @doc[-1] = ""
+            else
+              unless @doc.last.end_with? ":"
+                @doc[-1] = "    #{@doc.last}"
+              else
+                last = @doc.last
+                if @doc[-2] == ""
+                  @doc[-1] = "### #{last}" 
+                else
+                  @doc[-1] = "" 
+                  @doc << "### #{last}"
+                end
+              end
+            end
+            unless @text_flat[i] == @text_flat.last
+              @doc << "" unless @text_flat[i + 1].start_with? "##"
+            end
+          end
+        end
+      end
+
+      unless @doc.empty?  
+        @doc.unshift ("=" * class_name.length)
+        @doc.unshift class_name
+        file.write @name, @doc.join("\n") 
+      end
+    end
+
+    def flatten text
+      flat = []
+      text.lines.to_a.each do |line|
+        flat << line.strip
+      end
+      flat
+    end
+
+    def transform_to_link text
+      method = text.split(".").last
+      hierarchy = text.split(".")[0..-2].join(".")
+      hierarchy_parts = hierarchy.split "/"
+      domain = hierarchy_parts.shift
+      capitalized_parts = []
+      hierarchy_parts.each do |part|
+        snaked = part.split "_"      
+        up_snaked = []
+        snaked.each do |sn|
+          up_snaked << sn.capitalize
+        end
+        capitalized_parts << up_snaked.join("")
+      end
+      data = []
+      data << "### #{domain}"
+      data << ""
+      data << "[#{method.upcase} #{domain}/#{capitalized_parts.join("/")}](https://github.com/Fetcher/#{domain}/blob/master/doc/#{domain}/#{hierarchy_parts.join("/")}.md##{method})"
+      data
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: fetcher-documentator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Luciano Bertenasco
+- Xavier Via
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fast
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A documentator gem for Fetcher
+email:
+- lbertenasco@gmail.com
+- fernando.via@gmail.com
+executables:
+- documentator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/documentator
+- fetcher-documentator.gemspec
+- lib/fetcher-documentator.rb
+- lib/fetcher-documentator/version.rb
+homepage: https://github.com/Fetcher/documentator
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A documentator gem for Fetcher
+test_files: []