RubyGems - glam - Versions diffs - 0.0.1 - Mend

glam 0.0.1

Files changed (12) hide show

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebfb766d24926bb7ae2327e74fe4aa4c28cba6ed
+  data.tar.gz: 3f90158c080e4ff95ac0d365443455d2fdf377a6
+SHA512:
+  metadata.gz: 4e72d8918cb66f7f1d014dc027505b066ee53150e5f09b6421600baadbcec5e43aeb6cbf9881cf97ede2dcdf371bfb2ea80b8c78b49175504f000e2184a72e7a
+  data.tar.gz: db70c41eba8cd202ba60eadb6e2a72028ab2af932f4a4dc3ef0947820fa24af1fc942645b27fc18e70fec683113d78ce564f5cf636b51dcffbc006e386eeb258

data/.gitignore ADDED

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in glam.gemspec
+gemspec

data/LICENSE.txt ADDED

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Barry
+MIT License
+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 ADDED

@@ -0,0 +1,69 @@
+# Glam
+Make your HTML look glamorous! Glam takes well-formed but possibly dubiously formatted HTML and outputs it as pretty printed HTML 5.
+## Installation
+Add this line to your application's Gemfile:
+    gem 'glam'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install glam
+## Usage
+Glam can be used as a command-line tool. For example, if you have an HTML file like this:
+**example.html**
+``` html
+<html><head><title>Example</title></head><body><h1>Example</h1></body></html>
+```
+You can glamorize it like this:
+    $ glam example.html
+Which outputs:
+``` html
+<!doctype html>
+<html>
+  <head>
+    <title>
+      Example
+    </title>
+  </head>
+  <body>
+    <h1>
+      Example
+    </h1>
+  </body>
+</html>
+```
+You can also produce the same output by piping HTML into `glam`:
+    $ cat example.html | glam
+You can also use Glam from ruby code:
+``` ruby
+require 'glam'
+puts Glam(File.read('example.html'))
+```
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile ADDED

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

data/bin/glam ADDED

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'glam/cli'
+Glam::CLI.run

data/glam.gemspec ADDED

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name          = "glam"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Paul Barry"]
+  spec.email         = ["mail@paulbarry.com"]
+  spec.description   = %q{An HTML pretty printer}
+  spec.summary       = %q{Make your HTML look glamorous!}
+  spec.homepage      = "http://github.com/pjb3/glam"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/glam.rb ADDED

@@ -0,0 +1,15 @@
+require 'glam/glamorizer'
+module Glam
+  VERSION = '0.0.1'
+end
+# Pretty-print the HTML
+# @param html [String] The HTML to be pretty-printed
+# @param opts [Hash] The options
+# @option opts [Integer] :indent_size
+#   How many spaces should be used for each level of indentation
+# @return [String] The pretty-printed HTML
+def Glam(html, opts={})
+  Glam.glamorize(html, opts={})
+end

data/lib/glam/cli.rb ADDED

@@ -0,0 +1,38 @@
+require 'optparse'
+require 'glam'
+module Glam
+  class CLI
+    def self.run
+      new.run
+    end
+    def initialize
+      @options = {
+        indent_size: 2,
+      }
+    end
+    def run
+      @parser = OptionParser.new do |o|
+        o.on "-i", "--indent [INDENT]", Integer do |indent_size|
+          @options[:indent_size] = indent_size
+        end
+      end
+      @parser.banner = "glam [options] file"
+      @parser.on_tail "-h", "--help", "Show help" do
+        $stderr.puts @parser
+        exit 1
+      end
+      @parser.parse!
+      glam = Glam::Glamorizer.new(@options)
+      puts glam.glamorize(ARGV[0] ? File.read(ARGV[0]) : STDIN.read)
+    end
+  end
+end

data/lib/glam/glamorizer.rb ADDED

@@ -0,0 +1,74 @@
+require "nokogiri"
+require "set"
+module Glam
+  class Glamorizer
+    VOID_ELEMENTS = Set.new(%w[area base br col embed hr img input keygen link meta param source track wbr])
+    attr_accessor :indent_size, :indent_char, :current_indent
+    # @param opts [Hash] The options
+    # @option opts [Integer] :indent_size
+    #   How many spaces should be used for each level of indentation
+    def initialize(opts={})
+      self.indent_size = 2
+      self.indent_char = ' '
+      self.current_indent = 0
+      if opts
+        opts.each do |k,v|
+          send("#{k}=", v)
+        end
+      end
+    end
+    # Pretty-print the HTML
+    # @param html [String] The HTML to be pretty-printed
+    # @return [String] The pretty-printed HTML
+    def glamorize(html)
+      node = if html.is_a?(Nokogiri::XML::Node)
+        result = ''
+        html
+      else
+        result = "<!doctype html>\n"
+        Nokogiri::HTML(html).root
+      end
+      result << indented_node_with_attributes(node)
+      self.current_indent += 1
+      node.children.each do |child_node|
+        if child_node.text?
+          unless child_node.blank?
+            result << "#{indent}#{child_node.content.strip}\n"
+          end
+        elsif VOID_ELEMENTS.include?(child_node.name)
+          result << indented_node_with_attributes(child_node)
+        else
+          result << glamorize(child_node)
+        end
+      end
+      self.current_indent -= 1
+      result << "#{indent}</#{node.name}>\n"
+    end
+    private
+    def indent
+      indent_char * (indent_size * current_indent)
+    end
+    def indented_node_with_attributes(node)
+      "#{indent}<#{node.name}#{node.attributes.map{|n,v| %{ #{n}="#{v}"}}.join}>\n"
+    end
+  end
+  # Pretty-print the HTML
+  # @param html [String] The HTML to be pretty-printed
+  # @param opts [Hash] The options
+  # @option opts [Integer] :indent_size
+  #   How many spaces should be used for each level of indentation
+  # @return [String] The pretty-printed HTML
+  def self.glamorize(html, opts={})
+    Glamorizer.new(opts).glamorize(html)
+  end
+end

metadata ADDED

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: glam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Barry
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An HTML pretty printer
+email:
+- mail@paulbarry.com
+executables:
+- glam
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/glam
+- glam.gemspec
+- lib/glam.rb
+- lib/glam/cli.rb
+- lib/glam/glamorizer.rb
+homepage: http://github.com/pjb3/glam
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.0.14
+signing_key:
+specification_version: 4
+summary: Make your HTML look glamorous!
+test_files: []
+has_rdoc: