RubyGems - devfu-simple-tidy - Versions diffs - 0.1.0 - Mend

devfu-simple-tidy 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

data/README.rdoc ADDED Viewed

@@ -0,0 +1,27 @@
+= SimpleTidy
+I've had a lot of trouble with the http://rubyforge.org/projects/tidy/ project (which uses libtidy-ruby),
+getting segfaults and whatnot.  So ... I decided to make super simple wrapper around the <b>tidy</b>
+command line app (instead of the C library).
+== Installation
+  $ sudo gem install devfu-simple-tidy --source http://gems.github.com
+== Usage
+  require 'simple-tidy'
+  >> puts SimpleTidy.clean '<html>foo</html>', :indent_spaces => 2
+  <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
+  <html>
+  <head>
+    <title></title>
+  </head>
+  <body>
+    foo
+  </body>
+  </html>
+  => nil

data/Rakefile ADDED Viewed

@@ -0,0 +1,68 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+puts "\nGem: simple-tidy\n\n"
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = 'simple-tidy'
+    s.summary     = ''
+    s.email       = 'remi@remitaylor.com'
+    s.homepage    = 'http://github.com/devfu/simple-tidy'
+    s.description = ''
+    s.authors     = %w( remi )
+    s.files       = FileList['[A-Z]*', '{lib,spec,bin,examples}/**/*']
+    # s.add_dependency 'person-gemname'
+    # s.executables << 'script'
+    # s.rubyforge_project = 'gemname'
+    # s.extra_rdoc_files = %w( README.rdoc )
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+# require 'hanna'
+# require 'darkfish-rdoc'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'simple-tidy'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  # rdoc.options += ["--template=#{`allison --path`}"]  # sudo gem install allison
+  # rdoc.options += %w( -f darkfish )                   # sudo gem install darkfish-rdoc
+  # rdoc.options += %w( -T hanna )                      # sudo gem install mislav-hanna
+  rdoc.options += %w( -m README.rdoc ) # the initial page displayed
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('simple-tidy.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+task :default => :spec

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.1.0

data/lib/simple-tidy.rb ADDED Viewed

@@ -0,0 +1,60 @@
+require 'open3'
+class SimpleTidy
+  DEFAULT_OPTIONS = { :tidy_mark => false }
+  OPTIONS_WITHOUT_VALUES = [ :indent ]
+  SINGLE_DASH_OPTIONS = [ :indent ]
+  def initialize options = nil
+    @tidy_options = DEFAULT_OPTIONS.merge(options || {})
+  end
+  def warnings
+    @warnings || []
+  end
+  def clean html
+     @output, @warnings = get_output_and_warnings html
+     @output
+  end
+  def self.clean html, options = nil
+    SimpleTidy.new(options).clean html
+  end
+private
+  def get_output_and_warnings html
+    stdin, stdout, stderr = Open3.popen3 "echo '#{ html }' | tidy #{ tidy_options_text }"
+    output   = stdout.read.strip
+    warnings = stderr.read.split("\n").select {|line| line =~ /line \d+ column \d+ - Warning:/ }
+    return output, warnings
+  end
+  def tidy_options
+    # check options for dependencies (some options require other options to be set)
+    if @tidy_options.keys.include? :indent_spaces and ! @tidy_options[:indent] == true
+      @tidy_options[:indent] = true
+    end
+    @tidy_options
+  end
+  def tidy_options_text
+    tidy_options.map {|key, value|
+      option = dashes_for_option key
+      option << key.to_s.gsub('_', '-')
+      option << " #{ value.to_s.gsub('_', '-') }" unless OPTIONS_WITHOUT_VALUES.include?(key)
+      option
+    }.join(' ')
+  end
+  def dashes_for_option option
+    SINGLE_DASH_OPTIONS.include?(option) ? '-' : '--'
+  end
+end

data/spec/simple-tidy_spec.rb ADDED Viewed

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper'
+describe SimpleTidy do
+  it 'should be able to easily tidy html (without any options)' do
+    html = '<html>foo</html>'
+    SimpleTidy.new.clean(html).should ==
+      "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 3.2//EN\">\n" +
+      "<html>\n<head>\n<title></title>\n</head>\n<body>\nfoo\n</body>\n</html>"
+  end
+  it 'should have a shortcut to tidy html without creating a SimpleTidy instance' do
+    html = '<html>foo</html>'
+    SimpleTidy.clean(html).should == SimpleTidy.new.clean(html)
+  end
+  it 'should be able to pass options to shortcut'
+  it 'should be able to get warnings' do
+    html = '<html>foo</html>'
+    tidy = SimpleTidy.new
+    tidy.warnings.should be_empty
+    tidy.clean html
+    tidy.warnings.length.should == 4
+    tidy.warnings.should include('line 1 column 1 - Warning: missing <!DOCTYPE> declaration')
+    tidy.warnings.should include("line 1 column 7 - Warning: inserting missing 'title' element")
+  end
+  # it 'should be able to get errors'
+  # it 'should be able to get diagnostics ... aka info? ... aka debug?'
+  it 'should be able to set the indent option' do
+    html = '<html>foo</html>'
+    SimpleTidy.new( :indent_spaces => 2 ).clean(html).should ==
+      "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 3.2//EN\">\n\n" +
+      "<html>\n<head>\n  <title></title>\n</head>\n\n<body>\n  foo\n</body>\n</html>"
+    SimpleTidy.clean( html, :indent_spaces => 2 ).should == SimpleTidy.new( :indent_spaces => 2 ).clean(html)
+  end
+end

data/spec/spec.opts ADDED Viewed

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/simple-tidy'

metadata ADDED Viewed

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: devfu-simple-tidy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- remi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-08-17 00:00:00 -07:00
+default_executable:
+dependencies: []
+description: ""
+email: remi@remitaylor.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/simple-tidy.rb
+- spec/simple-tidy_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/devfu/simple-tidy
+licenses:
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+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: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: ""
+test_files:
+- spec/simple-tidy_spec.rb
+- spec/spec_helper.rb