tidy_ffi 0.1.4 → 0.1.5

data/.travis.yml

@@ -0,0 +1,9 @@
+before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install -qq libtidy-dev
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode

data/CHANGELOG

@@ -1,4 +1,5 @@
-v0.1.4. Correct the way libtidy is located on the filesystem. Works if libtidy resides in /usr/lib64, instead of /usr/lib
+v0.1.5. Fix JRuby issues.
+v0.1.4. Fix the way libtidy is located on the filesystem. Works if libtidy is in /usr/lib64, instead of /usr/lib
 v0.1.3. Fix recognition of date on weird environments
 v0.1.2. Initialize buffer before use
 v0.1.1. Fixes for new version of FFI gem

data/README.rdoc

@@ -2,20 +2,20 @@
 
 == What is it all about?
 
-I wanna clean and simple tidy library. For example:
+I wanted to have a clean and simple tidy library. For example:
   TidyFFI::Tidy.new('a string').clean
 
 For now it can't do anything else than clean (and saves errors from it) :)
 
 == Options
 
-You can use different ways to set up options. These examples are produces the same output:
+You can use different ways to specify options. These examples produce 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
@@ -24,8 +24,6 @@ You can use different ways to set up options. These examples are produces the sa
 
   TidyFFI::Tidy.clean('test', :show_body_only => 1)
 
-== Links
+== Other stuff
 
-* Source code: http://github.com/libc/tidy_ffi
-* Bug tracker: http://rubyforge.org/tracker/?atid=30230&group_id=7805&func=browse
-* Rubyforge project: http://rubyforge.org/projects/tidy-ffi
+And of course, it's depenedent on ffi and libtidy. So make sure they're installed before using the library!

data/lib/tidy_ffi/interface.rb

@@ -100,18 +100,19 @@ class TidyFFI::Interface
 
       pick_list = []
 
-      FFI::MemoryPointer.new(:pointer, 1) do |pointer|
-        pointer.put_pointer(0, iterator)
-        until iterator.null?
-          pick_list << LibTidy.tidyOptGetNextPick(opt, pointer)
-          iterator = pointer.get_pointer(0)
-        end
+      pointer = FFI::MemoryPointer.new(:pointer, 1)
+      pointer.put_pointer(0, iterator)
+      until iterator.null?
+        pick_list << LibTidy.tidyOptGetNextPick(opt, pointer)
+        iterator = pointer.get_pointer(0)
       end
 
       pick_list
+    ensure
+      pointer.free if pointer
     end
     private :pick_list_for
-    
+
     # Loads default options.
     def load_default_options
       return if @default_options
@@ -121,40 +122,40 @@ class TidyFFI::Interface
 
       @default_options = {}
 
-      FFI::MemoryPointer.new(:pointer, 1) do |pointer|
-        pointer.put_pointer(0, iterator)
-
-        until iterator.null?
-          opt = LibTidy.tidyGetNextOption(doc, pointer)
-
-          option = {}
-
-          option[:name] = LibTidy.tidyOptGetName(opt).gsub('-', '_').intern
-          option[:readonly?] = LibTidy.tidyOptIsReadOnly(opt) != 0
-          option[:type] = LibTidy::TIDY_OPTION_TYPE[LibTidy.tidyOptGetType(opt)]
-          option[:default] = case option[:type]
-          when :string
-            (LibTidy.tidyOptGetDefault(opt) rescue "")
-          when :integer
-            if pick_list = pick_list_for(opt)
-              option[:type] = :enum
-              option[:values] = pick_list
-              pick_list[LibTidy.tidyOptGetDefaultInt(opt)]
-            else
-              LibTidy.tidyOptGetDefaultInt(opt)
-            end
-          when :boolean
-            LibTidy.tidyOptGetDefaultBool(opt) != 0
+      pointer = FFI::MemoryPointer.new(:pointer, 1)
+      pointer.put_pointer(0, iterator)
+
+      until iterator.null?
+        opt = LibTidy.tidyGetNextOption(doc, pointer)
+
+        option = {}
+
+        option[:name] = LibTidy.tidyOptGetName(opt).gsub('-', '_').intern
+        option[:readonly?] = LibTidy.tidyOptIsReadOnly(opt) != 0
+        option[:type] = LibTidy::TIDY_OPTION_TYPE[LibTidy.tidyOptGetType(opt)]
+        option[:default] = case option[:type]
+        when :string
+          (LibTidy.tidyOptGetDefault(opt) rescue "")
+        when :integer
+          if pick_list = pick_list_for(opt)
+            option[:type] = :enum
+            option[:values] = pick_list
+            pick_list[LibTidy.tidyOptGetDefaultInt(opt)]
+          else
+            LibTidy.tidyOptGetDefaultInt(opt)
           end
-
-          @default_options[option[:name]] = option
-
-          iterator = pointer.get_pointer(0)
+        when :boolean
+          LibTidy.tidyOptGetDefaultBool(opt) != 0
         end
 
+        @default_options[option[:name]] = option
+
+        iterator = pointer.get_pointer(0)
       end
+
       @default_options.freeze
     ensure
+      pointer.free if pointer
       LibTidy.tidyRelease(doc)
     end
     private :load_default_options
@@ -171,11 +172,12 @@ class TidyFFI::Interface
   def self.default_options
     @default_options ||= load_default_options
   end
-  
+
   # Returns true if value is valid for +option+ and false otherwise.
   def self.option_valid?(option, value)
-    return false unless spec = default_options[option]
-    
+    spec = default_options[option]
+    return false unless spec
+
     case spec[:type]
     when :boolean
       true == value || false == value || value == 0 || value == 1 || %w(on off true false 0 1 yes no).include?(value.downcase)
@@ -185,10 +187,10 @@ class TidyFFI::Interface
       if Integer === value
         !!spec[:values][value]
       else
-        spec[:values].include?(value)
+        spec[:values].include?(value.downcase)
       end
     when :string
       String === value || Symbol === value
     end
   end
-end
+end

data/lib/tidy_ffi/lib_tidy.rb

@@ -3,7 +3,14 @@
 # This file must be lazy loaded!
 class TidyFFI::LibTidy #:nodoc:
   extend FFI::Library
-  ffi_lib TidyFFI.library_path
+
+  paths = Array(TidyFFI.library_path || Dir['/{opt,usr}/{,local/}lib{,64}/libtidy{,-*}.{dylib,so*}'])
+  begin
+    ffi_lib(*paths)
+  rescue LoadError
+    raise TidyFFI::LibTidyNotInstalled, "didn't find tidy libs on your system. Please install tidy (http://tidy.sourceforge.net/)"
+  end
+
 
   attach_function :tidyReleaseDate, [], :string
 

data/lib/tidy_ffi/options_container.rb

@@ -48,12 +48,12 @@ class TidyFFI::OptionsContainer #:nodoc:
   # It's a kinda bad method: it uses TidyFFI::Interface.option_valid and TidyFFI::Tidy.validate_options?
   # Also it do second lookup into default options
   def validate_option(key, value)
-    if TidyFFI::Tidy.validate_options? && !TidyFFI::Interface.option_valid?(key, value)
-      if TidyFFI::Interface.default_options[key]
-        raise TidyFFI::Tidy::InvalidOptionValue, "#{value} is not valid for #{key}"
-      else
-        raise TidyFFI::Tidy::InvalidOptionName, "#{key} is invalid option name"
-      end
+    return if !TidyFFI::Tidy.validate_options? || TidyFFI::Interface.option_valid?(key, value)
+
+    if TidyFFI::Interface.default_options[key]
+      raise TidyFFI::Tidy::InvalidOptionValue, "#{value} is not a valid value for key #{key}"
+    else
+      raise TidyFFI::Tidy::InvalidOptionName, "#{key} is an invalid option name"
     end
   end
 
@@ -87,4 +87,4 @@ class TidyFFI::OptionsContainer #:nodoc:
       @obj.send(meth, *args)
     end
   end
-end
+end

data/lib/tidy_ffi/tidy_ffi_extensions.rb

@@ -1,12 +1,5 @@
 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 ||= 'tidy'
-  end
+  # Sets and gets path to libtidy.{dylib,so}
+  attr_accessor :library_path
 end
 TidyFFI.extend TidyFFI::TidyFFIExtensions

data/lib/tidy_ffi/version.rb

@@ -1,3 +1,3 @@
 module TidyFFI
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/simple_spec.rb

@@ -46,8 +46,13 @@ describe TidyFFI::Tidy do
     it "raises error on invalid option value" do
       TidyFFI::Tidy.validate_options = true
       lambda do
-        TidyFFI::Tidy.default_options = {:force_output => "utter trash"}
+        TidyFFI::Tidy.default_options = {:force_output => "utter garbage"}
       end.should raise_error(TidyFFI::Tidy::InvalidOptionValue)
     end
+
+    it 'accepts UTF-8 writter in uppercase' do
+      TidyFFI::Tidy.validate_options = true
+      expect { TidyFFI::Tidy.default_options = {:char_encoding => "UTF8"} }.not_to raise_error
+    end
   end
-end
+end

data/tidy_ffi.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'ffi', ">= 0.3.5"
+  s.add_dependency 'ffi', "~> 1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tidy_ffi
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-13 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70164966260060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70164966260060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: Tidy library interface via FFI
 email: libc@libc.st
 executables: []
@@ -30,6 +35,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -62,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4149357649508067802
+      hash: 3224835435869118634
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -71,10 +77,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4149357649508067802
+      hash: 3224835435869118634
 requirements: []
 rubyforge_project: tidy-ffi
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Tidy library interface via FFI