guileless 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTk5NzVjNzdhY2JhMGVlNGQzYjY3OWQyYjdiY2VjNTJhM2Y5YTI0NQ==
-  data.tar.gz: !binary |-
-    YTcxMzkzNGIwODYxZTkzZWRiMDdkY2Q4ZTY3NWMwYTZiMjY5MjFjOQ==
+SHA1:
+  metadata.gz: d117a31360e13a08ef5a01518c0240018b891c35
+  data.tar.gz: da16fe450906543184362d9978800917dc3b1107
 SHA512:
-  metadata.gz: !binary |-
-    MTY5N2UwYzg3YTQ0Yzk4OGJlMDQwZWQ1ZGM3NGY4YjE1MjBjNTRhZDBiODM3
-    YmIwMWI1MzY4ZGRkMDE5ZDE4ZTQwNDgwYWFlZDFiMTVlZThiZTk1ODhjOTUw
-    NTdkZmJlMjY4MTJhMDE5NjdkYTM0MzExZTVhMGEzZWMyNTQzNDQ=
-  data.tar.gz: !binary |-
-    YzgwYWY1ZWY2M2U2OTBmYTkyNTI5NTUwMzk0MDAwMTNmM2Q2ZDViOThjNDlj
-    YTU3YjNiYWJiODAxNjk5ZjBhZDVhZjg1NjgxMDhjZjAxYmQ5MDZkZjVlN2Q4
-    NDIxYmRmMTY3MjIyZjVmZWIxN2RiMGQwYmRmZDQwMDg5ODA3Nzk=
+  metadata.gz: 6a978d321323f4eaec09533839e064c832a2ffb83c11dd173d138b7e839c7124f4d62621054595678a7171cd594a2a8e7373496c12f3f7eae0ff5a800b55c56b
+  data.tar.gz: bd494836464020a0af2eec465ee62fe80a93568872f16ceb0f48622ed5a904f1ce9bc827c4911a73f81073c4b2c40eb04fd7caad3bc3beaf6267aba53aa05257

data/Gemfile.lock

@@ -1,4 +1,5 @@
 GEM
+  remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.4)
     rspec (2.14.1)

data/README.md

@@ -4,14 +4,26 @@ Guileless is a naive HTML preprocessor. It does three things:
 
 1. Single line breaks are converted to `<br>`
 2. Several consecutive line breaks are treated as paragraphs and wrapped in `<p>`
-3. Converts stray `<`, `>`, and `&`s to HTML entities.
+3. Converts stray `<`, `>`, and `&`s to character entities.
 
 Why is this more useful than, say, Rails' built in `simple_format`?
 
 Well, it's actually a real (if simplistic) HTML parser. It understands nested
 tags, and will happily format text nodes inside `div`s and `blockquote`s.
 
-However, it does **NOT** do any sanitation on the input.
+Valid HTML is assumed, and it doesn't do any sanitation on the input.
+Anything it doesn't need to understand is simply passed through, but
+mismatched or missing opening and closing tags on block level elements will break.
+
+
+
+## Installation
+
+    gem install guileless
+
+or add it to your gemfile:
+
+    gem "guileless"
 
 ## Usage
 
