RubyGems - htmless - Versions diffs - 0.4 → 0.4.1 - Mend

htmless 0.4 → 0.4.1

Files changed (4) hide show

data/README.md CHANGED Viewed

@@ -1,7 +1,41 @@
-## Htmless
+# Htmless
-Fast extensible html5 builder in pure Ruby
+[![Build Status](https://travis-ci.org/pitr-ch/htmless.png)](https://travis-ci.org/pitr-ch/htmless)
+**Fast** and **extensible** HTML5 builder in pure **Ruby**
 -   Documentation: <http://blog.pitr.ch/htmless>
 -   Source: <https://github.com/pitr-ch/htmless>
 -   Blog: <http://blog.pitr.ch/blog/categories/htmless/>
+## Quick syntax example
+```ruby
+Htmless::Formatted.new.go_in do
+  html5
+  html do
+    head { title 'my_page' }
+    body do
+      div.content! do
+        p.centered "my page's content"
+      end
+    end
+  end
+end.to_html
+```
+returns
+```html
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>my_page</title>
+  </head>
+  <body>
+    <div id="content">
+      <p class="centered">my page's content</p>
+    </div>
+  </body>
+</html>
+```

data/README_FULL.md CHANGED Viewed

@@ -1,11 +1,43 @@
 # Htmless
-Fast extensible html5 builder in pure Ruby
+**Fast** and **extensible** HTML5 builder in pure **Ruby**
 -   Documentation: <http://blog.pitr.ch/htmless>
 -   Source: <https://github.com/pitr-ch/htmless>
 -   Blog: <http://blog.pitr.ch/blog/categories/htmless/>
+## Quick syntax example
+```ruby
+Htmless::Formatted.new.go_in do
+  html5
+  html do
+    head { title 'my_page' }
+    body do
+      div.content! do
+        p.centered "my page's content"
+      end
+    end
+  end
+end.to_html
+```
+returns
+```html5
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>my_page</title>
+  </head>
+  <body>
+    <div id="content">
+      <p class="centered">my page's content</p>
+    </div>
+  </body>
+</html>
+```
 ## Why?
 I needed html builder with these characteristics:
@@ -20,38 +52,8 @@ Disadvanteges of other options:
 *   Markaby - slow
 *   Wee::Brush - extensible but not a standalone gem
 *   Tagz - very slow
-*   Erubis - fast but temlate engine and no tag extensibility
-*   Tenjin - faster but temlate engine and no tag extensibility
-## Quick syntax example
-    !!!ruby
-    Htmless::Formatted.new.go_in do
-      html5
-      html do
-        head { title 'my_page' }
-        body do
-          div.content! do
-            p.centered "my page's content"
-          end
-        end
-      end
-    end.to_html
-returns
-    !!!html
-    <!DOCTYPE html>
-    <html xmlns="http://www.w3.org/1999/xhtml">
-      <head>
-        <title>my_page</title>
-      </head>
-      <body>
-        <div id="content">
-          <p class="centered">my page's content</p>
-        </div>
-      </body>
-    </html>
+*   Erubis - fast but template engine and no tag extensibility
+*   Tenjin - faster but template engine and no tag extensibility
 ## Chaining
@@ -88,7 +90,7 @@ until tag is closed.
     div(:class => 'left').class('center') # <div class='left center'></div>
     div(:id => 1).id(2)                   # <div id="1" id="2"></div>
-Udefined attribute can be rendered with.
+Undefined attribute can be rendered with.
     !!!ruby
     html.attribute :xmlns, 'http://www.w3.org/1999/xhtml'
@@ -198,7 +200,7 @@ Ids generated by Arrays are joined with '-'
     div.id('an', 'id') # => <div id="an-id"></div>
-## Tag's reprezentation
+## Tag's representation
 Each tag has its own class.
@@ -440,13 +442,13 @@ How to define `AMutant::RihtEye` to return `"next to laser left eye"` ?
       end
     end
-Each class is a diferent object.
+Each class is a different object.
     !!!ruby
     Parent.dynamic_classes[:LeftEye] # => #<Class:0x00000001d449b8(A.dc[:LeftEye])>
     AChild.dynamic_classes[:LeftEye] # => #<Class:0x00000001d42398(A.dc[:LeftEye])>
-`AMutant.dc[:RightEye]` automaticaly inherits from extended `AMutant.dc[:LeftEye]`
+`AMutant.dc[:RightEye]` automatically inherits from extended `AMutant.dc[:LeftEye]`
     !!!ruby
     Parent.dc[:LeftEye].new.to_s   # => 'left eye'
@@ -514,7 +516,7 @@ returns
 ### Synthetic
-Benchmatk can be found on github. It renders simple page with two collections. 'reuse' means
+Benchmark can be found on Github. It renders simple page with two collections. 'reuse' means
 that template is precompiled and reused during benchmark.
                                    user     system      total        real
@@ -532,8 +534,8 @@ that template is precompiled and reused during benchmark.
 ### Rails 3
-Benchmatk can be found on github.
-Single page with or without a partial which is rendered 200 times. Partials make no diffrence for Htmless.
+Benchmark can be found on Github.
+Single page with or without a partial which is rendered 200 times. Partials make no difference for Htmless.
     BenchTest#test_erubis_partials (3.34 sec warmup)
                wall_time: 3.56 sec
@@ -558,14 +560,14 @@ Single page with or without a partial which is rendered 200 times. Partials make
 ## Why is it fast?
-*   Optimalization of garbage collecting.
-    *   10-15% improvment.
-    *   Preinicialization (tag's instances, even strings).
+*   Optimization of garbage collecting.
+    *   10-15% improvement.
+    *   Pre-initialization (tag's instances, even strings).
     *   No string's `#+`, `#{}`. Just `#<<` to buffer.
     *   Precomputed spaces for indentation.
-*   Doing as less as posible when rendering.
-*   Magic by metaprograming not by `method_missing`. Magic is run on inicialization not when rendering.
-*   Number of micro optimalization.
+*   Doing as less as possible when rendering.
+*   Magic by meta-programing not by `method_missing`. Magic is run on initialization not when rendering.
+*   Number of micro optimization.
     *   Data in constants or instance variables.
     *   Buffer.
     *   No `#define_method`.
@@ -580,6 +582,6 @@ Single page with or without a partial which is rendered 200 times. Partials make
 ## Why use it?
-*   Its fast
-*   You can use inheritance (imposible with templates) and other goodness of Ruby
-*   You can use pure Ruby to write the html
+*   Its as fast as template-engines (erb) and much faster then other Ruby HTML builders.
+*   You can use inheritance (impossible with templates) and other goodness of Ruby.
+*   You can write html in pure Ruby.

data/lib/htmless.rb CHANGED Viewed

@@ -1,3 +1,9 @@
-require "htmless/formatted"
+module Htmless
+  def self.version
+    @version ||= Gem::Version.new File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
+  end
+  require "htmless/formatted"
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: htmless
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.1
   prerelease:
 platform: ruby
 authors:
@@ -44,7 +44,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: