RubyGems - tidy - Versions diffs - 1.0.1 → 1.1.0 - Mend

tidy 1.0.1 → 1.1.0

Files changed (13) hide show

data/CHANGES CHANGED

@@ -1,3 +1,11 @@
+V 1.1.0 2005/02/21
+  - $TIDYLIB global eliminated
+    Path to the library is now specified as follows:
+    Tidy.path = '/path/to/tidylib.so'
+  - minor code/docs/gemspec cleanup
 V 1.0.1
   .sub calls changed to .gsub

data/README.txt.en CHANGED

@@ -13,13 +13,14 @@ Requirements
 Install
 -------
-  - Download library from http://tidy.sf.net (pre-compiled versions available)
+  - Download library from http://tidy.sf.net (pre-compiled versions available).
-  - Download the tidy .gem file to a directory. Then type:
-      $ gem install tidy .gem
-  - Open test/usage.rb, edit $TIDYLIB to point to your compiled tidy library, run.
+  - Install files using one of the following:
+    $ gem install tidy-x-x-x.gem
+    $ ruby install.rb
+  - Open test/usage.rb, change Tidy.path to point to your compiled Tidy library, run.
 Usage
 -----

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 1.0.1
1	+ 1.1.0

data/install.rb ADDED

@@ -0,0 +1,11 @@
+require 'rbconfig'
+require 'ftools'
+# Install lib
+dst_dir = Config::CONFIG['sitelibdir']
+Dir.chdir('lib') {
+  Dir['**/*'].reject { |f| f =~ /\.(cvs|gem|svn)($|\/)/i or not File.file?(f) }.each { |file|
+    File.mkpath File.join(dst_dir, File.dirname(file)), true
+    File.install file, File.join(dst_dir, file), 0644, true
+  }
+}

data/lib/tidy.rb CHANGED

@@ -1,10 +1,9 @@
-# Ruby interface to HTML Tidy Library Project (http://tidy.sf.net)
+# Ruby interface to HTML Tidy Library Project (http://tidy.sf.net).
 #
-# = Usage
+# =Usage
 #
-#   $TIDYLIB = '/usr/lib/tidylib.so'
-#   require 'rubygems'
-#   require_gem 'tidy'
+#   require 'tidy'
+#   Tidy.path = '/usr/lib/tidylib.so'
 #   html = '<html><title>title</title>Body</html>'
 #   xml = Tidy.open(:show_warnings=>true) do |tidy|
 #     tidy.options.output_xml = true
@@ -31,17 +30,29 @@ module Tidy
   module_function
-  # Return a Tidyobj instance
+  # Return a Tidyobj instance.
   #
   def new(options=nil)
     Tidyobj.new(options)
   end
-  # With no block, open is a synonym for Tidy.new .
+  # Path to Tidylib.
+  #
+  def path() @path end
+  # Set the path to Tidylib (automatically loads the library).
+  #
+  def path=(path)
+    Tidylib.load(path)
+    @path = path
+  end
+  # With no block, open is a synonym for Tidy.new.
   # If a block is present, it is passed aTidy as a parameter.
-  # aTidyObj.release is ensured at end of the block
+  # aTidyObj.release is ensured at end of the block.
   #
   def open(options=nil)
+    raise "Tidy.path was not specified." unless @path
     tidy = Tidy.new(options)
     if block_given?
       begin
@@ -55,11 +66,10 @@ module Tidy
   end
   # Convert to boolean.
-  # 0, false and nil return false, anything else true
+  # 0, false and nil return false, anything else true.
   #
   def to_b(value)
-    return false if [0,false,nil].include?(value)
-    true
+    [0,false,nil].include?(value) ? false : true
   end
 end

data/lib/tidy/tidybuf.rb CHANGED

@@ -1,14 +1,14 @@
-# Buffer structure
+# Buffer structure.
 #
 class Tidybuf
   extend DL::Importable
-  # Access TidyBuffer instance
+  # Access TidyBuffer instance.
   #
   attr_reader(:struct)
-  # Mimic TidyBuffer
+  # Mimic TidyBuffer.
   #
   TidyBuffer = struct [
     "byte* bp",
@@ -17,23 +17,23 @@ class Tidybuf
     "uint next"
   ]
-  def initialize()
+  def initialize
     @struct = TidyBuffer.malloc
   end
-  # Free current contents and zero out
+  # Free current contents and zero out.
   #
-  def free()
+  def free
     Tidylib.buf_free(@struct)
   end
-  # Convert to array
+  # Convert to array.
   #
   def to_a
     to_s.split("\r\n")
   end
-  # Convert to string
+  # Convert to string.
   #
   def to_s
     @struct.bp.to_s

data/lib/tidy/tidyerr.rb CHANGED

@@ -1,21 +1,21 @@
-# Parameterized error message
+# Parameterized error message.
 #
 class Tidyerr < String
-  # Error parameter
+  # Error parameter.
   #
   attr_reader :severity, :line, :column, :message
-  # Create new instance
+  # Create new instance.
   #
   def initialize(error)
     super(error.to_s)
     parameterize
   end
-  # Parse error message into parameters (where applicable)
+  # Parse error message into parameters (where applicable).
   #
-  def parameterize()
+  def parameterize
     if to_str[0,4] == 'line'
       tokens    = to_str.split(' ', 7)
       @severity = tokens[5][0,1] # W or E

data/lib/tidy/tidylib.rb CHANGED

@@ -1,4 +1,4 @@
-# Ruby wrapper for HTML Tidy Library Project (http://tidy.sf.net)
+# Ruby wrapper for HTML Tidy Library Project (http://tidy.sf.net).
 #
 module Tidylib
@@ -6,14 +6,13 @@ module Tidylib
   module_function
-  # Load library (requires that $TIDYLIB be defined)
+  # Load the library.
   #
-  def load()
-    raise LoadError, 'Tidy requires that $TIDYLIB be defined' if $TIDYLIB.nil?
+  def load(path)
     begin
-      dlload($TIDYLIB)
+      dlload(path)
     rescue
-      raise LoadError, sprintf('Unable to load %s', $TIDYLIB)
+      raise LoadError, "Unable to load #{path}"
     end
     extern "void *tidyCreate()"
     extern "void tidyBufFree(void*)"
@@ -38,8 +37,8 @@ module Tidylib
   # tidyCreate
   #
-  def create()
-    tidyCreate()
+  def create
+    tidyCreate
   end
   # tidyCleanAndRepair
@@ -81,8 +80,8 @@ module Tidylib
   # tidyReleaseDate
   #
-  def release_date()
-    tidyReleaseDate()
+  def release_date
+    tidyReleaseDate
   end
   # tidyRunDiagnostics
@@ -103,13 +102,10 @@ module Tidylib
     tidySetErrorBuffer(doc, buf)
   end
-  # Convert to string replacing underscores with dashes.
-  # :output_xml becomes 'output-xml'
+  # Convert to string, replace underscores with dashes (:output_xml => 'output-xml').
   #
   def translate_name(name)
     name.to_s.gsub('_', '-')
   end
 end
-Tidylib.load

data/lib/tidy/tidyobj.rb CHANGED

@@ -1,25 +1,25 @@
-# Ruby interface to Tidylib
+# Ruby interface to Tidylib.
 #
 class Tidyobj
-  # Diagnostics Buffer (Array of String)
+  # Diagnostics Buffer (Array of String).
   #
   attr_reader(:diagnostics)
-  # Access the tidy instance
+  # Access the tidy instance.
   #
   attr_reader(:doc)
-  # Error Buffer (Array of Tidyerr)
+  # Error Buffer (Array of Tidyerr).
   #
   attr_reader(:errors)
-  # Options interface (Tidyopt)
+  # Options interface (Tidyopt).
   #
   attr_reader(:options)
   # Construct a new instance.
-  # Receives a hash of options to be set
+  # Receives a hash of options to be set.
   #
   def initialize(options=nil)
     @diagnostics = Array.new
@@ -35,13 +35,13 @@ class Tidyobj
     end
   end
-  # Clean and Repair
+  # Clean and Repair.
   #
   def clean(str)
     verify_doc
     rc = -1
-    # Clean and repair the string
+    # Clean and repair the string.
     #
     rc = Tidylib.parse_string(@doc, str)                                               # Parse the input
     rc = Tidylib.clean_and_repair(@doc) if rc >= 0                                     # Tidy it up!
@@ -49,14 +49,14 @@ class Tidyobj
     rc = Tidylib.save_buffer(@doc, @outbuf.struct) if rc >= 0                          # Pretty Print
     verify_severe(rc)
-    # Save and clear output/errors
+    # Save and clear output/errors.
     #
     output = @outbuf.to_s
     @errors = @errbuf.to_a.collect { |e| Tidyerr.new(e) }
     @outbuf.free
     @errbuf.free
-    # Save diagnostics
+    # Save diagnostics.
     #
     rc = Tidylib.run_diagnostics(@doc)
     verify_severe(rc)
@@ -66,36 +66,36 @@ class Tidyobj
     output
   end
-  # Load a tidy config file
+  # Load a tidy config file.
   #
   def load_config(file)
     verify_doc
     rc = Tidylib.load_config(@doc, file)
     case rc
-      when -1 then raise LoadError, sprintf('%s does not exist', file)
-      when  1 then raise LoadError, sprintf('errors parsing %s', file)
+      when -1 then raise LoadError, "#{file} does not exist"
+      when  1 then raise LoadError, "errors parsing #{file}"
     end
     rc
   end
-  # Clear the tidy instance
+  # Clear the tidy instance.
   #
-  def release()
+  def release
     verify_doc
     Tidylib.release(@doc)
     @doc = nil
   end
-  # Raise an error if the tidy document is invalid
+  # Raise an error if the tidy document is invalid.
   #
-  def verify_doc()
+  def verify_doc
     raise TypeError, 'Invalid Tidy document' unless @doc.class == DL::PtrData
   end
-  # Raise severe error based on tidy status value
+  # Raise severe error based on tidy status value.
   #
   def verify_severe(rc)
-    raise sprintf("A severe error (%d) occurred.\n", rc) if rc < 0
+    raise "A severe error (#{rc}) occurred.\n" if rc < 0
   end
   protected :verify_doc, :verify_severe

data/lib/tidy/tidyopt.rb CHANGED

@@ -1,26 +1,26 @@
-# Ruby interface to Tidylib options
+# Ruby interface to Tidylib options.
 #
 class Tidyopt
-  # Construct a new instance
+  # Construct a new instance.
   #
   def initialize(doc)
     @doc = doc
   end
-  # Reader for options (Hash syntax)
+  # Reader for options (Hash syntax).
   #
   def [](name)
     Tidylib.opt_get_value(@doc, name)
   end
-  # Writer for options (Hash syntax)
+  # Writer for options (Hash syntax).
   #
   def []=(name, value)
     Tidylib.opt_parse_value(@doc, name, value)
   end
-  # Reader/Writer for options (Object syntax)
+  # Reader/Writer for options (Object syntax).
   #
   def method_missing(name, value=:none, *args)
     name = name.to_s.gsub('=', '')

data/test/usage.rb CHANGED

@@ -1,6 +1,6 @@
-$TIDYLIB = '/usr/lib/tidylib.so'
-require 'rubygems'
-require_gem 'tidy'
+$LOAD_PATH.unshift('../lib')
+require 'tidy'
+Tidy.path = '/usr/lib/tidylib.so'
 html = '<html><title>title</title>Body</html>'
 xml = Tidy.open(:show_warnings=>true) do |tidy|
   tidy.options.output_xml = true

data/tidy.gemspec CHANGED

@@ -1,13 +1,19 @@
 require 'rubygems'
+version = File.read('VERSION').strip
+raise "no version" if version.empty?
 spec = Gem::Specification.new do |s|
-  s.name = "tidy"
-  s.version = File.read("VERSION").strip
-  s.summary = "Ruby interface to HTML Tidy Library Project"
-  s.description = s.summary+" (http://tidy.sf.net)"
-  s.files = Dir.glob("**/*").delete_if { |item| item.include?("CVS") }
+  s.name = 'tidy'
+  s.version = version
+  s.author = 'Kevin Howe'
+  s.email = 'kh@newclear.ca'
+  s.homepage = 'tidy.rubyforge.org'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Ruby interface to HTML Tidy Library Project'
+  s.files = Dir['**/*'].delete_if { |f| f =~ /(cvs|gem|svn)$/i }
   s.require_path = 'lib'
-  s.autorequire = 'tidy'
+  s.rdoc_options << '--all' << '--inline-source' << '--main' << 'lib/tidy.rb'
   s.has_rdoc = true
-  s.author = "Kevin Howe"
-  s.homepage = "http://www.newclear.ca/ruby/tidy/"
+  s.rubyforge_project = 'tidy'
 end

metadata CHANGED

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification
-rubygems_version: 0.8.1
+rubygems_version: 0.8.3
 specification_version: 1
 name: tidy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-date: 2005-01-13
+  version: 1.1.0
+date: 2005-02-21
 summary: Ruby interface to HTML Tidy Library Project
 require_paths:
   - lib
-author: Kevin Howe
-email:
-homepage: http://www.newclear.ca/ruby/tidy/
-rubyforge_project:
-description: Ruby interface to HTML Tidy Library Project (http://tidy.sf.net)
-autorequire: tidy
+email: kh@newclear.ca
+homepage: tidy.rubyforge.org
+rubyforge_project: tidy
+description:
+autorequire:
 default_executable:
 bindir: bin
 has_rdoc: true
@@ -25,6 +24,8 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version:
 platform: ruby
+authors:
+  - Kevin Howe
 files:
   - test
   - lib
@@ -33,6 +34,7 @@ files:
   - CHANGES
   - tidy.gemspec
   - README.txt.en
+  - install.rb
   - test/usage.rb
   - lib/tidy
   - lib/tidy.rb
@@ -42,7 +44,11 @@ files:
   - lib/tidy/tidybuf.rb
   - lib/tidy/tidyopt.rb
 test_files: []
-rdoc_options: []
+rdoc_options:
+  - "--all"
+  - "--inline-source"
+  - "--main"
+  - lib/tidy.rb
 extra_rdoc_files: []
 executables: []
 extensions: []