atlas2ipynb 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTg5MzhiYWI1NzVjODhiNzgyZjQ4OTY2NDc0NjA0ZjM5YTY5ZTJkNg==
+  data.tar.gz: !binary |-
+    Y2U5MTJhNmMwNTE3NTM0ZmRkZDlhMzhhMjg2NzMzOGRmZDA5NTJmMg==
+SHA512:
+  metadata.gz: !binary |-
+    N2VmMjBmYzA2OTNhZjhiNDdkMjliN2E5OTljMGU3NzMyNDUwNDJiNjMxMmRi
+    ZTEzNWNkNzk5MTFmY2I2YzY0NWQ4OTZhNDYyZTg1NjQ0ODlkNTRmY2ZhMDFi
+    ODg3ZTBjYjA1Nzg2NDE4Yjg1NDFmZWEzZWMyYWY3ODRiZDIzOWE=
+  data.tar.gz: !binary |-
+    ZjA2YTMwNjU4ODU4NGYzN2IxNTY5OTkxMzM5YjFiYmFhNWRhNjRiZWRmOGQ2
+    YzA1MzhhZTM2MDZhMTY1NDUzMTBlNmFmMmViMjQyZjRmMjQ4MDIwNWNjZjY2
+    NDBjNzE2MjkxZTdlOTIzZTMxNzBlNjY0YmY5ZjVhNTVlYTY1Yjg=

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Odewahn
+
+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 @@
+# Atlas2ipynb
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'atlas2ipynb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atlas2ipynb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/atlas2ipynb/fork )
+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/atlas2ipynb.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "atlas2ipynb"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Andrew Odewahn"]
+  spec.email         = ["odewahn@oreilly.com"]
+  spec.summary       = %q{Converts Atlas HTML build into iPythyon Notebooks.}
+  spec.description   = %q{Converts all ch*.html files from Atlas into iPythyon Notebooks.}
+  spec.homepage      = "https://github.com/odewahn/atlas2ipynb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "active_support", '~> 3.0', '>= 3.0.0'
+  spec.add_dependency "i18n"
+  
+end

data/bin/atlas2ipynb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'rubygems'
+require 'atlas2ipynb'
+
+
+c = Atlas2ipynb::Converter.new
+c.convert!

data/lib/atlas2ipynb.rb

