objective_elements 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a96004d9cd00908af90c7f251458c7df1346a7d8be58d09f9518e6bb0c937c77
+  data.tar.gz: 245cee10433fc4479b5ddfba7b4bfe608fc777c8551f9de207609b663fa38d34
+SHA512:
+  metadata.gz: 5ae990c5afac9ce516f7dc744dd5e5e1fac01a489af7c3a1bb4e5bdc196cd46682148c7a202666708cf7a54d08b388fd20a9798ad68c56137e11adccba499b02
+  data.tar.gz: be6296add683af618a92f7b8eaf64eb5534dafe01ac43ea843e5dc5ae55f26e65991876d7ece2faaa677ee62f0b2e3fea3bca0c7d29ee9459f0fb3aa43b50e41

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in elements.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    elements (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  elements!
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.8.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Robert Buchberger
+
+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,255 @@
+# Objective Elements
+
+This is a tiny gem that builds nicely formatted HTML using sane, readable Ruby. I use it for jekyll 
+plugins, but you can use it anywhere. It's ~100 lines, with no runtime dependencies beyond bundler
+and rake.
+
+Note: This gem doesn't actually know any HTML. It just knows how it should be formatted.
+
+## How it works:
+
+* Instantiate a `SingleTag` or `DoubleTag`
+
+* Attributes are a Hash, Content is an array. Define them on initialization, or later on.
+
+* Render it with `.to_s`. Get normal HTML without the pain.
+
+## Motivation:
+
+Have you ever tried to build HTML with string concatenation and interpolation? It starts out simply
+enough, but once you account for all the what-ifs, the indentation, the closing tags, and the 
+spaces you only need sometimes, it turns into a horrible mess.
+
+The problem, of course, is that building long, complex, varying blocks of text with string
+concatenation and interpolation is fragile, unreadable, and painful. You know this, but you're not
+going to write an entirely new class or pull in some big new dependency just for 10 lines of HTML.
+Instead, you just hammer through it and end up with code like this:
+
+```ruby
+picture_tag = "<picture>\n"\
+                      "#{source_tags}"\
+                      "#{markdown_escape * 4}<img src=\"#{url}#{instance['source_default'][:generated_src]}\" #{html_attr_string}>\n"\
+"#{markdown_escape * 2}</picture>\n"
+```
+
+or this: 
+```ruby
+    def build_li(this_item_data, icon_location, label)
+      li = "  <li#{@attributes['li']}>"
+      if this_item_data && this_item_data['url']
+        li << "<a href=\"#{this_item_data['url']}\"#{@attributes['a']}>"
+      end
+      li << build_image_tag(icon_location)
+      li << label
+      li << '</a>' if this_item_data['url']
+      li << "</li>\n"
+    end
+```
+
+Which is why I sat down and wrote this gem. It's super simple, you probably could have written it
+too, but hey! Now you don't have to. Here's a demo:
+
+## Demo
+
+```ruby
+p = DoubleTag.new 'p'
+p.to_s
+# <p>
+# </p>
+
+# Add attributes and content however you like:
+p.add_attributes class: 'stumpy grumpy', id: 'the-ugly-one'
+p.add_attributes class: 'slimy'
+p.add_content 'Bippity Boppity Boo!'
+p.to_s
+# <p class="stumpy grumpy slimy" id="the-ugly-one">
+#   Bippity Boppity Boo!
+# </p>
+
+# Want a oneliner?
+p.oneline = true
+p.to_s
+# <p class="stumpy mopey grumpy slimy" id="the-ugly-one">Bippity Boppity Boo!</p>
+p.oneline = false
+
+# Build it up step by step, or all at once:
+p.add_content DoubleTag.new(
+  'a',
+  content: 'Link!',
+  attributes: {href: 'awesome-possum.com'},
+  oneline: true
+) 
+# Add a parent tag!
+div = p.add_parent DoubleTag.new 'div'
+
+# Ruby implicitly calls .to_s on things when you try to perform string functions with them, meaning
+# cool things like this work:
+"#{div}"
+# <div>
+#   <p class="stumpy mopey grumpy slimy" id="the-ugly-one">
+#     Bippity Boppity Boo!
+#     <a href="awesome-possum.com">Link!</a>
+#   </p>
+# </div>
+
+```
+## Installation
+
+ - coming eventually. It'll be a gem and a require. For now, you can load it from this repo in your gemfile.
+ 
+## Usage
+
+So we're on the same page, here's the terminology I'm using:
+```
+<p class="stumpy">Hello</p>
+|a|       b      |  c  | d |
+```
+- a    -  element
+- b    -  attributes
+- a+b  -  opening tag
+- c    -  content
+- d    -  closing tag
+
+There are 2 classes: `SingleTag` is the base class, and `DoubleTag` inherits from it. A `SingleTag` is a
+self-closing tag, meaning it has no content and no closing tag. A `DoubleTag` is the other kind.
+
+### SingleTag Properties:
+
+ - element:
+     **String**, mandatory. What kind of tag it is; such as 'img' or 'hr'
+ - attributes:
+     **Hash** `{symbol: array or string}`, optional. Example: `{class: 'myclass plaid'}` or `{class:
+     ['myclass', 'plaid']}` 
+
+### SingleTag Methods (that you care about)
+
+`SingleTag.new(element, attributes: {})`
+
+`.to_s` - The big one. Returns your HTML as a string, nondestructively.
+
+`.reset_attributes(hash)` - Deletes all attributes, replaces with supplied argument if given.
+
+`.add_attributes(hash)` - Appends attributes instead of overwriting them.
+
+`.add_parent(DoubleTag)` - returns supplied DoubleTag, with self added as a child.
+
+`attr_reader :attributes, :element`
+
+### DoubleTag Properties:
+
+#### `DoubleTag` Inherits all of `SingleTag`'s properties and methods, but adds content and a closing tag.
+ - content:
+     **Array**, optional, containing anything (but probably just strings and tags. Anything else
+     will be turned into a string with `.to_s`, which is an alias for `.inspect` most of the time).
+
+     Each element in the array corresponds to at least one line of HTML; multiline child tags will
+     get as many lines as they need (like you'd expect).
+
+     Child elements are not rendered until the parent is rendered, meaning you can access and
+     modify them after defining a parent.
+
+ - oneline:
+    **Boolean**, optional, defaults to false. When true, the entire element and its content will be
+    rendered as a single line. Useful for anchor tags and list items.
+
+### DoubleTag Methods (that you care about)
+
+`DoubleTag.new(element, attributes: {}, oneline: false, content: [])`
+ - You can initialize it with content.
+
+`add_content(anything)`
+ - Smart enough to handle both arrays and not-arrays without getting dorked up.
+
+`attr_accessor: content`
+- You can modify the content array directly if you like. If you're just adding items, you should use
+    `.add_content`
+
+`.to_a`
+- Mostly used internally, but if you want an array of strings, each element a line with appropriate
+    indentation applied, this is how you can get it.
+
+## Configuration
+ 
+ Indentation is defined by the `indent` method on the DoubleTag class. If you'd like to change
+ it:
+
+ 1. Make a new class, inherit from DoubleTag.
+ 2. Override `indent` with whatever you want.
+ 3. Use your new class instead of DoubleTag.
+
+ Example:
+
+ ```ruby
+
+ class MyDoubleTag < DoubleTag
+  def indent
+    # 4 escaped spaces:
+    "\ \ \ \ "
+  end
+ end
+
+MyDoubleTag.new('p', content: 'hello').to_s
+# <p>
+#     hello
+# </p>
+
+ ```
+
+ ## Limitations
+
+* It actually doesn't know a single HTML element on its own, so it does nothing to ensure that
+    your HTML is valid. Garbage in, garbage out.
+
+* A parent tag can't put siblings on the same line. You can either
+    do this (with `oneline: true` on the strong tag):
+
+    ```html
+
+      Here is some
+      <strong>strong</strong>
+      text.
+
+    ```
+    or this (default behavior):
+
+    ```html
+
+      Here is some
+      <strong>
+        strong
+      </strong>
+      text.
+
+    ```
+    But you can't do this without string interpolation:
+
+    ```html
+
+    Here is some <strong>strong</strong> text. 
+
+    ```
+    It doesn't affect how the browser will render it, but it might bug you if you're particular about
+    source code layout.
+
+* If you set 'oneline: true' on a parent DoubleTag, but not all its children DoubleTags, the output
+    will not be pretty. I advise against it.
+
+* It doesn't wrap long lines of text, and it doesn't indent text with newlines embedded. It's on the
+    TODO list.
+
+## Contributing
+
+For code style, I've been using rubocop with the default settings and would appreciate if you did the
+same.
+
+If you add new functionality, or change existing functionality, please update the rspec tests to
+reflect it.
+
+https://github.com/rbuchberger/objective_elements
+
+contact:
+robert@robert-buchberger.com
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elements"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/objective_elements.rb

@@ -0,0 +1,4 @@
+module ObjectiveElements
+  require_relative 'objective_elements/single_tag'
+  require_relative 'objective_elements/double_tag'
+end

data/lib/objective_elements/double_tag.rb

@@ -0,0 +1,48 @@
+# Non-Self-Closing tag. Can have content, but doesn't have to.
+class DoubleTag < SingleTag
+  attr_accessor :content, :oneline
+  # content is an array of anything. Entries will be inserted sequentially in
+  # between the opening and closing tags.
+
+  def initialize(element, attributes: nil, content: [], oneline: false)
+    @oneline = oneline
+    reset_content(content)
+    super(element, attributes: attributes)
+  end
+
+  def closing_tag
+    "</#{element}>"
+  end
+
+  # Deletes all content, replaces with parameter (if supplied)
+  def reset_content(new = nil)
+    @content = []
+    add_content(new) if new
+  end
+
+  def add_content(addition)
+    @content << addition
+    @content.flatten!
+    self
+  end
+
+  def indent
+    "\ \ "
+  end
+
+  def to_a
+    lines = content.map do |c|
+      if c.is_a? SingleTag
+        c.to_a
+      else
+        c.to_s.dup
+      end
+    end
+    lines = lines.flatten.map { |l| l.prepend oneline ? '' : indent }
+    lines.unshift(opening_tag).push(closing_tag)
+  end
+
+  def to_s
+    to_a.join(oneline ? '' : "\n") + "\n"
+  end
+end

data/lib/objective_elements/single_tag.rb

@@ -0,0 +1,67 @@
+# Collection of HTML element tags
+# Describes a basic, self-closing HTML tag.
+class SingleTag
+  attr_reader :attributes
+  attr_accessor :element
+
+  # element is a string, such as 'div' or 'p'.
+
+  # Attributes are a hash. Keys are symbols, values are arrays. Will render as
+  # key="value1 value2 value3"
+
+  def initialize(element, attributes: nil)
+    @element = element
+    reset_attributes(attributes)
+  end
+
+  # Deletes all current attributes, overwrites them with supplied hash.
+  def reset_attributes(new = nil)
+    @attributes = {}
+    add_attributes(new) if new
+  end
+
+  # This is the only way we add new attributes. Flexible about what you give
+  # it-- accepts both strings and symbols for the keys, and both strings and
+  # arrays for the values.
+  def add_attributes(new)
+    formatted_new = {}
+    new.each_pair do |k, v|
+      v = v.split ' ' if v.is_a? String
+      formatted_new[k.to_sym] = v
+    end
+
+    @attributes.merge! formatted_new do |_key, oldval, newval|
+      oldval.concat newval
+    end
+  end
+  alias_method :add_attribute, :add_attributes
+
+  # Turns attributes into a string we can insert.
+  def render_attributes
+    attribute_string = ''
+    @attributes.each_pair do |k, v|
+      attribute_string << "#{k}=\"#{v.join ' '}\" "
+    end
+    attribute_string.strip
+  end
+
+  # Returns parent, with self added as a child
+  def add_parent(parent)
+    parent.add_content(self)
+  end
+
+  def opening_tag
+    output =  '<' + @element
+    output << ' ' + render_attributes unless @attributes.empty?
+    output << '>'
+  end
+
+  def to_a
+    [opening_tag]
+  end
+
+  # Renders our HTML.
+  def to_s
+    opening_tag + "\n"
+  end
+end

data/lib/objective_elements/version.rb

@@ -0,0 +1,3 @@
+module ObjectiveElements
+  VERSION = "0.1.0"
+end

data/objective_elements.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'objective_elements/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'objective_elements'
+  spec.version       = ObjectiveElements::VERSION
+  spec.authors       = ['Robert Buchberger']
+  spec.email         = ['robert@robert-buchberger.com']
+
+  spec.summary       = 'Build HTML without interpolating strings.'
+  spec.homepage      = 'https://github.com/rbuchberger/objective_elements'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.  The
+  # `git ls-files -z` loads the files in the RubyGem that have been added into
+  # git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~>0.11.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~>3.8.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: objective_elements
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Buchberger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: 
+email:
+- robert@robert-buchberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/objective_elements.rb
+- lib/objective_elements/double_tag.rb
+- lib/objective_elements/single_tag.rb
+- lib/objective_elements/version.rb
+- objective_elements.gemspec
+homepage: https://github.com/rbuchberger/objective_elements
+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.3
+signing_key: 
+specification_version: 4
+summary: Build HTML without interpolating strings.
+test_files: []