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

fragment 1.0.0 → 1.1.0

Files changed (12) hide show

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05b9ed2ebd1d81634b699810495aca5a66acb46e
+  data.tar.gz: 8d11babc8d25ade0f40112ec8c0c111cae637064
+SHA512:
+  metadata.gz: a69a5f02a542d5acde4b37643a8cbf8cda4fbb5afe52b45468aebadb189b5d7e178c142dbb4c3628d39c7ff87f7dee3baf6b77a97a19aa76ebbca6a9a0bb8816
+  data.tar.gz: cf3b9dd2585853d1d4114874e304581838fe64423aa84144d771a3e808443663698f04f865bda30fac6a9166e96864f3898498645e497d2d8cf06790b9230d4c

data/.rspec ADDED

@@ -0,0 +1,3 @@
+--color
+--require spec_helper

data/Gemfile ADDED

	@@ -0,0 +1,2 @@
1	+ gemspec
2	+

data/Gemfile.lock ADDED

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    fragment (1.0.0)
+GEM
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  fragment!
+  rspec

data/{MIT_LICENCE → MIT_LICENSE} RENAMED

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Mickael Riga
+Copyright (c) 2011-2015 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
@@ -16,4 +16,5 @@ 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.
+THE SOFTWARE.

data/README.md CHANGED

@@ -9,49 +9,65 @@ In essence, Fragment works more or less like any builder.
 First, how to install:
-    gem install fragment
+```
+gem install fragment
+```
+Or in your `Gemfile`:
+```
+gem 'fragment'
+```
 Then you can require Fragment and use it that way:
-    require 'fragment'
-    default = 'HTML'
-    html = Fragment.create 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"
+```
+require 'fragment'
+default = 'HTML'
+html = Fragment.create 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
-    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` method 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'>"
+```
+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.
+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:
+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'
+```
+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.
@@ -59,11 +75,17 @@ 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
+If you need more control on the scope of variables and basically stay in the
+scope you are in, you can add an argument to the block which represents the
+fragment itself. The change of arity changes the scope and since you are in the
+current scope, every fragment method has to be called on the fragment object.
+Here is an example which hopefully makes it clearer:
+```
+html = Fragment.create do |f|
+  f.h1 { "" }
+end
+```
 Do not hesitate to fork the project if you want to help me improve it.

data/fragment.gemspec CHANGED

@@ -1,13 +1,21 @@
+require_relative './lib/fragment/version'
 Gem::Specification.new do |s|
   s.name = 'fragment'
-  s.version = "1.0.0"
-  s.platform = Gem::Platform::RUBY
+  s.version = Fragment.version
   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@mypeplum.com"
   s.homepage = "https://github.com/mig-hub/fragment"
-  s.add_development_dependency(%q<bacon>, "~> 1.1.0")
+  s.licenses = ['MIT']
+  s.platform = Gem::Platform::RUBY
+  s.require_path = './lib'
+  s.files = `git ls-files`.split("\n").sort
+  s.test_files = s.files.select { |p| p =~ /^spec\/.*_spec.rb/ }
+  s.add_development_dependency("rspec")
 end

data/lib/fragment.rb CHANGED

@@ -1,13 +1,19 @@
+require 'fragment/version'
 class Fragment
   attr_accessor :to_s
-  def self.create(&block); self.new(false,&block).to_s; end
-  def self.create_here(&block); self.new(true,&block).to_s; end
+  def self.create(&block); self.new(&block).to_s; end
+  # create_here is kept for backward compatibility
+  def self.create_here(&block); self.new(&block).to_s; end
   def initialize outer_scope=false, &block
+    # outer_scope argument is kept for backward compatibility
+    # but it is not used
+    # checking is simpler with arity instead
     @to_s = ""
     return self unless block_given?
-    unless outer_scope
+    if block.arity==0
       instance_eval(&block)
     else
       block.call(self)

data/lib/fragment/version.rb ADDED

@@ -0,0 +1,7 @@
+class Fragment
+  VERSION = [1,1,0]
+  def self.version
+    VERSION.join('.')
+  end
+end

data/spec/fragment_spec.rb ADDED

