pagebuilder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20c3e9b1f9ee062b88333481c0b3ae229f74c2ef
+  data.tar.gz: bf084d67ff8d49de5670df8c251f5c14d668f307
+SHA512:
+  metadata.gz: 266e3a19041f3aa0b65d680d9066853339dbde525bc776371c4126e6222a50afe589df3469b620cc02bc5955b4aca6ed15bed03a5acacd123cba6c24f7f3dd01
+  data.tar.gz: 7a2f224579aab8e416e5f845be8cfb064fff14186bf979daa8d74dc4448b9a9260b6763996c35d4d6f0b7f60ed5eadf5b9bc372d56917d7f65b1aafd23a0be81

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+gems.locked

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+  - jruby-9.1.17.0
+install:
+  - gem install bundler -v 1.16.2
+  - bundle install --jobs=3 --retry=3 --path vendor/bundle
+script: bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team through github. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rob Widmer
+
+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,51 @@
+# Pagebuilder
+
+This gem provides helpers for building html pages. It uses the nokogiri gem to manage the page/DOM.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pagebuilder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pagebuilder
+
+## Usage
+
+Include `PageBuilder::Tags` in the class where you want to build out pages. It will add helper methods for most HTML 5 tags. As an example, you can then call `a 'click here', href: 'http://www.example.com'` to generate an anchor node that links to `http://www.example.com` with "click here" as the text.
+
+### Available helpers
+
+There are some helpers added with the tags that are not directly related to element nodes. These are generally prefixed with `pagebuilder_` and are private except for the `to_html` method.
+
+- `to_html` (public method)
+  - It calls `to_html` on the document to generate the output
+- `pagebuilder_document` and `pagebuilder_document=`
+  - Read or set the Nokogiri HTML document that should be used for generating html nodes
+  - If a document has not been set, an html5 doctyped Nokogiri Document will be created the first time it is called
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec`, or just `rspec`, to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rdubya/pagebuilder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pagebuilder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rdubya/pagebuilder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pagebuilder"
+
+# 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/gems.rb

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

data/lib/pagebuilder.rb

@@ -0,0 +1,11 @@
+require 'pagebuilder/version'
+
+require 'nokogiri'
+require 'pagebuilder/document'
+require 'pagebuilder/elements'
+require 'pagebuilder/tag_helpers'
+
+# The container namespace for the gem
+module PageBuilder
+
+end

data/lib/pagebuilder/document.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PageBuilder
+
+  # Adds helper methods to the standard Nokogiri HTML document and
+  # forces an html5 doctype
+  class Document < Nokogiri::HTML::Document
+
+    # TODO Make helpers for more often used meta tags
+    # TODO make helpers for more common link tags
+
+    def self.new
+      # This is the only way I've found so far to force the html5 subtype
+      parse('<!DOCTYPE html><html><head></head><body></body></html>')
+    end
+
+    # Gets the body node for the document
+    # @return [Nokogiri::XML::Node]
+    def body
+      @body ||= at('/html/body')
+    end
+
+    # Gets the head node for the document
+    # @return [Nokogiri::XML::Node]
+    def head
+      @head ||= at('/html/head')
+    end
+
+  end
+
+end

data/lib/pagebuilder/elements.rb

@@ -0,0 +1,8 @@
+require 'pagebuilder/elements/basic'
+require 'pagebuilder/elements/anchor'
+require 'pagebuilder/elements/input'
+require 'pagebuilder/elements/inputs'
+
+# Namespace for all custom elements
+module PageBuilder::Elements
+end

data/lib/pagebuilder/elements/anchor.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PageBuilder
+  module Elements
+
+    # Creates anchor nodes and adds some helper
+    # methods for commonly used attributes
+    class Anchor < Basic
+
+      # We have to override #new because nokogiri creates
+      # the nodes before calling initialize
+      # @param parent_or_doc [Nokogiri::XML::Node, Nokogiri::XML::Document] something to pull the current document from
+      def self.new(parent_or_doc)
+        super('a', parent_or_doc)
+      end
+
+      # Gets the current href attribute's value
+      # @return [String, nil]
+      def href
+        self['href']
+      end
+
+      # Sets the href attribute's value
+      # @param url [String] the url to link to
+      # @return void
+      def href=(url)
+        self['href'] = url
+      end
+    end
+  end
+end

data/lib/pagebuilder/elements/basic.rb

@@ -0,0 +1,38 @@
+module PageBuilder
+  module Elements
+
+    # A wrapper for Nokogiri::XML::Element so that
+    # we can add extra helpers
+    class Basic < Nokogiri::XML::Element
+
+      # Helper to easily set the content and attributes for this element
+      # @param content [String] text for the content of the element
+      # @param attributes [] keyword arguments for the attributes that should be set
+      # @option data [Hash] data attributes that should be set
+      # @return [self]
+      def configure(content = nil, **attributes)
+        self.content = content if content
+
+        # Deal with helper attributes
+        data_attrs = attributes.delete(:data)
+        self.data_attributes = data_attrs if data_attrs
+
+        # Set normal attributes
+        attributes.each { |k, v| self[k] = v }
+
+        self
+      end
+
+      # Helper to set data attributes as a single call instead of
+      # an individual line for each attributes
+      # @param attributes [Hash] data attributes that should be set (minus the "data-" prefix)
+      # @return void
+      def data_attributes=(attributes)
+        attributes.each do |k, v|
+          self["data-#{k}"] = v
+        end
+      end
+
+    end
+  end
+end

data/lib/pagebuilder/elements/input.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module PageBuilder
+  module Elements
+
+    # Creates anchor nodes and adds some helper
+    # methods for commonly used attributes
+    class Input < Basic
+
+      # We have to override #new because nokogiri creates
+      # the nodes before calling initialize
+      # @param parent_or_doc [Nokogiri::XML::Node, Nokogiri::XML::Document] something to pull the current document from
+      def self.new(parent_or_doc)
+        super('input', parent_or_doc)
+      end
+
+      # Gets the current type attribute's value
+      # @return [String, nil]
+      def type
+        self['type']
+      end
+
+      # Sets the type attribute's value
+      # @param type [String] the type of the input
+      # @return void
+      def type=(type)
+        self['type'] = type
+      end
+
+      # Gets the current value attribute's value
+      # @return [String, nil]
+      def value
+        self['value']
+      end
+
+      # Sets the value attribute's value
+      # @param value [String] the value for this input
+      # @return void
+      def value=(value)
+        self['value'] = value
+      end
+    end
+  end
+end

data/lib/pagebuilder/elements/inputs.rb

@@ -0,0 +1,13 @@
+require 'pagebuilder/elements/inputs/checkbox'
+require 'pagebuilder/elements/inputs/email'
+require 'pagebuilder/elements/inputs/file'
+require 'pagebuilder/elements/inputs/hidden'
+require 'pagebuilder/elements/inputs/password'
+require 'pagebuilder/elements/inputs/radio_button'
+require 'pagebuilder/elements/inputs/search'
+require 'pagebuilder/elements/inputs/submit_button'
+require 'pagebuilder/elements/inputs/text'
+
+# Namespace for all specialized input elements
+module PageBuilder::Elements::Inputs
+end

data/lib/pagebuilder/elements/inputs/checkbox.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PageBuilder
+  module Elements
+    module Inputs
+
+      # Creates checkbox input nodes and adds some helper
+      # methods for commonly used attributes
+      class Checkbox < PageBuilder::Elements::Input
+
+        def initialize(*args)
+          super
+          self.type = 'checkbox'
+        end
+
+      end
+    end
+  end
+end

data/lib/pagebuilder/elements/inputs/email.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PageBuilder
+  module Elements
+    module Inputs
+
+      # Creates email input nodes
+      class Email < PageBuilder::Elements::Input
+
+        def initialize(*args)
+          super
+          self.type = 'email'
+        end
+
+      end
+    end
+  end
+end