ruby_html 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cf10da42b2a32aff7c67a58f3a8d0483d1b754c0df61ed073069006a4817478
+  data.tar.gz: 2fdc6c6b4168d6afba39009d17010604645d3dfe66af2caac8b36f7ec06b0ca1
+SHA512:
+  metadata.gz: 5c7be02af205f74dca18f915dcf984e986bda08013bca8ba3a3f4365c02c5cadf66e295eb5c5c00bd8ebb3fa32d81279f824116991ecb4382a3fe9d984b52763
+  data.tar.gz: 415fccbcc1c9ddd93962209db002c48bc81f1a80bf7156c03ddbf3bcc5d10163908e29612bee9fd664c147cb6fa99a75fb302be9a5208871720c391425e6766c

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle/
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "rspec"
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2018 Jonathan Thom
+
+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

@@ -0,0 +1,89 @@
+# Ruby HTML
+
+A (totally unnecessary) HTML document builder in Ruby.
+
+### Installation
+
+Eventually, this will be a gem, but for now you can do:
+
+```
+git clone https://github.com/jonathanwthom/ruby_html.git
+cd rhtml
+irb
+require_relative "ruby_html"
+```
+
+Or you can include the rhtml directory in a project, and
+require it there.
+
+### How to Use It
+
+HTML element classes have the names you think they would. For example, to create a div:
+
+```
+div = Div.new
+```
+
+Elements can receive arguments. These can be strings, or can be other elements themselves.
+These elements will be nested under their parent.
+
+```
+div = Div.new("Hello", P.new("World"))
+```
+
+You can also add new elements to a previously created element with `#add_elements`, which accepts any number of arguments.
+
+```
+div.add_elements("Hello")
+div.add_elements("Hello", "From", H3.new("Earth"))
+```
+
+You can pass the same element as an argument as many times as you want - just like a partial or component.
+
+All elements have a method `#render`, which prints all the element's contents (calling `.render` on all non string elements
+contained within.
+
+```
+div = Div.new(H6.new("Hello"), "World")
+div.render
+=> "<div><h6>Hello</h6>World</div>"
+```
+
+To add attributes to an element, pass a hash to the object like so:
+
+```
+p_with_class = P.new("Hello World", attributes: { "class": "red" })
+p_with_class.render
+=> <p class='red'>Hello World</p>
+```
+
+Most importantly, if you want to actually create an HTML page, you'll want to create a `Document` that holds all of your elements.
+A document recieves elements, as well as header elements (such as `<title>` or `<style>`).
+
+```
+title = Title.new("Page Title")
+Document.new(Div.new, header_elements: [title])
+```
+
+`Document` has a special method, `#render_to_file` that recieves a file path, and creates your html document there.
+
+```
+Document.new.render_to_file("hello_world.html")
+=> creates html document
+```
+
+
+### TODO
+
+So much!
+
+- Build out all other elements. See the current list of supported elements [here](https://github.com/JonathanWThom/rhtml/blob/master/elements/elements.rb).
+- Tests!
+- Gemify it.
+
+### Contributing
+
+1. Fork it
+2. Clone it
+3. Make a PR.
+4. Be kind to others. Programming is fun.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/ruby_html/elements/document.rb

@@ -0,0 +1,26 @@
+class Document < Element
+	attr_reader :header_elements
+
+	def initialize(*elements, header_elements: [])
+		@elements = elements
+		@header_elements = header_elements.flatten
+	end
+
+	def opening_tag
+		"<!DOCTYPE><html><head>#{rendered_header_elements}</head><body>"
+	end
+
+	def rendered_header_elements
+		header_elements.map do |element|
+			element.render
+		end.join("")
+	end
+
+	def closing_tag
+		"</body></html>"
+	end
+
+	def render_to_file(path)
+		File.open(path, "w") { |file| file.write(render) }
+	end
+end

data/lib/ruby_html/elements/element.rb

@@ -0,0 +1,55 @@
+class Element
+	attr_reader :elements, :attributes
+
+	def initialize(*elements, attributes: {})
+		@elements = elements
+		@attributes = attributes
+	end
+
+	def add_elements(*new_elements)
+		new_elements.each do |element|
+			@elements.push(element)
+		end
+	end
+
+	def add_attribute(attribute_hash)
+		@attributes.merge!(attribute_hash)
+		## TODO: Account for adding elements that already exist.
+	end
+
+	def render
+		 opening_tag + rendered_elements + closing_tag
+	end
+	
+	def rendered_elements
+		elements.map do |element|
+			if element.is_a? String
+				element
+			else
+				element.render
+			end
+		end.join("")
+	end
+	
+	def tag
+		self.class.name.downcase
+	end
+
+	def opening_tag
+		if rendered_attributes != ""
+			"<#{tag} #{rendered_attributes}>"
+		else
+			"<#{tag}>"
+		end
+	end
+
+	def closing_tag
+		"</#{tag}>"
+	end
+
+	def rendered_attributes
+		attributes.map do |k, v|
+			"#{k}='#{v}'"
+		end.join(" ")
+	end
+end

data/lib/ruby_html/elements/elements.rb

@@ -0,0 +1,119 @@
+elements = %w(
+	Div
+	P
+	H1
+	H2
+	H3
+	H4
+	H5
+	H6
+	Img
+	Script
+	Style
+	Title
+	Link
+	Meta
+	Address
+	Article
+	Aside
+	Footer
+	Header
+	HGroup
+	Nav
+	Section
+	BlockQuote
+	Dd
+	Dl
+	Dt
+	FigCaption
+	Figure
+	Hr
+	Li
+	Main
+	Ol
+	Pre
+	Ul
+	A
+	Abbr
+	B
+	Bdi
+	Bdo
+	Br
+	Cite
+	Code
+	Dfn
+	Em
+	I
+	Kbd
+	Nobr
+	Q
+	Rp
+	Rt
+	Rtc
+	Ruby
+	S
+	Samp
+	Small
+	Span
+	Strong
+	Sub
+	Sup
+	Tt
+	U
+	Var
+	Wbr
+	Area
+	Audio
+	Map
+	Track
+	Video
+	Applet
+	Embed
+	IFrame
+	NoEmbed
+	Param
+	Picture
+	Source
+	Canvas
+	NoScript
+	Del
+	Ins
+	Caption
+	Col
+	ColGroup
+	Table
+	TBody
+	Td
+	TFoot
+	Th
+	THead
+	Tr
+	Button
+	DataList
+	FieldSet
+	Form
+	Input
+	Label
+	Legend
+	Meter
+	OptGroup
+	Option
+	Output
+	Progress
+	Select
+	TextArea
+	Details
+	Dialog
+	Menu
+	MenuItem
+	Summary
+	Content
+	Shadow
+	Slot
+	Template
+)
+
+elements.each do |klass_name|
+  klass = Class.new(Element)
+  Object.const_set(klass_name, klass)
+end

data/lib/ruby_html/version.rb

@@ -0,0 +1,3 @@
+module RubyHtml
+	VERSION = "0.0.2"
+end

data/lib/ruby_html.rb

@@ -0,0 +1,4 @@
+require "ruby_html/version"
+require "ruby_html/elements/element"
+require "ruby_html/elements/document"
+require "ruby_html/elements/elements"

data/ruby_html.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_html/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_html"
+  spec.version       = RubyHtml::VERSION
+  spec.authors       = ["Jonathan Thom"]
+  spec.email         = ["jonathan.thom1990@gmail"]
+  spec.description   = %{Build HTML with Ruby}
+  spec.summary       = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'engtagger'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: ruby_html
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jonathan Thom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: engtagger
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Build HTML with Ruby
+email:
+- jonathan.thom1990@gmail
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_html.rb
+- lib/ruby_html/elements/document.rb
+- lib/ruby_html/elements/element.rb
+- lib/ruby_html/elements/elements.rb
+- lib/ruby_html/version.rb
+- ruby_html.gemspec
+- spec/document_spec.rb
+- spec/element_spec.rb
+- spec/elements_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/document_spec.rb
+- spec/element_spec.rb
+- spec/elements_spec.rb