bubble 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eric Budd
+
+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.rdoc

@@ -0,0 +1,68 @@
+= Bubble
+
+Bubble is a library for creating HTML from basic Ruby data structures.
+
+== Installation
+
+Bubble is a gem.
+
+    gem install bubble
+
+== Examples
+
+Bubble can convert arrays and symbols into tags and hashes into attributes.
+
+If you want to create simple tags:
+
+    b = Bubble.new([:h1, "Entitling!"])
+    b.to_html
+    # => "<h1>Entitling!</h1>"
+
+Or if you want a tag with attributes:
+
+    link = Bubble.new([:a, {:href => "/images/free_cat.jpg"}, "Free Cat!"])
+    link.to_html
+    # => "<a href="/images/free_cat.jpg">Free Cat!</a>"
+
+Empty tags:
+
+    sad_and_alone = Bubble.new([:p])
+    sad_and_alone.to_html
+    # => "<p />"
+
+Or even nested tags:
+
+    blurb = Bubble.new([:marquee, {:style => 'font-weight: bold'}, [:font, "Arial",[:size, "smaller", [:b, "Made with DreamWeaver!"]]]])
+    blurb.to_html
+    # => "<marquee style="font-weight: bold"><font><Arial><size><smaller><b>Made with DreamWeaver!</b></smaller></size></Arial></font></marquee>"
+
+Since Bubble objects are just repurposed Arrays and Hashes, you can perform all the same operations on them.
+
+    b = Bubble.new
+    b[0] = :p
+    b << "Parachute Pants!"
+    b += [{:class => "hammer#{Time.new.class.name.downcase}"}]
+    b.last.merge!(:action => 'Stop!')
+    b.to_html
+    # => "<p class="hammertime" action="Stop!">Parachute Pants!</p>"
+
+== Purpose
+
+While it's certainly conceivable that you could build an entire templating system around Bubble, it's intended to create and programatically maniuplate small snippets of HTML.
+
+Ruby has an excellent library for working with arrays and hashes, and Bubble lets you work within the standard library instead of trying to wrangle raw HTML into a manipulable format.
+
+== Contributing to Bubble
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Eric Budd. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bubble"
+  gem.homepage = "http://github.com/Calamitous/bubble"
+  gem.license = "MIT"
+  gem.summary = %Q{Bubble is a library for creating HTML from basic Ruby data structures.}
+  gem.description = %Q{Bubble is a library for creating HTML from basic Ruby data structures.}
+  gem.email = "eric.b.budd@gmail.com"
+  gem.authors = ["Eric Budd"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bubble #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bubble.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bubble}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Budd"]
+  s.date = %q{2011-06-08}
+  s.description = %q{Bubble is a library for creating HTML from basic Ruby data structures.}
+  s.email = %q{eric.b.budd@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bubble.gemspec",
+    "lib/bubble.rb",
+    "spec/bubble_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/Calamitous/bubble}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Bubble is a library for creating HTML from basic Ruby data structures.}
+  s.test_files = [
+    "spec/bubble_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/bubble.rb

@@ -0,0 +1,82 @@
+class Bubble < Array
+  def to_fragment
+    self
+  end
+
+  def to_html
+    if first.is_a?(Array) 
+      self.each do |x|
+        unless x.is_a?(Array)
+          raise ArgumentError.new(":#{x.to_s} is not a valid tag array.  Did you mean [:#{x.to_s}]?")
+        end
+      end
+      map{|x| x.to_html }.join # traverse
+    else
+      self.to_tag #descend
+    end
+  end
+
+  def to_tag
+    return '' if empty?
+    if self.size == 1
+      return self[0].is_a?(Symbol) ? "<#{self[0].to_s} />" : self[0]
+    end
+
+    list = reject{ |x| x.is_a?(Hash) }
+    head, tail = list.bite_off_head
+
+    fore_tag = [head.to_s, properties.to_property_string].compact.reject{ |x| x.empty? }.join(' ')
+
+    return "<#{fore_tag} />" if tail.nil? || tail.empty?
+    "<#{fore_tag}>#{tail.to_html}</#{head}>"
+  end
+
+  def properties
+    self.inject({}) { |acc, elem| acc.merge!(elem) if elem.is_a?(Hash); acc }
+  end
+
+  def bite_off_head
+    return self[0], self[1..-1]
+  end
+end
+
+class BubbleProperty < Hash
+  def initialize(data = {})
+    if data.respond_to?(:keys)
+      data.keys.each{|k| self[k] = data[k]}
+    else
+      raise ArgumentError, "Couldn't instantiate BubbleProperty; I expected a Hash-y object."
+    end
+  end
+
+  def to_property_string
+    self.map{ |k, v| "#{k.to_s}=\"#{v.to_s}\""}.join(' ')
+  end
+end
+
+class Array
+  def to_fragment
+    Bubble.new(self)
+  end
+
+  def to_html
+    self.to_fragment.to_html
+  end
+end
+
+class Hash
+  def to_fragment_property
+    BubbleProperty.new(self)
+  end
+
+  def to_property_string
+    self.to_fragment_property.to_property_string
+  end
+end
+
+class String
+  def to_html
+    self
+  end
+end
+

data/spec/bubble_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'Bubble' do
+  context 'while entagging data' do
+    it 'entags a tag array' do
+      data = [[:a]]
+      data.to_html.should == '<a />'
+    end
+
+    it 'entags multiple arrays' do
+      data = [[[:a], [:b]]]
+      data.to_html.should == '<a /><b />'
+    end
+
+    it 'entags nested tag arrays' do
+      data = [[:a, [:b]]]
+      data.to_html.should == '<a><b /></a>'
+    end
+
+    it 'entags nested multiple tag arrays' do
+      data = [[[:a, [:b]], [:c, [:d]]]]
+      data.to_html.should == '<a><b /></a><c><d /></c>'
+    end
+
+    it 'entags nested arrays to an arbitrary depth' do
+      data = [[:a, [:b, [:c, [:d]]]]]
+      data.to_html.should == '<a><b><c><d /></c></b></a>'
+    end
+
+    it 'entags nested arrays including static text' do
+      pending
+      # hmmm, what should be the preferred usage...
+      # [:p, 'Test', [:a, {:href => '/wut'}, 'this'], 'baby'] 
+      # or
+      # [:p, 'Test #{[:a, {:href => '/wut'}, 'this'].to_html} baby'] 
+      data = [[:a, [:b, 'NO WAI', [:c, [:d, 'LOLWUT']]]]]
+      # data.to_html.should == '<a><b>NO WAI<c><d>LOLWUT</d></c></b></a>'
+    end
+
+    it 'ignores empty nesting' do
+      data = [[:a, [[[:b]]], [:c]]]
+      data.to_html.should == '<a><b /><c /></a>'
+    end
+
+    it 'raises an error if a tag is not correctly wrapped' do
+      data = [[:a], :c]
+      lambda { data.to_html }.should raise_error(':c is not a valid tag array.  Did you mean [:c]?')
+    end
+
+    it 'renders static text' do
+      data = [:p, 'this thing']
+      data.to_html.should == '<p>this thing</p>'
+    end
+
+    context 'with properties' do
+      it 'entags a tag array' do
+        data = [[:a, {:foo => :bar}]]
+        data.to_html.should == '<a foo="bar" />'
+      end
+
+      it 'renders static text' do
+        data = [:p, {:class => 'test'},  'this thing']
+        data.to_html.should == '<p class="test">this thing</p>'
+      end
+
+      it 'entags properties around interleaved tag arrays' do
+        data = [[:a, [:b], {:foo => :bar}]]
+        data.to_html.should == '<a foo="bar"><b /></a>'
+      end
+
+      it 'collects multiple hashes in to a single list of properties' do
+        data = [[:a, {:foo => :bar}, {:baz => 'quux!'}]]
+        data.to_html.should match(/baz="quux!"/)
+        data.to_html.should match(/foo="bar"/)
+      end
+
+      it 'overrides properties which have already been defined to the left' do
+        data = [[:a, {:foo => :bar}, {:foo => 'quux!'}]]
+        data.to_html.should == '<a foo="quux!" />'
+      end
+
+      it 'entags nested arrays' do
+        data = [[:a, [:b, {:lol => 'wut'}]]]
+        data.to_html.should == '<a><b lol="wut" /></a>'
+      end
+
+      it 'entags nested multiple tag arrays' do
+        data = [[[:a, [:b, {:lol => 'wut'}]], [:c, [:d, {:no => 'wai'}]]]]
+        data.to_html.should == '<a><b lol="wut" /></a><c><d no="wai" /></c>'
+      end
+    end
+  end
+end
+
+describe BubbleProperty do
+  context 'instantiation' do
+    it 'doesn\'t have any values' do
+      BubbleProperty.new.keys.should be_empty
+    end
+
+    it 'copies values from a provided hash' do
+      props = BubbleProperty.new(:a => :b)
+      props[:a].should == :b
+    end
+
+    it 'raises an error when an unhashable value is provided' do
+      lambda { BubbleProperty.new('I\'m a string!') }.should raise_error(ArgumentError)
+    end
+
+    it 'occurs when Hash#to_fragment_property is called' do
+      hash = {:c => 45, 'other' => Class}
+      prop = hash.to_fragment_property
+      prop.keys.each{ |k| hash[k].should == prop[k] }
+    end
+  end
+
+  context 'rendering' do
+    it 'returns an HTML property string' do
+      props = BubbleProperty.new(:a => 45)
+      props.to_property_string.should == 'a="45"'
+    end
+
+    it 'renders multiple properties' do
+      new_properties = {:a => 45, 'foo' => 'bar'}
+      props = BubbleProperty.new(new_properties)
+      props.to_property_string.should == 'foo="bar" a="45"'
+    end
+
+    it 'occurs when Hash#to_property_string is called' do
+      {:a => 45, 'foo' => 'bar'}.to_property_string.should == 'foo="bar" a="45"'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'bubble'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: bubble
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eric Budd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  name: rspec
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  name: bundler
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  name: jeweler
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: rcov
+  requirement: *id004
+  type: :development
+description: Bubble is a library for creating HTML from basic Ruby data structures.
+email: eric.b.budd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bubble.gemspec
+- lib/bubble.rb
+- spec/bubble_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Calamitous/bubble
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Bubble is a library for creating HTML from basic Ruby data structures.
+test_files: 
+- spec/bubble_spec.rb
+- spec/spec_helper.rb