literate-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af3d9f0e4094cc30bd9c2c5ce55f0c7dca4677ae
+  data.tar.gz: 460a0c484c3506d001ffcf292dd3b1eea7b61605
+SHA512:
+  metadata.gz: 66d594969d6def6b9ed58883f8dd6bc3bc426b2c5fb7c05845819fe976ee1702faac2a58cbd07f5cc801e127c79ae0798a6a0ba85bf5f5993bdfddb1bf4daf10
+  data.tar.gz: be34836dfc728e3fc37331ef0c865988302d54f098d1d077f3129d9f514e6c82bcb144c564ecf48d678126ac7c80b12c23aa0632e47500312fb6db4e3c4b06f6

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    literate-ruby (0.0.1)
+      kramdown (~> 1.2.0)
+      pygments.rb (~> 0.5.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    kramdown (1.2.0)
+    posix-spawn (0.3.6)
+    pygments.rb (0.5.4)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  literate-ruby!
+  rake
+  rspec (~> 2.14.1)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Andrew Stewart
+
+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,78 @@
+# Literate Ruby
+
+A simple Ruby script that lets you enjoy literate programming in Ruby a little
+bit more.
+
+## How do I use it?
+
+Given a `.litrb` file like the following (let's call it `example.litrb`):
+
+    # Literate Programming Is Fun
+
+    Literate programming is a great way to document your code, making it easily
+    accessible and well-explained to the reader. For example, below we define
+    a function that prints "Hello World", then run it.
+
+        def hello
+          puts "Hello, World!"
+        end
+
+If the `literate-ruby.rb` script is run on this file, it will generate two
+files:
+
+- `example.rb` will contain all the code from the `.litrb` file, waiting to be
+  run by Ruby:
+
+```ruby
+# example.rb
+
+def hello
+  puts "Hello, World!"
+end
+```
+
+- `example.html` will contain the converted markdown from the file, with
+  syntax-highlighted Ruby:
+
+```html
+<!-- example.html -->
+<h1>Literate Programming Is Fun</h1>
+
+<p>Literate programming is a great way to document your code, making it easily
+accessible and well-explained to the reader. For example, below we define
+a function that prints "Hello World", then run it.</p>
+
+<div class="highlight"><pre><span class="k">def</span> <span class="nf">hello</span>
+  <span class="nb">puts</span> <span class="s2">&quot;Hello, World!&quot;</span>
+<span class="k">end</span>
+</pre></div>
+```
+
+## Dependencies:
+
+Literate Ruby makes use of the following gems:
+
+- [rdicount][]
+- [pygments.rb][]
+
+To install RDiscount, you'll need at least a basic build system, since it's
+implemented in C.
+
+If you have a Pygments install (`which pygmentize`), Pygments.rb will use that.
+If not, it will need to use an external web service to perform syntax
+highlighting.
+
+[rdicount]: https://github.com/davidfstr/rdiscount/
+[pygments.rb]: https://github.com/tmm1/pygments.rb
+
+## TODO:
+
+- support for directly running `.litrb` files
+- support for processing a dir of `.litrb` fils
+- support for reading Literate Ruby from stdin and outputting html or ruby to
+  stdout
+- gemify or otherwise turn into a binary
+
+## License
+
+MIT. Plain and simple. See `LICENSE` for more details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+RSpec::Core::RakeTask.new :spec
+Bundler::GemHelper.install_tasks

data/bin/literate-ruby

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'literate-ruby'
+
+LiterateRuby.start!

data/lib/literate-ruby.rb

@@ -0,0 +1,86 @@
+require 'pygments'
+require 'kramdown'
+
+module LiterateRuby
+  class << self
+    attr_reader :input, :ruby, :html, :basename
+
+    INDENTED_CODE_REGEX = / # Match a MARKDOWN CODE section.
+      (\r?\n)              # $1: CODE must be preceded by blank line
+      (                    # $2: CODE contents
+        (?:                # Group for multiple lines of code.
+          (?:\r?\n)+       # Each line preceded by a newline,
+          (?:[ ]{4}|\t).*  # and begins with four spaces or tab.
+        )+                 # One or more CODE lines
+        \r?\n              # CODE folowed by blank line.
+      )                    # End $2: CODE contents
+      (?=\r?\n)?           # CODE folowed by blank line.
+      /x
+
+    def print_help
+      warn "  Usage:"
+      warn "    literate-ruby [FILE].litrb"
+      exit 1
+    end
+
+    def check_args
+      print_help if ARGV.length == 0
+    end
+
+    def get_input
+      file = ARGV[0]
+
+      if File.exists?(file)
+        @input = File.read file
+        @basename = File.basename file, '.litrb'
+      else
+        print_help
+      end
+    end
+
+    def extract_ruby
+      @ruby = @input.scan(INDENTED_CODE_REGEX).join('')
+      @ruby.gsub!(/^[ ]{4}/ , '')
+      @ruby.lstrip!.strip!
+    end
+
+    def syntax_highlight_ruby_blocks
+      @input.gsub! INDENTED_CODE_REGEX do |code|
+        code.gsub!(/^[ ]{4}/ , '')
+        code.strip!.lstrip!
+
+        highlighted_code = highlight_code code
+        "\n\n#{highlighted_code}\n"
+      end
+    end
+
+    def highlight_code(code)
+      Pygments.highlight code, :lexer => 'ruby'
+    end
+
+    def convert_markdown
+      syntax_highlight_ruby_blocks
+      markdown = Kramdown::Document.new @input
+      @html = markdown.to_html
+    end
+
+    def export_html
+      html_filename = File.expand_path("./#{@basename}.html")
+      File.write html_filename, @html
+    end
+
+    def export_ruby
+      ruby_filename = File.expand_path("./#{@basename}.rb")
+      File.write ruby_filename, @ruby
+    end
+
+    def start!
+      check_args
+      get_input
+      extract_ruby
+      convert_markdown
+      export_html
+      export_ruby
+    end
+  end
+end

data/lib/literate-ruby/version.rb

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

data/literate-ruby.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path '../lib/literate-ruby/version', __FILE__
+
+Gem::Specification.new do |spec|
+  spec.name          = "literate-ruby"
+  spec.version       = LiterateRuby::VERSION
+  spec.authors       = ["Andrew Stewart"]
+  spec.email         = ["andrew@stwrt.ca"]
+  spec.description   = %q{Literate Programming, with Ruby.}
+  spec.summary       = %q{Literate Programming, with Ruby.}
+  spec.homepage      = "https://github.com/stewart/literate-ruby"
+  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 "kramdown", "~> 1.2.0"
+  spec.add_dependency "pygments.rb", "~> 0.5.4"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",   "~> 2.14.1"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: literate-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !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: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Literate Programming, with Ruby.
+email:
+- andrew@stwrt.ca
+executables:
+- literate-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/literate-ruby
+- lib/literate-ruby.rb
+- lib/literate-ruby/version.rb
+- literate-ruby.gemspec
+homepage: https://github.com/stewart/literate-ruby
+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: Literate Programming, with Ruby.
+test_files: []