rygments 0.1.0 → 0.2.0

data/.gitignore

@@ -3,3 +3,14 @@
 Gemfile.lock
 pkg/*
 doc/
+tmp/
+
+lib/rygments/*.pyc
+lib/*.so
+lib/*.bundle
+lib/*.o
+
+ext/Makefile
+ext/*.so
+ext/*.bundle
+ext/*.o

data/CHANGELOG.markdown

@@ -0,0 +1,11 @@
+# Release history for Rygments
+
+## 0.2.0
+
+ * Exceptions from Pygments are now passed on to Ruby
+ * Added strictly defined error handling
+ * Added RSpec tests
+
+## 0.1.0
+
+ * Initial release

data/README.markdown

@@ -6,10 +6,10 @@ highlighter.
 Rygments differs from other implementations in that it embeds a full
 Python interpreter for the Pygments Python files as a Ruby C extension.
 This enables Rygments to reach a level of performance that is equal to
-invoking Pygments from a native Python application, and without the overhead forking
+invoking Pygments from a native Python application, and without the overhead of forking
 a new process. This difference in performance really pays off when
 you are highlighting lots of smaller code fragments, e.g. for blog
-posts.
+posts or documentation generators such as Rocco.
 
 Compared to Albino (another popular Pygments Ruby wrapper) Rygments is over 30% faster when using it to highlight all files from the Ruby 1.9.2 source code.
 
@@ -73,7 +73,14 @@ website.
 
 # Compatibility
 
-Rygments has been tested on OSX Snow Leopard (10.6.6) and Ubuntu Linux 10.10. If you used it with success on a different platform then please let me know so I can extend this list.
+Rygments has been tested and is known to work on Ruby Enterprise Edition 1.8.7-2011.01 and Ruby 1.9.2.
+
+It has been tested on the following platforms:
+
+ * OSX Snow Leopard (10.6.6)
+ * Ubuntu Linux (8.04 and 10.10)
+
+If you used it with success on a different Ruby implementation or platform then please let me know so I can extend this list.
 
 # License
 

data/Rakefile

@@ -1,2 +1,16 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new do |ext|
+  ext.name = 'wrapper'
+  ext.ext_dir = 'ext'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--options', 'spec/spec.opts']
+end
+
+task :spec => :compile
+task :default => :spec

data/ext/wrapper.c

@@ -25,6 +25,34 @@ struct wrapper_struct {
 static VALUE rygments_class = Qnil;
 static VALUE wrapper_class = Qnil;
 
+/* This function collects a Python exception and raises it as a Ruby exception */
+static void reraise() {
+    PyObject *ptype, *pvalue, *ptraceback, *pystr = NULL;
+    VALUE rstr;
+
+    if (PyErr_Occurred()) {
+        /* Fetch and normalize information about the exception */
+        PyErr_Fetch(&ptype, &pvalue, &ptraceback);
+        PyErr_NormalizeException(&ptype, &pvalue, &ptraceback);
+
+        /* Convert the Python exception string to a Ruby string */
+        if (pvalue != NULL && (pystr = PyObject_Str(pvalue)) != NULL && PyString_Check(pystr)) {
+            rstr = rb_str_new2(PyString_AsString(pystr));
+        } else {
+            rstr = rb_str_new2("An unknown Python exception was thrown");
+        }
+        Py_XDECREF(pystr);
+
+        /* Release the references given by PyErr_Fetch */
+        Py_DECREF(ptype);
+        Py_XDECREF(pvalue);
+        Py_XDECREF(ptraceback);
+
+        /* Raise a Ruby exception */
+        rb_raise(rb_eRuntimeError, "%s", RSTRING_PTR(rstr));
+    }
+}
+
 /* This function places a string at a certain index in the given tuple */
 static int put_in_tuple(PyObject *tuple, int index, const char *string) {
     /* Don't accept NULL pointers */
@@ -57,9 +85,7 @@ static int initialize(struct wrapper_struct *s) {
 
     /* Check if module was loaded successfully */
     if (s->module == NULL) {
-        PyErr_Print();
-        fprintf(stderr, "Failed to load the rygments python module\n");
-        return 1;
+        reraise();
     }
     
     /* Get a reference to the rygmentize function */
@@ -71,11 +97,12 @@ static int initialize(struct wrapper_struct *s) {
         Py_DECREF(s->module);
 
         if (PyErr_Occurred()) {
-            PyErr_Print();
+            reraise();
         }
 
-        fprintf(stderr, "Cannot find the rygmentize function in the python module\n");
-        return 1;
+        Py_Finalize();
+
+        rb_raise(rb_eRuntimeError, "Cannot find the rygmentize function in the Python module");
     }
 
     return 0;
@@ -96,6 +123,11 @@ static VALUE wrapper_highlight_string(VALUE self, VALUE code, VALUE lexer, VALUE
     PyObject *pArgs, *pValue;
     int res;
 
+    /* Make sure we have three strings as input */
+    Check_Type(code, T_STRING);
+    Check_Type(lexer, T_STRING);
+    Check_Type(formatter, T_STRING);
+
     /* Get the wrapper structure */
     Data_Get_Struct(self, struct wrapper_struct, s);
 
@@ -109,8 +141,7 @@ static VALUE wrapper_highlight_string(VALUE self, VALUE code, VALUE lexer, VALUE
     /* Check if we have bad arguments */
     if (res) {
         Py_DECREF(pArgs);
-        fprintf(stderr,"Bad arguments\n");
-        return Qnil;
+        rb_raise(rb_eRuntimeError, "bad input given");
     }
 
     /* Call the function */
@@ -119,8 +150,9 @@ static VALUE wrapper_highlight_string(VALUE self, VALUE code, VALUE lexer, VALUE
 
     /* Check if we have a valid result */
     if (pValue == NULL) {
-        fprintf(stderr,"Call failed\n");
-        return Qnil;
+        reraise();
+
+        rb_raise(rb_eRuntimeError, "Call failed");
     }
 
     /* Convert the pygmentized result to a Ruby string */
@@ -143,23 +175,33 @@ static VALUE wrapper_highlight_string(VALUE self, VALUE code, VALUE lexer, VALUE
 static VALUE wrapper_highlight_file(VALUE self, VALUE filename, VALUE lexer, VALUE formatter) {
     FILE *f;
 
+    /* Make sure the filename is a string */
+    Check_Type(filename, T_STRING);
+
     /* Open the file */
     if ((f=fopen(RSTRING_PTR(filename),"r"))==NULL) {
-        printf("error: could not open file\n");
-        return Qnil;
+        rb_sys_fail("could not open file");
     }
     
     /* Determine the file size */
-    fseek(f,0,SEEK_END);
+    if (fseek(f,0,SEEK_END) == -1) {
+        rb_sys_fail("could not seek to end of file");
+    }
     long fsize=ftell(f);
+    if (fsize == -1) {
+        rb_sys_fail("could not determine file length");
+    }
     rewind(f);
     
     /* Read the contents of the file into a buffer */
     char *buf=ALLOC_N(char, fsize);
     if ((fread(buf,1,fsize,f))!=(size_t)fsize) {
-        printf("error: could not read from file \"\"\n");
+        /* Close file handle with cached errno value */
+        int err = errno;
         fclose(f);
-        return Qnil;
+        errno = err;
+
+        rb_sys_fail("could not read from file");
     }
     fclose(f);
 
@@ -174,7 +216,7 @@ static VALUE wrapper_highlight_file(VALUE self, VALUE filename, VALUE lexer, VAL
 /* Free the wrapper structure and deinitialize the Python interpreter */
 static void wrapper_free(void *p) {
     struct wrapper_struct *s = (struct wrapper_struct *)p;
-    
+
     /* Decrese refcounts of the Python helper */
     Py_DECREF(s->rygmentize);
     Py_DECREF(s->module);
@@ -183,7 +225,7 @@ static void wrapper_free(void *p) {
     if (PyErr_Occurred()) {
         PyErr_Print();
     }
-    
+
     /* Free the Python interpreter */
     Py_Finalize();
 

data/lib/rygments.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "ext", "wrapper"))
+require "wrapper"
 
 # = Introduction
 #
@@ -40,6 +40,9 @@ require File.expand_path(File.join(File.dirname(__FILE__), "..", "ext", "wrapper
 # Author:: Emil Loer (http://emilloer.com)
 # License:: Licensed under the terms of the MIT license
 module Rygments
+  # The full filename of the Python helper script
+  HELPER_PATH = File.expand_path(File.join(File.dirname(__FILE__), "rygments"))
+
   # Perform syntax highlighting on a string.
   # Returns the highlighted string.
   def self.highlight_string(code, lexer = "ruby", formatter = "html")
@@ -52,11 +55,6 @@ module Rygments
     wrapper.highlight_file filename, lexer, formatter
   end
 
-  private
-
-  # The full filename of the Python helper script
-  HELPER_PATH = File.expand_path(File.join(File.dirname(__FILE__), "rygments"))
-
   # This function maintains a single instance of the Python wrapper 
   # extension.
   def self.wrapper

data/lib/rygments/version.rb

@@ -1,3 +1,3 @@
 module Rygments
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/rygments.gemspec

@@ -19,6 +19,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency("rspec", ["~> 2.0"])
+  s.add_development_dependency("rake-compiler", ["~> 0.7"])
+
   s.has_rdoc = true
   s.extensions = ["ext/extconf.rb"]
 end

data/spec/rygments_spec.rb

@@ -0,0 +1,125 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Rygments::Wrapper do
+  subject do
+    # We don't want to recreate wrappers because reinitializing Python
+    # fails on OSX
+    Rygments.wrapper
+  end
+
+  describe "#highlight_string" do
+    it "should return a string" do
+      subject.highlight_string("puts 'Hello World!'", "ruby", "html").should be_a(String)
+    end
+
+    it "should raise an exception when given an invalid formatter" do
+      expect {
+        subject.highlight_string("puts 'Hello World!", "ruby", "awesome_nonexistant_formatter")
+      }.to raise_error
+    end
+
+    it "should raise an exception when given an invalid lexer" do
+      expect {
+        subject.highlight_string("puts 'Hello World!", "awesome_nonexistant_lexer", "html")
+      }.to raise_error
+    end
+  end
+
+  describe "#highlight_file" do
+    it "should return a string" do
+      subject.highlight_file(__FILE__, "ruby", "html").should be_a(String)
+    end
+
+    it "should raise an exception when given a nonexisting filename" do
+      expect {
+        subject.highlight_file("this_file_does_not_exist", "ruby", "html")
+      }.to raise_error
+    end
+
+    it "should raise an exception when given an invalid formatter" do
+      expect {
+        subject.highlight_file(__FILE__, "ruby", "awesome_nonexistant_formatter")
+      }.to raise_error
+    end
+
+    it "should raise an exception when given an invalid lexer" do
+      expect {
+        subject.highlight_file(__FILE__, "awesome_nonexistant_lexer", "html")
+      }.to raise_error
+    end
+  end
+end
+
+describe Rygments do
+  describe "#highlight_string" do
+    it "should return a string" do
+      Rygments.highlight_string("puts 'Hello World!'", "ruby", "html").should be_a(String)
+    end
+
+    it "should raise an exception when given an invalid formatter" do
+      expect {
+        Rygments.highlight_string("puts 'Hello World!", "ruby", "awesome_nonexistant_formatter")
+      }.to raise_error
+    end
+
+    it "should raise an exception when given an invalid lexer" do
+      expect {
+        Rygments.highlight_string("puts 'Hello World!", "awesome_nonexistant_lexer", "html")
+      }.to raise_error
+    end
+
+    it "should raise an exception when the first argument is not a string" do
+      expect {
+        Rygments.highlight_string(:no_string, "ruby", "html")
+      }.to raise_error
+    end
+
+    it "should raise an exception when the second argument is not a string" do
+      expect {
+        Rygments.highlight_string("puts 'Hello World!", :no_string, "html")
+      }.to raise_error
+    end
+
+    it "should raise an exception when the third argument is not a string" do
+      expect {
+        Rygments.highlight_string("puts 'Hello World!", "ruby", :no_string)
+      }.to raise_error
+    end
+  end
+  
+  describe "#highlight_file" do
+    it "should return a string" do
+      Rygments.highlight_file(__FILE__, "ruby", "html").should be_a(String)
+    end
+
+    it "should raise an exception when given an invalid formatter" do
+      expect {
+        Rygments.highlight_file(__FILE__, "ruby", "awesome_nonexistant_formatter")
+      }.to raise_error
+    end
+
+    it "should raise an exception when given an invalid lexer" do
+      expect {
+        Rygments.highlight_file(__FILE__, "awesome_nonexistant_lexer", "html")
+      }.to raise_error
+    end
+
+    it "should raise an exception when the first argument is not a string" do
+      expect {
+        Rygments.highlight_file(:no_string, "ruby", "html")
+      }.to raise_error
+    end
+
+    it "should raise an exception when the second argument is not a string" do
+      expect {
+        Rygments.highlight_file(__FILE__, :no_string, "html")
+      }.to raise_error
+    end
+
+    it "should raise an exception when the third argument is not a string" do
+      expect {
+        Rygments.highlight_file(__FILE__, "ruby", :no_string)
+      }.to raise_error
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+SPEC_DIR = File.dirname(__FILE__)
+lib_path = File.expand_path(File.join(SPEC_DIR, "..", "lib"))
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require "rygments"
+require "wrapper"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rygments
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Emil Loer
@@ -15,10 +15,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 +01:00
+date: 2011-03-02 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id002
 description: Rygments is a Ruby wrapper for the Pygments syntax highlighter. It uses an embedded Python interpreter to get high processing throughput.
 email: 
 - emil@koffietijd.net
@@ -30,6 +59,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.markdown
 - Gemfile
 - README.markdown
 - Rakefile
@@ -40,6 +70,9 @@ files:
 - lib/rygments/rygments.py
 - lib/rygments/version.rb
 - rygments.gemspec
+- spec/rygments_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/thedjinn/rygments
 licenses: []
@@ -74,5 +107,7 @@ rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Rygments is a Ruby wrapper for Pygments
-test_files: []
-
+test_files: 
+- spec/rygments_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb