RubyGems - readem - Versions diffs - 0.1.1 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

data/.gitignore ADDED Viewed

@@ -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 ADDED Viewed

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

data/README.md ADDED Viewed

@@ -0,0 +1,86 @@
+# An amazing tool renders readmes in realtime
+Assuming I have all my projects in the ~/Projects directory, we can
+start a web server on port 4567 which renders a list of projects which have a README.
+When I want to serve up all my readmes, I enter this at the terminal:
+   gem install readem
+   readem
+Then my browser will automagically open the URL http://localhost:1337/
+and view a list of links to projects.
+When I click one of the links, the readme for that repository is
+displayed. Then it reloads the readme every 3 seconds after I stop
+editing, so I can view my changes in "realtime".
+## Implementation notes
+Rendering markdown: use the Makeup gem.
+## Implementation notes
+### Directories with readmes
+require "pathname"
+readmes = Pathname.glob("/home/marius/Projects/*/README.md")
+readme_dirs = readmes.map(&:dirname)
+local_dirnames = readme_dirs.map(&:dirname)
+### Mark up Markdown
+There's this thing called Makeup. How does it work? Use the
+[README](http://gitorious.org/gitorious/makeup), stupid.
+require "makeup/markup"
+first_readme = readmes.first
+first_readme = Makeup::Markup.new.render(first_readme.basename.to_s, first_readme.read)
+- Sinatra
+- List each readme
+- get /project-name: render readme
+### Bootstrap boilerplate
+<!DOCTYPE html>
+<html>
+    <head>
+      <link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" />
+      <title>Zomg</title>
+    </head>
+    <body>
+      <div class="container">
+        <h1>Amazing</h1>
+        <code>Oh</code>
+      </div>
+    </body>
+</html>

data/bin/readem ADDED Viewed

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# mode: ruby
+require "sinatra"
+require "pathname"
+require "makeup/markup"
+require "readem/version"
+set :bind, "0.0.0.0"
+set :port, 1337
+set :root, File.expand_path(File.dirname(__FILE__) + "/../")
+set :run, true
+get "/" do
+  readmes = Pathname.glob("/home/marius/Projects/*/README.md")
+  readme_dirs = readmes.map(&:dirname)
+  @local_dirnames = readme_dirs.map {|dir| dir.to_s.split("/").last}
+  erb :index
+end
+get "/:dir" do
+  readme = Pathname("/home/marius/Projects/#{params[:dir]}/README.md")
+  readme_data = readme.read
+  @markup = Makeup::Markup.new.render("README.md", readme_data)
+  erb :readme
+end

data/lib/readem/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Readem
+  VERSION = "0.1.1"
+end

data/readem.gemspec ADDED Viewed

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readem/version'
+Gem::Specification.new do |spec|
+  spec.name          = "readem"
+  spec.version       = Readem::VERSION
+  spec.authors       = ["Marius Mathiesen"]
+  spec.email         = ["marius.mathiesen@gmail.com"]
+  spec.description   = %q{Serve the READMEs in your ~/Projects in a web browser}
+  spec.summary       = %q{Run it, and see all your READMEs.}
+  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 "makeup", "~> 0.4"
+  spec.add_dependency "sinatra", "~> 1.4"
+  spec.add_dependency "redcarpet", "~> 2.3"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/views/index.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<h1>All your READMEs are now belong to us</h1>
+<ul>
+<% for dir in @local_dirnames do %>
+  <li><a href="/<%= dir %>"><%= dir %></a></li>
+<% end %>
+</ul>
+<p>Served by readem <%= Readem::VERSION %></p>

data/views/layout.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+    <head>
+      <link rel="stylesheet" href="http://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" />
+      <title>Zomg</title>
+    </head>
+    <body>
+      <div class="container">
+        <%= yield %>
+      </div>
+    </body>
+</html>

data/views/readme.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= @markup %>

metadata ADDED Viewed

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: readem
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.1
+platform: ruby
+authors:
+- Marius Mathiesen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  name: makeup
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  name: sinatra
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  name: redcarpet
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: bundler
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+description: Serve the READMEs in your ~/Projects in a web browser
+email:
+- marius.mathiesen@gmail.com
+executables:
+- readem
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- bin/readem
+- lib/readem/version.rb
+- readem.gemspec
+- views/index.erb
+- views/layout.erb
+- views/readme.erb
+homepage: ''
+licenses:
+- MIT
+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.24
+signing_key:
+specification_version: 3
+summary: Run it, and see all your READMEs.
+test_files: []

readem 0.1.1