tidy_ffi 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,4 @@
+v0.0.4. Options validation
 v0.0.3. Add method “errors” to return errors after cleanup
 v0.0.2. Do not require matchy, rr and context as development dependencies. A user does not need them.
 v0.0.1. Options support.

data/lib/tidy_ffi/interface.rb

@@ -84,4 +84,108 @@ class TidyFFI::Interface
     end
   end
   private :tidy_buf_object
+
+  class <<self
+    # Returns enumeration for opt.
+    #
+    # Some tidy options might try to trespass as integer, and in order to caught
+    # perpertraitors we need to call tidyOptGetPickList
+    def pic_list_for(opt)
+      iterator = LibTidy.tidyOptGetPickList(opt)
+
+      return nil if iterator.null?
+
+      pic_list = []
+
+      MemoryPointer.new(:pointer) do |pointer|
+        pointer.put_pointer(0, iterator)
+        until iterator.null?
+          pic_list << LibTidy.tidyOptGetNextPick(opt, pointer)
+          iterator = pointer.get_pointer(0)
+        end
+      end
+
+      pic_list
+    end
+    private :pic_list_for
+    
+    # Loads default options.
+    def load_default_options
+      return if @default_options
+
+      doc = LibTidy.tidyCreate
+      iterator = LibTidy.tidyGetOptionList(doc)
+
+      @default_options = {}
+
+      MemoryPointer.new(:pointer) 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 pic_list = pic_list_for(opt)
+              option[:type] = :enum
+              option[:values] = pic_list
+              pic_list[LibTidy.tidyOptGetDefaultInt(opt)]
+            else
+              LibTidy.tidyOptGetDefaultInt(opt)
+            end
+          when :boolean
+            LibTidy.tidyOptGetDefaultBool(opt) != 0
+          end
+
+          @default_options[option[:name]] = option
+
+          iterator = pointer.get_pointer(0)
+        end
+
+        @default_options.freeze
+      end
+    ensure
+      LibTidy.tidyRelease(doc)
+    end
+    private :load_default_options
+  end
+
+  # Returns a hash that represents default options for tidy. 
+  # Key for hash is the option name, value is also a hash...
+  # Possible values are:
+  # * :type - either :string, :integer, :boolean or :enum
+  # * :readonly?
+  # * :default - default value of an option
+  # * :values - possible values for :enum
+  # * :name
+  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]
+    
+    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)
+    when :integer
+      Integer === value || !!(value =~ /^\d+$/)
+    when :enum
+      if Integer === value
+        !!spec[:values][value]
+      else
+        spec[:values].include?(value)
+      end
+    when :string
+      String === value || Symbol === value
+    end
+  end
 end

data/lib/tidy_ffi/lib_tidy.rb

@@ -24,6 +24,30 @@ class TidyFFI::LibTidy #:nodoc:
   attach_function :tidyGetOptionByName, [:pointer, :string], :pointer
   attach_function :tidyOptGetId, [:pointer], :int
   attach_function :tidyOptSetValue, [:pointer, :int, :string], :int
+
+  # iterators
+  attach_function :tidyGetOptionList, [:pointer], :pointer
+  attach_function :tidyGetNextOption, [:pointer, :pointer], :pointer
+  attach_function :tidyOptGetName, [:pointer], :string
+  attach_function :tidyOptGetType, [:pointer], :int
+  attach_function :tidyOptGetDefault, [:pointer], :string
+  attach_function :tidyOptGetDefaultInt, [:pointer], :ulong
+  attach_function :tidyOptGetDefaultBool, [:pointer], :int
+  attach_function :tidyOptIsReadOnly, [:pointer], :int
+  attach_function :tidyOptGetPickList, [:pointer], :pointer
+  attach_function :tidyOptGetNextPick, [:pointer, :pointer], :string
+  
+  #types
+  # /** Option data types
+  # */
+  # typedef enum
+  # {
+  #   TidyString,          /**< String */
+  #   TidyInteger,         /**< Integer or enumeration */
+  #   TidyBoolean          /**< Boolean flag */
+  # } TidyOptionType;
+  TIDY_OPTION_TYPE = [:string, :integer, :boolean].freeze
+  
 end
 
 class TidyFFI::LibTidy::TidyBuf < FFI::Struct #:nodoc:

data/lib/tidy_ffi/options_container.rb

@@ -1,4 +1,5 @@
 class TidyFFI::OptionsContainer #:nodoc:
+  
   def initialize(ops = nil)
     if ops
       @options = ops.to_hash!
@@ -14,6 +15,7 @@ class TidyFFI::OptionsContainer #:nodoc:
   def merge_with_options(options)
     options.each do |key, val|
       key = key.intern unless Symbol === key
+      validate_option(key, val)
       @options[key] = val
     end
   end
@@ -35,12 +37,26 @@ class TidyFFI::OptionsContainer #:nodoc:
 
   def method_missing(method, *args)
     if method.to_s =~ /=$/
-      @options[method.to_s.sub(/=$/, '').intern] = args.first
+      key, val = method.to_s.sub(/=$/, '').intern, args.first
+      validate_option(key, val)
+      @options[key] = val
     else
       @options[method]
     end
   end
-  
+
+  # 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
+    end
+  end
+
   class Proxy #:nodoc:
     attr_reader :options
 

data/lib/tidy_ffi/tidy.rb

@@ -1,6 +1,8 @@
 # Clean and simple interface to Tidy
 class TidyFFI::Tidy
   OptionsContainer = TidyFFI::OptionsContainer
+  class InvalidOptionName < ArgumentError; end
+  class InvalidOptionValue < ArgumentError; end
 
   #Initializing object.
   #
@@ -66,5 +68,11 @@ class TidyFFI::Tidy
     def with_options(options)
       OptionsContainer::Proxy.new(self, @default_options, options)
     end
+
+    # When true it validates name and option type (default is true).
+    def validate_options?
+      @validate_options != false
+    end
+    attr_writer :validate_options
   end
 end

data/test/test_helper.rb

@@ -9,4 +9,5 @@ require 'context'
 
 class Test::Unit::TestCase
   alias method_name name unless instance_methods.include?('method_name')
+  include RR::Adapters::TestUnit unless instance_methods.include?('stub')
 end

data/test/test_lowlevel.rb

@@ -0,0 +1,86 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class TestSimple < Test::Unit::TestCase
+  I = TidyFFI::Interface
+  context "TidyFFI::Interface" do
+    context "default_options" do
+      it "returns a hash" do
+        I.default_options.is_a?(Hash)
+      end
+      
+      it "has show force_output option" do
+        I.default_options[:force_output][:name].should == :force_output
+        I.default_options[:force_output][:type].should == :boolean
+      end
+    end
+    
+    context "option_valid" do
+      it "returns false when unknown options is specified" do
+        I.option_valid?(:gobbledygook, '1').should == false
+      end
+
+      it "accepts yes, no, 1, 0, true, false as boolean values" do
+        stub(I).default_options { {:gobbledygook => {:type => :boolean}} }
+
+        %w{yes no 1 0 true false on off YeS}.each do |val|
+          I.option_valid?(:gobbledygook, val).should == true
+        end
+        I.option_valid?(:gobbledygook, 1).should == true
+        I.option_valid?(:gobbledygook, 0).should == true
+        I.option_valid?(:gobbledygook, true).should == true
+        I.option_valid?(:gobbledygook, false).should == true
+
+        I.option_valid?(:gobbledygook, "gobbledygook").should == false
+      end
+
+      it "accepts a number as a valid integer value" do
+        stub(I).default_options { {:gobbledygook => {:type => :integer}} }
+
+        I.option_valid?(:gobbledygook, 1).should == true
+        I.option_valid?(:gobbledygook, 0).should == true
+        I.option_valid?(:gobbledygook, "0").should == true
+        I.option_valid?(:gobbledygook, "1").should == true
+        I.option_valid?(:gobbledygook, "42").should == true
+
+        I.option_valid?(:gobbledygook, "gobbledygook").should == false
+        I.option_valid?(:gobbledygook, "true").should == false
+      end
+
+      it "accepts any string as a valid string value" do
+        stub(I).default_options { {:gobbledygook => {:type => :string}} }
+
+        I.option_valid?(:gobbledygook, 1).should == false
+        I.option_valid?(:gobbledygook, 0).should == false
+
+        I.option_valid?(:gobbledygook, "0").should == true
+        I.option_valid?(:gobbledygook, "1").should == true
+        I.option_valid?(:gobbledygook, "42").should == true
+        I.option_valid?(:gobbledygook, "gobbledygook").should == true
+        I.option_valid?(:gobbledygook, "true").should == true
+        
+      end
+
+      it "accepts a symbols as a valid string value" do
+        stub(I).default_options { {:gobbledygook => {:type => :string}} }
+
+        I.option_valid?(:gobbledygook, :test).should == true
+      end
+
+      it "accepts number in range as a valid enum value" do
+        stub(I).default_options { {:gobbledygook => {:type => :enum, :values => ["one", "two"]}} }
+
+        I.option_valid?(:gobbledygook, 1).should == true
+        I.option_valid?(:gobbledygook, 0).should == true
+        I.option_valid?(:gobbledygook, 3).should == false
+      end
+
+      it "accepts string representation of enum value" do
+        stub(I).default_options { {:gobbledygook => {:type => :enum, :values => ["one", "two"]}} }
+
+        I.option_valid?(:gobbledygook, "one").should == true
+        I.option_valid?(:gobbledygook, "two").should == true
+        I.option_valid?(:gobbledygook, "three").should == false
+      end
+    end
+  end
+end

data/test/test_options.rb

@@ -3,7 +3,7 @@ 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|
+    [:default_options, :default_options=, :with_options, :validate_options].each do |method|
       it "responds to #{method}" do
         T.respond_to?(method)
       end
@@ -13,6 +13,7 @@ class TestOptions < Test::Unit::TestCase
   context "default_options method" do
     before :each do
       T.default_options.clear!
+      T.validate_options = false
     end
 
     context "equals version" do
@@ -38,7 +39,7 @@ class TestOptions < Test::Unit::TestCase
       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
@@ -48,6 +49,7 @@ class TestOptions < Test::Unit::TestCase
 
   context "options method" do
     before :each do
+      T.validate_options = false
       T.default_options.clear!
       @t = T.new('test')
     end
@@ -68,7 +70,7 @@ class TestOptions < Test::Unit::TestCase
         @t.options.should == {:test => 1, :test2 => 42, :test3 => 3}
       end
     end
-    
+
     context "clear! method" do
       it "clears options' options" do
         @t.options.test = 1
@@ -89,12 +91,12 @@ class TestOptions < Test::Unit::TestCase
         @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"
@@ -102,20 +104,24 @@ class TestOptions < Test::Unit::TestCase
   end
 
   context "with_options proxy class" do
+    before :each do
+      T.validate_options = false
+    end
+
     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

data/test/test_simple.rb

@@ -27,5 +27,22 @@ class TestSimple < Test::Unit::TestCase
         t.errors.should == "line 1 column 1 - Warning: missing <!DOCTYPE> declaration\nline 1 column 1 - Warning: plain text isn't allowed in <head> elements\nline 1 column 1 - Warning: inserting missing 'title' element\n"
       end
     end
+
+    # Commented out, because of broken upstream matchy gem :(
+    # context "options validation" do
+    #   it "raises error on invalid option name" do
+    #     TidyFFI::Tidy.validate_options = true
+    #     lambda do
+    #       TidyFFI::Tidy.default_options = {:complete_garbage => true}
+    #     end.should raise_error(TidyFFI::Tidy::InvalidOptionName)
+    #   end
+    # 
+    #   it "raises error on invalid option value" do
+    #     TidyFFI::Tidy.validate_options = true
+    #     lambda do
+    #       TidyFFI::Tidy.default_options = {:force_output => "utter trash"}
+    #     end.should raise_error(TidyFFI::Tidy::InvalidOptionValue)
+    #   end
+    # end
   end
 end

data/tidy_ffi.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tidy_ffi}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eugene Pimenov"]
-  s.date = %q{2009-03-02}
+  s.date = %q{2009-03-14}
   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.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", "test/test_lowlevel.rb"]
   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"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   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"]
+  s.test_files = ["test/test_helper.rb", "test/test_lowlevel.rb", "test/test_options.rb", "test/test_simple.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tidy_ffi
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Eugene Pimenov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-02 00:00:00 +03:00
+date: 2009-03-14 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,5 +90,6 @@ specification_version: 2
 summary: Tidy library interface via FFI
 test_files: 
 - test/test_helper.rb
+- test/test_lowlevel.rb
 - test/test_options.rb
 - test/test_simple.rb