@@ -19,6 +31,11 @@ However, it does **NOT** do any sanitation on the input.
 Guileless.format("<div>foo</div>") # => "<div><p>foo</p></div>"
 ```
 
+## Contributing
+
+&#x266B; Fork it, use it, break it, fix it,
+branch it, push it, pull request it.
+
 ## License
 
 Copyright (c) 2013 Inge Jørgensen

data/guileless.gemspec

@@ -6,12 +6,11 @@ require "guileless/version"
 Gem::Specification.new do |s|
   s.name        = 'guileless'
   s.version     = Guileless::VERSION
-  s.date        = '2013-10-20'
+  s.date        = '2014-05-21'
   s.summary     = "Naive HTML preprocessor"
   s.description = "Naive HTML preprocessor"
   s.authors     = ["Inge Jørgensen"]
   s.email       = 'inge@elektronaut.no'
-  s.files       = ["lib/hola.rb"]
   s.homepage    = 'http://github.com/elektronaut/guileless'
   s.license     = 'MIT'
   s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
@@ -20,5 +19,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-
 end

data/lib/guileless/parse_methods.rb

@@ -1,6 +1,18 @@
 module Guileless
   module ParseMethods
 
+    def escape_ampersand
+      value = stream.peek?(/[\w\d]+;/) ? "&" : "&"
+      @char_count += value.length
+      value
+    end
+
+    def start_tag
+      if stream.peek?(block_level_tags) || stream.peek?(closing(block_level_tags))
+        flush_buffer
+      end
+    end
+
     def parse_attribute_name(char)
       case
       when char !=~ /[\w\-]/
@@ -63,26 +75,19 @@ module Guileless
       end
     end
 
-    def parse_tag_name(char)
+    def parse_tag_name(char, next_state=:tag)
       case
       when char =~ /\w/
         @tag_name += char
         char
       else
         stream.reinject char
-        [false, :tag]
+        [false, next_state]
       end
     end
 
     def parse_closing_tag_name(char)
-      case
-      when char =~ /\w/
-        @tag_name += char
-        char
-      else
-        stream.reinject char
-        [false, :closing_tag]
-      end
+      parse_tag_name(char, :closing_tag)
     end
 
     def parse_left_angled_quote(char)
@@ -93,23 +98,14 @@ module Guileless
         stream.discard(3)
         ["<!--", :comment]
 
-      # Opening block tag
-      when stream.peek?(block_level_tags)
-        flush_buffer
-        [char, :tag_name]
-
       # Opening tag
       when stream.peek?(html_tags)
+        start_tag
         [char, :tag_name]
 
-      # Closing block level tag
-      when stream.peek?(closing(block_level_tags))
-        flush_buffer
-        stream.discard
-        ["</", :closing_tag_name]
-
       # Closing tag
       when stream.peek?(closing(html_tags))
+        start_tag
         stream.discard
         ["</", :closing_tag_name]
 
@@ -120,6 +116,16 @@ module Guileless
       end
     end
 
+    def parse_linebreak
+      if stream.peek?("\n")
+        flush_buffer
+        stream.strip_whitespace
+        false
+      else
+        "<br>"
+      end
+    end
+
     def parse_text(char)
       case
 
@@ -133,19 +139,12 @@ module Guileless
         "&gt;"
 
       # Escape ampersands
-      when char == "&" && !stream.peek?("amp;")
-        @char_count += 5
-        "&amp;"
-
-      # Paragraph break
-      when char == "\n" && stream.peek?("\n")
-        flush_buffer
-        stream.strip_whitespace
-        false
+      when char == "&"
+        escape_ampersand
 
       # Line break
       when char == "\n"
-        "<br>"
+        parse_linebreak
 
       when char !=~ /\s/
         @char_count += 1

data/lib/guileless/parser.rb

@@ -84,10 +84,16 @@ module Guileless
       @tag_name = ""
     end
 
+    def filtered_input
+      # Ignoring carriage return should be fine for now,
+      # the output doesn't contain newlines.
+      input.gsub(/\r/, '')
+    end
+
     def reset!
       @char_count = 0
       @buffer = Guileless::OutputBuffer.new
-      @stream = Guileless::InputStream.new(input)
+      @stream = Guileless::InputStream.new(filtered_input)
       @tag_stack = []
       reset_tag_name
       @state = :text

data/lib/guileless/version.rb

@@ -1,5 +1,5 @@
 module Guileless
   unless Guileless.const_defined?('VERSION')
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/guileless_spec.rb

@@ -20,10 +20,12 @@ describe Guileless do
 
     it "converts single breaks to <br>" do
       Guileless.format("foo\nbar").should == "<p>foo<br>bar</p>"
+      Guileless.format("foo\r\nbar").should == "<p>foo<br>bar</p>"
     end
 
     it "converts double breaks to <br>" do
       Guileless.format("foo\n\nbar").should == "<p>foo</p><p>bar</p>"
+      Guileless.format("foo\r\n\r\nbar").should == "<p>foo</p><p>bar</p>"
     end
 
     it "escapes left angled brackets" do
@@ -42,6 +44,11 @@ describe Guileless do
       Guileless.format("&amp;").should == "<p>&amp;</p>"
     end
 
+    it "doesn't escape other character entities" do
+      Guileless.format("&nbsp;").should == "<p>&nbsp;</p>"
+      Guileless.format("&#x1f4a9;").should == "<p>&#x1f4a9;</p>"
+    end
+
     it "understands empty attributes" do
       Guileless.format("<blockquote data-foo>stuff</blockquote>").should == "<blockquote data-foo><p>stuff</p></blockquote>"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guileless
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Inge Jørgensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies: []
 description: Naive HTML preprocessor
 email: inge@elektronaut.no
@@ -16,9 +16,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -44,21 +44,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Naive HTML preprocessor
 test_files:
 - spec/guileless_spec.rb
 - spec/spec_helper.rb
-has_rdoc: