tidy_ffi 0.0.2

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.0.2. Do not require matchy, rr and context as development dependencies. A user does not need them.
+v0.0.1. Options support.
+v0.0.0. Initial release.

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Eugene Pimenov
+
+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/Manifest

@@ -0,0 +1,15 @@
+CHANGELOG
+LICENSE
+Manifest
+README
+Rakefile
+lib/tidy_ffi/interface.rb
+lib/tidy_ffi/lib_tidy.rb
+lib/tidy_ffi/options_container.rb
+lib/tidy_ffi/tidy.rb
+lib/tidy_ffi/tidy_ffi_extensions.rb
+lib/tidy_ffi.rb
+test/test_helper.rb
+test/test_options.rb
+test/test_simple.rb
+tidy_ffi.gemspec

data/README

@@ -0,0 +1,23 @@
+= Tidy FFI
+
+== Purpose
+
+I wanna clean and simple tidy library. For example:
+  TidyFFI::Tidy.new('a string').clean
+
+For now it can't do anything else than clean :)
+
+== Options
+
+You can use different ways to set up options. These examples are produces the same output:
+
+  TidyFFI::Tidy.default_options.show_body_only = true
+  TidyFFI::Tidy.new('test').clean
+  
+  TidyFFI::Tidy.with_options(:show_body_only => true).new('test').clean
+  
+  tidy = TidyFFI::Tidy.new('test')
+  tidy.options.show_body_only = true
+  tidy.clean
+
+  

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+begin
+  require 'echoe'  
+  Echoe.new('tidy_ffi') do |p|
+    p.author = 'Eugene Pimenov'
+    p.summary = 'Tidy library interface via FFI'
+    p.url = 'http://github.com/libc/tidy_ffi'
+    p.runtime_dependencies = ['ffi >= 0.2.0']
+    # p.development_dependencies = ['rr', 'matchy', 'context']
+    p.project = 'tidy-ffi'
+  end
+rescue LoadError => boom
+  puts "You are missing a dependency required for meta-operations on this gem."
+  puts "#{boom.to_s.capitalize}."
+
+  desc 'No effect.'
+  task :default do; end
+end

data/lib/tidy_ffi/interface.rb

@@ -0,0 +1,83 @@
+# Low level interface to libtidy.
+class TidyFFI::Interface
+  LibTidy = TidyFFI::LibTidy
+
+  # Returns a TidyFFI::Interface with initialized interface.
+  def self.with_doc
+    doc = LibTidy.tidyCreate
+    nd = new(doc)
+    nd.with_redirected_error_buffer { yield nd }
+  ensure
+    LibTidy.tidyRelease(doc)
+  end
+
+  def initialize(doc) #:nodoc:
+    @doc = doc
+  end
+
+  # Apply options
+  def apply_options(options)
+    options.each do |key, value|
+      k = key.to_s.gsub('_', '-')
+
+      option = LibTidy.tidyGetOptionByName(@doc, k)
+      raise ArgumentError, "don't know about option #{key}" if option.null?
+      id = LibTidy.tidyOptGetId(option)
+      raise ArgumentError, "can't setup option #{key} to #{value}" if LibTidy.tidyOptSetValue(@doc, id, value.to_s) == 0
+    end
+  end
+
+  # Sets string to tidy
+  def string=(str)
+    LibTidy.tidyParseString(@doc, str)
+  end
+
+  # Cleans string
+  def clean
+    @output = nil
+    LibTidy.tidyCleanAndRepair(@doc)
+  end  
+  alias :clean_and_repair :clean
+  alias :repair :clean
+
+  # Returns output from tidy library
+  def output
+    @output ||= begin
+      with_buffer_pointer do |buf|
+        LibTidy.tidySaveBuffer(@doc, buf)
+        buf[:bp]
+      end
+    end
+  end
+
+  # Redirects error buffer
+  def with_redirected_error_buffer
+    with_buffer_pointer do |buf|
+      @error_buffer = buf
+      LibTidy.tidySetErrorBuffer(@doc, buf)
+      yield
+    end
+  ensure
+    @error_buffer = nil
+  end
+
+  # Yields block with new buffer
+  def with_buffer_pointer
+    buf = tidy_buf_object.new
+    yield buf
+  ensure
+    LibTidy.tidyBufFree(buf)
+  end
+
+  def tidy_buf_object
+    @tidy_buf_object ||= begin
+      release_date = Date.parse(LibTidy.tidyReleaseDate) rescue nil
+      if release_date && (release_date > Date.parse("Dec 29 2006"))
+        TidyFFI::LibTidy::TidyBufWithAllocator
+      else
+        TidyFFI::LibTidy::TidyBuf
+      end
+    end
+  end
+  private :tidy_buf_object
+end

data/lib/tidy_ffi/lib_tidy.rb

@@ -0,0 +1,43 @@
+# Very low level interface to tidy
+
+# This file must be lazy loaded!
+class TidyFFI::LibTidy #:nodoc:
+  extend FFI::Library
+  ffi_lib TidyFFI.library_path
+
+  attach_function :tidyReleaseDate, [], :string
+
+  attach_function :tidyCreate, [], :pointer
+  attach_function :tidyRelease, [:pointer], :void
+
+  attach_function :tidyCleanAndRepair, [:pointer], :int
+  attach_function :tidyRunDiagnostics, [:pointer], :int
+
+  attach_function :tidyParseString, [:pointer, :string], :int
+
+  attach_function :tidySaveBuffer, [:pointer, :pointer], :int
+
+  attach_function :tidySetErrorBuffer, [:pointer, :pointer], :int
+
+  attach_function :tidyBufFree, [:pointer], :void
+
+  attach_function :tidyGetOptionByName, [:pointer, :string], :pointer
+  attach_function :tidyOptGetId, [:pointer], :int
+  attach_function :tidyOptSetValue, [:pointer, :int, :string], :int
+end
+
+class TidyFFI::LibTidy::TidyBuf < FFI::Struct #:nodoc:
+  layout :bp, :string,
+         :size, :uint,
+         :allocated, :uint,
+         :next, :uint
+end
+
+class TidyFFI::LibTidy::TidyBufWithAllocator < FFI::Struct #:nodoc:
+  layout :allocator, :pointer,
+         :bp, :string,
+         :size, :uint,
+         :allocated, :uint,
+         :next, :uint
+end
+

data/lib/tidy_ffi/options_container.rb

@@ -0,0 +1,70 @@
+class TidyFFI::OptionsContainer #:nodoc:
+  def initialize(ops = nil)
+    if ops
+      @options = ops.to_hash!
+    else
+      @options = {}
+    end
+  end
+
+  def to_hash!
+    @options.dup
+  end
+
+  def merge_with_options(options)
+    options.each do |key, val|
+      key = key.intern unless Symbol === key
+      @options[key] = val
+    end
+  end
+
+  def ==(obj)
+    if obj.is_a?(Hash)
+      @options == obj
+    elsif obj.is_a?(OptionsContainer)
+      obj == @options
+    else
+      false
+    end
+  end
+
+  def clear!
+    @options = {}
+    self
+  end
+
+  def method_missing(method, *args)
+    if method.to_s =~ /=$/
+      @options[method.to_s.sub(/=$/, '').intern] = args.first
+    else
+      @options[method]
+    end
+  end
+  
+  class Proxy #:nodoc:
+    attr_reader :options
+
+    define_method :new do |*args|
+      @obj.new(args.first, options.to_hash!.merge(args[1] || {}))
+    end
+
+    def initialize(obj, options1, options2)
+      @obj = obj
+      @options = TidyFFI::OptionsContainer.new(options1)
+      @options.merge_with_options(options2)
+    end
+
+    def with_options(options)
+      Proxy.new(@obj, @options, options)
+    end
+
+    def clear!
+      @options.clear!
+      self
+    end
+
+    def method_missing(meth, *args)
+      @obj.send(meth, *args)
+    end
+  end
+end

data/lib/tidy_ffi/tidy.rb

@@ -0,0 +1,57 @@
+# Clean and simple interface to Tidy
+class TidyFFI::Tidy
+  OptionsContainer = TidyFFI::OptionsContainer
+  # Initialized object. str is a string to tidy, options is ignored for now :)
+  def initialize(str, options = {})
+    @string = str
+    @options = OptionsContainer.new(self.class.default_options)
+    self.options = options
+  end
+
+  # Returns cleaned string
+  def clean
+    @clean ||= TidyFFI::Interface.with_doc do |doc|
+      doc.apply_options(@options.to_hash!)
+      doc.string = @string
+      doc.clean
+      doc.output
+    end
+  end
+
+  # Assigns options for tidy.
+  # It merges options, not deletes old ones.
+  #   tidy.options= {:wrap_asp => true}
+  #   tidy.options= {:show_body_only => true}
+  # Will send to tidy both options.
+  def options=(options)
+    @options.merge_with_options(options)
+  end
+
+  # Proxy for options. Supports set and get
+  #
+  #   tidy.options.show_body_only #=> nil
+  #   tidy.options.show_body_only = true
+  #   tidy.options.show_body_only #=> true
+  def options
+    @options
+  end
+
+  class <<self
+    # Default options for tidy. Works just like options method
+    def default_options
+      @default_options ||= OptionsContainer.new
+    end
+
+    # Default options for tidy. Works just like options= method
+    def default_options=(options)
+      @default_options.merge_with_options(options)
+    end
+
+    # Returns a proxy class with options.
+    # Example:
+    #   TidyFFI::Tidy.with_options(:show_body_only => true).with_options(:wrap_asp => true).new('test)
+    def with_options(options)
+      OptionsContainer::Proxy.new(self, @default_options, options)
+    end
+  end
+end

data/lib/tidy_ffi/tidy_ffi_extensions.rb

@@ -0,0 +1,26 @@
+module TidyFFI::TidyFFIExtensions #:nodoc:
+  # Sets path to libtidy.{dylib,so}
+  def library_path=(path)
+    @libtidy_path = path
+  end
+
+  # Returns path to libtidy.{dylib,so}
+  def library_path
+    @libtidy_path ||= find_tidy
+  end
+
+  def find_tidy
+    fnames = ['libtidy.dylib', 'libtidy.so']
+    pathes = []
+    pathes += ENV['LD_LIBRARY_PATH'].split(':') if ENV['LD_LIBRARY_PATH']
+    pathes += ENV['DYLD_LIBRARY_PATH'].split(':') if ENV['DYLD_LIBRARY_PATH']
+    pathes += ENV['PATH'].split(':').reject { |a| a['sbin'] }.map { |a| a.sub('/bin', '/lib') } if ENV['PATH']
+    pathes = ['/usr/lib', '/usr/local/lib'] if pathes.size == 0
+    for path in pathes.uniq
+      fnames.each { |fname| return File.join(path, fname) if File.exists?(File.join(path, fname)) }
+    end
+    nil
+  end
+  private :find_tidy
+end
+TidyFFI.extend TidyFFI::TidyFFIExtensions

data/lib/tidy_ffi.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'ffi'
+
+module TidyFFI
+  self.autoload :LibTidy, 'tidy_ffi/lib_tidy'
+  self.autoload :Interface, 'tidy_ffi/interface'
+end
+
+require 'tidy_ffi/options_container'
+require 'tidy_ffi/tidy'
+require 'tidy_ffi/tidy_ffi_extensions'

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+
+require 'tidy_ffi'
+
+require 'rubygems'
+require 'rr'
+require 'matchy'
+require 'context'
+
+class Test::Unit::TestCase
+  alias method_name name unless instance_methods.include?('method_name')
+end

data/test/test_options.rb

@@ -0,0 +1,123 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class TestOptions < Test::Unit::TestCase
+  T = TidyFFI::Tidy
+  context "public interface" do
+    [:default_options, :default_options=, :with_options].each do |method|
+      it "responds to #{method}" do
+        T.respond_to?(method)
+      end
+    end
+  end
+
+  context "default_options method" do
+    before :each do
+      T.default_options.clear!
+    end
+
+    context "equals version" do
+      it "passes arguments to default_options.merge_with_options" do
+        T.default_options.expects(:merge_with_options)
+        T.default_options = {:test => 1, :test2 => 2}
+      end
+
+      it "merges options with existing" do
+        T.default_options = {:test => 1, :test2 => 2}
+        T.default_options = {:test3 => 3, :test2 => 42}
+        T.default_options.should == {:test => 1, :test2 => 42, :test3 => 3}
+      end
+    end
+
+    it "has clear! method to clear anything" do
+      T.default_options.test = 1
+      T.default_options.clear!
+      T.default_options.test.should == nil
+    end
+
+    it "saves options" do
+      T.default_options.option = 1
+      T.default_options.option.should == 1
+    end
+    
+    it "sets optons after creation" do
+      T.new('test').options.option.should == nil
+      T.default_options.option = 1
+      T.new('test').options.option.should == 1
+    end
+  end
+
+  context "options method" do
+    before :each do
+      T.default_options.clear!
+      @t = T.new('test')
+    end
+
+    context "equal version" do
+      before :each do
+        @t.options.clear!
+      end
+
+      it "passes arguments to options.merge_with_options" do
+        @t.options.expects(:merge_with_options)
+        @t.options = {:test => 1, :test2 => 2}
+      end
+
+      it "merges options with existing" do
+        @t.options = {:test => 1, :test2 => 2}
+        @t.options = {:test3 => 3, :test2 => 42}
+        @t.options.should == {:test => 1, :test2 => 42, :test3 => 3}
+      end
+    end
+    
+    context "clear! method" do
+      it "clears options' options" do
+        @t.options.test = 1
+        @t.options.clear!
+        @t.options.test.should == nil
+      end
+
+      it "clears default_options's options" do
+        T.default_options.test = 1
+        @t = T.new('test')
+        @t.options.clear!
+        @t.options.test.should == nil
+      end
+
+      it "clears with_options's options" do
+        @t = T.with_options(:test => 1).new('test')
+        @t.options.clear!
+        @t.options.test.should == nil
+      end
+    end
+    
+    it "saves options" do
+      @t.options.option = 1
+      @t.options.option.should == 1
+    end
+    
+    it "passes options to libtidy" do
+      @t.options.show_body_only = 1
+      @t.clean.should == "test\n"
+    end
+  end
+
+  context "with_options proxy class" do
+    it "has options method" do
+      T.with_options(:test => 1).options.test.should == 1
+    end
+    
+    it "has clear! method" do
+      T.with_options(:test => 1).clear!.options.test.should == nil
+    end
+    
+    it "chain methods" do
+      proxy = T.with_options(:test => 1).with_options(:test2 => 2)
+      proxy.options.test.should == 1
+      proxy.options.test2.should == 2
+    end
+    
+    it "passes options to object" do
+      T.with_options(:test => 1).new('test').options.test.should == 1
+    end
+  end
+end

data/test/test_simple.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class TestSimple < Test::Unit::TestCase
+  T = TidyFFI::Tidy
+  context "TidyFFI::Tidy" do
+    context "public interface" do
+      [[:initialize, -2],
+       [:clean, 0]].each do |method, arity|
+         it "method #{method} has arity #{arity}" do
+           T.instance_method(method).arity.should == arity
+         end
+       end
+    end
+    
+    context "simple cleanup" do
+      it "clean up text" do
+        T.new("test").clean.should =~ %r{<body>\s+test\s+</body>}
+        T.new("test").clean.should =~ %r{<meta name="generator" content=.+?Tidy.+?>}m
+      end
+    end
+  end
+end

data/tidy_ffi.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tidy_ffi}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eugene Pimenov"]
+  s.date = %q{2009-02-15}
+  s.description = %q{Tidy library interface via FFI}
+  s.email = %q{}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/tidy_ffi/interface.rb", "lib/tidy_ffi/lib_tidy.rb", "lib/tidy_ffi/options_container.rb", "lib/tidy_ffi/tidy.rb", "lib/tidy_ffi/tidy_ffi_extensions.rb", "lib/tidy_ffi.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "lib/tidy_ffi/interface.rb", "lib/tidy_ffi/lib_tidy.rb", "lib/tidy_ffi/options_container.rb", "lib/tidy_ffi/tidy.rb", "lib/tidy_ffi/tidy_ffi_extensions.rb", "lib/tidy_ffi.rb", "test/test_helper.rb", "test/test_options.rb", "test/test_simple.rb", "tidy_ffi.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/libc/tidy_ffi}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Tidy_ffi", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{tidy-ffi}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Tidy library interface via FFI}
+  s.test_files = ["test/test_helper.rb", "test/test_options.rb", "test/test_simple.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, [">= 0", "= 0.2.0"])
+    else
+      s.add_dependency(%q<ffi>, [">= 0", "= 0.2.0"])
+    end
+  else
+    s.add_dependency(%q<ffi>, [">= 0", "= 0.2.0"])
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: tidy_ffi
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Eugene Pimenov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-15 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+description: Tidy library interface via FFI
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README
+- lib/tidy_ffi/interface.rb
+- lib/tidy_ffi/lib_tidy.rb
+- lib/tidy_ffi/options_container.rb
+- lib/tidy_ffi/tidy.rb
+- lib/tidy_ffi/tidy_ffi_extensions.rb
+- lib/tidy_ffi.rb
+files: 
+- CHANGELOG
+- LICENSE
+- Manifest
+- README
+- Rakefile
+- lib/tidy_ffi/interface.rb
+- lib/tidy_ffi/lib_tidy.rb
+- lib/tidy_ffi/options_container.rb
+- lib/tidy_ffi/tidy.rb
+- lib/tidy_ffi/tidy_ffi_extensions.rb
+- lib/tidy_ffi.rb
+- test/test_helper.rb
+- test/test_options.rb
+- test/test_simple.rb
+- tidy_ffi.gemspec
+has_rdoc: true
+homepage: http://github.com/libc/tidy_ffi
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Tidy_ffi
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: tidy-ffi
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Tidy library interface via FFI
+test_files: 
+- test/test_helper.rb
+- test/test_options.rb
+- test/test_simple.rb