@@ -0,0 +1,140 @@
+require 'nokogiri'
+require 'json'
+require 'i18n'
+require 'active_support/inflector'
+
+# If running in irb, don't forget to do this:
+#    require 'bundler'
+#    Bundler.require
+#
+module Atlas2ipynb
+  
+  class Converter
+
+    #*************************************************************************************
+    # ipynb uses the plain filename as the user's index page, so we need to make something
+    # a name that is "meaningful".  To do this, I turn the <h1> from the first section, which 
+    # should be the chapter title, into a filename, per
+    #    http://stackoverflow.com/questions/1939333/how-to-make-a-ruby-string-safe-for-a-filesystem
+    # Also, since we might have special chars and foreign language isseus, we transliterate
+    # the string to strip out accents and such, per:
+    #    http://stackoverflow.com/questions/225471/how-do-i-replace-accented-latin-characters-in-ruby
+    # (I'm not sure what it will do with CJKV  languages.)  Finally, it ensures that the
+    # string is less than 50 chars long, but breaks it on a word boundry so that it 
+    # looks "nice"
+    #*************************************************************************************
+    def string_to_filename(s)
+       I18n.enforce_available_locales = false
+       out = ActiveSupport::Inflector.transliterate(s).downcase
+       out.gsub!(/^.*(\\|\/)/,'')
+       out.gsub!(/[^0-9A-Za-z]/,"_")
+       # truncate the name at 50 chars, but do it "nicely"
+       candidate = out[0,50].split("_") - [""]
+       return candidate.join("_")
+    end
+
+
+    #*************************************************************************************
+    # This function  processes the raw HTML sections using nokogiri.  It looks for 
+    # headers or code; everything else is treated as HTML.  This can be passed to 
+    # ipynb directly since markdown is a superset of HTML.  Although I'd originally
+    # planned to convert HTML to markdown, this proved infeasible with all the many
+    # edge cases in conversion, such has mathml
+    #*************************************************************************************
+    def process_section(n, level, out) 
+      n.children.each do |c|  
+         case c.name
+            when "section"
+              process_section(c, level+1, out) # since a section is just a container, we need to recurse to get the content                
+            when "h1", "h2", "h3", "h4", "h4", "h5", "h6"
+              out << {
+                 "cell_type" => "heading",
+                 "level" => level,
+                 "metadata" => {}, 
+                 "source" => c.text
+               }
+            when "pre","code"
+              out << {   
+                 "cell_type" => "code",
+                 "collapsed" => false,
+                 "input" => c.text, 
+                 "language" => c.attributes["data-code-language"] || "python",
+                 "metadata" => {}, 
+                 "outputs" => []
+               }
+            else
+              out << {   
+                 "cell_type" => "markdown",
+                 "metadata" => {}, 
+                 "source" => c.to_s
+              }
+          end
+        end  
+        return out
+    end
+
+
+    #*************************************************************************************
+    # This function takes a file name with HTML content, parses it with nokogiri, does some
+    # post-processing on the image links, and then calls process_section to convert
+    # each element to the corrseponding ipynb cell type (markdown, header, or code)
+    #*************************************************************************************
+    def html_to_ipynb(fn)
+      #
+      # Open the file and parse it w/nokogiri
+      doc = Nokogiri::HTML(IO.read(fn), nil, 'utf-8')
+      #
+      # Pre-process the doc to fix image URLs so that images can be served by the notebook server
+      # You do this by prepending "files/" to the image's relative URL, per this question on stackoverflow:
+      #   "inserting image into ipython notebook markdown"
+      doc.css("figure img").each do |img|
+        src = img.attributes["src"].value
+        img.attributes["src"].value = src.split("/").unshift("files").join("/")  #prepends "files" to the src
+      end
+      #
+      # Grab the first h1 tag to use as part of the notebooks filename
+      #
+      chapter_title = doc.css("section h1").first.text
+      #
+      # combine the cells we just computed with the ipynb header information
+      #
+      notebook = {
+       "metadata" => {
+        "name" => chapter_title
+       },
+       "nbformat" => 3,
+       "nbformat_minor"=> 0,
+       "worksheets" => [
+        {
+         "cells" => self.process_section(doc.css("section").first,1, []),  
+         "metadata" => {}
+        }
+       ]
+      }
+      return notebook
+    end
+
+
+    #*************************************************************************************
+    # Convert all chapter files in the directory into ipynb
+    #*************************************************************************************
+    def convert!
+      puts "Searching for ch*.html files from Atlas"
+      Dir["ch*.html"].each do |fn|
+        out = html_to_ipynb(fn)
+        # Compute the new filename, which is the original filename 
+        # with the ".html" (last 5 chars) replaced with ".ipynb".   
+        title_fn = self.string_to_filename(out['metadata']['name'])
+        ipynb_fn = "#{fn[0,fn.length-5]}_#{title_fn}.ipynb"
+        puts "... Converting #{fn} to #{ipynb_fn}"
+        # Create the file
+        f = File.open(ipynb_fn, 'w')
+        f.write JSON.pretty_generate(out)
+        f.close
+      end
+      puts "Done!"
+    end
+
+  end  
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: atlas2ipynb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Odewahn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ! '>='
+      - !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'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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'
+description: Converts all ch*.html files from Atlas into iPythyon Notebooks.
+email:
+- odewahn@oreilly.com
+executables:
+- atlas2ipynb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- atlas2ipynb.gemspec
+- bin/atlas2ipynb
+- lib/atlas2ipynb.rb
+homepage: https://github.com/odewahn/atlas2ipynb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Converts Atlas HTML build into iPythyon Notebooks.
+test_files: []