markup_mechanic 0.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem "rake", "0.8.7"
+  gem "turn"
+  gem "mocha"
+  gem "minitest"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Ryan Heath
+
+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/README.md

@@ -0,0 +1,69 @@
+MarkupMechanic
+==============
+
+Malformed HTML be gone! When you allow users to enter raw HTML into a wide open
+textarea, you're asking for trouble. Missing closing tags and tags closed in the 
+wrong order can really make your layouts go bananas. This little library is an
+attempt to repair those issues. Just leave it to the Markup Mechanic (thanks
+to [Chris Scharf](http://github.com/scharfie) for the name).
+
+# Installation
+
+Just add `gem "markup_mechanic"` to your Gemfile.
+
+Note: this gem is designed to use with Rails projects using ActiveRecord.
+
+# Usage
+
+It's rather simple to use. Once installed, just add one line to your model,
+passing it the columns that you wish to repair.
+
+    class Article < ActiveRecord::Base
+      repair_markup_for :caption, :body
+    end
+
+Each time the record is saved, those columns will run through a parser (or, "mechanic")
+that will repair the invalid HTML.
+
+# Custom Mechanic Adapters
+
+Under the hood, we're really just relying on the amazing Nokogiri library to do
+the dirty work. That's the default. But if you wanted to customize the behavior of
+the mechanic, you can add your own custom adapter.
+
+Two requirements:
+
+1. Your class must be initialized to accept an HTML string
+2. Your class must implement a `fix!` instance method
+
+For example, in your Rails project, let's say in `config/initializers/markup_mechanic.rb`
+you might do something like this:
+
+    class MyAwesomeMechanic
+      attr_reader :html
+
+      def initialize(html)
+        @html = html
+      end
+
+      def fix!
+        # do your fancy work here
+      end
+    end
+
+    MarkupMechanic.configure do |config|
+      config.adapter = MyAwesomeMechanic
+    end
+
+That's really it. Now the `repair_markup_for` method will run those columns through
+your custom parser instead.
+
+# Credits
+
+[Chris Scharf](http://github.com/scharfie) for the name and inspiration to package this up as a gem.
+
+# License
+
+Copyright (c) Ryan Heath
+
+Published under the MIT License, see LICENSE

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/*_test.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/markup_mechanic.rb

@@ -0,0 +1,32 @@
+require 'markup_mechanic/error'
+require 'markup_mechanic/default_adapter'
+require 'markup_mechanic/configuration'
+require 'markup_mechanic/callbacks'
+require 'markup_mechanic/base'
+
+module MarkupMechanic
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    # accepts a list of columns for an ActiveRecord
+    # model and fixes the HTML in a before_save callback
+    def repair_markup_for(*columns)
+      options = columns.extract_options!
+      before_save MarkupMechanic::Callbacks::BeforeSave.new(columns, options)
+    end
+  end
+
+  # mixins
+  extend Base
+  extend Configuration
+
+  # debug mode sends output to the logs
+  def self.debug_mode?
+    self.debug_mode
+  end
+end
+
+# hook into ActiveRecord
+require 'markup_mechanic/active_record'

data/lib/markup_mechanic/active_record.rb

@@ -0,0 +1,4 @@
+# mix the MarkupMechanic in with ActiveRecord
+if defined?(::ActiveRecord::Base)
+  ::ActiveRecord::Base.send(:include, MarkupMechanic)
+end

data/lib/markup_mechanic/base.rb

@@ -0,0 +1,18 @@
+require 'markup_mechanic/version'
+
+module MarkupMechanic
+  module Base
+    def version
+      VERSION
+    end
+
+    # wrapper for logging, highlights the section for easier viewing
+    def log(message)
+      if logger.present? && MarkupMechanic.debug_mode?
+        logger.info("--- Markup Mechanic (v#{MarkupMechanic.version}) ---")
+        logger.info(message)
+        logger.info("----------------------------------------------------")
+      end
+    end
+  end
+end

data/lib/markup_mechanic/callbacks.rb

@@ -0,0 +1,5 @@
+require 'markup_mechanic/callbacks/before_save'
+
+module MarkupMechanic
+  module Callbacks; end
+end

data/lib/markup_mechanic/callbacks/before_save.rb

@@ -0,0 +1,37 @@
+module MarkupMechanic
+  module Callbacks
+    # this is the callback that fires on
+    # before_save of a model that has the
+    # repair_markup_for() call
+    class BeforeSave
+      attr_accessor :columns, :options, :adapter
+
+      def initialize(columns, options)
+        @columns = columns
+        @options = options
+        @adapter = MarkupMechanic.adapter
+      end
+
+      def before_save(record)
+        self.columns.each do |column|          
+          if record.respond_to?(column) && record.respond_to?("#{column}=")
+            MarkupMechanic.log("Repairing #{record.class}::#{column}")
+
+            # register a new mechanic for this column
+            mechanic = self.adapter.new(record.send(column))
+
+            # since custom adapters are supported, we must ensure that the
+            # adapter responds to the `fix!` method, as expected
+            raise MarkupMechanic::InvalidAdapterError unless mechanic.respond_to?(:fix!)
+            
+            # repair the HTML
+            repaired_html = mechanic.fix!
+            
+            # update the record
+            record.send("#{column}=", repaired_html)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/markup_mechanic/configuration.rb

@@ -0,0 +1,23 @@
+module MarkupMechanic
+  module Configuration
+    attr_accessor :adapter, :logger, :debug_mode
+
+    # set the defaults when the
+    # Configuration module is extended
+    def self.extended(base)
+      base.reset!
+    end
+
+    # convenience method for configuration
+    def configure
+      yield self
+    end
+
+    # resets the options to the defaults
+    def reset!
+      self.adapter = MarkupMechanic::DefaultAdapter
+      self.logger = Rails.logger
+      self.debug_mode = Rails.env.development?
+    end
+  end
+end

data/lib/markup_mechanic/default_adapter.rb

@@ -0,0 +1,16 @@
+module MarkupMechanic
+  class DefaultAdapter
+    attr_reader :html
+
+    def initialize(html)
+      @html = html.to_s
+    end
+
+    # use the magic that is Nokogiri to parse
+    # and fix the HTML fragment
+    def fix!
+      fragment = Nokogiri::HTML.fragment(self.html)
+      fragment.to_html
+    end
+  end
+end

data/lib/markup_mechanic/error.rb

@@ -0,0 +1,12 @@
+module MarkupMechanic
+  class Error < StandardError; end
+
+  # raised if the adapter isntance doesn't accept
+  # an HTML string on initialization or there's
+  # no `fix!` method on the object
+  class InvalidAdapterError < Error
+    def initialize(message = "needs initialized with a string of HTML, and must respond to a fix! method")
+      super(message)
+    end
+  end
+end

data/lib/markup_mechanic/version.rb

@@ -0,0 +1,3 @@
+module MarkupMechanic
+  VERSION = "0.1.0"
+end

data/markup_mechanic.gemspec

@@ -0,0 +1,47 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = "1.3.5"
+
+  s.name = "markup_mechanic"
+  s.version = "0.1.0"
+  s.date = "2013-06-05"
+  s.rubyforge_project = "markup_mechanic"
+
+  s.summary = "Repairs invalid HTML markup"
+  s.description = "For use in Rails projects that will correct invalid HTML entered by users"
+
+  s.authors  = ["Ryan Heath"]
+  s.email    = "ryan@rpheath.com"
+  s.homepage = "http://github.com/rpheath/markup_mechanic"
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency("nokogiri", ["~> 1.5"])
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    lib/markup_mechanic.rb
+    lib/markup_mechanic/active_record.rb
+    lib/markup_mechanic/base.rb
+    lib/markup_mechanic/callbacks.rb
+    lib/markup_mechanic/callbacks/before_save.rb
+    lib/markup_mechanic/configuration.rb
+    lib/markup_mechanic/default_adapter.rb
+    lib/markup_mechanic/error.rb
+    lib/markup_mechanic/version.rb
+    markup_mechanic.gemspec
+    test/markup_mechanic_test.rb
+    test/test_helper.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test\.rb/ }
+end

data/test/markup_mechanic_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class MarkupMechanicTest < Test::Unit::TestCase
+  def setup
+    # ...
+  end
+
+  test "should be true" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "test/unit"
+require "mocha/setup"
+require "turn"
+
+Test::Unit::TestCase.class_eval do
+  def self.test(name, &block)
+    define_method("test_#{name.to_s.gsub(/\W/,'_')}", &block) if block_given?
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: markup_mechanic
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Heath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  version_requirements: *id001
+  name: nokogiri
+  prerelease: false
+  type: :runtime
+description: For use in Rails projects that will correct invalid HTML entered by users
+email: ryan@rpheath.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/markup_mechanic.rb
+- lib/markup_mechanic/active_record.rb
+- lib/markup_mechanic/base.rb
+- lib/markup_mechanic/callbacks.rb
+- lib/markup_mechanic/callbacks/before_save.rb
+- lib/markup_mechanic/configuration.rb
+- lib/markup_mechanic/default_adapter.rb
+- lib/markup_mechanic/error.rb
+- lib/markup_mechanic/version.rb
+- markup_mechanic.gemspec
+- test/markup_mechanic_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rpheath/markup_mechanic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: markup_mechanic
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 2
+summary: Repairs invalid HTML markup
+test_files: 
+- test/markup_mechanic_test.rb