@@ -0,0 +1,190 @@
+# encoding: utf-8
+require "fragment"
+RSpec.describe Fragment do
+  def fragment(&block); Fragment.create(&block); end
+  it "Builds simple tags" do
+    expect(fragment{ br }).to eq '<br />'
+    expect(fragment{ p }).to eq '<p />'
+  end
+  it "Opens and closes tags" do
+    expect(fragment{ p{} }).to eq '<p></p>'
+    expect(fragment{ div{} }).to eq '<div></div>'
+  end
+  it "Nests tags" do
+    expect(fragment{ p{ br } }).to eq '<p><br /></p>'
+  end
+  it "Builds deeply nested tags" do
+    expect(fragment do
+      p do
+        div do
+          ol do
+            li
+          end
+        end
+      end
+    end).to eq '<p><div><ol><li /></ol></div></p>'
+  end
+  it "Builds deeply nested tags with repetition" do
+    expect(fragment do
+      p do
+        div do
+          ol do
+            li
+            li
+          end
+          ol do
+            li
+            li
+          end
+        end
+      end
+    end).to eq '<p><div><ol><li /><li /></ol><ol><li /><li /></ol></div></p>'
+  end
+  it "Builds deeply nested tags with strings" do
+    expect(fragment do
+      p do
+        div {'Hello, World'}
+      end
+    end).to eq '<p><div>Hello, World</div></p>'
+  end
+  it "Allows to write directly if needed" do
+    expect(fragment do
+      write "<!DOCTYPE html>"
+    end).to eq '<!DOCTYPE html>'
+  end
+  it "Builds a full HTML page" do
+    expect(fragment do
+      doctype
+      html do
+        head do
+          title {"Hello World"}
+        end
+        body do
+          h1 {"Hello World"}
+        end
+      end
+    end).to eq "<!DOCTYPE html>\n<html><head><title>Hello World</title></head><body><h1>Hello World</h1></body></html>"
+  end
+  it "Builds with some ruby inside" do
+    expect(fragment do
+      table do
+        tr do
+          %w[one two three].each do |s|
+            td{s}
+          end
+        end
+      end
+    end).to eq '<table><tr><td>one</td><td>two</td><td>three</td></tr></table>'
+  end
+  it "Builds escapeable attributes" do
+    expect(fragment {
+      a(:href => "http://example.org/?a=one&b=two") {
+        "Click here"
+      }
+    }).to eq "<a href='http://example.org/?a=one&amp;b=two'>Click here</a>"
+  end
+  it "Should accept attributes in a string" do
+    expect(fragment{ input("type='text'") }).to eq "<input type='text' />"
+  end
+  it 'Should accept symbols as attributes' do
+    input = fragment{ input(:type => :text, :value => :one) }
+    expect(input).to match /type='text'/
+    expect(input).to match /value='one'/
+  end
+  it 'Builds tags with prefix' do
+    expect(fragment{ tag "prefix:local" }).to eq '<prefix:local />'
+  end
+  it 'Builds tags with a variety of characters' do
+    # with "-"
+    expect(fragment{ tag "hello-world" }).to eq '<hello-world />'
+    # with Hiragana
+    expect(fragment{ tag "あいうえお" }).to eq '<あいうえお />'
+  end
+  it "Has a practicle way to add attributes like 'selected' based on boolean" do
+    @selected = false
+    expect(fragment do
+      option({:name => 'opt', :selected => @selected})
+      option(:name => 'opt', :selected => !@selected)
+      option(:name => 'opt', :selected => @i_am_nil)
+    end).to eq "<option name='opt' /><option name='opt' selected='true' /><option name='opt' />"
+  end
+  it "Builds a more complex HTML page with a variable in the outer scope" do
+    default = 'HTML'
+    html = Fragment.new 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.to_s
+    expect(html).to eq "<!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
+  it 'Can be used inside the scope of an object' do
+    class Stranger
+      attr_accessor :name, :comment
+      def show_comment
+        Fragment.create do |b|
+          b.p{ self.comment }
+        end
+      end
+      def show_summary
+        Fragment.create 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'
+    expect(s.show_comment).to eq '<p>Strange days</p>'
+    expect(s.show_summary).to eq '<article><h1>The Doors</h1><p>Strange days</p></article>'
+    expect(s.fail_summary).to eq "<article><h1><name /></h1><p>\n<!--  -->\n</p></article>"
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = true
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata CHANGED

@@ -1,32 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fragment
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease:
+  version: 1.1.0
 platform: ruby
 authors:
 - Mickael Riga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bacon
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '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.
@@ -36,33 +33,40 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- MIT_LICENCE
+- .rspec
+- Gemfile
+- Gemfile.lock
+- MIT_LICENSE
 - README.md
 - fragment.gemspec
 - lib/fragment.rb
+- lib/fragment/version.rb
+- spec/fragment_spec.rb
+- spec/spec_helper.rb
 - test/spec_fragment.rb
 homepage: https://github.com/mig-hub/fragment
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
 - ./lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key:
-specification_version: 3
+specification_version: 4
 summary: Lightweight HTML builder
-test_files: []
+test_files:
+- spec/fragment_spec.rb