RubyGems - fragment - Versions diffs - 0.0.1 - Mend

fragment 0.0.1

Files changed (6) hide show

data/MIT_LICENCE ADDED

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Mickael Riga
+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,68 @@
+FRAGMENT
+========
+Fragment is an HTML builder heavily based on Gestalt from the Ramaze framework.
+Its main purpose is to create fragments of HTML (hence the name),
+but is perfectly suited for building full pages.
+In essence, Fragment works more or less like any builder except that the code
+is reduce to the minimum. Instead of trying to be universal, I would rather keep the
+code as simple as possible and concentrate on small problems I have everyday when trying to
+write HTML via Ruby.
+First, how to install:
+    sudo gem install fragment
+Them you can require Fragment and use it that way:
+    require 'fragment'
+    default = 'HTML'
+    html = Fragment.please do
+      doctype
+      html(:lang=>'en') do
+        head { title { "My Choice" } }
+        body do
+          comment "Here starts the body"
+          select(:name => 'language') do
+            ['JS', 'HTML', 'CSS'].each do |l|
+              option(:value => l, :selected => l==default) { l }
+            end
+          end
+          write "\n<!-- This allows to write HTML directly when using a snippet -->\n"
+          write "\n<!-- like Google Analytics or including another fragment -->\n"
+        end
+      end
+    end
+If you try this example, you might notice a couple of things:
+First of all, you have a `doctype` helper which only creates an HTML5 doctype.
+If you want something else, you can use the `write` function which lets you write directly in place:
+    write "<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01//EN'"
+    write "  'http://www.w3.org/TR/html4/strict.dtd'>"
+The major difference with Gestalt (if you used it) is that it does not accept content
+in the arguments. This simplifies the code a lot for a very small sacrifice.
+So the argument is either a Hash that represents the attributes, or a string like
+you would write in the HTML code.
+One problem I had when creating fragments of HTML from code with a Hash for attributes
+is for attributes like 'selected' or 'checked' which are a bit annoying because they do
+not have a negative value (not that I know of), so you cannot write things like:
+    selected='not_selected'
+I find this slightly irritating.
+So what I did is that in the Hash, when a value is false, its key is removed.
+This is what I did on the long example above for marking the default option.
+Nothing fancy but quite good to be aware of.
+Do not hesitate to fork the project if you want to help me improve it.
+Thanx
+Mig

data/fragment.gemspec ADDED

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'fragment'
+  s.version = "0.0.1"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Another HTML builder"
+  s.description = "An HTML builder heavily based on Gestalt from the Ramaze framework. Its main purpose is to create fragments (hence the name), but is perfectly suited for building full pages."
+  s.files = `git ls-files`.split("\n").sort
+  s.require_path = './lib'
+  s.author = "Mickael Riga"
+  s.email = "mig@campbellhay.com"
+  s.homepage = "http://www.campbellhay.com"
+  s.add_development_dependency(%q<bacon>, "~> 1.1.0")
+end

data/lib/fragment.rb ADDED

@@ -0,0 +1,43 @@
+class Fragment
+  attr_accessor :out
+  def self.please(&block); self.new(&block).out; end
+  def initialize(&block)
+    @out = ""
+    instance_eval(&block) if block_given?
+  end
+  def method_missing(meth, args={}, &block); tag(meth, args, &block); end
+  def tag(name, attributes={})
+    @out << "<#{name}"
+    if attributes.kind_of?(String)
+      @out << ' ' << attributes
+    else
+      @out << attributes.delete_if{|k,v| v.nil? or v==false }.map{|(k,v)| " #{k}='#{_fragment_escape_entities(v)}'" }.join
+    end
+    if block_given?
+      @out << ">"
+      text = yield
+      @out << text.to_str if text != @out and text.respond_to?(:to_str)
+      @out << "</#{name}>"
+    else
+      @out << ' />'
+    end
+  end
+  def _fragment_escape_entities(s)
+    s.to_s.gsub(/&/, '&amp;').gsub(/"/, '&quot;').gsub(/'/, '&apos;').gsub(/</, '&lt;').gsub(/>/, '&gt;')
+  end
+  # Override Kernel methods
+  def p(args={}, &block); tag(:p, args, &block); end
+  def select(args={}, &block); tag(:select, args, &block); end
+  # More
+  def write(s=''); @out << s; end
+  def doctype; write "<!DOCTYPE html>\n"; end
+  def comment(s=''); write "\n<!-- #{s} -->\n"; end
+end

data/test/spec_fragment.rb ADDED

@@ -0,0 +1,160 @@
+require 'rubygems'
+require 'bacon'
+ROOT = ::File.dirname(__FILE__)+'/..'
+$:.unshift ROOT+'/lib'
+require 'fragment'
+describe "Fragment" do
+  def fragment &block
+    Fragment.please(&block)
+  end
+  it "simple tag" do
+    fragment{ br }.should == '<br />'
+    fragment{ p }.should == '<p />'
+  end
+  it "open close tags" do
+    fragment{ p{} }.should == '<p></p>'
+    fragment{ div{} }.should == '<div></div>'
+  end
+  it "nested tags" do
+    fragment{ p{ br } }.should == '<p><br /></p>'
+  end
+  it "deep nested tags" do
+    fragment do
+      p do
+        div do
+          ol do
+            li
+          end
+        end
+      end
+    end.should == '<p><div><ol><li /></ol></div></p>'
+  end
+  it "deep nested tags with repetition" do
+    fragment do
+      p do
+        div do
+          ol do
+            li
+            li
+          end
+          ol do
+            li
+            li
+          end
+        end
+      end
+    end.should == '<p><div><ol><li /><li /></ol><ol><li /><li /></ol></div></p>'
+  end
+  it "deep nested tags with strings" do
+    fragment do
+      p do
+        div {'Hello, World'}
+      end
+    end.should == '<p><div>Hello, World</div></p>'
+  end
+  it "allows to write directly if needed" do
+    fragment do
+      write "<!DOCTYPE html>"
+    end.should == '<!DOCTYPE html>'
+  end
+  it "some simple example" do
+    fragment do
+      doctype
+      html do
+        head do
+          title {"Hello World"}
+        end
+        body do
+          h1 {"Hello World"}
+        end
+      end
+    end.should == "<!DOCTYPE html>\n<html><head><title>Hello World</title></head><body><h1>Hello World</h1></body></html>"
+  end
+  it "some ruby inside" do
+    fragment do
+      table do
+        tr do
+          %w[one two three].each do |s|
+            td{s}
+          end
+        end
+      end
+    end.should == '<table><tr><td>one</td><td>two</td><td>three</td></tr></table>'
+  end
+  it "escapeable attributes" do
+    fragment {
+      a(:href => "http://example.org/?a=one&b=two") {
+        "Click here"
+      }
+    }.should == "<a href='http://example.org/?a=one&amp;b=two'>Click here</a>"
+  end
+  it "should accept attributes in a string" do
+    fragment{ input("type='text'") }.should == "<input type='text' />"
+  end
+  it 'should accept symbols as attributes' do
+    input = fragment{ input(:type => :text, :value => :one) }
+    input.should =~ /type='text'/
+    input.should =~ /value='one'/
+  end
+  it 'tags with prefix' do
+    fragment{ tag "prefix:local" }.should == '<prefix:local />'
+  end
+  it 'tags with a variety of characters' do
+    # with "-"
+    fragment{ tag "hello-world" }.should == '<hello-world />'
+    # with Hiragana
+    fragment{ tag "あいうえお" }.should == '<あいうえお />'
+  end
+  it "has a practicle way to add attributes like 'selected' based on boolean" do
+    @selected = false
+    fragment do
+      option({:name => 'opt', :selected => @selected})
+      option(:name => 'opt', :selected => !@selected)
+      option(:name => 'opt', :selected => @i_am_nil)
+    end.should == "<option name='opt' /><option name='opt' selected='true' /><option name='opt' />"
+  end
+  it "Pass the Readme example" do
+    default = 'HTML'
+    html = Fragment.please do
+      doctype
+      html(:lang=>'en') do
+        head { title { "My Choice" } }
+        body do
+          comment "Here starts the body"
+          select(:name => 'language') do
+            ['JS', 'HTML', 'CSS'].each do |l|
+              option(:value => l, :selected => l==default) { l }
+            end
+          end
+          write "\n<!-- This allows to write HTML directly when using a snippet -->\n"
+          write "\n<!-- like Google Analytics or including another fragment -->\n"
+        end
+      end
+    end
+    html.should == "<!DOCTYPE html>\n<html lang='en'><head><title>My Choice</title></head><body>\n<!-- Here starts the body -->\n<select name='language'><option value='JS'>JS</option><option value='HTML' selected='true'>HTML</option><option value='CSS'>CSS</option></select>\n<!-- This allows to write HTML directly when using a snippet -->\n\n<!-- like Google Analytics or including another fragment -->\n</body></html>"
+  end
+end

metadata ADDED

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: fragment
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease:
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Mickael Riga
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-12-14 00:00:00 +00:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 19
+        segments:
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id001
+description: An HTML builder heavily based on Gestalt from the Ramaze framework. Its main purpose is to create fragments (hence the name), but is perfectly suited for building full pages.
+email: mig@campbellhay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT_LICENCE
+- README.md
+- fragment-0.0.1.gem
+- fragment.gemspec
+- lib/fragment.rb
+- test/spec_fragment.rb
+has_rdoc: true
+homepage: http://www.campbellhay.com
+licenses: []
+post_install_message:
+rdoc_options: []
+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:
+rubygems_version: 1.4.2
+signing_key:
+specification_version: 3
+summary: Another HTML builder
+test_files: []