tomdoccery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2862a2dc5a0955693481ef95c4dadc3bf2ea5df
+  data.tar.gz: 8f1110334a8d241aaff208891436aca417ce908d
+SHA512:
+  metadata.gz: 5a09804b9116b5df62cbfb7156dc55adb15dc66ecb8e7eb77e7a969fcac5d64876abae707f5e1bac5ce6fc8983d3030ebe711e08c2263f567fe7d6a20342d464
+  data.tar.gz: ee09fa93babaf6bef4ca9b30236d50ea464e36668377b15db40191e3eb6d6eea058aefc8796236bbddf41519af0d9d440a8471994b4c8c8406d3ea815aeabea7

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 tomdoccery.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tim
+
+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,31 @@
+# Tomdoccery (beta)
+
+## Installation
+
+Add this line to your application's Gemfile:
+```
+gem 'tomdoccery'
+bundle
+```
+
+Or install it yourself as:
+```
+gem install tomdoccery
+```
+
+## Usage
+
+Mount it in your config/routes.rb file:
+```
+require 'tomdoccery/web'
+mount Tomdoccery::Web => '/tomdoc'
+```
+You can use any url.
+
+## 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/lib/tomdoccery.rb

@@ -0,0 +1,40 @@
+require "tomdoccery/version"
+
+module Tomdoccery
+  class Base
+    attr_reader :menu_items
+    attr_reader :directory
+    attr_reader :models
+
+    def initialize
+      @directory = './app/models/'
+      @models = Dir.glob('./app/models/*')
+      @menu_items = set_menu_items
+    end
+
+    def set_menu_items
+      @models.map do |path|
+        a = path.split('/')
+        name = a[a.length-1]
+        camel = name.gsub!('.rb', '').gsub!(/^[a-z]|_+[a-z]/) { |a| a.upcase }.gsub('_', '')
+        { display: camel, link: name.downcase }
+      end
+    end
+
+    def blocks(model)
+      blocks = parse_model(File.read(@directory + model + '.rb'))
+      blocks.map do |b|
+        parse_block(b)
+      end
+    end
+
+    def parse_model(file)
+      file.scan(/^[ ]+(#[ ][Internal:|Public:|Deprecated:].*?def[ ].*?$)/m).flatten || []
+    end
+
+    def parse_block(block)
+      block.match(/(^[ ]?#[ ](Internal:|Public:|Deprecated:)[ ].*?#\n)(^[ ]*#[ ]Examples.*?#\n)(^[ ]*#[ ]Returns.*?\.)(.*)/m) || []
+    end
+
+  end
+end

data/lib/tomdoccery/version.rb

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

data/lib/tomdoccery/web.rb

@@ -0,0 +1,29 @@
+require 'sinatra/base'
+module Tomdoccery
+  class Web < Sinatra::Base
+    dir = File.expand_path(File.dirname(__FILE__) + "/../../web")
+    set :public_folder, "#{dir}/assets"
+    set :views,  "#{dir}/views"
+    set :root, "#{dir}/public"
+
+    before do
+      @prefix = env['SCRIPT_NAME']
+    end
+
+    def sanitize(s)
+      s.gsub!('#', '') rescue nil
+    end
+
+    get '/' do
+      redirect "#{ @prefix }/#{ Tomdoccery::Base.new.menu_items[0][:link] }"
+      slim :index
+    end
+
+    get '/:model' do |model|
+      tommy = Tomdoccery::Base.new
+      @menu_items = tommy.menu_items
+      @blocks = tommy.blocks(model)
+      slim :model
+    end
+  end
+end

data/tomdoccery.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tomdoccery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tomdoccery"
+  spec.version       = Tomdoccery::VERSION
+  spec.authors       = ["Tim"]
+  spec.email         = ["thogg4@gmail.com"]
+  spec.description   = %q{tomdoccery}
+  spec.summary       = %q{tomdoccery}
+  spec.homepage      = "https://github.com/thogg4/tomdoccery"
+  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 'sinatra'
+  spec.add_dependency 'slim'
+  spec.add_dependency 'tomparse'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/web/assets/styles.css

@@ -0,0 +1,3 @@
+li {
+  list-style-type: none;
+}

data/web/views/index.slim

@@ -0,0 +1 @@
+

data/web/views/layout.slim

@@ -0,0 +1,15 @@
+html
+  head
+    link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-combined.min.css" rel="stylesheet"
+    link href='/'
+  body
+    .container
+      .row
+        .span4
+          ul.unstyled
+            - @menu_items.each do |item|
+              li
+                a href="#{@prefix}/#{item[:link]}" = item[:display]
+
+        .span8
+          == yield

data/web/views/model.slim

@@ -0,0 +1,18 @@
+- if @blocks.empty?
+
+  h3 You have not tomdoccified this model.
+
+- else
+  - @blocks.each do |b|
+    .row
+      .span8
+        .page-header: h1 = b[5]
+
+        .description
+          p.lead = sanitize(b[1])
+          p = sanitize(b[3])
+          p = sanitize(b[4])
+
+.row
+  .span8
+    p.muted If you have a tomdocced method that is not here, check for typos.

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: tomdoccery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tomparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: tomdoccery
+email:
+- thogg4@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tomdoccery.rb
+- lib/tomdoccery/version.rb
+- lib/tomdoccery/web.rb
+- tomdoccery.gemspec
+- web/assets/styles.css
+- web/views/index.slim
+- web/views/layout.slim
+- web/views/model.slim
+homepage: https://github.com/thogg4/tomdoccery
+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.0.rc.2
+signing_key: 
+specification_version: 4
+summary: tomdoccery
+test_files: []