hoshi 1.0.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5712bb65af3f082b487149e20c16dc7d7ad796e9
-  data.tar.gz: ad41a5906aaa48aaab16c0b912375c91a7d2f64d
+  metadata.gz: ca598007027aa97210dfa948d34d79b3a1d9d533
+  data.tar.gz: 66e539e52fd1d0cf65e10a6b17447bda15b1b926
 SHA512:
-  metadata.gz: 5d64a05cc2610dfb1d197aaea201c2511f733fafff11161f564b83f42f4a4154c3efe4ac41527e948d3afc13ca5e586d0a29637df3e25b8639926ae564eae490
-  data.tar.gz: 117bf21e0b303d8edcb7b4a86ccacd442bbd11a969eaad00ed7715db6cc141a20c633f384bd525e4f3bf14a939a56c1043eee063069a1170deb89fcb5d9c0ed1
+  metadata.gz: c52c4c1f843a6bde06813bc637de617c7613b89445c23b252ff242e99f1744f8a76714996949fe1805e54024b893fb85523f05cc094ad8af18dbfd376c327022
+  data.tar.gz: e0c86d605ebee271e95b71d9b1f7c09812181ced4a3fe60c69d2417920a195d30dc3031953ca1c642dce1fc64f4091f7b5490b9dc88a5963b4c87cafc993b23d

data/README

@@ -2,22 +2,27 @@
 
 == Summary
 
-Hoshi is a library for creating real, first-class HTML/XML views.  So,
-unlike template libraries, you can take advantage of mixins,
-inheritance, and all the other wonderful features of Ruby's object
-system.  There is also support for easy RSS feeds and CGI.
+Hoshi is a library for creating real, first-class HTML/XML views.  It is a
+generator, so unlike template libraries, you can take advantage of mixins,
+inheritance, and all the other wonderful features of Ruby's object system.
+
+In addition to HTML5 and plain XML, Hoshi supports RSS2 and SVG, as well as some
+older standards like HTML4 and XHTML1.  (If you need anything more specific, it
+is easy to extend, and if you want to contribute, patches are welcome.)
 
 Hoshi is designed to:
-	* Generate clean HTML/XHTML/XML with minimal effort
-	* Be easy for a coder to use and understand
+	* Generate clean HTML/XML with minimal effort
+	* Be simple, to avoid bugs and keep it easy to use, understand, and modify
 	* Take full advantage of Ruby's object sytem
 	* Be more readable and easier to write than bare HTML
 
-It is semi-modeled after Markaby, but with a much more straightforward
-implementation and different semantics (e.g., no instance_eval, so scope
-inside a tag is as expected).
+It was initially inspired by (and partially modeled on) Markaby, but the
+implementation is more straightforward so the semantics are cleaner (e.g., no
+instance_eval, meaning scope inside blocks supplied to tags has no gotcha's).
 
-See doc/LICENSE for the license, doc/examples for examples.
+See doc/LICENSE for the license, doc/examples for examples.  See test/ for the
+tests, and run `rake test` to execute them.  (The tests take a fraction of a
+second to execute.)
 
 == Installation
 
@@ -29,7 +34,7 @@ or by downloading from github (http://github.com/pete/hoshi).
 
 == Usage
 
-These examples and more featured in the fabulous doc/examples directory.
+These examples 
 Also, there is a program included called html2hoshi (and associated
 lib/html2hoshi.rb; see Hoshi.from_html) that takes HTML as input and
 converts it to Ruby code using Hoshi.
@@ -46,7 +51,7 @@ These should be fairly straightforward:
       html {
         head {
           title "Hello, world!"
-          link :rel => 'stylesheet', :href => '/css/hoshi.css'
+          link rel: 'stylesheet', href: '/css/hoshi.css'
         }
 
         body {
@@ -71,13 +76,13 @@ You can get a little more complicated:
       html {
         head {
           title t
-          script(:type => 'text/javascript') {
+          script(type: 'text/javascript') {
             raw "alert(\"Hi, I'm some javascript, I suppose.\");"
           }
         }
         
         body {
-          h1 t, :class => 'page_title'
+          h1 t, class: 'page_title'
 
           yield
         }
@@ -93,7 +98,6 @@ You can get a little more complicated:
     end
   end
 
-
   class Fibonacci < Hoshi::View :xhtml1
     include Layout
 
@@ -126,7 +130,8 @@ You can get a little more complicated:
 
 === Block-based
 
-For simpler cases where you only intend to produce markup, perhaps for use as a templating engine.
+For simpler cases where you just need to produce a little markup.  Useful for
+small scripts.
 
   require 'hoshi'
 
@@ -135,7 +140,7 @@ For simpler cases where you only intend to produce markup, perhaps for use as a
     html {
       head {
         title "Hello, world!"
-        link :rel => 'stylesheet', :href => '/css/hoshi.css'
+        link rel: 'stylesheet', href: '/css/hoshi.css'
       }
 
       body {
@@ -149,37 +154,33 @@ For simpler cases where you only intend to produce markup, perhaps for use as a
 
 == Bugs
 
-There needs to be some work done on correcting the tags; I suspect I'm
-missing or miscategorizing some of them.
-
-I'd like to perhaps add a layer for serializing objects in the standard
-HTML5 method (i.e., the Schema.org/microdata stuff).  That's very
-speculative at the moment.
+There needs to be some work done on correcting the tags; I suspect I'm missing
+or miscategorizing some of them.  If you come across a case where Hoshi emits
+invalid HTML/XML/etc., please let me know.
 
-There are some requirements that were expedient at the time (requiring
-metaid and hpricot, embedding the gemspec in the Rakefile, etc.) that
-could use cleanup.  Hash is monkey-patched, and using the new Ruby 2
-refinements feature would be nicer.
+That's the only known bug likely to affect you.  See doc/TODO for a more
+detailed roadmap.
 
 == Credits
 
 Author:
-Pete Elmore -- (pete(a)debu.gs)
+Pete Elmore, Rekka Labs -- ( pete(a)debu.gs )
 
-Pretty heavily indebted to:
+The initial design is pretty heavily indebted to:
 _why the lucky stiff's Markaby library
 
-Initial design discussion:
-Dan Yoder
-
 Simple block version:
 Nolan Darilek -- (nolan(a)thewordnerd.info)
 
-Homie that be lookin' out for my broken deps:
-Lars Lethonen
+Friends that have reported bugs:
+Lars Lethonen, opsangeles -- ( http://opsangeles.com/ )
+Hunter, Spore Labs -- ( https://github.com/madhermit )
 
 The guys that paid me to do the initial version:
-AT&T Interactive.
+AT&T Interactive.  (Now yp.com; they have changed names and owners.)
+
+The company that covers development now:
+Rekka Labs -- http://rekka.io/  (Yes, you can hire us.)
 
 Also, I guess I should credit Attractive Eighties Women
 (http://attractiveeightieswomen.com/), since I was blasting them the

data/Rakefile

@@ -16,11 +16,10 @@ spec = Gem::Specification.new { |s|
 	Dir['bin/*'].map(&File.method(:basename)).map(&s.executables.method(:<<))
 
 	s.name = 'hoshi'
-	s.rubyforge_project = 'hoshi-view'
 	s.summary = "Nice, object-oriented, first-class views."
 	s.homepage = "http://debu.gs/#{s.name}"
-	%w(metaid hpricot).each &s.method(:add_dependency)
-	s.version = '1.0.3'
+	%w(hpricot).each &s.method(:add_dependency)
+	s.version = '1.1.1'
 }
 
 Gem::PackageTask.new(spec) { |pkg|
@@ -29,7 +28,7 @@ Gem::PackageTask.new(spec) { |pkg|
 
 task(:install => :package) { 
 	g = "pkg/#{spec.name}-#{spec.version}.gem"
-	system "sudo gem install -l #{g}"
+	system "gem install -l #{g}"
 }
 
 task(:test) {

data/doc/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008,2013 Pete Elmore (pete at debu.gs)
+Copyright (c) 2008-2017 Pete Elmore (pete at debu.gs)
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),

data/doc/TODO

@@ -1,10 +1,24 @@
-TODO for 1.0:
-* Separate the tags by close type in the various View sub-classes.  (The most
-  tedious thing on the list, but required for compliance.)
-* Still not too happy about the way RSS feeds are done, going to rework.
+TODO:
+· Still not too happy about the way RSS feeds are done, going to rework.
+· I do not use Atom as often as I use RSS, but Atom support would be nice.
+· html2hoshi should move to its own gem.
+· Fix some of the heuristics, default to safe() rather than raw() more often.
+  This is based on usage, but it breaks compatibility, so it'll require
+  some caution.  (Possibly make it configurable or part of blocks' state.)
 
-TODO for later:
-* Have html2hoshi do a smarter job of deciding doctypes, not using permissive!
-  so much.
-* View logic helpers.
-* Ooh, ooh, SVG!
+Ongoing:
+· Separate the tags by close type in the various View sub-classes.  (The most
+  tedious thing on the list, but required for compliance.) My current strategy
+  is to run things through validator.w3c.org and whenever it complains, I change
+  the tag.  Most of the HTML I do nowadays is HTML5, so the older versions of
+  HTML no longer get checked very often.
+
+Speculative (i.e., these may be bad ideas and they might not ever get done):
+· HTML5 microdata serialization using Schema.org conventions.  This should
+  work as easily as JSON serialization in a perfect world.
+· Possibly add some higher-level patterns for Bootstrap/Foundation/etc.
+  Ideally, they end up presenting the same API, so changing a parent class
+  or a mixin is all that is needed to change frameworks.
+· Integrate HTML validation into the tests, and make some validation tests.
+· Expanding the DSL for views.  There are not a lot of things I've missed in
+  the API so far, though, and the special-cased things are largely unused.

data/doc/examples/blocks.rb

@@ -1,6 +1,6 @@
 require 'hoshi'
 
-str = Hoshi::View::HTML4.build {
+str = Hoshi::View::HTML5.build {
 	doctype
 	html {
 		head {

data/lib/hoshi.rb

@@ -4,7 +4,7 @@ require 'hoshi/tag'
 require 'hoshi/view'
 
 # This is the namespace for all of Hoshi, which currently only includes
-# Hoshi::View and Hoshi::Tag .  For an overview, see doc/README .  For
+# Hoshi::View and Hoshi::Tag .  For an overview, see the README.  For
 # specifics, check out Hoshi::View .
 module Hoshi
 	# This is a cosmetic method; you may do Hoshi::View[:type],

data/lib/hoshi/monkey_patches.rb

@@ -1,14 +1,20 @@
-# TODO:  When 1.9 goes away, monkey-patching should be changed to refinements.
+# TODO: When 1.9 goes away, this monkey-patch should be changed to refinements, or
+# just moved into a private instance method for Hoshi::Tag.
 # See: http://blog.headius.com/2012/11/refining-ruby.html
 
 class Hash
 	# Makes this hash fit to be put into a tag.
-	# {a: 1, b: "two", c: true}.to_html_options # => 'a="one" b="two" c'
+	# 	{a: 1, b: "two", c: true, d: false}.to_html_options # => 'a="one" b="two" c'
+	# Note that true and false are special-cased, true to allow for attributes that
+	# do not have a value and false for convenience, to allow for, e.g., inline
+	# conditionals.
 	def to_html_options double_quotes = true
 		qchar = double_quotes ? '"' : "'"
 		map { |k,v|
 			if v == true # Intentional.
 				k.to_s
+			elsif v == false
+				''
 			else
 				"#{k}=#{qchar}#{v.to_s.gsub(qchar, CGI.escapeHTML(qchar))}#{qchar}"
 			end

data/lib/hoshi/view.rb

@@ -1,13 +1,10 @@
-require 'metaid'
 require 'cgi'
 
-require 'hoshi/view-tag'
-
 module Hoshi
 	# The View class is the super-class for views you create with Hoshi.  More
 	# likely, though, you'll be using one of View's many sub-classes as the
 	# super-class for your view, like this:
-	#   class MyView < Hoshi::View :html4
+	#   class MyView < Hoshi::View :html5
 	# or
 	#   class MyView < Hoshi::View::XHTML1Frameset
 	# Of course, using View[] is the preferred method for the sake of brevity.
@@ -17,6 +14,25 @@ module Hoshi
 	class View
 		class ValidationError < StandardError; end
 
+		# This creates an instance method for this view which appends a tag.
+		# Most of these are handled for you.  The arguments to this method
+		# match those to Tag.new.  See also View.permissive!.
+		# 	tag('h1')
+		# 	def show_an_h1
+		# 		h1 "I have been shown"
+		# 	end
+		def self.tag(name, close_type = nil)
+			define_method(name) { |*opts,&b|
+				if b
+					tag name, close_type, *opts, &b
+				else
+					tag name, close_type, *opts
+				end
+			}
+			# Inline tags.
+			define_method("_#{name}") { |*opts| _tag name, close_type, *opts }
+		end
+
 		# A short-hand for creating multiple tags via View.tag.  For tags that
 		# do not require closing, see View.open_tags.
 		def self.tags *names

data/lib/hoshi/view/svg.rb

@@ -0,0 +1,47 @@
+class Hoshi::View
+	class SVG < self
+		# camelCase looks awful on method names, and we can't have
+		# hyphenated ones, so we start with a tag list from MDN:
+		# https://developer.mozilla.org/en-US/docs/Web/SVG/Element
+		tag_list = %w(
+			a altGlyph altGlyphDef altGlyphItem animate animateColor
+			animateMotion animateTransform circle clipPath color-profile
+			cursor defs desc ellipse feBlend feColorMatrix
+			feComponentTransfer feComposite feConvolveMatrix
+			feDiffuseLighting feDisplacementMap feDistantLight feFlood
+			feFuncA feFuncB feFuncG feFuncR feGaussianBlur feImage feMerge
+			feMergeNode feMorphology feOffset fePointLight
+			feSpecularLighting feSpotLight feTile feTurbulence filter font
+			font-face font-face-format font-face-name font-face-src
+			font-face-uri foreignObject g glyph glyphRef hkern image line
+			linearGradient marker mask metadata missing-glyph mpath path
+			pattern polygon polyline radialGradient rect script set stop
+			style svg switch symbol text textPath title tref tspan use view
+			vkern
+		)
+
+		self_closing_tags *tag_list.grep(/^[a-z]+$/i)
+		tag_list.grep(/[A-Z]/).each { |camel|
+			alias_method camel.
+				gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2}" }.downcase.to_sym,
+				camel.to_sym
+		}
+		tag_list.grep(/-/).each { |hyphen|
+			define_method(hyphen.gsub('-', '_')) { |*opts,&b|
+				if b
+					tag hyphen, :self, *opts, &b
+				else
+					tag hyphen, :self, *opts
+				end
+			}
+		}
+
+		dtd! '<?xml version="1.0" encoding="UTF-8"?>\n' \
+			'<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" '\
+			'"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">'
+
+		def self.content_type
+			"image/svg+xml"
+		end
+	end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hoshi
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.1
 platform: ruby
 authors:
 - Pete Elmore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-12 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: metaid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: hpricot
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +47,6 @@ files:
 - lib/hoshi.rb
 - lib/hoshi/monkey_patches.rb
 - lib/hoshi/tag.rb
-- lib/hoshi/view-tag.rb
 - lib/hoshi/view.rb
 - lib/hoshi/view/html.rb
 - lib/hoshi/view/html3.rb
@@ -70,6 +55,7 @@ files:
 - lib/hoshi/view/html4_transitional.rb
 - lib/hoshi/view/html5.rb
 - lib/hoshi/view/rss2.rb
+- lib/hoshi/view/svg.rb
 - lib/hoshi/view/xhtml.rb
 - lib/hoshi/view/xhtml1.rb
 - lib/hoshi/view/xhtml1_frameset.rb
@@ -95,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: hoshi-view
-rubygems_version: 2.2.2
+rubyforge_project: 
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Nice, object-oriented, first-class views.

data/lib/hoshi/view-tag.rb

@@ -1,22 +0,0 @@
-module Hoshi
-	class View
-		# This creates an instance method for this view which appends a tag.
-		# Most of these are handled for you.  The arguments to this method
-		# match those to Tag.new.  See also View#permissive!.
-		# 	tag('h1')
-		# 	def show_an_h1
-		# 		h1 "I have been shown"
-		# 	end
-		def self.tag(name, close_type = nil)
-			define_method(name) { |*opts,&b|
-				if b
-					tag name, close_type, *opts, &b
-				else
-					tag name, close_type, *opts
-				end
-			}
-			# Inline tags.
-			define_method("_#{name}") { |*opts| _tag name, close_type, *opts }
-		end
-	end
-end