objective_elements 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e2d1f8b25c51909941b93851d03b35750d6f565a96c79e15c4fc7b335c8569b
-  data.tar.gz: cfc29825193a34c5d5fe1c6aa279cd2d5767181639afa1080eba7faad0081091
+  metadata.gz: d19b11b8215023de5a6dc505034de4d08e02e1beca92c20b6920a6ad6420a09e
+  data.tar.gz: c24f570c8e46ca9609c46e2ad70d309d5a170a6c2c8da0ec2932e76efaba7a71
 SHA512:
-  metadata.gz: 35c68f9a39dbe6da0ab4ff7681bff27ec230a1633c0d991c7015bd359225cd92b7d6b9ed02a1e5563a9a2675953e715ec55b851c62c59e4a61185ab7188f459a
-  data.tar.gz: a6fb2881ad600bde01391a56359a3a35459d957e561cc9b5c0cdd20bfe66b1028c6c636d7711bff67b89a6321a39230b6ed9ce18578898aa26d5449f3c55fbcb
+  metadata.gz: 97bf3bd7f4c6cf88c6441a5bcb3098735e90c135abbe14ea940012b81f5bd98a7a4a468492e6b897ee680e0656df3daf5485acf122daacdc656b653a8d56c020
+  data.tar.gz: 7f0710dbea4c75c73290c5818922cb7004649f87ea566053ad49d365ff3499267cdd87b2aa3071082129d2b5827aa9cd6bee76b4bc179175c43d2548d2f17127

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.solargraph.yml

@@ -0,0 +1,15 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+require_paths: []
+max_files: 5000

data/Gemfile

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

data/Gemfile.lock

@@ -1,31 +1,72 @@
 PATH
   remote: .
   specs:
-    objective_elements (1.1.0)
+    objective_elements (1.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
+    backport (1.1.2)
+    benchmark (0.1.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    method_source (0.9.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    maruku (0.7.3)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    rainbow (3.0.0)
     rake (10.5.0)
+    reverse_markdown (1.4.0)
+      nokogiri
     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-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.3)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    solargraph (0.38.2)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      maruku (~> 0.7, >= 0.7.3)
+      nokogiri (~> 1.9, >= 1.9.1)
+      parser (~> 2.3)
+      reverse_markdown (~> 1.0, >= 1.0.5)
+      rubocop (~> 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9)
+    thor (1.0.1)
+    tilt (2.0.10)
+    unicode-display_width (1.6.0)
+    yard (0.9.24)
 
 PLATFORMS
   ruby
@@ -36,6 +77,8 @@ DEPENDENCIES
   pry (~> 0.11.3)
   rake (~> 10.0)
   rspec (~> 3.8.0)
+  rubocop (~> 0.79)
+  solargraph (~> 0.38)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -18,7 +18,7 @@ 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, 
+going to write an entirely new class or pull in some big new dependency just for 10 lines of HTML,
 so instead you hammer through it and end up with code like this:
 
 ```ruby
@@ -29,7 +29,8 @@ picture_tag = "<picture>\n"\
               "#{html_attr_string}>\n"\"#{markdown_escape * 2}</picture>\n"
 ```
 
-or this: 
+or this:
+
 ```ruby
     def build_li(this_item_data, icon_location, label)
       li = "  <li#{@attributes['li']}>"
@@ -98,43 +99,50 @@ div = p.add_parent DoubleTag.new 'div'
 
 ## Changes
 
+### 1.1.1
+
+Fix bug where duplicate attribute keys would overwrite each other's values, when passed at the same time.
+
 ### 1.1.0
+
 Add `ShelfTag`, which is useful when you want to create siblings without a parent element.
 
 ### 1.0.0
-Attributes syntax has changed pretty significantly. Find `.add_attributes` & replace `.attributes << `
+
+Attributes syntax has changed pretty significantly. Find `.add_attributes` & replace `.attributes <<`
 will get you most of the way there, but you should read over the usage section again.
 
 ## Installation
 
- ```ruby
- # Gemfile
- 
- gem 'objective_elements', '~> 1.0.0'
- ```
- 
- ```ruby
- # Anywhere else:
- 
- require 'objective_elements'
- ```
- 
+```ruby
+# Gemfile
+
+gem 'objective_elements', '~> 1.0.0'
+```
+
+```ruby
+# Anywhere else:
+
+require 'objective_elements'
+```
+
 ## Terminology
 
 ```
 <p class="stumpy">Hello</p>
 |a|       b      |  c  | d |
 ```
-- a    -  element
-- b    -  attributes
-- a+b  -  opening tag
-- c    -  content
-- d    -  closing tag
 
+- a - element
+- b - attributes
+- a+b - opening tag
+- c - content
+- d - closing tag
 
 ## Usage
 
 For Attribute & SingleTag examples, we'll use this image tag:
+
 ```ruby
 
 img = SingleTag.new 'img', attributes: 'src="angry-baby.jpg"'
@@ -146,34 +154,39 @@ A `SingleTag` is a self-closing tag, meaning it has no content and no closing ta
 the other kind.
 
 ### Attributes
+
 Attributes are their own class, and can be accessed by the `.attributes` method on both single and
 double tags. Important methods:
 
-` << (attribute)` 
+`<< (attribute)`
+
 - Example: `p.attributes << 'alt="he does not look happy"'`
 - Example: `p.attributes << { alt: "he does not look happy" }`
 - Add new attributes, can accept a hash or a string. Hash keys will be converted
-to symbols if they are not already, and values will be split on spaces into an array if they are not
-already. Attributes can also be given as a string in the standard HTML syntax (`class="myclass"
-id="my-id"`).  **Every other method which adds attributes in some way, calls this method**. This
-means that any time you are adding attributes, you can use any format which this method understands.
- 
-`.delete(attribute)` 
+  to symbols if they are not already, and values will be split on spaces into an array if they are not
+  already. Attributes can also be given as a string in the standard HTML syntax (`class="myclass" id="my-id"`). **Every other method which adds attributes in some way, calls this method**. This
+  means that any time you are adding attributes, you can use any format which this method understands.
+
+`.delete(attribute)`
+
 - Example: `img.attributes.delete 'src'`
 - Example: `img.attributes.delete :src`
 - Example: `img.attributes.delete [:src, 'alt']`
 - Delete one or more attributes. Accepts a string, symbol, or an array of
-strings and/or symbols.
+  strings and/or symbols.
+
+`.replace(attribute)`
 
-`.replace(attribute)` 
 - Example: `img.attributes.replace 'src="happy-baby.jpg"'`
 - Replaces one or more attributes and values individually.
 
-`.content[:attribute_name] = ` 
+`.content[:attribute_name] =`
+
 - Example: `img.attributes.content[:src] = 'dirty-baby.jpg'` < This just broke everything.
-- Don't do it. Use `.replace`, `.(attribute name) = `, or `<<` 
+- Don't do it. Use `.replace`, `.(attribute name) =`, or `<<`
+
+`.content[:attribute_name]`
 
-`.content[:attribute_name]` 
 - Example: `img.attributes[:src] # returns 'angry-baby.jpg`
 - Retrieve the content for a given attribute, as an array of strings. Must be a symbol. You'll
 - mostly need this when you don't know which attribute you need ahead of
@@ -181,18 +194,20 @@ strings and/or symbols.
 
 **There is a shorthand for the next two methods. Keep reading.**
 
-`.(attribute_name)` 
+`.(attribute_name)`
+
 - Example: `img.attributes.src # 'angry-baby.jpg'`
 - Convenience method/syntactic sugar: Returns the value of a given attribute name, as a
 - space-separated string. This relies on method_missing, which means that any overlap with
-  already existing methods won't work.  
+  already existing methods won't work.
 - **You can't access `class` or `method` html attributes this way, because
   basic objects in ruby already have those methods.**
 - **Ruby methods can't have dashes in them.** This means `p.data-awesomeness` won't work.
 
-`.(attribute_name) = value` 
+`.(attribute_name) = value`
+
 - Example: `img.attributes.src = 'happy-baby.jpg'`
-- Same as above. Similar to `.replace(attribute)`. Interestingly, `method = ` and `class = ` both
+- Same as above. Similar to `.replace(attribute)`. Interestingly, `method =` and `class =` both
   work (`.class` is defined on the basic object class, but `.class=` is not.). Still, you
   probably shouldn't use them.
 
@@ -203,36 +218,43 @@ strings and/or symbols.
 
 ### SingleTag Properties:
 
- #### element
- - String
- - Mandatory
- - Which type of tag, such as 'hr' or 'img'
- 
- #### attributes
- - Instance of the class described above.
+#### element
+
+- String
+- Mandatory
+- Which type of tag, such as 'hr' or 'img'
+
+#### attributes
+
+- Instance of the class described above.
 
 ### SingleTag Methods (that you care about)
 
 `SingleTag.new(element, attributes: nil)`
 
-`.to_s` 
+`.to_s`
+
 - Example: `img.to_s`
 - The big one. Returns your HTML as a string, nondestructively.
 
-`.add_parent(DoubleTag)` 
+`.add_parent(DoubleTag)`
+
 - Example: `img.add_parent DoubleTag.new 'picture'`
 - returns supplied DoubleTag, with self added as a child.
 
-`.attributes` 
+`.attributes`
+
 - Example: `img.attributes`
 - attr_reader for HTML attributes. This is how you can access any attribute method
-described above.
+  described above.
+
+`.reset_attributes`
 
-`.reset_attributes` 
 - Example: `img.reset_attributes`
 - Removes all attributes.
 
-`.attributes=(new)` 
+`.attributes=(new)`
+
 - Example: `img.attributes = 'src="grumpy-baby.jpg" id="muddy"'`
 - Equivalent to `reset_attributes` and `.attributes << new`
 
@@ -241,40 +263,43 @@ described above.
 
 ### DoubleTag Properties:
 
-
 #### `DoubleTag` Inherits all of `SingleTag`'s properties and methods, and adds content and a
+
 closing tag.
 
- #### content
+#### content
 
-   - Array
-   - Optional
-   - Contains 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.
-   - add with `.add_content`, or modify the content array directly.
+- Array
+- Optional
+- Contains 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.
+- add with `.add_content`, or modify the content array directly.
 
- #### 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.
+#### 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)
 
-For DoubleTag Examples, we're working with a div tag: 
+For DoubleTag Examples, we're working with a div tag:
 
 ```
 div = DoubleTag.new 'div'
 ```
 
-`DoubleTag.new(element, attributes: {}, oneline: false, content: [])` 
+`DoubleTag.new(element, attributes: {}, oneline: false, content: [])`
+
 - You can initialize it with content.
 
-`add_content(anything)` 
+`add_content(anything)`
+
 - Example: `div.add_content 'example text!'`
 - Example: `div.add_content ['splits', 'across', 'lines']`
 - Example: `div.add_content img # image tag from earlier`
@@ -300,77 +325,78 @@ tag.
 Convert it into an actual tag with `.add_parent(DoubleTag)`
 
 ## Configuration
- 
- Indentation is defined by the `indent` method on the DoubleTag class, which is two escaped
- spaces by default ("\ \ "). 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.
+Indentation is defined by the `indent` method on the DoubleTag class, which is two escaped
+spaces by default ("\ \ "). 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:
 
- Example:
+```ruby
 
- ```ruby
- 
- require 'objective_elements'
+require 'objective_elements'
 
- class MyDoubleTag < DoubleTag
-  def indent
-    # 4 escaped spaces:
-    "\ \ \ \ "
-  end
+class MyDoubleTag < DoubleTag
+ def indent
+   # 4 escaped spaces:
+   "\ \ \ \ "
  end
+end
 
 MyDoubleTag.new('p', content: 'hello').to_s
 # <p>
 #     hello
 # </p>
 
- ```
-
- ## Limitations
-
-* It doesn't know a single HTML element on its own, so it does nothing to ensure your HTML is valid.
-
-* A parent tag can't put siblings on the same line. You can either do this (with `oneline: true` on
-   the strong tag):
+```
 
-    ```html
+## Limitations
 
-    <p>
-      Here is some
-      <strong>strong</strong>
-      text.
-    </p>
+- It doesn't know a single HTML element on its own, so it does nothing to ensure your HTML is valid.
 
-    ```
-    or this (default behavior):
+- A parent tag can't put siblings on the same line. You can either do this (with `oneline: true` on
+  the strong tag):
 
-    ```html
+  ```html
+  <p>
+    Here is some
+    <strong>strong</strong>
+    text.
+  </p>
+  ```
 
-    <p>
-      Here is some
-      <strong>
-        strong
-      </strong>
-      text.
-    </p>
+  or this (default behavior):
 
-    ```
-    But you can't do this without string interpolation or something:
+  ```html
+  <p>
+    Here is some
+    <strong>
+      strong
+    </strong>
+    text.
+  </p>
+  ```
 
-    ```html
+  But you can't do this without string interpolation or something:
 
-    <p>Here is some <strong>strong</strong> text.</p>
+  ```html
+  <p>
+    Here is some
+    <strong>strong</strong>
+    text.
+  </p>
+  ```
 
-    ```
-    This doesn't affect how the browser will render it, but it might bug you if you're particular about
-    source code layout.
+  This 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
+- 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. Handling this situation is on the TODO list.
 
-* It doesn't wrap long lines of text, and it doesn't indent text with newlines embedded. It's on the
+- It doesn't wrap long lines of text, and it doesn't indent text with newlines embedded. It's on the
   TODO list.
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,8 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "elements"
+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.
@@ -10,5 +10,5 @@ require "elements"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/objective_elements.rb

@@ -1,3 +1,8 @@
+# Author: Robert Buchberger <robert@buchberger.cc>
+#
+# This module provides a few helpful classes for generating HTML using simple
+# Ruby. Its goal is to be lightweight, and more focused than the general-purpose
+# nature of nokogiri.
 module ObjectiveElements
   require_relative 'objective_elements/single_tag'
   require_relative 'objective_elements/double_tag'

data/lib/objective_elements/html_attributes.rb

@@ -13,6 +13,10 @@ class HTMLAttributes
   def to_s
     return_string = ''
     @content.each_pair do |k, v|
+      # If an attribute has no values, we need to introduce an empty string to
+      # the array in order to get the correct format (alt="", for example):
+      v << '' if v.empty?
+
       return_string << "#{k}=\"#{v.join ' '}\" "
     end
 
@@ -86,27 +90,34 @@ class HTMLAttributes
     add_hash hashify_input new_string
   end
 
-  def add_hash(new)
+  # Input: Keys are attribute names (either strings or symbols), values are
+  # attribute values (either a string or an array of strings)
+  def add_hash(new_hash)
     formatted_new = {}
-    new.each_pair do |k, v|
-      v = v.split ' ' if v.is_a? String
+
+    new_hash.each_pair do |k, v|
+      v = v.split(' ') if v.is_a? String
+
       formatted_new[k.to_sym] = v
     end
 
-    @content.merge! formatted_new do |_key, oldval, newval|
-      oldval.concat newval
+    @content.merge!(formatted_new) do |_key, oldval, newval|
+      oldval.concat(newval)
     end
+
     self
   end
 
   def hashify_input(new_string)
     # looking for something like:
-    # 'class="something something-else" id="my-id"'
+    # 'class="something something-else" id="my-id" alt=""'
     new_hash = {}
-    new_string.scan(/ ?([^="]+)="([^"]+)"/).each do |m|
-      # [['class','something something-else'],['id','my-id']]
-      key = m.shift
-      val = m.pop
+    new_string.scan(/ ?([^="]+)="([^"]*)"/).each do |match|
+      # Returns something like:
+      # [['class','something something-else'],['id','my-id'],['alt', '']]
+
+      key, val = *match
+
       if new_hash[key]
         new_hash[key] << ' ' + val
       else

data/lib/objective_elements/version.rb

@@ -1,3 +1,3 @@
 module ObjectiveElements
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/objective_elements.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |spec|
   spec.name          = 'objective_elements'
   spec.version       = ObjectiveElements::VERSION
   spec.authors       = ['Robert Buchberger']
-  spec.email         = ['robert@robert-buchberger.com']
+  spec.email         = ['robert@buchberger.cc']
 
-  spec.summary       = 'Build HTML without interpolating strings.'
+  spec.summary       = 'Build HTML with simple ruby.'
   spec.homepage      = 'https://github.com/rbuchberger/objective_elements'
   spec.license       = 'MIT'
 
@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~>0.11.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~>3.8.0'
+  spec.add_development_dependency 'rubocop', '~>0.79'
+  spec.add_development_dependency 'solargraph', '~>0.38'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: objective_elements
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Robert Buchberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,14 +66,44 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
 description: 
 email:
-- robert@robert-buchberger.com
+- robert@buchberger.cc
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".solargraph.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -110,5 +140,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Build HTML without interpolating strings.
+summary: Build HTML with simple ruby.
 test_files: []