datastory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87dea24700cc2bdc46984ddd4cf9a7567b0b3ebb
+  data.tar.gz: 69aa1f62365fab941aa2c284856f6b5d5f71d74a
+SHA512:
+  metadata.gz: c314b77af442cbe21b47dec8a654e83eab5e70e60cf977d3d3950621b18aaea1330da3abc2aa0fcf6910f59e37392cc6143f55df81046eee2d9b32a012c74b9e
+  data.tar.gz: b261f9dd9db34c7e2b0444701284115d169fe74c9419210f79ed28c2a91282d949319d04cafae7c4fc3384fa0819a8e79e402d0ff235d30dfadab7dde323e406

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alan Johnson
+
+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,60 @@
+# Datastory
+
+DataStory is an extension on Markdown that helps you script documents that
+tell a data story and show your work. DataStory is inspired by 
+[RMarkdown](http://www.rstudio.com/ide/docs/r_markdown).
+
+DataStory attempts to go the extra mile and create a portable HTML output file that is self-contained,
+using data uris, so any included images or filesare attached to the html file itself, including
+the original source file.
+
+## Use with Caution
+
+DataStory is in active dev right now, but isn't quite ready for prime time. Feel free to install it
+and play around, but it's got a ways to go. Do report any problems you run into.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'datastory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install datastory
+
+## Usage
+
+DataStory includes the DataStory command, which takes two arguments, input and output. 
+
+```
+datastory analysis.md analysis.html
+```
+
+The input file should be a valid DataStory Markdown file. The output file should be a valid path
+where a new html file can be created.
+
+## Syntax
+
+At its core, DataStory converts Markdown to HTML. See the core 
+[Markdown reference](http://daringfireball.net/projects/markdown/syntax) to get familiar with 
+Markdown.
+
+DataStory allows the use of code fences, using 3 backticks (```) to represent blocks of code. Adding
+a language definition of ruby-datastory causes the code in the code fenced area to be both displayed
+and executed, with its output displayed below the original code.
+
+Using a language definition of ruby-datastory-silent will display the code and execute it, but not
+display any output.
+
+## 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/datastory

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/datastory"
+
+puts "Processing #{ARGV[0]}..."
+DataStory::Renderer.new(ARGV[0]).render_to(ARGV[1])
+puts "Wrote to #{ARGV[1]}"
+puts

data/datastory.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datastory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "datastory"
+  spec.version       = DataStory::VERSION
+  spec.authors       = ["Alan Johnson"]
+  spec.email         = ["alan@commondream.com"]
+  spec.description   = %q{Tell stories about data and share your work.}
+  spec.summary       = %q{Tell stories about data and share your work.}
+  spec.homepage      = "http://github.com/commondream/datastory"
+  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 "redcarpet", "~> 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/datastory/data_uri.rb

@@ -0,0 +1,24 @@
+require "base64"
+
+module DataStory
+  class DataURI
+    
+    # Public: Generates a data uri from a file type and data.
+    def self.from_data(file_type, data)
+      encoded_data = Base64.strict_encode64(data)
+      "data:#{file_type};base64,%s" % encoded_data
+    end
+    
+    # Public: Loads the file at file_path and converts it to a data uri.
+    def self.from_file(path)
+      file_type = `file --mime -b #{path}`
+      
+      data = nil
+      File.open(path, "rb") do |file|
+        data = file.read
+      end
+
+      from_data(file_type, data)
+    end
+  end
+end

data/lib/datastory/markdown_renderer.rb

@@ -0,0 +1,52 @@
+require "redcarpet"
+
+module DataStory 
+  class MarkdownRenderer < Redcarpet::Render::HTML
+    def initialize
+      @binding = eval("binding;")
+      super
+    end
+    
+    def block_code(code, language)
+      output = <<-EOF
+        <pre><code class="#{language}">#{code}</code></pre>
+      EOF
+        
+      if language == "ruby-datastory" || language == "ruby-datastory-silent"
+        prev_stdout = $stdout
+        #prev_stderr = $stderr
+        
+        out = StringIO.new
+        $stdout = out
+        #$stderr = out
+        
+        eval(code, @binding)
+        
+        $stdout = prev_stdout
+        #$stderr = prev_stderr
+        
+        if out.string.length > 0 && language != "ruby-datastory-silent"
+          output += "<p>Output:</p><pre>#{out.string}</pre>"
+        end
+      end
+      
+      output
+    end
+    
+    
+    # Inserts an image. If the image is relative to the current path it'll load it as a data
+    # URI to make the resulting report self contained.
+    def image(link, title, alt_text)
+      if link.start_with?("http")
+        <<-EOF
+          <img src="#{link}" alt="#{alt_text}" title="#{title}">
+        EOF
+      else
+        src = DataURI.from_file(link)
+        <<-EOF
+          <img src="#{src}" alt="#{alt_text}" title="#{title}">
+        EOF
+      end
+    end
+  end
+end

data/lib/datastory/version.rb

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

data/lib/datastory.rb

@@ -0,0 +1,82 @@
+require_relative "datastory/version"
+require_relative "datastory/markdown_renderer"
+require_relative "datastory/data_uri"
+
+module DataStory
+  class Renderer
+    def initialize(path)
+      @path = path
+      @markdown = Redcarpet::Markdown.new(DataStory::MarkdownRenderer, 
+          no_intra_emphasis: true,
+          fenced_code_blocks: true,
+          autolink: true,
+          disable_indented_code_blocks: true,
+          strikethrough: true,
+          lax_spacing: true,
+          space_after_headers: true,
+          superscript: true,
+          underline: true,
+          highlight: true,
+          footnotes: true)
+    end
+    
+    def render_to(output_path)
+      markdown_data = File.read(@path)
+      
+      output = @markdown.render(markdown_data)
+      
+      doc = <<-EOF
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <title>DataStory</title>
+          <style>
+            body {
+              font-family: Helvetica, Arial, sans-serif;
+              font-size: 100%;
+            }
+            
+            h1,h2,h3,h4,h5,h6 {
+              font-family: "Times", "Times New Roman", serif;
+            }
+            h1 {
+              font-size: 2.5rem;
+            }
+            
+            pre {
+              background: #eee;
+              padding: 8px;
+            }
+            
+            footer {
+              font-size: .8rem;
+              border-top: 2px solid #eee;
+            }
+            
+            .content {
+              width: 80%;
+              margin: 0 auto;
+            }
+          </style>
+        </head>
+        <body>
+          <div class="content">
+            #{output}
+          
+            <footer>
+              <p>
+                <em>Generated by <a href="http://github.com/commondream/datastory">DataStory</a> on
+                #{Time.now}</em>. <a href="#{DataURI.from_file(@path)}">Original Source</a>
+              </p>
+            </footer>
+          </div>
+        </body>
+      </html>
+      EOF
+      
+      File.open(output_path, "wb") do |file|
+        file.write(doc)
+      end
+    end
+  end
+end

data/samples/test.md

@@ -0,0 +1,51 @@
+# Test Story
+
+The idea behind DataStory is that it's hard to tell stories with data sometimes, so we all need
+tools that help us do that as easily as possible. DataStory uses markdown to convert scripts and
+content into great looking output that tells a story.
+
+``` ruby-datastory
+require 'gnuplot'
+```
+
+``` ruby-datastory
+puts "This is a test"
+output = 5 + 5
+puts output
+```
+
+Here's some code with no output. It shouldn't have an output section under it.
+
+``` ruby-datastory
+output += 2
+```
+
+And then another output.
+``` ruby-datastory
+puts output
+```
+
+Now let's output a graph:
+
+``` ruby-datastory
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new(gp) do |plot|
+    plot.terminal "gif"
+    plot.output "tmp/sin_wave.gif"
+  
+    # see sin_wave.rb
+    plot.xrange "[-10:10]"
+    plot.title  "Sin Wave Example"
+    plot.ylabel "sin(x)"
+    plot.xlabel "x"
+    
+    plot.data << Gnuplot::DataSet.new( "sin(x)" ) do |ds|
+      ds.with = "lines"
+      ds.linewidth = 4
+    end
+    
+  end
+end
+```
+
+![Graph of Stuff](tmp/sin_wave.gif)

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: datastory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alan Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.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: Tell stories about data and share your work.
+email:
+- alan@commondream.com
+executables:
+- datastory
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/datastory
+- datastory.gemspec
+- lib/datastory.rb
+- lib/datastory/data_uri.rb
+- lib/datastory/markdown_renderer.rb
+- lib/datastory/version.rb
+- samples/test.md
+homepage: http://github.com/commondream/datastory
+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.6
+signing_key: 
+specification_version: 4
+summary: Tell stories about data and share your work.
+test_files: []
+has_rdoc: