RubyGems - fragment - Versions diffs - 0.0.2 → 1.0.0 - Mend

fragment 0.0.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

data/README.md CHANGED

@@ -5,14 +5,11 @@ 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.
+In essence, Fragment works more or less like any builder.
 First, how to install:
-    sudo gem install fragment
+    gem install fragment
 Then you can require Fragment and use it that way:
@@ -20,7 +17,7 @@ Then you can require Fragment and use it that way:
     default = 'HTML'
-    html = Fragment.please do
+    html = Fragment.create do
       doctype
       html(:lang=>'en') do
         head { title { "My Choice" } }
@@ -40,7 +37,7 @@ Then you can require Fragment and use it that way:
 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:
+If you want something else, you can use the `write` method 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'>"
@@ -62,7 +59,13 @@ This is what I did on the long example above for marking the default option.
 Nothing fancy but quite good to be aware of.
+If you do something and want to keep the scope you are in, you can use `create_here` instead of `here`. You then have access to the methods through the fragment object passed to the block:
+    html = Fragment.create_here do |f|
+      f.h1 { "" }
+    end
 Do not hesitate to fork the project if you want to help me improve it.
 Thanx
-Mig
+Mig

data/fragment.gemspec CHANGED

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name = 'fragment'
-  s.version = "0.0.2"
+  s.version = "1.0.0"
   s.platform = Gem::Platform::RUBY
-  s.summary = "Another HTML builder"
+  s.summary = "Lightweight 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.email = "mig@mypeplum.com"
   s.homepage = "https://github.com/mig-hub/fragment"
   s.add_development_dependency(%q<bacon>, "~> 1.1.0")
 end

data/lib/fragment.rb CHANGED

@@ -1,43 +1,52 @@
 class Fragment
-  attr_accessor :out
+  attr_accessor :to_s
-  def self.please(&block); self.new(&block).out; end
+  def self.create(&block); self.new(false,&block).to_s; end
+  def self.create_here(&block); self.new(true,&block).to_s; end
-  def initialize(&block)
-    @out = ""
-    instance_eval(&block) if block_given?
+  def initialize outer_scope=false, &block
+    @to_s = ""
+    return self unless block_given?
+    unless outer_scope
+      instance_eval(&block)
+    else
+      block.call(self)
+    end
+    self
   end
   def method_missing(meth, args={}, &block); tag(meth, args, &block); end
-  def tag(name, attributes={})
-    @out << "<#{name}"
+  def tag name, attributes={}
+    @to_s << "<#{name}"
     if attributes.kind_of?(String)
-      @out << ' ' << attributes
+      @to_s << ' ' << attributes
     else
-      @out << attributes.delete_if{|k,v| v.nil? or v==false }.map{|(k,v)| " #{k}='#{_fragment_escape_entities(v)}'" }.join
+      @to_s << attributes.delete_if{|k,v| v.nil? or v==false }.map{|(k,v)| " #{k}='#{_fragment_escape_html(v)}'" }.join
     end
     if block_given?
-      @out << ">"
+      @to_s << ">"
       text = yield
-      @out << text.to_str if text != @out and text.respond_to?(:to_str)
-      @out << "</#{name}>"
+      @to_s << text.to_str if text != @to_s and text.respond_to?(:to_str)
+      @to_s << "</#{name}>"
     else
-      @out << ' />'
+      @to_s << ' />'
     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
+  # Helpers
+  def write(s=''); @to_s << s; end
   def doctype; write "<!DOCTYPE html>\n"; end
   def comment(s=''); write "\n<!-- #{s} -->\n"; end
+  def _fragment_escape_html(s)
+    s.to_s.gsub(/&/, '&amp;').gsub(/"/, '&quot;').gsub(/'/, '&apos;').gsub(/</, '&lt;').gsub(/>/, '&gt;')
+  end
+end
-end

data/test/spec_fragment.rb CHANGED

@@ -1,31 +1,28 @@
-require 'rubygems'
-require 'bacon'
+# encoding: utf-8
-ROOT = ::File.dirname(__FILE__)+'/..'
-$:.unshift ROOT+'/lib'
-require 'fragment'
+require 'bacon'
+$:.unshift File.expand_path('../../lib', __FILE__)
+require "fragment"
-describe "Fragment" do
+describe 'Fragment' do
-  def fragment &block
-    Fragment.please(&block)
-  end
+  def fragment(&block); Fragment.new(&block).to_s; end
-  it "simple tag" do
+  it "Builds simple tags" do
     fragment{ br }.should == '<br />'
     fragment{ p }.should == '<p />'
   end
-  it "open close tags" do
+  it "Opens and closes tags" do
     fragment{ p{} }.should == '<p></p>'
     fragment{ div{} }.should == '<div></div>'
   end
-  it "nested tags" do
+  it "Nests tags" do
     fragment{ p{ br } }.should == '<p><br /></p>'
   end
-  it "deep nested tags" do
+  it "Builds deeply nested tags" do
     fragment do
       p do
         div do
@@ -37,7 +34,7 @@ describe "Fragment" do
     end.should == '<p><div><ol><li /></ol></div></p>'
   end
-  it "deep nested tags with repetition" do
+  it "Builds deeply nested tags with repetition" do
     fragment do
       p do
         div do
@@ -54,7 +51,7 @@ describe "Fragment" do
     end.should == '<p><div><ol><li /><li /></ol><ol><li /><li /></ol></div></p>'
   end
-  it "deep nested tags with strings" do
+  it "Builds deeply nested tags with strings" do
     fragment do
       p do
         div {'Hello, World'}
@@ -62,13 +59,13 @@ describe "Fragment" do
     end.should == '<p><div>Hello, World</div></p>'
   end
-  it "allows to write directly if needed" do
+  it "Allows to write directly if needed" do
     fragment do
       write "<!DOCTYPE html>"
     end.should == '<!DOCTYPE html>'
   end
-  it "some simple example" do
+  it "Builds a full HTML page" do
     fragment do
       doctype
       html do
@@ -82,7 +79,7 @@ describe "Fragment" do
     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
+  it "Builds with some ruby inside" do
     fragment do
       table do
         tr do
@@ -94,7 +91,7 @@ describe "Fragment" do
     end.should == '<table><tr><td>one</td><td>two</td><td>three</td></tr></table>'
   end
-  it "escapeable attributes" do
+  it "Builds escapeable attributes" do
     fragment {
       a(:href => "http://example.org/?a=one&b=two") {
         "Click here"
@@ -102,29 +99,29 @@ describe "Fragment" do
     }.should == "<a href='http://example.org/?a=one&amp;b=two'>Click here</a>"
   end
-  it "should accept attributes in a string" do
+  it "Should accept attributes in a string" do
     fragment{ input("type='text'") }.should == "<input type='text' />"
   end
-  it 'should accept symbols as attributes' do
+  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
+  it 'Builds tags with prefix' do
     fragment{ tag "prefix:local" }.should == '<prefix:local />'
   end
-  it 'tags with a variety of characters' do
+  it 'Builds 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
+  it "Has a practicle way to add attributes like 'selected' based on boolean" do
     @selected = false
     fragment do
       option({:name => 'opt', :selected => @selected})
@@ -133,11 +130,11 @@ describe "Fragment" do
     end.should == "<option name='opt' /><option name='opt' selected='true' /><option name='opt' />"
   end
-  it "Pass the Readme example" do
+  it "Builds a more complex HTML page with a variable in the outer scope" do
     default = 'HTML'
-    html = Fragment.please do
+    html = Fragment.new do
       doctype
       html(:lang=>'en') do
         head { title { "My Choice" } }
@@ -152,9 +149,45 @@ describe "Fragment" do
           write "\n<!-- like Google Analytics or including another fragment -->\n"
         end
       end
-    end
+    end.to_s
     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
+  it 'Can be used inside the scope of an object' do
+    class Stranger
+      attr_accessor :name, :comment
+      def show_comment
+        Fragment.new(true) do |b|
+          b.p{ self.comment }
+        end.to_s
+      end
+      def show_summary
+        Fragment.create_here do |b|
+          b.article do
+            b.h1{ self.name }
+            b.p{ self.comment }
+          end
+        end
+      end
+      def fail_summary
+        Fragment.create do
+          article do
+            h1{ self.name }
+            p{ self.comment }
+          end
+        end
+      end
+    end
+    s = Stranger.new
+    s.name = 'The Doors'
+    s.comment = 'Strange days'
+    s.show_comment.should=='<p>Strange days</p>'
+    s.show_summary.should=='<article><h1>The Doors</h1><p>Strange days</p></article>'
+    s.fail_summary.should=="<article><h1><name /></h1><p>\n<!--  -->\n</p></article>"
+  end
+end

metadata CHANGED

@@ -1,87 +1,68 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification
 name: fragment
-version: !ruby/object:Gem::Version
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease:
-  segments:
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors:
+authors:
 - Mickael Riga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00 +00:00
-default_executable:
-dependencies:
-- !ruby/object:Gem::Dependency
+date: 2014-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bacon
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements:
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version
-        hash: 19
-        segments:
-        - 1
-        - 1
-        - 0
+      - !ruby/object:Gem::Version
         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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+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@mypeplum.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
+files:
 - .gitignore
 - MIT_LICENCE
 - README.md
 - fragment.gemspec
 - lib/fragment.rb
 - test/spec_fragment.rb
-has_rdoc: true
 homepage: https://github.com/mig-hub/fragment
 licenses: []
 post_install_message:
 rdoc_options: []
-require_paths:
+require_paths:
 - ./lib
-required_ruby_version: !ruby/object:Gem::Requirement
+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
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      hash: 3
-      segments:
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 1.4.2
+rubygems_version: 1.8.23
 signing_key:
 specification_version: 3
-summary: Another HTML builder
+summary: Lightweight HTML builder
 test_files: []