LiterateRuby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a83fe70c28d8a6cb8cc3405ad8d4a74a7524e76e
+  data.tar.gz: 836191dec59cbd069d3071b67c2b5c88b60b17c0
+SHA512:
+  metadata.gz: 3e74933ae262fd7a7457b972bea899a2e078d37b7e38a1c38fb46fe945193c9fe067c5f9671777cc539bff8c68199b6d35f988dc16277c205d7c80e1e92c6e67
+  data.tar.gz: bcc1add2ddc784458b8f5b7071de7b5b2a6b6c2defbd166c3fe01942c7fa78da5eba66c67962370608f91e6615442f452efe0bd4ebea6ab886990651970515e9

data/README.md

@@ -0,0 +1,30 @@
+# Literate Ruby
+[![Gem
+Version](https://badge.fury.io/rb/LiterateRuby.svg)](https://badge.fury.io/rb/LiterateRuby)
+
+## Name
+The name is inspired by Literate Haskell.
+
+## Usage
+
+A file like this
+
+```
+This is some commentary on ruby code,
+and here is some more commentary.
+
+> puts 'this is executable ruby code'
+> # of course, you can include comments
+> # in here, but why would you?
+> class A
+>  def you_can_define
+>    @classes_and_such = 'in here'
+>  end
+>  # if you want to 
+> end 
+
+This is called bird style. There are specs on it
+[here](https://wiki.haskell.org/Literate_programming#Bird_Style).
+
+## Future
+In the future LaTeX might be used in here as well.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+
+desc 'Run tests'
+task default: :test
+
+task :clean do
+  `rm *.gem`
+end
+
+task :build do
+  `gem build literate-ruby.gemspec`
+end
+
+task :deploy do
+  `rake clean`
+  `rake build`
+  `gem push *.gem`
+end

data/lib/literate-ruby.rb

@@ -0,0 +1,4 @@
+require 'literate-ruby/file'
+
+module LiterateRuby
+end

data/lib/literate-ruby/file.rb

@@ -0,0 +1,15 @@
+module LiterateRuby
+  class File < File
+    def parse
+      base = File.basename(path, '.*')
+      `touch #{File.basename(path, '.*')}.rb`
+      file = read
+      File.open("#{base}.rb", 'w') do |f|
+        file.each_line do |line|
+          f.write(line[2..-1]) if line[0...2] == '> '
+        end
+      end
+      "#{base}.rb"
+    end
+  end
+end

data/test/test_file.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'literate-ruby'
+
+describe File do
+  describe 'test file conversion' do
+    literate_file = LiterateRuby::File.new('first_file.lrb', 'r')
+    file_name = literate_file.parse
+    lr = File.new(file_name, 'r').read
+    compp = File.new('first_file_actual.rb', 'r').read
+    it 'must show that the conversion works' do
+      lr.must_equal compp
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: LiterateRuby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eli Sadoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies: []
+description: "This gem is hightly inspired by literate haskell. It currently will
+  support \n\"bird style\" which is described in full [here](https://wiki.haskell.org/Literate_programming#Bird_Style).\n"
+email: snood1205@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Rakefile
+- bin/literate-ruby
+- lib/literate-ruby.rb
+- lib/literate-ruby/file.rb
+- test/test_file.rb
+homepage: https://github.com/snood1205/literate-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "-t"
+- literate-ruby RDocs
+- "-m"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A gem to write, so-called, literate ruby.
+test_files:
+- test/test_file.rb